rivescript 0.1.1

data/lib/rivescript/inheritance.rb

@@ -0,0 +1,105 @@
+# RiveScript Ruby port, https://jvmlab.org/, MIT License
+
+# Topic inheritance functions.
+#
+# Helper functions to assist with topic inheritance and includes.
+
+require_relative "utils"
+
+class RiveScript
+  module Inheritance
+    module_function
+
+    # Recursively scan through a topic and retrieve a listing of all triggers in
+    # that topic and in all included/inherited topics. Some triggers will come out
+    # with an {inherits} tag to signify inheritance depth.
+    def get_topic_triggers(rs, topic, thats = false, depth = 0, inheritance = 0, inherited = false)
+      rs_depth = rs._depth
+      rs_topics = rs._topics
+      rs_thats = rs._thats
+      rs_includes = rs._includes
+      rs_inherits = rs._inherits
+
+      if depth > rs_depth
+        rs.warn("Deep recursion while scanning topic inheritance (gave up in topic #{topic})!")
+        return []
+      end
+
+      rs.say("Collecting trigger list for topic #{topic} (depth=#{depth}; inheritance=#{inheritance}; inherited=#{inherited})")
+
+      if rs_topics[topic].nil?
+        rs.warn("Inherited or included topic '#{topic}' doesn't exist or has no triggers")
+        return []
+      end
+
+      triggers = []
+      in_this_topic = []
+
+      unless thats
+        rs_topics[topic]&.each do |trigger|
+          in_this_topic.push([trigger["trigger"], trigger])
+        end
+      else
+        rs_thats[topic]&.each do |_cur_trig, previous_map|
+          previous_map.each do |_previous, pointer|
+            in_this_topic.push([pointer["trigger"], pointer])
+          end
+        end
+      end
+
+      includes = rs_includes[topic] || {}
+      if includes.any?
+        includes.each_key do |inc|
+          rs.say("Topic #{topic} includes #{inc}")
+          triggers.concat(get_topic_triggers(rs, inc, thats, depth + 1, inheritance + 1, false))
+        end
+      end
+
+      inherits = rs_inherits[topic] || {}
+      if inherits.any?
+        inherits.each_key do |inh|
+          rs.say("Topic #{topic} inherits #{inh}")
+          triggers.concat(get_topic_triggers(rs, inh, thats, depth + 1, inheritance + 1, true))
+        end
+      end
+
+      topic_inherits = rs_inherits[topic] || {}
+      if topic_inherits.any? || inherited
+        in_this_topic.each do |trigger|
+          rs.say("Prefixing trigger with {inherits=#{inheritance}} #{trigger}")
+          triggers.push(["{inherits=#{inheritance}}#{trigger[0]}", trigger[1]])
+        end
+      else
+        triggers.concat(in_this_topic)
+      end
+
+      triggers
+    end
+
+    # Given a topic, return an array of every topic related to it (all topics it
+    # includes or inherits, plus all topics included or inherited by those topics,
+    # and so on). The array includes the original topic, too.
+    def get_topic_tree(rs, topic, depth = 0)
+      rs_depth = rs._depth
+      rs_includes = rs._includes
+      rs_inherits = rs._inherits
+
+      if depth > rs_depth
+        rs.warn("Deep recursion while scanning topic tree!")
+        return []
+      end
+
+      topics = [topic]
+
+      (rs_includes[topic] || {}).each_key do |inc|
+        topics.concat(get_topic_tree(rs, inc, depth + 1))
+      end
+
+      (rs_inherits[topic] || {}).each_key do |inh|
+        topics.concat(get_topic_tree(rs, inh, depth + 1))
+      end
+
+      topics
+    end
+  end
+end

data/lib/rivescript/lang/ruby.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# RiveScript Ruby port
+# Byte <byte@jvmlab.org>, https://jvmlab.org/
+# MIT License
+
+class RiveScript
+  module Lang
+    # Ruby language support for RiveScript object macros.
+    #
+    # Object macros defined in RiveScript source are compiled and executed via
+    # Kernel#eval. Loading untrusted third-party RiveScript personalities can
+    # therefore execute arbitrary Ruby code in your process. Disable this handler
+    # when loading untrusted sources:
+    #
+    #   bot.set_handler("ruby", nil)
+    #
+    # This handler is enabled by default in the Ruby port.
+    class RubyHandler
+      attr_reader :objects, :sources
+
+      def initialize(master)
+        @master = master
+        @objects = {}
+        @sources = {}
+        @binding = binding
+      end
+
+      # Called by RiveScript to load Ruby object macro source.
+      # +code+ may be a Proc or an Array of source lines.
+      def load(name, code)
+        if code.is_a?(Proc)
+          @objects[name] = code
+          @sources[name] = nil
+          return
+        end
+
+        lines = code.is_a?(Array) ? code.join("\n") : code.to_s
+        @sources[name] = lines
+        source = <<~RUBY
+          @objects[#{name.inspect}] = lambda do |rs, args|
+            #{lines}
+          end
+        RUBY
+
+        begin
+          eval(source, @binding, "(rivescript object #{name})", 1)
+        rescue StandardError => e
+          @master.warn("Error evaluating Ruby object: #{e.message}")
+        end
+      end
+
+      # Called by RiveScript to execute a Ruby object macro.
+      def call(rs, name, fields, scope = nil)
+        func = @objects[name]
+        return @master.errors["objectNotFound"] if func.nil?
+
+        reply =
+          if scope
+            scope.instance_exec(rs, fields, &func)
+          else
+            func.call(rs, fields)
+          end
+      rescue StandardError => e
+        reply = "[ERR: Error when executing Ruby object: #{e.message}]"
+      ensure
+        reply = "" if reply.nil?
+        reply
+      end
+    end
+  end
+end