controller_resources 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 1813e22346789043275cf46f1a6e554396d2b454
-  data.tar.gz: 4e2e6622d6c1cb24d07fac8ef82c6c373130ddac
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmIwYmQ2N2FjMzJiMTdkMjkzY2EzNjhmMWZiOWUxMDhiYmRlYjJkNA==
+  data.tar.gz: !binary |-
+    NGI1YzdhZjA0OGZkYzc4ZjM0NmRkNDg3MmEzNDI0M2JiNWY0MjE4MQ==
 SHA512:
-  metadata.gz: bb9fa68805b138bf1c1b7d0efaaa134e46c5b75864e8822b99ebe97f14027a011c1acf287a763b00c0dc843cf85f981e4fbd61c44c2aec2bb0ea5c6659fa6ff3
-  data.tar.gz: 42cc040fb18486bf5df3a8b4b7cfc02ffb2267bc9fd6cab812de9f240d3538ea32f609c7f3c1cf5a996744c85a7729b3e367de89c7860e4e4f5e63f0aba5ace0
+  metadata.gz: !binary |-
+    NmQyOWQyMzJmYzEzM2QwZGQ0NDBiNWE1ZTIyZjEyNDMwYzI5NDkwMjBhYTc5
+    ZjA4YWI2YzUzN2U4NjhiNGNlZmQxZDE3MjIzZDk2ZjQwYjUwYTk2ZTQ1MDEw
+    NzU1MWUwZjhmNzk2NDlkZTBkNTlhOTk1ZTZiZTdmZGY3YTIyMGY=
+  data.tar.gz: !binary |-
+    NjQxOGY3Nzc4YzJmZTBmNWYxZWQyZjNiYzBlZDAwNzg2NzYxMWEwNWYzMGI1
+    ZWYzYzY3ZjAzNWFjMGYwMWMxMWI4MTE3ZWViYmFkYWIwZjRjNDM2YzFjMDMz
+    MzAwNzY5ZTgxYTRhNmVhOGRmMmJkMzdhYmY4OGRlN2FlZWViYTA=

data/.gitignore

@@ -16,3 +16,5 @@ mkmf.log
 /vendor
 .env
 tags
+/spec/dummy/tmp
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -3,5 +3,15 @@ AllCops:
     - spec/dummy/**/*
     - vendor/**/*
     - bin/**/*
+    - spec/support/**/*
+
 Metrics/AbcSize:
   Max: 32
+
+Style/Documentation:
+  Exclude:
+    - lib/controller_resources/version.rb
+    - spec/**/*.rb
+
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 2.0.0
   - 2.1.6
   - 2.2.2
 cache: bundle
-before_script: ./bin/rake db
-script: ./bin/rake test
 addons:
   codeclimate:
     repo_token:

data/README.md

@@ -3,10 +3,11 @@
 [![Build Status](https://travis-ci.org/tubbo/controller_resources.svg)](https://travis-ci.org/tubbo/controller_resources)
 [![Code Climate](https://codeclimate.com/github/tubbo/controller_resources/badges/gpa.svg)](https://codeclimate.com/github/tubbo/controller_resources)
 [![Test Coverage](https://codeclimate.com/github/tubbo/controller_resources/badges/coverage.svg)](https://codeclimate.com/github/tubbo/controller_resources)
+[![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
+[DecentExposure][de], [StrongParameters][sp] and assumes an
 [ActiveRecord][ar]-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
@@ -14,8 +15,7 @@ you to use the fetched resources however you want.
 
 ```ruby
 resource :post do
-  search :title, :category
-  modify :title, :category, :body, :is_published
+  permit :title, :category, :body, :is_published
 end
 ```
 
@@ -31,10 +31,8 @@ methods are passed down to DecentExposure:
 
 ```ruby
 expose :post, param: :post_id
-resource :comment do
-  ancestor :post
-  search :body
-  modify :body, :user_id
+resource :comment, ancestor: :post do
+  permit :body, :user_id
 end
 ```
 
@@ -46,22 +44,10 @@ Add this line to your application's Gemfile:
 gem 'controller_resources'
 ```
 
-Then run the following generator to generate the locale files for
-Responders:
+And run
 
 ```bash
-$ rails generate responders:install
-```
-
-This will also insert Responders into your `ApplicationController`. If
-you do not want this, be sure to include the following code in a base
-controller somewhere...this is the best way for `ControllerResources` to
-function:
-
-```ruby
-class ApplicationController < ActionController::Base
-  responders :flash, :http_cache
-end
+$ bundle install
 ```
 
 ## Usage
@@ -73,8 +59,7 @@ methods!
 ```ruby
 class ItemsController < ApplicationController
   resource :item do
-    search :name, :user
-    modify :name, :user, :is_private
+    permit :name, :user, :is_private
   end
 
   def index
@@ -99,50 +84,16 @@ access the model objects passed down into the template:
 <%= user.name %>
 ```
 
-<<<<<<< HEAD
-You can also use some given helpers for establishing authorization logic
-in ApplicationController. Since `ControllerResources` is included by
-default, you can use the given `current_resource` method to tell Pundit
-(for example) which policy to use in authorization:
-
-```ruby
-class ApplicationController < ActionController::Base
-  before_action :authenticate_user!
-  before_action :authorize_user!
-
-  rescue_from Pundit::NotAuthorizedError, with: :forbidden
-
-  def forbidden
-    render 'forbidden', status: :forbidden
-  end
-
-  private
-
-  def authorize_user!
-    authorize current_user, current_resource, current_action
-  end
-
-  def current_action
-    :"#{action_name}?"
-  end
-end
-```
-
-This `current_resource` method is populated by the given configured
-Resource object, which will attempt to classify its `model_name` and
-provide a class constant that can be used here. In the
-`PostsController#show` action, for example, that call to `authorize` would be
-partially expanded like this:
-
-```ruby
-authorize current_user, Post, :show?
-```
+### Meta-Programming Capabilities
 
-(where `current_user` is the authenticated User found by Devise)
+Since `ControllerResources` is programatically defining exposure methods
+for you, it also keeps references to the name given in the `resource`
+block so you can infer what kind of object you are using in your view.
+The `model_name`, `collection_name` and `model` / `collection` methods
+are included as helpers along with the rest of the exposure methods in
+your view as well as the controller.
 
-While ControllerResources doesn't provide authorization or
-authentication helpers, it does provide the necessary methods to aid
-your own authorization and authentication frameworks in their job.
+For more, consult the [RDoc Documentation][rdoc]
 
 ## Contributing
 
@@ -150,16 +101,51 @@ Contributions to `ControllerResources` may be made using GitHub pull
 requests. You must include accompanying tests, and all tests must pass
 for any contribution to be considered.
 
+**NOTE:** Running tests requires that you have [PhantomJS][pjs]
+installed.
+
 To run tests:
 
 ```bash
-$ rake test
+$ bin/rake test
 ```
 
 This will also use Rubocop to lint-check your code so it adheres to our
 style guide.
 
+## Releasing
+
+All acceptance testing and final RubyGems.org releasing is performed
+automatically by [Travis CI][ci]. When a new gem version needs to be
+released, one with push access to the repo can update the version by
+running the following Rake task, which will tag the latest version of
+the gem and push all commits to GitHub, where it will be picked up by
+Travis and auto-deployed to [RubyGems][rg]:
+
+```bash
+$ bin/rake release
+```
+
+## Compatibility
+
+ControllerResources adheres to the [Semantic Versioning][sv]
+standard for publishing new versions of the library. Bug fixes will be
+pushed in patch updates, while new features that maintain compatibility
+will be available in minor updates. Major updates are reserved for new
+features that break existing compatibility.
+
+### Ruby version support
+
+This project will be tested against any version of MRI that is currently
+being supported by the Ruby core team. It is not currently being tested
+on JRuby or Rubinius. For more information on what versions of Ruby
+we're testing, see [Travis CI][ci].
+
 [de]: https://github.com/hashrocket/decent_exposure
-[rp]: https://github.com/plataformatec/responders
 [sp]: https://github.com/rails/strong_parameters
-
+[ci]: https://travis-ci.org
+[rg]: https://rubygems.org
+[pjs]: http://phantomjs.org
+[sv]: http://semver.org
+[rdoc]: http://rubydoc.info/github/tubbo/controller_resources/master
+[ar]: http://guides.rubyonrails.org/active_record_basics.html

data/Rakefile

@@ -5,12 +5,25 @@ require 'rubocop/rake_task'
 
 desc 'Set up the test database for the dummy app'
 task :db do
-  sh 'cd spec/dummy && bundle exec rake db:create db:migrate'
+  sh 'cd spec/dummy && bundle exec rake db:setup'
 end
 
-RSpec::Core::RakeTask.new :spec
+# Run RSpec code examples
+RSpec::Core::RakeTask.new :test
 
+# Run RuboCop lint checks
 RuboCop::RakeTask.new :lint
 
-desc 'Run Rubocop lint checks and RSpec code examples'
-task test: %w(lint spec)
+# Clear out default Bundler release task
+Rake::Task['release'].clear
+
+desc "Release version to RubyGems via Travis-CI"
+task release: %w(
+  build release:guard_clean release:source_control_push
+) do
+  Bundler.ui.confirm 'Please wait for Travis-CI to build the gem'
+  Bundler.ui.confirm 'https://travis-ci.org/tubbo/controller_resources'
+end
+
+# CI task
+task default: %i(lint db test build)

data/bin/coderay

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('coderay', 'coderay')

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/controller_resources.gemspec

@@ -4,36 +4,39 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'controller_resources/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'controller_resources'
-  spec.version       = ControllerResources::VERSION
-  spec.authors       = ['Tom Scott']
-  spec.email         = ['tubbo@psychedeli.ca']
-  spec.summary       = '
+  spec.name = 'controller_resources'
+  spec.version = ControllerResources::VERSION
+  spec.authors = ['Tom Scott']
+  spec.email = ['tubbo@psychedeli.ca']
+  spec.summary = '
     A controller DSL for Rails that allows you to easily and quickly
     define both singular and collection model resources that can be
     operated on within the controller.
   '.strip
-  spec.description   = spec.summary + '
+  spec.description = spec.summary + '
     Attempts to DRY up most of the boilerplate code at the top of
     each controller used to set up its state.
   '.strip
-  spec.homepage      = 'https://github.com/tubbo/controller_resources'
-  spec.license       = 'MIT'
+  spec.homepage = 'https://github.com/tubbo/controller_resources'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^|spec/})
+  spec.files = `git ls-files -z`.split("\x0")
+  # spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^|spec/})
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'pg'
-  spec.add_development_dependency 'generator_spec'
   spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'yard'
 
   spec.add_dependency 'rails'
   spec.add_dependency 'decent_exposure'
-  spec.add_dependency 'responders'
 end

data/lib/controller_resources/engine.rb

@@ -1,11 +1,12 @@
 module ControllerResources
-  # Extensions for the including Rails app.
+  # Extends +ActionController::Base+ in the host app to include the
+  # +ControllerResources+ mixin by default.
   class Engine < ::Rails::Engine
     isolate_namespace ControllerResources
 
-    config.to_prepare do
-      ApplicationController.class_eval do
-        include ControllerResources::Extension
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.class_eval do
+        include ControllerResources
       end
     end
   end

data/lib/controller_resources/not_defined_error.rb

@@ -0,0 +1,12 @@
+module ControllerResources
+  # Thrown when a +resource+ has not been defined, yet the controller
+  # attempts to call the generated +edit_params+ method.
+  class NotDefinedError < RuntimeError
+    def initialize(*args)
+      super
+      @message = %(
+        Call to #edit_params failed: Resource not defined.
+      )
+    end
+  end
+end

data/lib/controller_resources/version.rb

@@ -1,4 +1,4 @@
-# :nodoc:
 module ControllerResources
-  VERSION = '0.0.6'
+  # Current version of this gem.
+  VERSION = '0.1.0'
 end

data/lib/controller_resources.rb

@@ -1,16 +1,151 @@
 require 'active_support/all'
 require 'decent_exposure'
-require 'responders'
 require 'controller_resources/version'
+require 'controller_resources/engine'
+require 'controller_resources/not_defined_error'
 
-# A controller DSL for Rails that allows you to easily and quickly define
+# The DSL mixin for ActionController that allows you to quickly define
 # both singular and collection model resources that can be operated on
 # within the controller. Attempts to DRY up most of the boilerplate code
 # at the top of each controller used to set up its state.
+#
+# @author Tom Scott
+#
+# @example
+#
+#   class PostsController < ApplicationController
+#     resource :post do
+#       permit :title, :body, :author_id
+#     end
+#
+#     def index
+#       respond_with posts
+#     end
+#
+#     def show
+#       respond_with post
+#     end
+#
+#     def create
+#       post.save
+#       respond_with post
+#     end
+#
 module ControllerResources
-  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
 
-  autoload :Engine
-  autoload :Resource
-  autoload :Extension
+  included do
+    # Given name of the model as supplied to the +resource+ directive.
+    #
+    # @attr_accessor [Symbol]
+    cattr_accessor :model_name
+
+    # Collection name computed by pluralizing the given model name.
+    #
+    # @attr_accessor [Symbol]
+    cattr_accessor :collection_name
+
+    # A collection of arguments supplied to +StrongParameters#permit+
+    # that is used in the +edit_params+ method to easily define
+    # attributes which need to be whitelisted for mass assignment.
+    #
+    # @attr_accessor [Array]
+    cattr_accessor :params_to_permit
+
+    # Configures +DecentExposure+ to use the +edit_params+ method
+    # defined by this module as the default attributes for mass
+    # assignment.
+    decent_configuration do
+      attributes :edit_params
+    end
+
+    helper_method :model, :collection
+  end
+
+  class_methods do
+    # Define resources based on the given name and decent exposure
+    # options. Uses +DecentExposure+ to define said resources and
+    # stores the generated names in the controller's configuration.
+    #
+    # If a block is given, one can also call additional DSL methods
+    # like +permit+.
+    #
+    # @param [Symbol] name - the name of the model exposure, which
+    # is pluralized to compute the name of the collection exposure and
+    # stored to +model_name+.
+    # @param [Hash] options - passed wholesale to both +expose+ methods,
+    # and useful for defining custom +DecentExposure+ options.
+    # @param &block - a block that is yielded after +expose+ methods are
+    # defined, and used primarily to set permittable params.
+    # @example
+    #
+    #   expose :author
+    #   resource :post, ancestor: :author
+    #
+    def resource(name, options = {})
+      self.model_name = name
+      self.collection_name = "#{name}".pluralize.to_sym
+
+      expose model_name, options
+      expose collection_name, options
+
+      yield if block_given?
+    end
+
+    private
+
+    # Permit the given attributes in +StrongParameters+.
+    #
+    # @example
+    #
+    #   expose :author
+    #   resource :post, ancestor: :author do
+    #     permit :title, :body
+    #   end
+    #
+    def permit(*permittable_params)
+      self.params_to_permit = permittable_params
+    end
+  end
+
+  # Reader method for the defined singular resource.
+  #
+  # @return [Object] the model object or +nil+ if no resource has been
+  # defined.
+  def model
+    return unless resource?
+    public_send model_name
+  end
+
+  # Reader method for the defined collection resource.
+  #
+  # @return [Object] the collection of models or +nil+ if no resource
+  # has been defined.
+  def collection
+    return unless resource?
+    public_send collection_name
+  end
+
+  # White-listed parameters for mass assignment as defined by
+  # +StrongParameters+. Throws a +ControllerResources::NotDefinedError+
+  # if no +resource+ block has been defined on this controller.
+  #
+  # @return [ActionController::Parameters] the +StrongParameters+ hash.
+  # @raise [ControllerResources::NotDefinedError] when no +resource+ has
+  # been defined on this controller.
+  def edit_params
+    fail NotDefinedError unless resource?
+    return params.require(model_name).permit! unless params_to_permit.present?
+    params.require(model_name).permit(*params_to_permit)
+  end
+
+  private
+
+  # Whether a +resource+ directive has been invoked on this controller.
+  #
+  # @private
+  # @return [Boolean]
+  def resource?
+    model_name.present?
+  end
 end

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

@@ -1,17 +1,16 @@
 class PostsController < ApplicationController
   resource :post do
-    search :title
-    modify :title, :body
+    permit :title, :body
   end
 
   # GET /posts
   def index
-    respond_with posts
+    render :index
   end
 
   # GET /posts/1
   def show
-    respond_with post
+    render :show
   end
 
   # GET /posts/new
@@ -27,18 +26,18 @@ class PostsController < ApplicationController
   # POST /posts
   def create
     post.save
-    respond_with post
+    redirect_to post
   end
 
   # PATCH/PUT /posts/1
   def update
     post.update(edit_params)
-    respond_with post
+    redirect_to post
   end
 
   # DELETE /posts/1
   def destroy
     post.destroy
-    respond_with post
+    redirect_to posts_path
   end
 end