can_field 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3468acfaf9c73a05f5fcab6e9753ba27df93858
+  data.tar.gz: a42426ddc1769f28c467a114dbeb9f0e38787ac8
+SHA512:
+  metadata.gz: 0da21c94dd1b608056d84ada848e53ec50cb8e4092750f663a8fa1e351c6430a333db75ab72d5bb1dce204366bc4ca2e074e6f154478372b07b59d42d2a5d28f
+  data.tar.gz: b152ffc10ba960210fd2ce8e833e63e981c83de16803fd9eb1df06cc729e283be98f0bc9325922aee98db177c3a83b0f77458177e723f4f710afd830b0091743

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Roman Kolesnev
+
+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,70 @@
+# CanField
+
+[CanCan](https://github.com/ryanb/cancan) provides only model-level permissions. This gem adds field-based permissions to CanCan using [strong_parameters gem](https://github.com/rails/strong_parameters).
+
+**Warning!** Currently gem doesn't support any nested logic!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'can_field'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install can_field
+
+## Usage
+
+### ability.rb
+
+Now you have new method for you ability.rb file.
+
+```ruby
+canf(actions, target, fields)
+
+# example usage
+
+canf :update, Book, [:title, :desription]
+canf [:create, :update], Shelf, [:position]
+```
+
+This method invoke standart `can` method with give `actions` and `targer` and generate some additional rules for restrict field access (`:_cf_action_fl_field` as example).
+
+### In controller
+
+There is a contrller class method that provides integration with `load_and_authorize_resource`. Just add `permit_can_field_constraints` right after `load_and_authorize_resource` call. Like this:
+
+```ruby
+class BooksController < ApplicationController
+  load_and_authorize_resource
+  permit_can_field_constraints
+  
+  ...
+
+end
+```
+
+### Helpers
+
+In controller and views you can use helpers `canf?` and `allowed_fields_for`:
+
+```ruby
+allowed_fields_for(action, subject) # return list of available fields or [:all] if no restrictions
+allowed_fields_for :create, Book # as example
+
+canf?(action, subject, field) # like can? but look for field restrictions
+canf? :update, Book, :title # as example 
+```
+
+## 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. Create new Pull Request

data/Rakefile

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

data/can_field.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'can_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "can_field"
+  spec.version       = CanField::VERSION
+  spec.authors       = ["Roman Kolesnev"]
+  spec.email         = ["rvkolesnev@gmail.com"]
+  spec.description   = %q{CanCan constraints for fields using strong_parameters}
+  spec.summary       = %q{This gem provide extension for CanCan and some new helpers for restrict access on field level.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'cancan'
+  spec.add_dependency 'strong_parameters'
+  spec.add_dependency 'rails', '< 4.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "active_attr"
+end

data/lib/can_field.rb

@@ -0,0 +1,7 @@
+require "can_field/version"
+require "can_field/can_can/rule_additions"
+require "can_field/can_can/ability_additions"
+require "can_field/controller_additions"
+
+module CanField
+end

data/lib/can_field/can_can/ability_additions.rb

@@ -0,0 +1,36 @@
+module CanField
+  module CanCan
+    module AbilityAdditions
+      # see README.md
+      def canf(actions, target, fields)
+        unless actions.is_a? Array
+          actions = [actions]
+        end
+
+        unless fields.is_a? Array
+          fields = [fields]
+        end
+
+        actions.each do |action|
+          can action.to_sym, target
+        end
+
+        actions.product(fields).each do |x|
+          action, field = x
+          can "_cf_#{action}_fl_#{field}".to_sym, target
+        end
+      end
+
+      # for internal use
+      def abilities_for_subject(subject)
+        @rules.select{|a| a.relevant_for_subject? subject}.map(&:actions).flatten.uniq
+      end
+    end
+  end
+end
+
+if defined? CanCan::Ability
+  CanCan::Ability.class_eval do
+    include CanField::CanCan::AbilityAdditions
+  end
+end

data/lib/can_field/can_can/rule_additions.rb

@@ -0,0 +1,18 @@
+module CanField 
+  module CanCan
+    
+    module RuleAdditions
+      # for internal use
+      def relevant_for_subject?(subject)
+        @match_all || matches_subject?(subject)
+      end
+    end
+
+  end
+end
+
+if defined? CanCan::Rule
+  CanCan::Rule.class_eval do
+    include CanField::CanCan::RuleAdditions
+  end
+end

data/lib/can_field/controller_additions.rb

@@ -0,0 +1,59 @@
+module CanField
+  module ControllerAdditions
+    module ClassMethods
+      def permit_can_field_constraints
+        resource_name = self.to_s.sub("Controller", "").underscore.split('/').last.singularize
+        model = Kernel.const_get(resource_name.camelcase)
+
+        [:update, :create].each do |action|
+          prepend_before_filter(only: action) do
+            if params.has_key?(resource_name)
+              keys = allowed_fields_for action, model
+              if keys == [:all]
+                self.params[resource_name] = params[resource_name].permit!
+              else
+                self.params[resource_name] = params[resource_name].permit *keys
+              end
+            else
+              self.params = params.permit, *keys
+            end
+          end
+        end
+      end
+    end
+    
+    module InstanceMethods
+      def allowed_fields_for(action, subject)
+        #TODO: gen cool rules
+        abilities = Ability.new(current_user).abilities_for_subject(subject).map(&:to_s).group_by{|x| x[0..2] == '_cf' ? :field : :mass}
+
+        re = /\A_cf_(?<action>\w+)_fl_(?<field>\w+)$/
+        result = (abilities[:field] || []).map do |a|
+          x = re.match(a)
+          [x[:action], x[:field]]
+        end.select{|a| a[0] == action.to_s}.map{|a| a[1]}.map(&:to_sym)
+
+        result << :all if result == []
+
+        result
+      end
+
+      def canf?(action, subject, field)
+        allowed_fields_for(action, subject).include?(field.to_sym) or
+          allowed_fields_for(action, subject).include?(:all)
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+      receiver.helper_method :allowed_fields_for, :canf?
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include CanField::ControllerAdditions
+  end
+end

data/lib/can_field/version.rb

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

data/spec/can_field/can_can_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+class Book
+  include ActiveAttr::Model
+end
+
+class Shelf
+  include ActiveAttr::Model
+end
+
+class Ability
+  include CanCan::Ability
+
+  def initialize
+    canf :update, Book, :title
+
+    canf [:create, :update], Shelf, [:name, :position]
+  end
+end
+
+describe "CanField::CanCan" do
+  describe "::AbilityAdditions" do
+    subject{ ability }
+    let(:ability) {Ability.new}
+
+    describe "#canf" do
+      it { should     be_able_to(:_cf_update_fl_title,  Book.new) }
+      it { should_not be_able_to(:_cf_update_fl_author, Book.new) }
+
+      it { should     be_able_to(:update, Book.new) }
+      it { should_not be_able_to(:create, Book.new) }
+
+      it { should be_able_to(:_cf_update_fl_name,     Shelf.new) }
+      it { should be_able_to(:_cf_update_fl_position, Shelf.new) }
+      it { should be_able_to(:_cf_create_fl_name,     Shelf.new) }
+      it { should be_able_to(:_cf_create_fl_position, Shelf.new) }
+
+      it { should     be_able_to(:update, Shelf.new)}
+      it { should     be_able_to(:create, Shelf.new)}
+      it { should_not be_able_to(:read,   Shelf.new)}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "cancan"
+require "can_field"
+require "active_attr"
+require "cancan/matchers"

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: can_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roman Kolesnev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cancan
+  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: strong_parameters
+  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: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: active_attr
+  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: CanCan constraints for fields using strong_parameters
+email:
+- rvkolesnev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- can_field.gemspec
+- lib/can_field.rb
+- lib/can_field/can_can/ability_additions.rb
+- lib/can_field/can_can/rule_additions.rb
+- lib/can_field/controller_additions.rb
+- lib/can_field/version.rb
+- spec/can_field/can_can_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.0
+signing_key: 
+specification_version: 4
+summary: This gem provide extension for CanCan and some new helpers for restrict access
+  on field level.
+test_files:
+- spec/can_field/can_can_spec.rb
+- spec/spec_helper.rb