cuke-patterns 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brendan Baldwin
+
+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.markdown

@@ -0,0 +1,54 @@
+# cuke-patterns
+
+Makes cucumber step definitions more focused, understandable, searchable and awesomeable.
+
+ * Author: Brendan Baldwin <brendan@usergenic.com>
+ * Github: http://github.com/brendan/cuke-patterns
+
+## What does it do?
+
+(This gem is only relevant if you're using cucumber already.)
+
+Change your step definition files from this:
+
+    When /^(\w+) withdraws \$(\d+\(?:\.\d+)?)$/ do |name, amount|
+      customer = Bank::Customer.find_by_name(name)
+      amount = BigDecimal.new(amount)
+      Bank::Teller.withdraw_for(customer, amount)
+    end
+
+Into this:
+
+    When ":customer withdraws :dollar_amount" do |customer, amount|
+      Bank::Teller.withdraw_for(customer, amount)
+    end
+
+    Pattern :customer, /(\w+)/ do |name|
+      Bank::Customer.find_by_name(name)
+    end
+
+    Pattern :dollar_amount, /\$(\d+\(?:.\d+)?)/ do |amount|
+      BigDecimal.new(amount)
+    end
+
+Patterns are kind of like Transforms in cucumber, except Patterns are designed to be
+referenced in Step definitions by name as opposed to recognized by form automatically.
+
+To use it, just pop this in your app's support/env.rb which gets loaded by cucumber:
+
+    require 'rubygems'
+    require 'cuke-patterns'
+
+## Notes 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) 2010 Brendan Baldwin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cuke-patterns"
+    gem.summary = %Q{Makes cucumber step definitions more focused, understandable, searchable and awesomeable.}
+    gem.description = %Q{Makes cucumber step definitions more focused, understandable, searchable and awesomeable.}
+    gem.email = "brendan@usergenic.com"
+    gem.homepage = "http://github.com/brendan/cuke-patterns"
+    gem.authors = ["Brendan Baldwin"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cuke-patterns #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/cuke-patterns.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cuke-patterns}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brendan Baldwin"]
+  s.date = %q{2010-08-14}
+  s.description = %q{Makes cucumber step definitions more focused, understandable, searchable and awesomeable.}
+  s.email = %q{brendan@usergenic.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "cuke-patterns.gemspec",
+     "features/no_regressions_in_normal_cukes.feature",
+     "features/simple_cuke_patterns.feature",
+     "features/step_definitions/no_regression_steps.rb",
+     "features/step_definitions/simple_pattern_steps.rb",
+     "features/support/env.rb",
+     "lib/cuke-patterns.rb"
+  ]
+  s.homepage = %q{http://github.com/brendan/cuke-patterns}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Makes cucumber step definitions more focused, understandable, searchable and awesomeable.}
+
+  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
+    else
+    end
+  else
+  end
+end
+

data/features/no_regressions_in_normal_cukes.feature

@@ -0,0 +1,9 @@
+Feature: No regressions in normal cukes
+  In order for anyone to want to use this cuke-patterns gem
+  As a developer of cuke-patterns
+  I want to ensure this doesn't screw anything up
+
+Scenario: Simple regexp matched scenario
+  Given a typical given step
+  When a typical when step
+  Then a typical then step

data/features/simple_cuke_patterns.feature

@@ -0,0 +1,16 @@
+Feature: Simple Cuke Patterns
+
+Scenario: Transform string of digits into Fixnum
+  When @x is 1234
+  Then @x should be a Fixnum
+  And @x should evaluate to 1234
+
+Scenario: Transform digits with negative sign into Fixnum
+  When @x is -1234
+  Then @x should be a Fixnum
+  And @x should evaluate to -1234
+
+Scenario: Transform a list to an array of Fixnums
+  When @x contains 1, 2, 3 and 4
+  Then @x should be an Array
+  And @x should evaluate to [1, 2, 3, 4]

data/features/step_definitions/no_regression_steps.rb

@@ -0,0 +1,6 @@
+Given /^a typical given step$/ do
+end
+When /^a typical when step$/ do
+end
+Then /^a typical then step$/ do
+end

data/features/step_definitions/simple_pattern_steps.rb

@@ -0,0 +1,30 @@
+When "@x is :integer" do |integer|
+  @x = integer
+end
+
+When "@x contains :list_of_integers" do |list|
+  @x = list
+end
+
+Then "@x should be a :class" do |klass|
+  @x.class.should == klass
+end
+
+Then /^@x should evaluate to (.*)$/ do |expression|
+  @x.should == eval(expression)
+end
+
+Pattern 'a',  /a|an/
+Pattern 'an', /a|an/
+
+Pattern :class, /([A-Z][a-z]+)/ do |class_name|
+  Object.const_get(class_name)
+end
+
+Pattern :integer, /(-?\d+)/ do |number|
+  number.to_i
+end
+
+Pattern :list_of_integers, /(-?\d+(?: *(?:,|and) *-?\d+)*)/ do |list|
+  list.split(/ *(?:,|and) */).map{|number| number.to_i}
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.push File.expand_path(File.join(File.dirname(__FILE__),'..','..','lib'))
+
+require 'cuke-patterns'
+

data/lib/cuke-patterns.rb

@@ -0,0 +1,173 @@
+module CukePatterns
+
+  module RbDslExt
+
+    def register_rb_cuke_pattern(name, regexp, &proc)
+      @rb_language.register_rb_cuke_pattern(name, regexp, &proc)
+    end
+
+  end
+
+  # For extending the Cucumber::RbSupport::RbLanguage class
+  module RbLanguageExt
+
+    def self.included(rb_language_class)
+      rb_language_class.class_eval do
+        alias_method :register_rb_step_definition_without_cuke_patterns, :register_rb_step_definition
+        alias_method :register_rb_step_definition, :register_rb_step_definition_with_cuke_patterns
+      end
+
+      super
+    end
+
+    def apply_cuke_patterns_to_delayed_step_definition_registrations!
+      count = 0
+      cuke_pattern_delayed_step_definition_registrations.each do |matcher, proc|
+        regexp, converted_proc = convert_cuke_patterns_and_proc(matcher, proc)
+        register_rb_step_definition(regexp, converted_proc)
+        count += 1
+      end
+
+      # Clean up our mess!
+      remove_instance_variable('@cuke_pattern_delayed_step_definition_registrations')
+    end
+
+    def cuke_patterns
+      @cuke_patterns ||= {}
+    end
+
+    def register_rb_cuke_pattern(name, regexp, &conversion_proc)
+      name = ":#{name}" if name.is_a?(Symbol) # so :user becomes ':user'
+
+      if conversion_proc
+        # Count the capturing '(' characters to get the pattern arity
+        pattern_capture_count = capture_count_for(regexp)
+
+        if pattern_capture_count != conversion_proc.arity
+          raise "There are #{pattern_capture_count} of capture(s) in Pattern #{name} but block arity is #{conversion_proc.arity}"
+        end
+      end
+
+      return cuke_patterns[name] = [regexp, conversion_proc]
+    end
+
+    def register_rb_step_definition_with_cuke_patterns(matcher, proc)
+      return register_rb_step_definition_without_cuke_patterns(matcher, proc) unless matcher.is_a?(String)
+      cuke_pattern_delayed_step_definition_registrations << [matcher, proc]
+      return :registration_delayed_by_cuke_patterns
+    end
+
+    private
+
+    def capture_count_for(regexp)
+      regexp.to_s.gsub(/\\\\|\\\(|\(\?/,'').scan(/\(/).length
+    end
+
+    def convert_cuke_patterns_and_proc(matcher, proc)
+
+      matcher_regexp = "^"
+
+      pattern_counter = 0
+      capture_counter = 0
+
+      # Split the string by non-alphanumeric, underscore or leading-colon characters
+      matcher.scan(/(:?\w+)|([^:\w]+|:)/) do |candidate, non_candidate|
+
+        if non_candidate or not cuke_patterns.include?(candidate)
+          matcher_regexp << Regexp.escape(candidate || non_candidate)
+          next
+        end
+
+        regexp, conversion_proc = cuke_patterns[candidate]
+
+        pattern_capture_count = capture_count_for(regexp)
+
+        proc = convert_cuke_pattern_proc_arguments(
+          proc, conversion_proc,
+          pattern_counter, pattern_capture_count) if conversion_proc
+
+        pattern_counter += 1 unless pattern_capture_count == 0
+        capture_counter += pattern_capture_count
+
+        matcher_regexp << regexp.to_s
+
+      end
+
+      matcher_regexp << "$"
+
+      return [Regexp.new(matcher_regexp), proc]
+    end
+
+    # Returns a new Proc/block made by applying the conversion_block to a number of
+    # the arguments yielded to the original_block (arg_count) at the offset.
+    def convert_cuke_pattern_proc_arguments(original_proc, conversion_proc, offset, arg_count)
+
+      arity = original_proc.arity + arg_count - 1
+      arg_list = (1..arity).map{|n| "arg#{n}"}.join(",")
+
+      file, line = original_proc.file_colon_line.split(/:/,2)
+      line = line.to_i
+
+      new_proc = instance_eval(<<-ruby, file, line)
+        Proc.new do |#{arg_list}|
+          args = [#{arg_list}]
+          arg_range = offset..(offset + arg_count - 1)
+          converted_args = instance_exec(*args[arg_range], &conversion_proc)
+          args.slice!(arg_range)
+          args.insert(offset, converted_args)
+          instance_exec(*args, &original_proc)
+        end
+      ruby
+
+      class << new_proc; self end.module_eval do
+        define_method(:file_colon_line){ original_proc.file_colon_line }
+      end
+
+      return new_proc
+    end
+
+    def cuke_pattern_delayed_step_definition_registrations
+      @cuke_pattern_delayed_step_definition_registrations ||= []
+    end
+
+  end
+
+  # For extending the Cucumber::StepMother class
+  module StepMotherExt
+
+    def self.included(step_mother_class)
+      step_mother_class.class_eval do
+        alias_method :load_code_files_without_cuke_patterns, :load_code_files
+        alias_method :load_code_files, :load_code_files_with_cuke_patterns
+      end
+
+      super
+    end
+
+    def load_code_files_with_cuke_patterns(step_def_files)
+      result = load_code_files_without_cuke_patterns(step_def_files)
+      @programming_languages.each do |programming_language|
+        programming_language.apply_cuke_patterns_to_delayed_step_definition_registrations!
+      end
+      return result
+    end
+
+  end
+
+end
+
+Cucumber::RbSupport::RbDsl.module_eval do
+  extend CukePatterns::RbDslExt
+
+  def Pattern(name, regexp, &proc)
+    Cucumber::RbSupport::RbDsl.register_rb_cuke_pattern(name, regexp, &proc)
+  end
+end
+
+Cucumber::RbSupport::RbLanguage.class_eval do
+  include CukePatterns::RbLanguageExt
+end
+
+Cucumber::StepMother.class_eval do
+  include CukePatterns::StepMotherExt
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: cuke-patterns
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brendan Baldwin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Makes cucumber step definitions more focused, understandable, searchable and awesomeable.
+email: brendan@usergenic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- cuke-patterns.gemspec
+- features/no_regressions_in_normal_cukes.feature
+- features/simple_cuke_patterns.feature
+- features/step_definitions/no_regression_steps.rb
+- features/step_definitions/simple_pattern_steps.rb
+- features/support/env.rb
+- lib/cuke-patterns.rb
+has_rdoc: true
+homepage: http://github.com/brendan/cuke-patterns
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Makes cucumber step definitions more focused, understandable, searchable and awesomeable.
+test_files: []
+