given_core 3.0.0.beta.1

data/Rakefile

@@ -0,0 +1,232 @@
+#!/usr/bin/ruby -wKU
+
+require 'rake/clean'
+require './lib/given/version'
+require './lib/given/module_methods'
+
+CLEAN.include("pkg/rspec-given-*").exclude("pkg/*.gem")
+CLOBBER.include("*.gemspec", "html", "README", "README.old")
+
+# README Formatting --------------------------------------------------
+
+task :default => :examples
+
+def version
+  Given::VERSION
+end
+
+def tag_name
+  "rspec-given-#{version}"
+end
+
+def tagged?
+  `git tag`.split.include?(tag_name)
+end
+
+def git_clean?
+  sh "git status | grep 'nothing to commit'", :verbose => false do |status|
+    return status
+  end
+end
+
+desc "Display the current version tag"
+task :version do
+  puts tag_name
+end
+
+desc "Tag the current commit with #{tag_name}"
+task :tag do
+  fail "Cannot tag, project directory is not clean" unless git_clean?
+  fail "Cannot tag, #{tag_name} already exists." if tagged?
+  sh "git tag #{tag_name}"
+end
+
+# Running examples ---------------------------------------------------
+
+desc "Run all the examples"
+task :examples => [:specs, :rs_examples]
+
+desc "Run the RSpec 2 specs and examples"
+task :examples => [:specs, :rs_examples, :mt_examples]
+
+desc "Run the specs"
+task :specs do
+  puts "Running specs"
+  sh "rspec spec"
+end
+
+EXAMPLES = FileList['examples/**/*_spec.rb'].
+  exclude('examples/failing/*.rb').
+  exclude('examples/integration/failing/*.rb')
+
+unless Given::NATURAL_ASSERTIONS_SUPPORTED
+  EXAMPLES.exclude("examples/stack/*.rb")
+end
+
+FAILING_EXAMPLES = FileList['examples/failing/**/*_spec.rb']
+
+desc "Run the RSpec specs and examples"
+task :rs => [:specs, :rs_examples]
+
+desc "Run the Minitest tests and examples"
+task :mt => [:specs, :mt_examples]
+
+desc "Run the examples in RSpec 2"
+task :rs_examples => [:verify_rspec2] do
+  puts "Running examples (with RSpec2)"
+  sh "rspec #{EXAMPLES}"
+end
+
+desc "Run the examples in Minitest"
+task :mt_examples do
+  puts "Running examples (with Minitest)"
+  ENV['FRAMEWORK'] = 'Minitest'
+  sh "ruby -Ilib:examples examples/loader.rb #{EXAMPLES}"
+end
+
+desc "Run failing examples"
+task :failing => [:verify_rspec2] do
+  puts "Running failing examples (with RSpec2)"
+  sh "rspec #{FAILING_EXAMPLES}"
+end
+
+task :verify_rspec1 do
+  sh "type spec >/dev/null 2>&1", :verbose => false do |status|
+    fail "You need to install RSpec 1 in order to test against it." unless status
+  end
+end
+
+task :verify_rspec2 do
+  sh "type rspec >/dev/null 2>&1", :verbose => false do |status|
+    fail "You need to install RSpec 2 in order to test against it." unless status
+  end
+end
+
+task :load_check do
+  SRC_FILES = FileList['lib/rspec/given/*.rb'].exclude(%r(rspec1))
+  SRC_FILES.each do |fn|
+    sh %{ruby -Ilib -e 'load "#{fn}"'}
+  end
+end
+
+# Formatting the README ----------------------------------------------
+
+directory 'html'
+
+desc "Display the README file"
+task :readme => ["README.md"] do
+  Bundler.with_clean_env do
+    sh "ghpreview README.md"
+  end
+end
+
+desc "Generate an RDoc README"
+file "README.md" => ["examples/stack/stack_spec.rb", "lib/given/version.rb"] do
+  open("README.md") do |ins|
+    open("README.tmp", "w") do |outs|
+      state = :copy
+      while line = ins.gets
+        case state
+        when :copy
+          if line =~ /rspec-given, version +\d+(\.(\d+|beta))+/i
+            line.gsub!(/version +\d+(\.(\d+|beta))+/i, "version #{Given::VERSION}")
+            outs.puts line
+          elsif line =~ /^<pre>/
+            state = :insert
+          else
+            outs.puts line
+          end
+        when :insert
+          outs.puts "<pre>"
+          outs.puts open("examples/stack/stack_spec.rb") { |codes| codes.read }
+          outs.puts "</pre>"
+          state = :skip
+        when :skip
+          state = :copy2 if line =~ /^<\/pre>/
+        when :copy2
+          outs.puts line
+        end
+      end
+    end
+  end
+  mv "README.md", "README.old"
+  mv "README.tmp", "README.md"
+end
+
+
+# RDoc ---------------------------------------------------------------
+begin
+  require 'rdoc/task'
+  if RDoc::VERSION > "2.4.2"
+    RDOC_ENABLED = true
+  else
+    puts "Version of RDoc is too old, please gem install a later version"
+    RDOC_ENABLED = false
+  end
+rescue LoadError => ex
+  RDOC_ENABLED = false
+end
+
+begin
+  require 'darkfish-rdoc'
+  DARKFISH_ENABLED = true
+rescue LoadError => ex
+  DARKFISH_ENABLED = false
+end
+
+if RDOC_ENABLED
+  def md_to_rdoc(infile, outfile)
+    open(infile) do |ins|
+      open(outfile, "w") do |outs|
+        state = :copy
+        while line = ins.gets
+          case state
+          when :ignore
+            if line =~ /^-->/
+              state = :copy
+            end
+          when :pre
+            if line =~ /^<\/pre>/
+              state = :copy
+            else
+              outs.puts "    #{line}"
+            end
+          when :copy
+            if line =~ /^<!--/
+              state = :ignore
+            elsif line =~ /^<pre>/
+              state = :pre
+            else
+              line.gsub!(/^####/, '====')
+              line.gsub!(/^###/, '===')
+              line.gsub!(/^##/, '==')
+              line.gsub!(/^#/, '=')
+              outs.puts line
+            end
+          end
+        end
+      end
+    end
+  end
+
+  file "README" => ["README.md"] do
+    md_to_rdoc("README.md", "README")
+  end
+
+  RDoc::Task.new("rdoc") do |rdoc|
+    rdoc.rdoc_dir = 'html'
+    rdoc.title    = "RSpec/Given -- A Given/When/Then extension for RSpec"
+    rdoc.options = [
+      '--line-numbers',
+      '--main' , 'doc/main.rdoc',
+      '--title', 'Given - Given/When/Then Extensions for RSpec'
+    ]
+    rdoc.options << '-SHN' << '-f' << 'darkfish' if DARKFISH_ENABLED
+
+    rdoc.rdoc_files.include('README')
+    rdoc.rdoc_files.include('MIT-LICENSE')
+    rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+  end
+
+  task :rdoc => "README"
+end

data/TODO

@@ -0,0 +1,13 @@
+Things to do to improve the minitest integration
+
+TODO:
+
+* Make a separate gem for minitest (do we need one for given-core?)
+
+DONE:
+
+* Handle have_failed in minitest
+* General cleanup making sure files go where they need.
+* Implement assertion counting for minitest
+* Figure out why the minitest example count is so low.
+* Move stuff out of minitest_helper to appropriate file.

data/doc/main.rdoc

@@ -0,0 +1,7 @@
+= Given/When/Then for RSpec
+
+rspec-given is an RSpec extension to allow Given/When/Then notation in
+RSpec specifications.  It is a natural extension of the experimental
+work done on the Given framework.
+
+For more information see http://github.com/jimweirich/rspec-given

data/lib/given.rb

@@ -0,0 +1,2 @@
+
+require 'given/core'

data/lib/given/core.rb

@@ -0,0 +1,11 @@
+
+# Require all the core features
+
+require 'given/version'
+require 'given/module_methods'
+require 'given/file_cache'
+require 'given/line_extractor'
+require 'given/extensions'
+require 'given/fuzzy_number'
+require 'given/failure'
+require 'given/failure_matcher'

data/lib/given/evaluator.rb

@@ -0,0 +1,38 @@
+
+module Given
+  class EvalErr
+    def initialize(str)
+      @string = str
+    end
+    def size
+      inspect.size
+    end
+    def to_s
+      @string
+    end
+    def inspect
+      @string
+    end
+  end
+
+  class Evaluator
+    def initialize(example, block)
+      @example = example
+      @block = block
+    end
+
+    def eval_string(exp_string)
+      eval_in_context(exp_string).inspect
+    rescue StandardError => ex
+      EvalErr.new("#{ex.class}: #{ex.message}")
+    end
+
+    private
+
+    def eval_in_context(exp_string)
+      exp_proc = "proc { #{exp_string} }"
+      blk = eval(exp_proc, @block.binding)
+      @example.instance_eval(&blk)
+    end
+  end
+end

data/lib/given/ext/numeric.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+module Given
+  module Ext
+    module Numeric
+
+      def ±(del=nil)
+        result = Given::Fuzzy::FuzzyNumber.new(self)
+        result.delta(del) if del
+        result
+      end
+
+      def ‰(percentage=nil)
+        result = Given::Fuzzy::FuzzyNumber.new(self)
+        result.percent(percentage) if percentage
+        result
+      end
+
+      def €(neps=nil)
+        result = Given::Fuzzy::FuzzyNumber.new(self)
+        result.epsilon(neps) if neps
+        result
+      end
+
+    end
+  end
+end
+
+class Numeric
+  include Given::Ext::Numeric
+end

data/lib/given/extensions.rb

@@ -0,0 +1,242 @@
+require 'given/module_methods'
+require 'given/natural_assertion'
+require 'given/failure'
+
+module Given
+
+  # Provide run-time methods to support Given infrastructure. All the
+  # methods in this module are considered private and
+  # implementation-specific.
+  module InstanceExtensions   # :nodoc:
+
+    # List of containing contexts in order from innermost to
+    # outermost.
+    def _gvn_inner_contexts    # :nodoc:
+      self.class.ancestors.select { |context|
+        context.respond_to?(:_Gvn_givens)
+      }
+    end
+
+    # List of containing contexts in order from outermost to
+    # innermost.
+    def _gvn_contexts          # :nodoc:
+      _gvn_inner_contexts.reverse
+    end
+
+    # Return the context information for keyword from the innermost
+    # defining context.
+    def _gvn_info(keyword)     # :nodoc:
+      _gvn_inner_contexts.each do |context|
+        h = context._Gvn_context_info
+        if h.has_key?(keyword)
+          return h[keyword]
+        end
+      end
+      nil
+    end
+
+    # Should a natural assertion failure message be generated?
+    #
+    # A natural assertion failure message is generated if the
+    # assertion has non-empty content. The configuration options for
+    # natural assertions are checked and applied accordingly.
+    #
+    def _gvn_need_na_message?(nassert) # :nodoc:
+      return false unless nassert.has_content?
+      _gvn_na_configured?
+    end
+
+    # Return the configuration value for natural assertions.
+    #
+    # If natural assertions are not configured in the contexts, use
+    # the global configuration value.
+    def _gvn_na_configured?    # :nodoc:
+      info_value = _gvn_info(:natural_assertions_enabled)
+      info_value.nil? ? Given.natural_assertions_enabled? : info_value
+    end
+
+    # Establish all the Given preconditions the current and
+    # surrounding describe/context blocks, starting with the
+    # outermost context.
+    def _gvn_establish_givens  # :nodoc:
+      return if defined?(@_gvn_ran) && @_gvn_ran
+      @_gvn_ran = true
+      _gvn_contexts.each do |context|
+        context._Gvn_givens.each do |block|
+          instance_eval(&block)
+        end
+      end
+    end
+
+    # Check all the invariants in the current and surrounding
+    # describe/context blocks, starting with the outermost context.
+    def _gvn_check_invariants  # :nodoc:
+      _gvn_contexts.each do |context|
+        context._Gvn_invariants.each do |block|
+          _gvn_evaluate("Invariant", block)
+        end
+      end
+    end
+
+    def _gvn_check_ands  # :nodoc:
+      return if self.class._Gvn_context_info[:and_ran]
+      self.class._Gvn_and_blocks.each do |block|
+        _gvn_evaluate("And", block)
+      end
+      self.class._Gvn_context_info[:and_ran] = true
+    end
+
+    # Implement the run-time semantics of the Then clause.
+    def _gvn_then(&block)      # :nodoc:
+      _gvn_establish_givens
+      _gvn_check_invariants
+      _gvn_evaluate("Then", block)
+      _gvn_check_ands
+    end
+
+    # Evaluate a Then, And, or Invariant assertion.
+    def _gvn_evaluate(clause_type, block)   # :nodoc:
+      Given.framework.start_evaluation
+      passed = instance_eval(&block)
+      if ! Given.framework.explicit_assertions? && _gvn_na_configured?
+        _gvn_naturally_assert(clause_type, block, passed)
+      end
+    end
+
+    def _gvn_naturally_assert(clause_type, block, passed)
+      Given.framework.count_assertion
+      unless passed
+        nassert = NaturalAssertion.new(clause_type, block, self, self.class._Gvn_lines)
+        Given.fail_with nassert.message if _gvn_need_na_message?(nassert)
+      end
+    end
+  end
+
+  module ClassExtensions
+
+    # List of all givens directly in the current describe/context
+    # block.
+    def _Gvn_givens            # :nodoc:
+      @_Gvn_givens ||= []
+    end
+
+    # List of all invariants directly in the current
+    # describe/context block.
+    def _Gvn_invariants        # :nodoc:
+      @_Gvn_invariants ||= []
+    end
+
+    def _Gvn_and_blocks
+      @_Gvn_and_blocks ||= []
+    end
+
+    def _Gvn_context_info
+      @_Gvn_context_info ||= {}
+    end
+
+    def _Gvn_lines
+      @_Gvn_lines ||= LineExtractor.new
+    end
+
+    # Trigger the evaluation of a Given! block by referencing its
+    # name.
+    def _Gvn_trigger_given(name) # :nodoc:
+      Proc.new { send(name) }
+    end
+
+    # Declare a "given" of the current specification.  If the given
+    # is named, the block will be lazily evaluated the first time
+    # the given is mentioned by name in the specification.  If the
+    # given is unnamed, the block is evaluated for side effects
+    # every time the specification is executed.
+    #
+    # :call-seq:
+    #   Given(:name) { ... code ... }
+    #   Given { ... code ... }
+    #
+    def Given(*args, &block)
+      if args.first.is_a?(Symbol)
+        let(args.first, &block)
+      else
+        _Gvn_givens << block
+      end
+    end
+
+    # Declare a named given of the current specification.  Similar
+    # to the named version of the "Given" command, except that the
+    # block is always evaluated.
+    #
+    # :call-seq:
+    #   Given!(:name) { ... code ... }
+    #
+    def Given!(name, &block)
+      let(name, &block)
+      _Gvn_givens << _Gvn_trigger_given(name)
+    end
+
+    # Declare the code that is under test.
+    #
+    # :call-seq:
+    #   When(:named_result) { ... code_under_test ... }
+    #   When { ... code_under_test ... }
+    #
+    def When(*args, &block)
+      if args.first.is_a?(Symbol)
+        let(args.first) do
+          begin
+            _gvn_establish_givens
+            instance_eval(&block)
+          rescue Given.pending_error => ex
+            raise
+          rescue Exception => ex
+            Failure.new(ex)
+          end
+        end
+        _Gvn_before do __send__(args.first) end
+      else
+        _Gvn_before do
+          _gvn_establish_givens
+          instance_eval(&block)
+        end
+      end
+    end
+
+    # Provide an assertion about the specification.
+    #
+    # Then supplies an assertion that should be true after all the
+    # Given and When blocks have been run. All invariants in scope
+    # will be checked before the Then block is run.
+    #
+    # :call-seq:
+    #   Then { ... assertion ... }
+    #
+    def Then(&block)
+      env = block.binding
+      file, line = eval "[__FILE__, __LINE__]", env
+      description = _Gvn_lines.line(file, line) unless Given.source_caching_disabled
+      if description
+        cmd = "it(description)"
+      else
+        cmd = "specify"
+      end
+      eval %{#{cmd} do _gvn_then(&block) end}, binding, file, line
+      _Gvn_context_info[:then_defined] = true
+    end
+
+    # Establish an invariant that must be true for all Then blocks
+    # in the current (and nested) scopes.
+    def Invariant(&block)
+      _Gvn_invariants << block
+    end
+
+    def And(&block)
+      fail "And defined without a Then" unless _Gvn_context_info[:then_defined]
+      _Gvn_and_blocks << block
+    end
+
+    def use_natural_assertions(enabled=true)
+      Given.ok_to_use_natural_assertions(enabled)
+      _Gvn_context_info[:natural_assertions_enabled] = enabled
+    end
+  end
+end