eavi 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89417f14ff76e2a1a025877ffc8f421da4efe828
+  data.tar.gz: f80ca41d54257abd0c2abd75943b29effce8fb2d
+SHA512:
+  metadata.gz: 616c403446a6fae16c540b058bee183a57de7884b9b749eba4b6aaac78786e4503b5dc438e3650a5d63ee8ddf76a4c07d20d59ceecb2c4f3bd3fa9b89e798aea
+  data.tar.gz: beb4d9dff7a5833de44466f2ad383b3774cd3a6d0b0c06bfc5ceb12dd83e423e43751f7270b2ab5b026bf8dbc5f364db55c631a06650b1c3f15e37ab1cdecb7b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Pierre Le Gall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/eavi/no_visit_method_error.rb

@@ -0,0 +1,16 @@
+module Eavi
+  # Error raised when a Visitor do not have a visit method to handle an object.
+  class NoVisitMethodError < TypeError
+    attr_reader :visitor, :visited, :visited_as
+
+    def initialize(visitor, visited, visited_as)
+      @visitor = visitor
+      @visited = visited
+      @visited_as = visited_as
+    end
+
+    def to_s
+      "no visit method in #{@visitor} for #{@visited_as} instances"
+    end
+  end
+end

data/lib/eavi/visit_method_helper.rb

@@ -0,0 +1,24 @@
+module Eavi
+  # Helper for visit methods generation, matching & co.
+  module VisitMethodHelper
+    TEMPLATE = 'visit[%s]'.freeze
+    REGEXP = /^visit\[(.*)\]$/
+
+    # Return 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
+    # 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.
+    def self.get_type(visit_method)
+      type_symbol = match(visit_method).captures[0]
+      return const_get(type_symbol)
+    end
+  end
+end

data/lib/eavi/visitor.rb

@@ -0,0 +1,131 @@
+require_relative 'visit_method_helper'
+require_relative 'no_visit_method_error'
+
+module Eavi
+  # Extend a module/class or include a class with Visitor
+  # to make it a dynamic visitor (see the OOP visitor pattern).
+  module Visitor
+    # Call the visit method associated with the type of +object+.
+    def visit(object, *args, as: object.class)
+      as.ancestors.each do |type|
+        visit_method_name = VisitMethodHelper.gen_name(type)
+        next unless respond_to?(visit_method_name)
+        return send(visit_method_name, object, *args)
+      end
+      raise NoVisitMethodError.new(self, object, as)
+    end
+
+    class << self
+      def included(visitor)
+        visitor.extend(ModuleDSL)
+        visitor.extend(ModuleMethods)
+        visitor.extend(ModuleMethodsWhenIncluded)
+      end
+
+      def extended(visitor)
+        visitor.extend(ModuleDSL)
+        visitor.extend(ModuleMethods)
+        visitor.extend(ModuleMethodsWhenExtended)
+      end
+    end
+
+    # Domain-Specific Language for the module/class
+    module ModuleDSL
+      # DSL method to add visit methods on types +types+.
+      def def_visit(*types, &block)
+        add_visit_method(*types, &block)
+      end
+
+      # DSL method to remove visit methods on types +types+.
+      def undef_visit(*types)
+        remove_visit_method(*types)
+      end
+    end
+
+    # Extends if included or extended
+    module ModuleMethods
+      # Alias the `visit` method.
+      def alias_visit_method(visit_method_alias)
+        specialized_alias_visit_method(visit_method_alias)
+      end
+
+      # Add/override a visit method for the types +types+.
+      def add_visit_method(*types, &block)
+        block = block.curry(1) if block.arity.zero?
+        types.each do |type|
+          specialized_add_visit_method(type, &block)
+        end
+      end
+
+      # Remove the visit methods for the types +types+.
+      def remove_visit_method(*types)
+        types.each do |type|
+          specialized_remove_visit_method(type)
+        end
+      end
+
+      # Remove all the visit methods.
+      def reset_visit_methods
+        visit_methods.each do |visit_method|
+          specialized_remove_method(visit_method)
+        end
+      end
+
+      # Return a list of the visit method.
+      def visit_methods
+        return methods.select do |method|
+          VisitMethodHelper.match(method)
+        end
+      end
+
+      # Return a list of the types with a visit method.
+      def visitable_types
+        return visit_methods.collect do |visit_method|
+          VisitMethodHelper.get_type(visit_method)
+        end
+      end
+    end
+
+    # Extends only when included
+    module ModuleMethodsWhenIncluded
+      private
+
+      def specialized_alias_visit_method(visit_method_alias)
+        define_method(visit_method_alias, instance_method(:visit))
+      end
+
+      def specialized_add_visit_method(type, &block)
+        define_method(VisitMethodHelper.gen_name(type), block)
+      end
+
+      def specialized_remove_visit_method(type)
+        remove_method(VisitMethodHelper.gen_name(type))
+      end
+
+      def specialized_remove_method(visit_method)
+        remove_method(visit_method)
+      end
+    end
+
+    # Extends only when extended
+    module ModuleMethodsWhenExtended
+      private
+
+      def specialized_alias_visit_method(visit_method_alias)
+        define_singleton_method(visit_method_alias, method(:visit))
+      end
+
+      def specialized_add_visit_method(type, &block)
+        define_singleton_method(VisitMethodHelper.gen_name(type), block)
+      end
+
+      def specialized_remove_visit_method(type)
+        singleton_class.send(:remove_method, VisitMethodHelper.gen_name(type))
+      end
+
+      def specialized_remove_method(visit_method)
+        singleton_class.send(:remove_method, visit_method)
+      end
+    end
+  end
+end

data/lib/eavi.rb

@@ -0,0 +1,5 @@
+# Eavi is a Ruby visitor pattern helper.
+module Eavi
+end
+
+require_relative 'eavi/visitor'

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: eavi
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Pierre Le Gall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-11 00:00:00.000000000 Z
+dependencies: []
+description: Make the visitor pattern accessible and flexible in Ruby.
+email: pierre@legall.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/eavi.rb
+- lib/eavi/no_visit_method_error.rb
+- lib/eavi/visit_method_helper.rb
+- lib/eavi/visitor.rb
+homepage: http://github.com/lepieru/eavi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A visitor pattern helper for Ruby.
+test_files: []