exposure 0.0.4

data/Manifest.txt

@@ -0,0 +1,41 @@
+Manifest.txt
+README.mdown
+Rakefile
+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
+script/generate
+spec/custom_matchers.rb
+spec/exposure_spec.rb
+spec/factories/pirate_factory.rb
+spec/factories/ship_factory.rb
+spec/finders/finder_spec.rb
+spec/finders/nested_resources_finder_spec.rb
+spec/fixtures/pirates/edit.erb
+spec/fixtures/pirates/index.erb
+spec/fixtures/pirates/new.erb
+spec/fixtures/pirates/show.erb
+spec/fixtures/ships/edit.erb
+spec/fixtures/ships/index.erb
+spec/fixtures/ships/new.erb
+spec/fixtures/ships/show.erb
+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
+spec/responders/respond_with_method_spec.rb
+spec/responders/respond_with_proc_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/spec_rails_helper.rb
+tasks/rspec.rake
+tasks/shoulda.rake

data/README.mdown

@@ -0,0 +1,39 @@
+exposure
+======
+
+REQUIREMENTS:
+======
+
+
+INSTALL:
+=======
+    
+    gem sources -a http://gems.github.com (you only have to do this once)
+    sudo gem install trek-exposure
+
+
+LICENSE:
+=========
+
+(The MIT License)
+
+Copyright (c) 2009 Trek Glowacki
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/exposure'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# 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']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/exposure.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{exposure}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Trek Glowacki"]
+  s.date = %q{2009-10-07}
+  s.description = %q{Expose your data}
+  s.email = ["trek.glowacki@gmail.com"]
+  s.extra_rdoc_files = ["Manifest.txt"]
+  s.files = ["Manifest.txt", "README.mdown", "Rakefile", "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", "script/generate", "spec/custom_matchers.rb", "spec/exposure_spec.rb", "spec/factories/pirate_factory.rb", "spec/factories/ship_factory.rb", "spec/finders/finder_spec.rb", "spec/finders/nested_resources_finder_spec.rb", "spec/fixtures/pirates/edit.erb", "spec/fixtures/pirates/index.erb", "spec/fixtures/pirates/new.erb", "spec/fixtures/pirates/show.erb", "spec/fixtures/ships/edit.erb", "spec/fixtures/ships/index.erb", "spec/fixtures/ships/new.erb", "spec/fixtures/ships/show.erb", "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", "spec/responders/respond_with_method_spec.rb", "spec/responders/respond_with_proc_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/spec_rails_helper.rb", "tasks/rspec.rake", "tasks/shoulda.rake"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Expose your data}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<hoe>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 2.3.3"])
+  end
+end

data/lib/exposure/common.rb

@@ -0,0 +1,127 @@
+module Exposure
+  module Common
+    class <<
+      attr_accessor :resource_name, :resources_name, 
+                    :resource_chain, :resources_chain, 
+                    :collection_nesting, :member_nesting,
+                    :parent_model
+    end
+    
+    # response_for :create, :on => :success, :is => { proc }
+    # response_for :show, :formats => [:html] do
+    #   @resource.activated ? render('show') : render('next_steps')
+    # end
+    # response_for :new, :is => :new_foo_built
+    #
+    # valid action names are 
+    #   :index :show :new :create :edit :update :destroy
+    # valid options are
+    #   :on (optional)
+    #     :success, :failure, :any
+    #     default is :any
+    #   :is (option if block given)
+    #     can be a Proc or method name as symbol.
+    #   :formats
+    #     array of formats as symbols.
+    #     defaults to [:html]
+    def response_for(action_name, options = {}, &block)
+      options[:is] ||= block
+      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]
+      when :success
+        self.const_get(:Responses)["#{action_name}.success.html"] = options[:is]
+      when :failure
+        self.const_get(:Responses)["#{action_name}.failure.html"] = options[:is]
+      end
+    end
+    
+    # find :person, :with => Proc.new { Person.find_by_permalink(params[:permalink]) }
+    # find :people, :with => Proc.new { Person.send(params[:scope]) }
+    # find :dogs, :with => :dogs_adopted_after_date
+    # find :dogs do
+    #   Dog.all
+    # end
+    # 
+    # valid options are
+    #   :with
+    #   :only (unimplemented)
+    #   :except (unimplemented)
+    def find(name, options = {}, &block)
+      options[:with] ||= block
+      self.const_get(:Finders)[name] = options[:with]
+    end
+    
+    # configure flash messages
+    # valid action names are 
+    #   :index :show :new :create :edit :update :destroy
+    # valid options are
+    #   :on (optional)
+    #     :success, :failure, :any
+    #     default is :any
+    #   :is (optional if block given)
+    #     can be a Proc or method name as symbol.
+    def flash_for(action_name, options = {}, &block)
+      options[:is] ||= block
+      
+      case options[:on]
+      when NilClass, :any
+        self.const_get(:FlashMessages)[true][action_name]  = options[:is]
+        self.const_get(:FlashMessages)[false][action_name] = options[:is]
+      when :success
+        self.const_get(:FlashMessages)[true][action_name]  = options[:is]
+      when :failure
+        self.const_get(:FlashMessages)[false][action_name] = options[:is]
+      end
+    end
+    
+    # access point for creating and configuring before_ callbacks.
+    def before(trigger, action, options = {})
+      build_callback('before', trigger, action, options)
+    end
+    
+    # access point for creating and configuring before_ callbacks.
+    def after(trigger, action, options = {})
+      build_callback('after', trigger, action, options)
+    end
+    
+    # builds default finders
+    def build_default_finders(member, nesting) #:nodoc:
+      finders = self::const_set(:DefaultFinders, {
+        self.resource_name.intern  => Proc.new { [:find, params[:id] ] },
+        self.resources_name.intern => Proc.new { [:all] }
+      })
+      
+      nesting.each do |association_name|
+        finders[association_name.to_s.singularize.to_sym] = Proc.new { [:find, params[:"#{association_name.to_s.singularize}_id"]] }
+        finders[association_name] = Proc.new { [ :all ] }
+      end
+    end
+    
+    # builds callbacks that adhere to the ActiveSupport::Callbacks interface
+    def build_callback(prefix, trigger, action, options) #:nodoc:
+      callback_name = "#{prefix}_#{trigger}"
+      
+      if options[:on]
+        callback_name += "_on_#{options.delete(:on)}"
+      end
+      
+      options[:if] ||= []
+      
+      only_methods = options.delete(:only)
+      except_methods = options.delete(:except)
+      
+      if only_methods
+        options[:if] << Proc.new {|c| only_methods.include?(c.action_name.intern) }
+      end
+      
+      if except_methods
+        options[:if] << Proc.new {|c| !except_methods.include?(c.action_name.intern) }
+      end
+            
+      self.send(callback_name, action, options)
+    end
+  end
+end

data/lib/exposure/configuration.rb

@@ -0,0 +1,63 @@
+module Exposure
+  module Configuration
+    # options
+    # :nested => false or symbol or array of symbols
+    #   defaults to false
+    # :only   => array of REST methods names as symbols to only include
+    #   defaults to [:show, :new, :create, :edit, :update, :destroy]
+    # :except => array of REST methods to exclude
+    #   defaults to [ ]
+    # :formats => array of 
+    #   defaults to [ :html, :xml, :json ]
+    def expose_one(resource_name, options = {})
+      include ActiveSupport::Callbacks      
+      extend Exposure::Common
+      self.resource_name = resource_name
+      self.member_nesting = [ [self.resource_name.to_sym] ]
+
+      extend  Patterns::Resource
+      include Patterns::Resource::Actions
+      
+      define_callbacks(*Patterns::Resource::Callbacks)
+    end
+    
+    # options
+    # :nested => false or symbol or array of symbols
+    #   defaults to false
+    # :only   => array of REST methods names as symbols to only include
+    #   defaults to [:index, :show, :new, :create, :edit, :update, :destroy]
+    # :except => array of REST methods to exclude
+    #   defaults to [ ]
+    # :formats => array of 
+    #   defaults to [ :html, :xml, :json ]
+    # 
+    def expose_many(name, options = {})
+      include ActiveSupport::Callbacks
+      extend Exposure::Common
+      
+      self.resource_name  = name.to_s.singularize
+      self.resources_name = name.to_s
+      
+      if nesting = options[:nested]
+        
+        self.parent_model = nesting.shift.to_s.singularize.capitalize.constantize
+        
+        build_default_finders(self.resources_name, nesting)
+        
+        nesting.collect! {|sym| [sym.to_s.singularize.to_sym, sym]}
+        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
+        build_default_finders(self.resource_name, [])
+        self.member_nesting = [ [self.resource_name.to_sym] ]
+        self.collection_nesting = [ [self.resources_name.to_sym] ]
+      end
+      
+      extend  Patterns::Resources
+      include Patterns::Resources::Actions
+      
+      define_callbacks(*Patterns::Resources::Callbacks)
+    end
+  end
+end

data/lib/exposure/patterns/resource.rb

@@ -0,0 +1,226 @@
+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