rs 35

data/.gitignore

@@ -0,0 +1,14 @@
+config.rb
+InstalledFiles
+
+rs.gemspec
+pkg/
+
+*.log
+*.swp
+.DS_Store
+
+old
+
+# ctags
+tags

data/Rakefile

@@ -0,0 +1,52 @@
+begin
+  require "rubygems"
+    require "jeweler"
+
+  namespace :jeweler do
+    Jeweler::Tasks.new do |gem|
+      gem.name        = "rs"
+
+      gem.version     = `git log --pretty=oneline | wc -l`.chomp
+
+
+      gem.summary     = "Object-oriented shell in full Ruby environment."
+      gem.description = <<-END.gsub /\s+/, " "
+
+                        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.
+
+                        END
+
+      gem.email       = "rs@projects.kittensoft.org"
+      gem.homepage    = "http://github.com/rue/rs"
+      gem.authors     = ["Eero Saynatkari"]
+
+
+      gem.add_development_dependency  "rspec",        ">= 1.3.0"
+
+      gem.post_install_message = <<-END
+
+      =======================================
+
+      /path/to/cwd rs> _
+
+      =======================================
+
+      END
+    end
+
+    Jeweler::GemcutterTasks.new
+  end
+
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+# Main tasks
+
+desc "Generate Gem and push it."
+task :release_gem => %w[jeweler:gemcutter:release]
+

data/bin/rs

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+#
+# The 'executable' rs program.
+#
+# == Copyright
+# Copyright (c) 2005-2010 Eero Saynatkari, all rights reserved.
+#
+# == Licence
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# - Redistributions of source code must retain the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors.
+#
+# - Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - The names of the authors may not be used to endorse or promote
+#   products derived from this software without specific prior
+#   written permission.
+#
+# == Disclaimer
+# This software is provided "as is" and without any express or
+# implied warranties, including, without limitation, the implied
+# warranties of merchantability and fitness for a particular purpose.
+# Authors are not responsible for any damages, direct or indirect.
+
+
+# We might need the files in development
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+
+# System
+
+# Project
+require "rs/eval"
+require "rs/ui"
+
+
+# TODO: Yeah...ugh. --rue
+#
+RS.start {|rs|
+
+  # Minor configulabulous
+  config = rs.main.send(:rs).config
+
+  config.default_prompt      = lambda { "#{Dir.pwd} rs> " }
+  config.continuation_prompt = lambda { "#{Dir.pwd} ..> " }
+
+
+  RS::UI.new {|ui|
+
+    ui.on_SIGINT {
+      @earlier_incomplete = nil
+      ui.puts ""
+      ui.prompt = config.default_prompt
+    }
+
+    ui.on_input {|line|
+      next if line.empty?
+
+      if @earlier_incomplete
+        line = @earlier_incomplete + line
+        @earlier_incomplete = nil
+      end
+
+      begin
+        output = rs.execute line
+
+        ui.puts "=> #{output.inspect}"
+        ui.prompt = config.default_prompt
+
+      rescue RS::IncompleteExpression
+        @earlier_incomplete = line + "\n"      # Only allow where newlines appropriate.
+        ui.prompt = config.continuation_prompt
+
+      rescue LocalJumpError => e    # next and redo in 1.8
+        output = e
+      end
+    }
+
+    ui.prompt = config.default_prompt
+    ui.run
+  }
+
+}
+

data/doc/LICENCE

@@ -0,0 +1,29 @@
+= LICENCE
+
+== Copyright
+Copyright (c) 2005-2010 Eero Saynatkari, all rights reserved.
+
+== Licence
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions, the following disclaimer and
+  attribution to the original authors.
+
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions, the following disclaimer and
+  attribution to the original authors in the documentation and/or
+  other materials provided with the distribution.
+
+- The names of the authors may not be used to endorse or promote
+  products derived from this software without specific prior
+  written permission.
+
+== Disclaimer
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+Authors are not responsible for any damages, direct or indirect.
+

data/doc/README.markdown

@@ -0,0 +1,62 @@
+ rs
+====
+
+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.
+
+
+
+ Features
+==========
+
+Currently extremely rudimentary and exploratory:
+
+- Executes normal Ruby code, unrestricted.
+
+
+
+ Requirements
+==============
+
+- Ruby
+  - 1.8.7, 1.9.1, 1.9.2
+
+- For development
+  - RSpec (>= 1.3.0)
+
+
+
+ Where?
+========
+
+    $ gem install rs
+
+Source is found on [Github](http://github.com/rue/rs).
+
+
+
+ Who Do I Complain To?
+=======================
+
+* rs MEOW projects _purr_ kittensoft _rawr_ org.
+* IRC channels #rs and ##rs on Freenode ('rue', if not the only person.)
+
+
+
+ Legal
+=======
+
+Copyright (c) 2005-2010 Eero Saynatkari. See doc/LICENCE.
+
+
+
+ Acknowledgements
+==================
+
+The original spark was provided by Reyn Vlietstra's ruSH back in 2005.
+It was an excellent implementation of a novel concept, and I thoroughly
+enjoyed working on it. The first incarnation of rs was a complete rewrite
+effort of ruSH, and now I am starting from scratch again. Thanks to Reyn
+and all the other collaborators on ruSH and the earlier rs.
+

data/lib/rs/eval.rb

@@ -0,0 +1,129 @@
+# == Copyright
+# Copyright (c) 2005-2010 Eero Saynatkari, all rights reserved.
+#
+# == Licence
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# - Redistributions of source code must retain the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors.
+#
+# - Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - The names of the authors may not be used to endorse or promote
+#   products derived from this software without specific prior
+#   written permission.
+#
+# == Disclaimer
+# This software is provided "as is" and without any express or
+# implied warranties, including, without limitation, the implied
+# warranties of merchantability and fitness for a particular purpose.
+# Authors are not responsible for any damages, direct or indirect.
+
+# Libs
+require "ostruct"
+
+
+module RS
+
+  # Creates and yields a new Evaluator.
+  #
+  # The block given should implement whatever logic is
+  # desired. Will clean up as necessary.
+  #
+  # TODO: This needs much improvement, probably. --rue
+  #
+  def self.start(&block)
+    rs = Evaluator.new
+
+    begin
+      rs.send :run, &block
+
+    rescue SystemExit => e
+      # No need to print errors etc., but set return code.
+      exit! e.status
+    end
+  end
+
+
+  #
+  # Error raised trying to execute an incomplete expression.
+  #
+  class IncompleteExpression < SyntaxError; end
+
+
+  # Runtime environment for executing user input as Ruby.
+  #
+  class Evaluator
+
+    # Create a new execution environment.
+    #
+    # You should use RS.start instead.
+    #
+    # TODO: Generate unique bindings?
+    #
+    def initialize()
+      @binding = eval "lambda { binding }.call", TOPLEVEL_BINDING
+
+      stash = OpenStruct.new  :evaluator => self,
+                              :config => OpenStruct.new
+
+      @main = execute "self"
+      @main.instance_variable_set "@rs", stash
+
+      # Work around MRI changing description.
+      def @main.inspect(); :rs_main; end
+
+      execute "def rs(); @rs; end"
+    end
+
+
+    # Allow accessing main from the outside.
+    #
+    attr_reader :main
+
+
+    # Execute a presumably valid String of Ruby code.
+    #
+    # Trying to execute an incomplete Ruby expression
+    # raises IncompleteExpression.
+    #
+    # Errors are caught etc. (except top-level next and redo
+    # LocalJumpErrors, those need to be caught outside this
+    # scope), and returned as objects.
+    #
+    def execute(expression, file = "<no file>", line = "<no line>")
+      eval expression, @binding
+
+    rescue SyntaxError => e
+      case e.message
+      when /(parse|syntax) error.*?\$end/i, /unterminated/i  # Should catch most
+        raise IncompleteExpression
+      else
+        e
+      end
+    rescue SystemExit
+      raise
+    rescue Exception => e
+      e
+    end
+
+
+    # Yields this instance to block.
+    #
+    # Use RS.start.
+    #
+    def run()
+      yield self
+    end
+    private :run
+
+  end
+
+end
+

data/lib/rs/string.rb

@@ -0,0 +1,39 @@
+# == Authors
+# Please see doc/AUTHORS.
+#
+# == Copyright
+# Copyright (c) 2005-2010 the Authors, all rights reserved.
+#
+# == Licence
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# - Redistributions of source code must retain the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors.
+#
+# - Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - The names of the authors may not be used to endorse or promote
+#   products derived from this software without specific prior
+#   written permission.
+#
+# == Disclaimer
+# This software is provided "as is" and without any express or
+# implied warranties, including, without limitation, the implied
+# warranties of merchantability and fitness for a particular purpose.
+# Authors are not responsible for any damages, direct or indirect.
+
+
+
+# Extensions to String needed for rs.
+#
+class String
+
+  # Nothing yet, but will need this later anyway.. --rue
+
+end

data/lib/rs/ui.rb

@@ -0,0 +1,114 @@
+# == Copyright
+# Copyright (c) 2005-2010 Eero Saynatkari, all rights reserved.
+#
+# == Licence
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# - Redistributions of source code must retain the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors.
+#
+# - Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions, the following disclaimer and
+#   attribution to the original authors in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - The names of the authors may not be used to endorse or promote
+#   products derived from this software without specific prior
+#   written permission.
+#
+# == Disclaimer
+# This software is provided "as is" and without any express or
+# implied warranties, including, without limitation, the implied
+# warranties of merchantability and fitness for a particular purpose.
+# Authors are not responsible for any damages, direct or indirect.
+
+module RS
+
+  # Readline-based console UI.
+  #
+  class UI
+
+    # Lib
+    require "readline"
+
+
+    # Default prompt is unexciting.
+    #
+    DefaultPrompt = lambda { "#{Dir.pwd} rs> " }
+
+
+    # UI is set up and prepared to be read/written.
+    #
+    # Initial prompt may be given as an argument, and can
+    # later be changed using #prompt=.
+    #
+    def initialize(initial_prompt = DefaultPrompt)
+      $stdin.sync   = true
+      $stdout.sync  = true
+      $stderr.sync  = true
+
+      # Work around Readline binding to get full line of input
+      Readline.completer_word_break_characters  = 0.chr   # NUL byte unlikely?
+      Readline.completion_append_character      = nil
+
+      self.prompt = initial_prompt
+
+      yield self
+    end
+
+    # Prompt used for next input read.
+    #
+    attr_accessor :prompt
+
+
+    # Signal handlers
+    #
+    # TODO: Perhaps autogenerate these? --rue
+
+
+    # ^C, keyboard interrupt.
+    #
+    def on_SIGINT(&block); @sigint = block; end
+
+
+    # Other event handlers
+
+    # Block to call with each line of input.
+    #
+    def on_input(&block); @input = block; end
+
+
+    # Write #to_s to output.
+    #
+    # TODO: Probably need a .print version, huh? --rue
+    #
+    def puts(data)
+      $stdout.puts data.to_s
+    end
+
+    # Input loop.
+    #
+    # Calls the block given in #on_input for each line of
+    # input, as well as any other #on_* handlers as needed.
+    #
+    def run()
+      loop {
+        begin
+          if input = Readline.readline(@prompt.call, true)
+            @input.call input.chomp
+          else
+            puts ""
+            return
+          end
+        rescue Interrupt
+          @sigint.call
+        end
+      }
+    end
+
+  end
+
+end