controller_resources 0.1.2 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTQ3MGFiNmFiMDExMjIxMGJlYWI5NDc3ZDQ0OTVhM2I1YzY5Y2U4Mg==
+    NDliMjAxNWIzOGY5NjE2NzZmNTg3ZDRjMGEwZDdmOTA3NWZjOTM3Mw==
   data.tar.gz: !binary |-
-    NzQ3NGYwYTQ5N2IyOGM3MzJiOWZiNDVkZDE5ODRlNWQ1ODE4MjYyZA==
+    YzY5YWZkY2YwMDQxNjc2NjA4MjlmMjNkMmRmZDBhNzI0NzZmZGM2YQ==
 SHA512:
   metadata.gz: !binary |-
-    MmFmN2NjM2MwMThhYmViMWM0YzMxNDc0ZmU1NTM5ZTQ3MWIwNWFkY2M3NmQ5
-    YmI4NDM3ZWViNTFjOWEyY2JiMWM4OWQzM2I4YTBhZDEyNWFjZjA2OGExMzEx
-    YTdhNWU5Y2Q4NGJhZDczMmMxYWU4OWEyZDJkYzdhY2RkMjg3ODU=
+    ZTYxMmUxYjZiODFmMmRkNTRlNmM0YTc3ZGNmNmQ3MjhjNjA0NjE1NzYzNTI1
+    MWU2MWY1MDE0ZGFhNzkyMGY0YWQ2NDZkYjg4MDYwNDExMTZjODQxMjZkYTlh
+    Zjc1ZDFiZjRhOGY0NTMzZTAyNjY2MTRhYmMxNjVhMTJkMzBlMTE=
   data.tar.gz: !binary |-
-    YThiOTdkZTZhODUyYzc2ZGY1MTljYmRkMDMwY2YwODcyNThhY2I4NTc1MTQz
-    YjEyYWY2ZDA1ZWZmMmJkZTRkN2U5ODY1NTgwOGFiOTQ0ZmI5ZTRjNThhMmUy
-    ZDExOTYyNzY5ZWE5YjdmY2FjNmFlYjJlZGY0MGM3Y2VmYTM2NTk=
+    OWJmYzY1MDQ5ODgwY2RlYTBiNWQ2N2Y3YTk0YTFjOTRhNjI3YjhkMTM4OWQ3
+    MjdkM2Q5NjA3OWRjODZlNTUxYTZjYTRlMDQ1ZDIwNGVjZmY2ZDkyYzJmMDkx
+    YmUwMmIzYmY4M2UxMTRiYzNmNjRkOTBhOGRjYjUyNGI1NjRkMDg=

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.1

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 sudo: false
-cache: bundle
+cache: bundler
 rvm:
-  - 2.0.0
-  - 2.1.6
-  - 2.2.2
+  - 2.3.1
 addons:
   codeclimate:
     repo_token:
@@ -17,4 +15,3 @@ deploy:
   on:
     repo: tubbo/controller_resources
     tags: true
-    rvm: 2.2.2

data/README.md

@@ -6,35 +6,26 @@
 [![Inline docs](http://inch-ci.org/github/tubbo/controller_resources.svg?branch=master)](http://inch-ci.org/github/tubbo/controller_resources)
 
 A Rails engine providing a common DSL for fetching model resources in
-the controller and view layers. It leverages
-[DecentExposure][de], [StrongParameters][sp] and assumes an
-ActiveRecord-like DSL for querying model objects.
-ControllerResources does not assume any part of your stack, instead
-providing generic tools and extensions to ActionController which allow
-you to use the fetched resources however you want.
+the controller and view layers.
 
 ```ruby
-resource :post do
-  permit :title, :category, :body, :is_published
+class PostsController < ApplicationController
+  resource :post
+  respond_to :html
+
+  def index
+    respond_with @posts
+  end
 end
 ```
 
-...and not have to worry about where the `posts` and `post` methods come
-from. If you're used to working with DecentExposure, you'll know that
-we're just using the `expose` macro to set up these resources, and using
-the `resource` macro to populate what we expose and additionally what
-parameters to pass through.
+You can also specify an ancestor, which is used to look up the given
+resource.
 
-You can establish DecentExposure configuration with the `resource` block
-by calling methods which do not exist on the Resource. All of these
-methods are passed down to DecentExposure:
 
-```ruby
-expose :post, param: :post_id
-resource :comment, ancestor: :post do
-  permit :body, :user_id
-end
-```
+In this example, `@comment` is being looked up using
+`@post.comments.find` rather than the default `Comment.find`.
+
 
 ## Installation
 
@@ -50,38 +41,54 @@ And run
 $ bundle install
 ```
 
+Then, include the module in your base controller class:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include ControllerResources
+end
+```
+
 ## Usage
 
-Define your resource in the controller, and you can use methods instead
-of instance variables to access the model object. No more writing finder
-methods!
+Using the `resource` macro, you can define the name of your resource
+which will be used to derive instance variable names and class names for
+your models. ControllerResources assumes that your instance variables
+are named conventionally, and assumes that you follow Rails best
+practices when assigning instance variables in the controller.
 
 ```ruby
-class ItemsController < ApplicationController
-  resource :item do
-    permit :name, :user, :is_private
-  end
+class CommentsController < ApplicationController
+  before_action :find_post
+  resource :comment, ancestor: :post
+  respond_to :html
 
-  def index
-    respond_with items
+  def show
+    respond_with @comment
   end
 
-  def show
-    respond_with item
+  def new
+    @comment = @post.comments.build
   end
 
   def create
-    item.save
-    respond_with item
+    authorize @comment
+    @comment = @post.comments.create permitted_params(Comment)
+    respond_with @comment
+  end
+
+  def update
+    authorize @comment
+    @comment.update permitted_params(Comment)
+    respond_with @comment
   end
-end
-```
 
-In your view, you can use methods instead of instance variables to
-access the model objects passed down into the template:
+  private
 
-```erb
-<%= user.name %>
+  def find_post
+    @post = Post.find params[:post_id]
+  end
+end
 ```
 
 ### Meta-Programming Capabilities
@@ -95,6 +102,34 @@ your view as well as the controller.
 
 For more, consult the [RDoc Documentation][rdoc]
 
+### Customization
+
+As said before, the `model` and `collection` methods are exposed for you
+in the controller, and are what is used as the values for the instance
+variables set in `:find_resource`. You can override these methods in
+your base controller class to perform authorization or decoration logic
+in a consistent manner, like so:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include ControllerResources
+
+  private
+
+  def model
+    super.tap do |record|
+      authorize record
+    end.decorate
+  end
+
+  def collection
+    super.tap do |records|
+      policy_scope records
+    end.decorate
+  end
+end
+```
+
 ## Contributing
 
 Contributions to `ControllerResources` may be made using GitHub pull

data/Rakefile

@@ -6,10 +6,9 @@ require 'controller_resources/version'
 require 'yard'
 require 'travis/release/task'
 
-desc 'Set up the test database for the dummy app'
-task :db do
-  sh 'cd spec/dummy && bundle exec rake db:setup'
-end
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
 
 # Run RSpec code examples
 RSpec::Core::RakeTask.new :test
@@ -27,7 +26,7 @@ YARD::Rake::YardocTask.new :doc
 Travis::Release::Task.new
 
 # CI task
-task default: %i(lint db test build)
+task default: %i(app:db:setup test build)
 
 namespace :ci do
   desc "Rename gem package so it can be released with GitHub."

data/bin/cc-tddium-post-worker

@@ -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('codeclimate-test-reporter', 'cc-tddium-post-worker')
+load Gem.bin_path("codeclimate-test-reporter", "cc-tddium-post-worker")

data/bin/coderay

@@ -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('coderay', 'coderay')
+load Gem.bin_path("coderay", "coderay")

data/bin/erubis

@@ -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('erubis', 'erubis')
+load Gem.bin_path("erubis", "erubis")

data/bin/htmldiff

@@ -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('diff-lcs', 'htmldiff')
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -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('diff-lcs', 'ldiff')
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/nokogiri

@@ -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('nokogiri', 'nokogiri')
+load Gem.bin_path("nokogiri", "nokogiri")

data/bin/pry

@@ -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('pry', 'pry')
+load Gem.bin_path("pry", "pry")

data/bin/rackup

@@ -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('rack', 'rackup')
+load Gem.bin_path("rack", "rackup")

data/bin/rails

@@ -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('railties', 'rails')
+load Gem.bin_path("railties", "rails")

data/bin/rake

@@ -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('rake', 'rake')
+load Gem.bin_path("rake", "rake")