fix 0.6.1 → 0.7.0

data/lib/fix.rb

@@ -1,103 +1,25 @@
-require_relative File.join 'fix', 'dsl'
-require_relative File.join 'fix', 'version'
-
-require 'optparse'
-require 'set'
+require_relative File.join 'fix', 'test'
 
 # Namespace for the Fix framework.
+#
+# @api public
+#
 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'
-    print ' --color'          if defined? COLOR
-    print ' --debug'          if $DEBUG
-    print ' --hide_progress'  if defined? HIDE_PROGRESS
-    print " --seed #{SEED}"   if defined? SEED
-    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 = {
-      color:          false,
-      debug:          false,
-      hide_progress:  false,
-      seed:           Random.new_seed,
-      warnings:       false
-    }
-
-    opt_parser = OptionParser.new do |opts|
-      opts.banner = 'Usage: fix <files or directories> [options]'
-
-      opts.separator ''
-      opts.separator 'Specific options:'
-
-      opts.on('--color', 'Enable color in the output.') do
-        options[:color] = (const_set :COLOR, true)
-      end
-
-      opts.on('--debug', 'Enable ruby debug') do
-        options[:debug] = $DEBUG = true
-      end
-
-      opts.on('--hide_progress', 'Disable progress reporter in the output.') do
-        options[:hide_progress] = (const_set :HIDE_PROGRESS, true)
-      end
-
-      opts.on('--seed [INTEGER]', Integer, 'Order of the tests') do |seed|
-        options[:seed] = seed
-      end
-
-      opts.on('--warnings', 'Enable ruby warnings') do
-        options[:warnings] = $VERBOSE = true
-      end
-
-      opts.separator ''
-      opts.separator 'Common options:'
-
-      opts.on_tail '--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
-  end
-
-  def self.fetch_file_paths args
-    absolute_paths = Set.new
-
-    args.map do |s|
-      s = File.absolute_path s unless s.start_with? File::SEPARATOR
-
-      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
+  # Specs are built with this method.
+  #
+  # @example 42 must be equal to 42
+  #   describe(42) do
+  #     it { MUST Equal: 42 }
+  #   end
+  #
+  # @param front_object [BasicObject] The front object.
+  # @param specs        [Proc]        The set of specs.
+  #
+  # @return [ExpectationTarget] The expectation target.
+  def self.describe(front_object, &specs)
+    t = Test.new(front_object, &specs)
+
+    puts "#{t.report}"
+    exit t.pass?
   end
 end

data/lib/fix/helpers/it_helper.rb

@@ -0,0 +1,32 @@
+module Fix
+  # It's helper.
+  #
+  # @api private
+  #
+  module ItHelper
+    # Add it method to the DSL.
+    #
+    # @api public
+    #
+    # @example It must eql "FOO"
+    #   it { MUST Equal: 'FOO' }
+    #
+    # @param spec [Proc] A spec to compare against the computed actual value.
+    #
+    # @return [Array] List of results.
+    def it(&spec)
+      i = It.new do
+        Sandbox.new(@front_object, *@challenges).actual
+      end
+
+      result = begin
+                 i.instance_eval(&spec)
+               rescue Spectus::Result::Fail => f
+                 f
+               end
+
+      print result.to_char
+      results << result
+    end
+  end
+end

data/lib/fix/helpers/on_helper.rb

@@ -0,0 +1,29 @@
+module Fix
+  # On's helper.
+  #
+  # @api private
+  #
+  module OnHelper
+    # Add on method to the DSL.
+    #
+    # @api public
+    #
+    # @example On +2, it must equal 44.
+    #   on(:+, 2) do
+    #     it { MUST Equal: 44 }
+    #   end
+    #
+    # @param method_name [Symbol] The identifier of a method.
+    # @param args        [Array]  A list of arguments.
+    # @param block       [Proc]   A spec to compare against the computed value.
+    #
+    # @return [Array] List of results.
+    def on(method_name, *args, &block)
+      o = On.new(@front_object,
+                 results,
+                 *@challenges, Spectus::Challenge.new(method_name, *args))
+
+      o.instance_eval(&block)
+    end
+  end
+end

data/lib/fix/it.rb

@@ -1,13 +1,10 @@
-require_relative File.join 'helper', 'requirement_helper'
+require 'spectus/expectation_target'
 
 module Fix
-  class It
-    include Helper::RequirementHelper
-
-    def initialize object, defs, *args
-      @object = object
-      @defs   = defs
-      @args   = args
-    end
+  # Wraps the target of an expectation.
+  #
+  # @api private
+  #
+  class It < Spectus::ExpectationTarget
   end
 end

data/lib/fix/on.rb

@@ -1,19 +1,36 @@
-require_relative File.join 'helper', 'it_helper'
-require_relative File.join 'helper', 'its_helper'
-require_relative File.join 'helper', 'let_accessor_helper'
-require_relative File.join 'helper', 'on_helper' unless defined? Fix::Helper::OnHelper
+require 'spectus/challenge'
+require 'spectus/result/fail'
+
+require_relative 'it'
+
+%w(it on).each do |helper|
+  require_relative File.join 'helpers', "#{helper}_helper"
+end
+
+require_relative 'sandbox'
 
 module Fix
+  # Wraps the target of challenge.
+  #
+  # @api private
+  #
   class On
-    include Helper::ItHelper
-    include Helper::ItsHelper
-    include Helper::LetAccessorHelper
-    include Helper::OnHelper
-
-    def initialize object, defs, *args
-      @object = object
-      @defs   = defs
-      @args   = args
+    # Initialize the on class.
+    #
+    # @param front_object [BasicObject] The front object of the test.
+    # @param results      [Array]       The list of collected results.
+    # @param challenges   [Array]       The list of challenges to apply.
+    def initialize(front_object, results, *challenges)
+      @front_object = front_object
+      @results      = results
+      @challenges   = challenges
     end
+
+    # @!attribute [r] results
+    #
+    # @return [Array] The results.
+    attr_reader :results
+
+    [ItHelper, OnHelper].each { |helper| include helper }
   end
 end

data/lib/fix/report.rb

@@ -0,0 +1,61 @@
+module Fix
+  # The class that is responsible for reporting the result of the test.
+  #
+  # @api private
+  #
+  class Report
+    # Initialize the report class.
+    #
+    # @param test [Test] The test.
+    def initialize(test)
+      @test = test
+    end
+
+    # @!attribute [r] test
+    #
+    # @return [Test] The result.
+    attr_reader :test
+
+    # The report in plain text.
+    #
+    # @return [String] The report in plain text.
+    def to_s
+      "\n"                              \
+      "\n"                              \
+      "#{results_banner.join("\n")}\n"  \
+      "#{total_time_banner}\n"          \
+      "#{statistics_banner}\n"
+    end
+
+    private
+
+    # @private
+    def total_time_banner
+      "Ran #{test.results.length} tests in #{test.total_time} seconds"
+    end
+
+    # @private
+    def results_banner
+      test.results.reject { |r| r.to_char == '.' }.map.with_index(1) do |r, i|
+        "#{i}. #{r.message}\n" + maybe_backtrace(r)
+      end
+    end
+
+    # @private
+    def maybe_backtrace(result)
+      if result.respond_to?(:backtrace)
+        "    #{result.backtrace.first}\n"
+      else
+        ''
+      end
+    end
+
+    # @private
+    def statistics_banner
+      "#{test.statistics.fetch(:pass_percent)}% compliant - " \
+      "#{test.statistics.fetch(:total_infos)} infos, "        \
+      "#{test.statistics.fetch(:total_failures)} failures, "  \
+      "#{test.statistics.fetch(:total_errors)} errors"
+    end
+  end
+end

data/lib/fix/sandbox.rb

@@ -0,0 +1,25 @@
+module Fix
+  # Execute the untested code from the passed challenges.
+  #
+  # @api private
+  #
+  class Sandbox
+    # Initialize the sandbox class.
+    #
+    # @param object     [BasicObject] The front object of the test.
+    # @param challenges [Array]       The list of challenges to apply.
+    def initialize(object, *challenges)
+      @object     = object
+      @challenges = challenges
+    end
+
+    # The actual value.
+    #
+    # @return [BasicObject] The actual value.
+    def actual
+      @challenges.inject(@object) do |subject, challenge|
+        subject.public_send(challenge.symbol, *challenge.args)
+      end
+    end
+  end
+end

data/lib/fix/test.rb

@@ -1,253 +1,79 @@
-require_relative 'db'
+require_relative 'on'
+require_relative 'report'
 
 module Fix
+  # Wraps the target of the specs document.
+  #
+  # @api private
+  #
   class Test
-    attr_reader :total_time
-
-    def initialize io = $stdout, color: defined?(COLOR), hide_progress: defined?(HIDE_PROGRESS)
-      @io     = io
-      @color  = color
-
+    # Initialize the test class.
+    #
+    # @param front_object [BasicObject] The front object of the test.
+    # @param specs        [Proc]        The specs to test against the object.
+    def initialize(front_object, &specs)
       start_time = Time.now
 
-      @results = DB.instance.flat_map do |object, expectations|
-        expectations.map do |expectation|
-          if hide_progress
-            expectation.evaluate object
-          else
-            log expectation.evaluate(object)
-          end
-        end
-      end
+      g = On.new(front_object, [])
+      g.instance_eval(&specs)
 
+      @results    = g.results
       @total_time = Time.now - start_time
 
-      @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 "Ran #{@results.length} tests in #{@total_time} seconds"
-      @io.puts statistics
-
-      exit 1 if fail?
-    end
-
-    def errors
-      @results.select {|result| state(result) == :error }
-    end
-
-    def failures
-      @results.select {|result| state(result) == :failure }
-    end
-
-    def infos
-      @results.select {|result| state(result) == :info }
+      puts
     end
 
-    def reports results_with_state
-      __send__(results_with_state).map do |result|
-        truncate(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
+    # @!attribute [r] results
+    #
+    # @return [Array] The results.
+    attr_reader :results
 
-          __send__(color, "#{result.fetch(:challenge).first}" +
-            if result.fetch(:challenge).length > 1
-              '(' + result.fetch(:challenge)[1..-1].map {|arg| arg.inspect }.join(',') + ')'
-            else
-              ''
-            end
-          )
-        ) +
-        ' ' +
-        expectation_level(result) +
-        ' ' +
-        matcher_with_expected_if_given(result) +
-        returned_value(result)
-      end
-    end
+    # @!attribute [r] total_time
+    #
+    # @return [Float] The total time.
+    attr_reader :total_time
 
+    # Some statistics.
+    #
+    # @return [Hash] Some statistics.
     def statistics
-      color = if errors.any?
-        :error
-      elsif failures.any?
-        :failure
-      else
-        :success
-      end
-
-      percents = if @results.empty?
-        100
-      else
-        (@results.count {|result| result.fetch(:pass) != false }) / @results.length.to_f * 100
-      end
+      {
+        pass_percent:   pass_percent,
+        total_infos:    results.count { |r| r.to_char == 'I' },
+        total_failures: results.count { |r| r.to_char == 'F' },
+        total_errors:   results.count { |r| r.to_char == 'E' }
+      }
+    end
 
-      __send__ color, "#{percents.round}% compliant - " + [
-        "#{infos.length} infos",
-        "#{failures.length} failures",
-        "#{errors.length} errors"
-      ].join(', ')
+    # The report of the test.
+    #
+    # @return [Report] The report of the test.
+    def report
+      Report.new(self)
     end
 
+    # The state of the test.
+    #
+    # @return [Boolean] Return true if the test pass.
     def pass?
-      !@results.any? {|result| result.fetch(:pass) == false }
+      results.all?(&:result?)
     end
 
+    # @return [Boolean] Return false if the test fail.
     def fail?
       !pass?
     end
 
     private
 
-    def truncate string
-      if string.length > 16
-        string[0..16].concat '[...]'
-      else
-        string
-      end
-    end
-
-    def returned_value result
-      if result.fetch(:exception).nil?
-        about ' # => got '    + result.fetch(:got).inspect
-      else
-        about ' # => raised ' + result.fetch(:exception).inspect
-      end
-    end
-
-    def expectation_level result
-      case result.fetch :level
-      when 1
-        if result.fetch :negated
-          'MUST_NOT'
-        else
-          'MUST'
-        end
-      when 2
-        if result.fetch :negated
-          'SHOULD_NOT'
-        else
-          'SHOULD'
-        end
-      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
-      if @color
-        "\e[#{state}m#{string}\e[0m"
-      else
-        string
-      end
-    end
-
-    def about string
-      colorize 37, string
-    end
-
-    def default string
-      colorize 30, string
-    end
-
-    def error string
-      colorize 31, string
-    end
-
-    def success string
-      colorize 32, string
-    end
-
-    def pending string
-      colorize 33, string
-    end
-
-    def info string
-      colorize 34, string
-    end
-
-    def failure string
-      colorize 35, string
-    end
-
-    # Returns the state of the expectation.
-    def state data
-      if data.fetch :pass
-        :success
-      elsif data.fetch(:pass).nil?
-        :info
-      elsif data.fetch(:exception).nil?
-        :failure
-      else
-        :error
-      end
-    end
-
-    # Returns a char as the result of the expectation.
-    def char data
-      if data.fetch :pass
-        '.'
-      elsif data.fetch(:pass).nil?
-        'I'
-      elsif data.fetch(:exception).nil?
-        'F'
+    # @private
+    #
+    # @return [Fixnum] Return the percentage of passing specs.
+    def pass_percent
+      if results.empty?
+        100
       else
-        'E'
+        (results.count(&:result?) / results.length.to_f * 100).round
       end
     end
   end