active_module 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 191f7c2deb3a07261247a4302436cc734541ab62c3db9dd742974d58320dd763
-  data.tar.gz: bd20cb4d1aa7b6437facfaefc8213485571497df5e9e607ce19d16b81db246b8
+  metadata.gz: b80aaae788c312746df8dcaba68bfda8f881fc2c22d7642b509546bdab198bc0
+  data.tar.gz: 84674ab108e9b639327f7531f678a12b8dbf31ab25c01088f8839458b71d1cac
 SHA512:
-  metadata.gz: bc48c3f11e8f71321ab4abece1b5d58f671c96de7e494a5f2f7a8e55b9946c6e88af9e61970bdd2332eba12ee74dadec13485555dff0f05a4f74209c1327fd96
-  data.tar.gz: 126c9c4a2d885cadbe472dc23caa5025415f2806411e9eecce37a5b40c28ce990c5956246646292e9780b6f30d6f77705ab681899a7532940dbe0cfe59f2a471
+  metadata.gz: a89843336735a230e13691069fd3a2e919403a140712476bb5176862fd0bb72df6ff069fa9d3ca9635c2dadc1a602863122a2ec384f8414754a560da02561698
+  data.tar.gz: f7b03c281aafba2a1bf187f7ed9b049c9dd3798bafdf411c3710964e2cbc087dedd72937c897925bdcbb9f4887e625f5d893b69640df853f738324b12b955e7d

data/README.md

@@ -1,19 +1,21 @@
-# ActiveModule
 
-*"Let's turn modules and classes into first-class active record values!"*
+# active_module 
+![alt text](https://img.shields.io/badge/coverage-100%25-brightgreen)
+
+#### *Modules and Classes as first-class active record values!*
 
 ActiveModel/ActiveRecord implementation of the Module attribute type.
 
-- Allows storing a reference to a `Module` or `Class` (because they are modules) in a `:string` 
-database field in a safe and efficient way.
-- It automatically casts strings and symbols into modules when creating and querying objects.
-- Symbols or strings refer to the modules using unqualified names.
+- Allows storing a reference to a `Module` or `Class` in a `:string` database field
+- Automatically casts strings and symbols into modules when creating and querying objects
+- Symbols or strings refer to the modules using unqualified names
+- It is safe and efficient
 
 This is a very generic mechanism that enables many possible utilizations, for instance:
-- Strategy Pattern (composition-based polymorphism)
-- Rapid prototyping static domain objects
-- Static configuration management
-- Rich Java/C#-like enums
+- **Composition-based polymorphism (Strategy design pattern)**
+- **Rapid prototyping static domain objects**
+- **Static configuration management**
+- **Rich Java/C#-like enums**
 
 You can find examples of these in [Usage -> Examples :](#Examples) 
 
@@ -36,8 +38,19 @@ object.module_field = "Module"
 object.module_field #=> Nested::Module:Module
 ```
 
-And compare them like this (optional):
+Query them like this:
 ```ruby 
+MyARObject.where(module_field: Nested::Module)
+MyARObject.where(module_field: :Module)
+MyARObject.where(module_field: "Module")
+object.module_field #=> Nested::Module:Module
+```
+
+And compare them like this:
+
+```ruby 
+object.module_field == Nested::Module
+
 module MyNameSpace
   using ActiveModule::Comparison
 
@@ -51,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.1"
 ```
 
 If you are not using rails, just issue this command after loading active record
@@ -77,7 +90,7 @@ create_table :my_ar_objects do |t|
 end
 ```
 
-Now given this module structure:
+Now given this random module hierarchy:
 ```ruby
 class MyARObject < ActiveRecord::Base
   module MyModule1; end
@@ -169,23 +182,28 @@ my_ar_object.module_field == MyClass::MyModule1
 
 ## Examples
 
-### Strategy Pattern (composition-based polymorphism)
+### Composition-based polymorphism (Strategy design pattern)
 
 [The Strategy design pattern](https://en.wikipedia.org/wiki/Strategy_pattern) allows composition based polymorphism. This enables runtime polymorphism (by changing the strategy in runtime), 
 and multiple-polymorphism (by composing an object of multiple strategies).
 
-If you want to use classes this will do:
+If you want to use classes this will do: 
 ```ruby
 class MyARObject < ActiveRecord::Base
-  attribute :strategy, :active_module, possible_modules: StrategySuperclass.subclasses
+  attribute :strategy_class, :active_module, possible_modules: StrategySuperclass.subclasses
+
+  def strategy
+    @strategy ||= strategy_class.new(some_args_from_the_instance)
+  end
 
   def run_strategy!(args)
-    strategy.new(some_args).call(other_args)
+    strategy.call(args)
   end
 end
 ```
 
-But if you are not in the mood to define a class hierarchy for it, you can use modules instead:
+But if you are not in the mood to define a class hierarchy for it (or if you are performance-savy),
+you may use modules instead:
 
 ```ruby
 class MyARObject < ActiveRecord::Base

data/lib/active_module/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_module
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Pedro Rolo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.15.0
-description: Let's turn modules and classes into first-class active record values!
+description: ActiveModel/ActiveRecord module attribute type implementation
 email:
 - pedrorolo@gmail.com
 executables: []
@@ -89,5 +89,5 @@ requirements: []
 rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
-summary: ActiveModel/ActiveRecord module attribute type implementation
+summary: Modules and Classes as first-class active record values
 test_files: []