rspec-given 1.3.1 → 1.4.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Jim Weirich
+Copyright (c) 2010, 2011 Jim Weirich
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,11 @@
 # rspec-given
 
-rspec-given is an RSpec 2 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.
+Covering rspec-given, version 1.4.0.
+
+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.
 
 # Why Given/When/Then
 

data/Rakefile

@@ -1,9 +1,9 @@
 #!/usr/bin/ruby -wKU
 
 require 'rake/clean'
+require './lib/rspec/given/version'
 
-CLOBBER.include("*.gemspec", "html")
-
+CLOBBER.include("*.gemspec", "html", "README", "README.old")
 
 # README Formatting --------------------------------------------------
 
@@ -17,8 +17,16 @@ task :default => :examples
 
 # Running examples ---------------------------------------------------
 
-desc "Run the examples"
-task :examples do
+desc "Run all the examples"
+task :examples => [:examples1, :examples2]
+
+desc "Run the examples in RSpec 1"
+task :examples1 do
+  sh "spec examples/stack/stack_spec1.rb"
+end
+
+desc "Run the examples in RSpec 2"
+task :examples2 do
   sh "rspec examples"
 end
 
@@ -40,8 +48,43 @@ task "html/README.html" => ['html', 'README.md'] do
   end
 end
 
+desc "Generate an RDoc README"
+file "README.md" => ["examples/stack/stack_spec.rb", "lib/rspec/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 =~ /version +\d+\.\d+\.\d+/
+            line.gsub!(/version +\d+\.\d+\.\d+/, "version #{RSpec::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 ---------------------------------------------------------------
-require 'rake/rdoctask'
+gem "rdoc"
+require 'rdoc/task'
 
 begin
   require 'darkfish-rdoc'
@@ -50,19 +93,57 @@ rescue LoadError => ex
   DARKFISH_ENABLED = false
 end
 
-BASE_RDOC_OPTIONS = [
-  '--line-numbers', '--inline-source',
-  '--main' , 'README.rdoc',
-  '--title', 'RSpec::Given - Given/When/Then Extensions for RSpec'
-]
+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
 
-rd = Rake::RDocTask.new("rdoc") do |rdoc|
+file "README" => ["README.md"] do
+  md_to_rdoc("README.md", "README")
+end
+
+RDoc::Task.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'html'
-#  rdoc.template = 'doc/jamis.rb'
-  rdoc.title    = "Rake -- Ruby Make"
-  rdoc.options = BASE_RDOC_OPTIONS.dup
+  rdoc.title    = "RSpec/Given -- A Given/When/Then extension for RSpec"
+  rdoc.options = [
+    '--line-numbers',
+    '--main' , 'README',
+    '--title', 'RSpec::Given - Given/When/Then Extensions for RSpec'
+  ]
   rdoc.options << '-SHN' << '-f' << 'darkfish' if DARKFISH_ENABLED
 
-  rdoc.rdoc_files.include('README.md', 'MIT-LICENSE')
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
 end
+
+task :rdoc => "README"

data/examples/stack/stack_spec.rb

@@ -3,10 +3,6 @@ require 'spec_helper'
 require 'stack'
 
 describe Stack do
-  # NOTE: Invariants are not yet supported in rspec-given
-  # Invariant { stack.depth >= 0 }
-  # Invariant { stack.empty? == (stack.depth == 0) }
-
   def stack_with(initial_contents)
     stack = Stack.new
     initial_contents.each do |item| stack.push(item) end

data/examples/stack/stack_spec1.rb

@@ -0,0 +1,3 @@
+
+$:.unshift File.dirname(__FILE__) + "/.."
+require 'stack/stack_spec'

data/lib/rspec/given.rb

@@ -1,4 +1,7 @@
-require 'rspec/given/version'
-require 'rspec/given/extensions'
-require 'rspec/given/configure'
-
+if defined? Spec
+  require 'rspec/given/rspec1_given'
+else
+  require 'rspec/given/version'
+  require 'rspec/given/extensions'
+  require 'rspec/given/configure'
+end

data/lib/rspec/given/configure.rb

@@ -4,4 +4,3 @@ RSpec.configure do |c|
   c.alias_example_to :Then
   c.extend(RSpec::Given::Extensions)
 end
-

data/lib/rspec/given/extensions.rb

@@ -2,6 +2,12 @@ module RSpec
   module Given
     module Extensions
 
+      # *DEPRECATED:*
+      #
+      # The Scenario command is deprecated.  Future versions of
+      # rspec/given will start displaying warnings when used.
+      # Eventually the command will be removed.
+      #
       # Declare a scenario to contain Given/When/Then declarations.  A
       # Scenario is essentially an RSpec context, with the additional
       # expectations:
@@ -26,7 +32,7 @@ module RSpec
       #   Given(:name, &block)
       #   Given(&block)
       #
-      def Given(*args,&block)
+      def Given(*args, &block)
         if args.first.is_a?(Symbol)
           let(args.first, &block)
         else

data/lib/rspec/given/rspec1_given.rb

@@ -0,0 +1,10 @@
+require 'rspec/given/version'
+require 'rspec/given/extensions'
+
+class Spec::ExampleGroup
+  extend RSpec::Given::Extensions
+
+  class << self
+    alias Then specify
+  end
+end

data/lib/rspec/given/version.rb

@@ -1,9 +1,10 @@
 module RSpec
   module Given
-    VERSION_MAJOR = 1
-    VERSION_MINOR = 3
-    VERSION_BUILD = 1
-    VERSION_NUMBERS = [VERSION_MAJOR, VERSION_MINOR, VERSION_BUILD]
+    VERSION_NUMBERS = [
+      VERSION_MAJOR = 1,
+      VERSION_MINOR = 4,
+      VERSION_BUILD = 0,
+    ]
     VERSION = VERSION_NUMBERS.join(".")
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-given
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 3
-  - 1
-  version: 1.3.1
+  prerelease: 
+  version: 1.4.0
 platform: ruby
 authors: 
 - Jim Weirich
@@ -14,34 +10,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-01 00:00:00 -05:00
-default_executable: 
+date: 2011-06-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ~>
+    - - ">"
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+        version: 1.2.8
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bluecloth
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.4.2
+  type: :development
+  version_requirements: *id003
 description: |
   Given is an RSpec extension that allows explicit definition of the
   pre and post-conditions for code under test.
@@ -59,13 +62,13 @@ files:
 - README.md
 - lib/rspec/given/configure.rb
 - lib/rspec/given/extensions.rb
+- lib/rspec/given/rspec1_given.rb
 - lib/rspec/given/version.rb
 - lib/rspec/given.rb
 - examples/spec_helper.rb
 - examples/stack/stack.rb
 - examples/stack/stack_spec.rb
-- examples/wrong/wrong_spec.rb
-has_rdoc: true
+- examples/stack/stack_spec1.rb
 homepage: http://github.com/jimweirich/rspec-given
 licenses: []
 
@@ -80,23 +83,21 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: given
-rubygems_version: 1.3.6
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: Given/When/Then Specification Extensions for RSpec.

data/examples/wrong/wrong_spec.rb

@@ -1,26 +0,0 @@
-require 'rspec/given'
-require 'wrong'
-
-include Wrong
-
-describe "Using Wrong" do
-  def self.Should(&block)
-    specify do
-      assert(&block)
-    end
-  end
-
-  # Scenario "trying wrong's assert" do
-  #   Given(:a) { 1 }
-  #   Given(:b) { 1 }
-  #   Then { a == b }
-  # end
-
-  context "trying wrong's assert" do
-    Given(:a) { 1 }
-    Given(:b) { 2 }
-    puts "DBG: BEFORE THEN"
-    Should { a == b }
-    puts "DBG: AFTER THEN"
-  end
-end