cuttlebone 0.1.3 → 0.1.4

data/.gitignore

@@ -1,6 +1,7 @@
 .rvmrc
 .bundle
 .autotest
+.*.swp
 Gemfile.lock
 coverage/
 pkg/

data/Rakefile

@@ -9,11 +9,42 @@ require 'cucumber/rake/task'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
 
+begin
+  require 'haml'
+  require 'sass'
+rescue LoadError
+end
+
 CUTTLEBONE_GEMSPEC = eval(File.read(File.expand_path('../cuttlebone.gemspec', __FILE__)))
 
 desc 'Default: run specs'
 task :default => 'spec'
 
+if defined?(Haml) and defined?(Sass)
+  task :gem => 'rack:compile'
+
+  namespace :rack do
+    desc 'Compiles HTML/CSS files.'
+    task :compile do
+      {
+        'index.html.haml' => 'index.html',
+        'error.html.haml' => 'error.html',
+        'cuttlebone.sass' => 'stylesheets/cuttlebone.css'
+      }.each_pair do |f,t|
+        File.open(File.expand_path("../public/#{t}", __FILE__), 'w') do |tt|
+          tt.write(
+            (
+              f =~ /\.haml$/ ?
+              Haml::Engine.new(File.read(File.expand_path("../public/sources/#{f}",__FILE__)), :format => :html5, :ugly => true) :
+              Sass::Engine.new(File.read(File.expand_path("../public/sources/#{f}",__FILE__)))
+          ).render()
+          )
+        end
+      end
+    end
+  end
+end
+
 namespace :spec do
   desc 'Run all specs in spec directory (format=progress)'
   RSpec::Core::RakeTask.new(:progress) do |t|

data/cuttlebone.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "i18n"
   s.add_development_dependency "cucumber", "~> 0.10.0"
   s.add_development_dependency "rcov",     "~> 0.9.0"
+  s.add_development_dependency "capybara", "~> 0.4.0"
+  s.add_development_dependency "haml",     "~> 3.0.0"
 
   s.files            = `git ls-files`.split("\n")
   s.executables      = `git ls-files`.split("\n").select{|f| f =~ /^bin/}

data/examples/todo.rb

@@ -53,5 +53,5 @@ context Task do
 end
 
 at_exit do
-  Cuttlebone.run([Task.new(:title => 'x'), Task.new(:title => 'y')])
+  Cuttlebone.run([Task.new(:title => 'x'), Task.new(:title => 'y')], Cuttlebone::Drivers::Rack)
 end

data/features/rack.feature

@@ -0,0 +1,19 @@
+@browser @wip
+Feature: rack compatibility
+  In order to manage my todo list through the web
+  As a programmer
+  I want to connect to a cuttlebone web-server
+
+  Background:
+    Given the following cuttlebone code:
+      """
+      context "x" do
+        prompt { 'prompt' }
+        command(?y) { output 'ok' }
+      end
+      """
+
+  Scenario: start a rack on top of cuttlebone
+    When I start an "x" session on rack
+    And I go to "/"
+    Then I should see "prompt" in the prompt

data/features/step_definitions/rack_steps.rb

@@ -0,0 +1,13 @@
+When /^I start (?:an? )?"([^"]*)" session on rack$/ do |objects|
+  @d = Cuttlebone::Drivers::Rack.new(*(objects.scan(/([^,]{1,})(?:,\s*)?/).flatten))
+  Capybara.app = @d.send(:app)
+end
+
+When /^I go to "([^"]*)"$/ do |path|
+  visit path
+end
+
+Then /^I should see "([^"]*)" in the prompt$/ do |text|
+  page.should have_xpath('//span[@id="prompt"]', :text => text)
+end
+

data/features/step_definitions/steps.rb

@@ -17,7 +17,7 @@ Given /^a started "([^"]*)" session$/ do |objects|
 end
 
 When /^I start (?:an? )?"([^"]*)" session$/ do |objects|
-  @d = Cuttlebone::Session::Test.new(*(objects.scan(/([^,]{1,})(?:,\s*)?/).flatten))
+  @d = Cuttlebone::Drivers::Test.new(*(objects.scan(/([^,]{1,})(?:,\s*)?/).flatten))
 end
 
 # invocation
@@ -71,6 +71,7 @@ Then /^I should see an error$/ do
 end
 
 Then /^I should get an error$/ do
-  @d.internal_error.should_not be_blank
+  @d.internal_error.should_not be_nil
+  @d.internal_error.should_not be_empty
 end
 

data/features/support/env.rb

@@ -1,2 +1,9 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'cuttlebone'))
+require File.expand_path('../../../lib/cuttlebone.rb', __FILE__)
 require 'cucumber/formatter/unicode'
+
+require 'capybara/cucumber'
+require 'capybara/session'
+Capybara.default_selector = :css
+Capybara.default_driver = :selenium
+#Capybara.app = 0 # 
+

data/features/support/test_driver.rb

@@ -1,16 +1,14 @@
-class Cuttlebone::Session::Test < Cuttlebone::Session::Base
-  def initialize *args
+# TODO FIXME
+class Cuttlebone::Drivers::Test < Cuttlebone::Drivers::Base
+  def initialize *stack_objects
     super
-    stack = []
-    @stack.each { |c| stack << c }
-    @stack_history = [ stack ]
+    @session = Cuttlebone::Session.sessions.create(*stack_objects)
+    save_stack_to_history
   end
 
-  def process command
-    stack = []
-    @stack.each { |c| stack << c }
-    @stack_history << stack
-    a, n, o, e = super(command)
+  def call command
+    a, n, o, e = @session.call(command)
+    save_stack_to_history
     @output = o
     @error  = e
     [ a, n, o, e ]
@@ -18,7 +16,22 @@ class Cuttlebone::Session::Test < Cuttlebone::Session::Base
 
   attr_reader :output, :error
 
+  def active_context
+    @history[-1].last
+  end
+
   def previous_active_context
-    @stack_history[-2].last
+    @history[-2].last
+  end
+
+  delegate :terminated?, :prompt, :internal_error, :to => '@session'
+
+  private
+
+  def save_stack_to_history
+    stack = []
+    @session.stack.each { |c| stack << c }
+    (@history ||= []) << stack
   end
+
 end

data/lib/cuttlebone/drivers/base.rb

@@ -0,0 +1,13 @@
+class Cuttlebone::Drivers::Base
+  def initialize *stack_objects
+    Cuttlebone::Session.set_default *stack_objects
+  end
+
+  def sessions
+    Cuttlebone::Session.sessions
+  end
+
+  def run
+    raise NotImplementedError, "You must implement #run in your #{send(:class).name}!"
+  end
+end

data/lib/cuttlebone/drivers/rack.rb

@@ -0,0 +1,154 @@
+require 'rack'
+require 'haml'
+require 'sass/plugin/rack'
+require 'json'
+
+class Cuttlebone::Drivers::Rack < Cuttlebone::Drivers::Base
+
+  ##
+  #
+  # Cuttlebone::Drivers::Rack::Middleware
+  #
+  # It responds only to predefined HTTP POST calls and deals them according to
+  # Cuttlebone definitions and the associated driver's internal state.
+  #
+  class Middleware
+
+    def initialize app, driver=nil
+      @app    = app
+      @driver = driver || Cuttlebone::Drivers::Rack.new
+    end
+
+    def call env
+      @request  = Rack::Request.new(env)
+
+      return(@app.call(env)) unless @request.post?
+      return(@app.call(env)) unless @request.path =~ %r{^/(?:(?:prompt|call)/([0-9a-f]{40}))|init$}
+      # return(@app.call(env)) unless @request.is_json_request?
+
+      @response = Rack::Response.new
+      @response['Content-Type'] = 'application/json'
+
+      if @request.path == '/init'
+        session = @driver.sessions.create
+        json 'id' => session.id, 'prompt' => session.prompt
+      elsif @request.path =~ %r{/prompt/([0-9a-f]{40})}
+        id      = $1
+        session = @driver.sessions[id]
+        json 'id' => session.id, 'prompt' => session.prompt
+      elsif @request.path =~ %r{/call/([0-9a-f]{40})}
+        id      = $1
+        session = @driver.sessions[id]
+
+        if command=@request.params['command']
+          _, _, output, error = session.call(command.force_encoding("UTF-8"))
+          json 'id' => session.id, 'prompt' => session.prompt, 'output' => output, 'error' => error
+        else
+          @response.status = 409
+          json 'id' => session.id, 'prompt' => session.prompt, 'error' => 'No command was given!'
+        end
+      end
+
+      return(@response.finish)
+    rescue
+      json 'id' => (session.id rescue nil), 'prompt' => (session.prompt rescue nil), 'error' => $!.message
+      return(@response.finish)
+    end
+
+    private
+
+    def json data
+      @response.write(data.to_json)
+    end
+  end
+
+  ##
+  #
+  # Cuttlebone::Driver::Rack::Application
+  #
+  # It's a fully functional rack-enabled application that serves all other
+  # materials for a fully functional Cuttlebone web server.
+  #
+  class Application
+
+    STATIC_FILES = %w{ /index.html /favicon.png /stylesheets/cuttlebone.css /javascripts/cuttlebone.js /javascripts/jquery.min.js }
+
+    def self.public_path path=''
+      File.expand_path("../../../../public/#{path}", __FILE__)
+    end
+
+    def call(env)
+      @request  = Rack::Request.new(env)
+      @response = Rack::Response.new
+
+      if @request.get? and @request.path == '/'
+        redirect_to '/index.html'
+      elsif @request.get? and STATIC_FILES.include?(@request.path)
+        static @request.path
+      else
+        error 'Not found.', 404
+      end
+
+      @response.finish
+    end
+
+    private
+
+    def static path
+      @response.write(File.read(File.expand_path("../../../../public#{path}", __FILE__)))
+    end
+
+    def error message, status=500
+      @response.write(File.read(File.expand_path("../../../../public/error.html", __FILE__)).gsub(/Error happens.  It always does./, message))
+      @response.status = status
+    end
+
+    def redirect_to path
+      @response.redirect(path)
+    end
+  end
+
+  ##
+  #
+  # Starts Cuttlebone Rack application.
+  #
+  def run
+    trap(:INT) do
+      if server.respond_to?(:shutdown)
+        server.shutdown
+      else
+        exit
+      end
+    end
+    server.run app, :Host=>'0.0.0.0', :Port=>9292
+  end
+
+  private
+
+  ##
+  #
+  # Builds Rack application stack.
+  #
+  # @return Rack::Application
+  #
+  def app
+    driver = self
+    Rack::Builder.app do
+      use Rack::ShowExceptions
+      use Rack::Lint
+      use Rack::ContentType
+      use Rack::ContentLength
+      use Rack::Session::Pool, :expire_after => 2592000
+      use Middleware, driver
+      run Application.new
+    end
+  end
+
+  ##
+  #
+  # Returns a Rack server.
+  #
+  def server
+    @server ||= ::Rack::Handler.default()
+  end
+end

data/lib/cuttlebone/{session → drivers}/shell.rb

@@ -1,14 +1,15 @@
 # TODO FIXME load readline iff it was invoked through command line interface
 require 'readline'
 
-class Cuttlebone::Session::Shell < Cuttlebone::Session::Base
+class Cuttlebone::Drivers::Shell < Cuttlebone::Drivers::Base
   def run
+    session = Cuttlebone::Session.sessions.create
     loop do
-      break if terminated?
-      command = Readline::readline("#{prompt} > ")
+      break if session.terminated?
+      command = Readline::readline("#{session.prompt} > ")
       break unless command
       Readline::HISTORY.push(command)
-      _, _, output, error = call(command)
+      _, _, output, error = session.call(command)
       print (output<<'').join("\n")
       print "\033[01;31m#{error}\033[00m\n" if error
     end

data/lib/cuttlebone/session.rb

@@ -1,4 +1,91 @@
-module Cuttlebone::Session
-  autoload :Base, 'cuttlebone/session/base'
-  autoload :Shell, 'cuttlebone/session/shell'
+require 'digest/sha1'
+
+class Cuttlebone::Session
+  
+  # TODO FIXME locking / mutexes / serialization / deserialization
+  class NotFound < StandardError; end
+
+  @@sessions = {}
+
+  @@default_stack_objects = []
+
+  module SessionCollectionExtensions
+    def [] key
+      raise NotFound unless has_key?(key)
+      super(key)
+    end
+
+    def create *stack_objects
+      s = Cuttlebone::Session.new(*stack_objects)
+      send(:[]=, s.id, s)
+      s
+    end
+  end
+
+  @@sessions.extend SessionCollectionExtensions
+
+  def self.set_default *stack_objects
+    @@default_stack_objects = stack_objects
+  end
+
+  def self.sessions
+    @@sessions
+  end
+
+  def initialize *stack_objects
+    options  = stack_objects.extract_options!
+    @id      = options[:id] || Digest::SHA1.hexdigest(Time.now.to_s + Time.now.usec.to_s + rand(1000).to_s) # TODO FIXME
+    @@default_stack_objects.each { |so| stack_objects << (so.dup rescue so) } if stack_objects.empty?
+    @stack ||= stack_objects.map{ |o| Cuttlebone::Controller.new(self, o) }
+  rescue Cuttlebone::InvalidContextError => e
+    @internal_error = %{Context initialization failed for #{e.context.inspect}!}
+  rescue => e
+    @internal_error = %{Internal error occured: #{e.message} (#{e.class})}
+  ensure
+    @stack ||= []
+  end
+
+  attr_reader :id, :stack, :internal_error
+
+  def active_context
+    stack.last
+  end
+
+  delegate :name, :prompt, :to => :active_context
+
+  def call command
+    process command
+  end
+
+  def terminated?
+    stack.empty?
+  end
+
+  private
+
+  def process command
+    active_context = stack.pop
+
+    action, next_context, output, error = begin
+                                            a, n, o, e = active_context.process(command)
+                                            raise ArgumentError, "Unknown action: #{a}" unless [ :self, :replace, :add, :drop ].include?(a.to_s.to_sym)
+                                            raise TypeError, "Output must be an instance of String or nil!" unless o.is_a?(Array) or o.nil?
+                                            raise TypeError, "Error must be an instance of String or nil!" unless e.is_a?(String) or e.nil?
+                                            [ a.to_s.to_sym, n, o, e ]
+                                          rescue => e
+                                            [ :self, active_context, nil, %{Cuttlebone::Session: #{e.message} (#{e.class})} ]
+                                          end
+    case action
+    when :self
+      stack << active_context
+    when :replace
+      stack << Cuttlebone::Controller.new(self, next_context)
+    when :add
+      stack << active_context << Cuttlebone::Controller.new(self, next_context)
+    when :drop
+      # noop
+    end
+    [ action, next_context, output, error ]
+  end
+
 end

data/lib/cuttlebone/version.rb

@@ -1,3 +1,3 @@
 module Cuttlebone
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/cuttlebone.rb

@@ -8,11 +8,17 @@ module Cuttlebone
   autoload :Definition, 'cuttlebone/definition'
   autoload :Session,    'cuttlebone/session'
 
+  module Drivers
+    autoload :Base,  'cuttlebone/drivers/base'
+    autoload :Shell, 'cuttlebone/drivers/shell'
+    autoload :Rack,  'cuttlebone/drivers/rack'
+  end
+
   @@definitions = []
   def self.definitions; @@definitions; end
 
-  def self.run starting_objects, default_driver=Session::Shell
-    default_driver.new(starting_objects).run
+  def self.run stack_objects, default_driver=Drivers::Shell
+    default_driver.new(stack_objects).run
   end
 end
 

data/public/error.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Cuttlebone - Error</title>
+<link href='/stylesheets/cuttlebone.css?1301248065' rel='stylesheet' type='text/css'>
+</head>
+<body>
+<div class='output'>
+<ul>
+<li class='error'>Error happens.  It always does.</li>
+</ul>
+</div>
+<div class='actions'>
+<ul>
+<li>
+<a href='/'>back to console</a>
+</li>
+</ul>
+</div>
+</body>
+</html>

data/public/index.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Cuttlebone</title>
+<link href='/favicon.png?1301248065' rel='icon' type='image/png'>
+<link href='/stylesheets/cuttlebone.css?1301248065' rel='stylesheet' type='text/css'>
+<script src='/javascripts/jquery.min.js?1301248065' type='text/javascript'></script>
+<script src='/javascripts/cuttlebone.js?1301248065' type='text/javascript'></script>
+</head>
+<body>
+<div class='output'>
+<ul></ul>
+</div>
+<div class='input'>
+<span id='prompt'></span>
+<span>&gt;</span>
+<input id='input' name='command' type='text'>
+</div>
+</body>
+</html>

data/public/javascripts/cuttlebone.js

@@ -0,0 +1,41 @@
+// I know that it's ugly, but this is a POC/WIP project.
+// TODO:
+// * get rid of that global variable
+// * #input should determine (with a special html5 attribute) which session
+//   will it talk to
+// * #input should know about the updated output too
+// * create a convenience function that sets up and handles all the magic
+
+var cuttlebone_session_id;
+
+jQuery(document).ready(function(){
+  // updates prompt
+  jQuery.ajax({type:'POST',url:"/init",dataType:"json",success:function(d){if(d['id']){cuttlebone_session_id=d['id'];};if(d['prompt']){jQuery('#prompt').html(d['prompt']);};}});
+});
+
+// evaluates input
+jQuery("#input").live("keypress", function(e) {
+  if (e.keyCode == 13) {
+    jQuery.ajax({
+      type:     "POST",
+      url:      "/call/"+cuttlebone_session_id,
+      data:     {command:jQuery('#input').val()},
+      dataType: "json",
+      success:  function(d){
+        if (d['output']) {
+          jQuery.each(d['output'], function(i,v) {
+            jQuery('.output ul').append('<li><pre>'+v+'</pre></li>');
+          });
+        };
+        if (d['error']) {
+          jQuery('.output ul').append('<li class="error">'+d['error']+'</li>');
+        };
+        if (d['prompt']) {
+          jQuery('#prompt').html(d['prompt']);
+        }
+      }
+    });
+    $(this).val('');
+  };
+});
+