turnip_documentation_formatter 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--require turnip/rspec

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in turnip-documentation-formatter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    turnip_documentation_formatter (0.0.1)
+      turnip (~> 4.3)
+
+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
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      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 (>= 3.0, < 4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  turnip_documentation_formatter!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Aram Visser
+
+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,39 @@
+# Turnip Documentation Formatter
+
+This gem extends the default RSpec documentation formatter for [Turnip](https://github.com/jnicklas/turnip) to print each step on it's own line.
+
+This makes it easier to see on exactly which step an error occured.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'turnip_documentation_formatter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install turnip_documentation_formatter
+
+## Usage
+
+Use the default documentation formatter when running RSpec (`rspec --format documentation`).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/turnip-documentation-formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "turnip/documentation_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/documentation_formatter.feature

@@ -0,0 +1,17 @@
+Feature: Documentation formatter examples
+  Scenario: Passing
+    Given there is a monster
+    When I attack it
+    Then it should die
+
+  Scenario: Error
+    Given there is a monster
+    When I attack it
+    And raise error
+    Then it should die
+
+  Scenario: Pending
+    Given there is a monster
+    When I attack it
+    And do something unexpected
+    Then it should die

data/lib/turnip_documentation_formatter/turnip_extension.rb

@@ -0,0 +1,89 @@
+# 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

data/lib/turnip_documentation_formatter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Turnip
+  module DocumentationFormatter
+    VERSION = "0.0.1"
+  end
+end

data/lib/turnip_documentation_formatter.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'turnip'
+require 'turnip/rspec'
+
+require "turnip_documentation_formatter/turnip_extension.rb"
+require "turnip_documentation_formatter/version"
+
+module Turnip
+  # Extensions for the RSpec documentation formatter
+  module DocumentationFormatter
+    def initialize(output)
+      super
+
+      @current_step = nil
+      @remaining_scenario_steps = []
+    end
+
+    def example_started(notification)
+      super if defined?(super)
+
+      @remaining_scenario_steps = notification.example.metadata[:turnip_steps].dup
+    end
+
+    def step_started(notification)
+      @current_step = notification.step
+      @remaining_scenario_steps.shift
+    end
+
+    def step_passed(notification)
+      output.puts step_passed_output(notification.step)
+    end
+
+    def example_passed(passed)
+      return super unless turnip_example?(passed)
+
+      flush_messages if respond_to? :flush_messages
+      @example_running = false
+    end
+
+    def example_pending(pending)
+      return super unless turnip_example?(pending)
+
+      output.puts step_pending_output(@current_step,
+                                      pending.example.execution_result.pending_message)
+      output.puts remaining_step_names
+
+      flush_messages if respond_to? :flush_messages
+      @example_running = false
+    end
+
+    def example_failed(failure)
+      return super unless turnip_example?(failure)
+
+      failure.example.metadata[:failed_step] = @current_step
+      output.puts step_failed_output(@current_step)
+      output.puts remaining_step_names
+
+      flush_messages if respond_to? :flush_messages
+      @example_running = false
+    end
+
+    private
+
+      def turnip_example?(notification)
+        notification.example.metadata[:turnip]
+      end
+
+      def step_passed_output(step)
+        ::RSpec::Core::Formatters::ConsoleCodes.wrap("#{current_indentation}#{step}",
+                                                     :success)
+      end
+
+      def step_pending_output(step, message)
+        ::RSpec::Core::Formatters::ConsoleCodes.wrap("#{current_indentation}#{step} " \
+                                                     "(PENDING: #{message})",
+                                                     :pending)
+      end
+
+      def step_failed_output(step)
+        ::RSpec::Core::Formatters::ConsoleCodes.wrap("#{current_indentation}#{step} " \
+                                                     "(FAILED - #{next_failure_index})",
+                                                     :failure)
+      end
+
+      def remaining_step_names
+        @remaining_scenario_steps.map do |step|
+          "#{current_indentation}#{step}"
+        end
+      end
+  end
+end
+
+
+# Only extend documentation formatter if it's loaded
+if defined?(::RSpec::Core)
+  # Extend the default documentation formatter
+  class RSpec::Core::Formatters::DocumentationFormatter
+    RSpec::Core::Formatters.register self, :example_started, :example_group_started, :example_group_finished,
+                            :example_passed, :example_pending, :example_failed, :step_started, :step_passed
+
+
+    prepend Turnip::DocumentationFormatter
+  end
+
+  # Make sure the documentation formatter listens for turnip events if it's already registered
+  RSpec.world.reporter.registered_listeners(:example_started).each do |formatter|
+    if formatter.is_a? RSpec::Core::Formatters::DocumentationFormatter
+      RSpec.world.reporter.register_listener formatter, :step_started, :step_passed
+    end
+  end
+
+  # Highlight error step in summary description
+  class RSpec::Core::Formatters::ExceptionPresenter
+    def encoded_description(description)
+      return if description.nil?
+
+      if example.metadata[:turnip] && example.metadata[:failed_step]
+        step = example.metadata[:failed_step].to_s
+        error = ::RSpec::Core::Formatters::ConsoleCodes.wrap(step, :failure)
+        description = description.gsub(step, error)
+      end
+
+      encoded_string(description)
+    end
+  end
+end

data/turnip-documentation-formatter.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/turnip_documentation_formatter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "turnip_documentation_formatter"
+  spec.version       = Turnip::DocumentationFormatter::VERSION
+  spec.authors       = ["Aram Visser"]
+  spec.email         = ["hello@aramvisser.com"]
+
+  spec.summary       = "RSpec documentation formatter for Turnip"
+  spec.description   = "Show each turnip step on it's own line when using the documentation formatter (`rspec -fd`)"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["source_code_uri"] = "https://github.com/aramvisser/turnip_documentation_formatter"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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 "rspec", "~> 3.10"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: turnip_documentation_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aram Visser
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Show each turnip step on it's own line when using the documentation formatter
+  (`rspec -fd`)
+email:
+- hello@aramvisser.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- 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:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/aramvisser/turnip_documentation_formatter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: RSpec documentation formatter for Turnip
+test_files: []