exposure 0.0.4 → 0.0.5

data/Manifest.txt

@@ -5,7 +5,6 @@ exposure.gemspec
 lib/exposure.rb
 lib/exposure/common.rb
 lib/exposure/configuration.rb
-lib/exposure/patterns/resource.rb
 lib/exposure/patterns/resources.rb
 script/console
 script/destroy
@@ -28,7 +27,6 @@ spec/flashers/flash_with_block_spec.rb
 spec/flashers/flash_with_method_spec.rb
 spec/flashers/flash_with_proc_spec.rb
 spec/flashers/flash_with_string_spec.rb
-spec/resource_spec.rb
 spec/resources_spec.rb
 spec/responders/respond_to_mime_types_spec.rb
 spec/responders/respond_with_block_spec.rb

data/README.mdown

@@ -1,19 +1,72 @@
-exposure
-======
+# exposure
+Exposure is a Rails is a controller abstraction layer like [`resource_this`](http://github.com/jnewland/resource_this), [`make_resourceful`](http://github.com/hcatlin/make_resourceful) and [`resource_controller`](resource_controller) with the same goal: exposing resources at the controller level with fewer headaches.
 
-REQUIREMENTS:
-======
+    class PostsController < ApplicationController
+      expose :posts
+    end
 
+## Customization:
+Exposure has a number of customization points:
+### Callbacks
+Exposure uses `ActiveSupport`'s callback system and has the following callbacks:
+
+  * `before_find`
+  * `after_find`
+  * `after_find_on_failure`
+  * `after_find_on_success`
+  * `before_assign`
+  * `after_assign`
+  * `before_save`
+  * `after_save`
+  * `after_save_on_failure`
+  * `after_save_on_success`
+  * `before_create`
+  * `after_create_on_failure`
+  * `after_create_on_success`
+  * `before_update`
+  * `after_update_on_failure`
+  * `after_update_on_success`
+  * `before_destroy`
+  * `after_destroy_on_success`
+  * `before_response`
+  * `before_response_on_success`
+  * `before_response_on_failure`
+  
+You can access these directly 
+
+    class PostsController
+      before_find :do_somethng_special, :if => {|c| c.action_name == 'show' }
+      private
+        def do_somethng_special
+          ...
+        end
+    end
+  
+or through a specialty syntax
+    
+    class PostsController
+      before :find, :do_somethng_special, :only => [:create]
+      private
+        def do_somethng_special
+          ...
+        end
+    end
+
+### Finders
+### Flashers
+### Responders
 
 INSTALL:
-=======
+------
+    
+    $ sudo gem install exposure
     
-    gem sources -a http://gems.github.com (you only have to do this once)
-    sudo gem install trek-exposure
+    # environment.rb
+    gem.exposure
 
 
 LICENSE:
-=========
+------
 
 (The MIT License)
 

data/Rakefile

@@ -12,10 +12,7 @@ Hoe.plugin :newgem
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 $hoe = Hoe.spec 'exposure' do
   self.developer 'Trek Glowacki', 'trek.glowacki@gmail.com'
-  # self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  # self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
+  self.summary = 'exposed resources'
 end
 
 require 'newgem/tasks'

data/lib/exposure/common.rb

@@ -26,15 +26,16 @@ module Exposure
     #     defaults to [:html]
     def response_for(action_name, options = {}, &block)
       options[:is] ||= block
-      options[:formats] ||= [:html]
+      formats  = options[:formats] || [:html]
+      
       case options[:on]
       when NilClass, :any
-        self.const_get(:Responses)["#{action_name}.success.html"] = options[:is]
-        self.const_get(:Responses)["#{action_name}.failure.html"] = options[:is]
+        build_custom_response(action_name, :success, formats, options[:is])
+        build_custom_response(action_name, :failure, formats, options[:is])
       when :success
-        self.const_get(:Responses)["#{action_name}.success.html"] = options[:is]
+        build_custom_response(action_name, :success, formats, options[:is])
       when :failure
-        self.const_get(:Responses)["#{action_name}.failure.html"] = options[:is]
+        build_custom_response(action_name, :failure, formats, options[:is])
       end
     end
     
@@ -100,6 +101,12 @@ module Exposure
       end
     end
     
+    def build_custom_response(action_name, success_status, formats, response)
+      formats.each do |format|
+        self.const_get(:Responses)["#{action_name}.#{success_status}.#{format}"] = response
+      end
+    end
+    
     # builds callbacks that adhere to the ActiveSupport::Callbacks interface
     def build_callback(prefix, trigger, action, options) #:nodoc:
       callback_name = "#{prefix}_#{trigger}"

data/lib/exposure/configuration.rb

@@ -40,7 +40,7 @@ module Exposure
       
       if nesting = options[:nested]
         
-        self.parent_model = nesting.shift.to_s.singularize.capitalize.constantize
+        self.parent_model = nesting.shift.to_s.singularize.camelize.constantize
         
         build_default_finders(self.resources_name, nesting)
         
@@ -48,7 +48,7 @@ module Exposure
         self.member_nesting = nesting + [ [self.resource_name.to_sym] ]
         self.collection_nesting = nesting + [ [self.resources_name.to_sym] ]
       else
-        self.parent_model = self.resource_name.capitalize.constantize
+        self.parent_model = self.resource_name.camelize.constantize
         build_default_finders(self.resource_name, [])
         self.member_nesting = [ [self.resource_name.to_sym] ]
         self.collection_nesting = [ [self.resources_name.to_sym] ]
@@ -59,5 +59,6 @@ module Exposure
       
       define_callbacks(*Patterns::Resources::Callbacks)
     end
+    alias :expose :expose_many
   end
 end

data/lib/exposure.rb

@@ -1,14 +1,15 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
+require 'action_controller'
 require 'exposure/configuration'
 require 'exposure/common'
 require 'exposure/patterns/resources'
 require 'exposure/patterns/resource'
 
 module Exposure
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
   def self.included(base)
     base.extend Configuration
   end
-end
+end
+ActionController::Base.send :include, Exposure

data/spec/exposure_spec.rb

@@ -1,4 +1,24 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-describe "exposure" do
+describe "exposure", :type => :controller do
+  class ShipTypesController < ActionController::Base
+    expose_many(:ship_types)
+  end 
+  controller_name :ship_types
+  
+  before(:each) do
+    @controller = ShipTypesController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    ActionController::Routing::Routes.draw do |map| 
+      map.resources :ship_types
+    end
+  end
+  
+  describe "parent models" do
+    it "should constantize resource name" do
+      ShipTypesController.resources_name.should == "ship_types"
+      ShipTypesController.parent_model.should == ShipType
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -29,7 +29,7 @@ require 'exposure'
 
 ActiveRecord::Base.logger = Logger.new(STDOUT) if ENV['DEBUG']
 ActionController::Base.logger = Logger.new(STDOUT) if ENV['DEBUG']
-ActionController::Base.send :include, Exposure
+# ActionController::Base.send :include, Exposure
 ActionController::Base.view_paths=(File.dirname(__FILE__) + '/fixtures')
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
@@ -54,6 +54,12 @@ ActiveRecord::Schema.define(:version => 1) do
     t.column :created_at,   :datetime
     t.column :updated_at,   :datetime
   end
+  create_table :ship_types do |t|
+    t.column :title,        :string
+    t.column :body,         :text
+    t.column :created_at,   :datetime
+    t.column :updated_at,   :datetime
+  end
 end
 
 class Pirate < ActiveRecord::Base
@@ -68,4 +74,7 @@ class Ship < ActiveRecord::Base
   def validate
   end
   validates_associated :pirate
+end
+
+class ShipType < ActiveRecord::Base
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: exposure
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Trek Glowacki
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-07 00:00:00 -04:00
+date: 2009-10-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.3
     version: 
-description: Expose your data
+description: ""
 email: 
 - trek.glowacki@gmail.com
 executables: []
@@ -39,7 +39,6 @@ files:
 - lib/exposure.rb
 - lib/exposure/common.rb
 - lib/exposure/configuration.rb
-- lib/exposure/patterns/resource.rb
 - lib/exposure/patterns/resources.rb
 - script/console
 - script/destroy
@@ -62,7 +61,6 @@ files:
 - spec/flashers/flash_with_method_spec.rb
 - spec/flashers/flash_with_proc_spec.rb
 - spec/flashers/flash_with_string_spec.rb
-- spec/resource_spec.rb
 - spec/resources_spec.rb
 - spec/responders/respond_to_mime_types_spec.rb
 - spec/responders/respond_with_block_spec.rb
@@ -97,10 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: exposure
 rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: Expose your data
+summary: exposed resources
 test_files: []
 

data/lib/exposure/patterns/resource.rb

@@ -1,226 +0,0 @@
-module Exposure
-  module Patterns
-    module Resource
-      def self.extended(base)
-        base::const_set(:DefaultResponses, DefaultResponses)
-        base::const_set(:DefaultFlashMessages, DefaultFlashMessages)
-        base::const_set(:DefaultFinders, {
-          base.resource_name => Proc.new {|parent,controller| parent.find(controller.params[:id])},
-        })
-      end
-      
-      Callbacks = %w(
-        before_find after_find after_find_on_failure after_find_on_success
-        before_assign after_assign
-        before_save after_save after_save_on_failure after_save_on_success
-        before_create after_create_on_failure after_create_on_success
-        before_update after_update_on_failure after_update_on_success
-        before_destroy after_destroy_on_success
-        before_response before_response_on_success before_response_on_failure
-      )
-      
-      DefaultFlashMessages = {
-        true => {
-          :create => Proc.new {|c| "#{c.send(:resource_name).capitalize} successfully created" },
-          :update => Proc.new {|c| "#{c.send(:resource_name).capitalize} successfully updated" },
-          :destroy => Proc.new {|c| "#{c.send(:resource_name).capitalize} successfully removed" }
-        },
-        false => {}
-      }
-      
-      DefaultResponses = {
-        true =>  {
-          :show  => Proc.new   {|c| c.send(:render, 'show')        },
-          :new   => Proc.new   {|c| c.send(:render, 'new')         },
-          :create => Proc.new  {|c| c.send(:redirect_to, {:action => 'show'})  },
-          :edit   => Proc.new  {|c| c.send(:render, 'edit')        },
-          :update => Proc.new  {|c| c.send(:redirect_to, {:action => 'show' })   },
-          :destroy => Proc.new {|c| c.send(:redirect_to, {:action => 'new'}) }
-        },
-        false => {
-          :create => Proc.new {|c| c.send(:render, 'new')    },
-          :update => Proc.new {|c| c.send(:render, 'edit')   }
-        }
-      }
-    
-      module Actions
-        # no index on single resources
-        
-        def show
-          run_callbacks(:before_find)
-          if find_record
-            run_callbacks(:after_find_on_success)
-            run_callbacks(:after_find)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_success)
-            response_for(:show, true)
-          else
-            run_callbacks(:after_find_on_failure)
-            run_callbacks(:after_find)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_failure)
-            response_for(:show, false)
-          end
-        end
-
-        def new
-          run_callbacks(:before_assign)
-          new_record
-          run_callbacks(:after_assign)
-          run_callbacks(:before_response)
-          run_callbacks(:before_response_on_success)
-          response_for(:new, true)
-        end
-
-        def create
-          run_callbacks(:before_assign)
-          new_record
-          run_callbacks(:after_assign)
-
-          run_callbacks(:before_create)
-          run_callbacks(:before_save)
-
-          if save_record
-            run_callbacks(:after_save_on_success)
-            run_callbacks(:after_create_on_success)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_success)
-            flash_for(:create, true)
-            response_for(:create, true)
-          else
-            run_callbacks(:after_save_on_failure)
-            run_callbacks(:after_create_on_failure)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_failure)
-            flash_for(:create, false)
-            response_for(:create, false)
-          end
-
-        end
-
-        def edit
-          run_callbacks(:before_find)
-          if find_record
-            run_callbacks(:after_find_on_success)
-            run_callbacks(:after_find)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_success)
-            response_for(:edit, true)
-          else
-            run_callbacks(:after_find_on_failure)
-            run_callbacks(:after_find)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_failure)
-            response_for(:edit, false)
-          end
-        end
-
-        def update
-          run_callbacks(:before_find)
-          if find_record
-            run_callbacks(:after_find_on_success)
-            run_callbacks(:after_find)
-            if update_record
-              run_callbacks(:after_save_on_success)
-              run_callbacks(:after_update_on_success)
-              run_callbacks(:before_response)
-              run_callbacks(:before_response_on_success)
-              flash_for(:update, true)
-              response_for(:update, true)
-            else
-              run_callbacks(:after_save_on_failure)
-              run_callbacks(:after_create_on_failure)
-              run_callbacks(:before_response)
-              run_callbacks(:before_response_on_failure)
-              flash_for(:update, false)
-              response_for(:update, false)
-            end
-          else
-            run_callbacks(:after_find_on_failure)
-            run_callbacks(:after_find)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_failure)
-            response_for(:edit, false)
-          end
-        end
-
-        def destroy
-          run_callbacks(:before_find)
-          if find_record
-            run_callbacks(:after_find_on_success)
-            run_callbacks(:after_find)
-            run_callbacks(:before_destroy)
-
-            delete_record
-
-            run_callbacks(:after_destroy_on_success)
-            run_callbacks(:before_response)
-            run_callbacks(:before_response_on_success)
-            flash_for(:destroy, true)
-            response_for(:destroy, true)
-
-          else
-            run_callbacks(:after_find_on_failure)
-            run_callbacks(:after_find)
-            response_for(:destroy, false)
-          end
-        end
-
-        private
-          def custom_response_for(action_name, action_successful)
-            false
-          end
-
-          def default_response_for(action_name, action_successful)
-            self.class::DefaultResponses[action_successful][action_name].call(self)
-          end
-
-          def response_for(action_name, action_successful)
-            custom_response_for(action_name, action_successful) || default_response_for(action_name, action_successful)
-          end
-
-          def custom_flash_for(action_name, action_successful)
-            false
-          end
-
-          def default_flash_for(action_name, action_successful)
-            if message_proc = self.class::DefaultFlashMessages[action_successful][action_name]
-              flash[:message] = message_proc.call(self)
-            end
-          end
-
-          def flash_for(action_name, action_successful)
-            custom_flash_for(action_name, action_successful) || default_flash_for(action_name, action_successful)
-          end
-
-          def resource_name
-            self.class.resource_name
-          end
-
-          def save_record
-            @resource.save
-          end
-
-          def update_record
-            @resource.update_attributes(params[resource_name])
-          end
-
-          def new_record
-            @resource = instance_variable_set("@#{resource_name}", resource_name.camelize.constantize.new(params[resource_name]))
-          end
-
-          def find_record
-            @resource = instance_variable_set("@#{resource_name}", resource_name.camelize.constantize.find(params[:id]))
-          end
-
-          def find_records
-            @resources = instance_variable_set("@#{resource_name.pluralize}", resource_name.camelize.constantize.all)
-          end
-
-          def delete_record
-            @resource.destroy
-          end
-        end
-    end
-  end
-end

data/spec/resource_spec.rb

@@ -1,192 +0,0 @@
-# require File.dirname(__FILE__) + '/spec_helper'
-# 
-# describe "a REST patterned resource of 'post'", :type => :controller do
-#   class ShipController < ActionController::Base
-#     expose_one :ship
-#   end
-#   controller_name :ship
-#   
-#   before(:each) do
-#     @controller = ShipController.new
-#     @request    = ActionController::TestRequest.new
-#     @response   = ActionController::TestResponse.new
-#     ActionController::Routing::Routes.draw do |map| 
-#       map.resource :ship
-#     end
-#   end
-#   
-#   describe 'configuration' do
-#     it "has a resource name of 'post'" do
-#       @controller.send(:resource_name).should == 'ship'
-#     end
-#   
-#     %w(show new create edit update destroy).each do |action|
-#       it "has the REST action #{action}" do
-#         @controller.should respond_to(action)
-#       end
-#     end
-#   end
-#   
-#   describe 'show' do
-#     describe 'with found resource' do
-#       before(:each) do
-#         Ship.should_receive(:find).with('1').and_return(Factory.stub(:ship))
-#         get :show, {:id => 1}
-#       end
-#       
-#       it { should assign_to(:ship) }
-#       it { should assign_to(:resource) }
-#       it { should respond_with(:success) }
-#       it { should render_template(:show) }
-#       it { should_not set_the_flash }
-#     end
-#     
-#     describe 'with missing resource' do
-#       before(:each) do
-#         rescue_action_in_public!
-#         Ship.should_receive(:find).with('1').and_raise(ActiveRecord::RecordNotFound)
-#         get :show, {:id => 1}
-#       end
-#       
-#       it { should_not assign_to(:ship) }
-#       it { should_not assign_to(:resource) }
-#       it { should respond_with(:not_found) }
-#       it { should_not render_template(:show) }
-#       it { should_not set_the_flash }
-#     end
-#   end
-#   
-#   describe 'new' do
-#     before(:each) do
-#       get :new
-#     end
-#     
-#     it { should assign_to(:ship) }
-#     it { should assign_to(:resource) }
-#     it { should respond_with(:success) }
-#     it { should render_template(:new) }
-#     it { should_not set_the_flash }
-#     
-#   end
-#   
-#   describe 'create' do
-#     describe 'with valid data' do
-#       before(:each) do
-#         params = {
-#           :ship => {}
-#         }
-#         post_before_saving = Factory.build(:ship)
-#         Ship.should_receive(:new).with(params[:ship]).and_return(post_before_saving)
-#         post_before_saving.should_receive(:save).and_return(true)
-#         post(:create, params)
-#       end
-#       
-#       it { should assign_to(:ship) }
-#       it { should assign_to(:resource) }
-#       it { should respond_with(:redirect).to(:show) }
-#       it { should set_the_flash.to('Ship successfully created') }
-#     end
-#     
-#     describe 'with invalid data' do
-#       before(:each) do
-#         params = {
-#           :ship => {}
-#         }
-#         post_before_saving = Factory.build(:ship)
-#         Ship.should_receive(:new).with(params[:ship]).and_return(post_before_saving)
-#         post_before_saving.should_receive(:save).and_return(false)
-#         post(:create, params)
-#       end
-#       
-#       it { should assign_to(:ship) }
-#       it { should assign_to(:resource) }
-#       it { should respond_with(:success) }
-#       it { should render_template(:new) }
-#       it { should_not set_the_flash }
-#     end
-#   end
-#   
-#   describe 'edit' do
-#     describe 'with found resource' do
-#       before(:each) do
-#         Ship.should_receive(:find).with('1').and_return(Factory.stub(:ship))
-#         get :edit, {:id => 1}
-#       end
-#       
-#       it { should assign_to(:ship) }
-#       it { should assign_to(:resource) }
-#       it { should respond_with(:success) }
-#       it { should render_template(:edit) }
-#       it { should_not set_the_flash }
-#     end
-#     
-#     describe 'with missing resource' do
-#       before(:each) do
-#         rescue_action_in_public!
-#         Ship.should_receive(:find).with('1').and_raise(ActiveRecord::RecordNotFound)
-#         get :edit, {:id => 1}
-#       end
-#       
-#       it { should_not assign_to(:ship) }
-#       it { should_not assign_to(:resource) }
-#       it { should respond_with(:not_found) }
-#       it { should_not render_template(:edit) }
-#       it { should_not set_the_flash }
-#     end
-#   end
-#   
-#   describe 'update' do
-#     describe 'with valid data' do
-#       before(:each) do
-#         params = {
-#           :id  => 1,
-#           :ship => {}
-#         }
-#         post_before_saving = Factory.build(:ship)
-#         Ship.should_receive(:find).with("1").and_return(post_before_saving)
-#         post_before_saving.should_receive(:update_attributes).with(params[:ship]).and_return(true)
-#         put(:update, params)
-#       end
-#       
-#       it { should assign_to(:ship) }
-#       it { should assign_to(:resource) }
-#       it { should respond_with(:redirect).to(:show) }
-#       it { should set_the_flash.to('Ship successfully updated') }
-#       
-#     end
-#     
-#     describe 'with invalid data' do
-#       before(:each) do
-#         params = {
-#           :id  => 1,
-#           :ship => {}
-#         }
-#         post_before_saving = Factory.build(:ship)
-#         Ship.should_receive(:find).with("1").and_return(post_before_saving)
-#         post_before_saving.should_receive(:update_attributes).with(params[:ship]).and_return(false)
-#         put(:update, params)
-#       end
-#       
-#       it { should assign_to(:ship) }
-#       it { should assign_to(:resource) }
-#       it { should respond_with(:success) }
-#       it { should render_template(:edit) }
-#       it { should_not set_the_flash }
-#     end
-#   end
-#   
-#   describe 'destroy' do
-#     before(:each) do
-#       params = {
-#         :id  => 1,
-#       }
-#       post_before_saving = Factory.build(:ship)
-#       Ship.should_receive(:find).with("1").and_return(post_before_saving)
-#       post_before_saving.should_receive(:destroy)
-#       delete(:destroy, params)
-#     end
-#     
-#     it { should respond_with(:redirect).to(:new) }
-#     it { should set_the_flash.to('Ship successfully removed') }
-#   end
-# end