rspec-given 2.4.1 → 2.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2526965146d0b14ab9961e98cd410bcbc2778294
+  data.tar.gz: 34ec57d90eb5e434f33932b35cc029ca38933822
+SHA512:
+  metadata.gz: a5e34bc27ea98957e2494940ede0550dc77199ccf77bd44d3e9bce24d7561c9ebdbfaeb15994a3a9fb9ff3be01b35194ab947b0011d6cc48051a924adf11d74c
+  data.tar.gz: cfbbcf7d2975f67a2487d08da61c58622688a73f607a97250cb77e548fee7f0c080a38fc19e336af6d2219bd3b725b0ff8a13551b91698ff65d004a8ab6c20ba

data/Gemfile

@@ -1,11 +1,3 @@
 source 'https://rubygems.org'
-gem 'rspec', '>= 2.12'
-gem 'rake', '>= 0.9.2.2'
-gem 'sorcerer'
-
-group :dev do
-  gem 'bluecloth'
-  gem 'ghpreview'
-  gem 'flog'
-  gem 'flay'
-end
+gemspec
+gem 'rake'

data/Gemfile.lock

@@ -1,54 +1,15 @@
+PATH
+  remote: .
+  specs:
+    rspec-given (2.4.1)
+      rspec (>= 2.12)
+      sorcerer (>= 0.3.7)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.12)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    blankslate (3.1.2)
-    bluecloth (2.2.0)
-    charlock_holmes (0.6.9.1)
-    diff-lcs (1.2.1)
-    escape_utils (0.2.4)
-    ffi (1.0.11)
-    flay (2.1.0)
-      ruby_parser (~> 3.0)
-      sexp_processor (~> 4.0)
-    flog (3.2.2)
-      ruby_parser (~> 3.1, > 3.1.0)
-      sexp_processor (~> 4.0)
-    gemoji (1.4.0)
-    ghpreview (0.0.6)
-      github-linguist (= 2.1)
-      html-pipeline (= 0.0.6)
-      httpclient
-      listen
-      rb-fsevent
-    github-linguist (2.1.0)
-      charlock_holmes (~> 0.6.6)
-      escape_utils (~> 0.2.3)
-      mime-types (~> 1.18)
-      pygments.rb (~> 0.2.13)
-    github-markdown (0.5.3)
-    html-pipeline (0.0.6)
-      activesupport (>= 2)
-      escape_utils (~> 0.2)
-      gemoji (~> 1.0)
-      github-linguist (~> 2.1)
-      github-markdown (~> 0.5)
-      nokogiri (~> 1.4)
-      rinku (~> 1.7)
-      sanitize (~> 2.0)
-    httpclient (2.3.3)
-    i18n (0.6.4)
-    listen (0.7.3)
-    mime-types (1.21)
-    multi_json (1.6.1)
-    nokogiri (1.5.6)
-    pygments.rb (0.2.13)
-      rubypython (~> 0.5.3)
-    rake (10.0.3)
-    rb-fsevent (0.9.3)
-    rinku (1.7.2)
+    diff-lcs (1.2.4)
+    rake (10.0.4)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -56,25 +17,12 @@ GEM
     rspec-core (2.13.1)
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    ruby_parser (3.1.1)
-      sexp_processor (~> 4.1)
-    rubypython (0.5.3)
-      blankslate (>= 2.1.2.3)
-      ffi (~> 1.0.7)
-    sanitize (2.0.3)
-      nokogiri (>= 1.4.4, < 1.6)
-    sexp_processor (4.1.5)
+    rspec-mocks (2.13.1)
     sorcerer (0.3.10)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bluecloth
-  flay
-  flog
-  ghpreview
-  rake (>= 0.9.2.2)
-  rspec (>= 2.12)
-  sorcerer
+  rake
+  rspec-given!

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010, 2011 Jim Weirich
+Copyright (c) 2011, 2012, 2013 by Jim Weirich
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,4 +18,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/README.md

@@ -4,12 +4,11 @@
 | :----: |
 | [![Master Build Status](https://secure.travis-ci.org/jimweirich/rspec-given.png?branch=master)](https://travis-ci.org/jimweirich/rspec-given) |
 
-Covering rspec-given, version 2.4.1.
+Covering rspec-given, version 2.4.2.
 
 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.  It turns out that 90% of the Given
-framework can be trivially implemented on top of RSpec.
+work done on the Given framework.
 
 # Why Given/When/Then
 
@@ -645,8 +644,22 @@ file:
                                                 # ... even when should/expect are detected
 ```
 
+# License
+
+RSpec-Given is available under the MIT License.  See the MIT-LICENSE
+file in the source distribution.
+
 # History
 
+* Version 2.4.2
+
+  * Minor adjustment to natural assertion error messages to better
+    handle multi-line values.
+
+  * Remove flog, flay and other development tools from the bundle and
+    gemspec. The Rakefile was updated to suggest installing them if
+    they are not there.
+
 * Version 2.4.1
 
   * Fix bug where constants from nested modules were not properly

data/Rakefile

@@ -2,18 +2,13 @@
 
 require 'rake/clean'
 require './lib/rspec/given/version'
+require './lib/rspec/given/module_methods'
 
 CLEAN.include("pkg/rspec-given-*").exclude("pkg/*.gem")
 CLOBBER.include("*.gemspec", "html", "README", "README.old")
 
 # README Formatting --------------------------------------------------
 
-begin
-  require 'bluecloth'
-rescue LoadError => ex
-  puts "WARNING: BlueCloth not available"
-end
-
 task :default => :ex2
 
 def version
@@ -69,6 +64,11 @@ end
 EXAMPLES = FileList['examples/**/*_spec.rb'].
   exclude('examples/failing/*.rb').
   exclude('examples/integration/failing/*.rb')
+
+unless RSpec::Given::NATURAL_ASSERTIONS_SUPPORTED
+  EXAMPLES.exclude("examples/stack/*.rb")
+end
+
 FAILING_EXAMPLES = FileList['examples/failing/**/*_spec.rb']
 
 desc "Run the examples in RSpec 2"
@@ -96,7 +96,7 @@ task :verify_rspec2 do
 end
 
 task :load_check do
-  SRC_FILES = FileList['lib/rspec/given/*.rb'].exclude(/rspec1/)
+  SRC_FILES = FileList['lib/rspec/given/*.rb'].exclude(%r(rspec1))
   SRC_FILES.each do |fn|
     sh %{ruby -Ilib -e 'load "#{fn}"'}
   end
@@ -108,7 +108,9 @@ directory 'html'
 
 desc "Display the README file"
 task :readme => ["README.md"] do
-  sh "ghpreview README.md"
+  Bundler.with_clean_env do
+    sh "ghpreview README.md"
+  end
 end
 
 desc "Generate an RDoc README"
@@ -147,9 +149,13 @@ end
 
 # RDoc ---------------------------------------------------------------
 begin
-  gem "rdoc"
   require 'rdoc/task'
-  RDOC_ENABLED = true
+  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
@@ -205,7 +211,7 @@ if RDOC_ENABLED
     rdoc.title    = "RSpec/Given -- A Given/When/Then extension for RSpec"
     rdoc.options = [
       '--line-numbers',
-      '--main' , 'README',
+      '--main' , 'doc/main.rdoc',
       '--title', 'RSpec::Given - Given/When/Then Extensions for RSpec'
     ]
     rdoc.options << '-SHN' << '-f' << 'darkfish' if DARKFISH_ENABLED

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/examples/stack/stack_spec.rb

@@ -2,25 +2,24 @@ require 'rspec/given'
 require 'example_helper'
 require 'stack'
 
+RSpec::Given.use_natural_assertions
+
 describe Stack do
-  def stack_with(initial_contents)
-    stack = Stack.new
-    initial_contents.each do |item| stack.push(item) end
-    stack
-  end
+  Given(:stack) { Stack.new }
+  Given(:initial_contents) { [] }
+  Given { initial_contents.each do |item| stack.push(item) end }
 
-  Given(:stack) { stack_with(initial_contents) }
-  Invariant { stack.empty?.should == (stack.depth == 0) }
+  Invariant { stack.empty? == (stack.depth == 0) }
 
-  context "when empty" do
+  context "with an empty stack" do
     Given(:initial_contents) { [] }
-    Then { stack.depth.should == 0 }
+    Then { stack.depth == 0 }
 
     context "when pushing" do
       When { stack.push(:an_item) }
 
-      Then { stack.depth.should == 1 }
-      Then { stack.top.should == :an_item }
+      Then { stack.depth == 1 }
+      Then { stack.top == :an_item }
     end
 
     context "when popping" do
@@ -35,8 +34,8 @@ describe Stack do
     context "when popping" do
       When(:pop_result) { stack.pop }
 
-      Then { pop_result.should == :an_item }
-      Then { stack.depth.should == 0 }
+      Then { pop_result == :an_item }
+      Then { stack.depth == 0 }
     end
   end
 
@@ -47,16 +46,16 @@ describe Stack do
     context "when pushing" do
       When { stack.push(:new_item) }
 
-      Then { stack.top.should == :new_item }
-      Then { stack.depth.should == original_depth + 1 }
+      Then { stack.top == :new_item }
+      Then { stack.depth == original_depth + 1 }
     end
 
     context "when popping" do
       When(:pop_result) { stack.pop }
 
-      Then { pop_result.should == :top_item }
-      Then { stack.top.should == :second_item }
-      Then { stack.depth.should == original_depth - 1 }
+      Then { pop_result == :top_item }
+      Then { stack.top == :second_item }
+      Then { stack.depth == original_depth - 1 }
     end
   end
 end

data/lib/rspec/given/evaluator.rb

@@ -0,0 +1,39 @@
+module RSpec
+  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
+end

data/lib/rspec/given/natural_assertion.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require 'rspec/given/module_methods'
+require 'rspec/given/evaluator'
 
 if RSpec::Given::NATURAL_ASSERTIONS_SUPPORTED
   require 'ripper'
@@ -12,29 +13,13 @@ module RSpec
 
     InvalidThenError = Class.new(StandardError)
 
-    class EvalErr
-      def initialize(str)
-        @string = str
-      end
-      def size
-        inspect.size
-      end
-      def to_s
-        @string
-      end
-      def inspect
-        @string
-      end
-    end
-
     class NaturalAssertion
 
       def initialize(clause_type, block, example, line_extractor)
         @clause_type = clause_type
-        @block = block
-        @example = example
+        @evaluator = Evaluator.new(example, block)
         @line_extractor = line_extractor
-        set_file_and_line
+        set_file_and_line(block)
       end
 
       VOID_SEXP = [:void_stmt]
@@ -56,10 +41,6 @@ module RSpec
         @output
       end
 
-      def evaluate(expr_string)
-        eval_in_context(expr_string)
-      end
-
       private
 
       def using_should?
@@ -96,7 +77,7 @@ module RSpec
 
       def expression_value_pairs
         assertion_subexpressions.map { |exp|
-          [exp, eval_string(exp)]
+          [exp, @evaluator.eval_string(exp)]
         }
       end
 
@@ -112,8 +93,8 @@ module RSpec
         @source ||= @line_extractor.line(@code_file, @code_line)
       end
 
-      def set_file_and_line
-        @code_file, @code_line = eval "[__FILE__, __LINE__]", @block.binding
+      def set_file_and_line(block)
+        @code_file, @code_line = eval "[__FILE__, __LINE__]", block.binding
         @code_line = @code_line.to_i
       end
 
@@ -168,20 +149,8 @@ module RSpec
       end
 
       def eval_sexp(sexp)
-        expr = Sorcerer.source(sexp)
-        eval_string(expr)
-      end
-
-      def eval_string(exp_string)
-        eval_in_context(exp_string).inspect
-      rescue StandardError => ex
-        EvalErr.new("#{ex.class}: #{ex.message}")
-      end
-
-      def eval_in_context(exp_string)
-        exp_proc = "proc { #{exp_string} }"
-        blk = eval(exp_proc, @block.binding)
-        @example.instance_eval(&blk)
+        expr_string = Sorcerer.source(sexp)
+        @evaluator.eval_string(expr_string)
       end
 
       WRAP_WIDTH = 20
@@ -189,13 +158,22 @@ module RSpec
       def display_pairs(pairs)
         width = suggest_width(pairs)
         pairs.each do |x, v|
-          fmt = (v.size > WRAP_WIDTH) ?
-          "  %-#{width+2}s\n  #{' '*(width+2)} <- %s\n" :
-            "  %-#{width+2}s <- %s\n"
+          v = adjust_indentation(v)
+          fmt = multi_line?(v) ?
+          "%-#{width+2}s\n  #{' '*(width+2)} <- %s\n" :
+            "%-#{width+2}s <- %s\n"
           @output << sprintf(fmt, v, x)
         end
       end
 
+      def adjust_indentation(string)
+        string.to_s.gsub(/^/, '  ')
+      end
+
+      def multi_line?(string)
+        (string.size > WRAP_WIDTH) || (string =~ /\n/)
+      end
+
       def suggest_width(pairs)
         pairs.map { |x,v| v.size }.select { |n| n < WRAP_WIDTH }.max || 10
       end