rs 35

data/spec/evaluator_spec.rb

@@ -0,0 +1,114 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# Testing
+require "spec_helper"
+
+# Project
+require "rs/eval"
+
+
+# TODO: Dunno how much point there is to add stuff to spec
+#       here, but I suppose some coverage is useful. --rue
+
+describe "Executing Ruby code with the evaluator" do
+  before :each do
+    @rs = RS::Evaluator.new
+    @topmeth = "rs_eval_toplevel_def_#{$$}"
+  end
+
+  after :each do
+    @rs.execute "Object.send :remove_method, :#{@topmeth} if Object.instance_methods.include?(:#{@topmeth})"
+    @rs.execute "Object.send :remove_const, :RSEvalSpecsClass if defined? RSEvalSpecsClass"
+    @rs.execute "Object.send :remove_const, :RSEvalSpecsModule if defined? RSEvalSpecsModule"
+    @rs.execute "Object.send :remove_const, :RSEvalSpecsExtModule if defined? RSEvalSpecsExtModule"
+  end
+
+  it "has a top-level self object" do
+    @rs.execute("self").should be_kind_of(Object)
+  end
+
+  it "provides #rs which gives access to an OpenStruct" do
+    @rs.execute("rs").should be_kind_of(OpenStruct)
+  end
+
+  it "allows access to a #config OpenStruct through #rs" do
+    @rs.execute("rs.config").should be_kind_of(OpenStruct)
+  end
+
+  it "allows top-level method definitions" do
+    @rs.execute("def #{@topmeth}; :gots; end").should == nil
+    @rs.execute(@topmeth).should == :gots
+  end
+
+  it "allows top-level class and module definitions" do
+    @rs.execute "class RSEvalSpecsClass; end"
+    @rs.execute "module RSEvalSpecsModule; end"
+
+    @rs.execute("RSEvalSpecsClass").should be_kind_of(Class)
+    @rs.execute("RSEvalSpecsModule").should be_kind_of(Module)
+  end
+
+  it "has no wrapping nesting in top-level modules" do
+    @rs.execute("Module.nesting").should == []
+    @rs.execute("module RSEvalSpecsModule; Module.nesting; end").should == [RSEvalSpecsModule]
+  end
+
+  it "supports extending and including into self" do
+    @rs.execute "module RSEvalSpecsModule; def rsesm; end; end"
+    @rs.execute "module RSEvalSpecsExtModule; def rsesem; end; end"
+
+    @rs.execute "include RSEvalSpecsModule"
+    @rs.execute("Object.ancestors").include?(RSEvalSpecsModule).should == true
+
+    @rs.execute "extend RSEvalSpecsExtModule"
+    @rs.execute("class << self; ancestors; end").include?(RSEvalSpecsExtModule).should == true
+  end
+
+  it "gracefully returns error object if an error bubbles to top level" do
+    @rs.execute("raise SyntaxError").should be_kind_of(SyntaxError)
+  end
+
+  it "supports normal error handling" do
+    @rs.execute("begin; raise SyntaxError; rescue SyntaxError; :yay; end").should == :yay
+  end
+
+  it "lets SystemExit bubble up" do
+    lambda { @rs.execute "exit 1" }.should raise_error(SystemExit)
+  end
+
+  it "returns error object given top-level return" do
+    @rs.execute("return").should be_kind_of(Exception)
+  end
+
+  it "returns error object given top-level break" do
+    @rs.execute("break").should be_kind_of(Exception)
+  end
+
+  it "returns error object given top-level next" do
+    pending "Escapes on 1.8" if RUBY_VERSION =~ /1\.8/
+    @rs.execute("next").should be_kind_of(Exception)
+  end
+
+  it "returns error object given top-level redo" do
+    pending "Escapes on 1.8" if RUBY_VERSION =~ /1\.8/
+    @rs.execute("redo").should be_kind_of(Exception)
+  end
+
+end
+
+
+describe "Evaluator creation using RS.start" do
+
+  it "yields an Evaluator to the block given" do
+    RS.start {|rs| rs.should be_kind_of(RS::Evaluator) }
+  end
+
+  it "does not rescue errors raised in the block" do
+    lambda { RS.start {|rs| raise "hi" } }.should raise_error("hi")
+  end
+
+  it "gives access to the eval context's main object with #main" do
+    RS.start {|rs| rs.main.should be_eql(rs.execute "self") }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "tempfile"
+
+
+class OutputMatcher
+  def initialize(expected, stream)
+    @expected = expected
+    @stream = stream
+  end
+
+# TODO: cleanup unnecessary error stuffs
+  def matches?(block)
+    old_to = @stream.dup
+
+    # Obtain a filehandle to replace (works with Readline)
+    @stream.reopen File.open(File.join(Dir.tmpdir, "should_output_#{$$}"), "w+")
+
+    # Execute
+    block.call
+
+    # Restore
+    out = @stream.dup
+    @stream.reopen old_to
+
+    # Grab the data
+    out.rewind
+    @data = out.read
+
+    # Match up
+    case @expected
+    when Regexp
+      @data.should =~ @expected
+    else
+      @data.should == @expected
+    end
+
+  # Clean up
+  ensure
+    out.close if out and !out.closed?
+
+    # STDIO redirection will break else
+    begin
+      @stream.seek 0, IO::SEEK_END
+    rescue Errno::ESPIPE, Errno::EPIPE
+      # Ignore
+    end
+
+    FileUtils.rm out.path if out
+  end
+
+  def failure_message()
+    fail
+#    "Output to #{@stream.to_i} was:\n#{@data.inspect}\nshould have been:\n#{@expected.inspect}"
+  end
+
+  def negative_failure_message()
+    fail
+  end
+end
+
+# Top-level matching
+#
+def output(expected, into_stream = $stdout)
+  OutputMatcher.new expected, into_stream
+end
+

data/spec/ui_spec.rb

@@ -0,0 +1,144 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# Testing
+require "spec_helper"
+
+# Project
+require "rs/ui"
+
+
+describe "UI creation" do
+
+  it "yields the UI instance to the given block" do
+    RS::UI.new {|ui| ui.should be_kind_of(RS::UI) }
+  end
+
+  it "provides some kind of a default prompt String" do
+    Readline.should_receive(:readline).with(an_instance_of(String), true).once.and_return nil
+
+    RS::UI.new {|ui| ui.run }
+  end
+
+  it "allows prompt to be assigned to" do
+    lambda {
+      RS::UI.new {|ui| ui.prompt = lambda { "hi>" } }
+    }.should_not raise_error
+  end
+
+  it "accepts a ^C handler in #on_SIGINT" do
+    lambda {
+      RS::UI.new {|ui| ui.on_SIGINT { :hi } }
+    }.should_not raise_error
+  end
+
+  it "accepts a linewise input handler in #on_input" do
+    lambda {
+      RS::UI.new {|ui| ui.on_input {|i| i.reverse } }
+    }.should_not raise_error
+  end
+
+end
+
+
+describe "UI loop/processing" do
+
+  it "terminates when ^D, EOF, received." do
+    Readline.should_receive(:readline).once.and_return nil
+
+    RS::UI.new {|ui|
+      ui.run
+    }
+  end
+
+  it "calls the current prompt and uses its value going out for each loop" do
+    str = "rs_ui_spec_prompt #{$$}> "
+
+    prompt = Object.new
+    prompt.should_receive(:call).exactly(2).times.and_return { str }
+
+    inputs = ["hi\n", "ho\n", nil]
+    prompts = [//, str, str]
+
+    # TODO: Slightly iffy, improve.
+    Readline.should_receive(:readline).exactly(3).times {|output_prompt, _|
+      prompts.shift.should === output_prompt
+      inputs.shift
+    }
+
+    RS::UI.new {|ui|
+      ui.on_input {|input|
+        ui.prompt = prompt
+      }
+
+      ui.run
+    }
+  end
+
+end
+
+
+describe "UI event handling" do
+
+  it "calls block given to #on_SIGINT on ^C" do
+    inputs = [lambda { raise Interrupt }, lambda { nil }]
+
+    Readline.should_receive(:readline).exactly(2).times.and_return { inputs.shift.call }
+
+    called = false
+
+    RS::UI.new {|ui|
+      ui.on_SIGINT { called = true }
+      ui.run
+    }
+
+    called.should == true
+  end
+
+  it "continues processing after invoking #on_SIGINT" do
+    continued = false
+
+    inputs = [lambda { raise Interrupt }, lambda { continued = true; nil } ]
+
+    Readline.should_receive(:readline).exactly(2).times.and_return { inputs.shift.call }
+
+    RS::UI.new {|ui|
+      ui.on_SIGINT { :yay }
+      ui.run
+    }
+
+    continued.should == true
+  end
+
+  it "invokes #on_input block for each line of input until terminated by ^D" do
+    inputs = ["hi\n", "ha\n", "hoo bee\n", nil, "blee\n"]
+    expected = inputs.map {|i| i.chomp if i }
+
+    Readline.should_receive(:readline).exactly(4).times.and_return { inputs.shift }
+
+    RS::UI.new {|ui|
+      ui.on_input {|input|
+        input.should == expected.shift
+      }
+
+      ui.run
+    }
+
+    expected.should == [nil, "blee"]
+  end
+
+end
+
+
+describe "UI output" do
+
+  it "calls #to_s on its argument and writes it to output with a newline when using #puts" do
+    lambda {
+      RS::UI.new {|ui|
+        ui.puts "Hiya"
+        ui.puts "Really"
+      }
+    }.should output("Hiya\nReally\n")
+  end
+
+end
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: rs
+version: !ruby/object:Gem::Version 
+  version: "35"
+platform: ruby
+authors: 
+- Eero Saynatkari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 +02:00
+default_executable: rs
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: " rs is the result of my object-oriented shell musings, experiments and implementations. Its focus is above all on simplicity and the best possible implementation of modern shell usage and needs. "
+email: rs@projects.kittensoft.org
+executables: 
+- rs
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- bin/rs
+- doc/LICENCE
+- doc/README.markdown
+- lib/rs/eval.rb
+- lib/rs/string.rb
+- lib/rs/ui.rb
+- setup.rb
+- spec/evaluator_spec.rb
+- spec/spec_helper.rb
+- spec/ui_spec.rb
+has_rdoc: true
+homepage: http://github.com/rue/rs
+licenses: []
+
+post_install_message: |+
+  
+        =======================================
+  
+        /path/to/cwd rs> _
+  
+        =======================================
+  
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Object-oriented shell in full Ruby environment.
+test_files: 
+- spec/evaluator_spec.rb
+- spec/spec_helper.rb
+- spec/ui_spec.rb