crb 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [maiha@wota.jp]
+
+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

@@ -0,0 +1,117 @@
+crb
+===
+
+  An irb console for cucumber world
+
+
+Features
+========
+
+  * Can define steps interactively
+  * Can execute steps interactively like debugger
+  * Can share cuke world and irb context in a same object
+  * Can see instance variables of step files via irb
+  * Supported hooks (but only before/after without parameters)
+
+
+Usage
+=====
+
+  Use 'crb' command as same as 'cucumber' command
+  % crb (... cucumber options ...)
+
+  And then you are in cucumber world via irb
+
+
+Example
+=======
+
+  % cd examples/i18n/en
+  % crb
+  irb(CRB:3):001:0>
+         ^^^ This means a number of defined steps.
+
+  irb(CRB:3):001:0> Given "I have entered 3"
+  Undefined step: "I have entered 3"
+  => #<Cucumber::Undefined: Undefined step: "I have entered 3">
+
+  irb(CRB:3):002:0> Given "I have entered 3 into the calculator"
+  => [3]
+
+  irb(CRB:3):003:0> Given "I have entered 5 into the calculator"
+  => [3, 5]
+
+  irb(CRB:3):004:0> Then "I press add"
+  => 8
+
+  irb(CRB:3):005:0> @calc
+  => #<Calculator:0x7faa0a3e5218 @args=[3, 5]>
+
+
+I18N
+====
+
+  I18N keywords are also available.
+
+  % cd examples/i18n/ja
+  % crb
+  irb(CRB:3):001:0> 前提 "3 を入力"
+  => [3]
+  irb(CRB:3):002:0> @calc
+  => #<Calculator:0x7ff45ecdbc70 @args=[3]>
+
+
+Custom
+======
+
+  % mkdir my-project
+  % crb my-project
+  irb(CRB:0):001:0> Given "ab"
+  Undefined step: "ab"
+  => #<Cucumber::Undefined: Undefined step: "ab">
+  irb(CRB:0):002:0> Given(/^(..)$/){|i| p "Two chars for you! #{i}"}
+  => "/^(..)$/ is defined"
+  irb(CRB:1):003:0> Given "ab"
+  "Two chars for you! ab"
+
+
+World Methods
+=============
+
+  Above crb(irb) context is a same object with cuke's world.
+  And there are following additional methods.
+
+    * before : execute before hooks. returns message (String)
+    * after  : execute after  hooks. returns message (String)
+    * steps  : returns step definitions (Array[RbStepDefinition])
+    * runtime: returns runtime object (CRB::Runtime)
+    * hooks  : returns hooks (Hash[type=>Array[RbHook]])
+    * rb     : returns ruby language support object (RbLanguage)
+
+
+Restricted
+==========
+
+  * Hooks are not called automatically because crb is free from
+    scenarios. Otherwise if hooks are called in each invokes,
+    we'll never succeed to "add" operation in above calculator.
+
+  * "before", "after" methods are the manual triggers for hooks.
+    And "Ctl-C" is binded as "before" filter too.
+
+  * To implement CRB, there are many ugly codes that closely
+    depend on cuke's internal structures like private methods
+    and instance vars. So it'll break soon after cuke's update.
+
+
+Environment
+===========
+
+  Tested on ruby-1.8.7, cucumber-1.0.0
+
+
+Author
+======
+
+  maiha@wota.jp
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "crb"
+  gem.homepage = "http://github.com/maiha/crb"
+  gem.license = "MIT"
+  gem.summary = "A cucumber console that offers cucumber world enviroment on irb"
+  gem.description = gem.summary
+  gem.email = "maiha@wota.jp"
+  gem.authors = ["maiha"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/crb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# clear ARGV for Irb
+
+require 'rubygems'
+require 'crb'
+CRB::Console.execute(ARGV.slice!(0..-1)||[])

data/crb.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{crb}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["maiha"]
+  s.date = %q{2011-07-10}
+  s.default_executable = %q{crb}
+  s.description = %q{TODO: longer description of your gem}
+  s.email = %q{maiha@wota.jp}
+  s.executables = ["crb"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "bin/crb",
+    "crb.gemspec",
+    "lib/crb.rb"
+  ]
+  s.homepage = %q{http://github.com/maiha/crb}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{TODO: one-line summary of your gem}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/crb.rb

@@ -0,0 +1,122 @@
+require 'cucumber'
+require 'cucumber/formatter/unicode'
+require 'cucumber/runtime'
+require 'cucumber/rb_support/rb_dsl'
+require 'irb'
+
+module CRB
+  class Runtime < Cucumber::Runtime
+    def run!
+      load_step_definitions
+      fire_after_configuration_hook
+    end
+
+    def step_definitions
+      @support_code.step_definitions
+    end
+  end
+
+  module World
+    include Cucumber::RbSupport::RbDsl
+
+    attr_accessor :runtime
+    attr_accessor :rb
+
+    def to_s
+      "CRB:%s" % (steps.size rescue '???')
+    end
+
+    def steps
+      runtime.step_definitions
+    end
+
+    def hooks
+      rb.send(:hooks)
+    end
+
+    def before
+      fire_hook(:before)
+    end
+
+    def after
+      fire_hook(:after)
+    end
+
+    private
+      def Given(name, &block)
+        if block
+          step = super(name, &block)
+          "%s is defined" % (step.regexp_source rescue 'A new step')
+        else
+          @crb_before_executed ||= (before; true)
+          runtime.step_match(name).invoke(nil)
+        end
+      rescue Cucumber::Undefined => e
+        puts e.to_s
+        e
+      end
+
+      def fire_hook(key)
+        count = 0
+        hooks[key].each do |hook|
+          block = hook.instance_variable_get('@proc')
+          if block
+            instance_eval(&block)
+            count += 1
+          else
+            # cuke is newer than 1.0
+          end
+        end
+        "%d %s hooks executed" % [count, key]
+      end
+  end
+
+  class Console < Cucumber::Cli::Main
+    include IRB
+
+    def runtime
+      @runtime ||= CRB::Runtime.new(configuration)
+    end
+
+    def rb
+      @rb ||= runtime.load_programming_language('rb')
+    end
+
+    def world
+      @world ||= (
+        rb.send(:create_world)
+        world = rb.current_world
+        world.extend(CRB::World)
+        world.runtime = runtime
+        world.rb = rb
+        world.instance_eval do
+          Gherkin::I18n.code_keywords.each do |adverb|
+            next if adverb.to_s == "Given"
+            alias :"#{adverb}" :Given
+          end
+        end
+        world
+      )
+    end
+
+    def execute!
+      IRB.setup(__FILE__)
+      IRB.conf[:CONTEXT_MODE] = 0
+      irb = Irb.new(WorkSpace.new(world))
+      runtime.run!
+      IRB.module_eval do
+        @CONF[:MAIN_CONTEXT] = irb.context
+      end
+
+      trap("SIGINT") {
+        world.before 
+        irb.signal_handle
+      }
+      catch(:IRB_EXIT) do
+        irb.eval_input
+      end
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: crb
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-10 00:00:00 +09:00
+default_executable: crb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: A cucumber console that offers cucumber world enviroment on irb
+email: maiha@wota.jp
+executables: 
+- crb
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- bin/crb
+- crb.gemspec
+- lib/crb.rb
+has_rdoc: true
+homepage: http://github.com/maiha/crb
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A cucumber console that offers cucumber world enviroment on irb
+test_files: []
+