fix 1.0.0.beta4 → 1.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6245525d719965043d4187cbcce446e21c2b946303048159a13cc37161851ada
-  data.tar.gz: c5b10da14f591df283e832f15f4839b420ecfbcbca4af6ed2974b28c20815d15
+  metadata.gz: 9d095777befeb78f0e16a218f3f14c0f8b39955265db3848cd26a0afb0b224f3
+  data.tar.gz: d918e8bfd693765450dfb14477f4fe9285642e22a35995446b89acac78662837
 SHA512:
-  metadata.gz: 9ba29c713607b3cfe280c7eb82e9eee07adc69b8d0c58c0ab9cf54117befc5a0f35c76c32d93cd0e5c4bf911a5c09786109ecc336d4866ada3e7d79f0296551b
-  data.tar.gz: 6267c5c89cd4a6cf4a7573bb4866e4855ed10a403cd2cb606fbe9a18f6ff3f3206559e01f8c349f0ca82d6b8a60fed13546dce80744b0967ca9ac3aeda2d381b
+  metadata.gz: c063f295f4d133635d70da15659c613018b51931db21d40c3bedb7db9b442fa756e8ed52833fc49333a816749df99c73956d43c237159f7bd6e728ea36e7791d
+  data.tar.gz: 1e4317121e610e67d0d396571b86e0a82b07c16122cc0be5c2c7ee5514136d9ec349282b643f06fe6d7f7b33cd04584048cf72ec3d8d88345e93f1135e7d5dee

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2020 Cyril Kato
+Copyright (c) 2014-2021 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,91 +1,120 @@
 # Fix
 
-[![Build Status](https://api.travis-ci.org/fixrb/fix.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/fixrb/fix/badges/gpa.svg)][codeclimate]
-[![Gem Version](https://badge.fury.io/rb/fix.svg)][gem]
-[![Inline docs](https://inch-ci.org/github/fixrb/fix.svg?branch=master)][inchpages]
-[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+[![Home](https://img.shields.io/badge/Home-fixrb.dev-00af8b)](https://fixrb.dev/)
+[![Version](https://img.shields.io/github/v/tag/fixrb/fix?label=Version&logo=github)](https://github.com/fixrb/fix/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/fix/main)
+[![CI](https://github.com/fixrb/fix/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/fix/actions?query=workflow%3Aci+branch%3Amain)
+[![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)
 
-> Specing framework for Ruby.
+⚠️ This project is still in the experimental phase. May be used at your own risk.
+
+![Fix specing framework for Ruby](https://fixrb.dev/fix.webp)
+
+## Project goals
+
+* Extract specs from the tests.
+* Look like English documents.
+* Be minimalist and easy to use.
+* Run tests quickly.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'fix', '>= 1.0.0.beta4'
+gem "fix", ">= 1.0.0.beta8"
 ```
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install fix --pre
+```sh
+gem install fix --pre
+```
 
 ## Example
 
-Given this app:
+Given these specifications:
 
 ```ruby
-# examples/duck/app.rb
-class Duck
-  def walks
-    'Klop klop!'
+# examples/duck/fix.rb
+
+require "fix"
+
+Fix :Duck do
+  it SHOULD be_an_instance_of :Duck
+
+  on :swims do
+    it MUST be_an_instance_of :String
+    it MUST eql "Swoosh..."
   end
 
-  def swims
-    'Swoosh...'
+  on :speaks do
+    it MUST raise_exception NoMethodError
   end
 
-  def quacks
-    puts 'Quaaaaaack!'
+  on :sings do
+    it MAY eql "♪... ♫..."
   end
 end
 ```
 
-When you run this:
+When we load this `Duck` application:
 
 ```ruby
-# examples/duck/fix.rb
-require_relative 'app'
-require_relative '../../lib/fix'
-
-@bird = Duck.new
-
-Fix(@bird) do
-  on :swims do
-    it { MUST eql 'Swoosh...' }
+# examples/duck/app.rb
+class Duck
+  def walks
+    "Klop klop!"
   end
 
-  on :speaks do
-    it { MUST raise_exception NoMethodError }
+  def swims
+    "Swoosh..."
   end
 
-  on :sings do
-    it { MAY eql '♪... ♫...' }
+  def quacks
+    puts "Quaaaaaack!"
   end
 end
 ```
 
-Then the output should look like this:
+And we run this test:
+
+```ruby
+# examples/duck/test.rb
+
+require_relative "app"
+require_relative "fix"
+
+Fix[:Duck].against { Duck.new }
+```
 
 ```sh
-ruby examples/duck/fix.rb
+ruby examples/duck/test.rb
 ```
 
+We should see this output:
+
 ```txt
-examples/duck/fix.rb:8: Success: expected to eql "Swoosh...".
-examples/duck/fix.rb:12: Success: undefined method `speaks' for #<Duck:0x00007fe3be868ea0>.
-examples/duck/fix.rb:16: NoMethodError: undefined method `sings' for #<Duck:0x00007fe3be868ea0>.
+(irb):3 Success: expected #<Duck:0x00007fb2fa208708> to be an instance of Duck.
+(irb):7 Success: expected to eq "Swoosh...".
+(irb):15 NoMethodError: undefined method `sings' for #<Duck:0x00007fb2fd8371d0>.
+(irb):6 Success: expected "Swoosh..." to be an instance of String.
+(irb):11 Success: undefined method `speaks' for #<Duck:0x00007fb2fcc79258>.
 ```
 
 ## Contact
 
-* Home page: https://fixrb.dev/
-* Source code: https://github.com/fixrb/fix
+* Home page: [https://fixrb.dev/](https://fixrb.dev/)
+* Source code: [https://github.com/fixrb/fix](https://github.com/fixrb/fix)
+* API Doc: [https://rubydoc.info/gems/fix](https://rubydoc.info/gems/fix)
+* Twitter: [https://twitter.com/fix\_rb](https://twitter.com/fix\_rb)
 
 ## Versioning
 
@@ -93,20 +122,13 @@ __Fix__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The [gem](https://rubygems.org/gems/fix) is available as open source under the terms of the [MIT License](https://github.com/fixrb/fix/raw/main/LICENSE.md).
 
 ***
 
 <p>
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/fix/raw/master/img/sashite.png"
+    src="https://github.com/fixrb/fix/raw/main/img/sashite.png"
     alt="Sashite" /></a>
 </p>
-
-[travis]: https://travis-ci.org/fixrb/fix
-[codeclimate]: https://codeclimate.com/github/fixrb/fix
-[gem]: https://rubygems.org/gems/fix
-[inchpages]: https://inch-ci.org/github/fixrb/fix
-[rubydoc]: https://rubydoc.info/gems/fix/frames
-[gitter]: https://gitter.im/fixrb/fix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge

data/lib/fix.rb

@@ -1,25 +1,22 @@
 # frozen_string_literal: true
 
+require_relative File.join("fix", "set")
+
+require_relative "kernel"
+
 # Namespace for the Fix framework.
 #
+# @api public
 module Fix
-  # Specs are built with this method.
+  # Test a built specification.
   #
-  # @example 42 must be equal to 42
-  #   describe(42) do
-  #     it { MUST equal 42 }
-  #   end
+  # @example Run _Answer_ specification against `42`.
+  #   Fix[:Answer].against(42)
   #
-  # @param front_object [BasicObject] The front object.
-  # @param options      [Hash]        Some options.
-  # @param specs        [Proc]        The set of specs.
+  # @param name [String, Symbol] The constant name of the specifications.
   #
-  # @raise [SystemExit] The result of the test.
-  def self.describe(front_object, **lets, &block)
-    c = Context.new(front_object, ::Defi.send(:itself), **lets)
-    c.instance_eval(&block)
+  # @return [::Fix::Test] The specification document.
+  def self.[](name)
+    ::Fix::Set.load(name)
   end
 end
-
-require_relative 'kernel'
-require_relative File.join('fix', 'context')

data/lib/fix/doc.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Fix
+  # Module for storing spec documents.
+  #
+  # @api private
+  module Doc
+    # @param name [String, Symbol] The constant name of the specifications.
+    def self.fetch(name)
+      const_get("#{name}::CONTEXTS")
+    end
+
+    # @param contexts [Array<::Fix::Dsl>] The list of contexts document.
+    def self.specs(*contexts)
+      contexts.flat_map do |context|
+        env = context.new
+
+        env.public_methods(false).map do |public_method|
+          [env] + env.public_send(public_method)
+        end
+      end
+    end
+  end
+end

data/lib/fix/dsl.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "defi"
+
+require_relative "matcher"
+require_relative "requirement"
+
+module Fix
+  # Abstract class for handling the domain-specific language.
+  #
+  # @api private
+  class Dsl
+    extend Matcher
+    extend Requirement
+
+    # Sets a user-defined property.
+    #
+    # @example
+    #   require "fix"
+    #
+    #   Fix do
+    #     let(:name) { "Bob" }
+    #   end
+    #
+    # @param name   [String, Symbol] The name of the property.
+    # @param block  [Proc] The content of the method to define.
+    #
+    # @return [Symbol] A private method that define the block content.
+    #
+    # @api public
+    def self.let(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 be 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
+    end
+
+    # Defines an example group that describes a unit to be tested.
+    #
+    # @example
+    #   require "fix"
+    #
+    #   Fix do
+    #     on :+, 2 do
+    #       it MUST be 42
+    #     end
+    #   end
+    #
+    # @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(:CONTEXTS) << klass
+
+      const_set("Child#{block.object_id}", klass)
+
+      klass.define_singleton_method(:challenges) do
+        challenge = ::Defi.send(method_name, *args, **kwargs)
+        super() + [challenge]
+      end
+
+      klass.instance_eval(&block)
+      klass
+    end
+
+    # Defines a concrete spec definition.
+    #
+    # @example
+    #   require "fix"
+    #
+    #   Fix { it MUST be 42 }
+    #
+    # @api public
+    def self.it(requirement)
+      location = caller_locations(1, 1).fetch(0)
+      location = [location.path, location.lineno].join(":")
+
+      define_method("test_#{requirement.object_id}") do
+        [location, requirement, self.class.challenges]
+      end
+    end
+
+    # The list of challenges to be addressed to the object to be tested.
+    #
+    # @return [Array<Defi::Challenge>] A list of challenges.
+    def self.challenges
+      []
+    end
+  end
+end

data/lib/fix/matcher.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+require "matchi"
+
+module Fix
+  # Collection of expectation matchers.
+  #
+  # @api private
+  module Matcher
+    # Equivalence matcher
+    #
+    # @example
+    #   matcher = eq("foo")
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { "bar" } # => false
+    #
+    # @param expected [#eql?] An expected equivalent object.
+    #
+    # @return [#matches?] An equivalence matcher.
+    #
+    # @api public
+    def eq(expected)
+      ::Matchi::Eq.new(expected)
+    end
+
+    alias eql eq
+
+    # Identity matcher
+    #
+    # @example
+    #   object = "foo"
+    #   matcher = be(object)
+    #   matcher.matches? { object } # => true
+    #   matcher.matches? { "foo" } # => false
+    #
+    # @param expected [#equal?] The expected identical object.
+    #
+    # @return [#matches?] An identity matcher.
+    #
+    # @api public
+    def be(expected)
+      ::Matchi::Be.new(expected)
+    end
+
+    alias equal be
+
+    # Comparisons matcher
+    #
+    # @example
+    #   matcher = be_within(1).of(41)
+    #   matcher.matches? { 42 } # => true
+    #   matcher.matches? { 43 } # => false
+    #
+    # @param delta [Numeric] A numeric value.
+    #
+    # @return [#matches?] A comparison matcher.
+    #
+    # @api public
+    def be_within(delta)
+      ::Matchi::BeWithin.new(delta)
+    end
+
+    # Regular expressions matcher
+    #
+    # @example
+    #   matcher = match(/^foo$/)
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { "bar" } # => false
+    #
+    # @param expected [#match] A regular expression.
+    #
+    # @return [#matches?] A regular expression matcher.
+    #
+    # @api public
+    def match(expected)
+      ::Matchi::Match.new(expected)
+    end
+
+    # Expecting errors matcher
+    #
+    # @example
+    #   matcher = raise_exception(NameError)
+    #   matcher.matches? { Boom } # => true
+    #   matcher.matches? { true } # => false
+    #
+    # @param expected [Exception, #to_s] The expected exception name.
+    #
+    # @return [#matches?] An error matcher.
+    #
+    # @api public
+    def raise_exception(expected)
+      ::Matchi::RaiseException.new(expected)
+    end
+
+    # True matcher
+    #
+    # @example
+    #   matcher = be_true
+    #   matcher.matches? { true } # => true
+    #   matcher.matches? { false } # => false
+    #   matcher.matches? { nil } # => false
+    #   matcher.matches? { 4 } # => false
+    #
+    # @return [#matches?] A `true` matcher.
+    #
+    # @api public
+    def be_true
+      be(true)
+    end
+
+    # False matcher
+    #
+    # @example
+    #   matcher = be_false
+    #   matcher.matches? { false } # => true
+    #   matcher.matches? { true } # => false
+    #   matcher.matches? { nil } # => false
+    #   matcher.matches? { 4 } # => false
+    #
+    # @return [#matches?] A `false` matcher.
+    #
+    # @api public
+    def be_false
+      be(false)
+    end
+
+    # Nil matcher
+    #
+    # @example
+    #   matcher = be_nil
+    #   matcher.matches? { nil } # => true
+    #   matcher.matches? { false } # => false
+    #   matcher.matches? { true } # => false
+    #   matcher.matches? { 4 } # => false
+    #
+    # @return [#matches?] A `nil` matcher.
+    #
+    # @api public
+    def be_nil
+      be(nil)
+    end
+
+    # Type/class matcher
+    #
+    # @example
+    #   matcher = be_an_instance_of(String)
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { 4 } # => false
+    #
+    # @param expected [Class, #to_s] The expected class name.
+    #
+    # @return [#matches?] A type/class matcher.
+    #
+    # @api public
+    def be_an_instance_of(expected)
+      ::Matchi::BeAnInstanceOf.new(expected)
+    end
+
+    # Change matcher
+    #
+    # @example
+    #   object = []
+    #   matcher = change(object, :length).by(1)
+    #   matcher.matches? { object << 1 } # => true
+    #
+    #   object = []
+    #   matcher = change(object, :length).by_at_least(1)
+    #   matcher.matches? { object << 1 } # => true
+    #
+    #   object = []
+    #   matcher = change(object, :length).by_at_most(1)
+    #   matcher.matches? { object << 1 } # => true
+    #
+    #   object = "foo"
+    #   matcher = change(object, :to_s).from("foo").to("FOO")
+    #   matcher.matches? { object.upcase! } # => true
+    #
+    #   object = "foo"
+    #   matcher = change(object, :to_s).to("FOO")
+    #   matcher.matches? { object.upcase! } # => true
+    #
+    # @param object [#object_id]  An object.
+    # @param method [Symbol]      The name of a method.
+    # @param args   [Array]       A list of arguments.
+    # @param kwargs [Hash]        A list of keyword arguments.
+    #
+    # @return [#matches?] A change matcher.
+    #
+    # @api public
+    def change(object, method, *args, **kwargs, &block)
+      ::Matchi::Change.new(object, method, *args, **kwargs, &block)
+    end
+
+    # Satisfy matcher
+    #
+    # @example
+    #   matcher = satisfy { |value| value == 42 }
+    #   matcher.matches? { 42 } # => true
+    #
+    # @param expected [Proc] A block of code.
+    #
+    # @return [#matches?] A satisfy matcher.
+    #
+    # @api public
+    def satisfy(&expected)
+      ::Matchi::Satisfy.new(&expected)
+    end
+
+    private
+
+    # Predicate matcher, or default method missing behavior.
+    #
+    # @example Empty predicate matcher
+    #   matcher = be_empty
+    #   matcher.matches? { [] } # => true
+    #   matcher.matches? { [4] } # => false
+    def method_missing(name, *args, **kwargs, &block)
+      return super unless predicate_matcher_name?(name)
+
+      ::Matchi::Predicate.new(name, *args, **kwargs, &block)
+    end
+
+    # :nocov:
+
+    # Hook method to return whether the obj can respond to id method or not.
+    def respond_to_missing?(name, include_private = false)
+      predicate_matcher_name?(name) || super
+    end
+
+    # :nocov:
+
+    # Predicate matcher name detector.
+    #
+    # @param name [Array, Symbol] The name of a potential predicate matcher.
+    #
+    # @return [Boolean] Indicates if it is a predicate matcher name or not.
+    def predicate_matcher_name?(name)
+      name.start_with?("be_", "have_") && !name.end_with?("!", "?")
+    end
+  end
+end