controller_resources 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6641d78693a54de498d10f9d1d53243bcaf1997d
-  data.tar.gz: 180ca43f6043f5a50a094e167cf399da6010b57c
+  metadata.gz: 1813e22346789043275cf46f1a6e554396d2b454
+  data.tar.gz: 4e2e6622d6c1cb24d07fac8ef82c6c373130ddac
 SHA512:
-  metadata.gz: 08d0bc4c3a24e6110df16fb9210d4def5884f3cfaee4254ee2ca99367ad0dccdf4ec897a72944daa90c003a3866cffaaa592e5ea5267f68960e71b00afc2e730
-  data.tar.gz: 0e968d80f3d199f1ed5b800e61d2190c3e1fbd226ced05a59e0ce4eca736772f39090fa118a75564e0bf4604bb078b97423f10f3da7d5a63e08c047a5463571f
+  metadata.gz: bb9fa68805b138bf1c1b7d0efaaa134e46c5b75864e8822b99ebe97f14027a011c1acf287a763b00c0dc843cf85f981e4fbd61c44c2aec2bb0ea5c6659fa6ff3
+  data.tar.gz: 42cc040fb18486bf5df3a8b4b7cfc02ffb2267bc9fd6cab812de9f240d3538ea32f609c7f3c1cf5a996744c85a7729b3e367de89c7860e4e4f5e63f0aba5ace0

data/.gitignore

@@ -13,3 +13,6 @@
 *.a
 mkmf.log
 /spec/dummy/log/*.log
+/vendor
+.env
+tags

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Exclude:
+    - spec/dummy/**/*
+    - vendor/**/*
+    - bin/**/*
+Metrics/AbcSize:
+  Max: 32

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.2.2

data/.travis.yml

@@ -1,8 +1,11 @@
 language: ruby
-rvm: 2.1.5
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
 cache: bundle
-before_script: bundle exec rake db:setup
-script: bundle exec rspec
+before_script: ./bin/rake db
+script: ./bin/rake test
 addons:
   codeclimate:
     repo_token:

data/README.md

@@ -4,14 +4,39 @@
 [![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)
 
-A Rails engine that unites DecentExposure, StrongParameters, Devise (if
-installed) and Draper (if installed) to provide one hell of an awesome
-controller DSL.
+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][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
+you to use the fetched resources however you want.
 
-## Features
+```ruby
+resource :post do
+  search :title, :category
+  modify :title, :category, :body, :is_published
+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 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:
 
-- Provides a common DSL for describing strong parameters as well as
-  rules for DecentExposure and response types (default: html,json)
+```ruby
+expose :post, param: :post_id
+resource :comment do
+  ancestor :post
+  search :body
+  modify :body, :user_id
+end
+```
 
 ## Installation
 
@@ -21,10 +46,22 @@ Add this line to your application's Gemfile:
 gem 'controller_resources'
 ```
 
-Then run the following generator to generate the locale file:
+Then run the following generator to generate the locale files for
+Responders:
 
 ```bash
-$ rails generate controller_resources:install
+$ 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
 ```
 
 ## Usage
@@ -62,10 +99,67 @@ 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?
+```
+
+(where `current_user` is the authenticated User found by Devise)
+
+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.
+
 ## Contributing
 
-1. Fork it ( https://github.com/tubbo/controller_resources/fork )
-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 a new Pull Request
+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.
+
+To run tests:
+
+```bash
+$ rake test
+```
+
+This will also use Rubocop to lint-check your code so it adheres to our
+style guide.
+
+[de]: https://github.com/hashrocket/decent_exposure
+[rp]: https://github.com/plataformatec/responders
+[sp]: https://github.com/rails/strong_parameters
+

data/Rakefile

@@ -1,2 +1,16 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+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'
+end
+
+RSpec::Core::RakeTask.new :spec
+
+RuboCop::RakeTask.new :lint
+
+desc 'Run Rubocop lint checks and RSpec code examples'
+task test: %w(lint spec)

data/bin/cc-tddium-post-worker

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'cc-tddium-post-worker' 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('codeclimate-test-reporter', 'cc-tddium-post-worker')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' 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('erubis', 'erubis')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' 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('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' 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('diff-lcs', 'ldiff')

data/bin/nokogiri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'nokogiri' 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('nokogiri', 'nokogiri')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' 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('rack', 'rackup')

data/bin/rails

@@ -1,12 +1,16 @@
 #!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/controller_resources/engine', __FILE__)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-# Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+require 'rubygems'
+require 'bundler/setup'
 
-require 'rails/all'
-require 'rails/engine/commands'
+load Gem.bin_path('railties', 'rails')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' 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('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' 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('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' 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('rubocop', 'rubocop')

data/bin/ruby-parse

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-parse' 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('parser', 'ruby-parse')

data/bin/ruby-rewrite

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' 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('parser', 'ruby-rewrite')

data/bin/sprockets

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' 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('sprockets', 'sprockets')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' 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('thor', 'thor')

data/controller_resources.gemspec

@@ -8,24 +8,32 @@ Gem::Specification.new do |spec|
   spec.version       = ControllerResources::VERSION
   spec.authors       = ['Tom Scott']
   spec.email         = ['tubbo@psychedeli.ca']
-  spec.summary       = %q{A "glue" for decent_exposure, responders, draper and strong_params}
-  spec.description   = %q{A "glue" for decent_exposure, responders, draper and strong_params}
+  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 + '
+    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.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3'
   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_dependency 'rails', '>= 4.0.0'
+  spec.add_dependency 'rails'
   spec.add_dependency 'decent_exposure'
   spec.add_dependency 'responders'
 end

data/lib/controller_resources/engine.rb

@@ -1,4 +1,5 @@
 module ControllerResources
+  # Extensions for the including Rails app.
   class Engine < ::Rails::Engine
     isolate_namespace ControllerResources