{"id":16068051,"url":"https://github.com/ged/rspec-formatter-webkit","last_synced_at":"2025-03-18T05:31:05.680Z","repository":{"id":1133312,"uuid":"1010519","full_name":"ged/rspec-formatter-webkit","owner":"ged","description":"A webkit-aware pretty formatter for RSpec (github mirror).","archived":false,"fork":false,"pushed_at":"2018-01-17T15:39:42.000Z","size":485,"stargazers_count":20,"open_issues_count":1,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T07:32:38.258Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://deveiate.org/webkit-rspec-formatter.html","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ged.png","metadata":{"files":{"readme":"README.rdoc","changelog":"History.rdoc","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-10-20T22:15:39.000Z","updated_at":"2021-11-28T23:42:54.000Z","dependencies_parsed_at":"2022-08-16T12:10:41.239Z","dependency_job_id":null,"html_url":"https://github.com/ged/rspec-formatter-webkit","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Frspec-formatter-webkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Frspec-formatter-webkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Frspec-formatter-webkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Frspec-formatter-webkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ged","download_url":"https://codeload.github.com/ged/rspec-formatter-webkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243903159,"owners_count":20366432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T06:08:16.605Z","updated_at":"2025-03-18T05:31:03.309Z","avatar_url":"https://github.com/ged.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"= A WebKit RSpec Formatter\n\nhttp://deveiate.org/webkit-rspec-formatter.html\n\n\n== Description\n\nThis is a formatter for RSpec 2 that takes advantage of features in\nWebKit[http://webkit.org/] to make the output from RSpec in Textmate more\nfun.\n\nTest output looks like this:\n\nhttp://deveiate.org/images/tmrspec-example.png\n\n\n== Installation\n\nTo get started, install the `rspec-formatter-webkit` gem:\n\n    $ gem install rspec-formatter-webkit\n\n\n== Usage\n\nIf you're running specs in Textmate 2 via\n{the RSpec bundle}[http://github.com/rspec/rspec-tmbundle], include\nthese in your \u003ctt\u003e.tm_properties\u003c/tt\u003e file:\n\n    TM_RSPEC_OPTS      = '-rrspec/core/formatters/webkit'\n    TM_RSPEC_FORMATTER = 'RSpec::Core::Formatters::WebKit'\n\nTo do the same in TextMate 1, open the 'Advanced' Preferences and\nadding the same variables there:\n\nhttp://deveiate.org/images/tmrspecopts-shellvar.png\n\nThat's it!\n\n=== Logging Output\n\nIf you have some kind of log output that you'd like to show up underneath\nthe example, you can append lines of HTML to the \u003ctt\u003elogger-output\u003c/tt\u003e\nthread-local variable and they'll be inserted into a +div+ under\nthe example line that can be toggled open and closed by clicking the\nexample line:\n\n    Thread.current['logger-output'] \u003c\u003c %{\u003cp\u003eSome stuff happened.\u003c/p\u003e}\n\nEach line that has such logging appended will appear with an asterisk after it\nin the output.\n\n==== Loggability\n\nIf you're using Loggability for logging, the WebKit formatter has CSS rules for\nthe output of its HTML formatter, and includes a helper for injecting the logs\ngenerated for an example into the output. Just include the Loggability spec\nhelper in your RSpec config:\n\n    require 'rspec'\n    require 'loggability/spechelpers'\n\n    RSpec.configure do |config|\n        config.include( Loggability::SpecHelpers )\n    end\n\n\n== Miscellaneous\n\nThis formatter is also usable anywhere else the standard HTML formatter is, of\ncourse. Also, while it's specifically intended to be used under the Textmate\nHTML viewer that the RSpec bundle uses, the output should work fine under\nrecent Gecko/Firefox-based viewers, as well. \n\nPatches/suggestions welcomed.\n\n\n== Contributing\n\nYou can check out the current development source with Mercurial via its\n{project page}[ssh://repo.deveiate.org/rspec-formatter-webkit]. Or if you prefer Git, via \n{its Github mirror}[https://github.com/ged/rspec-formatter-webkit].\n\nAfter checking out the source, run:\n\n    $ rake newb\n\nThis task will install any missing dependencies and generate the API documentation.\n\n\n== License\n\nCopyright (c) 2009-2015, Michael Granger\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice,\n  this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice,\n  this list of conditions and the following disclaimer in the documentation\n  and/or other materials provided with the distribution.\n\n* Neither the name of the author/s, nor the names of the project's\n  contributors may be used to endorse or promote products derived from this\n  software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fged%2Frspec-formatter-webkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fged%2Frspec-formatter-webkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fged%2Frspec-formatter-webkit/lists"}