masked_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b97ca1bc7469412e6d7a070de7849835b70ceb26043ec583a8243c2f4aef82f
+  data.tar.gz: 7baaef798a14dffd01b8bcb779db3fe5fcbaf9f8304f979c1b3ceb800f431efa
+SHA512:
+  metadata.gz: e1f91990606ed4e137c5a5329644cefd4101a514e2aeb5263a1f1aa1ab3007e78c101bbf2f800c5f7584e64c6dc62f26406af16f66f794b953a43cbb3ed5f88a
+  data.tar.gz: 2e1da713675c6ab35745fbfe7334cfbe1da1993b47b35e39fef7d889857e0835855c251b35ee090babfb212b2db39879839a4414d3ba74b51495616705de9a48

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 candland
+
+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,109 @@
+# MaskedAttribute
+
+Add methods for working with a masked attribute in models.
+
+## Usage
+
+### Add field to database
+
+Create the backing field. It should be appended with `_mask`. To add `roles` to `User`, the field would be `role_mask`.
+The field must be an `integer` and should be `default: 0, null: false`.
+
+Example migration:
+
+```bash
+bin/rails generate migration add_roles_to_user role_mask:integer
+```
+
+Modify the migration to set the default to 0, and disallow NULLs.
+
+```ruby
+class AddRolesToUsers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :users, :role_mask, :integer, null: false, default: 0
+  end
+end
+```
+
+```bash
+bin/rails db:migrate
+```
+
+### Include in your model
+
+```ruby
+class User
+  include MaskedAttribute
+
+  masked_attribute :roles, %i[admin sysadmin]
+end
+```
+
+The `masked_attribute` takes two arguments, `attribute_name` and `masks`.
+
+`attribute_name` is the name for the masked attribute. For example
+a name of `:roles` will create methods for the role_mask backing attribute.
+
+`masks` is an array of symbols for the mask values. Order matters. You can change the values
+of the masks, but if you change the order, you'll need to migrate existing data.
+
+`masked_attribute` will add methods, scopes, and contants to `User` for working with `roles`.
+
+```ruby
+User::ROLES = masks
+User::INDEXED_ROLES = {mask_value => mask, ...}
+
+# Add attr_writer for the ATTRIBUTE_NAME. This should always be called with the full array of roles.
+def roles= [array_of_masks]
+
+# Add attr_reader for the ATTRIBUTE_NAME
+def roles -> [array_of_masks]
+
+# Add a scope with_ATTRIBUTE_NAME, which returns records that match ALL given masks
+scope with_roles(*masks)
+
+# Add a scope with_any_ATTRIBUTE_NAME, which returns records that match ANY given masks
+scope with_any_roles(*masks)
+
+# Add scopes for each MASK, to return records with the MASK in the name of the method
+scope admins()
+scope sysadmins()
+
+# Add MASK? methods. Returns true if the mask is set
+def admin?
+def sysadmin?
+
+# Add add_MASK! methods. Updates the backing field with the MASK value in the name.
+def add_admin!
+def add_sysadmin!
+
+# Add remove_MASK! methods. Updates the backing field with the MASK value in the name.
+def remove_admin!
+def remove_sysadmin!
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "masked_attribute"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install masked_attribute
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/masked_attribute/railtie.rb

@@ -0,0 +1,4 @@
+module MaskedAttribute
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/masked_attribute/version.rb

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

data/lib/masked_attribute.rb

@@ -0,0 +1,106 @@
+require "masked_attribute/version"
+require "masked_attribute/railtie"
+
+module MaskedAttribute
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def mask_from values, check_values
+      (check_values & values).map { |r| 2**values.index(r) }.inject(0, :+)
+    end
+
+    private
+
+    # Add methods for working with a masked attribute in the model
+    #
+    # attribute_name = the name for the masked attribute. For example
+    #   a name of :roles will create methods for the role_mask backing attribute
+    #
+    # masks = an array of symbols for the mask values. Order matters.
+    #   %i[admin sysadmin]
+    #
+    # With those examples the follow methods & scopes will be created:
+    #
+    # scope with_roles(*masks)
+    # scope with_any_roles(*masks)
+    #
+    # scope admins()
+    # scope sysadmins()
+    #
+    # def admin?
+    # def sysadmin?
+    #
+    # def add_admin!
+    # def remove_admin!
+    #
+    # def add_sysadmin!
+    # def remove_sysadmin!
+    #
+    # def roles=(array of masks)
+    # def roles -> array of masks
+    #
+    # Class::ROLES = masks
+    # Class::INDEXED_ROLES = {mask_value => mask, ...}
+    def masked_attribute attribute_name, masks
+      attribute_name = attribute_name.to_s
+      mask_attribute_name = "#{attribute_name.singularize}_mask"
+      masks_const_name = attribute_name.upcase
+      masks = masks.freeze
+
+      indexed_masks = masks.map { |v| [2**masks.index(v), v] }.to_h.freeze
+
+      const_set masks_const_name, masks
+      const_set "INDEXED_#{masks_const_name}", indexed_masks
+
+      # Add a scope with_ATTRIBUTE_NAME, which returns records that match ALL given masks
+      self.class.define_method("with_#{attribute_name}") do |*values|
+        ok_mask = mask_from(masks, values)
+        where("role_mask & ? = ?", ok_mask, ok_mask)
+      end
+
+      # Add a scope with_any_ATTRIBUTE_NAME, which returns records that match ANY given masks
+      self.class.define_method("with_any_#{attribute_name}") do |*values|
+        ok_mask = mask_from(masks, values)
+        where("role_mask & ? != 0", ok_mask)
+      end
+
+      masks.each do |value|
+        value_int = 2**masks.index(value)
+
+        # Add MASK? method. Returns true if the mask is set
+        define_method("#{value}?") do
+          has = __send__(mask_attribute_name)
+          has & value_int > 0
+        end
+
+        # Add add_MASK! method. Updates the MASKS_mask with the MASK in the name
+        define_method("add_#{value}!") do
+          has = __send__(mask_attribute_name)
+          update!("#{mask_attribute_name}": (has | value_int))
+        end
+
+        # Add remove_MASK! method. Updates the MASKS_mask without the MASK in the name
+        define_method("remove_#{value}!") do
+          has = __send__(mask_attribute_name)
+          update!("#{mask_attribute_name}": (has & ~value_int))
+        end
+
+        # Add scope MASK, to return records with the MASK in the name
+        scope value.to_s.pluralize, -> { with_roles(value) }
+      end
+
+      # Add attr_writer for the attribute_name
+      define_method("#{attribute_name}=") do |value|
+        value = Array.wrap(value).map(&:to_sym)
+        __send__("#{mask_attribute_name}=", self.class.mask_from(masks, value))
+      end
+
+      # Add attr_reader for the attribute_name
+      define_method(attribute_name.to_s) do
+        masks.reject do |r|
+          ((__send__(mask_attribute_name).to_i || 0) & 2**masks.index(r)).zero?
+        end
+      end
+    end
+  end
+end

data/lib/tasks/masked_attribute_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :masked_attribute do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: masked_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- candland
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.2
+description: Adds methods for a bit masked field
+email:
+- candland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/masked_attribute.rb
+- lib/masked_attribute/railtie.rb
+- lib/masked_attribute/version.rb
+- lib/tasks/masked_attribute_tasks.rake
+homepage: https://candland.net/masked_attribute
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://candland.net/masked_attribute
+  source_code_uri: https://github.com/candland/masked_attribute
+  changelog_uri: https://github.com/candland/masked_attribute/CHANGES.md
+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: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Adds methods for a bit masked field
+test_files: []