eavi 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd59d004569dc526eda05b7ff0cfea3dab4d87aa
-  data.tar.gz: eea265db8b1a62cc99199d5e24da12de21804316
+  metadata.gz: 6f6de9f9fc58a77b27a53a52795a010bf91f032e
+  data.tar.gz: b8944f725219774d13bf092f1dc01244fc8db3cb
 SHA512:
-  metadata.gz: ef978d38107d68845f29d377f78b0ac7858513fb1d98efa2e0ef278d9c5407eef165c95ab3223c46e8831c73b754c9d33a2e3435520d414ede4d6f763f02ac65
-  data.tar.gz: 00f83214a0489d1c2e7b224d97b67b9ddfa91f131bf67d06ee43b83955e17481b13bb5c416d60c2ea33e843d1402a1d3c0bd8970cfb13a65df13140f62633f42
+  metadata.gz: 0bc369b4c2d793bb7ec9fe8eb52e14f4bdc7e123bb3fc6e641fef46271b1a9ff603a9eb047f94e94d631483796fe2b3a17b43e604880a642ca7d6fad8c73990e
+  data.tar.gz: 7e0c0bfed62fe5a16ffcce7ef1f23bb44d8e0028241fc4674f210bda5ffe7653e0281671d91fa2ae2f41d58ba0e3a7c8b72374adada8d44940c2a7fb083aff43

data/lib/eavi/visit_method_helper.rb

@@ -4,18 +4,18 @@ module Eavi
     TEMPLATE = 'visit[%s]'.freeze
     REGEXP = /^visit\[(.*)\]$/
 
-    # Return a visit method name for the type +type+.
+    # Returns a visit method name for the type +type+.
     def self.gen_name(type)
       return TEMPLATE % type.name
     end
 
-    # Return true if the +visit_method_name+ is a well formed
+    # Returns true if the +visit_method_name+ is a well formed
     # visit method name, else false.
     def self.match(visit_method_name)
       return REGEXP.match(visit_method_name)
     end
 
-    # Return the type matching a visit method.
+    # Returns the type matching a visit method.
     def self.get_type(visit_method)
       type_symbol = match(visit_method).captures[0]
       return const_get(type_symbol)

data/lib/eavi/visitor.rb

@@ -6,6 +6,11 @@ module Eavi
   # to make it a dynamic visitor (see the OOP visitor pattern).
   module Visitor
     # Call the visit method associated with the type of +object+.
+    #
+    # @param [Object] object The object to visit
+    # @param [Object] *args The arguments passed to the called visit method
+    # @param [Class] as: The class which the visit method is attached
+    # @returns The result of the called visit method
     def visit(object, *args, as: object.class)
       as.ancestors.each do |type|
         visit_method_name = VisitMethodHelper.gen_name(type)
@@ -17,35 +22,38 @@ module Eavi
 
     class << self
       def included(visitor)
-        visitor.extend(ModuleDSL)
-        visitor.extend(ModuleMethods)
-        visitor.extend(ModuleMethodsWhenIncluded)
+        visitor.extend(DSL)
+        visitor.extend(MethodsWhenIncludedAndExtended)
+        visitor.extend(MethodsWhenIncluded)
       end
 
       def extended(visitor)
-        visitor.extend(ModuleDSL)
-        visitor.extend(ModuleMethods)
-        visitor.extend(ModuleMethodsWhenExtended)
+        visitor.extend(DSL)
+        visitor.extend(MethodsWhenIncludedAndExtended)
+        visitor.extend(MethodsWhenExtended)
       end
     end
 
-    # Domain-Specific Language for the module/class
-    module ModuleDSL
-      # protected
-
+    # DSL methods
+    module DSL
       # DSL method to add visit methods on types +types+.
+      #
+      # @param [Array<Class>] *types Types attached to the new visit method
+      # @param [Proc] block The content of the visit method
       def def_visit(*types, &block)
         add_visit_method(*types, &block)
       end
 
       # DSL method to remove visit methods on types +types+.
+      #
+      # @param [Array<Class>] *types Types attached to the removed visit method
       def undef_visit(*types)
         remove_visit_method(*types)
       end
     end
 
     # Extends if included or extended
-    module ModuleMethods
+    module MethodsWhenIncludedAndExtended
       # Alias the `visit` method.
       def alias_visit_method(visit_method_alias)
         specialized_alias_visit_method(visit_method_alias)
@@ -76,12 +84,12 @@ module Eavi
         end
       end
 
-      # Return a list of the visit method.
+      # Returns a list of the visit method.
       def visit_methods
         specialized_visit_methods
       end
 
-      # Return a list of the types with a visit method.
+      # Returns a list of the types with a visit method.
       def visitable_types
         return visit_methods.collect do |visit_method|
           VisitMethodHelper.get_type(visit_method)
@@ -90,7 +98,7 @@ module Eavi
     end
 
     # Extends only when included
-    module ModuleMethodsWhenIncluded
+    module MethodsWhenIncluded
       private
 
       def specialized_alias_visit_method(visit_method_alias)
@@ -117,7 +125,7 @@ module Eavi
     end
 
     # Extends only when extended
-    module ModuleMethodsWhenExtended
+    module MethodsWhenExtended
       private
 
       def specialized_alias_visit_method(visit_method_alias)

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: eavi
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Pierre Le Gall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2018-01-14 00:00:00.000000000 Z
 dependencies: []
-description: Make the visitor pattern accessible and flexible in Ruby.
+description: Make the visitor pattern very accessible in Ruby.
 email: pierre@legall.im
 executables: []
 extensions: []