controller_resources 0.1.2 → 1.0.0

data/bin/rspec

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('rspec-core', 'rspec')
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('rubocop', 'rubocop')
+load Gem.bin_path("rubocop", "rubocop")

data/bin/ruby-parse

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('parser', 'ruby-parse')
+load Gem.bin_path("parser", "ruby-parse")

data/bin/ruby-rewrite

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('parser', 'ruby-rewrite')
+load Gem.bin_path("parser", "ruby-rewrite")

data/bin/sprockets

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('sprockets', 'sprockets')
+load Gem.bin_path("sprockets", "sprockets")

data/bin/thor

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('thor', 'thor')
+load Gem.bin_path("thor", "thor")

data/bin/yard

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('yard', 'yard')
+load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('yard', 'yardoc')
+load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('yard', 'yri')
+load Gem.bin_path("yard", "yri")

data/controller_resources.gemspec

@@ -33,12 +33,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
   spec.add_development_dependency 'rubocop', '~> 0'
   spec.add_development_dependency 'capybara', '~> 2'
-  # spec.add_development_dependency 'poltergeist', '~> 1.7'
   spec.add_development_dependency 'database_cleaner', '~> 1'
   spec.add_development_dependency 'pry', '~> 0'
   spec.add_development_dependency 'yard', '~> 0'
   spec.add_development_dependency 'travis-release', '~> 0'
 
-  spec.add_dependency 'rails', '~> 4'
-  spec.add_dependency 'decent_exposure', '~> 2'
+  spec.add_dependency 'rails'
 end

data/lib/controller_resources.rb

@@ -1,17 +1,127 @@
 require 'active_support/all'
-require 'decent_exposure'
 require 'controller_resources/version'
 
-# A mixin for ActionController that helps define singular and collection
-# model resources with permitted attributes all in one big macro.
+# A mixin for +ActionController+ for easily and consistently finding
+# resource objects to be used in the controller and view layer.
 module ControllerResources
-  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
 
-  autoload :NotDefinedError
-  autoload :Extension
-  autoload :Engine
-end
+  included do
+    class_attribute :resource_name
+    class_attribute :resource_finder_method
+    class_attribute :resource_search_method
+    class_attribute :resource_id_param
+    class_attribute :resource_class_name
+    class_attribute :resource_ancestor_name
+    class_attribute :collection_actions
+    self.collection_actions ||= %i(index)
+  end
+
+  class_methods do
+    # Define the resource this controller will be manipulating, and call
+    # the +:find_resource+ callback before most actions in order to set
+    # up the resource automatically.
+    #
+    # @param [Symbol] name - Lowercased name of the resource.
+    # @option [Symbol] :ancestor - Optional ancestor ivar name.
+    def resource(name, ancestor: nil, finder: :find, searcher: :where, param: :id, class_name: nil)
+      self.resource_name = name.to_s
+      self.resource_ancestor_name = ancestor.to_s if ancestor.present?
+      self.resource_search_method = searcher
+      self.resource_finder_method = finder
+      self.resource_id_param = param
+      self.resource_class_name = class_name || resource_name.classify
+
+      before_action :find_resource, except: [:new, :create]
+    end
+  end
+
+  protected
+
+  # Pluralized name of the resource.
+  #
+  # @protected
+  # @return [String]
+  def plural_resource_name
+    resource_name.pluralize
+  end
+
+  # Runs before every action to determine its resource in an instance
+  # variable.
+  #
+  # @protected
+  def find_resource
+    if collection?
+      instance_variable_set "@#{plural_resource_name}", collection
+    else
+      instance_variable_set "@#{resource_name}", model
+    end
+  end
+
+  # Find the collection by its search params.
+  #
+  # @protected
+  # @return [Object]
+  def collection
+    model_class.send resource_search_method, search_params
+  end
+
+  # Find the model by its ID, or return a new model.
+  #
+  # @protected
+  # @return [Object]
+  def model
+    model_class.send resource_finder_method, resource_id
+  end
+
+  # Find the ancestor of this model if it's defined. Used in the
+  # +model_class+ to use as the base object by which we derive models in
+  # this controller.
+  #
+  # @protected
+  # @return [Object] or +nil+ if the ancestor was not configured.
+  def ancestor
+    return unless resource_ancestor_name.present?
+    instance_variable_get "@#{resource_ancestor_name}"
+  end
+
+  private
+
+  # Test whether current +action_name+ is in the +collection_actions+
+  # Array.
+  #
+  # @return [Boolean] +true+ if action needs a collection as its resource.
+  def collection?
+    collection_actions.include? action_name.to_sym
+  end
+
+  # Override this method to provide your own search params.
+  #
+  # @private
+  # @return [ActionController::Parameters] Params given to the search
+  # method.
+  def search_params
+    params.permit!.except(:controller, :action, :format)
+  end
+
+  # @private
+  # @return [Class] Class constant for the given resource derived from
+  # +resource_name+.
+  def model_class
+    ancestor_resource || resource_class_name.constantize
+  end
+
+  def ancestor_resource
+    return unless ancestor.present?
+    return unless ancestor.respond_to? plural_resource_name
+    ancestor.send plural_resource_name
+  end
 
-ActiveSupport.on_load :action_controller do
-  include ControllerResources::Extension
+  # Override to provide your own finder param.
+  #
+  # @private
+  # @return [String] Param used to find a model, by default +params[:id]+
+  def resource_id
+    params[resource_id_param]
+  end
 end

data/lib/controller_resources/version.rb

@@ -1,4 +1,4 @@
 module ControllerResources
   # Current version of this gem.
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,4 +1,6 @@
 class ApplicationController < ActionController::Base
+  include ControllerResources
+
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception

data/spec/dummy/app/controllers/posts_controller.rb

@@ -1,7 +1,5 @@
 class PostsController < ApplicationController
-  resource :post do
-    permit :title, :body
-  end
+  resource :post
 
   # GET /posts
   def index
@@ -15,7 +13,7 @@ class PostsController < ApplicationController
 
   # GET /posts/new
   def new
-    render :new
+    @post = Post.new
   end
 
   # GET /posts/1/edit
@@ -25,19 +23,28 @@ class PostsController < ApplicationController
 
   # POST /posts
   def create
-    post.save
-    redirect_to post
+    @post = Post.create edit_params
+    flash[:notice] = 'Post created.'
+    redirect_to @post
   end
 
   # PATCH/PUT /posts/1
   def update
-    post.update(edit_params)
-    redirect_to post
+    @post.update edit_params
+    flash[:notice] = 'Post updated.'
+    redirect_to @post
   end
 
   # DELETE /posts/1
   def destroy
-    post.destroy
+    @post.destroy
+    flash[:notice] = 'Post deleted.'
     redirect_to posts_path
   end
+
+  private
+
+  def edit_params
+    params.require(:post).permit :title, :body
+  end
 end

data/spec/dummy/app/views/posts/_form.html.erb

@@ -1,4 +1,4 @@
-<%= form_for post do |f| %>
+<%= form_for @post do |f| %>
   <div class="field">
     <%= f.label :title, 'Title' %><br>
     <%= f.text_field :title %>

data/spec/dummy/app/views/posts/edit.html.erb

@@ -2,5 +2,5 @@
 
 <%= render 'form' %>
 
-<%= link_to 'Show', post %> |
+<%= link_to 'Show', @post %> |
 <%= link_to 'Back', posts_path %>

data/spec/dummy/app/views/posts/index.html.erb

@@ -12,8 +12,8 @@
   </thead>
 
   <tbody>
-    <% posts.each do |post| %>
-      <tr>
+    <% @posts.each do |post| %>
+      <tr id="post-<%= post.id %>">
         <td><%= post.title %></td>
         <td><%= post.body %></td>
         <td><%= link_to 'Show', post %></td>