singular_resource 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f053e2406cc78d4fe7039e2aa1d1aa66b52d120
+  data.tar.gz: a4ce51239058b9c8b948a2a033ee337f5b2481b5
+SHA512:
+  metadata.gz: c4eac4db87ae958755b2f441de10a40a5d5016d8b6cd160c4504729bf9fcfd13089967fd86605d9683c698f10edc589adf08bc6015729654206d3d73c4580b94
+  data.tar.gz: 49b1a5f63fffbfab073923ad6a39b2eab8e0fc441c4cfdd4d1dcf621ddca7d2758d104aa7d11921453729322d6175286026914308143c86419e86b1cc667b14c

data/README.md

@@ -0,0 +1,164 @@
+Singular Resource
+=====================
+
+Extracted from decent exposure, attempts to leave the useful parts, and just use `helper_method` to expose your view models.
+
+## DOES
+Allow you to find or initialize a simple resource, removing the boilerplate from CRUD actions.
+
+
+## DOES NOT
+Expose the model in any way, scope the query to a collection method if defined, or deal with collections.
+
+
+## Use
+It provides a private method that performs a query for the document when invoked, unless the id is not defined (`new`, `create`), in which case it returns an initialized model.
+```ruby
+   singular_resource :patient
+```
+
+#### Strategies
+Like `decent_exposure`, it's configurable, and provides different strategies.
+By default, it uses `StrongParametersStrategy`, which only assigns the attributes if a method name is provided via the `attributes` option.
+
+#### Options
+``` ruby
+  :optional => "True if shouldn't fail if document does not exist",
+
+  :model => "Class or name of the model class",
+
+  :finder_parameter => "Name of the parameter that has the document's id",
+
+  :attributes => "Name of the attributes method name if using strong parameters",
+
+  :param_key => "Name of the parameter that has the document's attributes"
+```
+
+## Comparison
+What `singular_resource` proposes is that you go from this:
+
+```ruby
+class Controller
+  def new
+    @person = Person.new(params[:person])
+  end
+
+  def create
+    @person = Person.new(params[:person])
+    if @person.save
+      redirect_to(@person)
+    else
+      render :new
+    end
+  end
+
+  def edit
+    @person = Person.find(params[:id])
+  end
+
+  def update
+    @person = Person.find(params[:id])
+    if @person.update_attributes(params[:person])
+      redirect_to(@person)
+    else
+      render :edit
+    end
+  end
+end
+```
+
+To something like this:
+
+```ruby
+class Controller
+  expose(:person)
+
+  def create
+    if person.save
+      redirect_to(person)
+    else
+      render :new
+    end
+  end
+
+  def update
+    if person.save
+      redirect_to(person)
+    else
+      render :edit
+    end
+  end
+end
+```
+
+### With [draper](http://github.com/drapergem/draper)
+
+If you use decorators, you can go from something like this:
+
+```ruby
+class Controller
+  def new
+    @person = Person.new(params[:person]).decorate
+  end
+
+  def create
+    @person = Person.new(params[:person])
+    if @person.save
+      redirect_to(@person)
+    else
+      @person = @person.decorate
+      render :new
+    end
+  end
+
+  def edit
+    @person = Person.find(params[:id]).decorate
+  end
+
+  def update
+    @person = Person.find(params[:id])
+    if @person.update_attributes(params[:person])
+      redirect_to(@person)
+    else
+      @person = @person.decorate
+      render :edit
+    end
+  end
+end
+```
+
+To something like this:
+
+```ruby
+class Controller
+  before_filter :decorate_person
+
+  singular_resource(:person)
+
+  def create
+    if person.save
+      redirect_to(person)
+    else
+      render :new
+    end
+  end
+
+  def update
+    if person.save
+      redirect_to(person)
+    else
+      render :edit
+    end
+  end
+
+  private
+    def decorate_person
+      @person = person.decorate
+    end
+end
+```
+
+If you think that the `before_filter` is nasty or don't like ivars in your views, so do I! Check the [present](http://github.com/ElMassimo/present) gem
+
+### Special Thanks
+Singular Resource is a subset of [decent_exposure](https://github.com/voxdolo/decent_exposure).

data/lib/singular_resource/configuration.rb

@@ -0,0 +1,19 @@
+module SingularResource
+  class Configuration
+    def initialize(&block)
+      instance_exec(&block) if block_given?
+    end
+
+    def merge(other)
+      options.merge(other)
+    end
+
+    def options
+      @options ||= {}
+    end
+
+    def method_missing(key,value)
+      self.options[key] = value
+    end
+  end
+end

data/lib/singular_resource/error.rb

@@ -0,0 +1,4 @@
+module SingularResource
+  # Public: A generic Error class for singular_resource
+  class Error < ::StandardError; end
+end

data/lib/singular_resource/finder.rb

@@ -0,0 +1,17 @@
+require 'singular_resource/inflector'
+
+module SingularResource
+  class Finder
+    attr_accessor :name, :strategy, :options
+
+    def initialize(name, strategy, options)
+      self.name = name.to_s
+      self.strategy = strategy
+      self.options = options
+    end
+
+    def call(controller)
+      strategy.new(controller, name, options).resource
+    end
+  end
+end

data/lib/singular_resource/finder_strategizer.rb

@@ -0,0 +1,13 @@
+require 'singular_resource/finder'
+require 'singular_resource/strategies/strong_parameters_strategy'
+
+module SingularResource
+  class FinderStrategizer
+
+    def self.strategy_for(name, options={})
+      strategy_class = options.delete(:strategy) || Strategies::StrongParametersStrategy
+      options = options.merge(name: name)
+      Finder.new(name, strategy_class, options)
+    end
+  end
+end

data/lib/singular_resource/inflector.rb

@@ -0,0 +1,27 @@
+require 'active_support/inflector'
+require 'active_support/core_ext/string'
+
+module SingularResource
+  class Inflector
+    attr_reader :original, :model
+
+    def initialize(name, model)
+      @original = name.to_s
+      @model = model
+    end
+
+    alias name original
+
+    def param_key
+      model.name.param_key
+    end
+
+    def parameter
+      "#{model.name.singularize}_id"
+    end
+
+    def self.class_for(name)
+      name.to_s.classify.constantize
+    end
+  end
+end

data/lib/singular_resource/resource.rb

@@ -0,0 +1,55 @@
+require 'singular_resource/finder_strategizer'
+require 'singular_resource/configuration'
+require 'simple_memoizer'
+
+module SingularResource
+  module Resource
+    extend ActiveSupport::Concern
+    include SimpleMemoizer
+
+    included do
+      class_attribute :_singular_configurations
+      self._singular_configurations ||= Hash.new(Configuration.new)
+    end
+
+    module ClassMethods
+      def singular_configuration(name=:default,&block)
+        self._singular_configurations = _singular_configurations.merge(name => Configuration.new(&block))
+      end
+
+      def singular_resource(name, options={})
+        enforce_method_name_not_used!(name)
+
+        config = options[:config] || :default
+        options = _singular_configurations[config].merge(options)
+
+        _resource_finders[name] = finder = FinderStrategizer.strategy_for(name, options)
+
+        define_resource_method(name, finder)
+      end
+
+      private
+
+      def _resource_finders
+        @_resource_finders ||= {}
+      end
+
+      def define_resource_method(name, finder)
+        define_method(name) do
+          finder.call(self)
+        end
+        memoize name
+        hide_action name
+      end
+
+      def enforce_method_name_not_used!(name)
+        if ActionController::Base.instance_methods.include?(name.to_sym)
+          Kernel.abort "[ERROR] You are adding a singular resource by the `#{name}` method, " \
+            "which overrides an existing ActionController method of the same name. " \
+            "Consider a different resource name\n" \
+            "#{caller.first}"
+        end
+      end
+    end
+  end
+end

data/lib/singular_resource/strategies/assign_attributes.rb

@@ -0,0 +1,20 @@
+module SingularResource
+  module Strategies
+    module AssignAttributes
+
+      def attributes
+        raise 'Implement in submodule'
+      end
+
+      def assign_attributes?
+        !get? && !delete? && attributes.present?
+      end
+
+      def resource
+        super.tap do |r|
+          r.attributes = attributes if r && assign_attributes?
+        end
+      end
+    end
+  end
+end

data/lib/singular_resource/strategies/assign_from_method.rb

@@ -0,0 +1,19 @@
+require 'singular_resource/strategies/assign_attributes'
+
+module SingularResource
+  module Strategies
+    module AssignFromMethod
+      include AssignAttributes
+
+      def attributes
+        @attributes ||= method_attributes || {}
+      end
+
+      private
+
+      def method_attributes
+        controller.send(options[:attributes]) if options[:attributes]
+      end
+    end
+  end
+end

data/lib/singular_resource/strategies/assign_from_params.rb

@@ -0,0 +1,19 @@
+require 'singular_resource/strategies/assign_attributes'
+
+module SingularResource
+  module Strategies
+    module AssignFromParams
+      include AssignAttributes
+
+      def attributes
+        @attributes ||= params[param_key] || {}
+      end
+
+      private
+
+      def param_key
+        options[:param_key] || inflector.param_key
+      end
+    end
+  end
+end

data/lib/singular_resource/strategies/eager_attributes_strategy.rb

@@ -0,0 +1,8 @@
+require 'singular_resource/strategies/mongoid_strategy'
+require 'singular_resource/strategies/assign_from_params'
+
+module SingularResource
+  class EagerAttributesStrategy < MongoidStrategy
+    include Strategies::AssignFromParams
+  end
+end

data/lib/singular_resource/strategies/mongoid_strategy.rb

@@ -0,0 +1,25 @@
+require 'singular_resource/strategy'
+require 'active_support/core_ext/module/delegation'
+
+module SingularResource
+  class MongoidStrategy < Strategy
+    delegate :get?, :delete?, :to => :request
+    delegate :parameter,      :to => :inflector
+
+    def id
+      params[parameter] || params[finder_parameter]
+    end
+
+    def finder_parameter
+      options[:finder_parameter] || :id
+    end
+
+    def resource
+      if id
+        options[:optional] ? model.where(id: id).first : model.find(id)
+      else
+        model.new
+      end
+    end
+  end
+end

data/lib/singular_resource/strategies/strong_parameters_strategy.rb

@@ -0,0 +1,10 @@
+require 'singular_resource/strategies/mongoid_strategy'
+require 'singular_resource/strategies/assign_from_method'
+
+module SingularResource
+  module Strategies
+    class StrongParametersStrategy < MongoidStrategy
+      include Strategies::AssignFromMethod
+    end
+  end
+end

data/lib/singular_resource/strategy.rb

@@ -0,0 +1,40 @@
+require 'singular_resource/inflector'
+
+module SingularResource
+  class Strategy
+    attr_reader :controller, :name, :options
+    attr_writer :model, :inflector
+
+    def initialize(controller, name, options={})
+      @controller, @name, @options = controller, name.to_s, options
+    end
+
+    def resource
+      raise 'Implement in subclass'
+    end
+
+    protected
+
+    def inflector
+      @inflector ||= SingularResource::Inflector.new(name, model)
+    end
+
+    def model
+      @model ||= case options[:model]
+                 when Class, Module
+                   options[:model]
+                 else
+                   name_or_model = options[:model] || name
+                   SingularResource::Inflector.class_for(name_or_model)
+                 end
+    end
+
+    def params
+      controller.params
+    end
+
+    def request
+      controller.request
+    end
+  end
+end

data/lib/singular_resource.rb

@@ -0,0 +1,6 @@
+require 'singular_resource/resource'
+require 'singular_resource/error'
+
+ActiveSupport.on_load(:action_controller) do
+  include SingularResource::Resource
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: singular_resource
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_memoizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extracted from decent exposure, attempts to leave the useful parts, and
+  just use `helper_method` to expose your view models.
+email:
+- maximomussini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/singular_resource.rb
+- lib/singular_resource/configuration.rb
+- lib/singular_resource/error.rb
+- lib/singular_resource/finder.rb
+- lib/singular_resource/finder_strategizer.rb
+- lib/singular_resource/inflector.rb
+- lib/singular_resource/resource.rb
+- lib/singular_resource/strategies/assign_attributes.rb
+- lib/singular_resource/strategies/assign_from_method.rb
+- lib/singular_resource/strategies/assign_from_params.rb
+- lib/singular_resource/strategies/eager_attributes_strategy.rb
+- lib/singular_resource/strategies/mongoid_strategy.rb
+- lib/singular_resource/strategies/strong_parameters_strategy.rb
+- lib/singular_resource/strategy.rb
+homepage: https://github.com/ElMassimo/singular_resource
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Subset of decent_exposure, leaves the good parts and dismisses the 'magic'
+test_files: []