droonga-engine 1.0.1

data/lib/droonga/logger.rb

@@ -0,0 +1,142 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013-2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  class << self
+    def logger
+      @logger ||= Logger.new
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+
+  class Logger
+    module Level
+      TRACE = 0
+      DEBUG = 1
+      INFO  = 2
+      WARN  = 3
+      ERROR = 4
+      FATAL = 5
+
+      LABELS = [
+        "trace",
+        "debug",
+        "info",
+        "warn",
+        "error",
+        "fatal",
+      ]
+
+      class << self
+        def label(level)
+          LABELS[level]
+        end
+
+        def default
+          WARN
+        end
+
+        def default_label
+          label(default)
+        end
+      end
+    end
+
+    class << self
+      @@default_output = nil
+      def default_output
+        @@default_output || $stdout
+      end
+
+      def default_output=(output)
+        @@default_output = output
+      end
+    end
+
+    def initialize(options={})
+      @output = options[:output] || self.class.default_output
+      @tag = options[:tag]
+      self.level = ENV["DROONGA_LOG_LEVEL"] || Level.default_label
+    end
+
+    def level
+      Level.label(@level)
+    end
+
+    def level=(level)
+      @level = Level::LABELS.index(level.to_s)
+    end
+
+    def trace(message, data={})
+      log(Level::TRACE, message, data)
+    end
+
+    def debug(message, data={})
+      log(Level::DEBUG, message, data)
+    end
+
+    def info(message, data={})
+      log(Level::INFO, message, data)
+    end
+
+    def warn(message, data={})
+      log(Level::WARN, message, data)
+    end
+
+    def error(message, data={})
+      log(Level::ERROR, message, data)
+    end
+
+    def exception(message, exception, data={})
+      log(Level::ERROR,
+          "#{message}: #{exception.message}(#{exception.class})",
+          data)
+      log_backtrace(Level::ERROR, exception.backtrace)
+    end
+
+    private
+    def log(level, message, data)
+      return unless target_level?(level)
+      @output.print(build_log_line(level, message, data))
+    end
+
+    def log_backtrace(level, backtrace)
+      return unless target_level?(level)
+      backtrace.each do |message|
+        @output.write(build_log_line(level, message))
+      end
+    end
+
+    def target_level?(level)
+      @level <= level
+    end
+
+    def build_log_line(level, message, data={})
+      line = "#{Time.now.iso8601}[#{Level.label(level)}]: "
+      line << "#{@tag}: " if @tag
+      line << message
+      data.each do |key, value|
+        line << " #{key}=#{value.inspect}"
+      end
+      line << "\n"
+      line
+    end
+  end
+end

data/lib/droonga/message_matcher.rb

@@ -0,0 +1,109 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  # It checks whether the pattern matches against a message.
+  #
+  # It provides the small language. Here is the pattern syntax.
+  #
+  #   * PATTERN = [TARGET_PATH, OPERATOR, ARGUMENT*]
+  #   * PATTERN = [PATTERN, LOGICAL_OPERATOR, PATTERN]
+  #   * TARGET_PATH = "COMPONENT(.COMPONENT)*"
+  #   * OPERATOR = :equal, :in, :include, :exist, :start_with
+  #                (More operators may be added in the future.
+  #                 For example, :end_with and so on.)
+  #   * ARGUMENT = OBJECT_DEFINED_IN_JSON
+  #   * LOGICAL_OPERATOR = :or (:add will be added.)
+  #
+  # For example:
+  #
+  # ```
+  # ["type", :equal, "search"]
+  # ```
+  #
+  # matches to the following message:
+  #
+  # ```
+  # {"type" => "search"}
+  # ```
+  #
+  # Another example:
+  #
+  # ```
+  # ["body.output.limit", :equal, 10]
+  # ```
+  #
+  # matches to the following message:
+  #
+  # ```
+  # {
+  #   "body" => {
+  #     "output" => {
+  #       "limit" => 10,
+  #     },
+  #   },
+  # }
+  # ```
+  class MessageMatcher
+    # @param [Array] pattern The pattern to be matched against a message.
+    def initialize(pattern)
+      path, operator, *arguments = pattern
+      @path_components = path.split(".")
+      @operator = operator
+      @arguments = arguments
+    end
+
+    def match?(message)
+      target = extract_target(message)
+      apply_operator(target)
+    end
+
+    private
+    NONEXISTENT_PATH = Object.new
+    def extract_target(message)
+      result = message
+      @path_components.each do |component|
+        return NONEXISTENT_PATH unless result.is_a?(Hash)
+        result = result[component]
+      end
+      result
+    end
+
+    def apply_operator(target)
+      case @operator
+      when :equal
+        [target] == @arguments
+      when :in
+        @arguments.any? do |argument|
+          argument.include?(target)
+        end
+      when :include
+        return false unless target.respond_to?(:include?)
+        @arguments.any? do |argument|
+          target.include?(argument)
+        end
+      when :exist
+        target != NONEXISTENT_PATH
+      when :start_with
+        return false unless target.respond_to?(:start_with?)
+        @arguments.any? do |argument|
+          target.start_with?(argument)
+        end
+      else
+        raise ArgumentError, "Unknown operator: <#{@operator}>"
+      end
+    end
+  end
+end

data/lib/droonga/output_message.rb

@@ -0,0 +1,55 @@
+# Copyright (C) 2013-2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "droonga/status_code"
+
+module Droonga
+  class OutputMessage
+    def initialize(raw_message)
+      @raw_message = raw_message
+    end
+
+    def adapted_message
+      # TODO: We can create adapted message non-destructively.
+      # If it is not performance issue, it is better that we don't
+      # change message destructively. Consider about it later.
+      @raw_message
+    end
+
+    def status_code
+      @raw_message["statusCode"]
+    end
+
+    def status_code=(status_code)
+      @raw_message["statusCode"] = status_code
+    end
+
+    def errors
+      @raw_message["errors"]
+    end
+
+    def errors=(errors)
+      @raw_message["errors"] = errors
+    end
+
+    def body
+      @raw_message["body"]
+    end
+
+    def body=(body)
+      @raw_message["body"] = body
+    end
+  end
+end

data/lib/droonga/planner.rb

@@ -0,0 +1,47 @@
+# Copyright (C) 2013-2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "droonga/loggable"
+require "droonga/distributed_command_planner"
+require "droonga/error_messages"
+
+module Droonga
+  class Planner
+    include Loggable
+    include ErrorMessages
+
+    def initialize
+    end
+
+    def plan(message)
+      raise NotImplemented, "#{self.class.name}\##{__method__} must implement."
+    end
+
+    private
+    def scatter(message, record, options={})
+      planner = DistributedCommandPlanner.new(message)
+      planner.scatter(record)
+      planner.reduce(options[:reduce])
+      planner.plan
+    end
+
+    def broadcast(message, options={})
+      planner = DistributedCommandPlanner.new(message)
+      planner.broadcast(:write => options[:write])
+      planner.reduce(options[:reduce])
+      planner.plan
+    end
+  end
+end

data/lib/droonga/pluggable.rb

@@ -0,0 +1,31 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  module Pluggable
+    def options
+      @options ||= {}
+    end
+
+    def find_sub_classes(names)
+      target_sub_classes = []
+      names.each do |name|
+        sub_classes = Plugin.registry.find_sub_classes(name, self)
+        target_sub_classes.concat(sub_classes)
+      end
+      target_sub_classes
+    end
+  end
+end

data/lib/droonga/plugin/metadata/adapter_input_message.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  module Plugin
+    module Metadata
+      class AdapterInputMessage
+        def initialize(adapter_class)
+          @adapter_class = adapter_class
+        end
+
+        def pattern
+          configuration[:pattern]
+        end
+
+        def pattern=(pattern)
+          configuration[:pattern] = pattern
+        end
+
+        private
+        def configuration
+          @adapter_class.options[:input_message] ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/droonga/plugin/metadata/adapter_output_message.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  module Plugin
+    module Metadata
+      class AdapterOutputMessage
+        def initialize(adapter_class)
+          @adapter_class = adapter_class
+        end
+
+        def pattern
+          configuration[:pattern]
+        end
+
+        def pattern=(pattern)
+          configuration[:pattern] = pattern
+        end
+
+        private
+        def configuration
+          @adapter_class.options[:output_message] ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/droonga/plugin/metadata/collector_message.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  module Plugin
+    module Metadata
+      class CollectorMessage
+        def initialize(plugin_class)
+          @plugin_class = plugin_class
+        end
+
+        def pattern
+          configuration[:pattern]
+        end
+
+        def pattern=(pattern)
+          configuration[:pattern] = pattern
+        end
+
+        private
+        def configuration
+          @plugin_class.options[:message] ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/droonga/plugin/metadata/handler_action.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  module Plugin
+    module Metadata
+      class HandlerAction
+        def initialize(handler_class)
+          @handler_class = handler_class
+        end
+
+        def synchronous?
+          configuration[:synchronous]
+        end
+
+        def synchronous=(boolean)
+          configuration[:synchronous] = boolean
+        end
+
+        private
+        def configuration
+          @handler_class.options[:action] ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/droonga/plugin/metadata/input_message.rb

@@ -0,0 +1,54 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Droonga
+  module Plugin
+    module Metadata
+      class InputMessage
+        class NotStringMessageType < Error
+          def initialize(type)
+            super("You must specify a string as a message type. " +
+                    "#{type.inspect} is not a string.")
+          end
+        end
+
+        class BlankMessageType < Error
+          def initialize
+            super("You must specify a non-empty string as a message type.")
+          end
+        end
+
+        def initialize(plugin_class)
+          @plugin_class = plugin_class
+        end
+
+        def type
+          configuration[:type]
+        end
+
+        def type=(type)
+          raise NotStringMessageType.new(type) unless type.is_a?(String)
+          raise BlankMessageType.new if type.empty?
+          configuration[:type] = type
+        end
+
+        private
+        def configuration
+          @plugin_class.options[:message] ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/droonga/plugin.rb

@@ -0,0 +1,43 @@
+# Copyright (C) 2014 Droonga Project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "droonga/plugin_registry"
+require "droonga/single_step_definition"
+require "droonga/adapter"
+require "droonga/planner"
+require "droonga/handler"
+require "droonga/collectors"
+
+module Droonga
+  module Plugin
+    class << self
+      def registry
+        @@registry ||= PluginRegistry.new
+      end
+    end
+
+    def register(name)
+      Plugin.registry.register(name, self)
+    end
+
+    def define_single_step(&block)
+      single_step_definitions << SingleStepDefinition.new(self, &block)
+    end
+
+    def single_step_definitions
+      @single_step_definitions ||= []
+    end
+  end
+end