groonga-schema 1.0.0

data/lib/groonga-schema/plugin.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga/command"
+
+module GroongaSchema
+  class Plugin
+    attr_reader :name
+    def initialize(name)
+      @name = name
+    end
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+
+      @name == other.name
+    end
+
+    def to_register_groonga_command
+      Groonga::Command::PluginRegister.new(:name => @name)
+    end
+
+    def to_unregister_groonga_command
+      Groonga::Command::PluginUnregister.new(:name => @name)
+    end
+  end
+end

data/lib/groonga-schema/schema.rb

@@ -0,0 +1,87 @@
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga-schema/column"
+require "groonga-schema/plugin"
+require "groonga-schema/table"
+
+module GroongaSchema
+  class Schema
+    attr_reader :plugins
+    attr_reader :tables
+    attr_reader :columns
+    def initialize
+      @plugins = []
+      @tables = {}
+      @columns = {}
+    end
+
+    def apply_command(command)
+      case command.command_name
+      when "register"
+        plugin = Plugin.new(command.path)
+        @plugins << plugin
+      when "plugin_register"
+        plugin = Plugin.new(command.name)
+        @plugins << plugin
+      when "table_create"
+        apply_command_table_create(command)
+      when "column_create"
+        apply_command_column_create(command)
+      end
+    end
+
+    private
+    def apply_command_table_create(command)
+      table = Table.new(command.name)
+      table.apply_command(command)
+      refered_table = @tables[table.key_type]
+      if refered_table
+        table.reference_key_type = true
+        refered_table.related_tables << table
+      end
+      @tables[table.name] = table
+      @columns[table.name] ||= {}
+    end
+
+    def apply_command_column_create(command)
+      column = Column.new(command.table, command.name)
+      column.apply_command(command)
+
+      table = @tables[column.table_name]
+      if table
+        table.columns << column
+      end
+
+      refered_table = @tables[column.value_type]
+      if refered_table
+        column.reference_value_type = true
+        refered_table.related_columns << column
+        refered_columns = @columns[column.value_type] || {}
+        column.sources.each do |source|
+          next if source == "_key"
+          source_column = refered_columns[source]
+          if source_column
+            source_column.related_columns << column
+          end
+        end
+      end
+
+      @columns[column.table_name] ||= {}
+      @columns[column.table_name][column.name] = column
+    end
+  end
+end

data/lib/groonga-schema/table.rb

@@ -0,0 +1,258 @@
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module GroongaSchema
+  class Table
+    attr_reader :name
+    attr_accessor :type
+    attr_accessor :flags
+    attr_accessor :key_type
+    attr_accessor :value_type
+    attr_accessor :default_tokenizer
+    attr_accessor :normalizer
+    attr_accessor :token_filters
+    attr_writer :reference_key_type
+    attr_accessor :columns
+    attr_accessor :related_tables
+    attr_accessor :related_columns
+    def initialize(name)
+      @name = name
+      @type = :no_key
+      @flags = []
+      @key_type = nil
+      @value_type = nil
+      @default_tokenizer = nil
+      @normalizer = nil
+      @token_filters = []
+      @reference_key_type = false
+      @columns = []
+      @related_tables = []
+      @related_columns = []
+    end
+
+    def reference_key_type?
+      @reference_key_type
+    end
+
+    def apply_command(command)
+      applier = CommandApplier.new(self, command)
+      applier.apply
+    end
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+
+      @name == other.name and
+        @type == other.type and
+        @flags.sort == other.flags.sort and
+        @key_type == other.key_type and
+        @value_type == other.value_type and
+        @default_tokenizer == other.default_tokenizer and
+        @normalizer == other.normalizer and
+        @token_filters == other.token_filters
+    end
+
+    def to_create_groonga_command
+      table_create_command(@name)
+    end
+
+    def to_remove_groonga_command
+      table_remove_command(@name)
+    end
+
+    def to_migrate_start_groonga_commands
+      commands = []
+      commands << table_create_command(new_name)
+      if @columns.empty?
+        commands << table_copy_command(@name, new_name)
+      else
+        sorted_columns = @columns.sort_by(&:name)
+        sorted_columns.each do |column|
+          next if column.type == :index
+          new_column = Column.new(new_name, column.name)
+          new_column.apply_column(column)
+          commands << new_column.to_create_groonga_command
+          commands << column.to_copy_groonga_command(new_name, column.name)
+        end
+      end
+      commands << table_rename_command(@name, old_name)
+      commands << table_rename_command(new_name, @name)
+      commands
+    end
+
+    def to_migrate_finish_groonga_commands
+      commands = []
+      sorted_columns = @columns.sort_by(&:name)
+      sorted_columns.each do |column|
+        next unless column.type == :index
+        commands << column.to_create_groonga_command
+      end
+      commands << table_remove_command(old_name)
+      commands
+    end
+
+    private
+    def old_name
+      "#{@name}_old"
+    end
+
+    def new_name
+      "#{@name}_new"
+    end
+
+    def table_create_command(name)
+      flags_value = [type_flag, *flags].join("|")
+      token_filters_value = @token_filters.join("|")
+      token_filters_value = nil if token_filters_value.empty?
+      arguments = {
+        "name"              => name,
+        "flags"             => flags_value,
+        "key_type"          => @key_type,
+        "value_type"        => @value_type,
+        "default_tokenizer" => @default_tokenizer,
+        "normalizer"        => @normalizer,
+        "token_filters"     => token_filters_value,
+      }
+      Groonga::Command::TableCreate.new(arguments)
+    end
+
+    def table_remove_command(name)
+      arguments = {
+        "name" => name,
+      }
+      Groonga::Command::TableRemove.new(arguments)
+    end
+
+    def table_copy_command(from_name, to_name)
+      arguments = {
+        "from_name" => from_name,
+        "to_name"   => to_name,
+      }
+      Groonga::Command::TableCopy.new(arguments)
+    end
+
+    def table_rename_command(name, new_name)
+      arguments = {
+        "name"     => name,
+        "new_name" => new_name,
+      }
+      Groonga::Command::TableRename.new(arguments)
+    end
+
+    def type_flag
+      case @type
+      when :no_key
+        "TABLE_NO_KEY"
+      when :hash_key
+        "TABLE_HASH_KEY"
+      when :pat_key
+        "TABLE_PAT_KEY"
+      when :dat_key
+        "TABLE_DAT_KEY"
+      else
+        "TABLE_HASH_KEY"
+      end
+    end
+
+    class CommandApplier
+      def initialize(table, command)
+        @table = table
+        @command = command
+      end
+
+      def apply
+        apply_flags
+        apply_key_type
+        apply_value_type
+        apply_default_tokenizer
+        apply_normalizer
+        apply_token_filters
+      end
+
+      private
+      def apply_flags
+        @type = :no_key
+        @flags = []
+        @command.flags.each do |flag|
+          parse_flag(flag)
+        end
+
+        @table.type = @type
+        @table.flags = @flags
+      end
+
+      def parse_flag(flag)
+        case flag
+        when "TABLE_NO_KEY"
+          @type = :no_key
+        when "TABLE_HASH_KEY"
+          @type = :hash_key
+        when "TABLE_PAT_KEY"
+          @type = :pat_key
+        when "TABLE_DAT_KEY"
+          @type = :dat_key
+        else
+          @flags << flag
+        end
+      end
+
+      def apply_key_type
+        case @type
+        when :no_key
+          @table.key_type = nil
+        else
+          @table.key_type = @command.key_type || "ShortText"
+        end
+      end
+
+      def apply_value_type
+        case @type
+        when :dat_key
+          @table.value_type = nil
+        else
+          @table.value_type = @command.value_type
+        end
+      end
+
+      def apply_default_tokenizer
+        case @type
+        when :no_key
+          @table.default_tokenizer = nil
+        else
+          @table.default_tokenizer = @command.default_tokenizer
+        end
+      end
+
+      def apply_normalizer
+        case @type
+        when :no_key
+          @table.normalizer = nil
+        else
+          @table.normalizer = @command.normalizer
+        end
+      end
+
+      def apply_token_filters
+        case @type
+        when :no_key
+          @table.token_filters = []
+        else
+          @table.token_filters = @command.token_filters
+        end
+      end
+    end
+  end
+end

data/lib/groonga-schema/version.rb

@@ -0,0 +1,19 @@
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module GroongaSchema
+  VERSION = "1.0.0"
+end

data/lib/groonga-schema.rb

@@ -0,0 +1,20 @@
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga-schema/command-line/groonga-schema-diff"
+require "groonga-schema/differ"
+require "groonga-schema/schema"
+require "groonga-schema/version"

data/test/run-test.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+$VERBOSE = true
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+
+$LOAD_PATH.unshift(lib_dir)
+
+require "test-unit"
+
+require "groonga-schema"
+require "groonga/command"
+
+exit(Test::Unit::AutoRunner.run(true, test_dir))

data/test/test-column.rb

@@ -0,0 +1,52 @@
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class ColumnTest < Test::Unit::TestCase
+  def column_create(arguments)
+    Groonga::Command::ColumnCreate.new(arguments)
+  end
+
+  sub_test_case "#apply_command" do
+    test "index" do
+      arguments = {
+        "table"  => "Words",
+        "name"   => "entries_text",
+        "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+        "type"   => "Entries",
+        "source" => "title, content",
+      }
+      command = column_create(arguments)
+      column = GroongaSchema::Column.new("Words", "entries_text")
+      column.apply_command(command)
+      assert_equal({
+                     :table_name => "Words",
+                     :name       => "entries_text",
+                     :type       => :index,
+                     :flags      => ["WITH_POSITION", "WITH_SECTION", "INDEX_TINY"],
+                     :value_type => "Entries",
+                     :sources    => ["title", "content"],
+                   },
+                   {
+                     :table_name => column.table_name,
+                     :name       => column.name,
+                     :type       => column.type,
+                     :flags      => column.flags,
+                     :value_type => column.value_type,
+                     :sources    => column.sources,
+                   })
+    end
+  end
+end