rich_enums 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46447b40cc9c43e26f1543e974579f45b0df6df7cf8f8266228d6938668a8524
-  data.tar.gz: bb0ec8a360ed8b6ef49b038fb56bace8b3511a70146667d9a12d426dedba9b10
+  metadata.gz: 1f6b109c5069cabe1da55839403d6f9efee399e46b5939be951a9604156911d2
+  data.tar.gz: 97582e336b09b8d5d2376bf73bc1b65522b9cd93f60daf17642bba5d9f02196a
 SHA512:
-  metadata.gz: 8680649383f45fedc1b388500b8f5c06dfb34e6450b16e20583d24d6a774b68ddf177eb18025dbb00ccbc4d8c6f297214e183bad7535dc01655e02a1b26297a2
-  data.tar.gz: 7c8e3743e48bd6bf09c76b4bcf4f81c8927ce6070f86e02a69d8122de5af7b783c1cd6d5f51f1c4900a1407f2031432441d8727e2a83ebb67dfe5fdc11e44c4e
+  metadata.gz: a1d592ab62bf202968448bcc4833a5b4abddd1b42a919834fcc730216a130fac8294bf997fe772422b1e36e0d9730c95abec7d008fd30f3a763c66356f7e3978
+  data.tar.gz: '049113830f6ab99a5870e7f41125f8544bdcca86cbf6947643059d1e265b957aa27de48d46bd49a8db9cee91d0040cd3777fb71e837dc082cca2ac199481e911'

data/.gitignore

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rich_enums (0.1.0)
+    rich_enums (0.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -31,4 +31,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 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/lib/rich_enums/version.rb

@@ -1,3 +1,3 @@
 module RichEnums
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 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'],

data/rich_enums.gemspec

@@ -6,13 +6,17 @@ 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'

metadata

@@ -1,17 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: rich_enums
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - harunkumars
 - rtdp
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies: []
-description: 
+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
@@ -37,10 +40,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 +59,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: []