rich_enums 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6b109c5069cabe1da55839403d6f9efee399e46b5939be951a9604156911d2
-  data.tar.gz: 97582e336b09b8d5d2376bf73bc1b65522b9cd93f60daf17642bba5d9f02196a
+  metadata.gz: 23864e56ec97162d3609d1478dd9b42f51eec0a5b1b3ad6fefede47b9f629dfa
+  data.tar.gz: 69522c7f2420aa3135c213b159e871ad2958c20deaced2d02c6f839194369bdf
 SHA512:
-  metadata.gz: a1d592ab62bf202968448bcc4833a5b4abddd1b42a919834fcc730216a130fac8294bf997fe772422b1e36e0d9730c95abec7d008fd30f3a763c66356f7e3978
-  data.tar.gz: '049113830f6ab99a5870e7f41125f8544bdcca86cbf6947643059d1e265b957aa27de48d46bd49a8db9cee91d0040cd3777fb71e837dc082cca2ac199481e911'
+  metadata.gz: 7a88fcda980a44065ec3c23a9d1871ac800f57ebe2b045e58718cd26095507506c69aec0b97480c0f211f5e117eacab7ace002a4738410339e109c1a001f8f93
+  data.tar.gz: '00880f968a5f479663c987ce2c5991c4cc7f065bdda3701122dd73dcef0283cc93e7cb17521bcc1cbc2d36ca8c8c919ccc48805bca09be7ec2137f53659e602a'

data/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+env:
+  RUBY_VERSION: 3.2.2
+
+name: RichEnums CI
+on:
+  pull_request:
+    paths-ignore:
+      - .gitignore
+      - CHANGELOG.md
+      - CONTRIBUTING.md
+      - README.md
+  push:
+    paths-ignore:
+      - .gitignore
+      - CHANGELOG.md
+      - CONTRIBUTING.md
+      - README.md
+
+jobs:
+  rspec-test:
+    name: Run tests (ruby ${{ matrix.ruby }}, rails ${{ matrix.rails }})
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        include:
+          - ruby: '3.3'
+            rails: '7.2'
+          - ruby: '3.2'
+            rails: '7.1'
+          - ruby: '3.2'
+            rails: '7.0'
+          - ruby: '3.2'
+            rails: '6.1'
+          - ruby: '3.1'
+            rails: '6.1'
+    env:
+      BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Gem cache
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-use-ruby-${{ hashFiles('**/Gemfile.lock') }}
+      - name: Install dependencies
+        run: |
+          gem install bundler --version 2.3.25 --no-document
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake spec

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/Gemfile.lock

@@ -1,12 +1,29 @@
 PATH
   remote: .
   specs:
-    rich_enums (0.1.3)
+    rich_enums (0.1.5)
+      activerecord (>= 6.1, < 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.1.7.7)
+      activesupport (= 6.1.7.7)
+    activerecord (6.1.7.7)
+      activemodel (= 6.1.7.7)
+      activesupport (= 6.1.7.7)
+    activesupport (6.1.7.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.2.3)
     diff-lcs (1.5.0)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.8.6)
+    minitest (5.22.3)
     rake (12.3.3)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -21,6 +38,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    sqlite3 (1.7.3)
+      mini_portile2 (~> 2.8.0)
+    temping (4.1.1)
+      activerecord (>= 6.0, < 7.2)
+      activesupport (>= 6.0, < 7.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   ruby
@@ -29,6 +54,8 @@ DEPENDENCIES
   rake (~> 12.0)
   rich_enums!
   rspec (~> 3.0)
+  sqlite3 (~> 1.4)
+  temping (~> 4.1)
 
 BUNDLED WITH
    2.4.15

data/README.md

@@ -17,6 +17,7 @@ user.role_code # => 'ROLE001'
 user.role_for_database # => 1
 User.roles # => {"admin"=>1, "user"=>2}
 User.role_codes # => {"admin"=>"ROLE001", "user"=>"ROLE101"}
+User.role_alt_name_to_ids # => {"ROLE001"=>1, "ROLE101"=>2}
 
 ```
 
@@ -61,6 +62,7 @@ user.role_alt_name # => 'ROLE001'
 user.role_for_database # => 1
 User.roles # => {"admin"=>1, "user"=>2}
 User.role_alt_names # => {"admin"=>"ROLE001", "user"=>"ROLE101"}
+User.role_alt_name_to_ids # => {"ROLE001"=>1, "ROLE101"=>2}
 ExternalSystem.sync(user.external_id, role_code: user.role_alt_name)
 ```
 Any arguments other than 'alt' are forwarded to the default enum definition.

data/gemfiles/activerecord_6.1.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+# Specify your gem's dependencies in rich_enums.gemspec
+gemspec path: "../"

data/gemfiles/activerecord_7.0.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.0"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+# Specify your gem's dependencies in rich_enums.gemspec
+gemspec path: "../"

data/gemfiles/activerecord_7.1.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.1"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+# Specify your gem's dependencies in rich_enums.gemspec
+gemspec path: "../"

data/gemfiles/activerecord_7.1.gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: ..
+  specs:
+    rich_enums (0.1.5)
+      activerecord (>= 6.1, < 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    rake (12.3.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    temping (4.1.1)
+      activerecord (>= 6.0, < 7.2)
+      activesupport (>= 6.0, < 7.2)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-23
+  x86_64-darwin-21
+
+DEPENDENCIES
+  activerecord (~> 7.1)
+  rake (~> 12.0)
+  rich_enums!
+  rspec (~> 3.0)
+  sqlite3 (~> 1.4)
+  temping (~> 4.1)
+
+BUNDLED WITH
+   2.5.16

data/gemfiles/activerecord_7.2.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.2"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+# Specify your gem's dependencies in rich_enums.gemspec
+gemspec path: "../"

data/gemfiles/activerecord_7.2.gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: ..
+  specs:
+    rich_enums (0.1.5)
+      activerecord (>= 6.1, < 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.2.0)
+      activesupport (= 7.2.0)
+    activerecord (7.2.0)
+      activemodel (= 7.2.0)
+      activesupport (= 7.2.0)
+      timeout (>= 0.4.0)
+    activesupport (7.2.0)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    logger (1.6.0)
+    minitest (5.25.1)
+    rake (12.3.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    securerandom (0.3.1)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    temping (4.2.0)
+      activerecord (>= 6.0, < 7.3)
+      activesupport (>= 6.0, < 7.3)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-23
+  x86_64-darwin-21
+
+DEPENDENCIES
+  activerecord (~> 7.2)
+  rake (~> 12.0)
+  rich_enums!
+  rspec (~> 3.0)
+  sqlite3 (~> 1.4)
+  temping (~> 4.1)
+
+BUNDLED WITH
+   2.5.16

data/lib/rich_enums/version.rb

@@ -1,3 +1,3 @@
 module RichEnums
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/lib/rich_enums.rb

@@ -15,6 +15,8 @@ module RichEnums
       # and
       # 2. Class method "column1_names" that will map the enum values to the full String description
       # and can be accessed by ClassName.<column>_names which will return a hash like { symbol1: string1, symbol2: string2 ...}
+      # 3. Class method "column1_alt_name_to_ids" will map the enum values the string values and can
+      # be accessed by ClassName.<column>_alt_name_to_ids which will return a hash like { string1: value1, string2: value2 ...}
       # e.g.
       # class Enrollment
       #  include RichEnums
@@ -31,6 +33,9 @@ module RichEnums
       # Calling learner_payment_path_names returns
       # {"greenfig_online"=>"GreenFig Online", "partner"=>"Partner", "partner_online"=>"Partner Online",
       # "po_check"=>"P.O. / Check", "other"=>"Other"}
+      # iii. a class method called learner_payment_path_alt_name_to_ids
+      # Calling learner_payment_path_alt_name_to_ids returns
+      # {"GreenFig Online"=>10, "Partner"=>20, "Partner Online"=>30, "P.O. / Check"=>40, "Other"=>100}
       # 3. Instance method "column1_name" will return the String associated with the enum value
       # e = Enrollment.new
       # e.learner_payment_path_po_check! -> normal enum method to update the object with enum value
@@ -38,32 +43,52 @@ module RichEnums
       # e.learner_payment_path_name --> "P.O. / Check" -> our custom method that returns the string/description
       # TODO: explore if enum options in Array format instead of Hash format will need to be handled
 
-      raise 'rich_enum error' unless column_symbol_value_string_options.keys.count.positive?
+      unless column_symbol_value_string_options.is_a? Hash
+        raise RichEnums::Error
+      end
+      if column_symbol_value_string_options.keys.count.zero?
+        raise RichEnums::Error
+      end
 
       # extract out the column
       column = column_symbol_value_string_options.keys.first
 
       # extract the Enum options for the column which may be in standard enum hash format or our custom format
       symbol_value_string = column_symbol_value_string_options.delete(column)
+
+      raise RichEnums::Error unless symbol_value_string.is_a? Hash
+
       # at this point, only the enum options like _prefix etc. are present in the original argument
       options = column_symbol_value_string_options
       # we allow for an option called alt: to allow the users to tag the alternate mapping. Defaults to 'alt_name'
-      alt = options.delete(:alt) || 'alt_name'
+      alt = options.delete(:alt).to_s || 'alt_name'
+      alt_map_method = 'alt_name_to_ids'
 
       # create two hashes from the provided input - 1 to be used to define the enum and the other for the name map
-      split_hash = symbol_value_string.each_with_object({ for_enum: {}, for_display: {} }) do |(symbol, value_string), obj|
-        obj[:for_enum][symbol] = value_string.is_a?(Array) ? value_string.first : value_string
-        obj[:for_display][symbol.to_s] = value_string.is_a?(Array) ? value_string.second : symbol.to_s
+      split_hash = symbol_value_string.each_with_object({ for_enum: {}, for_display: {}, for_filter: {} }) do |(symbol, value_string), obj|
+        value = value_string.is_a?(Array) ? value_string.first : value_string
+        display_string = value_string.is_a?(Array) ? value_string.second : symbol.to_s
+
+        obj[:for_enum][symbol] = value
+        obj[:for_display][symbol.to_s] = display_string
+        obj[:for_filter][display_string] = value
       end
 
       # 1. Define the Enum
-      enum "#{column}": split_hash[:for_enum], **options
+      if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('7.2')
+        enum column, split_hash[:for_enum], **options
+      else
+        enum "#{column}": split_hash[:for_enum], **options
+      end
 
-      # 2. Define our custom class method
-      # - the data to be returned by our custom method is available os a class instance variable
+      # 2. Define our custom class methods
+      # - the data to be returned by our custom methods is available as a class instance variable
       instance_variable_set("@#{column}_#{alt.pluralize}", split_hash[:for_display])
-      # - the custom method is just a getter for the class instance variable
+      instance_variable_set("@#{column}_#{alt_map_method}", split_hash[:for_filter])
+
+      # - the custom methods are just a getter for the class instance variables
       define_singleton_method("#{column}_#{alt.pluralize}") { instance_variable_get("@#{column}_#{alt.pluralize}") }
+      define_singleton_method("#{column}_#{alt_map_method}") { instance_variable_get("@#{column}_#{alt_map_method}") }
 
       # 3. Define our custom instance method to show the String associated with the enum value
       define_method("#{column}_#{alt}") { self.class.send("#{column}_#{alt.pluralize}")[send(column.to_s)] }

data/rich_enums.gemspec

@@ -22,6 +22,9 @@ DESC
   spec.metadata['source_code_uri'] = 'https://github.com/betacraft/rich_enums'
   spec.metadata['changelog_uri'] = 'https://github.com/betacraft/rich_enums/README.md'
 
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'temping', '~> 4.1'
+  spec.add_runtime_dependency 'activerecord', '>= 6.1', '< 8.0'
   # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rich_enums
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - harunkumars
@@ -9,8 +9,56 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
-dependencies: []
+date: 2024-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description: "With Enums we are able to map a label to a value on the database. \nUse
   Rich Enum if you need to maintain an additional mapping at the point of enum definition,
   \nfor e.g. for presentation purposes or for mapping to a different value on a different
@@ -22,8 +70,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -33,6 +83,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/activerecord_6.1.gemfile
+- gemfiles/activerecord_7.0.gemfile
+- gemfiles/activerecord_7.1.gemfile
+- gemfiles/activerecord_7.1.gemfile.lock
+- gemfiles/activerecord_7.2.gemfile
+- gemfiles/activerecord_7.2.gemfile.lock
 - lib/rich_enums.rb
 - lib/rich_enums/version.rb
 - rich_enums.gemspec
@@ -59,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: When a simple name to value mapping is not enough