activemodel-can_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fcfa2c7aaae1fd3314717694a5492d8387611eb
+  data.tar.gz: 2879eef1672d0e5e2b86b032eb4bcdfe89f7e41f
+SHA512:
+  metadata.gz: 29aa6cdd18c654637163b6a1a2911e584bbefbe04d42e5b516cfe2f7ab462b1cc137c7e79bb96f2c5dce4f0cf600aafc67ce7ebf455bad47bd83c6c34fd35b67
+  data.tar.gz: 904c7f34df160a3204dc0a7b1206d826841c68ac98be90adbc349c2785e03f8e201e41f7ab95d9098415e7594925a1457d7ca7853b44f003bfea7c84953344f3

data/.coverrails.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activemodel-cancan_validator.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,67 @@
+# activemodel-can_validator
+
+[![Build Status](https://travis-ci.org/yuku-t/activemodel-can_validator.svg?branch=master)](https://travis-ci.org/yuku-t/activemodel-can_validator) [![Code Climate](https://codeclimate.com/github/yuku-t/activemodel-can_validator/badges/gpa.svg)](https://codeclimate.com/github/yuku-t/activemodel-can_validator) [![Coverage Status](https://coveralls.io/repos/yuku-t/activemodel-can_validator/badge.svg)](https://coveralls.io/r/yuku-t/activemodel-can_validator) [![Dependency Status](https://gemnasium.com/yuku-t/activemodel-can_validator.svg)](https://gemnasium.com/yuku-t/activemodel-can_validator)
+
+Validate user permissions via [CanCan](https://github.com/CanCanCommunity/cancancan) API.
+
+## Usage
+
+Add to your Gemfile:
+
+```rb
+gem 'activemodel-can_validator'
+```
+
+Run:
+
+```
+bundle install
+```
+
+Then add the followng to your model which belongs to a user:
+
+```rb
+validates :user, can: { create: true }, on: :create
+```
+
+### Sample
+
+A user can retweet other users' tweets unless she is blocked by the user.
+
+```rb
+class User < ActiveRecord::Base
+  has_many :retweets
+
+  def block?(user)
+    blocking_users.include?(user)
+  end
+
+  delegate :can?, :cannot?, to: :ability
+
+  def ability
+    @ability ||= Ability.new(self)
+  end
+
+  class Ability
+    include CanCan::Ability
+    
+    def initialize(user)
+      user ||= User.new
+  
+      can :create, Retweet do |retweet|
+        !retweet.tweet.user.block?(user)
+      end
+    end
+  end
+end
+
+class Tweet < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Retweet < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :tweet
+  validates :user, presence: true, can: { create: true }, on: :create
+end
+```

data/Rakefile

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

data/activemodel-can_validator.gemspec

@@ -0,0 +1,22 @@
+file = File.open(File.expand_path('../lib/can_validator/version.rb', __FILE__))
+version = file.read.scan(/\d+\.\d+\.\d+/).first
+file.close
+
+Gem::Specification.new do |spec|
+  spec.name            = 'activemodel-can_validator'
+  spec.version         = version
+  spec.authors         = ['Yuku Takahashi']
+  spec.email           = ['yuku@qiita.com']
+  spec.summary         = 'A Rails validator based on CanCan.'
+  spec.homepage        = 'https://github.com/yuku-t/activemodel-can_validator'
+  spec.license         = 'MIT'
+
+  spec.files           = `git ls-files -z`.split("\x0")
+  spec.require_paths   = ['lib']
+
+  spec.add_dependency 'activemodel'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      permission_denied: doesn't have permission.

data/config/locales/ja.yml

@@ -0,0 +1,4 @@
+ja:
+  errors:
+    messages:
+      permission_denied: は権限がありません。

data/lib/activemodel-cancan_validator.rb

@@ -0,0 +1,3 @@
+require 'can_validator'
+require 'can_validator/version'
+require 'can_validator/engine'

data/lib/can_validator.rb

@@ -0,0 +1,18 @@
+class CanValidator < ActiveModel::EachValidator
+  RESERVED_OPTIONS = [:allow_nil, :allow_blank, :message, :on, :if, :unless]
+
+  def validate_each(record, attribute, value)
+    if !value.respond_to?(:can?) || !has_permission?(record, value)
+      record.errors.add(attribute, options[:message] || :permission_denied)
+    end
+  end
+
+  private
+
+  def has_permission?(record, value)
+    actions = options.keys - RESERVED_OPTIONS
+    actions.all? do |action|
+      options[action] ? value.can?(action, record) : value.cannot?(action, record)
+    end
+  end
+end

data/lib/can_validator/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+class CanValidator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/can_validator/version.rb

@@ -0,0 +1,3 @@
+class CanValidator
+  VERSION = '0.0.1'
+end

data/spec/can_validator_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe CanValidator do
+  describe 'validation' do
+    subject do
+      model_class.new(attr: value)
+    end
+
+    let(:model_class) do
+      Class.new(TestModel) do
+        validates :attr, can: { positive_action: true, negative_action: false }
+      end
+    end
+
+    context 'when the value object has CanCan interface' do
+      let(:value) do
+        Class.new do
+          def can?(*args)
+            false
+          end
+
+          def cannot?(*args)
+            !can?(*args)
+          end
+        end.new
+      end
+
+      context 'and it can do positive_action and cannot do negative_action against the resource' do
+        before do
+          allow(value).to receive(:can?).with(:positive_action, a_kind_of(model_class)).and_return(true)
+          allow(value).to receive(:can?).with(:negative_action, a_kind_of(model_class)).and_return(false)
+        end
+
+        it { should be_valid }
+      end
+
+      context "and it doesn't satisfy at least one required permission" do
+        before do
+          allow(value).to receive(:can?).with(:positive_action, a_kind_of(model_class)).and_return(true)
+          allow(value).to receive(:can?).with(:negative_action, a_kind_of(model_class)).and_return(true)
+        end
+
+        it { should be_invalid }
+      end
+    end
+
+    context 'when the value object does not have CanCan interface' do
+      let(:value) do
+        Object.new
+      end
+
+      it { should be_invalid }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'active_model'
+require 'can_validator'
+
+RSpec.configure do |config|
+  config.color = true
+  config.run_all_when_everything_filtered = true
+end
+
+class TestModel
+  include ActiveModel::Validations
+
+  def self.name
+    'TestModel'
+  end
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-can_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuku Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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:
+- yuku@qiita.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coverrails.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activemodel-can_validator.gemspec
+- config/locales/en.yml
+- config/locales/ja.yml
+- lib/activemodel-cancan_validator.rb
+- lib/can_validator.rb
+- lib/can_validator/engine.rb
+- lib/can_validator/version.rb
+- spec/can_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yuku-t/activemodel-can_validator
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Rails validator based on CanCan.
+test_files: []