fix 0.18.2 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3185bfc9a8b56c3a47a7efbbcbf141ea054e405bf2d4c6d0e76ceec8bc0fed2
-  data.tar.gz: fff9e1401b1e7aff1b9214692922eb6176548f12b94265d673fc4daa311bba53
+  metadata.gz: 3f307018b701019985c925b9a244c7b6813462faac51b8fef26488070a564f30
+  data.tar.gz: c09cc676e5394ef581f5fa7d0ae57beafc4a28686661c5d66b0bdd0006481864
 SHA512:
-  metadata.gz: 7de8da736c7d22d71a24b0d4a03fc691e34f2c33bf1394aeda3a78856b687c6e686b1b4ac548c7a52237953996fb70e35de5733da715a2b06342654ae9737fd2
-  data.tar.gz: 1058e6255fb4423d8479eddf1d95431de023acacefe84d87825f33ed4205378b5eea2ddfcdeb3b72aaa9e921eb96df240e52a12a55427d7dba9b68227550fb02
+  metadata.gz: 35d0e3bafa2f2b612a039c9892cf6024eb42bc52923a551c49b96d3b0efb2abcd9a6e5022b8086c69c351e15f5b789f460e2c938b1a82a4f7148c18a93ca4898
+  data.tar.gz: 9c6b388b420a98226aeb4fb59746725f4ea36824ea0d78065b01c4bd9d7c341a10b84dcb42351ca6a0bf865bf754404ad263cfd2b29de1cdd5916e97fd89fbf5

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2019 Cyril Kato
+Copyright (c) 2014-2020 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,26 +1,20 @@
 # Fix
 
-[![Build Status](https://travis-ci.org/fixrb/fix.svg?branch=master)][travis]
+[![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](http://inch-ci.org/github/fixrb/fix.svg?branch=master)][inchpages]
-[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+[![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]
 
 > Specing framework for Ruby.
 
-## Contact
-
-* Home page: https://fixrb.dev/
-* Bugs/issues: https://github.com/fixrb/fix/issues
-* Support: https://stackoverflow.com/questions/tagged/fixrb
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'fix'
+gem 'fix', '>= 1.0.0.beta1'
 ```
 
 And then execute:
@@ -29,36 +23,14 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install fix
-
-## Let's get started!
-
-[![asciicast](https://asciinema.org/a/29098.png)](https://asciinema.org/a/29098)
-
-## Philosophy
-
-### Simple, stupid
-
-With 174 LOC built on top of [Spectus expectation library](https://github.com/fixrb/spectus), facilities such as benchmarking and mocking are not supported.  __Fix__ offers however a **consistent** DSL to focus your BDD.
-
-### True specifications
-
-While specs behave like **documents** which can be logic-less, their interpretation should not be questioned regardless of the version of __Fix__, preventing from software erosion.  Also, Fix specs are compliant with **[RFC 2119](http://tools.ietf.org/html/rfc2119)**.
-
-### Low code complexity
-
-Monkey-patching, [magic tricks and friends](http://blog.arkency.com/2013/06/are-we-abusing-at-exit/) are not included.  Instead, animated by **authentic** and **unmuted** Ruby objects, unambiguous, understandable and structured specs are encouraged.
-
-### Test in isolation
-
-Rather than a _random order_ option to help finding bugs somewhere (and sometimes luck), __Fix__ prevents from **side effects** by running each context inside a distinct **sub-process**.  As it behaves like a function, no matter how many times you call it, the build status remains the same.
+    $ gem install fix --pre
 
 ## Usage
 
 Given this app:
 
 ```ruby
-# duck.rb
+# examples/duck/app.rb
 class Duck
   def walks
     'Klop klop!'
@@ -77,13 +49,13 @@ end
 When you run this:
 
 ```ruby
-# duck_spec.rb
-require_relative 'duck'
-require 'fix'
+# examples/duck/fix.rb
+require_relative 'app'
+require_relative '../../lib/fix'
 
 @bird = Duck.new
 
-Fix.describe @bird do
+Fix(@bird) do
   on :swims do
     it { MUST eql 'Swoosh...' }
   end
@@ -100,53 +72,48 @@ end
 
 Then the output should look like this:
 
-    $ ruby duck_spec.rb
-    ..I
-
-    1. Info: undefined method `sings' for #<Duck:0x007fb60383b740> (NoMethodError).
+```sh
+ruby examples/duck/fix.rb
+```
 
-    Ran 3 tests in 0.00038 seconds
-    100% compliant - 1 infos, 0 failures, 0 errors
+```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>.
+```
 
-## Security
+## Contact
 
-As a basic form of security __Fix__ provides a set of SHA512 checksums for
-every Gem release.  These checksums can be found in the `checksum/` directory.
-Although these checksums do not prevent malicious users from tampering with a
-built Gem they can be used for basic integrity verification purposes.
+* Home page: https://fixrb.dev/
+* Bugs/issues: https://github.com/fixrb/fix/issues
+* Support: https://stackoverflow.com/questions/tagged/fixrb
 
-The checksum of a file can be checked using the `sha512sum` command.  For
-example:
+## Rubies
 
-    $ sha512sum pkg/fix-0.1.0.gem
-    d12d7d9c2a4fdfe075cbb7a141fa5f2195175891e4098c7e1a28c8bca655ab44fb9d67b6a2e3991d0f852026c5e4537fdf7e314575c68d1c80b3a4b1eb1c041f  pkg/fix-0.1.0.gem
+* [MRI](https://www.ruby-lang.org/)
+* [Rubinius](https://rubinius.com/)
+* [JRuby](https://www.jruby.org/)
 
 ## Versioning
 
 __Fix__ follows [Semantic Versioning 2.0](http://semver.org/).
 
-## Contributing
+## License
 
-1. [Fork it](https://github.com/fixrb/fix/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## License
+***
 
-See `LICENSE.md` file.
+<p>
+  This project is sponsored by:<br />
+  <a href="https://sashite.com/"><img
+    src="https://github.com/fixrb/fix/raw/master/img/sashite.png"
+    alt="Sashite" /></a>
+</p>
 
-[gem]: https://rubygems.org/gems/fix
 [travis]: https://travis-ci.org/fixrb/fix
 [codeclimate]: https://codeclimate.com/github/fixrb/fix
-[gemnasium]: https://gemnasium.com/fixrb/fix
+[gem]: https://rubygems.org/gems/fix
 [inchpages]: http://inch-ci.org/github/fixrb/fix
 [rubydoc]: http://rubydoc.info/gems/fix/frames
 [gitter]: https://gitter.im/fixrb/fix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
-
-***
-
-This project is sponsored by:
-
-[![Sashite](https://pbs.twimg.com/profile_images/618485028322975744/PZ9qPuI__400x400.png)](https://sashite.com/)

data/lib/fix.rb

@@ -2,8 +2,6 @@
 
 # Namespace for the Fix framework.
 #
-# @api public
-#
 module Fix
   # Specs are built with this method.
   #
@@ -17,12 +15,11 @@ module Fix
   # @param specs        [Proc]        The set of specs.
   #
   # @raise [SystemExit] The result of the test.
-  def self.describe(front_object, verbose: true, **options, &specs)
-    t = Test.new(front_object, verbose: verbose, **options, &specs)
-
-    print t.report.to_s if verbose
-    exit t.pass?
+  def self.describe(front_object, **lets, &block)
+    c = Context.new(front_object, ::Defi.send(:itself), **lets)
+    c.instance_eval(&block)
   end
 end
 
-require_relative File.join('fix', 'test')
+require_relative 'kernel'
+require_relative File.join('fix', 'context')

data/lib/fix/context.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'aw'
+require 'defi'
+
+module Fix
+  # Wraps the target of challenge.
+  class Context
+    RESERVED_KEYWORDS = %i[
+      alias
+      and
+      begin
+      break
+      case
+      catch
+      class
+      def
+      defined?
+      do
+      else
+      elsif
+      end
+      ensure
+      fail
+      false
+      for
+      if
+      in
+      module
+      next
+      nil
+      not
+      or
+      raise
+      redo
+      rescue
+      retry
+      return
+      self
+      super
+      then
+      throw
+      true
+      undef
+      unless
+      until
+      when
+      while
+      yield
+    ].freeze
+
+    attr_reader :callable
+
+    def initialize(subject, challenge, before_hooks_counter = 0, *hooks, **lets)
+      @subject      = subject
+      @callable     = challenge.to(subject)
+      @before_hooks = hooks[0, before_hooks_counter]
+      @after_hooks  = hooks[before_hooks_counter..-1]
+      @lets         = lets
+    end
+
+    def before(&block)
+      @before_hooks << block
+    end
+
+    def after(&block)
+      @after_hooks << block
+    end
+
+    def let(name, &block)
+      raise ::TypeError, "expected a Symbol, got #{name.class}" unless name.is_a?(::Symbol)
+      raise ::NameError, "wrong method name `#{name}'" unless name.match?(/\A[a-z][a-z0-9_]+[?!]?\z/)
+      raise ::NameError, "reserved keyword name `#{name}'" if RESERVED_KEYWORDS.include?(name)
+      raise ::NameError, "reserved method name `#{name}'" if respond_to?(name, true) && !@lets.key?(name)
+
+      @lets.update(name => block.call)
+    rescue ::SystemExit => e
+      raise SuspiciousSuccessError, "attempt `#{name}' to bypass the tests" if e.success?
+      raise e
+    end
+
+    def let!(name, &block)
+      raise ::TypeError, "expected a Symbol, got #{name.class}" unless name.is_a?(::Symbol)
+      raise ::NameError, "wrong method name `#{name}'" unless name.match?(/\A[a-z][a-z0-9_]+[?!]?\z/)
+      raise ::NameError, "reserved keyword name `#{name}'" if RESERVED_KEYWORDS.include?(name)
+      raise ::NameError, "reserved method name `#{name}'" if respond_to?(name, true) && !@lets.key?(name)
+
+      @lets.update(name => ::Aw.fork! { block.call })
+    rescue ::SystemExit => e
+      raise SuspiciousSuccessError, "attempt `#{name}' to bypass the tests" if e.success?
+      raise e
+    end
+
+    # Verify the expectation.
+    #
+    # @param block [Proc] A spec to compare against the computed actual value.
+    #
+    # @return [::Spectus::Result::Pass, ::Spectus::Result::Fail] Pass or fail.
+    def it(_message = nil, &block)
+      print "#{block.source_location.join(':')}: "
+      i = It.new(callable, **@lets)
+      @before_hooks.each { |hook| i.instance_eval(&hook) }
+      result = i.instance_eval(&block)
+      puts result.colored_string
+    rescue ::Spectus::Result::Fail => result
+      abort result.colored_string
+    ensure
+      @after_hooks.each { |hook| i.instance_eval(&hook) }
+      raise ExpectationResultNotFoundError unless result.is_a?(::Spectus::Result::Common)
+    end
+
+    def on(name, *args, **options, &block)
+      if callable.raised?
+        actual    = callable
+        challenge = ::Defi.send(:call)
+      else
+        actual    = callable.object
+        challenge = ::Defi.send(name, *args, **options)
+      end
+
+      o = Context.new(actual, challenge, @before_hooks.length, *@before_hooks + @after_hooks, **@lets)
+      o.instance_eval(&block)
+    end
+
+    def with(_message = nil, **new_lets, &block)
+      actual    = callable.object
+      challenge = ::Defi.send(:itself)
+
+      c = Context.new(actual, challenge, @before_hooks.length, *@before_hooks + @after_hooks, **@lets.merge(new_lets))
+      c.instance_eval(&block)
+    end
+
+    private
+
+    def method_missing(name, *args, &block)
+      @lets.fetch(name) { super }
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @lets.key?(name) || super
+    end
+  end
+end
+
+require_relative 'it'
+require_relative 'expectation_result_not_found_error'
+require_relative 'suspicious_success_error'

data/lib/fix/expectation_result_not_found_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fix
+  class ExpectationResultNotFoundError < ::RuntimeError; end
+end

data/lib/fix/it.rb

@@ -1,41 +1,31 @@
 # frozen_string_literal: true
 
 require 'spectus/expectation_target'
-require 'spectus/matchers'
+require 'matchi/helper'
 
 module Fix
   # Wraps the target of an expectation.
-  #
-  # @api private
-  #
   class It < ::Spectus::ExpectationTarget
-    include ::Spectus::Matchers
+    include ::Matchi::Helper
 
     # Create a new expection target
     #
-    # @param subject    [BasicObject] The front object.
-    # @param challenges [Array]       The list of challenges.
-    # @param helpers    [Hash]        The list of helpers.
-    def initialize(subject, challenges, helpers)
-      @subject    = subject
-      @challenges = challenges
+    # @param callable [#call] The object to test.
+    def initialize(callable, **lets)
+      raise unless callable.respond_to?(:call)
 
-      helpers.each do |method_name, method_block|
-        define_singleton_method(method_name) do
-          method_block.call
-        end
-      end
+      @callable = callable
+      @lets     = lets
     end
 
-    # Verify the expectation.
-    #
-    # @param spec [Proc] A spec to compare against the computed actual value.
-    #
-    # @return [::Spectus::Result::Pass, ::Spectus::Result::Fail] Pass or fail.
-    def verify(&spec)
-      instance_eval(&spec)
-    rescue ::Spectus::Result::Fail => e
-      e
+    private
+
+    def method_missing(name, *args, &block)
+      @lets.fetch(name) { super }
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @lets.key?(name) || super
     end
   end
 end

data/lib/fix/suspicious_success_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fix
+  class SuspiciousSuccessError < ::StandardError; end
+end

data/lib/kernel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kernel
+  # rubocop:disable Naming/MethodName
+  def Fix(subject, **lets, &block)
+    ::Fix.describe(subject, **lets, &block)
+  end
+  # rubocop:enable Naming/MethodName
+end

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: fix
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aw
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: defi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,30 +70,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -137,67 +123,24 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Specing framework for Ruby.
-email:
-- contact@cyril.email
+email: contact@cyril.email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- ".yardopts"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- VERSION.semver
-- bin/console
-- bin/setup
-- checksum/fix-0.0.1.pre.gem.sha512
-- checksum/fix-0.1.0.gem.sha512
-- checksum/fix-0.1.0.pre.gem.sha512
-- checksum/fix-0.10.0.gem.sha512
-- checksum/fix-0.11.0.gem.sha512
-- checksum/fix-0.11.1.gem.sha512
-- checksum/fix-0.12.0.gem.sha512
-- checksum/fix-0.12.1.gem.sha512
-- checksum/fix-0.12.2.gem.sha512
-- checksum/fix-0.12.3.gem.sha512
-- checksum/fix-0.13.0.gem.sha512
-- checksum/fix-0.14.0.gem.sha512
-- checksum/fix-0.14.1.gem.sha512
-- checksum/fix-0.15.0.gem.sha512
-- checksum/fix-0.15.2.gem.sha512
-- checksum/fix-0.16.0.gem.sha512
-- checksum/fix-0.17.0.gem.sha512
-- checksum/fix-0.17.1.gem.sha512
-- checksum/fix-0.17.2.gem.sha512
-- checksum/fix-0.18.0.gem.sha512
-- checksum/fix-0.18.1.gem.sha512
-- checksum/fix-0.2.0.gem.sha512
-- checksum/fix-0.3.0.gem.sha512
-- checksum/fix-0.4.0.gem.sha512
-- checksum/fix-0.5.0.gem.sha512
-- checksum/fix-0.6.0.gem.sha512
-- checksum/fix-0.6.1.gem.sha512
-- checksum/fix-0.7.0.gem.sha512
-- checksum/fix-0.8.0.gem.sha512
-- checksum/fix-0.9.0.gem.sha512
-- checksum/fix-0.9.1.gem.sha512
-- fix.gemspec
 - lib/fix.rb
+- lib/fix/context.rb
+- lib/fix/expectation_result_not_found_error.rb
 - lib/fix/it.rb
-- lib/fix/on.rb
-- lib/fix/report.rb
-- lib/fix/test.rb
-- pkg_checksum
-homepage: https://github.com/fixrb/fix
+- lib/fix/suspicious_success_error.rb
+- lib/kernel.rb
+homepage: https://fixrb.dev/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/fixrb/fix
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -206,15 +149,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Specing framework.
+summary: Specing framework for Ruby.
 test_files: []