resourceful_controller 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resourceful_controller.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/resourceful_controller.rb

@@ -0,0 +1,34 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'resourceful_controller/resource_identification'
+require 'resourceful_controller/query_definitions'
+require 'resourceful_controller/url_definitions'
+require 'resourceful_controller/crud_definitions'
+
+module ResourcefulController
+  extend ActiveSupport::Concern
+  include ActiveSupport
+
+  include ResourceIdentification
+  include QueryDefinitions
+  include UrlDefinitions
+
+  delegate :options, :to => :klass
+
+  def klass
+    self.class
+  end
+
+  module ClassMethods
+    include CrudDefinitions
+
+    attr_accessor :options
+
+    def act_resourcefully options = {}
+      self.options = options
+      define_crud_methods
+    end
+
+  end
+end

data/lib/resourceful_controller/crud_definitions.rb

@@ -0,0 +1,79 @@
+module ResourcefulController
+  module CrudDefinitions
+    def define_crud_methods
+      methods.each { |method| send(:"define_#{method}") }
+    end
+
+    def methods
+      methods = default_methods - excepted_methods
+      methods = methods & specified_methods if specified_methods.present?
+      return methods
+    end
+
+    def excepted_methods
+      Array.wrap(@options[:except])
+    end
+
+    def specified_methods
+      Array.wrap(@options[:only])
+    end
+
+    def default_methods
+      [:index, :new, :create, :show, :edit, :update, :destroy]
+    end
+
+    def define_index
+      define_method :index do
+        instance_variable_set(:"@#{resources_name}", _index_query.call(params))
+      end
+    end
+
+    def define_new
+      define_method :new do
+        instance_variable_set(:"@#{resource_name}", resource_class.new)
+      end
+    end
+
+    def define_create
+      define_method :create do
+        instance_variable_set(:"@#{resource_name}", resource_class.new(params[:"#{resource_name}"]))
+        if instance_variable_get(:"@#{resource_name}").save
+          send(:redirect_to, show_path, :notice => "#{resource_name.titleize.capitalize} successfully created")
+        else
+          render :new
+        end
+      end
+    end
+
+    def define_show
+      define_method :show do
+        instance_variable_set(:"@#{resource_name}", _find_query.call(params))
+      end
+    end
+
+    def define_edit
+      define_method :edit do
+        instance_variable_set(:"@#{resource_name}", _find_query.call(params))
+      end
+    end
+
+    def define_update
+      define_method :update do
+        instance_variable_set(:"@#{resource_name}", _find_query.call(params))
+        if instance_variable_get(:"@#{resource_name}").update_attributes(params[:"#{resource_name}"])
+          redirect_to show_path, :notice => "#{resource_name.titleize.capitalize} successfully updated"
+        else
+          render :edit
+        end
+      end
+    end
+
+    def define_destroy
+      define_method :destroy do
+        resource = _find_query.call(params)
+        resource.destroy
+        redirect_to index_path, :notice => "#{resource_name.titleize.capitalize} successfully deleted"
+      end
+    end
+  end
+end

data/lib/resourceful_controller/query_definitions.rb

@@ -0,0 +1,30 @@
+module ResourcefulController
+  module QueryDefinitions
+    QUERY_METHODS = [:index_query, :find_query, :show_query, :edit_query, :update_query, :destroy_query]
+
+    QUERY_METHODS.each do |query_method|
+      define_method :"_#{query_method}" do
+        procify(options[query_method]) ||
+        send(:"default_#{query_method}")
+      end
+    end
+
+    def default_index_query
+      lambda { |params| resource_class.all }
+    end
+
+    def default_find_query
+      lambda { |params| resource_class.find(params[:id]) }
+    end
+
+    (QUERY_METHODS - [:index_query, :find_query]).each do |query_method|
+      alias :"default_#{query_method}" :default_find_query
+    end
+
+    def procify option
+      return unless option
+      option.is_a?(Proc) ? option : Proc.new { send option }
+    end
+
+  end
+end

data/lib/resourceful_controller/resource_identification.rb

@@ -0,0 +1,23 @@
+module ResourcefulController
+  module ResourceIdentification
+    extend ActiveSupport::Concern
+
+    delegate :resource_name, :resources_name, :resource_class, :to => :klass
+
+    module ClassMethods
+
+      def resource_name
+        resources_name.singularize
+      end
+
+      def resources_name
+        controller_name
+      end
+
+      def resource_class
+        resource_name.classify.constantize
+      end
+
+    end
+  end
+end

data/lib/resourceful_controller/url_definitions.rb

@@ -0,0 +1,15 @@
+module ResourcefulController
+  module UrlDefinitions
+    def namespace
+      controller_path.split("/")[0..-2]
+    end
+
+    def index_path
+      namespace.push(resources_name)
+    end
+
+    def show_path
+      namespace.push(instance_variable_get(:"@#{resource_name}"))
+    end
+  end
+end

data/lib/resourceful_controller/version.rb

@@ -0,0 +1,3 @@
+module ResourcefulController
+  VERSION = "0.0.1"
+end

data/resourceful_controller.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resourceful_controller/version"
+
+Gem::Specification.new do |s|
+  s.name        = "resourceful_controller"
+  s.version     = ResourcefulController::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ben Eddy"]
+  s.email       = ["bae@foraker.com"]
+  s.homepage    = ""
+  s.summary     = %q{Adds standard REST actions to a controller}
+  s.description = %q{Adds standard REST actions to a controller}
+
+  s.rubyforge_project = "resourceful_controller"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails"
+  s.add_development_dependency "rspec-rails"
+end

data/spec/resourceful_controller_spec.rb

@@ -0,0 +1,109 @@
+require 'resourceful_controller'
+require 'rails'
+require 'action_controller'
+require 'rspec/rails'
+
+class Application < Rails::Application
+end
+
+class TestController < ActionController::Base
+  include ResourcefulController
+end
+
+describe TestController do
+  extend ActionController::TestCase::Behavior
+  include RSpec::Rails::ControllerExampleGroup
+
+  describe "resourceful methods" do
+    before do
+      [:index, :new, :create, :show, :edit, :update, :destroy].each do |method|
+        TestController.send(:remove_method, method) if TestController.new.respond_to?(method)
+      end
+    end
+
+    it "adds all resourceful actions" do
+      TestController.act_resourcefully
+
+      [:index, :new, :create, :show, :edit, :update, :destroy].each do |method|
+        controller.respond_to?(method).should be_true
+      end
+    end
+
+    it "removes excepted methods" do
+      TestController.act_resourcefully :except => :destroy
+
+      [:index, :new, :create, :show, :edit, :update].each do |method|
+        controller.respond_to?(method).should be_true
+      end
+
+      controller.respond_to?(:destroy).should be_false
+    end
+
+    it "only adds specified actions" do
+      TestController.act_resourcefully :only => :destroy
+
+      controller.respond_to?(:destroy).should be_true
+
+      [:index, :new, :create, :show, :edit, :update].each do |method|
+        controller.respond_to?(method).should be_false
+      end
+    end
+  end
+
+  describe "support methods" do
+    before { TestController.act_resourcefully }
+
+    describe "#resource_name" do
+      it "infers the resource name from the controller class" do
+        controller.resource_name.should == "test"
+      end
+    end
+
+    describe "#resource_class" do
+      it "infers the resource class from the controller class" do
+        controller.resource_class.should == Test
+      end
+    end
+
+    describe "query methods" do
+      let(:query_methods) do
+        [:index_query, :find_query, :show_query, :edit_query, :update_query, :destroy_query]
+      end
+
+      it "defines default query methods" do
+        query_methods.each do |query_method|
+          controller.respond_to?(:"default_#{query_method}").should be_true
+        end
+      end
+
+      it "returns the default query" do
+        query = Proc.new { "oncilla" }
+
+        query_methods.each do |query_method|
+          controller.stub(:"default_#{query_method}" => query)
+          controller.send(:"_#{query_method}").call.should == "oncilla"
+        end
+      end
+
+      it "defers to a supplied proc" do
+        query_methods.each do |query_method|
+          TestController.act_resourcefully query_method => lambda { |params| params }
+          controller.send(:"_#{query_method}").call("margay").should == "margay"
+        end
+      end
+
+      it "defers to a supplied method name" do
+        class TestController
+          def my_query ; "margay" ; end
+        end
+
+        query_methods.each do |query_method|
+          TestController.act_resourcefully query_method => :my_query
+          controller.send(:"_#{query_method}").call.should == "margay"
+        end
+      end
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: resourceful_controller
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Eddy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Adds standard REST actions to a controller
+email: 
+- bae@foraker.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/resourceful_controller.rb
+- lib/resourceful_controller/crud_definitions.rb
+- lib/resourceful_controller/query_definitions.rb
+- lib/resourceful_controller/resource_identification.rb
+- lib/resourceful_controller/url_definitions.rb
+- lib/resourceful_controller/version.rb
+- resourceful_controller.gemspec
+- spec/resourceful_controller_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: resourceful_controller
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Adds standard REST actions to a controller
+test_files: 
+- spec/resourceful_controller_spec.rb