rspec_outlines 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/DESCRIPTION.txt

@@ -0,0 +1,12 @@
+Cucumber outlines for RSpec!
+
+    describe "Adding two numbers" do
+      outline "should return the sum" do
+        (a + b).should == c
+      end
+
+      fields :a, :b, :c
+      values  1,  1,  2
+      values  2,  3,  5
+      values  1, -1,  0
+    end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 George Ogata
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.rdoc

@@ -0,0 +1,18 @@
+= rspec_outlines
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 George Ogata. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+ROOT = File.dirname(__FILE__)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rspec_outlines"
+    gem.summary = "Define specs in tables."
+    gem.description = File.read("#{ROOT}/DESCRIPTION.txt")
+    gem.email = "george.ogata@gmail.com"
+    gem.homepage = "http://github.com/oggy/rspec_outlines"
+    gem.authors = ["George Ogata"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "mocha"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', "#{ROOT}/spec/spec.opts"]
+end
+
+Spec::Rake::SpecTask.new(:spec_integration) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec_integration/integration_spec.rb']
+  spec.spec_opts = ['--options', "#{ROOT}/spec_integration/spec.opts"]
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rspec_outlines #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/rspec_outlines.rb

@@ -0,0 +1,12 @@
+module RSpecOutlines
+end
+
+require 'rspec_outlines/error'
+require 'rspec_outlines/example_group'
+require 'rspec_outlines/example_methods'
+require 'rspec_outlines/example_proxy'
+require 'rspec_outlines/outline'
+
+Spec::Example::ExampleGroup.send :extend, RSpecOutlines::ExampleGroup
+Spec::Example::ExampleGroup.send :include, RSpecOutlines::ExampleMethods
+Spec::Example::ExampleProxy.send :include, RSpecOutlines::ExampleProxy

data/lib/rspec_outlines/error.rb

@@ -0,0 +1,3 @@
+module RSpecOutlines
+  Error = Class.new(RuntimeError)
+end

data/lib/rspec_outlines/example_group.rb

@@ -0,0 +1,28 @@
+module RSpecOutlines
+  module ExampleGroup
+    def outline(name, &definition)
+      @current_outline = Outline.new(self, name, &definition)
+    end
+
+    def current_outline
+      @current_outline ||= nil
+    end
+
+    def fields(*names)
+      need_outline
+      current_outline.fields = names.map{|name| name.to_sym}
+    end
+
+    def values(*args)
+      need_outline
+      current_outline.instantiate(*args)
+    end
+
+    private  # -------------------------------------------------------
+
+    def need_outline
+       current_outline or
+        raise Error, "no outline defined"
+    end
+  end
+end

data/lib/rspec_outlines/example_methods.rb

@@ -0,0 +1,19 @@
+module RSpecOutlines
+  module ExampleMethods
+    def method_missing(name, *args)
+      if is_outline_field_name?(name) && args.empty?
+        lookup_outline_field_name(name)
+      else
+        super
+      end
+    end
+
+    def is_outline_field_name?(name)
+      @_proxy.outline_values && @_proxy.outline_values.key?(name)
+    end
+
+    def lookup_outline_field_name(name)
+      @_proxy.outline_values[name]
+    end
+  end
+end

data/lib/rspec_outlines/example_proxy.rb

@@ -0,0 +1,5 @@
+module RSpecOutlines
+  module ExampleProxy
+    attr_accessor :outline_values
+  end
+end

data/lib/rspec_outlines/outline.rb

@@ -0,0 +1,23 @@
+module RSpecOutlines
+  class Outline
+    def initialize(example_group, name, &definition)
+      @example_group = example_group
+      @name = name
+      @definition = definition
+      @fields = nil
+      @number_of_examples = 0
+    end
+
+    attr_reader :name
+    attr_accessor :fields
+
+    def instantiate(*values)
+      fields or
+        raise Error, "no fields defined"
+      fields.length == values.length or
+        raise ArgumentError, "wrong number of values (#{fields.length} fields, #{values.length} values)"
+      example = @example_group.example("#{name} - #{@number_of_examples += 1}", &@definition)
+      example.outline_values = Hash[*fields.zip(values).flatten]
+    end
+  end
+end

data/rspec_outlines.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rspec_outlines}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["George Ogata"]
+  s.date = %q{2009-11-14}
+  s.description = %q{Cucumber outlines for RSpec!
+
+    describe "Adding two numbers" do
+      outline "should return the sum" do
+        (a + b).should == c
+      end
+
+      fields :a, :b, :c
+      values  1,  1,  2
+      values  2,  3,  5
+      values  1, -1,  0
+    end
+}
+  s.email = %q{george.ogata@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "DESCRIPTION.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rspec_outlines.rb",
+     "lib/rspec_outlines/error.rb",
+     "lib/rspec_outlines/example_group.rb",
+     "lib/rspec_outlines/example_methods.rb",
+     "lib/rspec_outlines/example_proxy.rb",
+     "lib/rspec_outlines/outline.rb",
+     "rspec_outlines.gemspec",
+     "spec/example_group_spec.rb",
+     "spec/example_methods_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec_integration/integration_spec.rb",
+     "spec_integration/spec.opts",
+     "spec_integration/spec_files/should_not_affect_normal_specs.rb",
+     "spec_integration/spec_files/should_run_the_outline_for_each_set_of_values_given.rb"
+  ]
+  s.homepage = %q{http://github.com/oggy/rspec_outlines}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Define specs in tables.}
+  s.test_files = [
+    "spec/example_group_spec.rb",
+     "spec/example_methods_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/spec/example_group_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe RSpecOutlines::ExampleGroup do
+  before do
+    @example_group = Class.new(Spec::Example::ExampleGroup)
+  end
+
+  describe "#outline" do
+    it "should set the current outline to a new outline with the given name" do
+      @example_group.outline("name of outline")
+      @example_group.current_outline.should be_a(Outline)
+      @example_group.current_outline.name.should == "name of outline"
+    end
+  end
+
+  describe "#fields" do
+    describe "when no outline has been defined" do
+      it "should raise an Error" do
+        lambda{@example_group.fields}.should raise_error(Error)
+      end
+    end
+
+    describe "when an outline has been defined" do
+      before do
+        @outline = Outline.new(@example_group, "name of outline")
+        @example_group.stubs(:current_outline).returns(@outline)
+      end
+
+      it "should set the fields of the last outline" do
+        @example_group.fields(:a, :b)
+        @outline.fields.should == [:a, :b]
+      end
+
+      it "should symbolize the given field names" do
+        @example_group.fields('a', 'b')
+        @outline.fields.should == [:a, :b]
+      end
+    end
+  end
+
+  describe "#values" do
+    describe "when there is no current outline" do
+      it "should raise an Error" do
+        lambda{@example_group.values(1, 2)}.should raise_error(Error)
+      end
+    end
+
+    describe "when the current outline has no fields defined" do
+      before do
+        @outline = Outline.new(@example_group, "name of outline")
+        @example_group.stubs(:current_outline).returns(@outline)
+      end
+
+      it "should raise an Error" do
+        lambda{@example_group.values(1, 2)}.should raise_error(Error)
+      end
+    end
+
+    describe "when there is a current outline with fields defined" do
+      before do
+        @outline = Outline.new(@example_group, "name of outline"){}
+        @outline.stubs(:fields).returns([:field_one, :field_two])
+        @example_group.stubs(:current_outline).returns(@outline)
+      end
+
+      it "should define an example based on the last outline" do
+        lambda{@example_group.values(1, 2)}.should change{@example_group.number_of_examples}.by(1)
+      end
+
+      it "should bind the given values to the example" do
+        @example_group.values(1, 2)
+        @example_group.example_proxies.last.outline_values.should == {:field_one => 1, :field_two => 2}
+      end
+
+      it "should raise an ArgumentError if the number of arguments is different to the number of fields" do
+        lambda{@example_group.values(1)}.should raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/example_methods_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe ExampleMethods do
+  describe "#execute" do
+    before do
+      @example_group = Class.new(Spec::Example::ExampleGroup)
+      @run_options = Spec::Runner::Options.new(StringIO.new, StringIO.new)
+      @run_options.reporter.example_group_started(@example_group)
+    end
+
+    describe "when outline values are present" do
+      before do
+        @proxy = Spec::Example::ExampleProxy.new("description")
+        @proxy.outline_values = {:x => 5}
+      end
+
+      it "should give the implementation access to the outline values" do
+        value = nil
+        example_group_instance = @example_group.new(@proxy) do
+          value = x
+        end
+        example_group_instance.execute(@run_options, {}).should be_true
+        value.should == 5
+      end
+    end
+
+    describe "when outline values are not present" do
+      before do
+        @proxy = Spec::Example::ExampleProxy.new("description")
+      end
+
+      it "should give the implementation access to the outline values" do
+        error = nil
+        example_group_instance = @example_group.new(@proxy) do
+          begin
+            x
+          rescue NameError => error
+          end
+        end
+        example_group_instance.execute(@run_options, {}).should be_true
+        error.should_not be_nil
+        error.message.should include("`x'")
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--debugger
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+ROOT = File.dirname(File.dirname(__FILE__))
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec_outlines'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+# So we don't have to qualify all our classes.
+include RSpecOutlines

data/spec_integration/integration_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'rbconfig'
+
+SPEC_FILE_DIRECTORY = "#{ROOT}/spec_integration/spec_files"
+
+describe "RSpec Outlines" do
+  def spec
+    suffix = Config::CONFIG['ruby_install_name'].sub(/\Aruby/, '')
+    basename = "spec#{suffix}"
+    ENV['PATH'].split(/:/).each do |dirname|
+      path = File.join(dirname, basename)
+      return path if File.file?(path) && File.executable?(path)
+    end
+  end
+
+  def run_spec_file(path)
+    original_rubylib = ENV['RUBYLIB']
+    ENV['RUBYLIB'] = "#{ROOT}/lib"
+    begin
+      output = `#{spec} "#{path}" 2>&1`
+      output[/.*/]
+    ensure
+      ENV['RUBYLIB'] = original_rubylib
+    end
+  end
+
+  Dir["#{SPEC_FILE_DIRECTORY}/*.rb"].each do |path|
+    name = File.basename(path).sub(/_spec\.rb\z/, '').gsub(/_/, ' ')
+    expected = File.read(path).match(/\A# expect: (.*)/)[1]
+    it(name){run_spec_file(path).should == expected}
+  end
+end

data/spec_integration/spec.opts

@@ -0,0 +1,3 @@
+--debugger
+--color
+--diff

data/spec_integration/spec_files/should_not_affect_normal_specs.rb

@@ -0,0 +1,11 @@
+# expect: .F
+
+describe "A matcher implemented by method_missing" do
+  it "should work properly in the passing case" do
+    [].should be_empty
+  end
+
+  it "should work properly in the failing case" do
+    [1].should be_empty
+  end
+end

data/spec_integration/spec_files/should_run_the_outline_for_each_set_of_values_given.rb

@@ -0,0 +1,13 @@
+# expect: ..F
+
+require 'rspec_outlines'
+
+describe "Adding two numbers" do
+  outline "should return the sum" do
+    (a + b).should == c
+  end
+  fields :a, :b, :c
+  values  1,  1,  2
+  values -1, -2, -3
+  values  1,  2, 10
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_outlines
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- George Ogata
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  Cucumber outlines for RSpec!
+  
+      describe "Adding two numbers" do
+        outline "should return the sum" do
+          (a + b).should == c
+        end
+  
+        fields :a, :b, :c
+        values  1,  1,  2
+        values  2,  3,  5
+        values  1, -1,  0
+      end
+
+email: george.ogata@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- DESCRIPTION.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rspec_outlines.rb
+- lib/rspec_outlines/error.rb
+- lib/rspec_outlines/example_group.rb
+- lib/rspec_outlines/example_methods.rb
+- lib/rspec_outlines/example_proxy.rb
+- lib/rspec_outlines/outline.rb
+- rspec_outlines.gemspec
+- spec/example_group_spec.rb
+- spec/example_methods_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec_integration/integration_spec.rb
+- spec_integration/spec.opts
+- spec_integration/spec_files/should_not_affect_normal_specs.rb
+- spec_integration/spec_files/should_run_the_outline_for_each_set_of_values_given.rb
+has_rdoc: true
+homepage: http://github.com/oggy/rspec_outlines
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Define specs in tables.
+test_files: 
+- spec/example_group_spec.rb
+- spec/example_methods_spec.rb
+- spec/spec_helper.rb