rink 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,5 +1,7 @@
 = rink
 
+  gem install rink
+  
 Makes interactive consoles awesome. More specifically, it does this by automating as much as conceivably possible so
 that you can get right down to what you really care about: your application.
 
@@ -23,8 +25,56 @@ application-specific interactive console, extend the Rink::Console class:
   #...
   MyConsole.new
   
-By default, Rink will execute code within the context of its #namespace (see the Rink::Console class documentation for
-details). You can, however, add specific commands to Rink like so:
+=== The Ruby Console
+
+With the default set of options, any input that is not processed as a custom command will be executed as Ruby code,
+much like the Ruby IRB. Guess there's not much more to say about that, so here's an example to drive the point home:
+
+  >> Interactive Console <<
+  
+  Rink::Console > class Person
+  Rink::Console >   attr_reader :first_name
+  Rink::Console >   def initialize
+  Rink::Console >     @first_name = "Colin"
+  Rink::Console >   end
+  Rink::Console > end
+    => nil
+  Rink::Console > Person.new.first_name
+    => "Colin"
+  Rink::Console > 
+  
+
+=== The Rink Namespace
+
+By default, Rink will execute code within the context of its namespace (see the Rink::Console class documentation for
+details). Basically, you can choose any Ruby object and run the console within the context of that object. For example:
+
+  class Person
+    attr_reader :first_name
+    
+    def initialize
+      @first_name = "Colin"
+    end
+  end
+  
+  class MyConsole < Rink::Console
+    option :namespace => Person.new
+  end
+  
+  MyConsole.new
+  
+  >> Interactive Console <<
+
+  MyConsole > self
+    => #<Person:0x10171c3a0 @first_name="Colin">
+  
+  MyConsole > first_name
+    => "Colin"
+  
+
+=== Custom Commands
+
+Rink isn't limited only to running Ruby code, however. You can also add specific commands to Rink like so:
 
   class MyConsole < Rink::Console
     command :help do |args|
@@ -71,10 +121,13 @@ In addition to commands, you can also easily add or override default options in
   MyConsole > greet_me
   Hello there!
   
+See the class documentation for Rink::Console for much more detailed information, including how to disable Ruby code
+processing entirely.
+  
 == Running From The Command Line
 
-You've seen numerous examples of how to start Rink from within Ruby. The same thing works from within IRB or a Rake
-task. Additionally, Rink ships with a script so that you can run it directly from the command line:
+You've seen numerous examples of how to start Rink from within Ruby. The same thing works from within IRB or inside of
+a Rake task. Additionally, Rink ships with a script so that you can run it directly from the command line:
 
   $ rink
   
@@ -113,9 +166,11 @@ You can also pass IO objects in directly:
     end
   end
   
+== Dealing With Errors
+  
 Normally, if an error occurs, Rink will print a nicely-formatted message to its output stream. This is helpful if you're
 using the console but not if you're trying to write tests for one. So, you can disable error catching within Rink by
-passing :rescue_errors => false to the initializer:
+passing +:rescue_errors => false+ to the initializer:
 
   MyConsole.new(:input => "raise", :rescue_errors => false)
   #=> RuntimeError!

data/Rakefile

@@ -8,7 +8,7 @@ begin
     gem.summary = %Q{Makes interactive consoles awesome.}
     gem.description = %Q{Makes interactive consoles awesome.}
     gem.email = "sinisterchipmunk@gmail.com"
-    gem.homepage = "http://github.com/sinisterchipmunk/rink"
+    gem.homepage = "http://www.thoughtsincomputation.com"
     gem.authors = ["Colin MacKenzie IV"]
     
     gem.add_development_dependency "rspec", ">= 1.3.0"

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/rink.rb

@@ -1,6 +1,8 @@
 #require 'sc-ansi'
 
+require File.expand_path(File.join(File.dirname(__FILE__), "core_ext/object"))
 require File.expand_path(File.join(File.dirname(__FILE__), "rink/delegation"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'rink/namespace'))
 require File.expand_path(File.join(File.dirname(__FILE__), "rink/lexer"))
 require File.expand_path(File.join(File.dirname(__FILE__), 'rink/io_methods'))
 require File.expand_path(File.join(File.dirname(__FILE__), "rink/line_processor/base"))

data/lib/rink/console.rb

@@ -2,7 +2,7 @@ module Rink
   class Console
     extend Rink::Delegation
     attr_reader :line_processor
-    attr_writer :namespace, :silenced
+    attr_writer :silenced
     attr_reader :input, :output
     delegate :silenced?, :print, :write, :puts, :to => :output, :allow_nil => true
     delegate :banner, :commands, :to => 'self.class'
@@ -11,10 +11,15 @@ module Rink
     # call super with :defer => true -- because otherwise Rink will start the console before your init code executes.
     def initialize(options = {})
       options = default_options.merge(options)
+      @namespace = Rink::Namespace.new
       apply_options(options)
       run(options) unless options[:defer]
     end
     
+    def namespace=(ns)
+      @namespace.replace(ns)
+    end
+    
     # The Ruby object within whose context the console will be run.
     # For example:
     #  class CustomNamespace
@@ -37,16 +42,7 @@ module Rink
     #  Rink::Console.new(:namespace => :self)
     #
     def namespace
-      @namespace ||= begin
-        # We want namespace to be any object, and in order to do that, Rink will call namespace#binding.
-        # But by default, the namespace should be TOPLEVEL_BINDING. If we set @namespace to this,
-        # Rink will call TOPLEVEL_BINDING#binding, which is an error. So instead we'll create a singleton
-        # object and override #binding on that object to return TOPLEVEL_BINDING. Effectively, that
-        # singleton object becomes (more-or-less) a proxy into the toplevel object. (Is there a better way?)
-        klass = Class.new(Object)
-        klass.send(:define_method, :binding) { TOPLEVEL_BINDING }
-        klass.new
-      end
+      @namespace.ns
     end
 
     # Runs a series of commands in the context of this Console. Input can be either a string
@@ -103,10 +99,7 @@ module Rink
 
       if options[:namespace]
         ns = options[:namespace] == :self ? self : options[:namespace]
-        if ns != @namespace
-          @namespace = ns
-          @namespace_binding = nil
-        end
+        @namespace.replace(ns)
       end
       
       if @input
@@ -255,10 +248,10 @@ module Rink
     include Rink::IOMethods
     
     def evaluate_scanner_statement
-      _caller = eval("caller", namespace_binding)
+      _caller = @namespace.evaluate("caller")
       scanner.each_top_level_statement do |code, line_no|
         begin
-          return eval(code, namespace_binding, self.class.name, line_no)
+          return @namespace.evaluate(code, self.class.name, line_no)
         rescue
           # clean out the backtrace so that it starts with the console line instead of program invocation.
           _caller.reverse.each { |line| $!.backtrace.pop if $!.backtrace.last == line }
@@ -267,10 +260,6 @@ module Rink
       end
     end
     
-    def namespace_binding
-      @namespace_binding ||= namespace.send(:binding)
-    end
-    
     def prepare_scanner_for(code)
       # the scanner prompt should be empty at first because we've already received the first line. Nothing to prompt for.
       scanner.set_prompt nil
@@ -319,7 +308,7 @@ module Rink
     # Runs the autocomplete method from the line processor, then reformats its result to be an array.
     def autocomplete(line)
       return [] unless @line_processor
-      result = @line_processor.autocomplete(line, namespace)
+      result = @line_processor.autocomplete(line, namespace.ns)
       case result
         when String
           [result]

data/lib/rink/input_method/base.rb

@@ -13,6 +13,10 @@ module Rink
       attr_accessor :prompt
       attr_accessor :output
       
+      def encoding
+        input.external_encoding
+      end
+
       def input
         raise NotImplementedError, "input"
       end

data/lib/rink/input_method/file.rb

@@ -7,6 +7,10 @@ module Rink
         @line_num = 0
         @lines = []
       end
+      
+      def input
+        @io
+      end
 
       def eof?
         @io.eof?

data/lib/rink/input_method/readline.rb

@@ -16,6 +16,10 @@ begin
           @eof = false
         end
         
+        def input
+          $stdin
+        end
+        
         def gets
           # in case they were changed. Do we need this here?
           ::Readline.completion_append_character = completion_append_character 

data/lib/rink/line_processor/pure_ruby.rb

@@ -119,7 +119,7 @@ module Rink
       
       def autocomplete(line, namespace)
         # Borrowed from irb/completion.rb
-        case line
+        result = case line
           when /^(\/[^\/]*\/)\.([^.]*)$/
             autocomplete_for_regexp($1, Regexp.quote($2))
             
@@ -161,6 +161,9 @@ module Rink
             candidates = eval("methods | private_methods | local_variables | self.class.constants", namespace.send(:binding))
             (candidates|RESERVED_WORDS).grep(/^#{Regexp.quote(line)}/)
         end
+        result.kind_of?(Array) ? 
+          result.collect { |r| r.kind_of?(String) ? r : r.to_s } :
+          result.kind_of?(String) ? result : result.to_s
       end
       
       private

data/lib/rink/namespace.rb

@@ -0,0 +1,37 @@
+module Rink
+  class Namespace
+    def initialize(ns = self.default_ns)
+      replace(ns)
+    end
+    
+    def binding
+      @ns_binding
+    end
+    
+    def ns
+      @namespace
+    end
+    
+    def replace(ns)
+      return ns if ns.eql?(@namespace)
+      @ns_binding = ns.instance_eval { binding }
+              #ns.send(:binding) # this no worky in 1.9
+      @namespace = ns
+    end
+    
+    def evaluate(code, *filename_lineno)
+      eval code, @ns_binding, *filename_lineno
+    end
+    
+    def default_ns
+      # We want namespace to be any object, and in order to do that, Rink will call namespace#binding.
+      # But by default, the namespace should be TOPLEVEL_BINDING. If we set @namespace to this,
+      # Rink will call TOPLEVEL_BINDING#binding, which is an error. So instead we'll create a singleton
+      # object and override #binding on that object to return TOPLEVEL_BINDING. Effectively, that
+      # singleton object becomes (more-or-less) a proxy into the toplevel object. (Is there a better way?)
+      klass = Class.new(Object)
+      klass.send(:define_method, :binding) { TOPLEVEL_BINDING }
+      klass.new
+    end
+  end
+end

data/rink.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rink}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Colin MacKenzie IV"]
-  s.date = %q{2010-08-06}
+  s.date = %q{2010-08-07}
   s.default_executable = %q{rink}
   s.description = %q{Makes interactive consoles awesome.}
   s.email = %q{sinisterchipmunk@gmail.com}
@@ -38,18 +38,20 @@ Gem::Specification.new do |s|
      "lib/rink/lexer.rb",
      "lib/rink/line_processor/base.rb",
      "lib/rink/line_processor/pure_ruby.rb",
+     "lib/rink/namespace.rb",
      "lib/rink/output_method/base.rb",
      "lib/rink/output_method/io.rb",
      "rink.gemspec",
      "spec/lib/core_ext/object_spec.rb",
      "spec/lib/rink/console_spec.rb",
      "spec/lib/rink/io_methods_spec.rb",
+     "spec/lib/rink/namespace_spec.rb",
      "spec/lib/rink/pure_ruby_line_processor_spec.rb",
      "spec/lib/rink_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/sinisterchipmunk/rink}
+  s.homepage = %q{http://www.thoughtsincomputation.com}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
@@ -61,6 +63,7 @@ Gem::Specification.new do |s|
      "spec/lib/rink",
      "spec/lib/rink/console_spec.rb",
      "spec/lib/rink/io_methods_spec.rb",
+     "spec/lib/rink/namespace_spec.rb",
      "spec/lib/rink/pure_ruby_line_processor_spec.rb",
      "spec/lib/rink_spec.rb",
      "spec/spec.opts",

data/spec/lib/rink/console_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Rink::Console do
-  class ExampleObject
+  class ::ExampleObject
     def inspect
       "#<example>"
     end
@@ -13,7 +13,7 @@ describe Rink::Console do
     else options = {}
     end
     input = input.flatten.join("\n")
-    subject.run(input, options.merge(:output => @output, :silent => false))
+    subject.run(input, {:output => @output, :silent => false, :rescue_errors => false}.merge(options))
   end
 
   before(:each) { @input = ""; @output = "" }
@@ -93,16 +93,16 @@ describe Rink::Console do
   end
 
   it "should print return value, inspected" do
-    console("ExampleObject.new")
+    console("ExampleObject.new", :rescue_errors => false)
     @output.should =~ /  => #<example>$/
   end
 
   it "should not raise exceptions" do
-    proc { console("test") }.should_not raise_error
+    proc { console("test", :rescue_errors => true) }.should_not raise_error
   end
 
   it "should print exceptions" do
-    console("test")
+    console("test", :rescue_errors => true)
     @output.should =~ /ArgumentError: /
   end
 
@@ -115,6 +115,8 @@ describe Rink::Console do
   it "should allow setting namespace" do
     obj = ExampleObject.new
     subject.namespace = obj
+    subject.namespace.should == obj
+    
     console("self").should == obj
   end
 

data/spec/lib/rink/namespace_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Rink::Namespace do
+  class ExampleObject
+    def initialize
+      @i = 5
+    end
+  end
+  
+  subject { Rink::Namespace.new }
+  
+  it "should use the top ns by default" do
+    subject.binding.should == TOPLEVEL_BINDING
+  end
+  
+  context "with a different ns" do
+    subject { Rink::Namespace.new(ExampleObject.new) }
+    
+    it "should not use the toplevel binding" do
+      subject.binding.should_not == TOPLEVEL_BINDING
+    end
+    
+    it "should evaluate code" do
+      subject.evaluate("@i").should == 5
+    end
+  end
+  
+  it "should be replaceable" do
+    subject.evaluate("@i").should_not == 5
+
+    subject.replace(ExampleObject.new)
+    subject.evaluate("@i").should == 5
+  end
+end

data/spec/lib/rink/pure_ruby_line_processor_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Rink::LineProcessor::PureRuby do
+  subject { Rink::LineProcessor::PureRuby.new }
+  
   it "should autocomplete" do
     subject.autocomplete('insp', Object.new).should == ["inspect"]
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Colin MacKenzie IV
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 -04:00
+date: 2010-08-07 00:00:00 -04:00
 default_executable: rink
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,18 +60,20 @@ files:
 - lib/rink/lexer.rb
 - lib/rink/line_processor/base.rb
 - lib/rink/line_processor/pure_ruby.rb
+- lib/rink/namespace.rb
 - lib/rink/output_method/base.rb
 - lib/rink/output_method/io.rb
 - rink.gemspec
 - spec/lib/core_ext/object_spec.rb
 - spec/lib/rink/console_spec.rb
 - spec/lib/rink/io_methods_spec.rb
+- spec/lib/rink/namespace_spec.rb
 - spec/lib/rink/pure_ruby_line_processor_spec.rb
 - spec/lib/rink_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/sinisterchipmunk/rink
+homepage: http://www.thoughtsincomputation.com
 licenses: []
 
 post_install_message: 
@@ -104,6 +106,7 @@ test_files:
 - spec/lib/core_ext/object_spec.rb
 - spec/lib/rink/console_spec.rb
 - spec/lib/rink/io_methods_spec.rb
+- spec/lib/rink/namespace_spec.rb
 - spec/lib/rink/pure_ruby_line_processor_spec.rb
 - spec/lib/rink_spec.rb
 - spec/spec.opts