controller_resources 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b490004ef78f9c21c3c72bb3d8de57c7ce52bde
+  data.tar.gz: 90ceb34f2312f142bf0a9aeab4d4ff55fc1a9709
+SHA512:
+  metadata.gz: d968d9c6ebad11cf03786a310ede7006a45d0277275987cfaf9c0e1083dff79615f02519248d0bea53cc5c6981f0887de44164b5f3529275555c332a92f08fa0
+  data.tar.gz: 1d224b6827f81280155ac18f94d485aa86a937ab6c4ea78b4d23d53515e1b0f46c155471e44ef6decbcd16920ab9f4b33607904a25a5eced6ff94b044d2cd9bf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in controller_resources.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tom Scott
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# ControllerResources
+
+A Rails engine that unites DecentExposure, StrongParameters, Devise (if
+installed) and Draper (if installed) to provide one hell of an awesome
+controller DSL.
+
+## Features
+
+- Provides a common DSL for describing strong parameters as well as
+  rules for DecentExposure and response types (default: html,json)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'controller_resources'
+```
+
+Then run the following generator to generate the locale file:
+
+```bash
+$ rails generate controller_resources:install
+```
+
+## 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!
+
+```ruby
+class ItemsController < ApplicationController
+  resource :item do
+    search :name, :user
+    modify :name, :user, :is_private
+  end
+
+  def index
+    respond_with items
+  end
+
+  def show
+    respond_with item
+  end
+
+  def create
+    item.save
+    respond_with item
+  end
+end
+```
+
+In your view, you can use methods instead of instance variables to
+access the model objects passed down into the template:
+
+```erb
+<%= user.name %>
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/rails

@@ -0,0 +1,12 @@
+#!/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.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/controller_resources/engine', __FILE__)
+
+# 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 'rails/all'
+require 'rails/engine/commands'

data/controller_resources.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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       = %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.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.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 "rspec", "~> 3"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "generator_spec"
+
+  spec.add_dependency "rails", "~> 4.1"
+  spec.add_dependency "decent_exposure"
+  spec.add_dependency "responders"
+end

data/lib/controller_resources.rb

@@ -0,0 +1,7 @@
+require "controller_resources/engine"
+require "controller_resources/version"
+require "controller_resources/extension"
+
+module ControllerResources
+  # config
+end

data/lib/controller_resources/engine.rb

@@ -0,0 +1,12 @@
+module ControllerResources
+  class Engine < ::Rails::Engine
+    isolate_namespace ControllerResources
+    config.to_prepare do
+      require 'controller_resources'
+
+      class ApplicationController < ActionController::Base
+        include ControllerResources::Extension
+      end
+    end
+  end
+end

data/lib/controller_resources/extension.rb

@@ -0,0 +1,94 @@
+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
+  # `resource :resource_name` macro in your controller class
+  # to make it work.
+  #
+  # Example:
+  #
+  #   class ArtistsController < ApplicationController
+  #     resource :artist
+  #
+  #     def index
+  #       respond_with artists
+  #     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
+
+      # 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
+    end
+
+    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
+
+        class_eval <<-RUBY
+          respond_to :html
+          expose :#{model}, except: %w(index)
+          expose :#{collection}, only: %w(index) do
+            #{model_class}.where(search_params)
+          end
+          #{authenticate if defined? Devise}
+        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
+
+      private
+      def authenticate
+        "before_action :authenticate_user!, except: %w(index show)"
+      end
+
+      def model_class
+        @model_class ||= model.classify
+      end
+
+      def collection
+        @collection ||= self._collection_resource.to_s
+      end
+    end
+
+    def search_params
+      params.permit self.class._search_params
+    end
+
+    def edit_params
+      params.require(self.class._singleton_resource).permit self._edit_params
+    end
+  end
+end

data/lib/controller_resources/version.rb

@@ -0,0 +1,3 @@
+module ControllerResources
+  VERSION = "0.0.1"
+end

data/lib/generators/controller_resources/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/controller_resources/install_generator.rb

@@ -0,0 +1,16 @@
+class InstallGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_locale
+    copy_file "#{gem_path}/lib/responders/locales/en.yml", "responders.en.yml"
+  end
+
+  private
+  def gem_path
+    @gem_path ||= gem_spec.full_gem_path
+  end
+
+  def gem_spec
+    @gem_spec ||= Gem::Specification.find_by_name 'responders'
+  end
+end

data/lib/tasks/controller_resources_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :controller_resources do
+#   # Task goes here
+# end

data/spec/controller_resources/extension_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module ControllerResources
+  RSpec.describe Extension do
+    class MockController < ActionController::Base
+      include Extension
+
+      resource :model do
+        search :name
+        modify :name, :password
+      end
+    end
+
+    subject { MockController }
+    let(:controller) { subject.new }
+
+    it "defines singleton and collection resources" do
+      expect(subject._singleton_resource).to eq(:model)
+      expect(subject._collection_resource).to eq(:models)
+    end
+
+    it "saves params" do
+      expect(subject._search_params).to eq([:name])
+      expect(subject._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

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

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

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .