skinny_controllers 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22e75d7a70d070311ace3af0a33cfa1df96dce4d
+  data.tar.gz: cee31b4824b93e8d425746a443212c1f36ca7f31
+SHA512:
+  metadata.gz: 0e1c99dd3bfd118eac0cb5081327328bf0dfbee23a5f93cee0a2d9fdf9f30d22eebab32aa0e7b6329a903ba88788a3e488893f12a6c0311f6153bc3a837adb61
+  data.tar.gz: e8ad57f6833d21b4148f8f5307e262d072698f83d114a027813297e7ad831df38afcce29436964077814935c5c3fc590855c4b2ca8335da1643cdd15800873e7

data/README.md

@@ -0,0 +1,23 @@
+# skinny-controllers
+[![Gem Version](http://img.shields.io/gem/v/skinny_controllers.svg?style=flat-square)](http://badge.fury.io/rb/skinny_controllers)
+[![Build Status](http://img.shields.io/travis/NullVoxPopuli/skinny_controllers.svg?style=flat-square)](https://travis-ci.org/NullVoxPopuli/skinny_controllers)
+[![Code Climate](http://img.shields.io/codeclimate/github/NullVoxPopuli/skinny_controllers.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/skinny_controllers)
+[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/NullVoxPopuli/skinny_controllers.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/skinny_controllers)
+[![Dependency Status](http://img.shields.io/gemnasium/NullVoxPopuli/skinny_controllers.svg?style=flat-square)](https://gemnasium.com/NullVoxPopuli/skinny_controllers)
+
+An implementation of role-based policies and operations to help controllers lose weight.
+
+The goal of this project is to help API apps be more slim, and separate logic as much as possible.
+
+# Installation
+
+```ruby
+gem 'skinny_controllers'
+```
+or
+
+`gem install skinny_controllers`
+
+# Usage
+
+TODO: this section

data/lib/skinny_controllers.rb

@@ -0,0 +1,54 @@
+# required gems
+require 'active_support'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/string/inflections'
+
+# files for this gem
+require 'skinny_controllers/default_verbs'
+require 'skinny_controllers/policy/base'
+require 'skinny_controllers/operation/policy_helpers'
+require 'skinny_controllers/operation/model_helpers'
+require 'skinny_controllers/operation/base'
+require 'skinny_controllers/operation/default'
+require 'skinny_controllers/diet'
+require 'skinny_controllers/version'
+
+module SkinnyControllers
+  # Tells the Diet what namespace of the controller
+  # isn't going to be part of the model name
+  #
+  # @example
+  #  # config/initializers/skinny_controllers.rb
+  #  SkinnyControllers.controller_namespace = 'API'
+  #  # 'API::' would be removed from 'API::Namespace::ObjectNamesController'
+  cattr_accessor :controller_namespace
+
+  #
+  cattr_accessor :operation_namespace do
+    'Operation'.freeze
+  end
+
+  cattr_accessor :allow_by_default do
+    true
+  end
+
+  # the diet uses ActionController::Base's
+  # `action_name` method to get the current action.
+  # From that action, we map what verb we want to use for our operation
+  #
+  # If an action is not be listed, the action name will be
+  # manipulated to fit the verb naming convention.
+  #
+  # @example POST controller#send_receipt will use 'SendReceipt' for the verb
+  cattr_accessor :action_map do
+    {
+      'default'.freeze => DefaultVerbs::Read,
+      'create'.freeze => DefaultVerbs::Create,
+      'index'.freeze => DefaultVerbs::ReadAll,
+      'destroy'.freeze => DefaultVerbs::Delete,
+      'update'.freeze => DefaultVerbs::Update
+    }
+  end
+end

data/lib/skinny_controllers/default_verbs.rb

@@ -0,0 +1,14 @@
+module SkinnyControllers
+  module DefaultVerbs
+    # show
+    Read = 'Read'.freeze
+    # index
+    ReadAll = 'ReadAll'.freeze
+    # create
+    Create = 'Create'.freeze
+    # destroy
+    Delete = 'Delete'.freeze
+    # update
+    Update = 'Update'.freeze
+  end
+end

data/lib/skinny_controllers/diet.rb

@@ -0,0 +1,77 @@
+module SkinnyControllers
+  module Diet
+    extend ActiveSupport::Concern
+
+    # TODO: what if we want multiple operations per action?
+    #
+    # @return an instance of the operation with default parameters
+    def operation
+      @operation ||= operation_class.new(current_user, params)
+    end
+
+    # Assumes the operation name from the controller name
+    #
+    # @example SomeObjectsController => Operation::SomeObject::Action
+    #
+    def operation_class
+      model_name = model_name_from_controller
+      klass_name = operation_class_from_model(model_name)
+      klass = klass_name.safe_constantize
+      klass || default_operation_class_for(model_name)
+    end
+
+    # dynamically creates a module for the model if it
+    # isn't already defined
+    def default_operation_class_for(model_name)
+      default_operation = Operation::Default
+      namespace = default_operation_namespace_for(model_name)
+
+      default = "#{namespace.name}::Default".safe_constantize
+      default || namespace.const_set('Default'.freeze, default_operation.dup)
+    end
+
+    def default_operation_namespace_for(model_name)
+      parent_namespace = Operation::Default.name.deconstantize
+      namespace = "#{parent_namespace}::#{model_name}".safe_constantize
+      namespace || Operation.const_set(model_name, Module.new)
+    end
+
+    # abstraction for `operation.run`
+    # useful when there is no logic needed for deciding what to
+    # do with an operation or if there is no logic to decide which operation
+    # to use
+    def model
+      @model ||= operation.run
+    end
+
+    private
+
+    # action name is inherited from ActionController::Base
+    # http://www.rubydoc.info/docs/rails/2.3.8/ActionController%2FBase%3Aaction_name
+    def verb_for_action
+      SkinnyControllers.action_map[action_name] || SkinnyControllers.action_map['default']
+    end
+
+    def model_name_from_controller
+      object_name = resource_name_from_controller.singularize
+      # remove the namespace if one exists
+      object_name.slice! controller_name_prefix
+      object_name
+    end
+
+    def resource_name_from_controller
+      controller_name = self.class.name
+      controller_name.gsub('Controller', '')
+    end
+
+    def operation_class_from_model(model_name)
+      prefix = SkinnyControllers.operation_namespace
+      "#{prefix}::#{model_name}::#{verb_for_action}"
+    end
+
+    def controller_name_prefix
+      namespace = SkinnyControllers.controller_namespace || ''
+      "#{namespace}::" if namespace
+    end
+  end
+end

data/lib/skinny_controllers/operation/base.rb

@@ -0,0 +1,57 @@
+module SkinnyControllers
+  module Operation
+    #
+    # An example Operation may looy like
+    #
+    # module Operations
+    #   class Event::Read < Base
+    #     def run
+    #       model if allowed?
+    #     end
+    #   end
+    # end
+    #
+    # TODO: make the above the 'default' and not require to be defined
+    class Base
+      include PolicyHelpers
+      include ModelHelpers
+
+      attr_accessor :params, :current_user, :authorized_via_parent
+
+      class << self
+        def run(current_user, params)
+          new(current_user, params).run
+        end
+      end
+
+      def initialize(current_user, params)
+        self.current_user = current_user
+        self.params = params
+        self.authorized_via_parent = false
+      end
+
+      def id_from_params
+        unless @id_from_params
+          @id_from_params = params[:id]
+          if filter = params[:filter]
+            @id_from_params = filter[:id].split(',')
+          end
+        end
+
+        @id_from_params
+      end
+
+      def object_class
+        @object_class ||= object_type_of_interest.demodulize.constantize
+      end
+
+      def object_type_of_interest
+        @object_type_name ||= self.class.name.deconstantize.demodulize
+      end
+
+      def association_name_from_object
+        object_type_of_interest.tableize
+      end
+    end
+  end
+end

data/lib/skinny_controllers/operation/default.rb

@@ -0,0 +1,9 @@
+module SkinnyControllers
+  module Operation
+    class Default < Base
+      def run
+        model if allowed?
+      end
+    end
+  end
+end

data/lib/skinny_controllers/operation/model_helpers.rb

@@ -0,0 +1,59 @@
+module SkinnyControllers
+  module Operation
+    module ModelHelpers
+      def model
+        # TODO: not sure if multiple ids is a good idea here
+        # if we don't have a(ny) id(s), get all of them
+        @model ||=
+          if id_from_params
+            model_from_id
+          elsif params[:scope]
+            model_from_scope
+          elsif key = params.keys.grep(/_id$/)
+            # hopefully there is only ever one of these passed
+            model_from_named_id(key.first)
+          else
+            model_from_params
+          end
+      end
+
+      def scoped_model(scoped_params)
+        unless @scoped_model
+          klass_name = scoped_params[:type]
+          operation_name = "Operations::#{klass_name}::Read"
+          operation = operation_name.constantize.new(current_user, id: scoped_params[:id])
+          @scoped_model = operation.run
+          self.authorized_via_parent = !!@scoped_model
+        end
+
+        @scoped_model
+      end
+
+      def model_from_params
+        object_class.where(params).accessible_to(current_user)
+      end
+
+      def model_from_named_id(key)
+        name, id = key.split('_')
+        name = name.camelize
+        model_from_scope(
+          id: id,
+          type: name
+        )
+      end
+
+      def model_from_scope(scope = params[:scope])
+        if scoped = scoped_model(scope)
+          association = association_name_from_object
+          scoped.send(association)
+        else
+          fail "Parent object of type #{scope[:type]} not accessible"
+        end
+      end
+
+      def model_from_id
+        object_class.find(id_from_params)
+      end
+    end
+  end
+end

data/lib/skinny_controllers/operation/policy_helpers.rb

@@ -0,0 +1,37 @@
+module SkinnyControllers
+  module Operation
+    module PolicyHelpers
+      POLICY_CLASS_PREFIX = 'Policy::'.freeze
+      POLICY_CLASS_SUFFIX = 'Policy'.freeze
+      POLICY_SUFFIX = '?'.freeze
+
+      def policy_class
+        @policy_class ||= (
+          POLICY_CLASS_PREFIX +
+          object_type_of_interest +
+          POLICY_CLASS_SUFFIX
+        ).constantize
+      end
+
+      def policy_name
+        @policy_name ||= self.class.name.demodulize.downcase + POLICY_SUFFIX
+      end
+
+      def policy_for(object)
+        @policy ||= policy_class.new(
+          current_user,
+          object,
+          authorized_via_parent: authorized_via_parent)
+      end
+
+      def allowed?
+        policy_for(model)
+      end
+
+      # checks the policy
+      def allowed_for?(object)
+        policy_for(object).send(policy_name)
+      end
+    end
+  end
+end

data/lib/skinny_controllers/policy/base.rb

@@ -0,0 +1,32 @@
+module SkinnyControllers
+  module Policy
+    class Base
+      attr_accessor :user, :object, :authorized_via_parent
+
+      def initialize(user, object, authorized_via_parent: false)
+        self.user = user
+        self.object = object
+        self.authorized_via_parent = authorized_via_parent
+      end
+
+      def default?
+        SkinnyControllers.allow_by_default
+      end
+
+      # defaults
+      def read?(o = object)
+        o.is_accessible_to? user
+      end
+
+      def read_all?
+        return true if authorized_via_parent
+        # This is expensive, so try to avoid it
+        # TODO: look in to creating a cache for
+        # these look ups that's invalidated upon
+        # object save
+        accessible = object.map { |ea| read?(ea) }
+        accessible.all?
+      end
+    end
+  end
+end

data/lib/skinny_controllers/version.rb

@@ -0,0 +1,3 @@
+module SkinnyControllers
+  VERSION = 0.1
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: skinny_controllers
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- L. Preston Sego III
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: awesome_print
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+description: An implementation of role-based policies and operations to help controllers
+  lose weight.
+email: LPSego3+dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/skinny_controllers.rb
+- lib/skinny_controllers/default_verbs.rb
+- lib/skinny_controllers/diet.rb
+- lib/skinny_controllers/operation/base.rb
+- lib/skinny_controllers/operation/default.rb
+- lib/skinny_controllers/operation/model_helpers.rb
+- lib/skinny_controllers/operation/policy_helpers.rb
+- lib/skinny_controllers/policy/base.rb
+- lib/skinny_controllers/version.rb
+homepage: https://github.com/NullVoxPopuli/skinny-controllers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: SkinnyControllers-0.1
+test_files: []