active_module 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a8c9cd4a4af05550d638422b06fe34b22d88511fb899c0cb6385177c1ba38a3
-  data.tar.gz: 11cbe4422096b9a3f961d401872d79e9bea9b4e2f3d60432ecb261284c1578e6
+  metadata.gz: 1473d88ff3d53e8948747dc7827ad2836478a0c6db139c54e11f2a96df58e758
+  data.tar.gz: 045e7b7689734cf7c98654ec1283a747063d1defba78c47e3efbd115c5046675
 SHA512:
-  metadata.gz: e565d8b750e9841d6cbd3dd266f70644be738c4dbe04a5bf02812ce4a038bca852a80b1c1e0ddbb5c936e938b5aaac818c01ecaea77b949be42c7941e97317ec
-  data.tar.gz: 2612bcb5734b38aeb4182a1c46c1f9e50234a96ea2dab4acb6411b59a4d036a3fd287a3721d73232dcbd1b4c64ad369e3f4c74bfcb81be40cdf7d1524c77e0c5
+  metadata.gz: 67321659d14a0aff48e5917e2242d42773dbc6f86a8fa8cef935956bbda4717858128a405264ff39cde9bd06e223ee266b08a4f4b07a62f600ee3b6de8c54714
+  data.tar.gz: bf7305eabb2c4d81e0514542c7172e440aaf5b17ea5d4bf732705100f8a92cc01f772aae9b3ba0f864c575f1040626d7730f5831d7d7889aec0ed88980f5271a

data/README.md

@@ -17,6 +17,35 @@ This is a very generic mechanism that enables many possible utilizations, for in
 
 You can find examples of these in [Usage -> Examples :](#Examples) 
 
+## TL;DR
+
+Declare module attributes like this:
+```ruby
+class MyARObject < ActiveRecord::Base
+  attribute :module_field, 
+            :active_module, 
+            possible_modules: [MyModule1, MyClass, Nested::Module]
+end
+```
+
+Assign them like this:
+```ruby 
+object.module_field = Nested::Module
+object.module_field = :Module
+object.module_field = "Module"
+object.module_field #=> Nested::Module:Module
+```
+
+And compare them like this (optional):
+```ruby 
+module MyNameSpace
+  using ActiveModule::Comparison
+
+  object.module_field =~ :Module1
+  object.module_field =~ "Module1"
+end
+```
+
 ## Installation
 
 Add to your gemfile - and if you are using rails - that's all you need:
@@ -54,7 +83,7 @@ class MyARObject < ActiveRecord::Base
   module MyModule1; end
   module MyModule2; end
   class MyClass; 
-    module Module1; end
+    module MyModule1; end
   end
 end
 ```
@@ -63,13 +92,13 @@ You can make the field refer to one of these modules/classes like this:
 class MyARObject < ActiveRecord::Base
   attribute :module_field, 
             :active_module, 
-            possible_modules: [MyModule1, MyModule2, MyClass, MyClass::Module1]
+            possible_modules: [MyModule1, MyModule2, MyClass, MyClass::MyModule1]
 end
 ```
 And this is it! Easy!<br>
 
 ### Assigning and querying module attributes
-Now you can use this attribute in many handy ways:
+Now you can use this attribute in many handy ways!
 <br>
 <br>
 For instance, you may refer to it using module literals:
@@ -109,6 +138,22 @@ my_ar_object.module_field = "MyClass::MyModule1"
 my_ar_object.module_field #=> MyARObject::MyClass::MyModule::Module
 ```
 
+### Comparing modules with strings and symbols
+
+In order to compare modules with Strings or Symbols you'll have to use the `ActiveModule::Comparison`
+refinement. This refinement adds the method `Module#=~` to the `Module` class, but this change is
+only available within the namespace that includes the refinement.
+
+```ruby
+module YourClassOrModuleThatWantsToCompare
+  using ActiveModule::Comparison
+
+  def method_that_compares
+    my_ar_object.module_field =~ :MyModule1
+  end
+end
+```
+
 ## Examples
 
 ### Strategy Pattern (composition-based polymorphism)

data/lib/active_module/comparison.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActiveModule
+  module Comparison
+    refine ::Module do
+      using ActiveModule::ModuleRefinement
+
+      def =~(other)
+        case other
+        when ::String
+          (@possible_names ||= possible_names).include?(other)
+        when ::Symbol
+          (@possible_names ||= possible_names).include?(other.to_s)
+        else
+          self == other
+        end
+      end
+    end
+
+    using self
+
+    def self.compare(module1, module2)
+      module1 =~ module2
+    end
+  end
+end

data/lib/active_module/version.rb

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

data/lib/active_module.rb

@@ -4,6 +4,7 @@ require_relative "active_module/version"
 require_relative "active_module/base"
 require_relative "active_module/invalid_module_value"
 require_relative "active_module/register"
+require_relative "active_module/comparison"
 require "active_module/railtie" if defined?(Rails::Railtie)
 
 module ActiveModule

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_module
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Pedro Rolo
@@ -58,6 +58,7 @@ files:
 - Rakefile
 - lib/active_module.rb
 - lib/active_module/base.rb
+- lib/active_module/comparison.rb
 - lib/active_module/invalid_module_value.rb
 - lib/active_module/module_refinement.rb
 - lib/active_module/modules_index.rb