action_params_permitter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f23d83ff4d7fe631eb3e9f7f72cbad5c354da27f
+  data.tar.gz: 3df5990081a00f38602390170ba40642e594b8cb
+SHA512:
+  metadata.gz: 447c2bf813fde97541de737a9a4b9996cd99d8b895bf8e9761e11c076211f1def784578354cde0f3910912405a5e8ab1f61f0b0c9f2f75415756592261d4a19b
+  data.tar.gz: 1fc785928a20185ad4db06edab8c9654d1cbccd2e566f76f15fd5e799cfa2fb0a35a586b41456b7d81998b384ae84181e2277e3277e9b8e79d04a5d5f4176a8b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+before_install: gem install bundler -v 1.10.6
+
+cache: bundler
+
+rvm:
+    - 2.2.2
+
+script: 'CODECLIMATE_REPO_TOKEN=5924b5a882e5cec32dfae43025aafac9164fc772aa776e6249a9430713ca56ed  bundle exec rake'
+
+addons:
+    code_climate:
+      repo_token: 5924b5a882e5cec32dfae43025aafac9164fc772aa776e6249a9430713ca56ed

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry-nav', '0.2.4'
+  gem 'faker', '1.4.3'
+  gem 'rspec-rails', '3.3.2'
+  gem 'rspec-its', '1.2.0'
+  gem 'shoulda-matchers', '2.8.0'
+  gem 'fabrication', '2.14.0'
+end
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sergey Gernyak
+
+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,139 @@
+# ActionParamsPermitter
+
+[![Code Climate](https://codeclimate.com/github/alterego-labs/action_params_permitter/badges/gpa.svg)](https://codeclimate.com/github/alterego-labs/action_params_permitter)
+[![Build Status](https://travis-ci.org/alterego-labs/action_params_permitter.svg)](https://travis-ci.org/alterego-labs/action_params_permitter)
+[![Test Coverage](https://codeclimate.com/github/alterego-labs/action_params_permitter/badges/coverage.svg)](https://codeclimate.com/github/alterego-labs/action_params_permitter/coverage)
+
+Strong Parameters are the great idea to keep your models clean. But what
+about controllers when form is very complex and
+`params.require(:anything).permit!` does not helps?
+
+```ruby
+class AnyController
+  private
+
+  def permitted_params
+    params.permit tutorial: [
+      :cost, :hours, :minutes, :seconds,
+      steps_attributes: [:id, :description, :order_number, :_destroy],
+      tool_ids: [],
+      material_ids: [],
+      post_attributes: [
+        :id, :title, :description, :meta_title, :meta_description,
+        :feature, :user_id, tag_list: [], category_ids: []],
+        media: [:id, :title, :alt, :_destroy]
+    ]
+  end
+
+end
+```
+
+This code seems not so clean.
+
+`action_params_permitter` gives you a alternative way to do permitting
+more clean.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_params_permitter', github: 'alterego-labs/action_params_permitter'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In general provided DSL looks like follow:
+
+```ruby
+SomePermitter = ActionParamsPermitter::Base.new do
+  # Your specific rules
+end
+```
+
+Rules are predefined and their variation are listed below:
+
+1. `resource`
+2. `attribute`
+3. `attributes`
+
+Nesting is allowed but only for `resource` (which is quite logical). There are some statements about resource rule:
+
+1. _Top level resource_ __always must__ accepts nestings rules otherwise
+   exception will be raised.
+2. _Top level resource_ may be __required__, but only one otherwise
+   exception will be raised.
+3. _Nested resource_ may not accepts nestings rules.
+
+Lets define permitter for our example in the top of readme:
+
+```ruby
+TutorialsParamsPermitter = ActionParamsPermitter::Base.new do
+  resource :tutorial do
+    attributes :cost, :hours, :minutes, :seconds
+    resource :steps_attributes do
+      attributes :id, :description, :order_number, :_destroy
+    end
+    resource :tool_ids
+    resource :material_ids
+    resource :post_attributes do
+      attributes :id, :title, :description, :meta_title, :meta_description
+      attributes :feature, :user_id
+      resource :tag_list
+      resource :category_ids
+    end
+    resource :media do
+      # Written specially for showing `attribute` rule in work
+      attribute :id
+      attribute :title
+      attribute :alt
+      attribute :_destroy
+    end
+  end
+end
+```
+
+`TutorialsParamsPermitter` respond to `#permit(params)` method. And now
+we may refactor our controller's method like this:
+
+```ruby
+class AnyController
+  private
+
+  def permitted_params
+    TutorialsParamsPermitter.permit(params)
+  end
+end
+```
+
+You may define root resource as required like this:
+
+```ruby
+TutorialsParamsPermitter = ActionParamsPermitter::Base.new do
+  resource :tutorial, required: true do
+    ...
+  end
+end
+```
+
+## Usage with Form Object gems
+
+There are many gems providing form objects, for example `reform`. And if you use a such one `action_params_permitter` is not helps you. Form Object gems inside carries same functional and `action_params_permitter` usage is excessive.
+
+## What about like `params.require(:any_resource).permit!`?
+
+Notice, please, this gem was written only for complex params permitting.
+Usage for so simple example is excessive.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alterego-labs/action_params_permitter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/action_params_permitter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_params_permitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_params_permitter"
+  spec.version       = ActionParamsPermitter::VERSION
+  spec.authors       = ["Sergey Gernyak"]
+  spec.email         = ["sergeg1990@gmail.com"]
+
+  spec.summary       = %q{Helps to permit income parameters more clearly.}
+  spec.homepage      = "https://github.com/alterego-labs/action_params_permitter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails',            '~> 4.2.4'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_params_permitter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/action_params_permitter.rb

@@ -0,0 +1,26 @@
+require "action_params_permitter/version"
+
+require 'active_support/dependencies/autoload'
+
+require "action_params_permitter/errors"
+
+module ActionParamsPermitter
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :PermitProcessor
+
+  module Builders
+    extend ActiveSupport::Autoload
+
+    autoload :Main
+    autoload :Resource
+
+    module Concerns
+      extend ActiveSupport::Autoload
+
+      autoload :TopLevelResourceBlockExistenceChecking
+      autoload :ResourceRequiring
+    end
+  end
+end

data/lib/action_params_permitter/base.rb

@@ -0,0 +1,39 @@
+module ActionParamsPermitter
+  #
+  # Entry for creating custom permitters
+  #
+  class Base
+    def initialize(&block)
+      builder.instance_eval(&block)
+    end
+
+    #
+    # Provides hash that must be passed to `permit` method.
+    #
+    # Returns:
+    # generated hash of permitter definition
+    #
+    def hash_for_permitting
+      builder.state
+    end
+
+    #
+    # Calls permitting income params using permitter definition
+    #
+    # Parameters:
+    # params - instance of ActionController::Parameters
+    #
+    # Returns:
+    # hash of permitted params
+    #
+    def permit(params)
+      PermitProcessor.new(params, builder).call
+    end
+
+    private
+
+    def builder
+      @_builder ||= Builders::Main.new({})
+    end
+  end
+end

data/lib/action_params_permitter/builders/concerns/resource_requiring.rb

@@ -0,0 +1,33 @@
+module ActionParamsPermitter
+  module Builders
+    module Concerns
+      module ResourceRequiring
+        def self.prepended(base)
+          base.instance_eval do
+            attr_reader :is_required
+          end
+        end
+
+        def initialize(*params)
+          @is_required = false
+          super(*params)
+        end
+
+        def resource(name, options = {}, &block)
+          check_double_requiring(options)
+          @is_required = true if options.fetch(:required, false)
+          super
+        end
+
+        private
+
+        def check_double_requiring(options)
+          return if !top_level_builder?
+          return if !is_required
+          return if !options[:required]
+          raise ActionParamsPermitter::DoubleRequireError, 'You may define only one required top level resource!'
+        end
+      end
+    end
+  end
+end

data/lib/action_params_permitter/builders/concerns/top_level_resource_block_existence_checking.rb

@@ -0,0 +1,20 @@
+module ActionParamsPermitter
+  module Builders
+    module Concerns
+      module TopLevelResourceBlockExistenceChecking
+        def resource(name, options = {}, &block)
+          check_block_existence(&block)
+          super
+        end
+
+        private
+
+        def check_block_existence(&block)
+          return if !top_level_builder?
+          return if block_given?
+          raise ActionParamsPermitter::TopLevelResourceWithoutBlockError, 'Top level resource must has block!'
+        end
+      end
+    end
+  end
+end

data/lib/action_params_permitter/builders/main.rb

@@ -0,0 +1,71 @@
+module ActionParamsPermitter
+  module Builders
+    #
+    # Provides context for building permitters
+    #
+    # Parameters:
+    # state - initial state for builder
+    #
+    class Main
+      prepend Concerns::TopLevelResourceBlockExistenceChecking
+      prepend Concerns::ResourceRequiring
+
+      attr_reader :state
+
+      def initialize(state)
+        @state = state
+      end
+
+      #
+      # Adds intention for resource permitting
+      #
+      # Parameters:
+      # name - name of the permitting resource
+      # options - hash with options. Available are:
+      #   required - true/false. Required may be only top level resource and only one.
+      #
+      # Returns:
+      # new state
+      #
+      def resource(name, options = {}, &block)
+        Builders::Resource.new(name, state).call(&block)
+      end
+
+      #
+      # Adds intention for attribute permitting
+      #
+      # Parameters:
+      # name - name of the permitting attribute
+      #
+      # Returns:
+      # new state
+      #
+      def attribute(name)
+        state << name
+        state
+      end
+
+      #
+      # Adds intention for attributes permitting.
+      # Works exactly as a `attribute` but accepts
+      # array of attributes
+      #
+      # Parameters:
+      # names - names of the permitting attributes
+      #
+      # Returns:
+      # new state
+      #
+      def attributes(*names)
+        names.each { |name| attribute(name) }
+        state
+      end
+
+      private
+
+      def top_level_builder?
+        state.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/action_params_permitter/builders/resource.rb

@@ -0,0 +1,66 @@
+module ActionParamsPermitter
+  module Builders
+    #
+    # Command class for building hash for permitting resource
+    #
+    # Parameters:
+    # name - name of the building resource
+    # state - current state of the builder
+    #
+    # Returns:
+    # new state
+    #
+    class Resource
+      attr_reader :name, :state
+
+      def initialize(name, state)
+        @name, @state = name, state
+      end
+
+      def call(&block)
+        if hash_state?
+          process_hash_state(&block)
+        else
+          process_array_state(&block)
+        end
+      end
+
+      private
+
+      def hash_state?
+        state.is_a?(Hash)
+      end
+
+      def process_hash_state(&block)
+        state[name] = gen_empty_builder(&block)
+        state
+      end
+
+      def process_array_state(&block)
+        sub_state = gen_sub_state(&block)
+        if state_has_hash?
+          child_hash.merge!(name => sub_state)
+        else
+          state << {name => sub_state }
+        end
+        state
+      end
+
+      def gen_sub_state(&block)
+        block_given? ? gen_empty_builder(&block) : []
+      end
+
+      def gen_empty_builder(&block)
+        Builders::Main.new([]).instance_eval(&block) || []
+      end
+
+      def child_hash
+        state.detect {|el| el.is_a?(Hash)}
+      end
+
+      def state_has_hash?
+        !child_hash.nil?
+      end
+    end
+  end
+end

data/lib/action_params_permitter/errors.rb

@@ -0,0 +1,4 @@
+module ActionParamsPermitter
+  DoubleRequireError                = Class.new(StandardError)
+  TopLevelResourceWithoutBlockError = Class.new(StandardError)
+end

data/lib/action_params_permitter/permit_processor.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/module/delegation'
+
+module ActionParamsPermitter
+  #
+  # Makes permitting process.
+  # It can be done using income params from
+  # your controller and builded permitter
+  #
+  # Parameters:
+  # params - instance of ActionController::Parameters
+  # builder - instance of Builders::Main
+  #
+  # Returns:
+  # hash with permitted parameters
+  #
+  class PermitProcessor
+    attr_reader :params, :builder
+
+    delegate :state, to: :builder
+
+    def initialize(params, builder)
+      @params, @builder = params, builder
+    end
+
+    def call
+      top_is_required? ? make_requiring : make_permitting
+    end
+
+    private
+
+    def make_permitting
+      params.permit(state)
+    end
+
+    def make_requiring
+      required_resource = state.keys.first
+      required_tail = state[required_resource]
+      params.require(required_resource).permit(required_tail)
+    end
+
+    def top_is_required?
+      builder.is_required
+    end
+  end
+end

data/lib/action_params_permitter/version.rb

@@ -0,0 +1,3 @@
+module ActionParamsPermitter
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: action_params_permitter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Gernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- sergeg1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_params_permitter.gemspec
+- bin/console
+- bin/setup
+- lib/action_params_permitter.rb
+- lib/action_params_permitter/base.rb
+- lib/action_params_permitter/builders/concerns/resource_requiring.rb
+- lib/action_params_permitter/builders/concerns/top_level_resource_block_existence_checking.rb
+- lib/action_params_permitter/builders/main.rb
+- lib/action_params_permitter/builders/resource.rb
+- lib/action_params_permitter/errors.rb
+- lib/action_params_permitter/permit_processor.rb
+- lib/action_params_permitter/version.rb
+homepage: https://github.com/alterego-labs/action_params_permitter
+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.8
+signing_key: 
+specification_version: 4
+summary: Helps to permit income parameters more clearly.
+test_files: []