enummer 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3876abd550e7a6cc2a44853daff2124bcaf7d277c9202d017b93d1f71a9b3223
-  data.tar.gz: 0ce455ff89be35d0aa8324570d33a5f4039ae4b3fdd7d67b317192d7bad60c21
+  metadata.gz: 3c5046553ca9c053f2632d3bc1ca202a9c8da4b1d93fdca16c5d35606e774932
+  data.tar.gz: 06651c73f0aacb682d4a8dbb7b22387504eb2e6f6bc02d6de7dec88ef41605b7
 SHA512:
-  metadata.gz: b54ffad39435c24dcc57cf27914cdcf895be71333d2665ce553775fd39bb51e1ae6b986b25adb3dd52ff19e50319a402fa8e5ff994605fccca74ceb52fba1e63
-  data.tar.gz: 876a285e2de4701cef2fa2cf66e36d4d9ae560fb0951686392ad7b2fcbb7458a3ed4b9205742a55b55a3ecf4e39ed86e7816a16b07d1c9786a4cc43f4030913e
+  metadata.gz: e11ec3eabc2ede11eb342fc5022ef48c3905a338180ce925452d36baed39597a351fe183494e4ae18a3e63e2956e61a2cf7439d85111f08d8a3a5712d9cddf49
+  data.tar.gz: 7fa79d2c2d7743ab75c26c1754aa010894bfb99314869118e075f663ac33511b435c9200d360c16ddcb0fba55c21600a28c5b0076e75fb323dc6727dc9bb8690

data/README.md

@@ -33,6 +33,18 @@ Now set up enummer with the available values in your model:
 enummer permissions: %i[read write execute]
 ```
 
+Similar to `enum`, enummer can also be initialized with a hash, where the numeric index represents the position of the bit that maps to the flag:
+
+``` ruby
+enummer permissions: {
+  read: 0,
+  write: 1,
+  execute: 2
+}
+```
+
+This makes it easier to add/remove entries without worrying about migrating historical data.
+
 ### Scopes
 
 Scopes will now be provided for `<option>` and `not_<option>`.

data/lib/enummer/enummer_type.rb

@@ -4,17 +4,16 @@ require "active_record/type"
 
 module Enummer
   class EnummerType < ::ActiveRecord::Type::Value
-    # @param [Array<Symbol>] value_names list of all possible values for this type
-    def initialize(value_names:)
-      @value_names = value_names
-      @bit_pairs = determine_bit_pairs(value_names)
+    # @param [Array<Symbol>] values hash with bit-value pairs for all possible values for this type
+    def initialize(values:)
+      @values = values
     end
 
     # @return Symbol Representation of this type
     # @example
     #   :enummer[read|write|execute]
     def type
-      "enummer[#{@value_names.join("|")}]".to_sym
+      :"enummer[#{@values.keys.join("|")}]"
     end
 
     # @param [Symbol|Array<Symbol>] value Current value represented as one or more symbols
@@ -22,7 +21,7 @@ module Enummer
     def serialize(value)
       return unless value
 
-      Array.wrap(value).sum { |value_name| @bit_pairs.fetch(value_name.to_sym, 0) }
+      Array.wrap(value).sum { |value_name| @values.fetch(value_name, 0) }
     end
 
     # @param [Numeric] value Numeric representation of values
@@ -31,19 +30,17 @@ module Enummer
       return [] unless value
       return [] if value.to_i.zero?
 
-      @bit_pairs.each_with_object([]) do |(pair_name, pair_value), value_names|
+      @values.each_with_object([]) do |(pair_name, pair_value), value_names|
         next if (value & pair_value).zero?
 
         value_names << pair_name
       end
     end
 
-    private
-
-    def determine_bit_pairs(value_names)
-      value_names.map.with_index do |name, shift|
-        [name, 1 << shift]
-      end.to_h
+    # @param [Array<Symbol>] value Current value represented as one or more symbols or strings
+    # @return [Array<Symbol>] Current value represented as symbols
+    def cast(value)
+      Array.wrap(value).map(&:to_sym)
     end
   end
 end

data/lib/enummer/extension.rb

@@ -13,10 +13,11 @@ module Enummer
       options[:_suffix] = values.delete(:_suffix)
 
       name, values = values.first
+      values = _enummer_determine_bit_pairs(values)
 
-      attribute(name, :enummer, value_names: values)
+      attribute(name, :enummer, values: values)
 
-      singleton_class.__send__(:define_method, name) { values }
+      singleton_class.__send__(:define_method, name) { values.keys }
 
       _enummer_build_with_scope(name, values)
       _enummer_build_values(name, values, options)
@@ -24,20 +25,20 @@ module Enummer
 
     private
 
-    def _enummer_build_with_scope(attribute_name, value_names)
+    def _enummer_build_with_scope(attribute_name, values)
       scope "with_#{attribute_name}", lambda { |desired|
-        expected = Array.wrap(desired).sum(0) { |value| 1 << value_names.index(value) }
+        expected = Array.wrap(desired).sum(0) { |value| values[value.to_sym] }
 
         where("#{attribute_name} & :expected = :expected", expected: expected)
       }
     end
 
-    def _enummer_build_values(attribute_name, value_names, options)
-      value_names.each_with_index do |name, i|
+    def _enummer_build_values(attribute_name, values, options)
+      values.each do |name, bit|
         method_name = _enummer_method_name(attribute_name, name, options)
 
-        define_method("#{method_name}?") { self[attribute_name].include?(name) }
-        define_method("#{method_name}=") do |new_value|
+        define_method(:"#{method_name}?") { self[attribute_name].include?(name) }
+        define_method(:"#{method_name}=") do |new_value|
           if ActiveModel::Type::Boolean.new.cast(new_value)
             self[attribute_name] += [name]
           else
@@ -45,12 +46,10 @@ module Enummer
           end
           self[attribute_name].uniq!
         end
-        define_method("#{method_name}!") do
+        define_method(:"#{method_name}!") do
           update(attribute_name => self[attribute_name] + [name])
         end
 
-        bit = 1 << i
-
         scope method_name, -> { where("#{attribute_name} & :bit = :bit", bit: bit) }
         scope "not_#{method_name}", -> { where("#{attribute_name} & :bit != :bit", bit: bit) }
       end
@@ -69,5 +68,12 @@ module Enummer
 
       value
     end
+
+    def _enummer_determine_bit_pairs(values)
+      values = values.map.with_index { |value, i| [value, i] }.to_h if values.is_a?(Array)
+      values.transform_values do |shift|
+        1 << shift
+      end
+    end
   end
 end

data/lib/enummer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enummer
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/lib/tasks/enummer_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :enummer do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enummer
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jamie Schembri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,14 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Multi-value enums for Rails.