permittribute 1.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Priyank Gupta
+
+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/README.md

@@ -0,0 +1,103 @@
+# Permittribute
+
+We sometimes face scenarios where we need same permitted attributes for a model in different controllers and end up re-writing all attributes again (violating DRY).
+
+Permittribute is meant to:
+
+- reuse same permitted attributes at different locations/controllers.
+- scope permitted attributes base on roles like admin, api etc.
+- group permitted attributes at a single reference point in their respective scopes.
+
+## Usage
+
+This is used with <a href='https://github.com/rails/strong_parameters'>rails/strong_parameters</a> which is now incorporated since rails 4.x.
+
+
+We use strong parameters something like:
+
+    # in controllers/articles_controller.rb
+    def article_params
+      params.require(:article).permit([:title, :author_id, :published_at, :publication])
+    end
+
+    # in controllers/admin/articles_controller.rb
+    def article_params
+      params.require(:article).permit([:title, :author_id, :published_at, :publication])
+    end
+
+    # in controllers/api/articles_controller.rb
+    def article_params
+      params.require(:article).permit([:title, :author_id, :published_at, :publication])
+    end
+
+With <b>Permittribute</b> we can do:
+
+    # in lib/permittribute/default.rb
+    Permittribute.configure do
+      config.articles = [:title, :author_id, :published_at, :publication]
+      # Use as #permittribute_articles
+    end
+
+    # in lib/permittribute/admin.rb
+    Permittribute.configure(:admin) do
+      config.articles = [:title, :author_id, :published_at, :publication]
+      # Use as #permittribute_admin_articles
+    end
+
+    # in lib/permittribute/api.rb
+    Permittribute.configure(:api) do
+      config.articles = [:title, :author_id, :published_at, :publication]
+      # Use as #permittribute_api_articles
+    end
+
+And
+
+    # in controllers/articles_controller.rb
+    def article_params
+      params.require(:article).permit(permittribute_articles)
+    end
+
+    # in controllers/admin/articles_controller.rb
+    def article_params
+      params.require(:article).permit(permittribute_admin_articles)
+    end
+
+    # in controllers/api/articles_controller.rb
+    def article_params
+      params.require(:article).permit(permittribute_api_articles)
+    end
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+    gem 'permittribute'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install permittribute
+
+After you have installed Permittribute or added it to your Gemfile, you need to run the generator:
+
+    $ rails generate permittribute:install
+
+This will
+
+- create three configurations file, `lib/permittribute/default.rb`, `lib/permittribute/admin.rb` and `lib/permittribute/api.rb`. These contains some example configurations.
+- adds `config.eager_load_paths += ["#{Rails.root}/lib/permittribute"]` in `config/application.rb`. To eager load created config files.
+
+## TODO
+
+- Add specs.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/permittribute/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/lib/generators/permittribute/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+module Permittribute
+  class InstallGenerator < Rails::Generators::Base
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def configure_application
+      application <<-APP
+
+    config.eager_load_paths += ["\#{Rails.root}/lib/permittribute"]
+      APP
+    end
+
+    def generate_config
+      template "default.rb", "lib/permittribute/default.rb"
+      template "admin.rb", "lib/permittribute/admin.rb"
+      template "api.rb", "lib/permittribute/api.rb"
+    end
+  end
+end

data/lib/generators/permittribute/templates/admin.rb

@@ -0,0 +1,12 @@
+Permittribute.configure(:admin) do |config|
+  # add class variables for permitted attributes
+  # For example:
+  # config.articles = [:title, :summary, :author_id, :published_at, :publication]
+  # Use as #permittribute_admin_articles
+
+  # config.books = [:title, :summary, :author_id, :published_at, :publication, :price, :status]
+  # Use as #permittribute_admin_books
+
+  # config.authors = [:name, :language, :age]
+  # Use as #permittribute_admin_authors
+end

data/lib/generators/permittribute/templates/api.rb

@@ -0,0 +1,12 @@
+Permittribute.configure(:api) do |config|
+  # add class variables for permitted attributes
+  # For example:
+  # config.articles = [:title, :summary, :author_id, :published_at, :publication]
+  # Use as #permittribute_api_articles
+
+  # config.books = [:title, :summary, :author_id, :published_at, :publication, :price, :status]
+  # Use as #permittribute_api_books
+
+  # config.authors = [:name, :language, :age]
+  # Use as #permittribute_api_authors
+end

data/lib/generators/permittribute/templates/default.rb

@@ -0,0 +1,12 @@
+Permittribute.configure do |config|
+  # add class variables for permitted attributes
+  # For example:
+  # config.articles = [:title, :summary, :author_id, :published_at, :publication]
+  # Use as #permittribute_articles
+
+  # config.books = [:title, :summary, :author_id, :published_at, :publication, :price, :status]
+  # Use as #permittribute_books
+
+  # config.authors = [:name, :language, :age]
+  # Use as #permittribute_authors
+end

data/lib/permittribute.rb

@@ -0,0 +1,13 @@
+require "permittribute/version"
+require 'permittribute/strong_params'
+
+require 'permittribute/engine'  if defined?(Rails)
+
+module Permittribute
+  def self.configure(role=:default, &block)
+    Permittribute::Attrs.configure_with_role(role.to_sym, &block)
+
+    Permittribute::StrongParams.delegate *Permittribute::Attrs.defined_meth_names_for_role(role),
+        to: :permittribute, prefix: :permittribute
+  end
+end

data/lib/permittribute/attrs.rb

@@ -0,0 +1,45 @@
+module Permittribute
+  class Attrs
+    @@attributes_group_by_roles = {}
+    @@defined_meth_names = Hash.new {|k,v| k[v] = []}
+
+    class << self
+      def all
+        @@defined_meth_names.values.flatten
+      end
+
+      def defined_meth_names_for_role(role)
+        @@defined_meth_names[role] || []
+      end
+
+      def configure_with_role(role, &block)
+        @@attributes_group_by_roles[role] ||= OpenStruct.new
+
+        yield @@attributes_group_by_roles[role]
+
+        define_role_attribute_methods(role)
+        @@defined_meth_names[role].uniq!
+      end
+
+      def define_role_attribute_methods(role)
+        @@attributes_group_by_roles[role].each_pair do |attribute, params|
+          define_role_attribute_method(role, attribute, params)
+        end
+      end
+
+      def define_role_attribute_method(role, attribute, params)
+        meth_name = (role == :default ? attribute : "#{role}_#{attribute}").to_sym
+        unless respond_to? meth_name
+          instance_eval <<-eometh
+            def #{meth_name}
+              @@attributes_group_by_roles['#{role}'.to_sym].send('#{attribute}'.to_sym)
+            end
+          eometh
+
+          @@defined_meth_names[role] << meth_name
+        end
+      end
+    end
+
+  end
+end

data/lib/permittribute/engine.rb

@@ -0,0 +1,20 @@
+module Permittribute
+  class Engine < ::Rails::Engine
+
+    engine_name "permittribute"
+
+    initializer 'permittribute.add_strong_params' do |app|
+      ActiveSupport.on_load :action_controller do
+        include Permittribute::StrongParams
+      end
+    end
+
+    initializer "permittribute.configure", group: :all do |app|
+      Dir[Rails.root.join('lib', 'permittribute/*.rb').to_s].each do |c|
+        app.config.to_prepare do
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+    end
+  end
+end

data/lib/permittribute/strong_params.rb

@@ -0,0 +1,9 @@
+require 'permittribute/attrs'
+
+module Permittribute
+  module StrongParams
+    def permittribute
+      Permittribute::Attrs
+    end
+  end
+end

data/lib/permittribute/version.rb

@@ -0,0 +1,3 @@
+module Permittribute
+  VERSION = "1.0.1"
+end

data/permittribute.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'permittribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "permittribute"
+  spec.version       = Permittribute::VERSION
+  spec.authors       = ["Priyank Gupta"]
+  spec.email         = ["priyankgupta1988@gmail.com", "priyankgupta1988@yahoo.com"]
+  spec.summary       = %q{ Reuse Permitted Attributes and group them at a single reference file }
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: permittribute
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Priyank Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Reuse Permitted Attributes and group them at a single reference file
+email:
+- priyankgupta1988@gmail.com
+- priyankgupta1988@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/permittribute/install_generator.rb
+- lib/generators/permittribute/templates/admin.rb
+- lib/generators/permittribute/templates/api.rb
+- lib/generators/permittribute/templates/default.rb
+- lib/permittribute.rb
+- lib/permittribute/attrs.rb
+- lib/permittribute/engine.rb
+- lib/permittribute/strong_params.rb
+- lib/permittribute/version.rb
+- permittribute.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Reuse Permitted Attributes and group them at a single reference file
+test_files: []