controller_resources 0.0.5 → 0.0.6

data/lib/controller_resources/extension.rb

@@ -1,6 +1,3 @@
-require 'decent_exposure'
-require 'responders'
-
 module ControllerResources
   # A single macro that combines all controller-level macros we use for
   # the front-end of this application. Simply use the
@@ -15,19 +12,17 @@ module ControllerResources
   #     def index
   #       respond_with artists
   #     end
+  #
+  #     def show
+  #       respond_with artist
+  #     end
   #   end
   #
   module Extension
     extend ActiveSupport::Concern
 
     included do
-      # Attributes for configuring ControllerResources.
-      class_attribute :_search_params
-      class_attribute :_edit_params
-      class_attribute :_singleton_resource
-      class_attribute :_collection_resource
-      class_attribute :_finder_method
-      class_attribute :_protected_actions
+      class_attribute :_resource
 
       # Use the StrongParameters strategy in DecentExposure
       decent_configuration do
@@ -39,71 +34,78 @@ module ControllerResources
       # 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.
-      def resource(name=nil, &block)
-        name = self.name.gsub(/Controller/, '').tableize if name.nil?
-        self._singleton_resource = name.to_s.singularize.to_sym
-        self._collection_resource = name.to_s.pluralize.to_sym
-        self._protected_actions = %w(create update destroy edit new)
-
-        class_eval <<-RUBY
-          expose :#{model}, except: %w(index)
-          expose :#{collection}, only: %w(index) do
-            #{model_class}.where(search_params)
-          end
-          #{authenticate if defined? Devise}
-          #{authorize if defined? Authority}
-        RUBY
-
-        yield if block_given?
-      end
-
-      protected
-      # Set the search params for this controller.
-      def search(*hash_of_params)
-        self._search_params = hash_of_params
-      end
-
-      # Set the edit params for this controller.
-      def modify(*hash_of_params)
-        self._edit_params = hash_of_params
-      end
-
-      def protect(action)
-        self._protected_actions << action
-      end
-
-      private
-      def authenticate
-        "before_action :authenticate_user!, only: %w(#{_protected_actions.join(' ')})"
-      end
-
-      def authorize
-        "authorize_actions_for #{model.to_s.classify}, only: %w(#{_protected_actions.join(' ')})"
-      end
-
-      def model_class
-        @model_class ||= self._singleton_resource.to_s.classify
+      # 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
 
-      def model
-        self._singleton_resource
+    # 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
 
-      def collection
-        @collection ||= self._collection_resource.to_s
+    # 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
 
-    def search_params
-      params.permit self.class._search_params
+    # 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
 
-    def edit_params
-      params.require(self.class._singleton_resource).permit self._edit_params
+    # 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

@@ -0,0 +1,99 @@
+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/lib/controller_resources/version.rb

@@ -1,3 +1,4 @@
+# :nodoc:
 module ControllerResources
-  VERSION = "0.0.5"
+  VERSION = '0.0.6'
 end

data/lib/controller_resources.rb

@@ -1,7 +1,16 @@
-require "controller_resources/engine"
-require "controller_resources/version"
-require "controller_resources/extension"
+require 'active_support/all'
+require 'decent_exposure'
+require 'responders'
+require 'controller_resources/version'
 
+# 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.
 module ControllerResources
-  # config
+  extend ActiveSupport::Autoload
+
+  autoload :Engine
+  autoload :Resource
+  autoload :Extension
 end

data/spec/dummy/app/assets/javascripts/posts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/posts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

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

@@ -0,0 +1,44 @@
+class PostsController < ApplicationController
+  resource :post do
+    search :title
+    modify :title, :body
+  end
+
+  # GET /posts
+  def index
+    respond_with posts
+  end
+
+  # GET /posts/1
+  def show
+    respond_with post
+  end
+
+  # GET /posts/new
+  def new
+    render :new
+  end
+
+  # GET /posts/1/edit
+  def edit
+    render :edit
+  end
+
+  # POST /posts
+  def create
+    post.save
+    respond_with post
+  end
+
+  # PATCH/PUT /posts/1
+  def update
+    post.update(edit_params)
+    respond_with post
+  end
+
+  # DELETE /posts/1
+  def destroy
+    post.destroy
+    respond_with post
+  end
+end

data/spec/dummy/app/helpers/posts_helper.rb

@@ -0,0 +1,2 @@
+module PostsHelper
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

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

@@ -0,0 +1,29 @@
+<%= form_for(@post) do |f| %>
+  <% if @post.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+      <% @post.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br>
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :body %><br>
+    <%= f.text_field :body %>
+  </div>
+  <div class="field">
+    <%= f.label :is_published %><br>
+    <%= f.check_box :is_published %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

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

@@ -0,0 +1,6 @@
+<h1>Editing Post</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @post %> |
+<%= link_to 'Back', posts_path %>

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

@@ -0,0 +1,31 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Listing Posts</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Title</th>
+      <th>Body</th>
+      <th>Is published</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @posts.each do |post| %>
+      <tr>
+        <td><%= post.title %></td>
+        <td><%= post.body %></td>
+        <td><%= post.is_published %></td>
+        <td><%= link_to 'Show', post %></td>
+        <td><%= link_to 'Edit', edit_post_path(post) %></td>
+        <td><%= link_to 'Destroy', post, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Post', new_post_path %>

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

@@ -0,0 +1,5 @@
+<h1>New Post</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', posts_path %>

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

@@ -0,0 +1,19 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Title:</strong>
+  <%= @post.title %>
+</p>
+
+<p>
+  <strong>Body:</strong>
+  <%= @post.body %>
+</p>
+
+<p>
+  <strong>Is published:</strong>
+  <%= @post.is_published %>
+</p>
+
+<%= link_to 'Edit', edit_post_path(@post) %> |
+<%= link_to 'Back', posts_path %>

data/spec/dummy/config/application.rb

@@ -18,6 +18,8 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
+    #
+    config.active_support.test_order = :random
   end
 end
 

data/spec/dummy/config/environments/test.rb

@@ -13,7 +13,7 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files  = true
   config.static_cache_control = 'public, max-age=3600'
 
   # Show full error reports and disable caching.

data/spec/dummy/config/routes.rb

@@ -1,4 +1,3 @@
 Rails.application.routes.draw do
-
-  mount ControllerResources::Engine => "/controller_resources"
+  resources :posts
 end

data/spec/dummy/db/migrate/20150614211054_create_posts.rb

@@ -0,0 +1,10 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.string :body
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20150614211054) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "posts", force: :cascade do |t|
+    t.string   "title"
+    t.string   "body"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end

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

@@ -0,0 +1,49 @@
+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

@@ -0,0 +1,11 @@
+# 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

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

data/spec/integration/navigation_spec.rb

@@ -1,4 +1,4 @@
 require 'spec_helper'
 
-RSpec.describe "navigation" do
+RSpec.describe 'navigation' do
 end