effective_resources 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c009d7e3ecdcedf8d6237f147268f258cb1def21
+  data.tar.gz: e626bb392c315716a7f8805a0ec43fee41aa2543
+SHA512:
+  metadata.gz: 22d8d71e5e635de0dac748d98a99cabbcefb1a741c0705489de856274a5ce0903e355ffb0d10de19751e6e8132988dc785a1ba8ef077f47c319d232a95888b48
+  data.tar.gz: f37f7fec56ae18b3dd8e86f0cc6ff43127fd0a7150231cd2be2e43a7e42456ca8ba5d0db6089de3fcd31e7aff698ba9b28973e48c884b70d1e108447edbfbf67

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Code and Effect Inc.
+
+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,74 @@
+# Effective Resources
+
+Make your controller an effective resource controller.
+
+Implements the 7 RESTful actions as a one-liner on any controller.
+
+## Getting Started
+
+Add to your Gemfile:
+
+```ruby
+gem 'effective_resources'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+## Usage
+
+Add to your contoller:
+
+```ruby
+class PostsController < ApplicationController
+  include Effective::CrudController
+
+  def post_params
+    params.require(:post).permit(:id, :title, :body)
+  end
+
+end
+```
+
+## What it does
+
+Implements the 7 RESTful actions: `index`, `new`, `create`, `show`, `edit`, `update`, `destroy`.
+
+# Loads an appropriate `@post` type instance
+# Sets a `@page_title` (effective_pages).
+# Calls authorize as per the configured `EffectiveResources.authorization_method` (flow through to CanCan or Pundit)
+# Does the create/update save
+# Sets a `flash[:success]` and redirects on success, or sets a `flash.now[:danger]` and renders on error.
+
+## Helpers
+
+### simple_form_submit
+
+Call `simple_form_submit(f)` like follows:
+
+```haml
+= simple_form_for(post) do |f|
+  = f.input :title
+  = f.input :body
+
+  = simple_form_submit(f)
+```
+
+to render 3 submit buttons: `Save`, `Save and Continue`, and `Save and Add New`.
+
+## License
+
+MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+## Contributing
+
+1. Fork it
+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. Bonus points for test coverage
+6. Create new Pull Request
+

data/app/controllers/concerns/effective/crud_controller.rb

@@ -0,0 +1,158 @@
+module Effective
+  module CrudController
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+    end
+
+    def index
+      @page_title ||= resource_name.pluralize.titleize
+      EffectiveResources.authorized?(self, :index, resource_class)
+
+      self.resources ||= resource_class.all
+      @datatable ||= resource_datatable_class.new(params[:scopes])
+    end
+
+    def new
+      self.resource ||= resource_class.new
+
+      @page_title ||= "New #{resource_name.titleize}"
+      EffectiveResources.authorized?(self, :new, resource)
+    end
+
+    def create
+      self.resource ||= resource_class.new(send(resource_params_method_name))
+
+      @page_title ||= "New #{resource_name.titleize}"
+      EffectiveResources.authorized?(self, :create, resource)
+
+      if resource.save
+        flash[:success] = "Successfully created #{resource_name}"
+        redirect_to(resource_redirect_path)
+      else
+        flash.now[:danger] = "Unable to create #{resource_name}: #{resource.errors.full_messages.to_sentence}"
+        render :new
+      end
+    end
+
+    def show
+      self.resource ||= resource_class.find(params[:id])
+
+      @page_title ||= resource.to_s
+      EffectiveResources.authorized?(self, :show, resource)
+    end
+
+    def edit
+      self.resource ||= resource_class.find(params[:id])
+
+      @page_title ||= "Edit #{resource}"
+      EffectiveResources.authorized?(self, :edit, resource)
+    end
+
+    def update
+      self.resource ||= resource_class.find(params[:id])
+
+      @page_title = "Edit #{resource}"
+      EffectiveResources.authorized?(self, :update, resource)
+
+      if resource.update_attributes(send(resource_params_method_name))
+        flash[:success] = "Successfully updated #{resource_name}"
+        redirect_to(resource_redirect_path)
+      else
+        flash.now[:danger] = "Unable to update #{resource_name}: #{resource.errors.full_messages.to_sentence}"
+        render :edit
+      end
+    end
+
+    def destroy
+      self.resource = resource_class.find(params[:id])
+
+      @page_title = "Destroy #{resource}"
+      EffectiveResources.authorized?(self, :destroy, resource)
+
+      if resource.destroy
+        flash[:success] = "Successfully deleted #{resource_name}"
+      else
+        flash[:danger] = "Unable to delete #{resource_name}: #{resource.errors.full_messages.to_sentence}"
+      end
+
+      request.referer.present? ? redirect_to(request.referer) : redirect_to(resources_path)
+    end
+
+    protected
+
+    def resource # @thing
+      instance_variable_get("@#{resource_name}")
+    end
+
+    def resource=(instance)
+      instance_variable_set("@#{resource_name}", instance)
+    end
+
+    def resources # @things
+      send(:instance_variable_get, "@#{resource_name.pluralize}")
+    end
+
+    def resources=(instance)
+      send(:instance_variable_set, "@#{resource_name.pluralize}", instance)
+    end
+
+    def resource_class # Thing
+      resource_namespaced_name.classify.safe_constantize || resource_name.classify.constantize
+    end
+
+    def resource_name # 'thing'
+      controller_path.split('/').last.singularize
+    end
+
+    def resource_namespace # ['admin']
+      controller_path.split('/')[0..-2].presence
+    end
+
+    def resource_namespaced_name # 'Admin::Thing'
+      ([resource_namespace, resource_name].compact * '/').singularize.camelize
+    end
+
+    def resource_datatable_class
+      if defined?(EffectiveDatatables)
+        "#{resource_namespaced_name.pluralize}Datatable".safe_constantize ||
+        "#{resource_name.pluralize.camelize}Datatable".safe_constantize ||
+        "Effective::Datatables::#{resource_namespaced_name.pluralize}".safe_constantize ||
+        "Effective::Datatables::#{resource_name.pluralize.camelize}".safe_constantize
+      end
+    end
+
+    def resource_params_method_name
+      ["#{resource_name}_params", "#{resource_name.pluralize}_params", 'permitted_params'].find { |name| respond_to?(name, true) } || 'params'
+    end
+
+    def resources_path # /admin/things
+      send([resource_namespace, resource_name.pluralize, 'path'].compact.join('_'))
+    end
+
+    def new_resource_path # /admin/things/new
+      send(['new', resource_namespace, resource_name, 'path'].compact.join('_'))
+    end
+
+    def edit_resource_path # /admin/things/1/edit
+      send(['edit', resource_namespace, resource_name, 'path'].compact.join('_'), resource)
+    end
+
+    def resource_path # /admin/things/1
+      send([resource_namespace, resource_name, 'path'].compact.join('_'), resource)
+    end
+
+    def resource_redirect_path
+      case params[:commit].to_s
+      when 'Save'               ; edit_resource_path
+      when 'Save and Continue'  ; resources_path
+      when 'Save and Add New'   ; new_resource_path
+      else resource_path
+      end
+    end
+
+  end
+end

data/app/helpers/effective_resources_helper.rb

@@ -0,0 +1,13 @@
+module EffectiveResourcesHelper
+
+  def simple_form_submit(form)
+    content_tag(:p, class: 'text-right') do
+      [
+        form.button(:submit, 'Save', data: { disable_with: 'Saving...' }),
+        form.button(:submit, 'Save and Continue', data: { disable_with: 'Saving...' }),
+        form.button(:submit, 'Save and Add New', data: { disable_with: 'Saving...' })
+      ].join(' ').html_safe
+    end
+  end
+
+end

data/app/models/effective/access_denied.rb

@@ -0,0 +1,17 @@
+unless defined?(Effective::AccessDenied)
+  module Effective
+    class AccessDenied < StandardError
+      attr_reader :action, :subject
+
+      def initialize(message = nil, action = nil, subject = nil)
+        @message = message
+        @action = action
+        @subject = subject
+      end
+
+      def to_s
+        @message || I18n.t(:'unauthorized.default', :default => 'Access Denied')
+      end
+    end
+  end
+end

data/config/effective_resources.rb

@@ -0,0 +1,22 @@
+EffectiveResources.setup do |config|
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) } # CanCanCan
+end

data/lib/effective_resources.rb

@@ -0,0 +1,20 @@
+require 'effective_resources/engine'
+require 'effective_resources/version'
+
+module EffectiveResources
+
+  # The following are all valid config keys
+  mattr_accessor :authorization_method
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
+      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
+    end
+    true
+  end
+
+end

data/lib/effective_resources/engine.rb

@@ -0,0 +1,13 @@
+module EffectiveResources
+  class Engine < ::Rails::Engine
+    engine_name 'effective_resources'
+
+    config.autoload_paths += Dir["#{config.root}/lib/"]
+
+    # Set up our default configuration options.
+    initializer 'effective_resources.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_resources.rb")
+    end
+
+  end
+end

data/lib/effective_resources/version.rb

@@ -0,0 +1,3 @@
+module EffectiveResources
+  VERSION = '0.1.0'.freeze
+end

data/lib/generators/effective_resources/install_generator.rb

@@ -0,0 +1,14 @@
+module EffectiveResources
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Creates an EffectiveResources initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_resources.rb', 'config/initializers/effective_resources.rb'
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: effective_resources
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Code and Effect
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Make any controller an effective resource controller.
+email:
+- info@codeandeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/controllers/concerns/effective/crud_controller.rb
+- app/helpers/effective_resources_helper.rb
+- app/models/effective/access_denied.rb
+- config/effective_resources.rb
+- lib/effective_resources.rb
+- lib/effective_resources/engine.rb
+- lib/effective_resources/version.rb
+- lib/generators/effective_resources/install_generator.rb
+homepage: https://github.com/code-and-effect/effective_resources
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Make any controller an effective resource controller.
+test_files: []