htmlcuke 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4066391cbb175c42721f8a2aa0340e443d24d8db
+  data.tar.gz: db5b76956b4b674a4d7343acc280cd4f81a34f79
+SHA512:
+  metadata.gz: 146a02e7e82b665eb823b80258258574c5165b473715a99cae649e409c638e4652ef54426a100d38e319372f98bccb121ede3dcd7bbb38165029249b8672dfbf
+  data.tar.gz: 7458866ef3896dc0a7741c00a4c75a0e94e733caf7ee78a51048c85065e07589fccf13638e0a23465804afe5274a6ddcb0a9e7a0cdaf72293d1f3b6dd595d4d5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in htmlcuke.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Ray
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Htmlcuke
+
+A custom Html formatter for Cucumber that provides specific functionality.
+This formatter removes (if necessary) any color codes wrapped around puts statements within a suite that is using the ```colorized``` or similar gem.
+The formatter also embeds a screenshot link of the last window focused in a failed test and opens the shot in a new tab upon clicking the link.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'htmlcuke'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install htmlcuke
+
+## Usage
+
+This usage case assumes you have the directories ```reports``` and ```reports/screens``` located in the same directory within which your test will run.
+
+Add this line to your cucumber.yml, Rakefile, or command line arguments:
+```
+--format Htmlcuke::Formatter --out reports/cucumber_$(date '+%Y.%m.%d-%H.%M.%S').html
+```
+
+The --out assumes you will output the .html files to the reports directory under the naming convention cucumber + timestamp, feel free to change this as you see fit.
+
+A sample after hook in hooks.rb would be:
+
+```ruby
+After do |scenario|
+  Dir::mkdir('reports') unless File.directory?('reports')
+  Dir::mkdir('reports/screens') unless File.directory?('reports/screens')
+  if scenario.failed?
+    if scenario.respond_to?('scenario_outline')
+      screenshot = "./results/FAILED_#{(scenario.scenario_outline.title + ' ' + scenario.name).gsub(' ','_').gsub(/[^0-9A-Za-z_]/, '')}.png"
+      screenshot_format = "./reports/screens/FAILED_#{(scenario.scenario_outline.title + ' ' + scenario.name).gsub(' ','_').gsub(/[^0-9A-Za-z_]/, '')}.png"
+    else
+      screenshot = "./results/FAILED_#{scenario.name.gsub(' ','_').gsub(/[^0-9A-Za-z_]/, '')}.png"
+      screenshot_format = "./reports/screens/FAILED_#{scenario.name.gsub(' ','_').gsub(/[^0-9A-Za-z_]/, '')}.png"
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/htmlcuke/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/htmlcuke.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'htmlcuke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "htmlcuke"
+  spec.version       = Htmlcuke::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Nathan Ray"]
+  spec.email         = ["ntray1@gmail.com"]
+  spec.summary       = %q{See https://github.com/maizaAvaro/Htmlcuke for a description and usage case}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/maizaAvaro/Htmlcuke"
+  spec.license       = "MIT"
+
+  spec.add_dependency 'cucumber'
+
+  spec.post_install_message = <<-EOS
+
+  -------------------------------------------
+  | To use this formatter:                  |
+  |                                         |
+  | Add --format 'Htmlcuke::Formatter' to   |
+  | to your cucumber.yml, Rakefile, or on   |
+  | the command line after your arguments   |
+  -------------------------------------------
+
+EOS
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rake'
+end

data/lib/htmlcuke/formatter.rb

@@ -0,0 +1,29 @@
+require 'cucumber/formatter/html'
+
+  module Htmlcuke
+    class Formatter < Cucumber::Formatter::Html
+
+      def print_messages
+        return if @delayed_messages.empty?
+
+        @delayed_messages.each do |msg|
+          @builder.li(:class => 'step message') do
+            modified_msg = msg
+            modified_msg.to_s.gsub!(/\[[0-9;]*m/, '') # Remove color codes from colorizer/puts for HTML format only
+            @builder << modified_msg
+          end
+        end
+        empty_messages
+      end
+
+      def embed_image(src, label)
+        id = "img_#{@img_id}"
+        @img_id += 1
+        @builder.span(:class => 'embed') do |pre|
+          pre << %{<a href="" onclick="img=document.getElementById('#{id}'); img.style.display = 'none'; window.open('file://#{src}', '_blank');return false">#{label}</a><br>&nbsp;
+          <img id="#{id}" style="display: none" src="#{src}"/>} unless label == 'Screenshot' # if you want the image to show up on the same page change to: img.style.display = (img.style.display == 'none' ? 'block' : 'none')
+        end
+      end
+
+    end
+  end

data/lib/htmlcuke/version.rb

@@ -0,0 +1,3 @@
+module Htmlcuke
+  VERSION = "1.0.0"
+end

data/lib/htmlcuke.rb

@@ -0,0 +1 @@
+require 'htmlcuke/formatter'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: htmlcuke
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Ray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ntray1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- htmlcuke.gemspec
+- lib/htmlcuke.rb
+- lib/htmlcuke/formatter.rb
+- lib/htmlcuke/version.rb
+homepage: https://github.com/maizaAvaro/Htmlcuke
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2+
+
+    -------------------------------------------
+    | To use this formatter:                  |
+    |                                         |
+    | Add --format 'Htmlcuke::Formatter' to   |
+    | to your cucumber.yml, Rakefile, or on   |
+    | the command line after your arguments   |
+    -------------------------------------------
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: See https://github.com/maizaAvaro/Htmlcuke for a description and usage case
+test_files: []