rink 1.0.0

data/rink.gemspec

@@ -0,0 +1,83 @@
+# 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{rink}
+  s.version = "1.0.0"
+
+  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.default_executable = %q{rink}
+  s.description = %q{Makes interactive consoles awesome.}
+  s.email = %q{sinisterchipmunk@gmail.com}
+  s.executables = ["rink"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/rink",
+     "lib/core_ext/object.rb",
+     "lib/rink.rb",
+     "lib/rink/console.rb",
+     "lib/rink/delegation.rb",
+     "lib/rink/input_method/base.rb",
+     "lib/rink/input_method/file.rb",
+     "lib/rink/input_method/io.rb",
+     "lib/rink/input_method/readline.rb",
+     "lib/rink/io_methods.rb",
+     "lib/rink/lexer.rb",
+     "lib/rink/line_processor/base.rb",
+     "lib/rink/line_processor/pure_ruby.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/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.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Makes interactive consoles awesome.}
+  s.test_files = [
+    "spec/lib",
+     "spec/lib/core_ext",
+     "spec/lib/core_ext/object_spec.rb",
+     "spec/lib/rink",
+     "spec/lib/rink/console_spec.rb",
+     "spec/lib/rink/io_methods_spec.rb",
+     "spec/lib/rink/pure_ruby_line_processor_spec.rb",
+     "spec/lib/rink_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+
+  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
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

data/spec/lib/core_ext/object_spec.rb

@@ -0,0 +1,19 @@
+describe Object do
+  context "#instance_exec" do
+    class Dummy
+      def value
+        :dummy_value
+      end
+    end
+
+    subject { Dummy.new }
+
+    it "should work with args" do
+      # Block returns the value passed to it and the value of #value from the Dummy, in whose context
+      # it will be eval'd.
+      block = lambda { |a| [a, value] }
+
+      subject.instance_exec(:arg_value, &block).should == [:arg_value, :dummy_value]
+    end
+  end
+end

data/spec/lib/rink/console_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Rink::Console do
+  class ExampleObject
+    def inspect
+      "#<example>"
+    end
+  end
+
+  def console(*input)
+    if input.last.kind_of?(Hash)
+      options = input.pop
+    else options = {}
+    end
+    input = input.flatten.join("\n")
+    subject.run(input, options.merge(:output => @output, :silent => false))
+  end
+
+  before(:each) { @input = ""; @output = "" }
+  subject { Rink::Console.new(:input => "", :silent => true) }
+  
+  it "should provide an option to not execute Ruby code" do
+    console("x = 5", :allow_ruby => false)
+    @output.should match(/I don't know the word \"x.\"/)
+  end
+  
+  it "should not raise a NameError when invoking a dynamically-defined method" do
+    console("def a; 5; end; a", :rescue_errors => false).should == 5
+  end
+  
+  it "should retain local variables" do
+    subject.run("x = 5\nx", :rescue_errors => false)
+  end
+  
+  it "should be able to set itself as the namespace" do
+    subject.run("self", :namespace => :self).should == subject
+  end
+  
+  it "should return the last value executed" do
+    console("1").should == 1
+  end
+  
+  it "should not have a nil namespace!" do
+    console("self").should_not be_nil
+  end
+  
+  it "should be able to span ruby code over 2 lines" do
+    proc { console("3.times do\nend", :rescue_errors => false) }.should_not raise_error
+  end
+  
+  it "should not output multiple prompts" do
+    console("3.times do |i|\nx = i\nend")
+    @output.should == ">> Interactive Console <<\nRink::Console > 3.times do |i|\nRink::Console > x = i\nRink::Console > end\n  => 3\nRink::Console > "
+  end
+  
+  it "should be able to span ruby code over 3 lines" do
+    proc { console("3.times do |i|\nx = i\nend", :rescue_errors => false) }.should_not raise_error
+    
+    # this illustrates a totally different prob: losing scope over multiple inputs.
+#    proc { console("x = 0\n3.times do |i|\nx += i\nend\nraise unless x == 3", :rescue_errors => false) }.
+#            should_not raise_error
+    
+  end
+  
+  # May need a better way to test this.
+  it "should be able to add hooks custom commands" do
+    # Create a subclass of Rink::Console so we don't contaminate the environment
+    klass = Class.new(Rink::Console)
+    klass.command(:help) { |*args| puts 'how may I help you?' }
+    k = klass.new(:input => "help", :output => @output, :rescue_errors => false)
+    @output.should =~ /how may I help you\?/ 
+  end
+  
+  it "should be able to exit" do
+    # yeah, it was an oversight. Catching all Exceptions resulted in catching SystemExit, so the app couldn't be
+    # stopped. Whoops.
+    #proc { console("exit") }.should raise_error(SystemExit)
+    
+    # now an honest-to-goodness 'exit' command exists, so SystemExit doesn't get raised.
+    # instead we'll just make sure that exit doesn't execute any further code.
+    console("exit\n1").should_not == 1
+  end
+
+  it "should show a banner" do
+    console
+    @output.should =~ /\A>> Interactive Console <</
+  end
+
+  it "should have a prompt" do
+    console
+    prompt = Regexp::escape(subject.send(:prompt))
+    @output.should =~ /^#{prompt}$/
+  end
+
+  it "should print return value, inspected" do
+    console("ExampleObject.new")
+    @output.should =~ /  => #<example>$/
+  end
+
+  it "should not raise exceptions" do
+    proc { console("test") }.should_not raise_error
+  end
+
+  it "should print exceptions" do
+    console("test")
+    @output.should =~ /ArgumentError: /
+  end
+
+  it "should ignore blank lines" do
+    console("\n")
+    prompt = Regexp::escape(subject.send(:prompt))
+    @output.should =~ /^#{prompt}[\n\r]+#{prompt}$/
+  end
+
+  it "should allow setting namespace" do
+    obj = ExampleObject.new
+    subject.namespace = obj
+    console("self").should == obj
+  end
+
+  it "should allow presetting namespace" do
+    obj = ExampleObject.new
+    console("self", :namespace => obj).should == obj
+  end
+
+  it "should allow lazily presetting namespace" do
+    console("self", :namespace => proc { ExampleObject.new }).should be_kind_of(ExampleObject)
+  end
+end

data/spec/lib/rink/io_methods_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Rink::IOMethods do
+  include Rink::IOMethods
+  
+  shared_examples_for "an input method" do
+    it "should gets" do
+      inln = @input.gets
+      inln.should_not be_nil
+      inln.length.should_not == 0
+    end
+  end
+  
+  context "input should be set up" do
+    context "from a File" do
+      before(:each) { setup_input_method(File.new(__FILE__, "r")).should be_kind_of(Rink::InputMethod::Base) }
+      
+      it_should_behave_like "an input method"
+    end
+    
+    context "from a String" do
+      before(:each) { setup_input_method("a string").should be_kind_of(Rink::InputMethod::Base) }
+      
+      it_should_behave_like "an input method"
+    end
+    
+    context "from a StringIO" do
+      before(:each) { setup_input_method(StringIO.new("a string")).should be_kind_of(Rink::InputMethod::Base) }
+      
+      it_should_behave_like "an input method"
+    end
+    
+    context "from an InputMethod" do
+      before(:each) { setup_input_method(setup_input_method("a string")).should be_kind_of(Rink::InputMethod::Base) }
+      
+      it_should_behave_like "an input method"
+    end
+  end
+end

data/spec/lib/rink/pure_ruby_line_processor_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Rink::LineProcessor::PureRuby do
+  it "should autocomplete" do
+    subject.autocomplete('insp', Object.new).should == ["inspect"]
+  end
+  
+  # probably don't need to test this directly since readline does it (and we know it works) ...
+  # maybe test that autocomplete and whatnot are processed correctly, instead.
+#  def console(*input)
+#    input = input.flatten.join("\n")
+#    subject.run(input, :output => @output, :silent => false)
+#  end
+#
+#  before(:each) { @input = ""; @output = "" }
+#  subject { Rink::Console.new(:input => "", :silent => true) }
+#  
+#  
+#  it "should autocomplete 'help'" do
+#    console("h\t")
+#    @output.should =~ /> help/
+#  end
+#  
+#  it "should not autocomplete 'help' from 'd'" do
+#    console("d\t")
+#    @output.should_not =~ /> dh?elp/
+#  end
+# 
+#  it "should recall backward" do
+#    console("1\n" + ANSI::move_up)
+#    @output.should =~ / => 1$/
+#  end
+end

data/spec/lib/rink_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rink do
+  # it's a placeholder. What's there to describe?
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'tmpdir'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rink'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: rink
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Colin MacKenzie IV
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-06 00:00:00 -04:00
+default_executable: rink
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: Makes interactive consoles awesome.
+email: sinisterchipmunk@gmail.com
+executables: 
+- rink
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/rink
+- lib/core_ext/object.rb
+- lib/rink.rb
+- lib/rink/console.rb
+- lib/rink/delegation.rb
+- lib/rink/input_method/base.rb
+- lib/rink/input_method/file.rb
+- lib/rink/input_method/io.rb
+- lib/rink/input_method/readline.rb
+- lib/rink/io_methods.rb
+- lib/rink/lexer.rb
+- lib/rink/line_processor/base.rb
+- lib/rink/line_processor/pure_ruby.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/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
+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 interactive consoles awesome.
+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/pure_ruby_line_processor_spec.rb
+- spec/lib/rink_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb