controller_resources 0.0.6 → 0.1.0

metadata

@@ -1,177 +1,223 @@
 --- !ruby/object:Gem::Specification
 name: controller_resources
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Tom Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: decent_exposure
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: responders
+  name: decent_exposure
   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: |-
-  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.Attempts to DRY up most of the boilerplate code at the top of
-      each controller used to set up its state.
+description: ! "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.Attempts to DRY up most of the boilerplate code at the top of\n    each
+  controller used to set up its state."
 email:
 - tubbo@psychedeli.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/cc-tddium-post-worker
+- bin/coderay
 - bin/erubis
 - bin/htmldiff
 - bin/ldiff
 - bin/nokogiri
+- bin/pry
 - bin/rackup
 - bin/rails
 - bin/rake
@@ -181,11 +227,13 @@ files:
 - bin/ruby-rewrite
 - bin/sprockets
 - bin/thor
+- bin/yard
+- bin/yardoc
+- bin/yri
 - controller_resources.gemspec
 - lib/controller_resources.rb
 - lib/controller_resources/engine.rb
-- lib/controller_resources/extension.rb
-- lib/controller_resources/resource.rb
+- lib/controller_resources/not_defined_error.rb
 - lib/controller_resources/version.rb
 - lib/tasks/controller_resources_tasks.rake
 - spec/dummy/README.rdoc
@@ -234,19 +282,18 @@ files:
 - spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/20150614211054_create_posts.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/db/seeds.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/dummy/test/controllers/posts_controller_test.rb
-- spec/dummy/test/fixtures/posts.yml
-- spec/dummy/test/models/post_test.rb
+- spec/features/posts_spec.rb
 - spec/integration/navigation_spec.rb
-- spec/lib/controller_resources/extension_spec.rb
-- spec/lib/controller_resources/resource_spec.rb
+- spec/lib/controller_resources_spec.rb
 - spec/spec_helper.rb
+- spec/support/posts.rb
 homepage: https://github.com/tubbo/controller_resources
 licenses:
 - MIT
@@ -257,12 +304,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -273,19 +320,22 @@ specification_version: 4
 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.
 test_files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/cc-tddium-post-worker
+- bin/coderay
 - bin/erubis
 - bin/htmldiff
 - bin/ldiff
 - bin/nokogiri
+- bin/pry
 - bin/rackup
 - bin/rails
 - bin/rake
@@ -295,11 +345,13 @@ test_files:
 - bin/ruby-rewrite
 - bin/sprockets
 - bin/thor
+- bin/yard
+- bin/yardoc
+- bin/yri
 - controller_resources.gemspec
 - lib/controller_resources.rb
 - lib/controller_resources/engine.rb
-- lib/controller_resources/extension.rb
-- lib/controller_resources/resource.rb
+- lib/controller_resources/not_defined_error.rb
 - lib/controller_resources/version.rb
 - lib/tasks/controller_resources_tasks.rake
 - spec/dummy/README.rdoc
@@ -348,16 +400,15 @@ test_files:
 - spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/20150614211054_create_posts.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/db/seeds.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/dummy/test/controllers/posts_controller_test.rb
-- spec/dummy/test/fixtures/posts.yml
-- spec/dummy/test/models/post_test.rb
+- spec/features/posts_spec.rb
 - spec/integration/navigation_spec.rb
-- spec/lib/controller_resources/extension_spec.rb
-- spec/lib/controller_resources/resource_spec.rb
+- spec/lib/controller_resources_spec.rb
 - spec/spec_helper.rb
+- spec/support/posts.rb

data/lib/controller_resources/extension.rb

@@ -1,111 +0,0 @@
-module ControllerResources
-  # A single macro that combines all controller-level macros we use for
-  # the front-end of this application. Simply use the
-  # `resource :resource_name` macro in your controller class
-  # to make it work.
-  #
-  # Example:
-  #
-  #   class ArtistsController < ApplicationController
-  #     resource :artist
-  #
-  #     def index
-  #       respond_with artists
-  #     end
-  #
-  #     def show
-  #       respond_with artist
-  #     end
-  #   end
-  #
-  module Extension
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :_resource
-
-      # Use the StrongParameters strategy in DecentExposure
-      decent_configuration do
-        strategy DecentExposure::StrongParametersStrategy
-        attributes :edit_params
-        except %w(index)
-      end
-
-      # Use the FlashResponder and HttpCacheResponder to respond to
-      # various requests.
-      responders :flash, :http_cache
-
-      helper_method :current_resource
-    end
-
-    # Macros included into the controller as class methods.
-    module ClassMethods
-      # Initialize this controller as an authenticated resource. You can
-      # optionally specify search_params and edit_params which are
-      # formed into strong parameter hashes.
-      #
-      # Example:
-      #
-      #   resource :post do
-      #     search :title
-      #     modify :title, :body
-      #   end
-      #
-      # @param [String] name - The parameterized name of the model
-      #                        backing this controller.
-      def resource(name = self.name.gsub(/Controller/, '').tableize, &block)
-        self._resource = Resource.new(name, &block)
-
-        expose(
-          _resource.model_name,
-          except: %i(index)
-        )
-        expose(
-          _resource.collection_name,
-          only: %i(index),
-          attributes: :search_params
-        )
-      end
-    end
-
-    # Omit any unpermitted parameters when searching in collections.
-    # Permits all parameters when none are given in the resource block.
-    #
-    # @returns [StrongParameters::Hash]
-    def search_params
-      if resource.search_params.any?
-        params.permit resource.search_params
-      else
-        params.permit!
-      end
-    end
-
-    # Omit any unpermitted parameters when editing or creating content.
-    # Permits all parameters when none are given in the resource block.
-    #
-    # @returns [StrongParameters::Hash]
-    def edit_params
-      if resource.edit_params.any?
-        params.require(resource.model_name).permit resource.edit_params
-      else
-        params.require(resource.model_name).permit!
-      end
-    end
-
-    # The resource object as made available to the controller
-    #
-    # @returns [Resource]
-    def resource
-      fail Resource::NotConfiguredError unless self.class._resource.present?
-      self.class._resource
-    end
-
-    # A helper for engines like Pundit to configure the current
-    # authorizer policy for this controller.
-    #
-    # @returns [Object] the class name of the configured model resource.
-    def current_resource
-      resource.model_class
-    end
-  end
-end

data/lib/controller_resources/resource.rb

@@ -1,99 +0,0 @@
-module ControllerResources
-  # The "data model" for the controlled resource. In the controller,
-  # defining the +resource+ block instantiates this class, which is used
-  # to hold all of the data the developer provides inside the block and
-  # used in the +Extension+ to actually do the "heavy lifting" in the
-  # controller. This class is just a way of storing all of the
-  # configured state for a given controller's resource.
-  class Resource
-    # The name of this resource, used to look up the collection and
-    # model names.
-    #
-    # @type [String]
-    attr_reader :name
-
-    # Permitted parameters for searching collections.
-    #
-    # @type [Array]
-    attr_reader :search_params
-
-    # Permitted parameters for editing members.
-    #
-    # @type [Array]
-    attr_reader :edit_params
-
-    # Thrown when a Resource object has not been configured, but we are
-    # attempting to use methods defined by ControllerResources.
-    class NotConfiguredError < StandardError; end
-
-    # Instantiate a new Resource with the given name and a block to
-    # define permitted parameters. The code given in the +resource+
-    # block is passed directly here so that the Resource class can be
-    # set up with its proper state.
-    #
-    # By default, resources are not given any search or edit params. If
-    # none are provided (via the +search+ and +modify+ configuration
-    # methods), all parameters will be permitted on collection and
-    # member resources respectively.
-    #
-    # @param [Symbol] name - The name of this resource, typically given
-    #                        as a singular symbol.
-    #
-    # @param [Block] &block - A block of code used to set up this
-    #                         object.
-    def initialize(name, &block)
-      @name = name.to_s
-      @search_params = []
-      @edit_params = []
-      @block = block
-      yield self if block_given?
-    end
-
-    # Singular version of the given resource name.
-    #
-    # @returns [Symbol]
-    def model_name
-      name.singularize.to_sym
-    end
-
-    # Pluralized version of the given resource name.
-    #
-    # @returns [Symbol]
-    def collection_name
-      name.pluralize.to_sym
-    end
-
-    # The model name as a class constant.
-    #
-    # @returns [Object]
-    def model_class
-      @model_class ||= model_name.to_s.classify.constantize
-    end
-
-    # Set the search params for this controller.
-    #
-    # Example:
-    #
-    #   resource :post do
-    #     search :title, :category, :tag
-    #   end
-    #
-    # @param [Array] A collection of params to whitelist.
-    def search(*params)
-      @search_params = params
-    end
-
-    # Set the edit params for this controller.
-    #
-    # Example:
-    #
-    #   resource :post do
-    #     modify :title, :category, :tag, :body, :is_published
-    #   end
-    #
-    # @param [Array] A collection of params to whitelist.
-    def modify(*params)
-      @edit_params = params
-    end
-  end
-end

data/spec/dummy/test/controllers/posts_controller_test.rb

@@ -1,49 +0,0 @@
-require 'test_helper'
-
-class PostsControllerTest < ActionController::TestCase
-  setup do
-    @post = posts(:one)
-  end
-
-  test "should get index" do
-    get :index
-    assert_response :success
-    assert_not_nil assigns(:posts)
-  end
-
-  test "should get new" do
-    get :new
-    assert_response :success
-  end
-
-  test "should create post" do
-    assert_difference('Post.count') do
-      post :create, post: { body: @post.body, is_published: @post.is_published, title: @post.title }
-    end
-
-    assert_redirected_to post_path(assigns(:post))
-  end
-
-  test "should show post" do
-    get :show, id: @post
-    assert_response :success
-  end
-
-  test "should get edit" do
-    get :edit, id: @post
-    assert_response :success
-  end
-
-  test "should update post" do
-    patch :update, id: @post, post: { body: @post.body, is_published: @post.is_published, title: @post.title }
-    assert_redirected_to post_path(assigns(:post))
-  end
-
-  test "should destroy post" do
-    assert_difference('Post.count', -1) do
-      delete :destroy, id: @post
-    end
-
-    assert_redirected_to posts_path
-  end
-end

data/spec/dummy/test/fixtures/posts.yml

@@ -1,11 +0,0 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
-
-one:
-  title: MyString
-  body: MyString
-  is_published: false
-
-two:
-  title: MyString
-  body: MyString
-  is_published: false

data/spec/dummy/test/models/post_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class PostTest < ActiveSupport::TestCase
-  # test "the truth" do
-  #   assert true
-  # end
-end

data/spec/lib/controller_resources/extension_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-
-# :nodoc:
-module ControllerResources
-  RSpec.describe Extension do
-    # :nodoc:
-    class MockController < ActionController::Base
-      include Extension
-
-      resource :model do |r|
-        r.search :name
-        r.modify :name, :password
-      end
-    end
-
-    subject { MockController }
-
-    let(:controller) { subject.new }
-
-    let(:resource) { subject._resource }
-
-    it 'defines a resource object' do
-      expect(resource).to be_present
-      expect(resource).to be_a(Resource)
-    end
-
-    it 'configures the resource object' do
-      expect(resource.model_name).to eq(:model)
-      expect(resource.collection_name).to eq(:models)
-    end
-
-    it 'saves params' do
-      expect(resource.search_params).to eq([:name])
-      expect(resource.edit_params).to eq([:name, :password])
-    end
-
-    it 'publishes params to instance method' do
-      expect(controller).to respond_to(:search_params)
-      expect(controller).to respond_to(:edit_params)
-    end
-  end
-end