risitor 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f83e529945dc5da5ac952f4e85b6eb454f4b0e2c
+  data.tar.gz: e2cba098ab838db018aeef47091e8d16bd5bb2e5
+SHA512:
+  metadata.gz: 48653f25fe5a6c89dd95c86ee16198be29c69edfa0a5b160ad3b10833f97517ba7f86ab0e1abb287f2807f02c622ad4ca3afe6aa1ef3ef966e42c336101950f0
+  data.tar.gz: 97a61929cba44373c0ee32e6c7acd490ad5fc9c19e3343c44524d1e079494d2ee4c9c74640fd4e38763c24e68303c0a23d8ad69528833288a6906a68239652e4

data/lib/risitor/no_visit_method_error.rb

@@ -0,0 +1,16 @@
+module Risitor
+  # Error raised when a Visitor failed to visit an object.
+  class NoVisitMethodError < NoMethodError
+    attr_reader :visitor, :visited, :visited_as
+
+    def initialize(visitor, visited, visited_as)
+      @visitor = visitor
+      @visited = visited
+      @visited_as = visited_as
+    end
+
+    def message
+      "no method in #{@visitor} to visit as #{@visited_as}"
+    end
+  end
+end

data/lib/risitor/visit_method_helper.rb

@@ -0,0 +1,24 @@
+module Risitor
+  # Helper for visit methods generation, matching & co.
+  module VisitMethodHelper
+    TEMPLATE = "visit[%s]"
+    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/risitor/visitor.rb

@@ -0,0 +1,121 @@
+require_relative './no_visit_method_error'
+require_relative './visit_method_helper'
+
+module Risitor
+  # The Visitor module can extend a module or include a class
+  # to make it a dynamic visitor (see the OOP visitor pattern).
+  module Visitor
+    # Calling visit execute the method associated with the
+    # type of +object+.
+    def visit(object, *args, as: object.class)
+      as.ancestors.each do |type|
+        visit_method = VisitMethodHelper.gen_name(type)
+        next unless respond_to? visit_method
+        return send(visit_method, object, *args)
+      end
+      raise NoVisitMethodError.new(self, object, as)
+    end
+
+    # List of the methods extended by a Visitor
+    module ClassMethods
+      # Alias the `visit` method
+      def alias_visit_method(visit_method_alias)
+        define_new_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 == 0
+        types.each do |type|
+          define_visit_method_for type, &block
+        end
+      end
+
+      # Remove the visit methods for the types +types+.
+      def remove_visit_method(*types)
+        types.each do |type|
+          undefine_visit_method_for type
+        end
+      end
+
+      # Remove all the visit methods.
+      def reset_visit_methods
+        visit_methods.each do |visit_method|
+          undefine_visit_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
+
+      alias_method :when_visiting, :add_visit_method
+    end
+
+    # List of the methods extended by a Visitor when included.
+    module ClassMethodsWhenIncluded
+      private
+
+      def define_new_visit_method(new_visit_method)
+        define_method new_visit_method, instance_method(:visit)
+      end
+
+      def define_visit_method_for(klass, &block)
+        define_method VisitMethodHelper.gen_name(klass), block
+      end
+
+      def undefine_visit_method_for(klass)
+        remove_method VisitMethodHelper.gen_name(klass)
+      end
+
+      def undefine_visit_method(visit_method)
+        remove_method visit_method
+      end
+    end
+
+    # List of the methods extended by a Visitor when included.
+    module ClassMethodsWhenExtended
+      private
+
+      def define_new_visit_method(new_visit_method)
+        define_singleton_method new_visit_method, method(:visit)
+      end
+
+      def define_visit_method_for(klass, &block)
+        define_singleton_method VisitMethodHelper.gen_name(klass), block
+      end
+
+      def undefine_visit_method_for(klass)
+        self.singleton_class.send :remove_method, VisitMethodHelper.gen_name(klass)
+      end
+
+      def undefine_visit_method(visit_method)
+        self.singleton_class.send :remove_method, visit_method
+      end
+    end
+
+    class << self
+      def included(visitor)
+        visitor.extend ClassMethods
+        visitor.extend ClassMethodsWhenIncluded
+      end
+
+      def extended(visitor)
+        visitor.extend ClassMethods
+        visitor.extend ClassMethodsWhenExtended
+      end
+    end
+  end
+
+  Base = Visitor
+end

data/lib/risitor.rb

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

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: risitor
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Pierre Le Gall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies: []
+description: Make the visitor pattern accessible and flexible inside Ruby.
+email: pierre@legall.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/risitor.rb
+- lib/risitor/no_visit_method_error.rb
+- lib/risitor/visit_method_helper.rb
+- lib/risitor/visitor.rb
+homepage: http://github.com/lepieru/risitor
+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: []