dude_policy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1b4e1e0aa981141b42efcca848389438987fb99a890d4dfcb2375b9567cf2de
+  data.tar.gz: e65b4dfdce1fbfb939b5e73caaae218c72c1b6e895daecdbd9bb5351ce8fe4ce
+SHA512:
+  metadata.gz: 4a1d56704ffafee188c45bf81937b2663cf5d638ff4441bd11bd8aa780f1ffbc1a0f451f611e728fda2aaf7d40963c9505309e5371e8717a27881a48d8907116
+  data.tar.gz: 281ae48292156284ee965d9554969b4476923d53921f5fcdcd91214756386676bef6c5aceeff392849b8f34a867e634a1b7e01cfca863238fba257c54b5d4145

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.1

data/CHANGELOG.md

@@ -0,0 +1 @@
+No changes sofar

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at equivalent@eq8.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dude_policy.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    dude_policy (0.1.0)
+      activesupport (> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dude_policy!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tomas Valent
+
+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,111 @@
+# Dude Policy
+
+This gem provides a way  how to do Ruby on Rails [Policy Objects](https://blog.eq8.eu/article/policy-object.html)
+from point of view of current_user/current_account (the **dude**)
+
+![](https://triblive.com/wp-content/uploads/2019/01/673808_web1_gtr-liv-goldenglobes-121718.jpg)
+
+Here are some examples what we mean:
+
+
+```ruby
+# irb
+article = Article.find(123)
+review  = Review.find(123)
+current_user = User.find(432) # e.g. Devise on any authentication solution
+
+current_user.dude.able_to_edit_article?(article)
+# => true
+
+current_user.dude.able_to_add_article_review?(article)
+# => true
+
+current_user.dude.able_to_delete_review?(review)
+# => false
+```
+
+[RSpec](https://rspec.info/) examples:
+
+```ruby
+# spec/any_file_spec.rb
+RSpec.describe 'short demo' do
+  let(:author_user)  { User.create }
+  let(:article) { Article.create(author: author_user) }
+  let(:different_user)  { User.create }
+
+  # you write tests like this:
+  it { expect(author_user.able_to_edit_article?(article)).to be_truthy }
+
+  # or you can take advantage of native `be_` RSpec matcher that converts any questionmark ending method to matcher
+  it { expect(author_user).to be_able_to_edit_article(article) }
+  it { expect(different_user).not_to be_able_to_edit_article(article) }
+  it { expect(author_user).not_to be_able_to_add_article_review(article) }
+  it { expect(different_user).to be_able_to_add_article_review(article) }
+  it { expect(author_user).not_to be_able_to_delete_review(article) }
+  it { expect(different_user).to be_able_to_add_article_review(article) }
+end
+```
+
+Policy objects:
+
+```ruby
+# app/policy/article_policy.rb
+class ArticlePolicy < DudePolicy::BasePolicy
+  def able_to_update_article?(dude:)
+    return true if article.author == dude
+    false
+  end
+
+  def able_to_add_article_review?(dude:)
+    return true if article.author != dude
+    false
+  end
+
+  private
+
+  def article
+    resource # delegation defined in DudePolicy::BasePolicy
+  end
+end
+```
+
+Full example in example app
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dude_policy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dude_policy
+
+## Usage
+
+### Gem is responsible for Authorization
+
+Gem will provide a way how to do `Authorization` (whan logged in user can/cannot do)
+
+For `Authentication` (is User logged in ?) you will need a different solution / gem (e.g. [Devise](https://github.com/heartcombo/devise), custom login solution, ...)
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/equivalent/dude_policy This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dude_policy/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DudePolicy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/equivalent/dude_policy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dude_policy"
+
+# 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(__FILE__)

data/bin/setup

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

data/dude_policy.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/dude_policy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dude_policy"
+  spec.version       = DudePolicy::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+
+  spec.summary       = %q{Policy objects for Ruby on Rails from perspectvie of current account}
+  spec.description   = %q{current user (current account) oriented Plain Ruby Object Policy for Ruby on Rails}
+  spec.homepage      = "https://github.com/equivalent/dude_policy"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/equivalent/dude_policy/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", '> 4.2' # ensures compatibility for ruby 2.0.0+ to head
+end

data/lib/dude_policy/base_policy.rb

@@ -0,0 +1,13 @@
+module DudePolicy
+  class BasePolicy
+    attr_reader :resource
+
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def inspect
+      "<#{self.class.name}##{object_id} resource:#{resource.class.name}>"
+    end
+  end
+end

data/lib/dude_policy/dude.rb

@@ -0,0 +1,25 @@
+module DudePolicy
+  class Dude
+    attr_reader :dude
+
+    def initialize(current_dude)
+      @dude = current_dude
+    end
+
+    def inspect
+      id = "##{dude.id}" if dude.respond_to?(:id)
+      "<#DudePolicy::Dude##{object_id} #{dude.class.name}#{id}>"
+    end
+
+    def method_missing(name, resource)
+      resource.policy.send(name, dude: dude)
+    end
+
+    # RSpec mocks are checking if object responds to calls
+    # Due to fact that we use method_missing is delegating responsibility
+    # Dude class responds to all calls
+    def respond_to?(*)
+      true
+    end
+  end
+end

data/lib/dude_policy/has_policy.rb

@@ -0,0 +1,11 @@
+module DudePolicy
+  module HasPolicy
+    def policy
+      @policy ||= policy_name.constantize.new(self)
+    end
+
+    def policy_name
+      "#{self.class.name}Policy"
+    end
+  end
+end

data/lib/dude_policy/is_a_dude.rb

@@ -0,0 +1,7 @@
+module DudePolicy
+  module IsADude
+    def dude
+      @dude ||= DudePolicy::Dude.new(self)
+    end
+  end
+end

data/lib/dude_policy/nil_dude_policy.rb

@@ -0,0 +1,13 @@
+module DudePolicy
+  class NilDudePolicy
+    include Singleton
+
+    def method_missing(*)
+      false
+    end
+
+    def inspect
+      "<#DudePolicy##{object_id} on nil>"
+    end
+  end
+end

data/lib/dude_policy/nil_extension.rb

@@ -0,0 +1,7 @@
+module DudePolicy
+  module NilExtesion
+    def dude
+      DudePolicy::NilDudePolicy.instance
+    end
+  end
+end

data/lib/dude_policy/version.rb

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

data/lib/dude_policy.rb

@@ -0,0 +1,24 @@
+require 'active_support/inflector'
+
+require 'singleton' # standard Ruby lib
+require "dude_policy/version"
+
+# nil stuff
+require "dude_policy/nil_extension"
+require "dude_policy/nil_dude_policy"
+
+# current account stuff
+require "dude_policy/dude"
+require "dude_policy/base_policy"
+
+# extend app
+require "dude_policy/is_a_dude"
+require "dude_policy/has_policy"
+
+
+# core of `dude_policy` is extending `nil` to include `nil.dude` method
+NilClass.send(:include, DudePolicy::NilExtesion)
+
+module DudePolicy
+  NotAuthorized = Class.new(StandardError)
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: dude_policy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: current user (current account) oriented Plain Ruby Object Policy for
+  Ruby on Rails
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dude_policy.gemspec
+- lib/dude_policy.rb
+- lib/dude_policy/base_policy.rb
+- lib/dude_policy/dude.rb
+- lib/dude_policy/has_policy.rb
+- lib/dude_policy/is_a_dude.rb
+- lib/dude_policy/nil_dude_policy.rb
+- lib/dude_policy/nil_extension.rb
+- lib/dude_policy/version.rb
+homepage: https://github.com/equivalent/dude_policy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/equivalent/dude_policy
+  source_code_uri: https://github.com/equivalent/dude_policy
+  changelog_uri: https://github.com/equivalent/dude_policy/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Policy objects for Ruby on Rails from perspectvie of current account
+test_files: []