fix 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af4f77c8e0f75a3f88d2bdb4757cf1f7d122ed3e
-  data.tar.gz: f80e87cf83afcdcb0f731941769c6f7b95730887
+  metadata.gz: 1964b909221b9e975cd2bbaf03ebfe3fbe748fb1
+  data.tar.gz: bedaf49f6b9f171ad4abb82817d391b97beafabc
 SHA512:
-  metadata.gz: b75d2c1f34987e4bd05bf660ae656ba28cf9e09c4366c21a2a3dbff84e0852a3a8be7d6987451f8596bcfd3ddd73574492639d27bce1bb263780d2195a059b3f
-  data.tar.gz: ac75678ec541a7481ea4579d5cd0d34a3c0d112a6275021abfa42ab52622bac881ff41ec9f1970cac9066ce851583cd215a7ac6af0baa657809f53b094d4f096
+  metadata.gz: fc69cd9da13b6e207270601c1f71a9d489473991edbaa077901cc60a9faec0b53d31db95c57d3174f5f57b8610a4dee551a00ab148a290a2aeb37652c85a9013
+  data.tar.gz: fc477c8a857a294bb3a31413f64147b427c5ea7eeb6d53c69f4da37223a012f3339dd4b21bddf3716f15a08185ef02fbfe0dea73ade0b1b1570953a6e85cbd9c

data/README.md

@@ -1,20 +1,19 @@
 # Fix
 
-[![Build Status](https://travis-ci.org/cyril/fix.rb.svg?branch=master)](https://travis-ci.org/cyril/fix.rb)
-[![Coverage Status](http://img.shields.io/coveralls/cyril/fix.rb.svg?branch=master)](https://coveralls.io/r/cyril/fix.rb)
-[![Dependency Status](https://gemnasium.com/cyril/fix.rb.svg)](https://gemnasium.com/cyril/fix.rb)
+[![Build Status](https://travis-ci.org/fixrb/fix.svg?branch=master)](https://travis-ci.org/fixrb/fix)
+[![Coverage Status](http://img.shields.io/coveralls/fixrb/fix.svg?branch=master)](https://coveralls.io/r/fixrb/fix)
+[![Dependency Status](https://gemnasium.com/fixrb/fix.svg)](https://gemnasium.com/fixrb/fix)
 [![Gem Version](http://img.shields.io/gem/v/fix.svg)](https://rubygems.org/gems/fix)
-[![Inline docs](http://inch-ci.org/github/cyril/fix.rb.svg?branch=master)](http://inch-ci.org/github/cyril/fix.rb)
+[![Inline docs](http://inch-ci.org/github/fixrb/fix.svg?branch=master)](http://inch-ci.org/github/fixrb/fix)
 [![Documentation](http://img.shields.io/:yard-docs-38c800.svg)](http://rubydoc.info/gems/fix/frames)
-[![License](http://img.shields.io/:license-MIT-38c800.svg)](http://cyril.mit-license.org/)
 
 > Specing framework for Ruby.
 
 ## Contact
 
 * Home page: http://fixrb.org/
-* Bugs/issues: https://github.com/cyril/fix.rb/issues
-* Support: https://stackoverflow.com/questions/tagged/fix-ruby
+* Bugs/issues: https://github.com/fixrb/fix/issues
+* Support: https://stackoverflow.com/questions/tagged/fixrb
 
 ## Rubies
 
@@ -44,7 +43,7 @@ $ gem install fix
 
 ### Minimalist
 
-With ~400 lignes of **simple code** built on top of [Spectus expectation library](cyril/spectus.rb), facilities such as benchmarking and mocking are not supported. Fix offers however a **consistent** syntax to **DRY** and focus your BDD.
+With ~400 lignes of **simple code** 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** syntax to **DRY** and focus your BDD.
 
 ### Resistant
 
@@ -107,11 +106,11 @@ ruby duck_spec.rb
 
     .....
     Finished in 0.001033 seconds.
-    5 tests, 0 failures, 0 errors
+    100% compliant (5 specs, 0 infos, 0 failures, 0 errors)
 
 ## Contributing
 
-1. [Fork it](https://github.com/cyril/fix.rb/fork)
+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`)

data/VERSION.semver

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/fix

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'fix'
+
+Fix.run(*ARGV)

data/example/duck/README.md

@@ -4,5 +4,5 @@
 $ ./test.rb
 ......
 Finished in 0.001181 seconds.
-6 tests, 0 failures, 0 errors
+100% compliant (6 specs, 0 infos, 0 failures, 0 errors)
 ```

data/fix.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'

data/lib/fix.rb

@@ -1,6 +1,95 @@
-require_relative File.join 'fix', 'dsl'
 require_relative File.join 'fix', 'version'
 
+require 'optparse'
+require 'set'
+
 # Namespace for the Fix framework.
 module Fix
+
+  # This is the command line top-level run method.  Everything starts from here.
+  def self.run *args
+    process_args args
+    file_paths = fetch_file_paths args
+
+    print "> fix --seed #{SEED}"
+    print ' --color'    if defined? COLOR
+    print ' --debug'    if $DEBUG
+    print ' --warnings' if $VERBOSE
+
+    puts ' ' + file_paths.to_a.join(' ')
+
+    require_relative File.join 'fix', 'dsl'
+    file_paths.each {|file_path| require file_path }
+  end
+
+  def self.process_args args
+    options = {
+      seed:     Random.new_seed,
+      color:    false,
+      debug:    false,
+      warnings: false
+    }
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: fix <files or directories> [options]'
+
+      opts.separator ''
+      opts.separator 'Specific options:'
+
+      opts.on('-c', '--color', 'Enable color in the output.') do
+        options[:color] = (const_set :COLOR, true)
+      end
+
+      opts.on('-s [INTEGER]', '--seed [INTEGER]', Integer, 'Order of the tests') do |seed|
+        options[:seed] = seed
+      end
+
+      opts.on('-d', '--debug', 'Enable ruby debug') do
+        options[:debug] = $DEBUG = true
+      end
+
+      opts.on('-w', '--warnings', 'Enable ruby warnings') do
+        options[:warnings] = $VERBOSE = true
+      end
+
+      opts.separator ''
+      opts.separator 'Common options:'
+
+      opts.on_tail '-h', '--help', 'Show this message' do
+        puts opts
+        exit
+      end
+
+      opts.on_tail '--version', 'Show the version' do
+        puts VERSION
+        exit
+      end
+    end
+
+    opt_parser.parse! args
+    const_set :SEED, options.fetch(:seed)
+    options.freeze
+  end
+
+  def self.fetch_file_paths args
+    absolute_paths = Set.new
+
+    args.map do |s|
+      s = File.absolute_path s unless s.start_with? '/'
+
+      if File.directory? s
+        spec_files = File.join s, '**', '*_spec.rb'
+        Dir.glob(spec_files).each {|spec_file| absolute_paths.add spec_file }
+      else
+        absolute_paths.add s
+      end
+    end
+
+    if absolute_paths.empty?
+      warn 'Sorry, files or directories not found.'
+      exit 1
+    end
+
+    absolute_paths.freeze
+  end
 end

data/lib/fix/db.rb

@@ -1,7 +1,7 @@
 require 'singleton'
 
 module Fix
-  random = Random.new
+  random = Random.new(defined?(SEED) ? SEED : Random.new_seed)
 
   db = Class.new Hash do
     include Singleton

data/lib/fix/dsl.rb

@@ -12,6 +12,6 @@ module Fix
       @object = object
     end
 
-    at_exit { Test.new if $!.nil? or $!.kind_of?(SystemExit) }
+    at_exit { Test.new if $!.nil? }
   end
 end

data/lib/fix/expectation.rb

@@ -1,6 +1,7 @@
 require 'set'
 require 'spectus'
 require_relative 'db'
+require_relative 'subject'
 
 module Fix
   class Expectation
@@ -9,10 +10,10 @@ module Fix
     attr_reader :priority
 
     def initialize object, positive, definition, *args
-      @positive           = positive
-      @matcher, @expected = definition.to_a.flatten 1
-      @args               = args
-      @priority           = DB.instance.random.rand
+      @positive   = positive
+      @definition = definition
+      @args       = args
+      @priority   = DB.instance.random.rand
 
       freeze
 
@@ -26,10 +27,6 @@ module Fix
 
     private
 
-    def pass? result, _subject = nil
-      result.equal? true
-    end
-
     def exception result
       result unless [ true, false ].include? result
     end
@@ -38,12 +35,11 @@ module Fix
       !@positive
     end
 
-    def presenter result, got, subject = nil
+    def presenter result, got, subject
       {
-        pass:       pass?(result, subject),
+        pass:       pass(result, subject),
         negated:    negated?,
-        matcher:    @matcher,
-        expected:   @expected,
+        definition: @definition,
         exception:  exception(result),
         got:        got
       }
@@ -51,10 +47,10 @@ module Fix
 
     def meta subject
       {
-        level:              level,
-        params:             subject.params,
-        challenge:          subject.challenge,
-        subject_exception:  subject.error
+        level:      level,
+        params:     subject.params,
+        challenge:  subject.challenge,
+        last_arg:   subject.last_arg
       }
     end
 

data/lib/fix/expectation_high.rb

@@ -1,5 +1,4 @@
 require_relative 'expectation'
-require_relative 'subject'
 
 module Fix
   class ExpectationHigh < Expectation
@@ -8,17 +7,19 @@ module Fix
       got     = nil
 
       Thread.new {
-        report = expect { got = subject.actual }.
-          public_send target, @matcher => @expected
+        report = expect { got = subject.actual }.public_send target, @definition
+        data   = presenter report, got, subject
 
-        data = presenter report, got
-
-        Hash[ data.to_a + meta(subject).to_a ]
+        Hash[ data.to_a + meta(subject).to_a ].merge object: front_object
       }.value
     end
 
     private
 
+    def pass result, _subject
+      result.equal? true
+    end
+
     def level
       1
     end

data/lib/fix/expectation_low.rb

@@ -7,20 +7,18 @@ module Fix
       got     = nil
 
       Thread.new {
-        report = expect { got = subject.actual }.
-          public_send target, @matcher => @expected
+        report = expect { got = subject.actual }.public_send target, @definition
+        data   = presenter report, got, subject
 
-        data = presenter report, got, subject
-
-        Hash[ data.to_a + meta(subject).to_a ]
+        Hash[ data.to_a + meta(subject).to_a ].merge object: front_object
       }.value
     end
 
     private
 
-    def pass? result, subject
+    def pass result, subject
       if subject.implemented?
-        exception(result).nil?
+        super
       else
         true
       end

data/lib/fix/expectation_medium.rb

@@ -7,19 +7,17 @@ module Fix
       got     = nil
 
       Thread.new {
-        report = expect { got = subject.actual }.
-          public_send target, @matcher => @expected
+        report = expect { got = subject.actual }.public_send target, @definition
+        data   = presenter report, got, subject
 
-        data = presenter report, got
-
-        Hash[ data.to_a + meta(subject).to_a ]
+        Hash[ data.to_a + meta(subject).to_a ].merge object: front_object
       }.value
     end
 
     private
 
-    def pass? result, _subject
-      super || exception(result).nil?
+    def pass result, _subject
+      super || (exception(result).nil? ? nil : false)
     end
 
     def level

data/lib/fix/subject.rb

@@ -1,36 +1,33 @@
 module Fix
   class Subject
-    attr_reader :error
+    attr_reader :last_arg
 
     def initialize input, *args
-      @input  = input
-      @args   = args
-      @error  = nil
-
-      @implemented = nil
+      @args         = args
+      @error        = nil
+      @implemented  = nil
+      @last_arg     = -1
 
       begin
-        param_id = 0
         @cache_value = params.inject(input) do |mem, param|
-          param_id = param_id.next
-          @implemented = mem.respond_to? param.first, false
+          @implemented  = mem.respond_to? param.first, false
+          @last_arg     = @last_arg.next
+
           mem.public_send(*param)
         end
-      rescue => e
-        @error = {
-          exception:  e,
-          param_id:   param_id
-        }
+
+        @last_arg = @last_arg.next
+      rescue => @error
       end
 
       freeze
     end
 
     def actual
-      if valid?
+      if @error.nil?
         @cache_value.public_send(*challenge)
       else
-        raise @error.fetch :exception
+        raise @error
       end
     end
 
@@ -43,13 +40,7 @@ module Fix
     end
 
     def implemented?
-      @implemented && valid? && @cache_value.respond_to?(challenge.first, false)
-    end
-
-    private
-
-    def valid?
-      @error.nil?
+      @implemented && @error.nil? && @cache_value.respond_to?(challenge.first, false)
     end
   end
 end

data/lib/fix/test.rb

@@ -4,35 +4,104 @@ module Fix
   class Test
     attr_reader :total_time
 
-    def initialize color: true, stdout: $stdout, stderr: $stderr
-      @options = { color: color, stdout: stdout, stderr: stderr }
+    def initialize io = $stdout, color: defined?(COLOR)
+      @io     = io
+      @color  = color
 
       start_time = Time.now
-      @results = DB.instance.map do |object, expectations|
-        expectations.map do |expectation|
-          log expectation.evaluate object
-        end
-      end.flatten 1
+
+      @results = DB.instance.flat_map do |object, expectations|
+        expectations.map {|expectation| log expectation.evaluate(object) }
+      end
+
       @total_time = Time.now - start_time
 
-      @options.fetch(:stdout).puts about "\nFinished in #{@total_time} seconds."
-      @options.fetch(:stdout).puts statistics
+      @results = @results.sort {|a, b| a.fetch(:level) <=> b.fetch(:level) }
+
+      @io.puts
+
+      %i(errors failures infos).each do |results_with_state|
+        if reports(results_with_state).any?
+          @io.puts
+          @io.puts "# #{results_with_state.capitalize}:"
+          @io.puts
+
+          reports(results_with_state).each_with_index do |report, index|
+            @io.print about "#{index.next}. "
+            @io.puts report
+          end
+        end
+      end
+
+      @io.puts
+      @io.puts about "Finished in #{@total_time} seconds."
+      @io.puts statistics
 
       freeze
     end
 
-    def pass?
-      @results.all? {|result| state(result) == :success }
+    def errors
+      @results.select {|result| state(result) == :error }
     end
 
-    def fail?
-      !pass?
+    def failures
+      @results.select {|result| state(result) == :failure }
     end
 
-    def statistics
-      errors    = @results.select {|result| state(result) == :error   }
-      failures  = @results.select {|result| state(result) == :failure }
+    def infos
+      @results.select {|result| state(result) == :info }
+    end
+
+    def reports results_with_state
+      __send__(results_with_state).map do |result|
+        result.fetch(:object).inspect +
+          if result.fetch(:params).any?
+            '.' +
+            result.fetch(:params).map.with_index do |args, i|
+              color = if i == result.fetch(:last_arg)
+                state result
+              elsif i > result.fetch(:last_arg)
+                :pending
+              else
+                :default
+              end
+
+              __send__(color, "#{args.first}" +
+                if args.length > 1
+                  '(' + args[1..-1].map {|arg| arg.to_s }.join(',') + ')'
+                else
+                  ''
+                end
+              )
+            end.join('.')
+          else
+            ''
+          end +
+          '.' +
+          (
+            color = if result.fetch(:params).length == result.fetch(:last_arg)
+              state result
+            else
+              :pending
+            end
+
+            __send__(color, "#{result.fetch(:challenge).first}" +
+              if result.fetch(:challenge).length > 1
+                '(' + result.fetch(:challenge)[1..-1].map {|arg| arg.to_s }.join(',') + ')'
+              else
+                ''
+              end
+            )
+          ) +
+          ' ' +
+          expectation_level(result) +
+          ' ' +
+          matcher_with_expected_if_given(result) +
+          returned_value(result)
+      end
+    end
 
+    def statistics
       color = if errors.any?
         :error
       elsif failures.any?
@@ -41,32 +110,74 @@ module Fix
         :success
       end
 
-      __send__ color, [
-        "#{@results.length} tests",
+      percents = (@results.count {|result| result.fetch(:pass) != false }) / @results.length.to_f * 100
+
+      __send__ color, "#{percents.round}% compliant (" + [
+        "#{@results.length} specs",
+        "#{infos.length} infos",
         "#{failures.length} failures",
         "#{errors.length} errors"
-      ].join(', ')
+      ].join(', ') + ')'
+    end
+
+    def pass?
+      !@results.any? {|result| result.fetch(:pass) == false }
+    end
+
+    def fail?
+      !pass?
     end
 
     private
 
-    def log result
-      color = state result
-      std   = (color == :success ? :stdout : :stderr)
+    def returned_value result
+      if result.fetch(:exception).nil?
+        about ' # => got '    + result.fetch(:got).inspect
+      else
+        about ' # => raised ' + result.fetch(:exception).inspect
+      end
+    end
 
-      @options.fetch(std).print __send__ color, char(result)
+    def expectation_level result
+      case result.fetch :level
+      when 1
+        result.fetch(:negated) ? 'MUST_NOT' : 'MUST'
+      when 2
+        result.fetch(:negated) ? 'SHOULD_NOT' : 'SHOULD'
+      when 3
+        'MAY'
+      end
+    end
+
+    def matcher_with_expected_if_given result
+      definition = Array result.fetch(:definition)
+
+      definition.flatten(1)[0].to_s +
+      if definition.flatten(1).length > 1
+        ' ' + definition.flatten(1)[1].inspect
+      else
+        ''
+      end
+    end
+
+    def log result
+      @io.print __send__ state(result), char(result)
 
       result
     end
 
     def colorize state, string
-      @options[:color] ? "\e[#{state}m#{string}\e[0m" : string
+      @color ? "\e[#{state}m#{string}\e[0m" : string
     end
 
     def about string
       colorize 37, string
     end
 
+    def default string
+      colorize 30, string
+    end
+
     def error string
       colorize 31, string
     end
@@ -79,7 +190,7 @@ module Fix
       colorize 33, string
     end
 
-    def matcher string
+    def info string
       colorize 34, string
     end
 
@@ -91,6 +202,8 @@ module Fix
     def state data
       if data.fetch :pass
         :success
+      elsif data.fetch(:pass).nil?
+        :info
       elsif data.fetch(:exception).nil?
         :failure
       else
@@ -102,6 +215,8 @@ module Fix
     def char data
       if data.fetch :pass
         '.'
+      elsif data.fetch(:pass).nil?
+        'I'
       elsif data.fetch(:exception).nil?
         'F'
       else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fix
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Cyril Wack
@@ -30,7 +30,7 @@ cert_chain:
   sQCgS9KCAyZ+aWNO1bUJcE3Bx1XXkMO3JEyVR1CoEcexg5Ci03/lAm7lL84DmlKR
   3I7UWtomapPFbzC0J/5jzQ==
   -----END CERTIFICATE-----
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spectus
@@ -105,7 +105,8 @@ dependencies:
 description: Specing framework for Ruby.
 email:
 - cyril@sashite.com
-executables: []
+executables:
+- fix
 extensions: []
 extra_rdoc_files: []
 files:
@@ -117,6 +118,7 @@ files:
 - README.md
 - Rakefile
 - VERSION.semver
+- bin/fix
 - example/duck/README.md
 - example/duck/app.rb
 - example/duck/lib.rb