feature_behavior 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6aa8f0a886160aaebf382daa8498747a286537e4e351ed9e054f9973da4cec7f
+  data.tar.gz: 5d19898954cf686a006210e23db32b8329bbee47e96d960934d19c3bc04f306f
+SHA512:
+  metadata.gz: 749503ae935902174aef61195893e03991751680218e8379ef9973b6d744f3127d7331e0c0f50b91c94bbf2c8b942e5a23e53f2305c6902d3e3022a45a1d4beb
+  data.tar.gz: a1aa67d0adb2aeafb3b80a231165c4ed7533445030e95f94ed54a11a15f002aaff1604cee97ca2a0c782668604bef8121dd024fb731df7f6b4f9467cd61834e4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-08
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Richard Jordan
+
+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,42 @@
+# FeatureBehavior
+
+Add behaveior steps to RSpec feature examples.
+
+## Installation
+
+Please do not do it earlier due to security reasons. Alternatively,
+replace this section with instructions to install your gem from git
+if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add feature_behavior
+
+If bundler is not being used to manage dependencies, install the gem
+by executing:
+
+    $ gem install feature_behavior
+
+## Usage
+
+TODO: Instructions to follow
+
+## 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/RichardJordan/feature_behavior.

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: :spec

data/feature_behavior.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/feature_behavior/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "feature_behavior"
+  spec.version = FeatureBehavior::VERSION
+  spec.authors = ["Richard Jordan"]
+  spec.email = ["richarddjordan@gmail.com"]
+  spec.licenses = ["MIT"]
+
+  spec.summary = "Add behaviors to RSpec feature spec runs"
+  spec.description = "Break up example blocks into behavior steps."
+  spec.homepage = "https://github.com/RichardJordan/feature_behavior"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/RichardJordan/feature_behavior"
+  spec.metadata["changelog_uri"] = "https://github.com/RichardJordan/feature_behavior/blob/main/CHANGELOG"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/feature_behavior/dsl.rb

@@ -0,0 +1,11 @@
+module FeatureBehavior
+  module DSL
+    def behavior(description, example = nil, &block)
+      Runner.run description, example, true, &block
+    end
+
+    def xbehavior(description, example = nil, &block)
+      Runner.run description, example, false, &block
+    end
+  end
+end

data/lib/feature_behavior/formatter.rb

@@ -0,0 +1,191 @@
+module FeatureBehavior
+  class Formatter < RSpec::Core::Formatters::DocumentationFormatter
+    RSpec::Core::Formatters.register self,
+      :example_failed,
+      :example_passed,
+      :example_started,
+      :behavior_terminated,
+      :behavior_passed,
+      :behavior_skipped,
+      :behavior_started,
+      :dump_pending,
+      :dump_summary
+
+
+    attr_reader :current_behavior,
+      :current_behavior_step,
+      :current_description,
+      :multi_step_example,
+      :skipped_behaviors,
+      :total_behaviors
+
+
+    def initialize(output)
+      super
+      @current_behavior = ""
+      @current_behavior_step = 0
+      @current_description = ""
+      @multi_step_example = false
+      @skipped_behaviors = []
+      @total_behaviors = 0
+    end
+
+    def behavior_passed(_notification)
+      msg = "#{step}#{current_behavior}"
+
+      if current_behavior_step == 1
+        output.puts "#{step_indent}#{"-" * msg.length}"
+      end
+
+      @last_msg = msg
+      output.puts colorized("#{step_indent}#{msg}", :success)
+    end
+
+    def behavior_skipped(notification)
+      @skipped_behaviors << notification
+      msg = "#{step}SKIPPED: #{current_behavior}"
+
+      if current_behavior_step == 1
+        output.puts "#{step_indent}#{"-" * msg.length}"
+      end
+
+      @last_msg = msg
+      output.puts colorized("#{step_indent}#{msg}", :blue)
+    end
+
+    def behavior_started(notification)
+      @total_behaviors += 1
+      @current_behavior = notification
+      @current_behavior_step += 1
+
+      if current_behavior_step == 1
+        @multi_step_example = true
+        msg = "#{current_description}, multiple steps:"
+        output.puts "#{current_indentation}#{msg}"
+      end
+    end
+
+    def behavior_terminated(_notification)
+    end
+
+    def dump_pending(notification)
+      super
+
+      if @skipped_behaviors.length > 0
+        msg = "\nBehaviors Pending: " \
+          "(Behaviors listed here have been intentionally skipped pending attention)"
+        @output << msg
+
+        results = []
+
+        @skipped_behaviors.each_with_index do |behavior, index|
+          results << skipped_behavior_dump_string(behavior, index)
+        end
+
+        @output << colorized("\n#{results.join("\n")}\n", :blue)
+      end
+    end
+
+    def dump_summary(notification)
+      behavior_summary if @total_behaviors > 0
+      super
+    end
+
+    def example_failed(_notification)
+      if multi_step_example
+        msg = "#{step}#{current_behavior} (Failed)"
+        output.puts colorized("#{step_indent}#{msg}", :failure)
+        output.puts "#{step_indent}#{"-" * msg.length}"
+        reset_behavior
+      end
+      super
+    end
+
+    def example_passed(_notification)
+      if multi_step_example
+        output.puts "#{step_indent}#{"-" * @last_msg.length}"
+        reset_behavior
+      end
+      super
+    end
+
+    def example_started(notification)
+      @current_behavior = ""
+      @current_behavior_step = 0
+      @current_description = notification.example.description
+      super
+    end
+
+
+    private
+
+    def behavior_summary
+      @output << "\n\nBehaviors:\n"
+
+      @output << colorized(
+        "\nTotal Behaviors Tested: #{total_behaviors}, Skipped: #{skipped_behaviors.length}\n",
+        behavior_summary_color,
+      )
+
+      @output << "\nExamples:\n"
+    end
+
+    def behavior_summary_color
+      skipped_behaviors.length > 0 ? :blue : :green
+    end
+
+    def colorized(text_string, color_scheme)
+      console_color_wrapper.wrap(text_string, color_scheme)
+    end
+
+    def console_color_wrapper
+      RSpec::Core::Formatters::ConsoleCodes
+    end
+
+    def reset_behavior
+      @current_behavior = nil
+      @multi_step_example = false
+    end
+
+    def skip_description_indent(idx)
+      " " * (skip_indent_length + 1 - Math.log10(idx + 1).to_i)
+    end
+
+    def skip_indent
+      " " * skip_indent_length
+    end
+
+    def skip_indent_length
+      Math.log10(skipped_behaviors.length).to_i
+    end
+
+    def skipped_behavior_dump_string(bh, idx)
+      colorized(
+        "\n  #{idx + 1})#{skip_description_indent(idx)}#{bh[:example_group_description]}" \
+        "\n     #{skip_indent}- Scenario: #{bh[:behavior_description_args].first}" \
+        "\n     #{skip_indent}- Behavior: #{bh[:current_behavior]}",
+        :blue
+      ) + colorized(
+        "\n     #{skip_indent}# Temporarily skipped with xbehavior" \
+        "\n     #{skip_indent}# #{bh[:location]}",
+        :cyan
+      )
+    end
+
+    def step
+      "Step#{step_number_indent}#{current_behavior_step}. "
+    end
+
+    def step_indent
+      "#{current_indentation}#{' ' * step_indent_extra_space_count}"
+    end
+
+    def step_indent_extra_space_count
+      2
+    end
+
+    def step_number_indent
+      current_behavior_step > 9 ? " " : "  "
+    end
+  end
+end

data/lib/feature_behavior/runner.rb

@@ -0,0 +1,83 @@
+module FeatureBehavior
+  class Runner
+
+    def self.run(description, example = nil, no_skip = true, &block)
+      new(description, example, no_skip, &block).run
+    end
+
+    attr_reader :description, :example, :example_block, :skipped
+
+    def initialize(description, example = nil, no_skip = true, &block)
+      @description = description
+      @example = example
+      @example_block = block
+      @skipped = !no_skip
+    end
+
+    def run
+      before_behavior
+      notify :behavior_started
+
+      if skipped
+        reporter.notify :behavior_skipped, skipped_behavior_args
+      else
+        run_example!
+        notify :behavior_passed
+      end
+
+      notify :behavior_terminated
+      after_behavior
+    end
+
+
+    private
+
+    def after_behavior
+      metadata[:description_args].pop
+      refresh_description
+    end
+
+    def before_behavior
+      metadata[:description_args].push(description)
+      refresh_description
+    end
+
+    def current_example
+      @current_example ||= example || RSpec.current_example
+    end
+
+    def metadata
+      current_example.metadata
+    end
+
+    def notify(event)
+      reporter.notify event, description
+    end
+
+    def refresh_description
+      metadata[:description] = metadata[:description_args].join(', ')
+
+      metadata[:full_description] = [
+        metadata[:example_group][:full_description],
+      ].concat(metadata[:description_args]).join(', ')
+    end
+
+    def reporter
+      current_example.reporter
+    end
+
+    def run_example!
+      example_block.call
+    end
+
+    def skipped_behavior_args
+      {
+        current_behavior: description,
+        example_group_description: metadata[:example_group][:full_description],
+        behavior_description_args: metadata[:description_args],
+        location: metadata[:location],
+      }
+    end
+
+  end
+end

data/lib/feature_behavior/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FeatureBehavior
+  VERSION = "0.1.0"
+end

data/lib/feature_behavior.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "feature_behavior/version"
+
+require 'feature_behavior/formatter'
+require 'feature_behavior/runner'
+
+module FeatureBehavior
+  class Error < StandardError; end
+
+end

data/sig/feature_behavior.rbs

@@ -0,0 +1,4 @@
+module FeatureBehavior
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: feature_behavior
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Jordan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-08 00:00:00.000000000 Z
+dependencies: []
+description: Break up example blocks into behavior steps.
+email:
+- richarddjordan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- feature_behavior.gemspec
+- lib/feature_behavior.rb
+- lib/feature_behavior/dsl.rb
+- lib/feature_behavior/formatter.rb
+- lib/feature_behavior/runner.rb
+- lib/feature_behavior/version.rb
+- sig/feature_behavior.rbs
+homepage: https://github.com/RichardJordan/feature_behavior
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/RichardJordan/feature_behavior
+  source_code_uri: https://github.com/RichardJordan/feature_behavior
+  changelog_uri: https://github.com/RichardJordan/feature_behavior/blob/main/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Add behaviors to RSpec feature spec runs
+test_files: []