rspec_magic 0.1.2

data/lib/rspec_magic/stable/use_method_discovery.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+"LODoc"
+
+module RSpecMagic; module Stable
+  # Create an automatic +let+ variable containing the method or action name,
+  # computed from the description of the parent +describe+.
+  #
+  #   describe do
+  #     use_method_discovery :m
+  #
+  #     subject { m }
+  #
+  #     describe "#first_name" do
+  #       it { is_expected.to eq :first_name }
+  #     end
+  #
+  #     describe ".some_stuff" do
+  #       it { is_expected.to eq :some_stuff }
+  #     end
+  #
+  #     describe "GET some_action" do
+  #       describe "intermediate context" do
+  #         it { is_expected.to eq :some_action }
+  #       end
+  #     end
+  #   end
+  #
+  module UseMethodDiscovery
+    module Exports
+      # Enable the discovery mechanics.
+      # @param [Symbol] method_let
+      def use_method_discovery(method_let)
+        # This context and all sub-contexts will respond to A and return B. "Signature" is based on
+        # invocation arguments which can vary as we use the feature more intensively. Signature method
+        # is the same, thus it shadows higher level definitions completely.
+        signature = { method_let: method_let }
+        define_singleton_method(:_umd_signature) { signature }
+
+        let(method_let) do
+          # NOTE: `self.class` responds to signature method, no need to probe and rescue.
+          if (sig = (klass = self.class)._umd_signature) != signature
+            raise "`#{method_let}` is shadowed by `#{sig.fetch(:method_let)}` in this context"
+          end
+
+          # NOTE: Better not `return` from the loop to keep it debuggable in case logic changes.
+          found = nil
+          while (klass._umd_signature rescue nil) == signature
+            found = self.class.send(:_use_method_discovery_parser, klass.description.to_s) and break
+            klass = klass.superclass
+          end
+
+          found or raise "No method-like descriptions found to use as `#{method_let}`"
+        end
+      end
+
+      private
+
+      # The parser used by {.use_method_discovery}.
+      # @param [String] input
+      # @return [Symbol] Method name, if parsed okay.
+      # @return [nil] If input isn't method-like.
+      def _use_method_discovery_parser(input)
+        if (mat = input.match(/^(?:(?:#|\.|::)(\w+(?:\?|!|=|)|\[\])|(?:DELETE|GET|PUT|POST) (\w+))$/))
+          (mat[1] || mat[2]).to_sym
+        end
+      end
+    end # Exports
+  end # module
+
+  # Activate.
+  defined?(RSpec) && RSpec.respond_to?(:configure) and RSpec.configure do |config|
+    config.extend UseMethodDiscovery::Exports
+  end
+end; end

data/lib/rspec_magic/stable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RSpecMagic
+  # "Stable" feature set.
+  #
+  #   # `spec/spec_helper.rb`.
+  #   require "rspec_magic/stable"
+  #
+  module Stable
+  end
+end
+
+Dir[File.expand_path("../stable/**/*.rb", __FILE__)].each { |fn| require fn }

data/lib/rspec_magic/unstable/include_dir_context.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "../config"
+
+module RSpecMagic; module Unstable
+  # Organize shared contexts in a hierarchy.
+  # Import relevant shared contexts into the given test.
+  #
+  #   describe … do
+  #     include_dir_context __dir__
+  #     …
+  #   end
+  #
+  # See the README file for more information.
+  module IncludeDirContext
+    module Exports
+      # Include the relevant shared contexts hierarchy.
+      # @param [String] dir
+      def include_dir_context(dir)
+        root = Config.spec_path
+
+        d, steps = dir, []
+        while d.start_with?(root)
+          steps << d
+          d = File.split(d).first
+        end
+
+        steps.reverse.each do |d|
+          begin; include_context d; rescue ArgumentError; end
+        end
+      end
+    end # Exports
+  end # module
+
+  # Activate.
+  defined?(RSpec) && RSpec.respond_to?(:configure) and RSpec.configure do |config|
+    config.extend IncludeDirContext::Exports
+  end
+end; end

data/lib/rspec_magic/unstable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RSpecMagic
+  # "Unstable" feature set.
+  #
+  #   # `spec/spec_helper.rb`.
+  #   require "rspec_magic/unstable"
+  #
+  module Unstable
+  end
+end
+
+Dir[File.expand_path("../unstable/**/*.rb", __FILE__)].each { |fn| require fn }

data/lib/rspec_magic/version.rb

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

data/lib/rspec_magic.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Load the "world" features.
+require_relative "rspec_magic/config"
+require_relative "rspec_magic/version"
+
+# Actual features are NOT loaded automatically.
+
+# A set of extensions for writing compact and expressive tests.
+module RSpecMagic
+end

data/rspec_magic.gemspec

@@ -0,0 +1,17 @@
+
+require_relative "lib/rspec_magic/version"
+
+Gem::Specification.new do |s|
+  s.name = "rspec_magic"
+  s.summary = "A set of extensions for writing compact and expressive tests"
+  s.version = RSpecMagic::VERSION
+
+  s.authors = ["Alex Fortuna"]
+  s.email = ["fortunadze@gmail.com"]
+  s.homepage = "https://github.com/dadooda/rspec_magic"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+end

data/spec/lib/rspec_magic/alias_method_spec.rb

@@ -0,0 +1,19 @@
+
+describe "`alias_method` matcher" do
+  describe "klass" do
+    let(:klass) do
+      Class.new do
+        def one; end
+        alias_method :one1, :one
+
+        def two; end
+        alias two2 two
+      end
+    end
+
+    subject { klass.new }
+
+    it { is_expected.to alias_method(:one1, :one) }
+    it { is_expected.to alias_method(:two2, :two) }
+  end
+end

data/spec/lib/rspec_magic/context_when_spec.rb

@@ -0,0 +1,45 @@
+
+require "json"
+
+describe ".context_when" do
+  context "when default" do
+    context_when a: 1, "b" => 2, x: "y" do
+      description = self.description
+      it { expect([a, b, x]).to eq [1, 2, "y"] }
+      it { expect { c }.to raise_error(NameError, /^undefined local variable or method `c'/) }
+      it { expect(description).to eq 'when { a: 1, "b" => 2, x: "y" }' }
+    end
+  end
+
+  context "when customized" do
+    def self._context_when_formatter(h)
+      "when #{h.to_json}"
+    end
+
+    describe "intermediate context" do
+      context_when a: 1, x: "y" do
+        description = self.description
+        it { expect([a, x]).to eq [1, "y"] }
+        it { expect(description).to eq 'when {"a":1,"x":"y"}' }
+      end
+    end
+  end # context "when customized"
+
+  describe "doc examples" do
+    describe "*" do
+      context_when name: "Joe", age: 25 do
+        it do
+          expect([name, age]).to eq ["Joe", 25]
+        end
+      end
+
+      context "when { name: \"Joe\", age: 25 }" do
+        let(:name) { "Joe" }
+        let(:age) { 25 }
+        it do
+          expect([name, age]).to eq ["Joe", 25]
+        end
+      end
+    end
+  end # describe "doc examples"
+end

data/spec/lib/rspec_magic/described_sym_spec.rb

@@ -0,0 +1,39 @@
+
+describe "`#described_sym` and friends" do
+  use_method_discovery :m
+
+  # WARNING! These are real, global classes we create here.
+
+  class CSVRow; end
+
+  class PageTitle
+    class Style
+    end
+  end
+
+  subject { public_send(m) }
+
+  describe "#described_sym" do
+    context "when the class is named like …" do
+      describe CSVRow do
+        it { is_expected.to eq :csv_row }
+      end
+
+      describe PageTitle do
+        it { is_expected.to eq :page_title }
+      end
+
+      describe PageTitle::Style do
+        # NOTE: That's how it works. Not sure if that's utterly useful though.
+        it { is_expected.to eq :"page_title/style" }
+      end
+    end # context "when the class is named like …"
+  end
+
+  # Just ping it briefly.
+  describe "#me" do
+    describe CSVRow do
+      it { is_expected.to eq :csv_row }
+    end
+  end
+end

data/spec/lib/rspec_magic/include_dir_context/README.md

@@ -0,0 +1,2 @@
+
+This directory with all subdirectories is a single test.

data/spec/lib/rspec_magic/include_dir_context/_context.rb

@@ -0,0 +1,4 @@
+
+shared_context __dir__ do
+  def global_sign; "root"; end
+end

data/spec/lib/rspec_magic/include_dir_context/app/_context.rb

@@ -0,0 +1,4 @@
+
+shared_context __dir__ do
+  def local_sign; "root/app"; end
+end

data/spec/lib/rspec_magic/include_dir_context/app/idc_consumer_spec.rb

@@ -0,0 +1,15 @@
+
+describe "`.include_dir_context` at root/app" do
+  include_dir_context __dir__
+  use_method_discovery :m
+
+  subject { public_send(m) }
+
+  describe "#global_sign" do
+    it { is_expected.to eq "root" }
+  end
+
+  describe "#local_sign" do
+    it { is_expected.to eq "root/app" }
+  end
+end

data/spec/lib/rspec_magic/include_dir_context/app/models/_context.rb

@@ -0,0 +1,4 @@
+
+shared_context __dir__ do
+  def local_sign; "root/app/models"; end
+end

data/spec/lib/rspec_magic/include_dir_context/app/models/idc_consumer_spec.rb

@@ -0,0 +1,15 @@
+
+describe "`.include_dir_context` at root/app/models" do
+  include_dir_context __dir__
+  use_method_discovery :m
+
+  subject { public_send(m) }
+
+  describe "#global_sign" do
+    it { is_expected.to eq "root" }
+  end
+
+  describe "#local_sign" do
+    it { is_expected.to eq "root/app/models" }
+  end
+end

data/spec/lib/rspec_magic/include_dir_context/idc_consumer_spec.rb

@@ -0,0 +1,15 @@
+
+describe "`.include_dir_context` at root" do
+  include_dir_context __dir__
+  use_method_discovery :m
+
+  subject { public_send(m) }
+
+  describe "#global_sign" do
+    it { is_expected.to eq "root" }
+  end
+
+  describe "#local_sign" do
+    it { expect { subject }.to raise_error(NoMethodError) }
+  end
+end

data/spec/lib/rspec_magic/use_letset_spec.rb

@@ -0,0 +1,134 @@
+
+describe ".use_letset" do
+  describe "straight usage" do
+    use_letset :let_a, :attrs
+    use_letset :let_d, :data
+
+    # Same-level definition. Important case.
+    let_a(:name) { "Joe" }
+
+    let_d(:number) { 12 }
+
+    describe "attrs" do
+      let_a(:age) { 25 }
+
+      describe "sub-context" do
+        # Redefinition via `let`.
+        let_a(:age) { 36 }
+        let_a(:gender) { :male }
+        it do
+          expect(name).to eq "Joe"
+          expect(age).to eq 36
+          expect(gender).to eq :male
+          expect(attrs).to eq(name: "Joe", age: 36, gender: :male)
+        end
+      end
+
+      it do
+        expect(name).to eq "Joe"
+        expect(age).to eq 25
+        expect(attrs).to eq(name: "Joe", age: 25)
+      end
+    end
+
+    describe "data" do
+      it do
+        expect(number).to eq 12
+        expect(data).to eq(number: 12)
+      end
+    end
+  end
+
+  describe "declarative (no block) usage" do
+    use_letset :let_a, :attrs
+
+    let_a(:name)
+
+    subject { attrs }
+
+    context "when no `let` value" do
+      context "when additional other `let` value" do
+        let_a(:age) { 25 }
+        it { is_expected.to eq(age: 25) }
+      end
+
+      it do
+        expect { name }.to raise_error RSpec::Core::ExampleGroup::WrongScopeError
+        expect(attrs).to eq({})
+      end
+    end
+
+    context "when `let`" do
+      let(:name) { "Joe" }
+      it { is_expected.to eq(name: "Joe") }
+    end
+
+    context "when `let_a`" do
+      let_a(:name) { "Joe" }
+      it { is_expected.to eq(name: "Joe") }
+    end
+
+    # Real-life thing follows, that's what we need declarative mode for.
+    context_when name: "Joe" do
+      context_when name: "Moe" do
+        it { is_expected.to eq(name: "Moe") }
+      end
+
+      it { is_expected.to eq(name: "Joe") }
+    end
+  end # describe "declarative (no block) usage"
+
+  describe "doc examples" do
+    describe "EN" do
+      describe do
+        # Method is `let_a`. Collection is `attrs`.
+        use_letset :let_a, :attrs
+
+        # Declare `attrs` elements.
+        let_a(:age)
+        let_a(:name)
+
+        subject { attrs }
+
+        # None of the elements is set yet.
+        it { is_expected.to eq({}) }
+
+        # Set `name` and see it in the collection.
+        context_when name: "Joe" do
+          it { is_expected.to eq(name: "Joe") }
+
+          # Add `age` and see both in the collection.
+          context_when age: 25 do
+            it { is_expected.to eq(name: "Joe", age: 25) }
+          end
+        end
+      end
+    end # describe "EN"
+
+    describe "RU" do
+      describe do
+        # Метод -- `let_a`. Коллекция -- `attrs`.
+        use_letset :let_a, :attrs
+
+        # Декларируем переменные, которые составляют коллекцию `attrs`.
+        let_a(:age)
+        let_a(:name)
+
+        subject { attrs }
+
+        # Ни одна переменная пока не задана, поэтому коллекция будет пустой.
+        it { is_expected.to eq({}) }
+
+        # Задаём `name` и видим его в коллекции.
+        context_when name: "Joe" do
+          it { is_expected.to eq(name: "Joe") }
+
+          # Задаём `age` и видим обе переменные в коллекции.
+          context_when age: 25 do
+            it { is_expected.to eq(name: "Joe", age: 25) }
+          end
+        end
+      end
+    end # describe "RU"
+  end # describe "doc examples"
+end

data/spec/lib/rspec_magic/use_method_discovery_spec.rb

@@ -0,0 +1,24 @@
+
+describe ".use_method_discovery" do
+  describe "doc examples" do
+    describe do
+      use_method_discovery :m
+
+      subject { m }
+
+      describe "#first_name" do
+        it { is_expected.to eq :first_name }
+      end
+
+      describe ".some_stuff" do
+        it { is_expected.to eq :some_stuff }
+      end
+
+      describe "GET some_action" do
+        describe "intermediate context" do
+          it { is_expected.to eq :some_action }   # (1)
+        end
+      end
+    end
+  end # describe "doc examples"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+
+# Must go before all.
+require_relative "support/simplecov"
+
+# Load support files.
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |fn| require fn }
+
+# Load shared context hierarchy.
+Dir[File.expand_path("**/_context.rb", __dir__)].each { |fn| require fn }

data/spec/support/self.rb

@@ -0,0 +1,6 @@
+
+require "rspec_magic/stable"
+require "rspec_magic/unstable"
+
+# Required by some features.
+RSpecMagic::Config.spec_path = File.expand_path("..", __dir__)

data/spec/support/simplecov.rb

@@ -0,0 +1,11 @@
+
+#
+# See https://github.com/simplecov-ruby/simplecov#getting-started.
+#
+
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "libx/"
+  add_filter "spec/"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rspec_magic
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Alex Fortuna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- fortunadze@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README-ru.md
+- README.md
+- Rakefile
+- lib/rspec_magic.rb
+- lib/rspec_magic/config.rb
+- lib/rspec_magic/stable.rb
+- lib/rspec_magic/stable/alias_method.rb
+- lib/rspec_magic/stable/context_when.rb
+- lib/rspec_magic/stable/described_sym.rb
+- lib/rspec_magic/stable/use_letset.rb
+- lib/rspec_magic/stable/use_method_discovery.rb
+- lib/rspec_magic/unstable.rb
+- lib/rspec_magic/unstable/include_dir_context.rb
+- lib/rspec_magic/version.rb
+- rspec_magic.gemspec
+- spec/lib/rspec_magic/alias_method_spec.rb
+- spec/lib/rspec_magic/context_when_spec.rb
+- spec/lib/rspec_magic/described_sym_spec.rb
+- spec/lib/rspec_magic/include_dir_context/README.md
+- spec/lib/rspec_magic/include_dir_context/_context.rb
+- spec/lib/rspec_magic/include_dir_context/app/_context.rb
+- spec/lib/rspec_magic/include_dir_context/app/idc_consumer_spec.rb
+- spec/lib/rspec_magic/include_dir_context/app/models/_context.rb
+- spec/lib/rspec_magic/include_dir_context/app/models/idc_consumer_spec.rb
+- spec/lib/rspec_magic/include_dir_context/idc_consumer_spec.rb
+- spec/lib/rspec_magic/use_letset_spec.rb
+- spec/lib/rspec_magic/use_method_discovery_spec.rb
+- spec/spec_helper.rb
+- spec/support/self.rb
+- spec/support/simplecov.rb
+homepage: https://github.com/dadooda/rspec_magic
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A set of extensions for writing compact and expressive tests
+test_files: []