active_module 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80aaae788c312746df8dcaba68bfda8f881fc2c22d7642b509546bdab198bc0
-  data.tar.gz: 84674ab108e9b639327f7531f678a12b8dbf31ab25c01088f8839458b71d1cac
+  metadata.gz: 743570de05b5e510d10408fe3b95eaab2789e4432311538bda978bf52d893355
+  data.tar.gz: 72057e516212b80260b45fe9b2bd5c97530fc5f6ceaab42c0578d48581bf3b50
 SHA512:
-  metadata.gz: a89843336735a230e13691069fd3a2e919403a140712476bb5176862fd0bb72df6ff069fa9d3ca9635c2dadc1a602863122a2ec384f8414754a560da02561698
-  data.tar.gz: f7b03c281aafba2a1bf187f7ed9b049c9dd3798bafdf411c3710964e2cbc087dedd72937c897925bdcbb9f4887e625f5d893b69640df853f738324b12b955e7d
+  metadata.gz: 7c4ee2bc7ae24fb246f9744f161088222af6c02d85c99d62e39f196257b90d24abcea21de0217ea578d8755acfd61bf4d078d9f7290f3cc0cc28110bca893cd9
+  data.tar.gz: '02582a7cbe08a616e35828e0537bacf41714cd4cfae0d5272188fb9feb8aa970c44670391b1cef6926781ebe53f28ce966a0eeda46d32e2149be22370cf19daf'

data/README.md

@@ -17,7 +17,7 @@ This is a very generic mechanism that enables many possible utilizations, for in
 - **Static configuration management**
 - **Rich Java/C#-like enums**
 
-You can find examples of these in [Usage -> Examples :](#Examples) 
+You can find examples of these in [Usage -> Examples](#Examples).
 
 ## TL;DR
 
@@ -54,8 +54,8 @@ object.module_field == Nested::Module
 module MyNameSpace
   using ActiveModule::Comparison
 
-  object.module_field =~ :Module1
-  object.module_field =~ "Module1"
+  object.module_field =~ :Module
+  object.module_field =~ "Module"
 end
 ```
 
@@ -64,7 +64,7 @@ end
 Add to your gemfile - and if you are using rails - that's all you need:
 
 ```ruby
-gem 'active_module', "~> 0.1"
+gem 'active_module', "~> 0.2"
 ```
 
 If you are not using rails, just issue this command after loading active record
@@ -86,7 +86,7 @@ ActiveRecord::Type.register(:active_module, ActiveModule::Base)
 Add a string field to the table you want to hold a module attribute in your migrations
 ```ruby
 create_table :my_ar_objects do |t|
-  t.string :module_field
+  t.string :module_field, index: true
 end
 ```
 
@@ -108,6 +108,16 @@ class MyARObject < ActiveRecord::Base
             possible_modules: [MyModule1, MyModule2, MyClass, MyClass::MyModule1]
 end
 ```
+
+Optionally, you can specify how to map your modules into the database 
+(the default is the module's fully qualified name):
+```ruby
+attribute :module_field, 
+          :active_module, 
+          possible_modules: [MyModule1, MyModule2, MyClass, MyClass::MyModule1]
+          mapping: {MyModule1 => "this is the db representation of module1"}
+```
+
 And this is it! Easy!<br>
 
 ### Assigning and querying module attributes
@@ -232,6 +242,39 @@ MyARObject.create!(module_field: :Strategy1).run_strategy! #=> "strategy1 called
 MyARObject.create!(module_field: :Strategy2).run_strategy! #=> "strategy2 called"
 ```
 
+You can later easily promote these modules to classes if you need instance variables:
+
+```ruby
+class MyARObject < ActiveRecord::Base
+  class Strategy1
+    def self.call
+      self.new.call
+    end
+
+    def call
+      "strategy1 called"
+    end
+  end
+
+  module Strategy2
+    def self.call
+      "strategy2 called"
+    end
+  end
+
+  attribute :strategy, 
+            :active_module, 
+            possible_modules: [Strategy1, Strategy2]
+
+  def run_strategy!(some_args)
+    strategy.call(some_args, other_args)
+  end
+end
+
+MyARObject.create!(module_field: :Strategy1).run_strategy! #=> "strategy1 called"
+MyARObject.create!(module_field: :Strategy2).run_strategy! #=> "strategy2 called"
+```
+
 
 ### Rapid prototyping static domain objects
 

data/lib/active_module/base.rb

@@ -5,11 +5,35 @@ require_relative "modules_index"
 
 module ActiveModule
   class Base < ActiveModel::Type::Value
-    def initialize(possible_modules:)
-      @possible_modules = possible_modules
+    attr_reader :possible_modules, :mapping
+
+    def initialize(possible_modules_or_mapping = nil,
+                   possible_modules: [],
+                   mapping: {})
+      @possible_modules =
+        if possible_modules_or_mapping.is_a?(Array)
+          possible_modules_or_mapping + possible_modules
+        else
+          possible_modules
+        end
+      mapping_arg = if possible_modules_or_mapping.is_a?(Hash)
+                      possible_modules_or_mapping.merge(mapping)
+                    else
+                      mapping
+                    end
+      @mapping =
+        @possible_modules.each_with_object(mapping_arg.dup) do |mod, result|
+          result[mod] ||= mod.name
+        end
       super()
     end
 
+    def ==(other)
+      other.is_a?(Base) &&
+        possible_modules == other.possible_modules &&
+        mapping == other.mapping
+    end
+
     def type
       :active_module
     end
@@ -38,13 +62,11 @@ module ActiveModule
     end
 
     def serialize(module_instance)
-      module_instance && cast(module_instance).name
+      mapping[cast(module_instance)]
     end
 
     def deserialize(str)
-      str&.constantize
-    rescue NameError
-      nil
+      from_db[str]
     end
 
     private
@@ -78,5 +100,9 @@ module ActiveModule
     def modules_index
       @modules_index ||= ModulesIndex.new(@possible_modules)
     end
+
+    def from_db
+      @from_db ||= mapping.invert
+    end
   end
 end

data/lib/active_module/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_module
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Pedro Rolo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2024-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord