astaire 0.0.1 → 0.2.0

data/README.md

@@ -0,0 +1,72 @@
+## Astaire: The basic Sinatra DSL for your Rails 3 apps
+
+Astaire allows the use of the basic Sinatra get / post / put / delete
+DSL inside of Rails controllers. This allows defining quick actions without
+having to update config/routes.rb. For example:
+
+    class ContactController < ActionController::Base
+
+      get "/contact" do
+        render :contact_form
+      end
+
+      post "/contact" do
+        # handle form input
+        redirect_to homepage_path
+      end
+
+    end
+
+### Installation
+
+Add the following to your application's Gemfile
+
+    gem "astaire"
+
+Then, run `bundle install` and you are good to go.
+
+### Usage
+
+Currently, Astaire provides 4 class level methods available in  the
+controller: `#get`, `#post`, `#put`, and `#delete`. With these methods
+you can define actions and routes all at once.
+
+    class MyController < ActionController::Base
+
+        # Get the contact form
+        get "/contact" do
+          render :contact_form
+        end
+
+        # The paths can also have named parameters and
+        # optional segments
+        #
+        # /say/hello       => "I say: hello"
+        # /say/hello/world => "I say: hello world"
+        #
+        get "/say/:one(/:two)" do
+          words = [params[:one], params[:two]].compact.join(' ')
+          render :text => "I say: #{words}"
+        end
+    end
+
+It is possible to name actions such that regular URL helpers can generate them.
+
+    class MyController < ActionController::Base
+
+      # Will output /hello
+      def index
+        render :text => hello_path
+      end
+
+      get "/hello", :as => :hello do
+        render :text => "hello"
+      end
+
+    end
+
+### TODO
+
+I guess, at this point I'm just putting what I have into the wild. Next
+steps will be determined by feedback that I get. One thing that I would
+like to add is Sinatra's inline template feature.

data/lib/astaire/railtie.rb

@@ -0,0 +1,27 @@
+module Astaire
+  class Rails < Rails::Railtie
+    config.to_prepare do
+      ApplicationController.class_eval { include Astaire::DSL }
+    end
+
+    initializer "astaire.cascade_routing" do |app|
+      # A lambda is needed here to ensure that the constant is reloaded
+      # after each request (in development mode)
+      astaire_app = proc { |env| ApplicationController.call(env) }
+      app.middleware.use ActionDispatch::Cascade, lambda { astaire_app }
+    end
+
+    # Controllers must be preloaded in order for Astaire's routing
+    # to be hooked up
+    initializer "astaire.preload_controllers" do |app|
+      config.to_prepare do
+        app.config.paths.app.controllers.each do |load_path|
+          matcher = /\A#{Regexp.escape(load_path)}\/(.*)\.rb\Z/
+          Dir["#{load_path}/**/*_controller.rb"].each do |file|
+            require_dependency file.sub(matcher, '\1')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/astaire.rb

@@ -1,38 +1,93 @@
 require 'active_support/concern'
 require 'action_controller'
+require 'astaire/railtie' if defined?(Rails)
 
 module Astaire
   module DSL
     extend ActiveSupport::Concern
 
+    include AbstractController::Helpers
+
     included do
-      unless respond_to?(:_router)
-        def self._router
-          @_router ||= ActionDispatch::Routing::RouteSet.new
-        end
-      end
+      class_attribute :_astaire_router
+      self._astaire_router = ActionDispatch::Routing::RouteSet.new
+
+      class_attribute :_astaire_helpers
+      self._astaire_helpers = url_helper_module
+
+      include _astaire_helpers
+      helper _astaire_helpers
     end
 
     module ClassMethods
       def call(env)
-        _router.call(env)
-      rescue ActionController::RoutingError
-        [404, {'Content-Type' => 'text/html', 'X-Cascade' => 'pass'}, []]
+        _astaire_router.call(env)
       end
 
       def mapper
-        @mapper ||= ActionDispatch::Routing::Mapper.new(_router)
+        @mapper ||= ActionDispatch::Routing::Mapper.new(_astaire_router)
       end
 
       %w(get post put delete).each do |method|
         class_eval <<-R, __FILE__, __LINE__+1
           def #{method}(path, opts = {}, &blk)
-            action_name = "[#{method}] \#{path}"
-            define_method action_name, &blk
-            mapper.match(path, :via => '#{method}', :to => action(action_name))
+            map_astaire_action "#{method}", path, opts, blk
           end
         R
       end
+
+    private
+
+      def map_astaire_action(method, path, opts, blk)
+        action_name = "[#{method}] #{path}"
+        define_method action_name, &blk
+        opts.merge! :via => method, :to => action(action_name)
+
+        mapper.match(path, opts)
+        make_url_helper(opts[:as]) if opts[:as]
+      end
+
+      def url_helper_module
+        Module.new do
+          def _astaire_url_opts_from_args(name, route, args, only_path)
+            opts = args.extract_options!
+
+            if args.any?
+              opts[:_positional_args] = args
+              opts[:_positional_keys] = route.segment_keys
+            end
+
+            opts = url_options.merge(opts)
+            opts.merge!(:use_route => name, :only_path => only_path)
+
+            if path_segments = opts[:_path_segments]
+              path_segments.delete(:controller)
+              path_segments.delete(:action)
+            end
+
+            opts
+          end
+        end
+      end
+
+      def make_url_helper(name)
+        name   = name.to_sym
+        router = _astaire_router
+
+        _astaire_helpers.module_eval do
+          define_method "#{name}_path" do |*args|
+            route = router.named_routes[name]
+            opts  = _astaire_url_opts_from_args(name, route, args, true)
+            router.url_for(opts)
+          end
+
+          define_method "#{name}_url" do |*args|
+            route = router.named_routes[name]
+            opts  = _astaire_url_opts_from_args(name, route, args, false)
+            router.url_for(opts)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 2
   - 0
-  - 1
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Carl Lerche
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-01 00:00:00 -07:00
+date: 2010-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,8 +41,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.md
 - LICENSE
+- lib/astaire/railtie.rb
 - lib/astaire.rb
 has_rdoc: true
 homepage: http://github.com/carllerche/astaire

data/README

@@ -1,3 +0,0 @@
-A first pass at the basic Sinatra DSL inside of a Rails controller. There is
-still a lot to do obviously, but see examples/hello_world.ru for a starting
-point.