bombshell 0.1.5 → 0.1.6

data/README.markdown

@@ -6,31 +6,37 @@ Really, you did? Weird.
 
 ## Simple example
 
+(The source code for this example is in [`doc/pizza`](https://github.com/rossmeissl/bombshell/tree/master/doc/pizza).) 
+
 `pizza/bin/pizza`:
 
-    #!/usr/bin/env ruby
-    $:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
-    
-    require 'rubygems'
-    require 'pizza'
-    Bombshell.launch(Pizza::Shell)
+``` ruby
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'pizza'
+Bombshell.launch(Pizza::Shell)
+```
 
 `pizza/lib/pizza/shell.rb`:
 
-    require 'bombshell'
-    
-    module Pizza
-     class Shell < Bombshell::Environment
-       include Bombshell::Shell
-       
-       prompt_with 'pizzabot'
-       
-       def order(size)
-         Pizza::Order.new(:size => size).place!
-         puts 'Your pizza has been ordered! Super!'
-       end
-     end
-    end
+``` ruby
+require 'bombshell'
+
+module Pizza
+ class Shell < Bombshell::Environment
+   include Bombshell::Shell
+   
+   prompt_with 'pizzabot'
+   
+   def order(size)
+     Pizza::Order.new(:size => size).place!
+     puts 'Your pizza has been ordered! Super!'
+   end
+ end
+end
+```
 
 Let's try it out:
 
@@ -39,28 +45,42 @@ Let's try it out:
     Your pizza has been ordered! Super!
     pizzabot>
 
+If you have Bombshell's source checked out, you can try this at home:
+
+``` console
+$ cd doc/pizza
+$ ./bin/pizza
+```
+
 ## Prompts
 
 You set your prompt like this:
 
+``` ruby
     prompt_with 'pizza_bot_loves_you'
+```
 
 Or like this:
 
+``` ruby
     prompt_with do
      "pizza_bot / #{Time.now}" # binding is on your shell *class*
     end
+```
 
 Or even like this:
 
+``` ruby
     prompt_with do |shell|
      "pizza_bot / #{shell.size}" # the block gets the shell *instance* when it asks for it
     end
+```
 
 ## Callbacks
 
 You can set callbacks like this:
 
+``` ruby
     before_launch do
      init # binding is on your shell *class*
     end
@@ -72,55 +92,62 @@ You can set callbacks like this:
     having_launched do
      puts size if size # binding is on your shell *instance*
     end
+```
 
 ## Subshells
 
-If you dump all of your functionality into one shell, things could get a little messy. That's why we have *subshells*:
+If you dump all of your functionality into one shell, things could get a little messy. That's why we have *subshells*.
+
+(The source code for this example is in [`doc/pizza2`](https://github.com/rossmeissl/bombshell/tree/master/doc/pizza2).) 
 
 `pizza/lib/pizza/shell.rb`:
 
-    require 'bombshell'
-    
-    module Pizza
-     class Shell < Bombshell::Environment
-       include Bombshell::Shell
-       prompt_with 'pizzabot'
-       
-       def pizza
-         Order.launch
-       end
-     end
-    end
+``` ruby
+require 'bombshell'
+
+module Pizza
+ class Shell < Bombshell::Environment
+   include Bombshell::Shell
+   prompt_with 'pizzabot'
+   
+   def pizza
+     Order.launch
+   end
+ end
+end
+
+require 'pizza/shell/order'
+```
 
 `pizza/lib/pizza/shell/order.rb`:
 
-    require 'bombshell'
-    
-    module Pizza
-     class Shell
-       class Order < Bombshell::Environment
-         include Bombshell::Shell
-         prompt_with 'new order'
-       
-         def size(s)
-           @size = s
-           puts 'You got it!'
-         end
-         
-         def topping(t)
-           @toppings ||= []
-           @toppings << t
-           puts "Added #{t}"
-         end
-         
-         def order
-           Pizza::Order.new :size => @size, :toppings => @toppings
-           puts 'Coming right up!'
-           quit
-         end
-       end
+``` ruby
+module Pizza
+ class Shell
+   class Order < Bombshell::Environment
+     include Bombshell::Shell
+     prompt_with 'new order'
+   
+     def size(s)
+       @size = s
+       puts 'You got it!'
      end
-    end
+     
+     def topping(t)
+       @toppings ||= []
+       @toppings << t
+       puts "Added #{t}"
+     end
+     
+     def order
+       Pizza::Order.new :size => @size, :toppings => @toppings
+       puts 'Coming right up!'
+       quit
+     end
+   end
+ end
+end
+```
 
 Let's try it out:
 
@@ -133,6 +160,13 @@ Let's try it out:
     Coming right up!
     pizzabot>
 
+If you have Bombshell's source checked out, you can try this at home:
+
+``` console
+$ cd doc/pizza2
+$ ./bin/pizza
+```
+
 ## Tab completion
 
 It's there. Give it a whirl with TAB.

data/bombshell.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Rossmeissl"]
-  s.date = "2011-04-20"
+  s.date = "2011-12-08"
   s.description = %q{Give your application or gem an interactive shell, complete with custom prompts, tab completion, and various callbacks. Commands are defined as Ruby methods and can be grouped into logical subshells.}
   s.email = %q{andy@rossmeissl.net}
   s.extra_rdoc_files = [
@@ -16,26 +16,12 @@ Gem::Specification.new do |s|
     "README.markdown"
   ]
   s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
     "bombshell.gemspec",
-    "doc/brainstorm.rb",
-    "features/callbacks.feature",
-    "features/completion.feature",
-    "features/prompts.feature",
-    "features/shell.feature",
-    "features/step_definitions/completion_steps.rb",
-    "features/subshells.feature",
-    "features/support/env.rb",
     "lib/bombshell.rb",
     "lib/bombshell/completor.rb",
     "lib/bombshell/environment.rb",
     "lib/bombshell/irb.rb",
+    "lib/bombshell/version.rb",
     "lib/bombshell/shell.rb",
     "lib/bombshell/shell/commands.rb"
   ]
@@ -44,7 +30,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.6.2}
   s.summary = %q{Custom IRB consoles made easy}
-  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'aruba', '>= 0.3.4'
   s.add_development_dependency 'bueller'
 end
 

data/lib/bombshell/shell.rb

@@ -55,7 +55,8 @@ module Bombshell
         @bombshell_callbacks[:before_launch].each do |callback|
           callback.call(*arguments.first(callback.arity > -1 ? callback.arity : 0))
         end
-        shell = new(*arguments)
+        number_of_requested_arguments = instance_method(:initialize).arity < 0 ? arguments.length : instance_method(:initialize).arity
+        shell = new(*arguments.first(number_of_requested_arguments))
         @bombshell_callbacks[:having_launched].each do |callback|
           shell.instance_eval &callback
         end

data/lib/bombshell/version.rb

@@ -0,0 +1,4 @@
+module Bombshell
+  # Used by Bueller
+  VERSION = "0.1.6"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bombshell
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-20 00:00:00 -04:00
-default_executable: 
+date: 2011-12-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -27,10 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
         - 0
-        version: "0"
+        - 3
+        - 4
+        version: 0.3.4
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -56,29 +57,16 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.markdown
 files: 
-- .document
-- .rspec
-- Gemfile
-- LICENSE.txt
-- README.markdown
-- Rakefile
-- VERSION
 - bombshell.gemspec
-- doc/brainstorm.rb
-- features/callbacks.feature
-- features/completion.feature
-- features/prompts.feature
-- features/shell.feature
-- features/step_definitions/completion_steps.rb
-- features/subshells.feature
-- features/support/env.rb
 - lib/bombshell.rb
 - lib/bombshell/completor.rb
 - lib/bombshell/environment.rb
 - lib/bombshell/irb.rb
+- lib/bombshell/version.rb
 - lib/bombshell/shell.rb
 - lib/bombshell/shell/commands.rb
-has_rdoc: true
+- LICENSE.txt
+- README.markdown
 homepage: http://github.com/rossmeissl/bombshell
 licenses: 
 - MIT
@@ -108,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Custom IRB consoles made easy

data/.document

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

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile

@@ -1,2 +0,0 @@
-source "http://rubygems.org"
-gemspec

data/Rakefile

@@ -1,17 +0,0 @@
-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 'cucumber/rake/task'
-Cucumber::Rake::Task.new
-task :default => :cucumber
-
-require 'bueller'
-Bueller::Tasks.new

data/VERSION

@@ -1 +0,0 @@
-0.1.2

data/doc/brainstorm.rb

@@ -1,56 +0,0 @@
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
-require 'bombshell'
-
-module Foo
-  class Shell < Bombshell::Environment
-    include Bombshell::Shell
-    
-    before_launch do
-      @punctuation = '!'
-    end
-    
-    before_launch do |arg|
-      puts arg if arg
-    end
-    
-    having_launched do
-      @msg = 'Done' + self.class.punctuation
-    end
-    
-    having_launched do
-      puts 'Welcome to FooShell'
-    end
-    
-    prompt_with do
-      punctuation
-    end
-    
-    def do_something
-      puts @msg
-    end
-    
-    def sub
-      Subshell.launch
-    end
-    
-    class << self
-      def punctuation
-        @punctuation
-      end
-    end
-  end
-end
-
-module Foo
-  class Subshell < Bombshell::Environment
-    include Bombshell::Shell
-    
-    def do_something_else
-      puts '... and done'
-    end
-    
-    prompt_with '[foo::subshell]'
-  end
-end
-
-Bombshell.launch(Foo::Shell)

data/features/callbacks.feature

@@ -1,48 +0,0 @@
-Feature: Callbacks
-
-  In order to have customization flexibility
-  As a Ruby library developer
-  I want to have access to callbacks
-  
-  Scenario: Using a before_launch callback
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          before_launch do
-            puts "Hi, I'm #{name}"
-          end
-          def self.name; 'Foo' end
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "quit"
-    Then the output should contain:
-      """
-      Hi, I'm Foo
-      """
-      
-  Scenario: Using a having_launched callback
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          having_launched do
-            puts "Hi, I'm an instance of #{self.class}"
-          end
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "quit"
-    Then the output should contain:
-      """
-      Hi, I'm an instance of Foo::Shell
-      """

data/features/completion.feature

@@ -1,55 +0,0 @@
-Feature: Completion
-
-  In order to expedite my exploration
-  As a user of a Bombshell-enabled Ruby library
-  I want to be able to use tab completion
-  
-  Scenario: Single matching command
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          def abcdef; end
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "abc" and hit tab
-    And I type "quit"
-    Then the output should contain:
-      """
-      abcdef
-      """
-    And the output should not contain:
-      """
-      method_missing
-      """
-      
-  Scenario: Multiple matching commands
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          def abcd; end
-          def abcx; end
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "abc" and hit tab twice
-    And I type "quit"
-    Then the output should contain:
-      """
-      abcd
-      """
-    And the output should contain:
-      """
-      abcx
-      """
-

data/features/prompts.feature

@@ -1,69 +0,0 @@
-Feature: Prompts
-
-  In order to brand my custom shell experience
-  As a developer of a Bombshell-enabled Ruby library
-  I want to set custom prompts
-  
-  Scenario: Static-string prompt
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          prompt_with 'fooprompt'
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "quit"
-    Then the output should contain:
-      """
-      fooprompt>
-      """
-      
-  Scenario: Class-oriented prompt
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          prompt_with do
-            _prompt
-          end
-          def self._prompt; 'fooprompt-class' end  
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "quit"
-    Then the output should contain:
-      """
-      fooprompt-class>
-      """
-
-  Scenario: Instance-oriented prompt
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          prompt_with do |foo|
-            foo._prompt
-          end
-          def _prompt; 'fooprompt-instance' end  
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "quit"
-    Then the output should contain:
-      """
-      fooprompt-instance>
-      """
-

data/features/shell.feature

@@ -1,45 +0,0 @@
-Feature: Custom shell
-
-  In order to allow my users to explore my library
-  As a Ruby library developer
-  I want to give them an interactive shell
-  
-  Scenario: Running the shell
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "quit"
-    Then the output should contain:
-      """
-      [Bombshell]
-      """
-      
-  Scenario: Using a command
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          def hello
-            puts 'hello world'
-          end
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "hello"
-    And I type "quit"
-    Then the output should contain:
-      """
-      [Bombshell]
-      """

data/features/step_definitions/completion_steps.rb

@@ -1,14 +0,0 @@
-When /^I type "(.*)" and hit tab$/ do |command|
-  pending
-  _write_interactive(command)
-  _write_interactive("\t")
-  _write_interactive("\n")
-end
-
-When /^I type "(.*)" and hit tab twice$/ do |command|
-  pending
-  _write_interactive(command)
-  _write_interactive("\t")
-  _write_interactive("\t")
-  _write_interactive("\n")
-end

data/features/subshells.feature

@@ -1,48 +0,0 @@
-Feature: Subshells
-
-  In order to organize my shell commands
-  As a developer of a Bombshell-enabled Ruby library
-  I want to use subshells
-  
-  Scenario: Using subshells
-    Given a file named "fooshell.rb" with:
-      """
-      require 'bombshell'
-      module Foo
-        class Shell < Bombshell::Environment
-          include Bombshell::Shell
-          def deeper
-            Subshell.launch
-          end
-          prompt_with 'first'
-          class Subshell < Bombshell::Environment
-            include Bombshell::Shell
-            def foo; puts 'bar' end
-            prompt_with 'second'
-          end
-        end
-      end
-      Bombshell.launch Foo::Shell
-      """
-    When I run "ruby fooshell.rb" interactively
-    And I type "deeper"
-    And I type "foo"
-    And I type "quit"
-    And I type "quit"
-    Then the output should contain:
-      """
-      first> deeper
-      """
-    And the output should contain:
-      """
-      second> foo
-      bar
-      """
-    And the output should contain:
-      """
-      second> quit
-      """
-    And the output should contain:
-      """
-      first> quit
-      """

data/features/support/env.rb

@@ -1,10 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'aruba/cucumber'
-require 'fileutils'
-require 'rspec/expectations'
-require 'bombshell'
-
-Before do
-  @aruba_io_wait_seconds = 3
-  @dirs = [File.join(ENV['HOME'], 'bombshell_features')]
-end