cramp 0.13 → 0.14

data/bin/cramp

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'cramp'
+require 'cramp/generators/application'
+
+if ['--version', '-v'].include?(ARGV.first)
+  puts "Cramp #{Cramp::VERSION}"
+  exit(0)
+end
+
+if ARGV.first != "new"
+  ARGV[0] = "--help"
+else
+  ARGV.shift
+end
+
+Cramp::Generators::Application.start

data/lib/cramp.rb

@@ -19,7 +19,7 @@ if RUBY_VERSION >= '1.9.1'
 end
   
 module Cramp
-  VERSION = '0.13'
+  VERSION = '0.14'
 
   mattr_accessor :logger
 

data/lib/cramp/abstract.rb

@@ -10,12 +10,14 @@ module Cramp
 
     class << self
       def call(env)
-        controller = new(env).process
+        new(env).process
       end
     end
 
     def initialize(env)
       @env = env
+      @env['websocket.receive_callback'] = method(:_on_data_receive)
+
       @finished = false
     end
 

data/lib/cramp/action.rb

@@ -51,10 +51,19 @@ module Cramp
       @body.call(result)
     end
 
+    def render_websocket(body, *)
+      data = ["\x00", body, "\xFF"].map(&method(:encode)) * ''
+      @body.call(data)
+    end
+
     # Used by SSE
     def sse_event_id
       @sse_event_id ||= Time.now.to_i
     end
 
+    def encode(string, encoding = 'UTF-8')
+      string.respond_to?(:force_encoding) ? string.force_encoding(encoding) : string
+    end
+
   end
 end

data/lib/cramp/callbacks.rb

@@ -4,10 +4,12 @@ module Cramp
     extend ActiveSupport::Concern
 
     included do
-      class_inheritable_accessor :before_start_callbacks, :on_finish_callbacks, :on_start_callback, :instance_reader => false
+      class_inheritable_accessor :before_start_callbacks, :on_finish_callbacks, :on_start_callback, :on_data_callbacks, :instance_reader => false
+
       self.before_start_callbacks = []
       self.on_finish_callbacks = []
       self.on_start_callback = []
+      self.on_data_callbacks = []
     end
 
     module ClassMethods
@@ -22,6 +24,10 @@ module Cramp
       def on_start(*methods)
         self.on_start_callback += methods
       end
+
+      def on_data(*methods)
+        self.on_data_callbacks += methods
+      end
     end
 
     def before_start(n = 0)
@@ -50,5 +56,14 @@ module Cramp
       EM.next_tick { yield }
     end
 
+    def _on_data_receive(data)
+      data = data.split(/\000([^\377]*)\377/).select{|d| !d.empty? }.collect{|d| d.gsub(/^\x00|\xff$/, '') }
+      self.class.on_data_callbacks.each do |callback|
+        data.each do |message|
+          EM.next_tick { send(callback, message) }
+        end
+      end
+    end
+
   end
 end

data/lib/cramp/generators/application.rb

@@ -0,0 +1,97 @@
+require 'thor/group'
+require 'active_support/core_ext/string/strip'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/blank'
+
+module Cramp
+  module Generators
+
+    class Application < Thor::Group
+      include Thor::Actions
+
+      argument :application_path, :type => :string
+      class_option :with_active_record, :type => :boolean, :aliases => "-M", :default => false, :desc => "Configures Active Record"
+
+      def initialize(*args)
+        raise Thor::Error, "No application name supplied. Please run: cramp --help" if args[0].blank?
+
+        super
+      end
+
+      def self.source_root
+        @_source_root ||= File.join(File.dirname(__FILE__), "templates/application")
+      end
+
+      def self.banner
+        "cramp new #{self.arguments.map(&:usage).join(' ')} [options]"
+      end
+
+      def create_root
+        self.destination_root = File.expand_path(application_path, destination_root)
+        valid_const?
+
+        empty_directory '.'
+        FileUtils.cd(destination_root)
+      end
+
+      def create_root_files
+        template 'config.ru'
+        template 'Gemfile'
+        template 'application.rb'
+
+        empty_directory "public"
+        empty_directory "public/javascripts"
+      end
+
+      def create_config
+        empty_directory "config"
+
+        inside "config" do
+          template "routes.rb"
+          template 'database.yml' if active_record?
+        end
+      end
+
+      def create_home_action
+        empty_directory "app/actions"
+
+        inside "app/actions" do
+          template "home_action.rb"
+        end
+      end
+
+      def create_models
+        if active_record?
+          empty_directory "app/models"
+        end
+      end
+
+      protected
+
+      def active_record?
+        options[:with_active_record]
+      end
+
+      def app_name
+        @app_name ||= File.basename(destination_root)
+      end
+
+      def app_const
+        @app_const ||= "#{app_const_base}::Application"
+      end
+
+      def app_const_base
+        @app_const_base ||= app_name.gsub(/\W/, '_').squeeze('_').camelize
+      end
+
+      def valid_const?
+        if app_const =~ /^\d/
+          raise Thor::Error, "Invalid application name #{app_name}. Please give a name which does not start with numbers."
+        elsif Object.const_defined?(app_const_base)
+          raise Thor::Error, "Invalid application name #{app_name}, constant #{app_const_base} is already in use. Please choose another application name."
+        end
+      end
+    end
+
+  end
+end

data/lib/cramp/generators/templates/application/Gemfile

@@ -0,0 +1,32 @@
+source :rubygems
+
+gem 'cramp'
+
+# Async webserver for running a cramp application
+gem 'thin'
+
+# Rack based routing
+gem 'http_router'
+
+# Collection of async-proof rack middlewares - https://github.com/rkh/async-rack.git
+gem 'async-rack'
+
+# For async Active Record models
+<% if active_record? -%>
+gem 'mysql2', '~> 0.2.11'
+gem 'activerecord'
+<% else -%>
+# gem 'mysql2', '~> 0.2.11'
+# gem 'activerecord'
+<% end -%>
+
+# Using Fibers + async callbacks to emulate synchronous programming
+# gem 'em-synchrony'
+
+# Generic interface to multiple Ruby template engines - https://github.com/rtomayko/tilt
+# gem 'tilt'
+
+group :development do
+  # Development gems
+  # gem 'ruby-debug19'
+end

data/lib/cramp/generators/templates/application/app/actions/home_action.rb

@@ -0,0 +1,11 @@
+class HomeAction < Cramp::Action
+  <% if active_record? -%>use_fiber_pool do |pool|
+    # Checkin database connection after each callback
+    pool.generic_callbacks << proc { ActiveRecord::Base.clear_active_connections! }
+  end
+
+  <% end %>def start
+    render "Hello World!"
+    finish
+  end
+end

data/lib/cramp/generators/templates/application/application.rb

@@ -0,0 +1,36 @@
+require "rubygems"
+require "bundler"
+
+module <%= app_const_base %>
+  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('./config/routes.rb'))
+    end
+
+    <% if active_record? %>def self.database_config
+      @_database_config ||= YAML.load(File.read('./config/database.yml')).with_indifferent_access
+    end
+
+    <% end %># Initialize the application
+    def self.initialize!<% if active_record? %>
+      ActiveRecord::Base.configurations = <%= app_const %>.database_config
+      ActiveRecord::Base.establish_connection(<%= app_const %>.env)<% end %>
+    end
+
+  end
+end
+
+Bundler.require(:default, <%= app_const %>.env)
+
+# Preload application classes
+Dir['./app/**/*.rb'].each {|f| require f}

data/lib/cramp/generators/templates/application/config.ru

@@ -0,0 +1,25 @@
+require './application'
+<%= app_const %>.initialize!
+
+# Development middlewares
+if <%= app_const %>.env == 'development'
+  use AsyncRack::CommonLogger
+
+  # Enable code reloading on every request
+  use Rack::Reloader, 0
+
+  # Serve assets from /public
+  use Rack::Static, :urls => ["/javascripts"], :root => <%= app_const %>.root(:public)
+end
+
+# Running thin :
+#
+#   bundle exec thin --max-persistent-conns 1024 --timeout 0 -R config.ru start
+#
+# Vebose mode :
+#
+#   Very useful when you want to view all the data being sent/received by thin
+#
+#   bundle exec thin --max-persistent-conns 1024 --timeout 0 -V -R config.ru start
+#
+run <%= app_const %>.routes

data/lib/cramp/generators/templates/application/config/database.yml

@@ -0,0 +1,6 @@
+development:
+  adapter: em_mysql2
+  database: <%= app_name %>_development
+  host: localhost
+  username: root
+  pool: 100

data/lib/cramp/generators/templates/application/config/routes.rb

@@ -0,0 +1,4 @@
+# Check out https://github.com/joshbuddy/http_router for more information on HttpRouter
+HttpRouter.new do
+  add('/').to(HomeAction)
+end

data/lib/cramp/websocket.rb

@@ -1,47 +1,12 @@
 module Cramp
-  class Websocket < Abstract
-    include PeriodicTimer
-
-    # TODO : Websockets shouldn't need this in an ideal world
-    include KeepConnectionAlive
-
-    class_inheritable_accessor :on_data_callbacks, :instance_reader => false
-    self.on_data_callbacks = []
+  class Websocket < Action
+    self.transport = :websocket
 
     class << self
       def backend=(backend)
         raise "Websocket backend #{backend} is unknown" unless [:thin, :rainbows].include?(backend.to_sym)
         require "cramp/websocket/#{backend}_backend.rb"
       end
-
-      def on_data(*methods)
-        self.on_data_callbacks += methods
-      end
-    end
-
-    def process
-      @env['websocket.receive_callback'] = method(:_on_data_receive)
-      super
-    end
-
-    def render(body)
-      data = ["\x00", body, "\xFF"].map(&method(:encode)) * ''
-      @body.call(data)
-    end
-
-    def _on_data_receive(data)
-      data = data.split(/\000([^\377]*)\377/).select{|d| !d.empty? }.collect{|d| d.gsub(/^\x00|\xff$/, '') }
-      self.class.on_data_callbacks.each do |callback|
-        data.each do |message|
-          EM.next_tick { send(callback, message) }
-        end
-      end
-    end
-
-    protected
-
-    def encode(string, encoding = 'UTF-8')
-      string.respond_to?(:force_encoding) ? string.force_encoding(encoding) : string
     end
 
   end

data/lib/cramp/websocket/rainbows.rb

@@ -0,0 +1,44 @@
+class Cramp::Websocket::Rainbows < Rainbows::EventMachine::Client
+  include Cramp::WebsocketExtension
+
+  def receive_data(data)
+    case @state
+    when :websocket
+      callback = @env[WEBSOCKET_RECEIVE_CALLBACK]
+      callback.call(data) if callback
+    else
+      super
+    end
+  end
+
+  def on_read(data)
+    if @state == :headers
+      @hp.add_parse(data) or return want_more
+      @state = :body
+      if 0 == @hp.content_length && !websocket?
+        app_call NULL_IO # common case
+      else # nil or len > 0
+        prepare_request_body
+      end
+    elsif @state == :body && websocket? && @hp.body_eof?
+      @state = :websocket
+      @input.rewind
+
+      handler = @env['HTTP_SEC_WEBSOCKET_KEY1'] &&
+                @env['HTTP_SEC_WEBSOCKET_KEY2'] ? Protocol76 : Protocol75
+      write(handler.new(@env, websocket_url, @buf).handshake)
+      app_call NULL_IO
+    else
+      super
+    end
+  rescue => e
+    handle_error(e)
+  end
+
+  def write_response(status, headers, body, alive)
+    write_headers(status, headers, alive) unless websocket?
+    write_body_each(body)
+  ensure
+    body.close if body.respond_to?(:close)
+  end
+end

data/lib/cramp/websocket/rainbows_backend.rb

@@ -1,40 +1,8 @@
-require 'rainbows'
-
-class Rainbows::EventMachine::Client
-  include Cramp::WebsocketExtension
-
-  def websocket_handshake!
-    @state = :websocket
-  end
-
-  def receive_data_with_websocket(data)
-    case @state
-    when :websocket
-      callback = @env[WEBSOCKET_RECEIVE_CALLBACK]
-      callback.call(data) if callback
-    else
-      receive_data_without_websocket(data)
-    end
-  end
-
-  alias_method_chain :receive_data, :websocket
-end
-
-class Rainbows::HttpResponse
-  class << self
-
-    def write_with_magic(socket, rack_response, out = [])
-      if socket.websocket?
-        socket.write socket.websocket_upgrade_data
-        socket.websocket_handshake!
-
-        out = nil # To make sure Rainbows! doesn't send back regular HTTP headers
-      end
-
-      write_without_magic(socket, rack_response, out)
-    end
-
-    alias_method_chain :write, :magic
-  end
-
+# :enddoc:
+require "rainbows"
+class Cramp::Websocket
+  # we use autoload since Rainbows::EventMachine::Client should only be
+  # loaded in the worker proceses and we want to be preload_app-friendly
+  autoload :Rainbows, "cramp/websocket/rainbows"
 end
+Rainbows::O[:em_client_class] = "Cramp::Websocket::Rainbows"

metadata

@@ -1,85 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cramp
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: '0.14'
   prerelease: 
-  segments: 
-  - 0
-  - 13
-  version: "0.13"
 platform: ruby
-authors: 
+authors:
 - Pratik Naik
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-31 00:00:00 +01:00
+date: 2011-08-05 00:00:00.000000000 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156676820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 3
-        - 0
-        - 9
+      - !ruby/object:Gem::Version
         version: 3.0.9
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rack
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156676820
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2156676220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
+      - !ruby/object:Gem::Version
+        version: 1.3.2
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2156676220
+- !ruby/object:Gem::Dependency
   name: eventmachine
+  requirement: &2156675640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.3
+  type: :runtime
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2156675640
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &2156674960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 12
-        - 10
-        version: 0.12.10
+      - !ruby/object:Gem::Version
+        version: 0.14.6
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2156674960
 description: Cramp is a framework for developing asynchronous web applications.
 email: pratiknaik@gmail.com
-executables: []
-
+executables:
+- cramp
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - MIT-LICENSE
 - lib/cramp/abstract.rb
 - lib/cramp/action.rb
 - lib/cramp/body.rb
 - lib/cramp/callbacks.rb
 - lib/cramp/fiber_pool.rb
+- lib/cramp/generators/application.rb
+- lib/cramp/generators/templates/application/app/actions/home_action.rb
+- lib/cramp/generators/templates/application/application.rb
+- lib/cramp/generators/templates/application/config/database.yml
+- lib/cramp/generators/templates/application/config/routes.rb
+- lib/cramp/generators/templates/application/config.ru
+- lib/cramp/generators/templates/application/Gemfile
 - lib/cramp/keep_connection_alive.rb
 - lib/cramp/long_polling.rb
 - lib/cramp/periodic_timer.rb
@@ -87,44 +83,36 @@ files:
 - lib/cramp/sse.rb
 - lib/cramp/test_case.rb
 - lib/cramp/websocket/extension.rb
+- lib/cramp/websocket/rainbows.rb
 - lib/cramp/websocket/rainbows_backend.rb
 - lib/cramp/websocket/thin_backend.rb
 - lib/cramp/websocket.rb
 - lib/cramp.rb
 - lib/vendor/fiber_pool.rb
-has_rdoc: true
+- bin/cramp
+has_rdoc: false
 homepage: http://m.onkey.org
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Asynchronous web framework.
 test_files: []
-