eac-resourcify 0.1.0

data/lib/resourcify.rb

@@ -0,0 +1,26 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  require 'extlib'
+  
+  Merb::BootLoader.before_app_loads do
+    # require code that must be loaded before the application
+    require 'resourcify/data_mapper/parents'
+    require 'resourcify/data_mapper/serialize_errors'
+    ::DataMapper::Model.append_extensions(Resourcify::DataMapper::Parents)
+    ::DataMapper::Resource.append_inclusions(Resourcify::DataMapper::SerializeErrors)
+    
+    require 'resourcify/controller'
+    require 'resourcify/resource'
+    require 'resourcify/actions'
+    require 'resourcify/responses'
+    require 'resourcify/parent_relationship'
+    Merb::Controller.send(:extend, Resourcify::Controller)
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    # code that can be required after the application loads
+  end
+  
+  # Merb::Plugins.add_rakefiles "resourcify/merbtasks"
+  
+end

data/lib/resourcify/actions.rb

@@ -0,0 +1,56 @@
+module Resourcify
+  module Actions
+    
+    protected
+
+    # UI Actions
+    def new
+      only_provides :html
+      resource
+      render
+    end
+
+    def edit
+      only_provides :html
+      resource
+      render
+    end  
+    
+    private
+    
+    # Verbs  
+
+    def get
+      display resource
+    end
+
+    def put
+      if resource.save
+        put_successful
+      else
+        put_failed
+      end
+    end
+    
+    def post
+      if resource.save
+        post_successful
+      else
+        post_failed
+      end
+    end
+    
+    def delete
+      resource.destroy || raise(StandardError.new("Failed to destroy resource: #{resource.inspect}"))
+      delete_successful 
+    end
+   
+    # Quick compatiblity with Resourceful Routes
+    alias_method :index,   :get
+    alias_method :show,    :get
+    alias_method :destroy, :delete
+    alias_method :update,  :put
+    alias_method :create,  :post
+   
+  end  
+end

data/lib/resourcify/controller.rb

@@ -0,0 +1,14 @@
+module Resourcify
+  module Controller
+
+    def resourcify
+        
+      include Resource
+      include Actions
+      include Responses
+      include ParentRelationship
+        
+    end
+
+  end
+end

data/lib/resourcify/data_mapper/parents.rb

@@ -0,0 +1,25 @@
+module Resourcify
+  module DataMapper
+    module Parents    
+          
+      # FIXME Only works for single-field foreign keys    
+      def parent_keys
+        parent_relationships.keys
+      end
+      
+      # FIXME Not grabbing proper relationships
+      def parent_relationships
+        parent_relationships = {}
+        relationships.each do |relationship_name, relationship|
+          if relationship.child_model == self
+            parent_key = relationship.child_key.entries.first.field.to_sym
+            parent_relationships[parent_key] = relationship 
+          end
+        end
+        parent_relationships
+      end
+    
+    end
+    
+  end
+end

data/lib/resourcify/data_mapper/serialize_errors.rb

@@ -0,0 +1,11 @@
+module Resourcify
+  module DataMapper
+    module SerializeErrors
+     
+      def serialize_properties
+        errors.blank? ? {} : { :errors => errors.send(:errors) }
+      end
+    
+    end
+  end
+end

data/lib/resourcify/parent_relationship.rb

@@ -0,0 +1,72 @@
+module Resourcify
+  module ParentRelationship
+    
+    
+    # e.g.
+    # class Person
+    #   belongs_to :location
+    # end
+    #
+    # class Location
+    #   has n, :people
+    # end
+    #
+    # access_by :location 
+    #
+    # (Options)
+    # :collection => :person
+    #
+    def self.included(base)
+      base.class_eval do
+       class_inheritable_accessor :relationship_collections
+       self.relationship_collections = {}
+        
+        def self.access_by(relationship, options = {})
+          options[:collection]   ||= Extlib::Inflection.tableize(model_name_parts.last).to_sym
+
+          relationship_collections[relationship] = options[:collection]
+        end
+        
+      end
+     
+    end
+    
+    def owner
+      collection || model
+    end
+    
+    def parent
+      @parent ||= parent_relationship.parent_model.get!(params[parent_key]) if parent_relationship?
+    end
+    
+    def collection(query = {})
+      if parent_relationship?
+        if association_name = relationship_collections[parent_relationship.name]
+          parent.send(association_name, query)
+        else
+          raise(ArgumentError.new(
+            "Parent relationship #{parent_relationship.name} found, but not marked as accessible.
+             Specify `access_by :#{parent_relationship.name}` for this controller."
+          ))
+        end
+      end
+    end
+    
+    def relationship_collections
+      self.class.relationship_collections
+    end
+    
+    def parent_relationship?
+      !parent_relationship.nil?
+    end
+    
+    def parent_relationship
+      @parent_relationship ||= model.parent_relationships[parent_key]
+    end
+    
+    def parent_key
+      @parent_key ||= model.parent_keys.detect { |parent_key| params[parent_key] }
+    end
+
+  end
+end

data/lib/resourcify/resource.rb

@@ -0,0 +1,104 @@
+module Resourcify
+  module Resource
+  
+    def self.included(base)
+        
+      base.class_eval do
+        def self.model
+          Extlib::Inflection.constantize(model_name)
+        rescue NameError
+          raise NameError.new(
+            "Could not find a model named #{model_name}. Override #{self.name}.model_name with an existing class."
+          )
+        end
+        
+        protected
+        
+        def self.model_name
+          model_name_parts.join('::')
+        end
+        
+        def self.model_name_parts
+          name_parts = name.split('::')
+          model_name = name_parts.pop.singular
+          name_parts << model_name
+        end
+        
+        def self.resources_path
+          Extlib::Inflection.tableize(model_name)
+        end
+        
+      end
+         
+    end
+    
+    # def self.inherited(subclass)
+    #   subclass.model = Kernel.const_get(subclass.name.singular)  
+    # end
+  
+    protected  
+
+    # Resources
+    
+    def model
+      self.class.model
+    end
+    
+    def resource_url
+      url(self.class.resources_path.singular.to_sym, resource.key)
+    end
+    
+    def resource_collection_url
+      url(self.class.resources_path.to_sym)
+    end
+    
+    def resource
+      @resource ||= assign_resource_instance_variable
+    end
+    
+    def fetch_resource
+      case params[:action]
+      when *self.class.load_actions then load_resource
+      when *self.class.build_actions then build_resource
+      else
+        raise ArgumentError, "Unknown resource action #{params[:action].inspect}"
+      end
+    end
+    
+    def build_resource
+      parent ? owner.build(resource_params || {}) : owner.new(resource_params || {})
+    end
+    
+    def load_resource
+      params[:id] ? owner.get!(params[:id]) : owner.all
+    end
+    
+    def resource_params
+      params[model.name.snake_case]
+    end
+    
+    # ParentRelationships overrides this method.
+    def owner
+      model
+    end
+    
+    private
+    
+    # FIXME Rewrite
+    # Equivelent to @users = User.all or @user = User.get!(id)
+    # TODO Dynamically create method?
+    # def resource  #{singular_name} = fetch_resource  end
+    # def resources #{plural_name}   = fetch_resource  end
+    def assign_resource_instance_variable
+      fetched_resource = fetch_resource
+      base_name = Extlib::Inflection.underscore(
+        Extlib::Inflection.demodulize(self.class.name)
+      ).downcase
+      instance_variable_name = fetched_resource.is_a?(Array) ? "@#{base_name}" : "@#{base_name.singular}"
+      instance_variable_set(instance_variable_name, fetched_resource)
+    end
+    
+
+  
+  end
+end

data/lib/resourcify/responses.rb

@@ -0,0 +1,50 @@
+module Resourcify
+  module Responses
+    
+    # Responses
+    # Success
+    def put_successful
+      case content_type
+      when :html then redirect(resource_url)
+      else 
+        self.status = 204 # No Content
+        ''
+      end
+    end
+    
+    def delete_successful
+      case content_type
+      when :html then redirect(resource_collection_url)
+      else 
+        self.status = 204 # No Content
+        ''
+      end
+    end
+    
+    def post_successful
+      case content_type
+      when :html then redirect(resource_url)
+      else
+        display(resource, :status => 201, :location => resource_url) # 201 Created
+      end
+    end
+    
+    # Failure 422 Unproccessable entity
+    def post_failed
+      case content_type
+      when :html then render(:new, :status => 422)
+      else 
+        display(resource, :status => 422) 
+      end
+    end
+    
+    def put_failed
+      case content_type
+      when :html then render(:edit, :status => 422)
+      else
+        display(resource, :status => 422)
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: eac-resourcify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Chapweske
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Basic enhancements for making Merb controllers more resourceful. Provides reduced code duplication, nested resource support, and aims for RFC2616 compliant responses.
+email: eric@slantwisedesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/resourcify.rb
+- lib/resourcify/controller.rb
+- lib/resourcify/actions.rb
+- lib/resourcify/parent_relationship.rb
+- lib/resourcify/resource.rb
+- lib/resourcify/responses.rb
+- lib/resourcify/data_mapper/parents.rb
+- lib/resourcify/data_mapper/serialize_errors.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- Install datamapper to get full functionality out of the box.
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Resourceful merb controllers.
+test_files: []
+