fix 1.0.0.beta5 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f9b6d58547e6b78494ab484447f08c43a2fd233db5ef946c977b0f21fc0311d
-  data.tar.gz: 0fb204fd7cb1ccf56ddfacfe6737e137c387d5734855e629edae6a5289d2e291
+  metadata.gz: 361429a943a5149aeea4da4dd83150360db392275ec4d9d98e76969e60768dce
+  data.tar.gz: 6df8aaff424652d4e73cb163cc1dfd973c9a4a03ec2e2d6e351db5f87b0674a8
 SHA512:
-  metadata.gz: 67bd36e9816e7f92c0a2534d3d7055a73c5c249182b6b0e7842441c856e0fb6d47e0fb59dbe89b9fbe3124212b98e765cf5f312a14e276017b1dcd29d120002f
-  data.tar.gz: e58648ee25f43b7d964a2f0782a05724c935b2661dc4c2afa5c71bff51af0baac694ef86a12c911266bb1d4e4ebc50d3f499e05531722d0362be5fc1f1f6bd5e
+  metadata.gz: 24a1c58a8e0db0ef62d97881eabc8a4ff0596d82c96f1dee40fc68edffdc17f0206c6d45aa11040e3b11af35038df58ee7bca1f6190330f91b1b384304dcc304
+  data.tar.gz: 0a5ff783abf6bce80c8ff4a3e3f2e938c004bf5cd02e8300f56650e6312638e911638ed41c9293047aa757ae73048cd412bae5b6cc031e43bab82a2f4b92e41c

data/README.md

@@ -7,6 +7,8 @@
 [![RuboCop](https://github.com/fixrb/fix/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/fix/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/fix?label=License&logo=github)](https://github.com/fixrb/fix/raw/main/LICENSE.md)
 
+⚠️ This project is still in the experimental phase. May be used at your own risk.
+
 ![Fix specing framework for Ruby](https://github.com/fixrb/fix/raw/main/img/fix.jpg)
 
 ## Installation
@@ -14,7 +16,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "fix", ">= 1.0.0.beta5"
+gem "fix", ">= 1.0.0.beta6"
 ```
 
 And then execute:
@@ -58,16 +60,18 @@ And this fixed behavior:
 relative "fix"
 
 Fix :Duck do
+  it MUST be_an_instance_of :Duck
+
   on :swims do
-    it { MUST eql "Swoosh..." }
+    it MUST eql "Swoosh..."
   end
 
   on :speaks do
-    it { MUST raise_exception NoMethodError }
+    it MUST raise_exception NoMethodError
   end
 
   on :sings do
-    it { MAY eql "♪... ♫..." }
+    it MAY eql "♪... ♫..."
   end
 end
 ```
@@ -80,7 +84,7 @@ When I run this test:
 require_relative "app"
 require_relative "fix"
 
-Fix[:Duck].call(Duck.new)
+Fix[:Duck].test { Duck.new }
 ```
 
 ```sh
@@ -90,15 +94,14 @@ ruby examples/duck/test.rb
 I should see this output:
 
 ```txt
-Test #<Duck:0x00007fc5289bcf68> against Duck:
-- NoMethodError: undefined method `sings' for #<Duck:0x00007fc5289bcf68>.
-- Success: expected to eql "Swoosh...".
-- Success: undefined method `speaks' for #<Duck:0x00007fc5289bcf68>.
+NoMethodError: undefined method `sings' for #<Duck:0x00007fc5289bcf68>.
+Success: expected to eql "Swoosh...".
+Success: undefined method `speaks' for #<Duck:0x00007fc5289bcf68>.
 ```
 
 ## Test suite
 
-__Fix__'s specifications are [fixed here](https://github.com/fixrb/fix/blob/main/fix/) and can be tested against __Fix__'s codebase executing [test/](https://github.com/fixrb/fix/blob/main/test/)'s files.
+__Fix__'s specifications will be [fixed here](https://github.com/fixrb/fix/blob/main/fix/) and will be tested against __Fix__'s codebase executing [test/*](https://github.com/fixrb/fix/blob/main/test/)'s files.
 
 ## Contact
 

data/lib/fix.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative File.join("fix", "doc")
 require_relative File.join("fix", "test")
 
 require_relative "kernel"
@@ -18,6 +19,6 @@ module Fix
   #
   # @return [::Fix::Dsl] The specification document.
   def self.[](name)
-    Test.new(name)
+    Test.new(*Doc.const_get(name).const_get(:CONTEXTS))
   end
 end

data/lib/fix/console.rb

@@ -3,21 +3,13 @@
 module Fix
   # Send log messages to the console.
   module Console
-    # @param name     [String, Symbol]  The name of the specification document.
-    # @param subject  [#object_id]      The front object to be tested.
-    #
-    # @return [nil] Add a message to `$stdout`.
-    def self.title(name, subject)
-      puts "Run #{name} specs against #{subject.inspect}:"
-    end
-
     # @param report [::Expresenter::Pass] Passed expectation result presenter.
     #
     # @see https://github.com/fixrb/expresenter
     #
     # @return [nil] Add a colored message to `$stdout`.
     def self.passed_spec(report)
-      puts "- #{report.colored_string}"
+      puts report.colored_string
     end
 
     # @param report [::Expresenter::Fail] Failed expectation result presenter.
@@ -26,7 +18,7 @@ module Fix
     #
     # @raise [SystemExit] Terminate execution immediately with colored message.
     def self.failed_spec(report)
-      abort "- #{report.colored_string}"
+      abort report.colored_string
     end
   end
 end

data/lib/fix/dsl.rb

@@ -4,7 +4,7 @@ require "defi"
 require "matchi/helper"
 require "spectus"
 
-require_relative "console"
+require_relative "test"
 
 module Fix
   # Abstract class for handling the domain-specific language.
@@ -16,22 +16,10 @@ module Fix
     # @example
     #   require "fix"
     #
-    #   Fix.describe "Name stories" do
+    #   Fix do
     #     let(:name) { "Bob" }
-    #
-    #     it { expect(name).to eq "Bob" }
-    #
-    #     context "with last name" do
-    #       let(:name) { "#{super()} Smith" }
-    #
-    #       it { expect(name).to eq "Bob Smith" }
-    #     end
     #   end
     #
-    #   # Output to the console
-    #   #   Success: expected to eq "Bob".
-    #   #   Success: expected to eq "Bob Smith".
-    #
     # @param name   [String, Symbol] The name of the property.
     # @param block  [Proc] The content of the method to define.
     #
@@ -39,11 +27,28 @@ module Fix
     #
     # @api public
     def self.let(name, &block)
-      private_class_method define_singleton_method(name, &block)
+      private define_method(name, &block)
     end
 
+    # Defines an example group with user-defined properties that describes a
+    # unit to be tested.
+    #
+    # @example
+    #   require "fix"
+    #
+    #   Fix do
+    #     with :password, "secret" do
+    #       it MUST equal true
+    #     end
+    #   end
+    #
+    # @param kwargs [Hash] The list of propreties.
+    # @param block [Proc] The block to define the specs.
+    #
+    # @api public
     def self.with(**kwargs, &block)
       klass = ::Class.new(self)
+      klass.const_get(:CONTEXTS) << klass
       kwargs.each { |name, value| klass.let(name) { value } }
       klass.instance_eval(&block)
       klass
@@ -54,115 +59,106 @@ module Fix
     # @example
     #   require "fix"
     #
-    #   Fix.on String do
-    #     on "+" do
-    #       it("concats") { expect("foo" + "bar").to eq "foobar" }
+    #   Fix do
+    #     on :+, 2 do
+    #       it MUST be 42
     #     end
     #   end
     #
-    #   # Output to the console
-    #   #   Success: expected to eq "foobar".
-    #
-    # @param const [Module, String] A module to include in block context.
+    # @param method_name [String, Symbol] The method to send to the subject.
     # @param block [Proc] The block to define the specs.
     #
     # @api public
     def self.on(method_name, *args, **kwargs, &block)
       klass = ::Class.new(self)
-      klass.const_get(:SPECS) << klass
+      klass.const_get(:CONTEXTS) << klass
+
       const_set("Child#{block.object_id}", klass)
 
       klass.define_singleton_method(:challenges) do
         super() + [::Defi.send(method_name, *args, **kwargs)]
       end
 
+      def klass.initialize
+        if subject.raised?
+          subject
+        else
+          challenge = ::Defi.send(method_name, *args, **kwargs)
+          challenge.to(subject.call)
+        end
+      end
+
       klass.instance_eval(&block)
       klass
     end
 
-    # Defines a concrete test case.
+    # Defines a concrete spec definition.
     #
-    # The test is performed by the block supplied to `&block`.
-    #
-    # @example The integer after 41
-    #   require "fix"
-    #
-    #   Fix(:AnswerToEverything) { it { MUST be 42 } }.call(42)
-    #
-    #   # Output to the console
-    #   #   Success: expected to be 42.
-    #
-    # @example A division by zero
+    # @example
     #   require "fix"
     #
-    #   Fix :Integer do
-    #     it { MUST be_an_instance_of Integer }
-    #
-    #     on :/, 0 do
-    #       it { MUST raise_exception ZeroDivisionError }
-    #     end
-    #   end
-    #
-    #   Fix[:Integer].call(41)
-    #
-    #   # Output to the console
-    #   #   Success: expected 41 to be an instance of Integer.
-    #   #   Success: divided by 0.
-    #
-    # It can be used inside a {.describe} or {.context} section.
-    #
-    # @param block [Proc] An expectation to evaluate.
-    #
-    # @raise (see ExpectationTarget::Base#result)
-    # @return (see ExpectationTarget::Base#result)
+    #   Fix { it MUST equal 42 }
     #
     # @api public
-    def self.it(&block)
-      define_method("test_#{block.object_id}", &block)
+    def self.it(requirement)
+      define_method("test_#{requirement.object_id}") { requirement }
     end
 
-    def self.its(method_name, *args, **kwargs, &block)
+    # @todo Move this method inside "fix-its" gem.
+    def self.its(method_name, requirement)
       klass = ::Class.new(self)
-      klass.const_get(:SPECS) << klass
-      const_set("Child#{block.object_id}", klass)
+      klass.const_get(:CONTEXTS) << klass
+
+      const_set("Child#{requirement.object_id}", klass)
 
       klass.define_singleton_method(:challenges) do
-        super() + [::Defi.send(method_name, *args, **kwargs)]
+        super() + [::Defi.send(method_name)]
       end
 
-      klass.it(&block)
+      def klass.initialize
+        if subject.raised?
+          subject
+        else
+          challenge = ::Defi.send(method_name, *args, **kwargs)
+          challenge.to(subject.call)
+        end
+      end
+
+      klass.it(requirement)
     end
 
     def self.challenges
       []
     end
 
+    def self.test(&subject)
+      Test.new(self).test(&subject)
+    end
+
     private_class_method :challenges
 
     private
 
-    def initialize(subject)
-      @subject = subject
-    end
+    attr_reader :subject
 
-    ::Spectus.methods(false).each do |method_name|
-      define_method(method_name.upcase) do |matcher|
-        ::Spectus.public_send(method_name, matcher).call do
-          self.class.send(:challenges).inject(@subject) do |object, challenge|
-            challenge.to(object).call
-          end
-        end
-      end
+    def initialize(&subject)
+      @subject = ::Defi::Value.new(&subject)
     end
 
-    def method_missing(method_name, *args, &block)
-      self.class.send(method_name)
-    rescue ::NoMethodError
-      super
+    ::Matchi::Matcher.constants.each do |matcher_const|
+      next if matcher_const.equal?(:Base)
+
+      matcher_klass = ::Matchi::Matcher.const_get(matcher_const)
+
+      define_singleton_method(matcher_klass.to_sym) do |*args|
+        matcher_klass.new(*args)
+      end
     end
 
-    def respond_to_missing?(method_name, include_private = false)
-      self.class.respond_to?(method_name) || super
+    ::Spectus.methods(false).each do |method_name|
+      define_singleton_method(method_name.upcase) do |matcher|
+        ::Spectus.public_send(method_name, matcher)
+      end
     end
   end
 end

data/lib/fix/test.rb

@@ -8,37 +8,44 @@ require_relative "doc"
 module Fix
   # Module for testing spec documents.
   class Test
-    attr_reader :name
+    attr_reader :contexts
 
-    def initialize(name)
-      @name = name
+    def initialize(*contexts)
+      @contexts = contexts
     end
 
-    def call(subject)
-      Console.title(name, subject)
-      requirements(subject).each { |requirement| test(requirement) }
+    def test(&block)
+      requirements(&block)
       exit(true)
     end
 
     private
 
-    def requirements(subject)
-      specs.flat_map do |spec|
-        example = spec.new(subject)
-        example.public_methods(false).map do |public_method|
-          example.method(public_method)
+    def requirements(&block)
+      contexts.flat_map do |context|
+        sandbox = context.new
+        sandbox.public_methods(false).shuffle.map do |public_method|
+          definition = sandbox.public_send(public_method)
+
+          report = begin
+            definition.call do
+              front_object = instance_eval(&block)
+
+              context.send(:challenges).inject(front_object) do |object, challenge|
+                challenge.to(object).call
+              end
+            end
+          rescue ::Expresenter::Fail => e
+            e
+          end
+
+          if report.passed?
+            Console.passed_spec report
+          else
+            Console.failed_spec report
+          end
         end
-      end.shuffle
-    end
-
-    def specs
-      Doc.const_get(name).const_get(:SPECS)
-    end
-
-    def test(requirement)
-      Console.passed_spec requirement.call
-    rescue ::Expresenter::Fail => e
-      Console.failed_spec e
+      end
     end
   end
 end

data/lib/kernel.rb

@@ -19,12 +19,14 @@ module Kernel
   # @return [Class] The specification document.
   #
   # rubocop:disable Naming/MethodName
-  def Fix(name, &block)
+  def Fix(name = nil, &block)
     klass = ::Class.new(::Fix::Dsl)
-    klass.const_set(:SPECS, [klass])
+    klass.const_set(:CONTEXTS, [klass])
     klass.instance_eval(&block)
-    ::Fix::Doc.const_set(name, klass)
-    ::Fix::Test.new(name)
+
+    ::Fix::Doc.const_set(name, klass) unless name.nil?
+
+    ::Fix::Test.new(*klass.const_get(:CONTEXTS))
   end
   # rubocop:enable Naming/MethodName
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fix
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0.beta6
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement