rich_enums 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46447b40cc9c43e26f1543e974579f45b0df6df7cf8f8266228d6938668a8524
-  data.tar.gz: bb0ec8a360ed8b6ef49b038fb56bace8b3511a70146667d9a12d426dedba9b10
+  metadata.gz: 15ff8f1970f8dfcea0ea54020b43e39e9a2107978e1cc432e38797698e8b5262
+  data.tar.gz: d1f1cfd235a02224c8b92d9847daf799512ea9c34d5cf847e128d6a9473b8322
 SHA512:
-  metadata.gz: 8680649383f45fedc1b388500b8f5c06dfb34e6450b16e20583d24d6a774b68ddf177eb18025dbb00ccbc4d8c6f297214e183bad7535dc01655e02a1b26297a2
-  data.tar.gz: 7c8e3743e48bd6bf09c76b4bcf4f81c8927ce6070f86e02a69d8122de5af7b783c1cd6d5f51f1c4900a1407f2031432441d8727e2a83ebb67dfe5fdc11e44c4e
+  metadata.gz: 61f4cd02dab095f81082e66daafb43709edb159a7dbbd906362e5d31458fef82064855b8ebe1e32eed8143818b0cf96974aa571012d53e9fac80539b3b6653e8
+  data.tar.gz: 50305e6f7e0377be49cb7289dd52aaf0c00263bf5d45f472a8d4e86b9f67789613740c2359d411ae6d6f51932530fd6049bd408a2082353af9b1e18311ca6372

data/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+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.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/.gitignore

@@ -10,4 +10,6 @@
 # rspec failure tracking
 .rspec_status
 .idea
-/*.gem
+/*.gem
+.byebug_history
+/*.db

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/Gemfile.lock

@@ -1,12 +1,29 @@
 PATH
   remote: .
   specs:
-    rich_enums (0.1.0)
+    rich_enums (0.1.4)
+      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.1.4
+   2.4.15

data/README.md

@@ -1,8 +1,24 @@
 # RichEnums
 
-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/rich_enums`. To experiment with that code, run `bin/console` for an interactive prompt.
+With Enums we are able to map a label to a value on the database.
+Use Rich Enum if you need to maintain an additional mapping at the point of enum definition,
+for e.g. for presentation purposes or for mapping to a different value on a different system.
 
-TODO: Delete this and the text above, and describe your gem
+e.g. rich enum definition
+```ruby
+class User < ApplicationRecord
+  # enum role: { admin: 1, user: 2 } # default enum definition
+  rich_enum role: { admin: [1, 'ROLE001'], user: [2, 'ROLE101'] }, alt: 'code'
+end
+
+user = User.new(role: :admin)
+user.role # => 'admin'
+user.role_code # => 'ROLE001'
+user.role_for_database # => 1
+User.roles # => {"admin"=>1, "user"=>2}
+User.role_codes # => {"admin"=>"ROLE001", "user"=>"ROLE101"}
+
+```
 
 ## Installation
 
@@ -16,13 +32,45 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or simply run 
+
+    $ bundle add rich_enums
+to add to Gemfile and run bundle install in one go.
 
-    $ gem install rich_enums
 
 ## Usage
+As shown in the example above, the rich_enum definition is similar to the default enum definition.
+It simply augments the enum definition with an additional mapping.
+
+The additional mapping can be named with the `alt` option. It defaults to 'alt_name' if unspecificed.
+This comes in handy when you need to map to a different value on a different system.
+
+1. Using rich_enum to define your enums provides you with an instance method (attribute name with a suffix specified with the alt property - defaults to _alt_name) to access the alternate value from the additional mapping.
+2. It also provides you with a class method(attribute name with a plural suffix derived from the alt option - defaults to _alt_names) to access the additional mapping.
 
-TODO: Write usage instructions here
+
+```ruby
+class User < ApplicationRecord
+  # enum role: { admin: 1, user: 2 } # default enum definition
+  rich_enum role: { admin: [1, 'ROLE001'], user: [2, 'ROLE101'] } # if alt is not specified, it defaults to 'alt_name'
+end
+
+user = User.new(role: :admin)
+user.role # => 'admin'
+user.role_alt_name # => 'ROLE001'
+user.role_for_database # => 1
+User.roles # => {"admin"=>1, "user"=>2}
+User.role_alt_names # => {"admin"=>"ROLE001", "user"=>"ROLE101"}
+ExternalSystem.sync(user.external_id, role_code: user.role_alt_name)
+```
+Any arguments other than 'alt' are forwarded to the default enum definition.
+For e.g. in this case _prefix: true is forwarded to the default enum definition.
+```ruby
+rich_enum payment_type: {
+    upfront: [10, 'Full payment'],
+    installment: [20, 'Pay in parts'],
+}, _prefix: true
+```
 
 ## Development
 
@@ -32,7 +80,7 @@ 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]/rich_enums. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rich_enums/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/betacraft/rich_enums. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/betacraft/rich_enums/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

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/lib/rich_enums/version.rb

@@ -1,3 +1,3 @@
 module RichEnums
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/lib/rich_enums.rb

@@ -9,7 +9,7 @@ module RichEnums
 
   module ClassMethods
     def rich_enum(column_symbol_value_string_options)
-      # rich_enum  column1: { symbol1: [value1, string1], ... }, **options
+      # rich_enum  column1: { symbol1: [value1, string1], ... }, alt: 'name', **options
       # will transform to
       # 1. enum column1: { symbol1: value1, ...}, to define the enums along with any options provided
       # and
@@ -17,7 +17,7 @@ module RichEnums
       # and can be accessed by ClassName.<column>_names which will return a hash like { symbol1: string1, symbol2: string2 ...}
       # e.g.
       # class Enrollment
-      #  include EnumMappable
+      #  include RichEnums
       #  rich_enum learner_payment_path: {
       #     greenfig_online: [10, 'GreenFig Online'],
       #     partner: [20, 'Partner'],
@@ -38,22 +38,30 @@ 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'
 
       # 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
+        obj[:for_enum][symbol] = value_string.is_a?(Array) ? value_string[0] : value_string
+        obj[:for_display][symbol.to_s] = value_string.is_a?(Array) ? value_string[1] : symbol.to_s
       end
 
       # 1. Define the Enum

data/rich_enums.gemspec

@@ -6,18 +6,25 @@ Gem::Specification.new do |spec|
   spec.authors       = %w[harunkumars rtdp]
   spec.email         = %w[harun@betacraft.io rtdp@betacraft.io]
 
-  spec.summary       = 'Provides a rich_enum class method to include String descriptions during Enum definitions'
-  # spec.description   = 'TODO: Write a longer description or delete this line.'
+  spec.summary       = 'When a simple name to value mapping is not enough'
+  spec.description   = <<-DESC
+With Enums we are able to map a label to a value on the database. 
+Use Rich Enum if you need to maintain an additional mapping at the point of enum definition, 
+for e.g. for presentation purposes or for mapping to a different value on a different system.
+DESC
   spec.homepage      = 'https://github.com/betacraft/rich_enums'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
   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,17 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: rich_enums
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - harunkumars
 - rtdp
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
-dependencies: []
-description: 
+date: 2024-04-29 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
+  system.\n"
 email:
 - harun@betacraft.io
 - rtdp@betacraft.io
@@ -19,8 +70,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -30,6 +83,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/activerecord_6.1.gemfile
+- gemfiles/activerecord_7.0.gemfile
+- gemfiles/activerecord_7.1.gemfile
 - lib/rich_enums.rb
 - lib/rich_enums/version.rb
 - rich_enums.gemspec
@@ -37,10 +93,11 @@ homepage: https://github.com/betacraft/rich_enums
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/betacraft/rich_enums
   source_code_uri: https://github.com/betacraft/rich_enums
   changelog_uri: https://github.com/betacraft/rich_enums/README.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -55,9 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.5.0.dev
+signing_key:
 specification_version: 4
-summary: Provides a rich_enum class method to include String descriptions during Enum
-  definitions
+summary: When a simple name to value mapping is not enough
 test_files: []