crud_methods 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.env
+.powrc
+.rspec
+.zeus*
+tmp

data/.rvmrc

@@ -0,0 +1,2 @@
+[ -e .env ] && . .env
+rvm use 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 zelig
+
+MIT License
+
+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/README.md

@@ -0,0 +1,110 @@
+# CrudeMethods
+
+This is a rails support library that provides a way to define 
+action-dependent controller methods in an order-independent declarative way. The action types default to rails CRUD actions and can be extended or modified on each controller. 
+
+This gem is supposed to be used by restful/resourceful controller abstractions as a simple and flexible interface for the user to set potentially action-specific behavour.
+
+Here I give some end-user cases. Note that this gem does not provide the particular controller abstraction functionalities in the examples, just demonstrate a common use of this specification pattern.
+
+1. a resourceful controller scaffold but adding a search action. The user just hooks into the resource retrieval scope chain, otherwise all behave as a crud index-type action:
+ 
+```ruby
+class ModelsController
+  include ResourfulCrudActions
+  crud_actions :defaults, :index! => [:search]
+  resources :search do |scope|
+    scope.search(params[:search])
+  end
+end
+```
+
+2. Imagine a responder abstraction, then the user can modify action-specific behaviour.
+
+```ruby
+class ModelsController
+  include SmartResponder
+  crud_actions :defaults
+  response_on_success :create do |format|
+    format.html { redirect_to home_path } 
+  end
+end
+```
+
+How these would use `crud_methods` is described in 'Usage' section.
+
+## Features
+
+A crud method allows
+- class-level declaration of action specific behaviour
+- the method definition block is executed in controller instance scope when the method is called on the instantiated controller.
+- actions are hierarchically organized allowing default behaviour for an action _type_ (with bang, like `:index!`)
+- user added custom actions will fall back to crud type they belong to
+- specification on different action-types are order-independent say action is `:show`, if current controller specifies a fallback with `:all`, but a specification for `:show!` is inherited, then the latter wins.
+- for a more thorough understanding, see the [documentation of the `state_methods` gem](https://github.com/zelig/state_methods.git).
+
+## Usage
+
+This section describes how the developer of any controller abstraction gem will use `crud_methods`.
+
+```ruby
+require 'crud_methods'           # require crud_method
+module MyGem::Controller
+  def self.included(base)
+    base.class_eval do
+      include CrudMethods         # include crud_method support
+      crud_method :resource       # declare action-specific method
+      # define your action-specific behaviour here on the class level
+      resource :create!, :new! do        
+        resource_class.new(params[model_name], :as => current_role)
+      end 
+      #...
+    end
+  end
+```
+
+Then the user will do:
+```ruby
+class SignupsController
+  include MyGem::Controller
+  crud_actions :defaults, :new! => [:wait]
+  # instead of signup just put on waiting list
+  resource :wait do
+    resource_class.new(params[model_name], :as => current_role).
+      tap { status = :waiting }
+  end
+end
+```
+
+## Implementation
+
+This gem is basically a paticular use case of the [`state_methods` gem](https://github.com/zelig/state_methods.git) on controller classes where the 'state accessor method' is `action_name` and the default state partition is the usual CRUD actions of rails.
+
+## Gotchas
+
+- do not use `super` within the class-level method definition block. it won't refer to anything reliable. use _fallback_ calls. :TODO: add more info.
+- specifying a method for a type (of action), will not override other specs for a subtype (or particular action) either earlier or later. This may be counterintuitive to some especially that  specifications for action types can be 'hidden' coming via controller inheritance or included modules. :TODO: add more info.
+- see the [documentation of the `state_methods` gem](https://github.com/zelig/state_methods.git)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crud_methods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crud_methods
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/crud_methods.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crud_methods/version'
+
+DESC = "design pattern that allows order-independent class-level definition of action-dependent controller methods for rails - action types default to rails CRUD actions "
+
+Gem::Specification.new do |gem|
+  gem.name          = "crud_methods"
+  gem.version       = CrudMethods::VERSION
+  gem.authors       = ["zelig"]
+  gem.email         = ["viktor.tron@gmail.com"]
+  gem.description   = DESC
+  gem.summary       = DESC
+  gem.homepage      = "https://github.com/zelig/crud_methods"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "state_methods"
+  gem.add_dependency "rails"
+  gem.add_development_dependency 'debugger'
+  gem.add_development_dependency "rspec-rails"
+
+end

data/lib/crud_methods.rb

@@ -0,0 +1,6 @@
+require "crud_methods/version"
+require "crud_methods/controller"
+
+module CrudMethods
+  # Your code goes here...
+end

data/lib/crud_methods/controller.rb

@@ -0,0 +1,50 @@
+require 'state_methods'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module CrudMethods
+
+  ACTIONS = { :C => [:create!, :new!], :U => [:edit!, :update!], :D => [:destroy!], :R => [:show!, :index!] }
+  mattr_accessor :actions
+  @@actions = ACTIONS
+  DEFAULT_ACTIONS = [:new, :create, :edit, :update, :show, :index, :destroy]
+  mattr_accessor :default_actions
+  @@default_actions = DEFAULT_ACTIONS
+  mattr_accessor :default_extension
+  @@default_extension = {}
+  default_actions.each { |a| default_extension[:"#{a}!"] = a }
+
+
+  module Controller
+
+    def self.included(base)
+      base.class_eval do
+        include ::StateMethods
+        _state_partition_for :action_name, :partition => ::CrudMethods.actions
+        include ControllerInstanceMethods
+        extend ControllerClassMethods
+      end
+    end
+
+    module ControllerInstanceMethods
+
+    end
+
+    module ControllerClassMethods
+
+      def crud_actions(*args)
+        args.each do |spec|
+          spec = ::CrudMethods.default_extension if spec == :defaults
+          puts spec
+          _state_partition_for :action_name, :extend => spec
+        end
+        puts _state_partition_for(:action_name).index
+      end
+
+      def crud_method(name)
+        state_method(name, :action_name)
+      end
+
+    end
+
+  end
+end

data/lib/crud_methods/version.rb

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

data/spec/rails_spec.rb

@@ -0,0 +1,261 @@
+require 'spec_helper'
+require 'crud_methods'
+
+require 'rails'
+require 'action_controller/railtie'
+require 'rspec/rails'
+module TestRailsApp
+  class Application < Rails::Application
+    # app config here
+    # config.secret_token = '572c86f5ede338bd8aba8dae0fd3a326aabababc98d1e6ce34b9f5'
+    routes.draw do
+      resources :models
+      get "unknown" => 'anonymous#unknown'
+    end
+    # routes are created for anonymous controllers https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs/anonymous-controller#anonymous-controllers-only-create-resource-routes
+  end
+
+  class ApplicationController < ActionController::Base
+    include CrudMethods::Controller
+    crud_method :test
+    test(:all) { 0 }
+    def default_render
+      render :text => @content
+    end
+  end
+
+  class DefaultTestController < ApplicationController
+    extend(RSpec::Rails::ControllerExampleGroup::BypassRescue)
+    def self.default_actions
+      [:new, :create, :edit, :update, :show, :index, :destroy]
+    end
+    def self.default_action_types
+      default_actions.map { |a| :"#{a}!" }
+    end
+    default_actions.each do |a|
+      define_method(a) {}
+    end
+    def unknown
+    end
+  end
+
+end
+
+def default_actions
+  TestRailsApp::DefaultTestController.default_actions
+end
+
+def default_action_types
+  TestRailsApp::DefaultTestController.default_action_types
+end
+
+class Error
+  def initialize(*args)
+    @args = args
+  end
+  def to_a
+    @args
+  end
+  def to_s
+    to_a.join(' with ')
+  end
+end
+
+def crud_test(action, result, method = :test, *args, &block)
+  spec = case result
+  when Error
+    "when action = #{action} then Controller##{method} raises #{result.to_s}"
+  else
+    "when action = #{action} then Controller##{method} = #{result}"
+  end
+  it spec do
+    crud_test!(action, result, method, *args, &block)
+  end
+end
+
+def crud_test!(action, result, method = :test, *args, &block)
+  case result
+  when Error
+    lambda do
+      _crud_test(action, result, method, *args, &block)
+    end.should raise_error(*result.to_a)
+  else
+    _crud_test(action, result, method, *args, &block).
+      should == result
+  end
+end
+
+def _crud_test(action, result, method = :test, *args, &block)
+  instance_eval(&block) if block_given?
+  get action, :id => "anyid"
+  puts "controller.action_name: #{controller.action_name}"
+  puts "#{controller.class._state_partition_for(:action_name).index}"
+  controller.send(method, *args)
+end
+
+describe 'CrudMethods' do
+
+  context "in a Rails controller", :type => :controller do
+
+    before(:each) do
+      @request = ActionController::TestRequest.new
+    end
+
+    describe "default extension" do
+
+      context "crud method 'test' is set on types only" do
+        controller(TestRailsApp::DefaultTestController) do
+          crud_actions :defaults
+          default_action_types.each { |a| test(a) { a } }
+        end
+
+        it "falls back to :all if action is undeclared" do
+          routes.draw { get "unknown" => 'anonymous#unknown' }
+          # lambda { get :unknown }.should raise_error(NameError)
+          crud_test!(:unknown, 0)
+        end
+
+        default_actions.each do |a|
+          crud_test(a, :"#{a}!")
+        end
+      end
+
+      context "crud method 'test' is set on actions too and override type spec" do
+        controller(TestRailsApp::DefaultTestController) do
+          crud_actions :defaults
+          default_action_types.each { |a| test(a) { a } }
+          default_actions.each { |a| test(a) { a } }
+        end
+
+        it "falls back to :all if action is undeclared" do
+          routes.draw { get "unknown" => 'anonymous#unknown' }
+          # lambda { get :unknown }.should raise_error(NameError)
+          crud_test!(:unknown, 0)
+        end
+
+        default_actions.each do |a|
+          crud_test(a, a)
+        end
+      end
+    end
+
+    describe "alternative extensions" do
+
+      context ":index! => [:index, :list]" do
+
+        controller(TestRailsApp::DefaultTestController) do
+          crud_actions :index! => [:index, :list]
+          default_action_types.each { |a| test(a) { a } }
+          def list
+          end
+        end
+
+        it "falls back to :all if action is undeclared" do
+          routes.draw { get "unknown" => 'anonymous#unknown' }
+          # lambda { get :unknown }.should raise_error(NameError)
+          crud_test!(:unknown, 0)
+        end
+
+        crud_test(:index, :"index!")
+        crud_test(:list, :"index!") { routes.draw { get "list" => 'anonymous#list' } }
+      end
+
+      context ":defaults, :index! => [:index, :list]" do
+
+        controller(TestRailsApp::DefaultTestController) do
+          crud_actions :defaults, :index! => [:index, :list]
+          default_action_types.each { |a| test(a) { a } }
+          def list
+          end
+        end
+
+        it "falls back to :all if action is undeclared" do
+          routes.draw { get "unknown" => 'anonymous#unknown' }
+          # lambda { get :unknown }.should raise_error(NameError)
+          crud_test!(:unknown, 0)
+        end
+
+        default_actions.each do |a|
+          crud_test(a, :"#{a}!")
+        end
+        crud_test(:list, :"index!") { routes.draw { get "list" => 'anonymous#list' } }
+      end
+
+      context ":index => :index!" do
+
+        it "contoller raises" do
+          lambda do Class.new(TestRailsApp::DefaultTestController) do
+              crud_actions :index => :index!
+            end
+          end.should raise_error(::StateMethods::CannotOverrideError, "index!")
+        end
+      end
+
+    end
+
+    context "crud method 'test' set on all crud R and index but not on show" do
+      controller(TestRailsApp::DefaultTestController) do
+        crud_actions :defaults
+        test(:R) { :R }
+        test(:index) { :index }
+      end
+
+      it "falls back to :all if action is undeclared" do
+        routes.draw { get "unknown" => 'anonymous#unknown' }
+        # lambda { get :unknown }.should raise_error(NameError)
+        crud_test!(:unknown, 0)
+      end
+
+      crud_test(:show, :R)
+      crud_test(:index, :index)
+    end
+
+    context "crud method 'test' passes args correctly" do
+      controller(TestRailsApp::DefaultTestController) do
+        crud_actions :defaults
+        test(:index) { |a, *args| [a, *args] }
+      end
+
+      crud_test(:show, Error.new(ArgumentError, "wrong number of arguments (1 for 0)"), :test, 0)
+      crud_test(:show, 0, :test)
+      crud_test(:index, [0, 1], :test, 0, 1)
+      crud_test(:index, [0], :test, 0)
+      crud_test(:index, Error.new(ArgumentError, "wrong number of arguments (0 for 1)"), :test)
+    end
+
+    context "crud method executes in controller instance scope" do
+      default = Class.new(TestRailsApp::DefaultTestController) do
+        crud_actions :defaults
+        crud_method :test1
+        crud_method :test2
+        test1(:all) { undefined_method1 }
+        test2(:all) { undefined_method2 }
+      end
+
+      controller(default) do
+        def undefined_method2
+          'defined'
+        end
+      end
+
+      crud_test(:show, Error.new(NameError), :test1)
+      crud_test(:show, 'defined', :test2)
+    end
+
+    context "crud method delegates to inherited specific state even if superstate is defined in subclass" do
+      default = Class.new(TestRailsApp::DefaultTestController) do
+        crud_actions :defaults
+        test(:index) { 'superclass index' }
+      end
+
+      controller(default) do
+        test(:R) { 'subclass R' }
+      end
+
+      crud_test(:index, 'superclass index')
+      crud_test(:show, 'subclass R')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: crud_methods
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- zelig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: state_methods
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'design pattern that allows order-independent class-level definition
+  of action-dependent controller methods for rails - action types default to rails
+  CRUD actions '
+email:
+- viktor.tron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crud_methods.gemspec
+- lib/crud_methods.rb
+- lib/crud_methods/controller.rb
+- lib/crud_methods/version.rb
+- spec/rails_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zelig/crud_methods
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1289959389357476616
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1289959389357476616
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: design pattern that allows order-independent class-level definition of action-dependent
+  controller methods for rails - action types default to rails CRUD actions
+test_files:
+- spec/rails_spec.rb
+- spec/spec_helper.rb