enum_fields 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc607b206f6498ca75d71fc583206138080cf768b849ddbe690789281a21921e
-  data.tar.gz: da78b379dd988c85daa54c5f29f9562ee03cf86a143eb360f22ccae14547d8a7
+  metadata.gz: d9d8952fea1c21107106addd2a2dc5f7d02348d2c0c3d99210d892c08e5b9b5b
+  data.tar.gz: 48ce6bb0b1b97a0fba166605469c0247143ea0f217ed2e5348c1757d124719d2
 SHA512:
-  metadata.gz: e0494cb5c0d8d4afc5ed527fd5c69fd67c1074f631ddaac73896efd7a7553c02f01e6069300356b7a7fc62f960c56e44d8860563ef0847d1bca6588834b423c2
-  data.tar.gz: 2b9fef8b1ee2af4fd06a2c6fd36c86655fd694502b291968c836452473c61b3ee33f23849a43e4404b87578c4f87451a4081d369ae0cfe7cedf9c8a70b9fa248
+  metadata.gz: cb50aeafc28d33cc7cb09a69ec946581b0bd9a6560c29f08511846dc88050ddbb69bcc12a0fc0841881d2b46c6ff2afd04cd4962ccb00dabf303eafe78ebdf74
+  data.tar.gz: cea3d418bbc42e7789c025f2400c67a6587898282360b8673aefa716e6d2331b0d224e8dffbdb91b385bda5165828804704525d0bc56ffb7ca326dca39714060

data/README.md

@@ -258,6 +258,114 @@ ticket.priority_metadata[:sla_hours]      # 72
 ticket.priority_metadata[:notify_manager] # false
 ```
 
+### Registry & Standalone Registration
+
+When `enum_field` is used in a model, definitions are automatically registered under a namespace derived from the model class name (e.g., `Campaign` becomes `campaign`).
+
+You can also register definitions directly, outside of models, using the `namespace` DSL:
+
+```ruby
+# config/initializers/enum_fields.rb
+EnumFields.namespace(:basic) do
+  enum_field :priority, {
+    low: {
+      value: "low",
+      label: "Low",
+    },
+    medium: {
+      value: "medium",
+      label: "Medium",
+    },
+    high: {
+      value: "high",
+      label: "High",
+    },
+  }
+
+  enum_field :status, {
+    active: {
+      value: "active",
+      label: "Active",
+    },
+    inactive: {
+      value: "inactive",
+      label: "Inactive",
+    },
+  }
+end
+```
+
+Access the raw registry:
+
+```ruby
+EnumFields.registry
+# => { "basic" => { "priority" => { ... }, "status" => { ... } }, "campaign" => { ... } }
+```
+
+### Catalog
+
+`EnumFields.catalog` returns all registered definitions with namespaces sorted alphabetically, each field's entries as an array of metadata hashes (keys stripped):
+
+```ruby
+EnumFields.catalog
+# => {
+#   "basic" => {
+#     "priority" => [
+#       {
+#         "value" => "low",
+#         "label" => "Low",
+#       },
+#       {
+#         "value" => "medium",
+#         "label" => "Medium",
+#       },
+#       {
+#         "value" => "high",
+#         "label" => "High",
+#       },
+#     ],
+#     "status" => [
+#       {
+#         "value" => "active",
+#         "label" => "Active",
+#       },
+#       {
+#         "value" => "inactive",
+#         "label" => "Inactive",
+#       },
+#     ],
+#   },
+#   "campaign" => {
+#     "stage" => [
+#       {
+#         "value" => "pending",
+#         "label" => "Pending",
+#         "icon" => "clock",
+#         "color" => "yellow",
+#       },
+#       {
+#         "value" => "processing",
+#         "label" => "Processing",
+#         "icon" => "cog",
+#         "color" => "blue",
+#       },
+#       {
+#         "value" => "shipped",
+#         "label" => "Shipped",
+#         "icon" => "truck",
+#         "color" => "green",
+#       },
+#       {
+#         "value" => "delivered",
+#         "label" => "Delivered",
+#         "icon" => "check",
+#         "color" => "green",
+#       },
+#     ],
+#   },
+# }
+```
+
 ## Development
 
 After checking out the repo, run:

data/lib/enum_fields/enum_field.rb

@@ -31,11 +31,11 @@ module EnumFields
     private
 
     def register!
-      EnumFields.register(
-        model_class: @model_class,
+      EnumFields.register({
+        namespace: @model_class.name&.underscore || @model_class.object_id.to_s,
         accessor: @accessor,
-        definition: @definition.data
-      )
+        definition: @definition.data,
+      })
     end
 
     def store_definition!

data/lib/enum_fields/namespace.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EnumFields
+  class Namespace
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    def enum_field(accessor, definition = {})
+      EnumFields.register({
+        namespace: @namespace,
+        accessor: accessor,
+        definition: definition,
+      })
+    end
+  end
+end

data/lib/enum_fields/registry.rb

@@ -7,10 +7,19 @@ module EnumFields
       super(@store)
     end
 
-    def register(model_class:, accessor:, definition:)
-      key = model_class.name&.underscore || model_class.object_id.to_s
-      @store[key] ||= {}.with_indifferent_access
-      @store[key][accessor] = definition
+    def register(args = {})
+      namespace = args.fetch(:namespace) { raise ArgumentError, "namespace is required" }
+      accessor = args.fetch(:accessor) { raise ArgumentError, "accessor is required" }
+      definition = args.fetch(:definition, {})
+
+      @store[namespace] ||= {}.with_indifferent_access
+      @store[namespace][accessor] = definition
+    end
+
+    def catalog
+      sort_by { |key, _| key.to_s }.to_h.transform_values do |fields|
+        fields.transform_values(&:values)
+      end
     end
   end
 end

data/lib/enum_fields/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EnumFields
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/enum_fields.rb

@@ -18,6 +18,7 @@ module EnumFields
 
   autoload :Definition
   autoload :EnumField
+  autoload :Namespace
   autoload :Registry
 
   def self.registry
@@ -28,6 +29,14 @@ module EnumFields
     registry.register(...)
   end
 
+  def self.namespace(name, &)
+    Namespace.new(name).instance_eval(&)
+  end
+
+  def self.catalog
+    registry.catalog
+  end
+
   def self.clear_registry!
     @registry = nil
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_fields
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kinnell Shah
@@ -68,6 +68,7 @@ files:
 - lib/enum_fields/definition.rb
 - lib/enum_fields/enum_field.rb
 - lib/enum_fields/errors.rb
+- lib/enum_fields/namespace.rb
 - lib/enum_fields/registry.rb
 - lib/enum_fields/version.rb
 homepage: https://github.com/kinnell/enum_fields