emerson 0.1.0.pre.1 → 0.1.0.pre.2

data/lib/emerson/matchers/integrations/rspec.rb

@@ -0,0 +1,11 @@
+if defined?(::ActionController)
+  require 'emerson/matchers/action_controller'
+
+  module RSpec
+    module Rails
+      module ControllerExampleGroup
+        include Emerson::Matchers::ActionController
+      end
+    end
+  end
+end

data/lib/emerson/matchers/integrations/test_unit.rb

@@ -0,0 +1,12 @@
+if defined?(ActionController)
+  require 'emerson/matchers/action_controller'
+
+  class ActionController::TestCase
+    include Emerson::Matchers::ActionController
+    extend Emerson::Matchers::ActionController
+
+    def subject
+      @controller
+    end
+  end
+end

data/lib/emerson/responder.rb

@@ -1,25 +1,14 @@
 require 'action_controller/base'
 
 module Emerson
+  # Add conventions for resourceful rendering and responses.
   class Responder < ActionController::Responder
-    # class << self
-    #   def base_decorator=(value)
-    #     @@base_decorator = value
-    #   end
-    # 
-    #   def base_decorator
-    #     # NOTE: requires definition of BaseDecorator
-    #     @@base_decorator ||= BaseDecorator
-    #   end
-    # end
-
     delegate :render_to_string, :to => :controller
 
     def initialize(*)
       super
       # NOTE: don't love the @resource ivar...
-      # may be able to remove in favor of layouts
-      controller.instance_variable_set(:"@resource", decorate(resource))
+      controller.instance_variable_set(:"@resource", resource)
     end
 
     def to_html
@@ -30,48 +19,68 @@ module Emerson
     end
 
     def to_json
-      # JSON rendering:
-      # 1. try xxx.json.erb
-      # 2. fail over to xxx.html.erb
-      controller.formats = [:json, :html]
-
-      render({
-        :json => {
-          :data => locals,
-          :view => render_to_string(render_args(:layout => false)).gsub(/\n/, '').presence,
-        }
-        # TODO: consider adding (with proper logic)...
-        # :location => location,
-        # :status   => status
-      })
+      if (mode = vendor_mode)
+        controller.formats = [:json, :html]
+
+        json = {}.tap do |hash|
+          unless_mode(:view) { hash[:data] = locals }
+          unless_mode(:data) do
+            hash[:view] = render_to_string(render_args(:layout => false))
+              .gsub(/\n/, '').presence
+          end
+        end
+
+        render(:json => json)
+      else
+        to_format
+      end
     rescue ActionView::MissingTemplate
       debug(:missing_template)
+
+      controller.formats = [:json]
       to_format
     end
 
     private
 
-      def action
-        @_action ||= (@action || controller.action_name).intern
+      def unless_mode(mode)
+        (vendor_mode == mode) ? nil : yield
       end
 
-      def decorated_resources
-        # NOTE: would like to use controller.current_scope, but i claimed that for the symbol
-        scope   = controller.instance_variable_get(:"@scope")
-        results = ([scope] + resources).compact
-        decorate(results)
+      # TODO: Emerson.vendor_pattern =
+      #       "application/vnd.emerson[.{version}][.(full|data|view)]+json"
+      def vendor_pattern
+        /application\/vnd\.emerson(\.([a-z]+))?\+json/
       end
 
+      def vendor_mode
+        @_vendor_mode ||= begin
+          result = (Emerson.response_config[:json_default] || :full).intern
+
+          if (header = request.env['HTTP_ACCEPT'])
+            if (match = header.match(vendor_pattern))
+              result = (match[2] || 'full').intern
+            end
+          end
+
+          result
+        end
+      end
+
+      def action
+        @_action ||= (@action || controller.action_name).intern
+      end
+
+      # TODO: rename for accuracy
       def locals
         @_locals ||= begin
-          base = (options[:locals] || {})
-          base.each do |k, v|
-            base[k] = decorate(v)
-          end
+          scope   = controller.instance_variable_get(:"@scope")
+          results = ([scope] + resources).compact
 
-          decorated_resources.inject(base) do |memo, object|
-            memo[key_for(object)] = object
-            memo
+          (options[:locals] || {}).tap do |hash|
+            results.each do |object|
+              hash[key_for(object)] = object
+            end
           end
         end
       end
@@ -79,9 +88,10 @@ module Emerson
       def render_args(overrides = {})
         # TODO: spec me!
         @_render_args ||= begin
-          if options[:layout] == :scoped
+          # TODO: move to conditionally-imported module
+          if options[:layout].to_s == 'scoped'
             options.delete(:layout)
-            options[:layout] = controller.current_scope.to_s if controller.current_scope.present?
+            options[:layout] = scope_type.to_s if controller.current_scope.present?
           end
 
           options.merge({
@@ -96,9 +106,9 @@ module Emerson
           if options[:location].present?
             nil
           elsif (path = options[:path])
-            # TODO: spec me!
-            if path == :scoped
-              options[:path] = template_built(controller.current_scope)
+            # TODO: move to conditionally-imported module
+            if path.to_s == 'scoped'
+              options[:path] = template_built(scope_type)
             end
 
             options[:path]
@@ -128,11 +138,6 @@ module Emerson
         end
       end
 
-      def decorate(object)
-        # ActiveDecorator::Decorator.instance.decorate(object)
-        object
-      end
-
       def key_for(object)
         if object == resource
           key_for_primary
@@ -156,6 +161,11 @@ module Emerson
         object.class.model_name.element.intern
       end
 
+      # TODO: move to conditionally-imported module
+      def scope_type
+        controller.current_scope.class.name.pluralize.underscore.intern
+      end
+
       def debug(type)
         # TODO: check Emerson.debug?
         case type

data/lib/emerson/response.rb

@@ -1,10 +1,24 @@
 module Emerson
+  # Adds Emerson response handling & rendering.
+  #
+  # @example
+  #   class ApplicationController < ActionController::Base
+  #     include Emerson::Response
+  #   end
   module Response
     class << self
+      # Configures `base` with the follow feature flag awareness:
+      #
+      #   * if `Emerson.scope_enabled?`, will include `Emerson::Scope`
+      #   * if `Emerson.responder_enabled?`, will set up `base.responder` to
+      #     use `Emerson::Responder` with `:html` and `:json` mime types.
       def included(base)
-        base.send(:include, Emerson::Scope)
-        base.responder = Emerson::Responder
-        base.class_eval('respond_to(:html, :json, :js)')
+        base.send(:include, Emerson::Scope) if Emerson.scope_enabled?
+
+        if Emerson.responder_enabled?
+          base.responder = Emerson::Responder
+          base.class_eval('respond_to(:html, :json)')
+        end
       end
     end
   end

data/lib/emerson/scope.rb

@@ -1,6 +1,7 @@
 require 'action_controller/base'
 
 module Emerson
+  # Add helpers for request-base, scoped resource loading.
   module Scope
     def self.included(base)
       base.class_eval do
@@ -53,11 +54,7 @@ module Emerson
     end
 
     def current_scope
-      @_current_scope ||= begin
-        if @scope.present?
-          @scope.class.model_name.plural.intern
-        end
-      end
+      scoped && @scope
     end
 
     protected
@@ -75,8 +72,6 @@ module Emerson
 
       def class_for(type)
         type.to_s.classify.constantize
-      rescue
-        nil
       end
 
       def default_scope

data/lib/emerson/version.rb

@@ -1,3 +1,3 @@
 module Emerson
-  VERSION = "0.1.0.pre.1"
+  VERSION = "0.1.0.pre.2"
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.