nummy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9edb3b21dc12078ceec611949ebf6deb80ed4a69309aaba8a2b01c233025e66
-  data.tar.gz: e066bb5910d68efdca902e242a1cd9269aecc48b9a77bbf9c246516dc995eb8d
+  metadata.gz: 1eec6bebfcfcfb1a55059d7a9b86bf2f2639a1db72ad9b69294ea3e26bb28d88
+  data.tar.gz: 17d3335c6b7bdfeb12233cf1bca4f95ac11ed608930e0a9fd46a0c92b63ca2fa
 SHA512:
-  metadata.gz: 401f6427a1c27596f411cf11c6686a9164aabe06980c6db046887848424f01245921d45f15d01b4938d26a5ccb274e08003b51810073e1ec3cd7e71c0e2f284d
-  data.tar.gz: 5e3c46a452c2967bc52c1ddf0df5993545af18801a3bbbaead6663fa91e0aa9d61fa87919b7c4c334791a0c7162867d023e4e346200c9d407029fb4e1497da53
+  metadata.gz: df883a0535f1b3e2ccf7015d7159d6fd9ba08f6b277324fda3ddf90222e95514f81e792f28fe6994bc1a59f1917bfe0e9cb40fa53b5ab5459172f5d080cd0a20
+  data.tar.gz: 105f1fbf20d88aa5168de81056c072498b7af2d994fbbc203b5317095fba49f6b9d86bc83e9254468c6b49dd4e7338aa0f0d104bbfb21237a3cb5f4af2c1c393

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-01-04
+
+- Add `Nummy::Enum.to_attribute`, which converts the enum to a hash that can be passed as the values of an `ActiveRecord::Enum`:
+  
+  ```ruby
+  class Conversation < ActiveRecord::Base
+    class Status < Nummy::Enum
+      ACTIVE = auto
+      ARCHIVED = auto
+    end
+
+    enum :status, Status.to_attribute
+  end
+  ```
+
+  > [!IMPORTANT]
+  > The conversion requires that `ActiveRecord::Inflector` is defined, but `nummy` does not depend on `ActiveRecord` directly. If you are using `nummy` in a non-Rails environment, you will need to require `ActiveRecord::Inflector` yourself.
+
 ## [0.1.0] - 2024-01-04
 
 - Initial release

data/README.md

@@ -14,13 +14,13 @@ constants in a module, and iterating over the members of data classes.
 Install the gem and add to the application's Gemfile by executing:
 
 ```console
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add nummy
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```console
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install nummy
 ```
 
 ## Usage
@@ -146,6 +146,55 @@ end
 > [!TIP]
 > `Nummy::Enum` extends `Enumerable` and iterates over the _values_ of the enum, so you have access to things like `.include?(value)`, `.any?`, and `.find`.
 
+#### Rails / ActiveRecord integration
+
+> [!IMPORTANT]
+> This integration requires `ActiveSupport::Inflector` to be defined.
+
+To use nummy enums as ActiveRecord enums, you can use the `.to_attribute` method:
+
+```ruby
+class Conversation < ActiveRecord::Base
+  class Status < Nummy::Enum
+    ACTIVE = auto
+    ARCHIVED = auto
+  end
+
+  enum :status, Status.to_attribute
+end
+```
+
+This allows you to use all of the Rails magic for enums, like scopes and boolean helpers, while also being able to refer to values in a safer way than hash lookups.
+
+That is, these two are the same:
+
+```ruby
+Conversation.statuses[:active] # => 0
+Conversation::Status::ACTIVE   # => 0
+```
+
+But these are not:
+
+```ruby
+Conversation.statuses[:acitve]
+# => nil
+
+Conversation::Status::ACITVE   # => nil
+# =>
+#  uninitialized constant Conversation::Status::ACITVE (NameError)
+#  Did you mean?  Conversation::Status::ACTIVE
+```
+
+You can get similar behavior using `#fetch`:
+
+```ruby
+Conversation.statuses.fetch(:acitve)
+# => key not found: :acitve (KeyError)
+#    Did you mean?  :active
+```
+
+But that still misses out on some of the DX benefits of using constants, like improved support for things like autocompletion, documentation, and navigation ("Go To Definition") in editors.
+
 ### `Nummy::MemberEnumerable`
 
 `Nummy::MemberEnumerable` is a module that includes `Enumerable` and makes it possible to iterate over any class or module that responds to `members`.

data/lib/nummy/enum.rb

@@ -354,6 +354,32 @@ module Nummy
       # Alias to support splatting enums into keyword args.
       alias to_hash to_h
 
+      # Converts the enum to a +Hash+ with snake_case keys.
+      #
+      # This is intended to be used with +ActiveRecord::Enum+, but can be used
+      # with any library that supports defining enums using a +Hash+ and expects
+      # to have lowercase keys.
+      #
+      # @note
+      #   This method _equires +ActiveSupport::Inflector+ to be defined.
+      #
+      # @return [Hash{Symbol => Integer}]
+      #
+      # @example
+      #   class Conversation < ActiveRecord::Base
+      #     class Status < Nummy::Enum
+      #       ACTIVE = auto
+      #       ARCHIVED = auto
+      #     end
+      #
+      #     enum :status, Status.to_attribute
+      #   end
+      def to_attribute
+        to_h.transform_keys! do |key|
+          ::ActiveSupport::Inflector.underscore(key).to_sym
+        end
+      end
+
       # Returns a string representation of +self+.
       #
       # The string will contain the name-value pairs of the constants in +self+.

data/lib/nummy/version.rb

@@ -2,5 +2,5 @@
 
 module Nummy
   # The current version of the gem.
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nummy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Benjamin Chauvette