specify 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbce3e763bb587ca4e22697758df1193f0c5390b
-  data.tar.gz: bacc2a768947097371695d3cd5f7917ddb80fe2c
+  metadata.gz: 2176feee363e08774e5723e4eb96372ca4b7810b
+  data.tar.gz: b8461df286c06c232b85621f8a3b7f65d83efdc7
 SHA512:
-  metadata.gz: 519d2f32a0c395e75ab89c7b0afa047c568e144abd664d2bb995890236eca9c99a2fe40e6907f46a208239d48b88bb87adcc6302e21fd36bf09630da9096c971
-  data.tar.gz: a3de2b83e891d4c9a89f4d7e6082bf5097ec48be037b332a8463ead16238bdba3fb154585cf380bb384e67e7f780c98d5ed01de8ba3551ed866e5a8d51bab38f
+  metadata.gz: d78f06c2164d721397075a8f903c857ae83afdbe73d36891406ea1704abdb93053a8105ada7c9d3e8f0a287fea8e3e33bfbe7720cc4e04cbec5a2bcdd023a6a0
+  data.tar.gz: f0c3a121504a3708fabc43ba124598bea8a7995c8328c3b4ece93acf4b87d8425dd1c4fd01adebf1b423e53476ea1c049fff180f5718d28d57e14ffd2896154b

data/README.md

@@ -11,7 +11,7 @@
 [![endorse](https://api.coderwall.com/jnyman/endorsecount.png)](https://coderwall.com/jnyman)
 
 > _"Simplicity is the ultimate sophistication."_
-> -- <cite>Leonardo DaVinci</cite>
+> -- <cite>Leonardo da Vinci</cite>
 
 Specify is a test solution development tool that acts as a BDD-style micro-framework.
 
@@ -72,3 +72,14 @@ To work on Specify:
 ## License
 
 Specify is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+
+## Credits
+
+Specify has been inspired by the following projects:
+
+* [maniok_bdd](https://github.com/21croissants/maniok_bdd)
+* [rspec-gherkin](https://github.com/sheerun/rspec-gherkin)
+* [rspec example steps](https://github.com/railsware/rspec-example_steps)
+* [XSpec](https://github.com/xaviershay/xspec)
+
+The parameterized and table logic is pulled directly from [RSpec::Parameterized](https://github.com/tomykaira/rspec-parameterized) with just a few cosmetic changes.

data/lib/specify/rspec/parameterized.rb

@@ -0,0 +1,138 @@
+require 'parser'
+require 'unparser'
+require 'proc_to_ast'
+
+module RSpec
+  module Specify
+    module Parameterized
+      autoload :Tabular, 'specify/rspec/tabular'
+
+      module ExampleGroupMethods
+        class Parameter
+          attr_reader :arg_names, :table_format, :block
+
+          def initialize(arg_names, table_format, &block)
+            @arg_names, @table_format, @block = arg_names, table_format, block
+          end
+        end
+
+        def data_condition(*args, &block)
+          set_parameters(args, false, &block)
+        end
+
+        def data_table(*args, &block)
+          set_parameters(args, true, &block)
+        end
+
+        def test_condition(*args, &block)
+          if @parameter.nil?
+            @parameterized_pending_cases ||= []
+            @parameterized_pending_cases << [args, block]
+          else
+            define_cases(@parameter, *args, &block)
+          end
+        end
+
+        alias_method :where,       :data_condition
+        alias_method :where_table, :data_table
+        alias_method :with_those,  :test_condition
+
+        private
+
+        def set_parameters(arg_names, table_format, &block)
+          @parameter = Parameter.new(arg_names, table_format, &block)
+
+          if @parameterized_pending_cases
+            @parameterized_pending_cases.each { |e|
+              define_cases(@parameter, *e[0], &e[1])
+            }
+          end
+        end
+
+        def separate_table_like_block(b)
+          ast = b.to_ast
+          inner_ast = ast.children[2]
+          if inner_ast.type == :send
+            lines = [inner_ast]
+          else
+            lines = inner_ast.children
+          end
+
+          lines.map do |node|
+            if node.type == :send
+              buf = []
+              extract_value(node, buf)
+              buf.reverse
+            end
+          end
+        end
+
+        def extract_value(node, buf)
+          receiver, method, arg = node.children
+
+          if method == :|
+            buf << eval_source_fragment(Unparser.unparse(arg))
+          end
+
+          if receiver.is_a?(AST::Node) && receiver.type == :send && receiver.children[1] == :|
+            extract_value(receiver, buf)
+          else
+            buf << eval_source_fragment(Unparser.unparse(receiver))
+          end
+        end
+
+        def eval_source_fragment(source_fragment)
+          instance = new  # for evaluate let methods.
+          if defined?(self.superclass::LetDefinitions)
+            instance.extend self.superclass::LetDefinitions
+          end
+          instance.instance_eval(source_fragment)
+        end
+
+        def define_cases(parameter, *args, &block)
+          instance = new  # for evaluate let methods
+          if defined?(self.superclass::LetDefinitions)
+            instance.extend self.superclass::LetDefinitions
+          end
+
+          if parameter.table_format
+            param_sets = separate_table_like_block(parameter.block)
+          else
+            extracted = instance.instance_eval(&parameter.block)
+            param_sets = extracted.is_a?(Array) ? extracted : extracted.to_params
+          end
+
+          # for only one parameter
+          param_sets = param_sets.map { |x| Array[x] } if !param_sets[0].is_a?(Array)
+
+          param_sets.each do |params|
+            pairs = [parameter.arg_names, params].transpose
+            pretty_params = pairs.map {|t| "#{t[0]}: #{params_inspect(t[1])}"}.join(', ')
+            describe(pretty_params, *args) do
+              pairs.each do |n|
+                let(n[0]) { n[1] }
+              end
+
+              module_eval(&block)
+            end
+          end
+        end
+
+        def params_inspect(obj)
+          begin
+            obj.is_a?(Proc) ? obj.to_raw_source : obj.inspect
+          #rescue Parser::SyntaxError
+          #  return obj.inspect
+          end
+        end
+
+      end
+    end
+  end
+
+  module Core
+    class ExampleGroup
+      extend ::RSpec::Specify::Parameterized::ExampleGroupMethods
+    end
+  end
+end

data/lib/specify/rspec/table.rb

@@ -0,0 +1,54 @@
+module RSpec
+  module Specify
+    module Parameterized
+      class Table
+        attr_reader :last_row
+
+        def initialize
+          @rows = []
+          @last_row = nil
+        end
+
+        def add_row(row)
+          unless @rows.find {|r| r.object_id == row.object_id}
+            @rows << row
+            @last_row = row
+          end
+          self
+        end
+
+        def add_param_to_last_row(param)
+          last_row.add_param(param)
+          self
+        end
+
+        alias :| :add_param_to_last_row
+
+        def to_a
+          @rows.map(&:to_a)
+        end
+
+        alias :to_params :to_a
+
+        class Row
+          def initialize(param)
+            @params = [param]
+          end
+
+          def add_param(param)
+            @params << param
+          end
+
+          def to_a
+            @params
+          end
+
+          #def to_params
+          #  [@params]
+          #end
+        end
+
+      end
+    end
+  end
+end

data/lib/specify/rspec/tabular.rb

@@ -0,0 +1,45 @@
+require 'binding_of_caller'
+require 'specify/rspec/table'
+
+module RSpec
+  module Specify
+    module Parameterized
+      module TabularSyntax
+        def |(other)
+          where_binding = binding.of_caller(1)          # get where block binding
+          caller_instance = eval('self', where_binding) # get caller instance (ExampleGroup)
+
+          if caller_instance.instance_variable_defined?(:@__parameter_table)
+            table = caller_instance.instance_variable_get(:@__parameter_table)
+          else
+            table = RSpec::Specify::Parameterized::Table.new
+            caller_instance.instance_variable_set(:@__parameter_table, table)
+          end
+
+          row = Table::Row.new(self)
+          table.add_row(row)
+          row.add_param(other)
+          table
+        end
+      end
+
+      module Tabular
+        refine Object do
+          include TabularSyntax
+        end
+
+        refine Fixnum do
+          include TabularSyntax
+        end
+
+        refine Bignum do
+          include TabularSyntax
+        end
+
+        refine Array do
+          include TabularSyntax
+        end
+      end
+    end
+  end
+end

data/lib/specify/version.rb

@@ -1,3 +1,3 @@
 module Specify
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/lib/specify.rb

@@ -12,6 +12,7 @@ require 'specify/rspec/world'
 require 'specify/rspec/reporter'
 require 'specify/rspec/notification'
 require 'specify/rspec/example_group'
+require 'specify/rspec/parameterized'
 require 'specify/rspec/documentation_formatter'
 
 RSpec::Core::ExampleGroup.send :include, RSpec::Specify::ExampleGroup

data/spec/parameterized_spec.rb

@@ -0,0 +1,229 @@
+require 'spec_helper'
+
+describe RSpec::Specify::Parameterized do
+  describe 'data_condition' do
+    data_condition(:a, :b, :answer) do
+      [
+          [1, 2, 3],
+          [5, 8, 13],
+          [0, 0, 0]
+      ]
+    end
+
+    test_condition do
+      it 'will perform additions' do
+        expect(a + b).to eq answer
+      end
+    end
+  end
+
+  describe 'lambda parameter' do
+    data_condition(:a, :b, :answer) do
+      [
+          [1 , 2 , -> {should == 3}],
+          [5 , 8 , -> {should == 13}],
+          [0 , 0 , -> {should == 0}]
+      ]
+    end
+
+    test_condition do
+      subject {a + b}
+      it 'will perform additions' do
+        self.instance_exec(&answer)
+      end
+    end
+  end
+
+  describe 'table separated with pipe' do
+    data_table(:a, :b, :answer) do
+      1         | 2         | 3
+      'hello '  | 'world'   | 'hello world'
+      [1, 2, 3] | [4, 5, 6] | [1, 2, 3, 4, 5, 6]
+    end
+
+    test_condition do
+      it 'will calculate that a plus b is answer' do
+        expect(a + b).to eq answer
+      end
+    end
+  end
+
+  describe 'table separated with pipe (using Tabular syntax)' do
+    using RSpec::Specify::Parameterized::Tabular
+
+    data_condition(:a, :b, :answer) do
+      1         | 2         | 3
+      'hello '  | 'world'   | 'hello world'
+      [1, 2, 3] | [4, 5, 6] | [1, 2, 3, 4, 5, 6]
+    end
+
+    test_condition do
+      it 'will calculate that a plus b is answer' do
+        expect(a + b).to eq answer
+      end
+    end
+  end
+
+  describe 'table separated with pipe and lambda parameter (using Tabular syntax)' do
+    using RSpec::Specify::Parameterized::Tabular
+
+    data_condition(:a, :b, :matcher) do
+      1         | 2         | -> { eq(3) }
+      'hello '  | 'world'   | -> { eq('hello world') }
+      [1, 2, 3] | [4, 5, 6] | -> { be_a(Array) }
+    end
+
+    test_condition do
+      it 'will calculate that a plus b is answer' do
+        expect(a + b).to instance_exec(&matcher)
+      end
+    end
+  end
+
+  context 'when the data_condition block is after test_condition' do
+    test_condition do
+      it 'will perform additions' do
+        expect(a + b).to eq answer
+      end
+    end
+
+    test_condition do
+      subject { a }
+      it { should be_a Numeric }
+    end
+
+    data_condition(:a, :b, :answer) do
+      [
+          [1 , 2 , 3],
+          [5 , 8 , 13],
+          [0 , 0 , 0]
+      ]
+    end
+  end
+
+  context 'when the data_condition block is between test_condition blocks' do
+    test_condition do
+      it 'should perform additions' do
+        expect(a + b).to eq answer
+      end
+    end
+
+    data_condition(:a, :b, :answer) do
+      [
+          [1 , 2 , 3],
+          [5 , 8 , 13],
+          [0 , 0 , 0]
+      ]
+    end
+
+    test_condition do
+      subject { a }
+      it { should be_a Numeric }
+    end
+  end
+
+  context 'when the data_condition has only one parameter to be set' do
+    data_condition(:x) do
+      [1, 2, 3]
+    end
+
+    test_condition do
+      it 'can take an array of elements' do
+        expect(x).to eq x
+      end
+    end
+  end
+
+  context 'when the table has only a row' do
+    data_table(:a, :b, :answer) do
+      1         | 2         | 3
+    end
+
+    test_condition do
+      it 'will calculate that a plus b is answer' do
+        expect(a + b).to eq answer
+      end
+    end
+  end
+
+  context 'when the table has only a row (using Tabular format)' do
+    using RSpec::Specify::Parameterized::Tabular
+
+    data_condition(:a, :b, :answer) do
+      1         | 2         | 3
+    end
+
+    test_condition do
+      it 'will calculate that a plus b is answer' do
+        expect(a + b).to eq answer
+      end
+    end
+  end
+
+  context 'when the data_condition has let variables, defined by parent example group' do
+    describe 'parent (define let)' do
+      let(:five) { 5 }
+      let(:eight) { 8 }
+
+      describe 'child 1' do
+        data_condition(:a, :b, :answer) do
+          [
+              [1 , 2 , 3],
+              [five , eight , 13],
+          ]
+        end
+
+        test_condition do
+          it 'will calculate that a plus b is answer' do
+            expect(a + b).to eq answer
+          end
+        end
+      end
+
+      describe 'child 2 (data_table)' do
+        data_table(:a, :b, :answer) do
+          1         | 2         | 3
+          five      | eight     | 13
+        end
+
+        test_condition do
+          it 'will calculate that a plus b is answer' do
+            expect(a + b).to eq answer
+          end
+        end
+      end
+
+      describe 'child 3 (Using Tabular)' do
+        using RSpec::Specify::Parameterized::Tabular
+
+        data_condition(:a, :b, :answer) do
+          1         | 2         | 3
+          five      | eight     | 13
+        end
+
+        test_condition do
+          it 'will calculate that a plus b is answer' do
+            expect(a + b).to eq answer
+          end
+        end
+      end
+
+      let(:eq_matcher) { eq(13) }
+      describe 'child 3 (use matcher)' do
+        data_condition(:a, :b, :matcher) do
+          [
+              [1    , 2     , eq(3) ],
+              [five , eight , eq_matcher],
+          ]
+        end
+
+        test_condition do
+          it 'will calculate that a plus b is answer' do
+            expect(a + b).to matcher
+          end
+        end
+      end
+    end
+  end
+
+end

data/specify.gemspec

@@ -31,6 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
 
   spec.add_runtime_dependency 'rspec-core', '~> 3.1'
+  spec.add_runtime_dependency 'parser'
+  spec.add_runtime_dependency 'unparser'
+  spec.add_runtime_dependency 'proc_to_ast'
+  spec.add_runtime_dependency 'binding_of_caller'
 
   spec.post_install_message = %{
 (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specify
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: proc_to_ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "\n    Specify is a test framework that is designed to treat testing
   as a\n    design activity by allowing requirements to be defined as tests.\n    Those
   tests can then be executed via an automation layer. This is\n    the basis of creating
@@ -85,12 +141,16 @@ files:
 - lib/specify/rspec/documentation_formatter.rb
 - lib/specify/rspec/example_group.rb
 - lib/specify/rspec/notification.rb
+- lib/specify/rspec/parameterized.rb
 - lib/specify/rspec/reporter.rb
 - lib/specify/rspec/shared_steps.rb
+- lib/specify/rspec/table.rb
+- lib/specify/rspec/tabular.rb
 - lib/specify/rspec/world.rb
 - lib/specify/spec.rb
 - lib/specify/version.rb
 - spec/api_spec.rb
+- spec/parameterized_spec.rb
 - spec/pending_spec.rb
 - spec/shared_steps_spec.rb
 - spec/spec_helper.rb
@@ -102,8 +162,8 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n
-  \ Specify 0.9.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
-  (::) (::) (::)\n  "
+  \ Specify 0.10.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -125,6 +185,7 @@ specification_version: 4
 summary: Description Language Specification and Execution Engine
 test_files:
 - spec/api_spec.rb
+- spec/parameterized_spec.rb
 - spec/pending_spec.rb
 - spec/shared_steps_spec.rb
 - spec/spec_helper.rb