cancancan_masquerade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46d1d6c061c49c53bd5f9fe15d7bdf26d684090da709509a7de632e547bb2b4d
+  data.tar.gz: 46ac209d484ee033ddd460ab7634247b7268e766c1957a27f52b67dbcdfa88db
+SHA512:
+  metadata.gz: 6cacf3cf74d09354695f0b036c6a932606b18e57e95ae08f7878195a4d90c36ed684f31e5de8c78faf4545872c53f2bcc1f9d009373ed9c54da0cceaea520a43
+  data.tar.gz: 61e08e5aacbea22e12b08f57eab2b23d8ac2d2ac8cf736bf5a6d86b2861d3a5bfd35ddf169a372836840823671d4494b6620ead5b860f2a5d37d224553976349

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

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, sexual identity and orientation,
+or any other criteria, as decided by the community.
+
+## 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 chall8908@gmail.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# ruby=ruby-2.5.1
+# ruby-gemset=cancancan_masquerade
+
+# Specify your gem's dependencies in cancancan_masquerade.gemspec
+gemspec
+
+require 'cancancan'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    cancancan_masquerade (0.1.0)
+      cancancan (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    cancancan (2.3.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cancancan_masquerade!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.59)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chris Hall
+
+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,135 @@
+# CanCanCan::Masquerade
+
+Put on a mask and pretend!  CanCanCan::Masquerade allows your objects to pretend
+to be other objects when checking permissions.
+
+This gem was originally designed with the goal of allowing ViewModels to act as
+Models in a Ruby on Rails application.  The implementation is simple enough that
+it can be applied to pretty much any object you like.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cancancan_masquerade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cancancan_masquerade
+
+## Usage
+
+Include Masquerade in your ability class!
+
+```ruby
+class Ability
+  include CanCan::Ability
+  include CanCanCan::Masquerade
+
+  # ... your permissions, as usual
+end
+```
+
+From here, we're operating on other objects in your project.  Only that one
+modification needs to be made to your ability class for this to work.
+
+### Inheriting from an instance variable
+
+If the object you'd like to masquerade as is an instance variable of the current
+object, simply specify it as a symbol (similar to delegating to an instance
+variable in Rails):
+
+```ruby
+class MaskedDancer
+  extend CanCanCan::Masquerade::InheritPermissions
+
+  inherit_permissions_from :@dancer
+
+  # ... rest of your class
+end
+```
+
+### Inheriting from a method
+
+If the object you'd like to masquerade as can be accessed via a property of the
+current object, pass the name of the method as a symbol:
+
+```ruby
+class MaskedDancer
+  extend CanCanCan::Masquerade::InheritPermissions
+
+  inherit_permissions_from :partner
+
+  # ... rest of your class
+end
+```
+
+### Inheriting by building another object
+
+If neither of the above work and the current object can be mapped into the object
+you wish to pretend to be, you can specify the class name and the mapping directly:
+
+```ruby
+class MaskedDancer
+  extend CanCanCan::Masquerade::InheritPermissions
+
+  inherit_permissions_from Dancer,
+                           mapping: { name: :@name,
+                                      type: :type
+                                    }
+
+  # ... rest of your class
+end
+```
+
+_The mapping must be a hash!_  Values that are symbols will be checked against
+defined methods and instance variables for mapping.  If neither match or the
+value is not a symbol, it will be passed as is.
+
+### Complex build process
+
+If the new object can't be built using one of these methods, you can pass a block
+that will be called when the object is needed for checking permissions:
+
+```ruby
+class MaskedDancer
+  extend CanCanCan::Masquerade::InheritPermissions
+
+  build_permission_instance do
+    # build your permission object here
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push git
+commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chall8908/cancancan_masquerade.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org)
+code of conduct.
+
+## 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 CancancanMasquerade project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cancancan_masquerade/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 "cancancan_masquerade"
+
+# 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/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/cancancan_masquerade.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cancancan/masquerade/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cancancan_masquerade"
+  spec.version       = CanCanCan::Masquerade::VERSION
+  spec.authors       = ["Chris Hall"]
+  spec.email         = ["chall8908@gmail.com"]
+
+  spec.summary       = %q{ Allow your objects to masquerade as other objects when checking permissions }
+  spec.description   = <<-DESC
+                       Put on a mask and pretend!  CanCanCan::Masquerade allows
+                       your objects to pretend to be other objects when checking
+                       permissions.
+                       DESC
+  spec.homepage      = "https://github.com/chall8908/cancancan_masquerade"
+  spec.license       = "MIT"
+
+  # 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 'cancancan', '~> 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rubocop', '~> 0.59'
+end

data/lib/cancancan/masquerade.rb

@@ -0,0 +1,16 @@
+module CanCanCan
+  module Masquerade
+
+    # Override functionality from CanCan to allow objects to masquerade as other objects
+    def extract_subjects(subject)
+      return extract_subjects(subject.to_permission_instance) if subject.respond_to? :to_permission_instance
+
+      return subject[:any] if subject.is_a? Hash and subject.key? :any
+
+      [subject]
+    end
+  end
+end
+
+require 'cancancan/masquerade/inherit_permissions'
+require 'cancancan/masquerade/version'

data/lib/cancancan/masquerade/inherit_permissions.rb

@@ -0,0 +1,57 @@
+module CanCanCan
+  module Masquerade
+    module InheritPermissions
+
+      protected
+
+      def inherit_permissions_from record, mapping: nil
+
+        case record
+        when /^@/   then permissions_from_instance_variable(record)
+        when Symbol then permissions_from_method(record)
+        when Class  then permissions_from_constructed_class(record, mapping)
+        else
+          raise InvalidPermissionConfiguration, "Invalid record type: #{record.class}.  Expecting Symbol or Class."
+        end
+      end
+
+      def build_permission_instance &block
+        define_method(:to_permission_instance, &block)
+      end
+
+      private
+
+      def permissions_from_instance_variable(variable)
+        build_permission_instance { instance_variable_get(variable) }
+      end
+
+      def permissions_from_method(method)
+        build_permission_instance { send(method) }
+      end
+
+      def permissions_from_constructed_class(class_to_build, mapping)
+        unless mapping.is_a?(Hash)
+          raise InvalidPermissionConfiguration, "Must supply a `mapping:` when building from a Class"
+        end
+
+        build_permission_instance do
+          values = mapping.reduce({}) do |final, (key, value)|
+            mapped_value = if value.is_a? Symbol and respond_to? value
+                             send value
+                           elsif value.is_a? Symbol and instance_variable_defined? value
+                             instance_variable_get value
+                           else
+                             value
+                           end
+
+            final.merge(key => mapped_value)
+          end
+
+          class_to_build.new(values)
+        end
+      end
+
+      class InvalidPermissionConfiguration < StandardError; end
+    end
+  end
+end

data/lib/cancancan/masquerade/version.rb

@@ -0,0 +1,9 @@
+module CanCanCan
+  module Masquerade
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    VERSION = [MAJOR, MINOR, PATCH] * '.'
+  end
+end

data/lib/cancancan_masquerade.rb

@@ -0,0 +1 @@
+require 'cancancan/masquerade'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: cancancan_masquerade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+description: |2
+                         Put on a mask and pretend!  CanCanCan::Masquerade allows
+                         your objects to pretend to be other objects when checking
+                         permissions.
+email:
+- chall8908@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- cancancan_masquerade.gemspec
+- lib/cancancan/masquerade.rb
+- lib/cancancan/masquerade/inherit_permissions.rb
+- lib/cancancan/masquerade/version.rb
+- lib/cancancan_masquerade.rb
+homepage: https://github.com/chall8908/cancancan_masquerade
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Allow your objects to masquerade as other objects when checking permissions
+test_files: []