bombshell 0.1.0 → 0.1.1

data/Gemfile

@@ -6,8 +6,5 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
 end

data/README.markdown

@@ -0,0 +1,157 @@
+# bombshell
+
+Ever wanted to give dudes the ability to explore your library interactively? Like, with a custom IRB-like shell/console?
+
+Really, you did? Weird.
+
+## Simple example
+
+`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)
+
+`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
+
+Let's try it out:
+
+    $ pizza
+    pizzabot> order 'large'
+    Your pizza has been ordered! Super!
+    pizzabot>
+
+## Prompts
+
+You set your prompt like this:
+
+    prompt_with 'pizza_bot_loves_you'
+
+Or like this:
+
+    prompt_with do
+     "pizza_bot / #{Time.now}" # binding is on your shell *class*
+    end
+
+Or even like this:
+
+    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:
+
+    before_launch do
+     init # binding is on your shell *class*
+    end
+
+    before_launch do |size|
+     Pizza.default_size = size # the block gets as many command-line parameters as you ask for
+    end
+
+    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*:
+
+`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
+
+`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
+     end
+    end
+
+Let's try it out:
+
+    pizzabot> pizza
+    new order> size 'large'
+    You got it!
+    new order> topping 'pepperoni'
+    Added pepperoni
+    new order> order
+    Coming right up!
+    pizzabot>
+
+## Tab completion
+
+It's there. Give it a whirl with TAB.
+
+## To use:
+
+* Create a class for your shell and `include Bombshell::Shell`. You should also set this class to inherit from `Bombshell::Environment` as that will ensure your shell doesn't have any extraneous "commands" (i.e. methods) inherited from Object. (If you'd rather use a different basis--like `CleanSlate`--or `undef` methods yourself, go right ahead.)
+
+* Define your commands as instance methods on this class. There's nothing *too* funny going on here, it's just Ruby.
+
+* Kick off the shell with `Bombshell.launch(YourShellClass)`. It's possible to do this from IRB but it's kind of messy (constant reassignment warnings). Instead, set up a "binary" for yourself like `pizza/bin/pizza` at the top of this file.
+
+## Hints:
+
+* Give your users a `help` command!
+* Use subshells for hierarchical interactivity!
+* Provide as thin of a wrapper you can above your library! We want to see what's going on!
+
+## Copyright
+
+Copyright (c) 2011 Andy Rossmeissl. See LICENSE.txt for
+further details.

data/Rakefile

@@ -11,34 +11,16 @@ 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 = "bombshell"
   gem.homepage = "http://github.com/rossmeissl/bombshell"
   gem.license = "MIT"
   gem.summary = %Q{Custom IRB consoles made easy}
-  gem.description = %Q{Custom IRB consoles made easy}
+  gem.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.}
   gem.email = "andy@rossmeissl.net"
   gem.authors = ["Andy Rossmeissl"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bombshell.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bombshell}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Rossmeissl"]
   s.date = %q{2011-03-07}
-  s.description = %q{Custom IRB consoles made easy}
+  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 = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     ".rspec",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "bombshell.gemspec",
@@ -50,21 +50,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/lib/bombshell/completor.rb

@@ -11,7 +11,9 @@ module Bombshell
     end
     
     def self.filter(m)
-      m - Bombshell::Environment.instance_methods - Bombshell::Shell::Commands::HIDE
+      (m - Bombshell::Environment.instance_methods - Bombshell::Shell::Commands::HIDE).reject do |m|
+        m =~ /^_/
+      end
     end
   end
 end

data/lib/bombshell/irb.rb

@@ -12,14 +12,14 @@ module IRB
 
     workspace = WorkSpace.new(binding)
     
-    @CONF[:PROMPT][:CARBON] = {
+    @CONF[:PROMPT][:BOMBSHELL] = {
       :PROMPT_I => "%m> ",
       :PROMPT_S => "%m\"> ",
       :PROMPT_C => "%m…>",
       :PROMPT_N => "%m→>",
       :RETURN => ''
     }
-    @CONF[:PROMPT_MODE] = :CARBON
+    @CONF[:PROMPT_MODE] = :BOMBSHELL
 
     irb = Irb.new(workspace)
 

data/lib/bombshell/shell.rb

@@ -30,11 +30,11 @@ module Bombshell
     end
     
     module ClassMethods
-      def launch(arguments = [])
+      def launch(*arguments)
         @bombshell_callbacks[:before_launch].each do |callback|
           callback.call(*arguments.first(callback.arity))
         end
-        shell = new
+        shell = new(*arguments)
         @bombshell_callbacks[:having_launched].each do |callback|
           shell.instance_eval &callback
         end

data/lib/bombshell/shell/commands.rb

@@ -4,7 +4,7 @@ module Bombshell
       HIDE = [:method_missing, :get_binding, :_prompt, :to_s]
       
       def quit
-        exit
+        throw :IRB_EXIT
       end
       def method_missing(*args)
         return if [:extend, :respond_to?].include? args.first

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bombshell
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -18,43 +18,11 @@ cert_chain: []
 date: 2011-03-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  name: rspec
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
-        version: 2.3.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 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,22 +33,8 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  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: Custom IRB consoles made easy
+  requirement: *id001
+description: 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.
 email: andy@rossmeissl.net
 executables: []
 
@@ -88,13 +42,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .rspec
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - bombshell.gemspec

data/README.rdoc

@@ -1,19 +0,0 @@
-= bombshell
-
-Description goes here.
-
-== Contributing to bombshell
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Andy Rossmeissl. See LICENSE.txt for
-further details.
-