rspec_explain 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems #'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_explain.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alexander K
+
+MIT License
+
+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.md

@@ -0,0 +1,54 @@
+# RSpecExplain
+
+The idea was to write something like scenario outlines in cucumber but without semicolons or vertical bars or other syntax trash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec_explain'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_explain
+
+## Usage
+
+    describe 'Usage' do
+      subject { Usage.new }
+             
+      explain :square, %w[
+        2   4
+        10  100
+        25  625
+        30  900
+      ].map(&:to_i)
+            
+      explain :no_spaces, <<-EX
+        one string  => one_string
+        a b c       => a_b_c
+        a_b c_d     => a_b_c_d
+      EX 
+            
+    end
+
+### output:
+
+    Usage
+      #square
+        2 => 4
+        10 => 100
+        ...
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/rspec_explain.rb

@@ -0,0 +1,5 @@
+require "rspec_explain/version"
+
+module RspecExplain
+  # Your code goes here...
+end

data/lib/rspec_explain/explain.rb

@@ -0,0 +1,37 @@
+module RSpecExplain
+  def explain method, examples, run='subject.%s(%s)'
+
+    examples = prepare examples
+
+    context "##{method}" do
+      examples.each do |input,output|
+        specify "#{input} => #{output}" do
+          eval(run % [method, input.inspect]).should == output #subject.send(:method, input)
+        end
+      end
+    end
+
+  end
+
+  private
+  def prepare table
+    case table
+    when Array then table.map { |x| prepare_one x }.each_slice(2)
+    when String then prepare table.lines.map { |line| line.split '=>' }.flatten
+    else
+      raise
+    end
+  end
+
+  COMMAND = %r"^`(.*)`$"
+  def prepare_one element
+    
+    element = element.strip if element.is_a? String
+
+    case element
+    when COMMAND then eval(element[COMMAND,1])
+    else
+      element
+    end      
+  end
+end

data/lib/rspec_explain/version.rb

@@ -0,0 +1,5 @@
+module RSpecExplain
+  VERSION = "0.0.1"
+end
+
+require_relative 'explain'

data/rspec_explain.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_explain/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rspec_explain"
+  gem.version       = RSpecExplain::VERSION
+  gem.authors       = ["Alexander K"]
+  gem.email         = ["xpyro@ya.ru"]
+  
+  gem.description   = <<-DESC
+    I'd like to write simple methods with simple specs
+    so this gem gonna be easy to use
+    with syntactic sugar to simplify the addition of examples
+    but not so much configurable to shape a way you write methods
+  DESC
+
+  gem.summary       = %q[helpers to describe methods by concise input/output tables]
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_development_dependency "rspec", "~> 2.0"
+end

data/spec/explain_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+class Usage
+  include RSpecExplain
+
+
+#####################
+#  Methods we test  #
+#####################
+
+  def square x
+    x**2
+  end
+
+  def no_spaces x
+    x.gsub(' ','_')
+  end  
+
+  DROP_LAST = [%r|^(.*/)[^/]+/$|, 1]
+
+  def level_up x
+    x[*DROP_LAST]
+  end 
+
+  def equal x
+    x
+  end 
+
+
+##############
+#  Examples  #
+##############
+
+  def usage_1
+    explain :square, [2,4,  3,9,  5,25,  10,100]  # 4 examples
+  end
+
+  def usage_2
+    explain :square, %w[
+      2 4
+      3 9
+      5 25
+      6 36
+      7 49
+    ].map(&:to_i)
+  end
+
+  def usage_3
+    explain :no_spaces, <<-EX
+      one string  => one_string
+      a b c       => a_b_c
+      a_b c_d     => a_b_c_d
+    EX
+  end  
+
+  def usage_4
+    explain :level_up, <<-EX
+      /x/y/z/ => /x/y/
+      /x/y/   => /x/
+      /one/   => /
+      /       => `nil`
+    EX
+  end
+
+  def usage_5
+    explain :equal, <<-EX
+      `2*2` => `2+2`
+      `3*2` => `2*3`
+      `1*1` => `1**1`
+    EX
+  end  
+
+  def usage_6
+    explain :equal, <<-EX.split(/$|=>/).map { |x| '`%s`' % x.strip }
+      2*2 => 2+2
+      3*2 => 2*3
+      1*1 => 1**1
+    EX
+  end    
+
+  def should_be_red
+   explain :equal, <<-EX
+      2*2 => `2*2`
+    EX
+  end
+
+  private
+  def context method
+    yield
+  end
+
+  def specify method
+    yield
+  end
+
+  def subject  # dont forget to set subject in your specs! #
+    self                                                   #
+  end                                                      #
+end                                                        #
+                                                           #
+describe RSpecExplain do                                   #
+  subject { Usage.new }           # like this!          <= #
+
+  context '.explain' do
+
+    it 'creates context block for given method' do
+      subject.should_receive(:context).with('#square').once
+      subject.usage_1
+    end
+
+    it 'specifies each example inside context block' do
+      subject.should_receive(:specify).exactly(4).times
+      subject.usage_1
+    end
+
+    it 'invokes subject inside specify block' do
+      subject.should_receive(:subject).exactly(4).times { subject }
+      subject.usage_1
+    end    
+
+    it 'invokes :method on subject' do
+      subject.should_receive(:square).exactly(4).times { |x| x**2 }
+      subject.usage_1
+    end
+
+    # specify 'someday I will test .should==output part' do
+    #   pending
+    # end
+
+
+    context 'obvious testing' do
+
+      it 'good examples should pass' do
+        subject.methods.grep(/usage_\d/).size.should be >= 4
+        subject.methods.grep(/usage_\d/).each { |method| subject.send method }
+      end
+
+      it 'bad examples should not pass' do
+        expect { subject.should_be_red }.to raise_error
+      end
+
+    end
+
+    context 'the most obvious usage example:' do
+      extend RSpecExplain
+
+      describe 'Usage' do
+        subject { Usage.new }         
+
+        explain :square, %w[
+          2   4
+          10  100
+          25  625
+          30  900
+        ].map(&:to_i)
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "bundler"
+Bundler.require :default, :development
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rspec_explain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander K
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ! "    I'd like to write simple methods with simple specs\n    so this
+  gem gonna be easy to use\n    with syntactic sugar to simplify the addition of examples\n
+  \   but not so much configurable to shape a way you write methods\n"
+email:
+- xpyro@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_explain.rb
+- lib/rspec_explain/explain.rb
+- lib/rspec_explain/version.rb
+- rspec_explain.gemspec
+- spec/explain_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: helpers to describe methods by concise input/output tables
+test_files:
+- spec/explain_spec.rb
+- spec/spec_helper.rb
+has_rdoc: