termvana 0.2.0.beta1

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+== 0.2.0
+* Tear out all ripl/fresh stuff, rebuild in Eventmachine
+* Basic cucumber support
+* Nifty iframe demo
+* build simple site
+_ fix timeout error when you run a long command and then other commands
+* more specs for CD - home dir, expanded paths, CDPATH, multiple terminals

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 David Haslem
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/READING.txt

@@ -0,0 +1,7 @@
+Usefult bits I've seen while figuring out stuff:
+
+http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01_01
+
+http://pubs.opengroup.org/onlinepubs/009695399/utilities/cd.html
+
+https://gist.github.com/535644

data/README.rdoc

@@ -0,0 +1,46 @@
+== Description
+A web-based shell that has autocompletion and readline behavior. It uses
+websockets, repl.js, readline.js.
+
+Goal is to have a fully usable shell for 80% of daily tasks, but with an awesome and hackable
+UI built in HTML/CSS/jQuery - eventually this goal may require a specialized browser, Termkit style,
+but initially I hope to get most functionality without taking that step.
+
+== Install
+Install the gem with:
+
+    gem install termvana
+
+== Usage
+
+Your browser must have html5 websockets support.
+
+To start the server
+
+    $ termvana
+
+Termvana will be available on port 5432
+
+Also notice that a subset of readline's functionality is available.  Try C-l, C-r or C-p and they
+should do what readline normally does. For more keybindings, see
+{readline.js}[http://github.com/cldwalker/readline.js].
+
+
+== Bugs/Issues
+Please report them {on github}[http://github.com/cldwalker/nirvana/issues]. For javascript issues,
+report them on {readline.js}[http://github.com/cldwalker/readline.js/issues] or
+{repl.js}[http://github.com/cldwalker/repl.js/issues] as appropriate.
+
+== Credits
+* {rkh's brirb}[http://github.com/rkh/brirb]: Original prototype which inspired nirvana
+* {cldwalker's nirvana}[http://github.com/cldwalker/nirvana]: Initial project inspiration, JS libs.
+* {janlelis's fresh}[https://github.com/janlelis/fresh]
+* {unconed's TermKit}[https://github.com/unconed/TermKit]
+
+== License
+termvana is MIT licensed. termvana comes bundled with other libraries which have the following
+licenses: jquery (GPL2 and MIT), jquery.hotkeys plugin (no license), repl.js jquery plugin (MIT) and
+readline.js jquery plugin (MIT).
+
+== Todo
+* Tests

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
+end
+
+task :default => :test

data/bin/termvana

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'termvana'
+Termvana.start()

data/lib/termvana.rb

@@ -0,0 +1,15 @@
+require 'termvana/version'
+require 'termvana/application'
+
+require 'thin'
+
+
+module Termvana
+  def self.start(port = 5432, open = false)
+    filename = File.expand_path(File.dirname(__FILE__) + '/termvana/config.ru')
+    puts "Opening up tervana..."
+    Thread.new{ sleep 1; `open http://localhost:5432/`} if open
+    
+    Thin::Runner.new("--max-persistent-conns 1024 --timeout 0 -R #{filename} -p #{port} start -e #{Termvana::Application.env}".split).run!
+  end
+end

data/lib/termvana/app/actions/home_action.rb

@@ -0,0 +1,7 @@
+class Termvana::HomeAction < Cramp::Action
+  def start
+    render File.read(File.join(Termvana::Application.root(:public), 'index.html'))
+    finish
+  end
+end
+

data/lib/termvana/app/actions/websocket_action.rb

@@ -0,0 +1,34 @@
+Cramp::Websocket.backend = :thin
+
+class Termvana::WebsocketAction < Cramp::Websocket
+  self.transport = :websocket
+
+  on_data :received_data
+  on_start :opened_conn
+  on_finish :closed_conn
+
+  attr_accessor :environment
+
+  def opened_conn
+    @environment = Termvana::Environment.new(:env => {"HOME" => ENV['HOME']})
+    @environment.messenger do |message|
+      render message.to_s
+    end
+    render Termvana::Response.new(:message => "Welcome to Nirvana. Websocket connected.", :type => :on_connect).to_s
+    # resulvt = Termvana::Runner.run ARGV
+    # send(result) unless result.to_s.empty?
+  end
+
+  def received_data(data)
+    command = Termvana::Request.new(data)
+    callable = Termvana::CommandProcessor.parse(environment, command)
+    callable.call
+  end
+
+  def closed_conn
+    # Ripl.shell.after_loop
+    STDERR.puts "Browser disconnecting."
+  end
+
+end
+

data/lib/termvana/app/command_processor.rb

@@ -0,0 +1,58 @@
+module Termvana
+  class CommandProcessor < EventMachine::Connection
+    include EventMachine::Deferrable
+    attr_accessor :environment, :command
+    # https://gist.github.com/535644
+    #
+    def self.register(command_klass)
+      @command_list ||=[]
+      @command_list << command_klass
+    end
+
+    def self.parse(environment, request)
+      @command_list ||= []
+      command_klass = @command_list.detect{|klass| klass.match?(request)}
+      if command_klass
+        command_klass.new(environment, request)
+      else
+        # Simple case - popen and set a timeout
+        lambda do 
+          process = EM.popen(environment.runnable(request), self, environment)
+          process.callback do |data|
+            environment.send_message Termvana::Response.new(:message => data)
+          end
+          process.errback do |data|
+            environment.send_message Termvana::Response.new(:message => "Command timed out.", :type => :error)
+          end
+          process.timeout(10)
+        end
+      end
+    end
+
+    def initialize(environment)
+      @environment = environment
+      # @command = command
+      environment.setup
+    end
+
+    # In the command processor, we are sending/recieving data over an
+    # I/O pipe to a command
+    def prepare_and_run
+      # send_data "cd #{environment.cwd}\n"
+      # send_data command.full_command
+      # send_data "\n"
+      # send_data "exit\n"
+    end
+
+
+    def receive_data data
+      environment.send_message(Response.new(:message => data))
+    end
+
+    def unbind
+      cancel_timeout
+      # puts "exit status: #{get_status.exitstatus}"
+    end
+    
+  end
+end

data/lib/termvana/app/commands/cd.rb

@@ -0,0 +1,15 @@
+module Termvana
+  class CdCommand < Command
+    type :builtin
+    response :none
+    name "cd"
+    def call
+      dir = request[1] || "~"
+      Dir.chdir(environment.fullpath(dir))
+      environment.env["PWD"] = environment.cwd = Dir.pwd
+      finish
+    end
+  end
+end
+
+Termvana::CommandProcessor.register(Termvana::CdCommand)

data/lib/termvana/app/commands/set.rb

@@ -0,0 +1,17 @@
+module Termvana
+  class SetCommand < Command
+    type :builtin
+    response :none
+    name "set"
+    def call
+      key, val = request[1].match(/(.+)=(.+)/) do |matches|
+        [matches[1], matches[2]]
+      end
+      environment.env[key] = val
+      finish
+    end
+  end
+end
+
+Termvana::CommandProcessor.register(Termvana::SetCommand)
+

data/lib/termvana/app/models/command.rb

@@ -0,0 +1,42 @@
+module Termvana
+  class Command
+    attr_accessor :request, :environment
+    def initialize(environment, request)
+      @request = request
+      @environment = environment
+    end
+
+    def finish
+      if !self.class.response || self.class.response == :none
+        respond_with :null
+      end
+    end
+
+    def respond_with(opts = {})
+      if opts == :null
+        environment.send_message Termvana::Response.new
+      elsif data = opts.delete(:text)
+        environment.send_message Termvana::Response.new(:message => data)
+      elsif data = opts.delete(:error)
+        environment.send_message Termvana::Response.new(:message => data, :type => :error)
+      end
+    end
+
+
+    def self.type(arg = false)
+      @type = arg if arg
+      @type
+    end
+    def self.response(arg = false)
+      @response = arg if arg
+      @response
+    end
+    def self.name(arg = false)
+      @name = arg if arg
+      @name
+    end
+    def self.match?(request)
+      self.name.match(/^#{request[0]}$/)
+    end
+  end
+end

data/lib/termvana/app/models/environment.rb

@@ -0,0 +1,31 @@
+module Termvana
+  class Environment
+    include Virtus
+    attribute :cwd, String, :default => "~"
+    attribute :env, Hash, :default => {}
+    def messenger
+      @messenger = Proc.new
+    end
+    def send_message(response)
+      @messenger[response]
+    end
+    def fullpath(path)
+      path.gsub("~", home)
+    end
+    def home
+      env['HOME']
+    end
+    def setup
+      Dir.chdir(fullpath(cwd))
+    end
+    def envs
+      my_envs = env.map do |k, v|
+        "#{k.upcase}=#{v}"
+      end.join(" ")
+    end
+    def runnable(request)
+      "env -i #{envs} #{request.full_command}"
+    end
+  end
+
+end

data/lib/termvana/app/models/request.rb

@@ -0,0 +1,25 @@
+module Termvana
+  class Request
+    include Virtus
+    attribute :full_command, String
+    attribute :type, Symbol, :default => :standard
+    def initialize(*args)
+      if args.first.is_a? String
+        command = JSON.parse(args.first).symbolize_keys
+        super(command)
+      else
+        super(*args)
+      end
+    end
+
+    def [](*args)
+      @tokens ||= Shellwords.split(full_command)
+      @tokens[*args]
+    end
+
+    def to_s
+      attributes.to_json
+    end
+
+  end
+end

data/lib/termvana/app/models/response.rb

@@ -0,0 +1,11 @@
+module Termvana
+  class Response
+    include Virtus
+    attribute :message, String, :default => ""
+    attribute :type, Symbol, :default => :output
+
+    def to_s
+      attributes.to_json
+    end
+  end
+end

data/lib/termvana/application.rb

@@ -0,0 +1,36 @@
+require 'cramp'
+require 'thin'
+require 'bundler'
+require 'http_router'
+require 'async-rack'
+require 'virtus'
+require 'active_support/json'
+
+module Termvana
+  class Application
+
+    def self.root(path = nil)
+      @_root ||= File.expand_path(File.dirname(__FILE__))
+      path ? File.join(@_root, path.to_s) : @_root
+    end
+
+    def self.env
+      @_env ||= (ENV['RACK_ENV'] || 'development')
+    end
+
+    def self.routes
+      @_routes ||= eval(File.read("#{root}/config/routes.rb"))
+    end
+
+    # Initialize the application
+    def self.initialize!
+    end
+
+  end
+end
+
+# Preload application classes
+Dir["#{File.expand_path(File.dirname(__FILE__))}/app/models/*.rb"].each {|f| require f}
+Dir["#{File.expand_path(File.dirname(__FILE__))}/app/command_processor.rb"].each {|f| require f}
+Dir["#{File.expand_path(File.dirname(__FILE__))}/app/**/*.rb"].each {|f| require f}
+