RubyGems - webmachine - Versions diffs - 0.3.0 → 0.4.0 - Mend

webmachine 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

data/Gemfile +12 -10
data/Guardfile +1 -1
data/README.md +1 -1
data/examples/application.rb +35 -0
data/lib/webmachine.rb +4 -3
data/lib/webmachine/adapter.rb +36 -0
data/lib/webmachine/adapters/mongrel.rb +18 -12
data/lib/webmachine/adapters/rack.rb +26 -7
data/lib/webmachine/adapters/webrick.rb +20 -16
data/lib/webmachine/application.rb +108 -0
data/lib/webmachine/chunked_body.rb +2 -2
data/lib/webmachine/configuration.rb +24 -14
data/lib/webmachine/decision/conneg.rb +9 -10
data/lib/webmachine/decision/flow.rb +25 -28
data/lib/webmachine/decision/fsm.rb +21 -22
data/lib/webmachine/decision/helpers.rb +3 -3
data/lib/webmachine/dispatcher.rb +18 -10
data/lib/webmachine/dispatcher/route.rb +54 -17
data/lib/webmachine/errors.rb +1 -1
data/lib/webmachine/headers.rb +2 -2
data/lib/webmachine/media_type.rb +2 -2
data/lib/webmachine/request.rb +78 -3
data/lib/webmachine/resource.rb +3 -2
data/lib/webmachine/resource/authentication.rb +4 -3
data/lib/webmachine/resource/callbacks.rb +4 -3
data/lib/webmachine/resource/encodings.rb +4 -3
data/lib/webmachine/response.rb +3 -2
data/lib/webmachine/streaming.rb +4 -4
data/lib/webmachine/version.rb +1 -1
data/spec/webmachine/adapter_spec.rb +40 -0
data/spec/webmachine/adapters/mongrel_spec.rb +22 -0
data/spec/webmachine/adapters/rack_spec.rb +34 -8
data/spec/webmachine/adapters/webrick_spec.rb +18 -0
data/spec/webmachine/application_spec.rb +73 -0
data/spec/webmachine/dispatcher/route_spec.rb +59 -2
data/spec/webmachine/dispatcher_spec.rb +17 -5
data/spec/webmachine/request_spec.rb +158 -1
data/webmachine.gemspec +6 -27
metadata +304 -112
data/spec/tests.org +0 -80

data/Gemfile CHANGED Viewed

@@ -6,20 +6,22 @@ gemspec
 gem 'bundler'
-unless ENV['TRAVIS']
+group :guard do
   gem 'guard-rspec'
+  case RbConfig::CONFIG['host_os']
+  when /darwin/
+    gem 'rb-fsevent'
+    # gem 'growl_notify'
+    gem 'growl'
+  when /linux/
+    gem 'rb-inotify'
+    gem 'libnotify'
+  end
+end
+group :docs do
   platform :mri do
     gem 'redcarpet'
-    case RbConfig::CONFIG['host_os']
-    when /darwin/
-      gem 'rb-fsevent'
-      gem 'growl_notify'
-    when /linux/
-      gem 'rb-inotify'
-      gem 'libnotify'
-    end
   end
 end

data/Guardfile CHANGED Viewed

@@ -1,7 +1,7 @@
 gemset = ENV['RVM_GEMSET'] || 'webmachine'
 gemset = "@#{gemset}" unless gemset.to_s == ''
-rvms = %W[ 1.8.7 1.9.2 jruby rbx ].map {|v| "#{v}#{gemset}" }
+rvms = %W[ 1.8.7 1.9.2 1.9.3 jruby rbx ].map {|v| "#{v}#{gemset}" }
 guard 'rspec', :cli => "--color --profile", :growl => true, :rvm => rvms do
   watch(%r{^lib/webmachine/locale/.+$}) { "spec" }

data/README.md CHANGED Viewed

@@ -17,7 +17,7 @@ Webmachine has a Rack adapter -- thanks to Jamis Buck -- but when
 using it, we recommend you ensure that NO middleware is used.  The
 behaviors that are encapsulated in Webmachine could be broken by
 middlewares that sit above it, and there is no way to detect them at
-runtime. _Caveat emptor_. That said, Webmachine should behave properly
+runtime. _Caveat implementor_. That said, Webmachine should behave properly
 when given a clear stack.
 ## Getting Started

data/examples/application.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require 'webmachine'
+class RouteDebugResource < Webmachine::Resource
+  def to_html
+    <<-HTML
+      <html>
+        <head><title>Test from Webmachine</title></head>
+        <body>
+          <h5>request.disp_path</h5>
+          <pre>#{request.disp_path}</pre>
+          <h5>request.path_info</h5>
+          <pre>#{request.path_info}</pre>
+          <h5>request.path_tokens</h5>
+          <pre>#{request.path_tokens}</pre>
+        </body>
+      </html>
+    HTML
+  end
+end
+MyApp = Webmachine::Application.new do |app|
+  # Configure your app like this:
+  app.configure do |config|
+    config.port = 8888
+    config.adapter = :WEBrick
+  end
+  # And add routes like this:
+  app.add_route ['fizz', :buzz, '*'], RouteDebugResource
+  # OR add routes this way:
+  app.routes do
+    add [:test, :foo, '*'], RouteDebugResource
+  end
+end
+MyApp.run

data/lib/webmachine.rb CHANGED Viewed

@@ -5,17 +5,18 @@ require 'webmachine/response'
 require 'webmachine/errors'
 require 'webmachine/decision'
 require 'webmachine/streaming'
+require 'webmachine/adapter'
 require 'webmachine/adapters'
 require 'webmachine/dispatcher'
+require 'webmachine/application'
 require 'webmachine/resource'
 require 'webmachine/version'
 # Webmachine is a toolkit for making well-behaved HTTP applications.
 # It is based on the Erlang library of the same name.
 module Webmachine
-  # Starts Webmachine serving requests
+  # Starts Webmachine's default global Application serving requests
   def self.run
-    configure unless configuration
-    Adapters.const_get(configuration.adapter).run
+    application.run
   end
 end

data/lib/webmachine/adapter.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module Webmachine
+  # The abstract class for definining a Webmachine adapter.
+  #
+  # @abstract Subclass and override {#run} to implement a custom adapter.
+  class Adapter
+    # @return [Webmachine::Configuration] the application's configuration.
+    attr_reader :configuration
+    # @return [Webmachine::Dispatcher] the application's dispatcher.
+    attr_reader :dispatcher
+    # @param [Webmachine::Configuration] configuration the application's
+    # configuration.
+    # @param [Webmachine::Dispatcher] dispatcher the application's dispatcher.
+    def initialize(configuration, dispatcher)
+      @configuration = configuration
+      @dispatcher    = dispatcher
+    end
+    # Create a new adapter and run it.
+    def self.run(configuration, dispatcher)
+      new(configuration, dispatcher).run
+    end
+    # Start the adapter.
+    #
+    # @abstract Subclass and override {#run} to implement a custom adapter.
+    # @raise [NotImplementedError]
+    def run
+      raise NotImplementedError
+    end
+  end
+end

data/lib/webmachine/adapters/mongrel.rb CHANGED Viewed

@@ -9,17 +9,17 @@ require 'webmachine/chunked_body'
 module Webmachine
   module Adapters
     # Connects Webmachine to Mongrel.
-    module Mongrel
+    class Mongrel < Adapter
       # Starts the Mongrel adapter
-      def self.run
-        c = Webmachine.configuration
+      def run
         options = {
-          :port => c.port,
-          :host => c.ip
-        }.merge(c.adapter_options)
+          :port => configuration.port,
+          :host => configuration.ip
+        }.merge(configuration.adapter_options)
         config = ::Mongrel::Configurator.new(options) do
           listener do
-            uri '/', :handler => Webmachine::Adapters::Mongrel::Handler.new
+            uri '/', :handler => Webmachine::Adapters::Mongrel::Handler.new(dispatcher)
           end
           trap("INT") { stop }
           run
@@ -29,6 +29,11 @@ module Webmachine
       # A Mongrel handler for Webmachine
       class Handler < ::Mongrel::HttpHandler
+        def initialize(dispatcher)
+          @dispatcher = dispatcher
+          super
+        end
         # Processes an individual request from Mongrel through Webmachine.
         def process(wreq, wres)
           header = Webmachine::Headers.from_cgi(wreq.params)
@@ -39,7 +44,7 @@ module Webmachine
                                             wreq.body || StringIO.new(''))
           response = Webmachine::Response.new
-          Webmachine::Dispatcher.dispatch(request, response)
+          @dispatcher.dispatch(request, response)
           begin
             wres.status = response.code.to_i
@@ -74,7 +79,8 @@ module Webmachine
             response.body.close if response.body.respond_to? :close
           end
         end
-      end
-    end
-  end
-end
+      end # class Handler
+    end # module Mongrel
+  end # module Adapters
+end # module Webmachine

data/lib/webmachine/adapters/rack.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-require 'rack/request'
+require 'rack'
 require 'webmachine/version'
 require 'webmachine/headers'
 require 'webmachine/request'
@@ -19,11 +19,29 @@ module Webmachine
     #     # put your own Webmachine resources in another file:
     #     require 'my/resources'
     #
-    #     run Webmachine::Adapters::Rack.new
+    #     run MyApplication.adapter
     #
     # Servers like pow and unicorn will read config.ru by default and it should
     # all "just work".
-    class Rack
+    #
+    # And for development or testing your application can be run with Rack's
+    # builtin Server identically to the Mongrel and WEBrick adapters with:
+    #
+    #     MyApplication.run
+    #
+    class Rack < Adapter
+      # Start the Rack adapter
+      def run
+        options = {
+          :app => self,
+          :Port => configuration.port,
+          :Host => configuration.ip
+        }.merge(configuration.adapter_options)
+        ::Rack::Server.start(options)
+      end
       # Handles a Rack-based request.
       # @param [Hash] env the Rack environment
       def call(env)
@@ -36,7 +54,7 @@ module Webmachine
                                           rack_req.body)
         response = Webmachine::Response.new
-        Webmachine::Dispatcher.dispatch request, response
+        @dispatcher.dispatch(request, response)
         response.headers['Server'] = [Webmachine::SERVER_STRING, "Rack/#{::Rack.version}"].join(" ")
@@ -45,6 +63,7 @@ module Webmachine
         [response.code.to_i, response.headers, body || []]
       end
-    end
-  end
-end
+    end # class Rack
+  end # module Adapters
+end # module Webmachine

data/lib/webmachine/adapters/webrick.rb CHANGED Viewed

@@ -8,21 +8,26 @@ require 'webmachine/dispatcher'
 module Webmachine
   module Adapters
     # Connects Webmachine to WEBrick.
-    module WEBrick
+    class WEBrick < Adapter
       # Starts the WEBrick adapter
-      def self.run
-        c = Webmachine.configuration
+      def run
         options = {
-          :Port => c.port,
-          :BindAddress => c.ip
-        }.merge(c.adapter_options)
-        server = Webmachine::Adapters::WEBrick::Server.new options
+          :Port => configuration.port,
+          :BindAddress => configuration.ip
+        }.merge(configuration.adapter_options)
+        server = Webmachine::Adapters::WEBrick::Server.new(dispatcher, options)
         trap("INT"){ server.shutdown }
         Thread.new { server.start }.join
       end
       # WEBRick::HTTPServer that is run by the WEBrick adapter.
       class Server < ::WEBrick::HTTPServer
+        def initialize(dispatcher, options)
+          @dispatcher = dispatcher
+          super(options)
+        end
         # Handles a request
         def service(wreq, wres)
           header = Webmachine::Headers.new
@@ -32,11 +37,9 @@ module Webmachine
                                             header,
                                             RequestBody.new(wreq))
           response = Webmachine::Response.new
-          Webmachine::Dispatcher.dispatch(request, response)
+          @dispatcher.dispatch(request, response)
           wres.status = response.code.to_i
-          response.headers.each do |k,v|
-            wres[k] = v
-          end
+          response.headers.each { |k,v| wres[k] = v }
           wres['Server'] = [Webmachine::SERVER_STRING, wres.config[:ServerSoftware]].join(" ")
           case response.body
           when String
@@ -51,7 +54,7 @@ module Webmachine
             end
           end
         end
-      end
+      end # class Server
       # Wraps the WEBrick request body so that it can be passed to
       # {Request} while still lazily evaluating the body.
@@ -79,7 +82,8 @@ module Webmachine
             @request.body {|chunk| @value << chunk; yield chunk }
           end
         end
-      end
-    end
-  end
-end
+      end # class RequestBody
+    end # module WEBrick
+  end # module Adapters
+end # module Webmachine

data/lib/webmachine/application.rb ADDED Viewed

@@ -0,0 +1,108 @@
+require 'forwardable'
+require 'webmachine/configuration'
+require 'webmachine/dispatcher'
+module Webmachine
+  # How to get your Webmachine app running:
+  #
+  #   MyApp = Webmachine::Application.new do |app|
+  #     app.routes do
+  #       add ['*'], AssetResource
+  #     end
+  #
+  #     app.configure do |config|
+  #       config.port = 8888
+  #     end
+  #   end
+  #
+  #   MyApp.run
+  #
+  class Application
+    extend Forwardable
+    def_delegators :dispatcher, :add_route
+    # @return [Configuration] the current configuration
+    attr_accessor :configuration
+    # @return [Dispatcher] the current dispatcher
+    attr_reader :dispatcher
+    # Create an Application instance
+    #
+    # An instance of application contains Adapter configuration and
+    # a Dispatcher instance which can be configured with Routes.
+    #
+    # @param [Webmachine::Configuration] configuration
+    #   a Webmachine::Configuration
+    #
+    # @yield [app]
+    #   a block in which to configure this Application
+    # @yieldparam [Application]
+    #   the Application instance being initialized
+    def initialize(configuration = Configuration.default)
+      @configuration = configuration
+      @dispatcher    = Dispatcher.new
+      yield self if block_given?
+    end
+    # Starts this Application serving requests
+    def run
+      adapter.run
+    end
+    # @return an instance of the configured web-server adapter
+    # @see Adapters
+    def adapter
+      @adapter ||= adapter_class.new(configuration, dispatcher)
+    end
+    # @return an instance of the configured web-server adapter
+    # @see Adapters
+    def adapter_class
+      Adapters.const_get(configuration.adapter)
+    end
+    # Evaluates the passed block in the context of {Webmachine::Dispatcher}
+    # for use in adding a number of routes at once.
+    #
+    # @return [Application, Array<Route>]
+    #   self if configuring, or an Array of Routes otherwise
+    #
+    # @see Webmachine::Dispatcher#add_route
+    def routes(&block)
+      if block_given?
+        dispatcher.instance_eval(&block)
+        self
+      else
+        dispatcher.routes
+      end
+    end
+    # Configure the web server adapter via the passed block
+    #
+    # Returns the receiver so you can chain it with Application#run
+    #
+    # @yield [config]
+    #   a block in which to set configuration values
+    # @yieldparam [Configuration]
+    #   config the Configuration instance
+    #
+    # @return [Application] self
+    def configure
+      yield configuration if block_given?
+      self
+    end
+    # @return [Configuration] the current configuration
+    def configuration
+      @configuration ||= Configuration.default
+    end
+  end
+  # @return [Application] the default global Application
+  def self.application
+    @application ||= Application.new
+  end
+end

data/lib/webmachine/chunked_body.rb CHANGED Viewed

@@ -39,5 +39,5 @@ module Webmachine
       end
       yield(FINAL_CHUNK)
     end
-  end
-end
+  end # class ChunkedBody
+end # module Webmachine