slow_your_roles 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 683edb9b195a92a1350e19fed6ec1422bd63c69bd7b49346f17ea938fc4b27f9
+  data.tar.gz: cce3a768afe37fe29f1b8f22c6392b1a569f6b99667f858ba7ce9c222b19fbc0
+SHA512:
+  metadata.gz: 5770dbf6768fe7d95b22d9e810f7a6035841d6f9f2573e275c43a007ffed3f001e9f60fa95f2e2adfece6a4ab9e609d13f4fe483e17ac64a12f215003dd7c6d0
+  data.tar.gz: 56ee32fea12d12f113c635690538d8b59628ad40e67ad1ff93d540cb1c02fe251a101001973693637f6cac71ef436ab4d586fea18755366bb03aa09c75c17bb5

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+### 2 June 2020 - Version 2.0.2
+Fixed incompatibility issue with PostgresSQL when using serialize role method.
+
+### 21 April 2020 - Version 2.0.1
+Ported over from unmaintained library, easy_roles. Because we cannot push new
+versions of this library to rubygems.org, it's now called slow_your_roles.

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    slow_your_roles (2.0.2)
+      activesupport (>= 6.0.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.1)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rexml (3.2.4)
+    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)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 6.0.3.1)
+  rspec
+  rubocop
+  slow_your_roles!
+  sqlite3
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,223 @@
+# Slow Your Roles
+
+Simple rails gem for basic role authorization with ruby on rails.
+
+>This gem has been cloned from [Easy Roles](https://github.com/platform45/easy_roles) due to owner no longer supporting or maintaining that library. Since we cannot publish this gem to rubygems under that name we renamed the library.
+
+## Changelog
+
+Please read the [CHANGELOG.md](https://github.com/aarona/slow_your_roles/blob/master/CHANGELOG.md) file.
+
+## Install
+
+```ruby
+gem install slow_your_roles
+```
+
+## Basic Setup
+
+### Serialize Method
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'slow_your_roles'
+```
+
+Then generate the migration:
+
+```
+rails g slow_your_roles user roles
+```
+
+Or add a `roles` column to your users model, and set the default value to `--- []`. Please note you can call this column anything you like, I like to use the name "roles".
+
+```
+t.string :roles, default: "--- []"
+```
+
+Then you need to add `slow_your_roles :column_name` to your model:
+
+```ruby
+  class User < ActiveRecord::Base
+    slow_your_roles :roles
+  end
+```
+
+### Bitmask Method
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'slow_your_roles'
+```
+
+Then generate the migration:
+
+```  
+rails g slow_your_roles user roles --use-bitmask-method
+```
+
+Or add a `roles_mask` column to your users model of type `integer`, and set the default value to `0`. Please note you can call this column anything you like, I like to use the name "`roles_mask`":
+
+```
+t.integer :roles_mask, default: 0
+```
+
+Add `slow_your_roles :column_name, method: :bitmask` to your model:
+
+```ruby
+class User < ActiveRecord::Base
+  slow_your_roles :roles_mask, method: :bitmask
+end
+```
+
+And lastly you need to add a constant variable which stores an array of the different roles for your system. The name of the constant must be the name of your column in full caps.
+
+#### WARNING: Bitmask storage relies that you DO NOT change the order of your array of roles, if you need to add a new role, just append it to the end of the array.
+
+```ruby
+class User < ActiveRecord::Base
+  slow_your_roles :roles_mask, method: :bitmask
+  
+  # Constant variable storing roles in the system
+  ROLES_MASK = %w[admin moderator user].freeze
+end
+```
+
+## Usage
+
+Slow your roles extends your model, and adds a few methods needed for basic role authorization.
+
+adding a role to a user
+
+```add_role 'role'```
+
+adding multiple roles at the same time to a user
+
+```add_roles 'admin', 'manager'```
+
+removing a role from a user
+
+```remove_role 'role'```
+
+check to see if a user has a certain role
+
+```ruby
+has_role? 'role'
+# or
+is_role? # role being anything you like, for example 'is_admin?' or 'is_awesome?'
+```
+
+For every method above there is a bang method too.
+
+```ruby
+  add_role! 'role'
+  add_roles! 'admin', 'manager'
+  remove_role! 'role'
+```
+
+## Examples
+
+```ruby
+@user = User.first
+
+@user.add_role 'admin'
+
+@user.is_admin?
+=> true
+
+@user.has_role? 'admin'
+=> true
+
+@user.is_awesome?
+=> false
+
+@user.add_role 'awesome'
+
+@user.is_awesome?
+=> true
+
+@user.remove_role 'admin'
+
+@user.is_admin?
+=> false
+
+etc etc
+```
+
+## Protecting controllers
+
+There are many ways to implement views for specific roles, so I did not specifically supply one. Here's an example on what you could do:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def admin_required
+    unless current_user && current_user.is_admin?
+      flash[:error] = "Sorry, you don't have access to that."
+        redirect_to root_url and return false
+    end
+  end
+end
+```
+
+Then in your `AdminsController` or any controller that you only want admins to view:
+
+```ruby
+class AdminsController < ApplicationController
+   before_filter :admin_required
+end
+
+class MarksController < ApplicationController
+   before_filter :admin_required, only: %w(create update)
+end
+```
+
+## Scopes
+
+By default, slow_your_roles adds the `with_role` scope to your models.
+
+```ruby
+  @admins = User.with_role('admin')
+```
+
+If you're using the bitmask method, an `ArgumentError` will be thrown if an undeclared scope is queried. Since an `ActiveRecord::Relation` is returned, the query is chainable:
+
+```log
+  BitmaskUser.with_role('admin').where(active: true).to_sql
+  # => SELECT "bitmask_users".* FROM "bitmask_users" WHERE "bitmask_users"."roles_mask" IN (1, 3, 5, 7) AND "bitmask_users"."active" = 't'
+  
+  SerializeUser.with_role('admin').where(active: true).to_sql
+  # => SELECT "serialize_users".* FROM "serialize_users" WHERE "serialize_users"."active" = 't' AND (serialize_users.roles LIKE '%!admin!%')
+```
+
+slow_your_roles also supports a `without_role` scope.
+
+```ruby
+@non_admins = User.without_role('admin')
+```
+
+Follow me on twitter: http://twitter.com/_aaron0
+
+## License
+
+Copyright (c) 2020 Platform45
+
+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/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('slow_your_roles', '2.0.2') do |p|
+  p.description    = 'Easy role authorization in rails'
+  p.url            = 'http://github.com/aarona/slow_your_roles'
+  p.author         = 'Aaron A'
+  p.email          = '_aaron@tutanota.com'
+  p.ignore_pattern = ['tmp/*', 'script/*']
+  p.dependencies   = ['activesupport']
+  p.development_dependencies = %w[rspec activerecord rubocop sqlite3]
+end

data/init.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'slow_your_roles'

data/lib/generators/active_record/slow_your_roles_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+require_relative '../install_generator_helpers'
+
+module ActiveRecord
+  module Generators
+    # Generator class to add SlowYourRoles to an ActiveRecord model.
+    class SlowYourRolesGenerator < ActiveRecord::Generators::Base
+      include SlowYourRoles::InstallGeneratorHelpers
+
+      argument :role_col, type: :string, required: false, default: 'roles', banner: 'role column'
+
+      class_option :use_bitmask_method, type: :boolean, required: false, default: false,
+                                        desc: 'Setup migration for Bitmask method'
+
+      class_option :add_index, type: :boolean, required: false, default: false,
+                               desc: 'Add an index to the relevant column'
+
+      desc 'Internal use by slow_your_roles generator - use that instead'
+
+      source_root File.expand_path('templates', __dir__)
+
+      def create_user_model
+        fname = "app/models/#{table_name.singularize.underscore}.rb"
+
+        if File.exist?(File.join(destination_root, fname))
+          inclusion = "slow_your_roles :#{role_col}"
+          if parse_file_for_line(fname, inclusion)
+            say_status('skipped', fname)
+          else
+            after = "class #{table_name.singularize.camelize} < ApplicationRecord\n"
+            inject_into_file fname, after: after do
+              <<-HEREDOC
+  #{inclusion}
+              HEREDOC
+            end
+          end
+        else
+          template('model.rb.erb', fname)
+        end
+      end
+
+      def copy_slow_your_roles_migration
+        if options.use_bitmask_method
+          migration_template 'migration_bitmask.rb.erb',
+                             "db/migrate/add_roles_to_#{table_name}.rb"
+        else
+          migration_template 'migration_serialize.rb.erb',
+                             "db/migrate/add_roles_to_#{table_name}.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration_bitmask.rb.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class AddBitmaskRolesTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    change_table :<%= table_name %> do |t|
+      t.integer :<%= self.role_col %>, default: 0
+     <%- if options.add_index -%>
+      t.index :<%= self.role_col %>
+     <%- end -%>
+    end
+  end
+end

data/lib/generators/active_record/templates/migration_serialize.rb.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class AddRolesTo<%= table_name.camelize %> < ActiveRecord::Migration<%= "[#{Rails::VERSION::STRING[0..2]}]" if Rails::VERSION::MAJOR > 4 %>
+  def change
+    change_table :<%= table_name %> do |t|
+      t.string :<%= self.role_col %>, default: '--- []'
+     <%- if options.add_index -%>
+      t.index :<%= self.role_col %>
+     <%- end -%>
+    end
+  end
+end

data/lib/generators/active_record/templates/model.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class <%= table_name.singularize.camelize %> < ApplicationRecord
+  slow_your_roles :<%= role_col %>
+end

data/lib/generators/install_generator_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SlowYourRoles
+  # Helper module for file generators
+  module InstallGeneratorHelpers
+    class << self
+      def included(mod)
+        mod.class_eval do
+          source_root File.expand_path('templates', __dir__)
+
+          private
+
+          def parse_file_for_line(filename, str)
+            match = false
+
+            File.open(File.join(destination_root, filename)) do |f|
+              f.each_line do |line|
+                match = line if line =~ /(#{Regexp.escape(str)})/mi
+              end
+            end
+            match
+          end
+        end
+      end
+    end
+  end
+end