shoulda-matchers-pundit 0.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
+Procfile
+Guardfile
+.rvmrc
+.guard_history
+.sass-cache

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0
+  - jruby
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+
+  gem 'foreman', '~> 0.62.0'
+  gem 'guard', '~> 1.6.2'
+  gem 'guard-minitest', '~> 0.5.0'
+  gem 'pry'
+
+  gem 'rspec-web', github: 'dcunited001/rspec-web'
+  gem 'minitest-reporters-ws', "~> 0.0.2"
+
+  if RbConfig::CONFIG['target_os'] =~ /linux/i
+    gem 'rb-inotify', require: false
+    gem 'ruby_gntp'
+  end
+
+  if RbConfig::CONFIG['target_os'] =~ /darwin/i
+    gem 'rb-fsevent', require: false
+    gem 'growl'
+  end
+
+  if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+    gem 'wdm', require: false, platforms: [:mswin, :mingw]
+    gem 'rb-notifu', platforms: [:mswin, :mingw]
+  end
+
+end

data/Guardfile.example

@@ -0,0 +1,10 @@
+interactor guard_rc: '~/.my_guard-rc', history_file: '.guard_history'
+scope groups: [:minitest]
+
+group :minitest do
+  guard :minitest, :notify => true do
+    watch(%r|^spec/(.*)_spec\.rb|)
+    watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Conner
+
+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/Procfile.example

@@ -0,0 +1 @@
+rspecweb: rspec-web

data/README.md

@@ -0,0 +1,41 @@
+[![Build Status](https://travis-ci.org/dcunited001/shoulda-matchers-pundit.png)](https://travis-ci.org/dcunited001/shoulda-matchers-pundit)
+
+# Shoulda::Matchers::Pundit
+
+TODO: update readme: description, installation, usage
+TODO: Configure Travis
+TODO: Configure Appraisal?
+TODO: file to load matcher for RSpec & integration test & test task
+TODO: file to load matcher for Cucumber & integration test & test task
+TODO: relocate dev dependencies from Gemfile to Gemspec
+TODO: Change gemspec dependencies to work with older versions of shoulda-matchers & pundit
+TODO: allow configurable error messages per suite & per spec file?
+TODO: add aliases to PermittedToMatcher?
+TODO: add ForbidMatcher & ForbiddenToMatcher? (& update integration tests)
+TODO: find a way to remove the constraint that a policy's record must be named record
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shoulda-matchers-pundit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shoulda-matchers-pundit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/shoulda-matchers-pundit.rb

@@ -0,0 +1,7 @@
+module Shoulda
+  module Matchers
+    module Pundit
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/shoulda/matchers/pundit.rb

@@ -0,0 +1,102 @@
+require "shoulda/matchers/pundit/version"
+
+module Shoulda
+  module Matchers
+    module Pundit
+
+      def permit(action)
+        PermitMatcher.new(action)
+      end
+
+      def be_permitted_to(action)
+        PermittedToMatcher.new(action)
+      end
+
+      class PermitMatcher
+        attr_reader :action, :policy
+
+        def initialize(action)
+          @action = action
+        end
+
+        def matches?(policy)
+          @policy = policy
+          policy.public_send("#{action}?")
+        end
+
+        def failure_message_for_should
+          <<-message
+            #{policy.class} does not permit #{action} on #{policy.record}
+            for #{policy.user.inspect}.
+          message
+        end
+
+        def failure_message_for_should_not
+          <<-message
+            #{policy.class} does not forbid #{action} on #{policy.record}
+            for #{policy.user.inspect}.
+          message
+        end
+
+        def description
+          "permits #{@action}"
+        end
+      end
+
+      class PermittedToMatcher
+        attr_reader :action, :record, :policy
+
+        def initialize(action)
+          @action = action
+        end
+
+        def matches?(user)
+          @policy ||= infer_policy(user)
+          @policy = policy.call(user, record) if @policy.is_a? Proc
+          policy.public_send("#{action}?")
+        end
+
+        def on(record)
+          @record = record
+          self
+        end
+
+        #alias_method :on_a, :on
+        #alias_method :a, :on
+        #alias_method :to, :on
+
+        def by(policy)
+          @policy = case policy
+            when Class then lambda { |user, record| policy.new(user, record) }
+            else policy
+          end
+          self
+        end
+
+        def failure_message_for_should
+          <<-message
+            User is not permitted to #{action} a #{policy.record} by #{policy.class}.
+            #{policy.user.inspect}.
+          message
+        end
+
+        def failure_message_for_should_not
+          <<-message
+            User is not forbidden to #{action} a #{policy.record} by #{policy.class}.
+            #{policy.user.inspect}.
+          message
+        end
+
+        def description
+          "permits #{action} on #{record}"
+        end
+
+        private
+
+        def infer_policy(user)
+          "#{record.class.name}Policy".constantize.new(user, record)
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/pundit/minitest.rb

@@ -0,0 +1,15 @@
+require 'shoulda/matchers/pundit'
+
+if defined?(Pundit)
+  Shoulda::Matchers::Pundit.module_eval do
+    def self.included(base)
+      instance_methods.each do |name|
+        base.register_matcher name, name
+      end
+    end
+  end
+
+  class MiniTest::Spec
+    include Shoulda::Matchers::Pundit
+  end
+end

data/lib/shoulda/matchers/pundit/version.rb

@@ -0,0 +1,7 @@
+module Shoulda
+  module Matchers
+    module Pundit
+      VERSION = "0.0.1".freeze
+    end
+  end
+end

data/shoulda-matchers-pundit.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'shoulda/matchers/pundit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shoulda-matchers-pundit"
+  spec.version       = Shoulda::Matchers::Pundit::VERSION.dup
+  spec.authors       = ["David Conner"]
+  spec.email         = ["dconner.pro@gmail.com"]
+  spec.description   = %q{Shoulda Matchers for Pundit & Setup for RSpec/Minitest}
+  spec.summary       = %q{Shoulda Matchers for Pundit & Setup for RSpec/Minitest}
+  spec.homepage      = "http://github.com/dcunited001/shoulda-matchers-pundit"
+  spec.license       = "MIT"
+  spec.date          = Time.now.strftime("%Y-%m-%d")
+
+  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 "shoulda-matchers", ">= 1.4.1"
+  spec.add_dependency "pundit", "~> 0.2.0"
+
+  spec.add_development_dependency "rake", ">= 0.9.2"
+  spec.add_development_dependency "minitest-matchers", ">= 1.2.0"
+
+end

data/spec/minitest_matchers_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Shoulda::Matchers::Pundit::PermitMatcher do
+
+  describe ArticlePolicy do
+
+    subject { ArticlePolicy.new(user, article) }
+    let(:article) { Article.new(user) }
+
+    describe 'Guest' do
+      let(:user) { nil }
+
+      wont { permit(:create) }
+      must { permit(:show) }
+      wont { permit(:update) }
+      wont { permit(:destroy) }
+
+    end
+
+    describe 'Any User' do
+      let(:user) { User.new(0) }
+      let(:another_user) { User.new(1) }
+      let(:article) { Article.new(another_user) }
+
+      must { permit(:create) }
+      must { permit(:show) }
+      wont { permit(:update) }
+      wont { permit(:destroy) }
+
+    end
+
+    describe 'Article Creater' do
+      let(:user) { User.new(1) }
+
+      must { permit(:create) }
+      must { permit(:show) }
+      must { permit(:update) }
+      wont { permit(:destroy) }
+
+    end
+  end
+end
+
+describe Shoulda::Matchers::Pundit::PermittedToMatcher do
+
+  let(:article) { Article.new(subject) }
+
+  describe 'Guest' do
+    subject { nil }
+
+    describe ArticlePolicy do
+
+      wont { be_permitted_to(:create).on(article) }
+      must { be_permitted_to(:show).on(article) }
+      wont { be_permitted_to(:update).on(article) }
+      wont { be_permitted_to(:destroy).on(article) }
+
+    end
+  end
+
+
+  describe 'Any User' do
+    subject { User.new(0) }
+
+    describe ArticlePolicy do
+      let(:another_user) { User.new(1) }
+      let(:article) { Article.new(another_user) }
+
+      must { be_permitted_to(:create).on(article) }
+      must { be_permitted_to(:show).on(article) }
+      wont { be_permitted_to(:update).on(article) }
+      wont { be_permitted_to(:destroy).on(article) }
+
+    end
+
+  end
+
+  describe 'Article Creator' do
+    subject { User.new(1) }
+
+    describe ArticlePolicy do
+
+      must { be_permitted_to(:create).on(article) }
+      must { be_permitted_to(:show).on(article) }
+      must { be_permitted_to(:update).on(article) }
+      wont { be_permitted_to(:destroy).on(article) }
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require 'minitest/autorun'
+require 'minitest/matchers'
+require "pry"
+
+require "pundit"
+require "active_model/naming"
+
+require 'shoulda/matchers/pundit/minitest'
+
+if ENV['MINITESTREPORTER']
+  require "minitest/reporters"
+  require "minitest/reporters/ws"
+
+  reporter = case ENV['MINITESTREPORTER']
+             when 'ws' then MiniTest::Reporters::Ws::Reporter.new
+             when 'spec' then MiniTest::Reporters::SpecReporter.new
+             else MiniTest::Reporters::ProgressReporter.new
+  end
+
+  Minitest::Reporters.use! reporter
+end
+
+class ArticlePolicy < Struct.new(:user, :record)
+
+  def create?
+    true if user
+  end
+
+  def update?
+    user && (record.user_id == user.id)
+  end
+
+  def destroy?
+    false
+  end
+
+  def show?
+    true
+  end
+
+end
+
+class Article
+  attr_accessor :user_id
+  def initialize(user)
+    @user_id = user.id if user
+  end
+end
+
+class User
+  attr_accessor :id
+  def initialize(id)
+    @id = id
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: shoulda-matchers-pundit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Conner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: minitest-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Shoulda Matchers for Pundit & Setup for RSpec/Minitest
+email:
+- dconner.pro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile.example
+- LICENSE.txt
+- Procfile.example
+- README.md
+- Rakefile
+- lib/shoulda-matchers-pundit.rb
+- lib/shoulda/matchers/pundit.rb
+- lib/shoulda/matchers/pundit/minitest.rb
+- lib/shoulda/matchers/pundit/version.rb
+- shoulda-matchers-pundit.gemspec
+- spec/minitest_matchers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dcunited001/shoulda-matchers-pundit
+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.25
+signing_key: 
+specification_version: 3
+summary: Shoulda Matchers for Pundit & Setup for RSpec/Minitest
+test_files:
+- spec/minitest_matchers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: