RubyRoles 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f0abb404befe21a94ffa66c559eca74a88800e51ed1ae6addf2ab8c541780c
-  data.tar.gz: b12d327d34fe9cecd55f3d93d05014a808a7c8f0342a311e2dfa28b8977c7c5a
+  metadata.gz: 2f57af3eeac9369deaa6fd24b79a20b024d8f99a990d9f225948f5d5552f254c
+  data.tar.gz: caa589a3e7489e2c584d84d20a03f70ab925ef3e6da4eca963c8618f3cbaddb5
 SHA512:
-  metadata.gz: b00b2af9d5e7a3b7251b5cb586546e9e54a75e7130c73f59fa44941104ee3310f8536cc882d54ed2bfb5124822955781c3492e670d76a05457ea68e35601d148
-  data.tar.gz: 4d480a2b5a08c3c5f9ac37c612092222f425bb64319cf8fe7c557627dee0a8ea650990a5b20624961071546d145ebdd8b8d6c57ea3ebe854dca642aa5f8716fc
+  metadata.gz: 9a987716021bc8e52f212fc44a357bb9e7c166240b690f691c7de40723ee6462a0dd5687a26d93c2d0e4663b1bbbc561d3e7c820d5e6371b048cc150e0e7e93c
+  data.tar.gz: 8cf010bd6a7f2c0cf9e6a3244dcfa812fd1196479487dd8fed62f52cdc17a3e827bd883f4a2b415c0058579168c96849bef5e9239239b923c1fc1edfa02eb3e6

data/.idea/RubyRoles.iml

@@ -11,6 +11,8 @@
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v8.0.2, ruby-3.2.2-p53) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activerecord (v8.0.2, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="activesupport (v8.0.2, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="base64 (v0.3.0, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="benchmark (v0.4.1, ruby-3.2.2-p53) [gem]" level="application" />
@@ -34,6 +36,7 @@
     <orderEntry type="library" scope="PROVIDED" name="reline (v0.6.2, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="securerandom (v0.4.1, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="stringio (v3.1.7, ruby-3.2.2-p53) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="timeout (v0.4.3, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.6, ruby-3.2.2-p53) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="uri (v1.0.3, ruby-3.2.2-p53) [gem]" level="application" />
   </component>

data/README.md

@@ -1,28 +1,95 @@
 # RubyRoles
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/RubyRoles`. To experiment with that code, run `bin/console` for an interactive prompt.
+Assign roles to users, accounts, user_accounts, and other models in a Ruby on Rails application.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add RubyRoles
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install RubyRoles
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class MyModel < ApplicationRecord
+  acts_as_ruby_roles
+  roles :sysadmin, :syssupport # , ... << # NOTE: Never remove entries, never reorder entries, always add to the end of the list only
+end
+```
+
+The default field used to store the roles is named "roles_mask", and it should be defined
+in the ActiveRecord migration like so:
+
+```ruby
+  def change
+    create_table :my_models do |t|
+      # ...
+      t.integer :roles_mask, default: 0, null: false
+      # ...
+    end
+  end
+```
+
+or, after the table was previous created:
+
+```ruby
+  def change
+    add_column :my_models, :roles_mask, :integer, default: 0, null: false
+  end
+```
+
+If you want to change the name of the field, simply specify the field name in the 
+acts_as_ruby_roles call in the model:
+
+```ruby
+class MyModel < ApplicationRecord
+  acts_as_ruby_roles field_name: :my_alternate_roles_field_name
+  roles :sysadmin, :syssupport, :viewonly # , ... << # NOTE: Never remove entries, never reorder entries, always add to the end of the list only
+end
+```
+
+Once you have this defined, you will have methods like the following available to you:
+
+```ruby
+user = User.first
+user.is_sysadmin?
+user.is_syssupport?
+user.is_viewonly?
+```
+
+To set the roles, use:
+
+```ruby
+user = User.first
+user.roles= [:sysadmin]
+user.roles= [:sysadmin,:syssupport]
+user.roles= [:sysadmin,:viewonly]
+user.save!
+```
+
+And all the roles can be read by:
+
+```ruby
+user = User.first
+user.roles => [:sysadmin,:syssupport,...]
+user.save!
+```
+
+In the database, roles are stored as integers.
+The values will return true or false depending on if the specified bit is set in the integer roles_mask for the model instance.
+The bits are defined sequentially in the "roles" call. So, in this example, :sysadmin
+is the 0th bit (integer  value 1), and :syssupport is the 1st bit (integer value 2), and :viewonly
+is the 2nd bit (integer value 4).
+
+An instance can be multiple roles by bit-wise ORing the values together.
 
 ## Development
 
@@ -32,4 +99,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/RubyRoles.
+Bug reports and pull requests are welcome on GitHub at https://github.com/leeatchison/RubyRoles.
+
+To build a new gem (authorized deployers only can do the push):
+
+```bash
+gem build RubyRoles.gemspec
+gem push RubyRoles-#.#.#.gem
+```

data/lib/RubyRoles.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "ruby_roles/version"
-require_relative "ruby_roles/concerns/roles_mgmt"
+require 'active_support'
+require 'active_record'
+require 'active_support/concern'
+require "ruby_roles/version"
+require "ruby_roles/concerns/roles_mgmt"
+require "ruby_roles/acts_as_ruby_roles/instance_methods"
+require "ruby_roles/acts_as_ruby_roles/class_methods"
 
 module RubyRoles
   class Error < StandardError; end
-  # Your code goes here...
+
+  class Railtie < Rails::Railtie
+    initializer 'RubyRoles.acts_as_ruby_roles' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.extend RubyRoles::ActsAsRubyRoles::ClassMethods
+      end
+    end
+  end
 end

data/lib/ruby_roles/acts_as_ruby_roles/class_methods.rb

@@ -0,0 +1,14 @@
+# lib/ruby_roles/acts_as_ruby_roles/class_methods.rb
+module RubyRoles
+  module ActsAsRubyRoles
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def acts_as_ruby_roles(options = {})
+        include RubyRoles::ActsAsRubyRoles::InstanceMethods
+        include RubyRoles::Concerns::RolesMgmt
+        # Initialize the class instance variables
+        @roles_field_name = options[:field_name] if options[:field_name].present?
+      end
+    end
+  end
+end

data/lib/ruby_roles/acts_as_ruby_roles/instance_methods.rb

@@ -0,0 +1,10 @@
+# lib/ruby_roles/acts_as_ruby_roles/instance_methods.rb
+module RubyRoles
+  module ActsAsRubyRoles
+    module InstanceMethods
+      # def ruby_roles
+      #   ...
+      # end
+    end
+  end
+end

data/lib/ruby_roles/concerns/roles_mgmt.rb

@@ -3,9 +3,9 @@ module RubyRoles
     module RolesMgmt
       extend ActiveSupport::Concern
 
-
       included do
         @role_list = []
+        @roles_field_name = :roles_mask
 
         #
         #
@@ -13,6 +13,14 @@ module RubyRoles
         #
         #
 
+        # Sets the roles field name
+        def self.roles_field name
+          @roles_field_name = name || :roles_mask
+        end
+        def self.get_roles_field
+          @roles_field_name
+        end
+
         # Sets the acceptable list of Roles
         def self.roles(*roles_list)
           @role_list = canonical_syms *roles_list
@@ -52,7 +60,7 @@ module RubyRoles
         end
         # Return list of human readable strings matching the roles
         def roles_human_readable
-          self.class.roles_bits_to_syms(self.roles_mask).map { |role|self.class.role_human_readable role }
+          self.class.roles_bits_to_syms(self.send(self.get_roles_field)).map { |role|self.class.role_human_readable role }
         end
 
 
@@ -89,39 +97,42 @@ module RubyRoles
       #
       #
 
+      def get_roles_field
+        self.class.get_roles_field
+      end
       # Set the valid set of roles for a given user
       def roles=(*roles)
-        self.roles_mask = self.class.roles_syms_to_bits(*roles)
+        self.send("#{ self.get_roles_field }=", self.class.roles_syms_to_bits(*roles) )
         self.roles
       end
 
       # Return the list of roles this user has
       def roles
-        self.class.roles_bits_to_syms(roles_mask)
+        self.class.roles_bits_to_syms(send(self.get_roles_field))
       end
 
       # Returns TRUE if user has this specific role
       def has_role?(role)
-        (self.roles_mask & self.class.roles_syms_to_bits(role)) !=0
+        (self.send(self.get_roles_field) & self.class.roles_syms_to_bits(role)) !=0
       end
 
       # Returns TRUE if user has any of the specified roles
       def has_any_roles?(*roles)
-        (self.roles_mask & self.class.roles_syms_to_bits(*roles)) !=0
+        (self.send(self.get_roles_field) & self.class.roles_syms_to_bits(*roles)) !=0
       end
 
       # Returns TRUE if user has all the specified roles
       def has_all_roles?(*roles)
         bits = self.class.roles_syms_to_bits(*roles)
-        (self.roles_mask & bits) == bits
+        (self.send(self.get_roles_field) & bits) == bits
       end
 
       def add_roles(*roles)
-        self.roles_mask = (self.roles_mask||0) | self.class.roles_syms_to_bits(*roles)
+        self.send("#{ self.get_roles_field }=", (self.send(self.get_roles_field)||0) | self.class.roles_syms_to_bits(*roles) )
         self.roles
       end
       def delete_roles(*roles)
-        self.roles_mask = (self.roles_mask||0) & ~self.class.roles_syms_to_bits(*roles)
+        self.send("#{ self.get_roles_field }=", (self.send(self.get_roles_field)||0) & ~self.class.roles_syms_to_bits(*roles) )
         self.roles
       end
     end

data/lib/ruby_roles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyRoles
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RubyRoles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lee Atchison
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Assign roles to users, accounts, user_accounts, and other models in a
   Ruby on Rails application.
 email:
@@ -42,6 +56,8 @@ files:
 - README.md
 - Rakefile
 - lib/RubyRoles.rb
+- lib/ruby_roles/acts_as_ruby_roles/class_methods.rb
+- lib/ruby_roles/acts_as_ruby_roles/instance_methods.rb
 - lib/ruby_roles/concerns/roles_mgmt.rb
 - lib/ruby_roles/version.rb
 - sig/RubyRoles.rbs