spinach_file_reporter 0.0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c36e9f36eae4d906bd88a0897b52fcec867b91c
+  data.tar.gz: 4caf81fb55686887ba8846a1a91e376207fb4da9
+SHA512:
+  metadata.gz: 32e5e1575393a586c34257e3158cde8d42b39dd077770368e2367148980f314712be56f85cf2895bf168cc404c7c871eb620b332efd8688378cf13c40610bc46
+  data.tar.gz: 232be7b501e2768cbae08f746f0da3e1c2d0b024b139c72656c6c0d61bc86538cba56edfcc5cd2ea7435361485312ed8c5bce45d5e8383eb986d9033de77b768

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yi Wen
+
+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,34 @@
+# spinach_file_reporter
+Gem version: 0.0.1
+
+Reporter for Spinach tests. This reports to console and into a file.
+File is saved under tmp/spinach_errors.txt
+
+This is a reporter that meant to use on Jenkins, combined with (https://github.com/dblock/jenkins-ansicolor-plugin) to bring the color output to Jenkins console.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spinach-file-reporter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spinach-file-reporter
+
+## Usage
+
+```bash
+$ bundle exec spinach -r file_reporter
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/spinach_file_reporter/gem_description.rb

@@ -0,0 +1,16 @@
+module Spinach
+  module FileReporter
+    module Reporter
+      module GemDescription
+        class << self
+          def to_s
+            <<-EOF
+            This is a console and file reporter for spinach. It works like output reporter of
+            spinach and add a file reporter of the errors to a file
+            EOF
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spinach_file_reporter/spinach_file_reporter.rb

@@ -0,0 +1,203 @@
+# encoding: utf-8
+module Spinach
+  class Reporter
+    # The Stdout reporter outputs the runner results to the standard output
+    #
+    class FileReporter < Reporter
+      include Reporting
+
+      # Initialitzes the runner
+      #
+      # @param [Hash] options
+      #  Sets a custom output buffer by setting options[:output]
+      #  Sets a custom error buffer by setting options[:error]
+      #
+      def initialize(*args)
+        super(*args)
+        @out = options[:output] || $stdout
+        @error = options[:error] || $stderr
+        @max_step_name_length = 0
+        @file_errors = []
+      end
+
+      def after_run(success)
+        if !success
+          file = File.new("tmp/spinach_errors.txt", "w")
+          file.puts @file_errors.uniq.join(' ')
+          file.close
+        else
+          File.delete("tmp/spinach.txt")
+        end
+      end
+
+      # Prints the feature name to the standard output
+      #
+      # @param [Hash] data
+      #   The feature in a JSON GherkinRubyRuby format
+      #
+      def before_feature_run(feature)
+        name = feature.name
+        out.puts "\n#{'Feature:'.magenta} #{name.light_magenta}"
+      end
+
+      # Prints the scenario name to the standard ouput
+      #
+      # @param [Hash] data
+      #   The feature in a JSON GherkinRubyRuby format
+      #
+      def before_scenario_run(scenario, step_definitions = nil)
+        @max_step_name_length = scenario.steps.map(&:name).map(&:length).max if scenario.steps.any?
+        name = scenario.name
+        out.puts "\n  #{'Scenario:'.green} #{name.light_green}"
+      end
+
+      # Adds an error report and re
+      #
+      # @param [Hash] data
+      #   The feature in a JSON GherkinRubyRuby format
+      #
+      def after_scenario_run(scenario, step_definitions = nil)
+        if scenario_error
+          report_error(scenario_error, :full)
+          self.scenario_error = nil
+        end
+      end
+
+      # Adds a passed step to the output buffer.
+      #
+      # @param [Step] step
+      #   The step.
+      #
+      # @param [Array] step_location
+      #   The step source location
+      #
+      def on_successful_step(step, step_location, step_definitions = nil)
+        output_step('✔', step, :green, step_location)
+        self.scenario = [current_feature, current_scenario, step]
+        successful_steps << scenario
+      end
+
+      # Adds a failing step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON GherkinRubyRuby format
+      #
+      # @param [Exception] failure
+      #   The exception that caused the failure
+      #
+      def on_failed_step(step, failure, step_location, step_definitions = nil)
+        output_step('✘', step, :red, step_location)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        feature = step_location[0].split( '/' ).last.split('.').first
+        @file_errors.push( "features/#{feature}.feature") if step_location
+        failed_steps << scenario_error
+      end
+
+      # Adds a step that has raised an error to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON GherkinRubyRuby format
+      #
+      # @param [Exception] failure
+      #   The exception that caused the failure
+      #
+      def on_error_step(step, failure, step_location, step_definitions = nil)
+        output_step('!', step, :red, step_location)
+        feature = step_location[0].split( '/' ).last.split('.').first
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        error_steps << scenario_error
+      end
+
+      # Adds an undefined step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON GherkinRubyRuby format
+      #
+      def on_undefined_step(step, failure, step_definitions = nil)
+        output_step('?', step, :red)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        undefined_steps << scenario_error
+      end
+
+      # Adds an undefined step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON GherkinRubyRuby format
+      #
+      def on_pending_step(step, failure)
+        output_step('P', step, :yellow)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        pending_steps << scenario_error
+      end
+
+      # Adds a feature not found message to the output buffer.
+      #
+      # @param [Hash] feature
+      #   the feature in a json gherkin format
+      #
+      # @param [Spinach::FeatureNotFoundException] exception
+      #   the related exception
+      #
+      def on_feature_not_found(feature)
+        generator = Generators::FeatureGenerator.new(feature)
+        lines = "Could not find steps for `#{feature.name}` feature\n\n"
+        lines << "\nPlease create the file #{generator.filename} at #{generator.path}, with:\n\n"
+
+        lines << generator.generate
+
+        lines.split("\n").each do |line|
+          out.puts "    #{line}".red
+        end
+        out.puts "\n\n"
+
+        undefined_features << feature
+      end
+
+      # Adds a step that has been skipped to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step that GherkinRubyRuby extracts
+      #
+      def on_skipped_step(step, step_definitions = nil)
+        output_step('~', step, :cyan)
+      end
+
+      # Adds to the output buffer a step result
+      #
+      # @param [String] symbol
+      #   A symbol to prepend before the step keyword (might be useful to
+      #   indicate if everything went ok or not).
+      #
+      # @param [Hash] step
+      #   The step in a JSON GherkinRubyRuby format
+      #
+      # @param [Symbol] color
+      #   The color code to use with Colorize to colorize the output.
+      #
+      # @param [Array] step_location
+      #   step source location and file line
+      #
+      def output_step(symbol, step, color, step_location = nil)
+        step_location = step_location.first.gsub("#{File.expand_path('.')}/", '# ')+":#{step_location.last.to_s}" if step_location
+        max_length = @max_step_name_length + 60 # Colorize and output format correction
+
+        # REMEMBER TO CORRECT PREVIOUS MAX LENGTH IF OUTPUT FORMAT IS MODIFIED
+        buffer = []
+        buffer << indent(4)
+        buffer << symbol.colorize(:"light_#{color}")
+        buffer << indent(2)
+        buffer << step.keyword.colorize(:"light_#{color}")
+        buffer << indent(1)
+        buffer << step.name.colorize(color)
+        joined = buffer.join.ljust(max_length)
+
+        out.puts(joined + step_location.to_s.colorize(:grey))
+      end
+
+      private
+      def indent(n = 1)
+        " " * n
+      end
+    end
+  end
+end

data/lib/spinach_file_reporter.rb

@@ -0,0 +1 @@
+require_relative "spinach_file_reporter/spinach_file_reporter"

data/spinach_file_reporter.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "spinach_file_reporter/gem_description"
+
+Gem::Specification.new do |s|
+  s.name        = 'spinach_file_reporter'
+  s.version     = '0.0.1.1'
+  s.date        = '2015-07-24'
+  s.summary     = 'Reporter for spinach with file output'
+  s.description = Spinach::FileReporter::Reporter::GemDescription.to_s
+  s.authors     = ["JuanMa Jurado"]
+  s.email       = "JuanMa Jurado"
+  s.license     = 'MIT'
+  s.files       = `git ls-files`.split($\)
+  s.require_paths = ["lib"]
+  s.homepage    = 'https://github.com/jmjurado23/spinach_file_reporter'
+
+  s.add_runtime_dependency(%q<spinach>, '~>0.4')
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: spinach_file_reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1.1
+platform: ruby
+authors:
+- JuanMa Jurado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spinach
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: |2
+              This is a console and file reporter for spinach. It works like output reporter of
+              spinach and add a file reporter of the errors to a file
+email: JuanMa Jurado
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/spinach_file_reporter.rb
+- lib/spinach_file_reporter/gem_description.rb
+- lib/spinach_file_reporter/spinach_file_reporter.rb
+- spinach_file_reporter-0.0.1.gem
+- spinach_file_reporter.gemspec
+homepage: https://github.com/jmjurado23/spinach_file_reporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: Reporter for spinach with file output
+test_files: []