active_module 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31dff5b0baa89fa4624fc7b974f5261d483cdaf48f7b7fe9a5d1f0a7f256d7fa
-  data.tar.gz: fbb6655e9de6c118ee99e199ed4ce78441cd55d151d839f7bf0040fa48519df5
+  metadata.gz: 1473d88ff3d53e8948747dc7827ad2836478a0c6db139c54e11f2a96df58e758
+  data.tar.gz: 045e7b7689734cf7c98654ec1283a747063d1defba78c47e3efbd115c5046675
 SHA512:
-  metadata.gz: 0ed009054605141713db46f3d768dc044f42d5bc8ac479ae8004408eaa9ad4657694d661299ba600868975bf7f254da00315d64564d1dfcd96a942ad6622dada
-  data.tar.gz: 4053a0f71c9b2b8db76c1f7637a989646c7b8ad531fa5da680c9795e61ec967fe9db13c74b566350039c13cdaf16d1a0c80f58e04944650e5e2c2f78d73a017f
+  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:
@@ -118,10 +147,12 @@ 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
 

data/lib/active_module/comparison.rb

@@ -7,16 +7,12 @@ module ActiveModule
 
       def =~(other)
         case other
-        when nil
-          false
-        when ::Module
-          super(other)
         when ::String
           (@possible_names ||= possible_names).include?(other)
         when ::Symbol
           (@possible_names ||= possible_names).include?(other.to_s)
         else
-          false
+          self == other
         end
       end
     end

data/lib/active_module/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_module
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Pedro Rolo