turnip_documentation_formatter 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a0eaf35ce8b914fe9c8d2db2777289852d8e65044e1809f0e133893b4ebc59b
-  data.tar.gz: 39e741e3ccd7c5072787aa03962a832f26b8d9e3117ab5005368791a5f159f8a
+  metadata.gz: 4d53cdcd22ed895e13bb235ce93d832edca4ceb0cadfd3839fa374648c3d15a2
+  data.tar.gz: b7505b5b44825cbdd747044ca6eabbca54bbf41fb12b305012b10bc8758c0e78
 SHA512:
-  metadata.gz: eceea9cb12aef29e5f32a5b7d07476b18d00ea3ca3c457f9ce950d2da42cd12005f7eb44bf359b889d7507b39de77ab6ed7ac711d50f8b76a85de283706659f3
-  data.tar.gz: 2bd911181bb49e1549583fd70eddde784120ce407658c75cb885674c4fbe6b266e1558e9a8236c846eac40384af6ef21419e4ca47dde83cf1446a55e12772784
+  metadata.gz: c7d89e5f8e419016ca8f050c31825ed2213552dc2fb72688a290ae6c0cc1f33e74d77ddd4d9009fcbbc384619c39e025785e85e4dec25782616ced0958186e09
+  data.tar.gz: ff8b6aed5ee1cc43c0232d5caef2a098db86e6f0300afc57d9475a4b81e921ca9947dd1525b94b53162a17529d4e4cf38869e0b227cdaa068bfd80dc2a77d404

data/.gitignore

@@ -7,5 +7,8 @@
 /spec/reports/
 /tmp/
 
+# Ignore any build gems
+*.gem
+
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,55 +1,36 @@
 PATH
   remote: .
   specs:
-    turnip_documentation_formatter (0.0.1)
-      turnip (~> 4.3)
+    turnip_documentation_formatter (0.1)
+      rspec (~> 3.10)
+      turnip (~> 4.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
-    cucumber-gherkin (14.2.0)
-      cucumber-messages (~> 12.4, >= 12.4.0)
-    cucumber-messages (12.4.0)
-      protobuf-cucumber (~> 3.10, >= 3.10.8)
-    diff-lcs (1.4.4)
-    i18n (1.8.11)
-      concurrent-ruby (~> 1.0)
-    middleware (0.1.0)
-    minitest (5.14.4)
-    protobuf-cucumber (3.10.8)
-      activesupport (>= 3.2)
-      middleware
-      thor
-      thread_safe
+    cucumber-gherkin (24.1.0)
+      cucumber-messages (~> 19.1, >= 19.1.4)
+    cucumber-messages (19.1.4)
+    cuke_modeler (3.17.0)
+      cucumber-gherkin (< 25.0)
+    diff-lcs (1.5.0)
     rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    thor (1.1.0)
-    thread_safe (0.3.6)
-    turnip (4.3.0)
-      cucumber-gherkin (~> 14.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    turnip (4.4.0)
+      cuke_modeler (~> 3.15)
       rspec (>= 3.0, < 4.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-linux
@@ -60,4 +41,4 @@ DEPENDENCIES
   turnip_documentation_formatter!
 
 BUNDLED WITH
-   2.2.15
+   2.2.25

data/README.md

@@ -4,6 +4,10 @@ This gem extends the default RSpec documentation formatter for [Turnip](https://
 
 This makes it easier to see on exactly which step an error occured.
 
+## Screenshot
+
+![Before example](https://user-images.githubusercontent.com/242972/81497557-779c7900-92e9-11ea-919f-d4d714540267.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,6 +23,12 @@ And then execute:
 Or install it yourself as:
 
     $ gem install turnip_documentation_formatter
+    
+And require the formatter in `spec_helper.rb`:
+
+```ruby
+require "turnip_documentation_formatter"
+```
 
 ## Usage
 
@@ -32,7 +42,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/turnip-documentation-formatter.
+Bug reports and pull requests are welcome on GitHub at https://github.com/aramvisser/turnip-documentation-formatter.
 
 ## License
 

data/lib/turnip_documentation_formatter/version.rb

@@ -2,6 +2,6 @@
 
 module Turnip
   module DocumentationFormatter
-    VERSION = "0.0.1"
+    VERSION = "0.1"
   end
 end

data/lib/turnip_documentation_formatter.rb

@@ -4,7 +4,6 @@ require 'rspec'
 require 'turnip'
 require 'turnip/rspec'
 
-require "turnip_documentation_formatter/turnip_extension.rb"
 require "turnip_documentation_formatter/version"
 
 module Turnip

data/turnip-documentation-formatter.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "turnip", "~> 4.3"
+  spec.add_runtime_dependency "turnip", "~> 4.4"
   spec.add_runtime_dependency "rspec", "~> 3.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnip_documentation_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Aram Visser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turnip
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -57,7 +57,6 @@ files:
 - bin/setup
 - examples/documentation_formatter.feature
 - lib/turnip_documentation_formatter.rb
-- lib/turnip_documentation_formatter/turnip_extension.rb
 - lib/turnip_documentation_formatter/version.rb
 - turnip-documentation-formatter.gemspec
 homepage:
@@ -80,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: RSpec documentation formatter for Turnip

data/lib/turnip_documentation_formatter/turnip_extension.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module Turnip::RSpec
-  module Execute
-    def run_step(feature_file, step)
-      reporter = ::RSpec.current_example.reporter
-      reporter.publish(:step_started, { step: step })
-
-      begin
-        instance_eval <<-EOS, feature_file, step.line
-          step(step)
-        EOS
-      rescue Turnip::Pending => e
-        reporter.publish(:step_pending, { step: step })
-
-        example = ::RSpec.current_example
-        example.metadata[:line_number] = step.line
-        example.metadata[:location] = "#{example.metadata[:file_path]}:#{step.line}"
-
-        if ::RSpec.configuration.raise_error_for_unimplemented_steps
-          e.backtrace.push "#{feature_file}:#{step.line}:in `#{step.description}'"
-          raise
-        end
-
-        skip("No such step: '#{e}'")
-      rescue StandardError, ::RSpec::Expectations::ExpectationNotMetError => e
-        reporter.publish(:step_failed, { step: step })
-
-        e.backtrace.push "#{feature_file}:#{step.line}:in `#{step.description}'"
-        raise e
-      end
-
-      reporter.publish(:step_passed, { step: step })
-    end
-  end
-
-  class << self
-    def run(feature_file)
-      feature = Turnip::Builder.build(feature_file)
-
-      return nil if feature.nil?
-
-      instance_eval <<-EOS, feature_file, feature.line
-        context = ::RSpec.describe feature.name, feature.metadata_hash
-        run_scenario_group(context, feature, feature_file)
-      EOS
-    end
-
-    private
-
-    #
-    # @param  [RSpec::ExampleGroups]  context
-    # @param  [Turnip::Node::Feature|Turnip::Node::Rule]  group
-    # @param  [String]  filename
-    #
-    def run_scenario_group(context, group, filename)
-      background_steps = group.backgrounds.map(&:steps).flatten
-
-      context.before do
-        background_steps.each do |step|
-          run_step(filename, step)
-        end
-      end
-
-      group.scenarios.each do |scenario|
-        all_steps = background_steps + scenario.steps
-        description = all_steps.map(&:to_s).join(' -> ')
-        metadata = scenario.metadata_hash.merge(turnip_steps: all_steps)
-
-        context.describe scenario.name, metadata do
-          instance_eval <<-EOS, filename, scenario.line
-            it description do
-              scenario.steps.each do |step|
-                run_step(filename, step)
-              end
-            end
-          EOS
-        end
-      end
-
-      if group.is_a?(Turnip::Node::Feature)
-        group.rules.each do |rule|
-          rule_context = context.context(rule.name, { turnip: true })
-          run_scenario_group(rule_context, rule, filename)
-        end
-      end
-    end
-  end
-end