groonga-schema 1.0.0

data/test/test-differ.rb

@@ -0,0 +1,222 @@
+# 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 DifferTest < Test::Unit::TestCase
+  setup do
+    @from = GroongaSchema::Schema.new
+    @to = GroongaSchema::Schema.new
+    @differ = GroongaSchema::Differ.new(@from, @to)
+  end
+
+  def plugin_register(arguments)
+    Groonga::Command::PluginRegister.new(arguments)
+  end
+
+  def table_create(arguments)
+    Groonga::Command::TableCreate.new(arguments)
+  end
+
+  def column_create(arguments)
+    Groonga::Command::ColumnCreate.new(arguments)
+  end
+
+  sub_test_case "#diff" do
+    test "plugin - add" do
+      @to.apply_command(plugin_register("name" => "token_filters/stem"))
+
+      expected = GroongaSchema::Diff.new
+      expected.added_plugins.concat(@to.plugins)
+      assert_equal(expected, @differ.diff)
+    end
+
+    test "plugin - remove" do
+      @from.apply_command(plugin_register("name" => "token_filters/stem"))
+
+      expected = GroongaSchema::Diff.new
+      expected.removed_plugins.concat(@from.plugins)
+      assert_equal(expected, @differ.diff)
+    end
+
+    test "table - add - without columns" do
+      arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      @to.apply_command(table_create(arguments))
+
+      expected = GroongaSchema::Diff.new
+      expected.added_tables["Words"] = @to.tables["Words"]
+      assert_equal(expected, @differ.diff)
+    end
+
+    test "table - add - with columns" do
+      table_create_arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      @to.apply_command(table_create(table_create_arguments))
+      column_create_arguments = {
+        "table"  => "Words",
+        "name"   => "entries_text",
+        "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+        "type"   => "Entries",
+        "source" => "title, content",
+      }
+      @to.apply_command(column_create(column_create_arguments))
+
+      expected = GroongaSchema::Diff.new
+      expected.added_tables["Words"] = @to.tables["Words"]
+      expected.added_columns["Words"] = {
+        "entries_text" => @to.columns["Words"]["entries_text"],
+      }
+      assert_equal(expected, @differ.diff)
+    end
+
+    test "table - remove - without columns" do
+      arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      @from.apply_command(table_create(arguments))
+
+      expected = GroongaSchema::Diff.new
+      expected.removed_tables["Words"] = @from.tables["Words"]
+      assert_equal(expected, @differ.diff)
+    end
+
+    test "table - remove - with columns" do
+      table_create_arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      @from.apply_command(table_create(table_create_arguments))
+      column_create_arguments = {
+        "table"  => "Words",
+        "name"   => "entries_text",
+        "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+        "type"   => "Entries",
+        "source" => "title, content",
+      }
+      @from.apply_command(column_create(column_create_arguments))
+
+      expected = GroongaSchema::Diff.new
+      expected.removed_tables["Words"] = @from.tables["Words"]
+      assert_equal(expected, @differ.diff)
+    end
+
+    test "table - change" do
+      from_arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      to_arguments = from_arguments.merge("default_tokenizer" => "TokenMecab")
+      @from.apply_command(table_create(from_arguments))
+      @to.apply_command(table_create(to_arguments))
+
+      expected = GroongaSchema::Diff.new
+      expected.changed_tables["Words"] = @to.tables["Words"]
+      assert_equal(expected, @differ.diff)
+    end
+
+    sub_test_case "column" do
+      setup do
+        arguments = {
+          "name"              => "Words",
+          "flags"             => "TABLE_PAT_KEY",
+          "key_type"          => "ShortText",
+          "default_tokenizer" => "TokenBigram",
+          "normalizer"        => "NormalizerAuto",
+          "token_filters"     => "TokenStem|TokenStopWord",
+        }
+        @from.apply_command(table_create(arguments))
+        @to.apply_command(table_create(arguments))
+      end
+
+      test "add" do
+        arguments = {
+          "table"  => "Words",
+          "name"   => "entries_text",
+          "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+          "type"   => "Entries",
+          "source" => "title, content",
+        }
+        @to.apply_command(column_create(arguments))
+
+        expected = GroongaSchema::Diff.new
+        expected.added_columns["Words"] = {
+          "entries_text" => @to.columns["Words"]["entries_text"],
+        }
+        assert_equal(expected, @differ.diff)
+      end
+
+      test "remove" do
+        arguments = {
+          "table"  => "Words",
+          "name"   => "entries_text",
+          "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+          "type"   => "Entries",
+          "source" => "title, content",
+        }
+        @from.apply_command(column_create(arguments))
+
+        expected = GroongaSchema::Diff.new
+        expected.removed_columns["Words"] = {
+          "entries_text" => @from.columns["Words"]["entries_text"],
+        }
+        assert_equal(expected, @differ.diff)
+      end
+
+      test "change" do
+        from_arguments = {
+          "table"  => "Words",
+          "name"   => "entries_text",
+          "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+          "type"   => "Entries",
+          "source" => "title, content",
+        }
+        to_arguments = from_arguments.merge("source" => "title")
+        @from.apply_command(column_create(from_arguments))
+        @to.apply_command(column_create(to_arguments))
+
+        expected = GroongaSchema::Diff.new
+        expected.changed_columns["Words"] = {
+          "entries_text" => @to.columns["Words"]["entries_text"],
+        }
+        assert_equal(expected, @differ.diff)
+      end
+    end
+  end
+end

data/test/test-plugin.rb

@@ -0,0 +1,43 @@
+# 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 PluginTest < Test::Unit::TestCase
+  sub_test_case "#==" do
+    test "equal" do
+      plugin1 = GroongaSchema::Plugin.new("token_filters/stem")
+      plugin2 = GroongaSchema::Plugin.new("token_filters/stem")
+      assert_equal(plugin1, plugin2)
+    end
+
+    test "not equal" do
+      plugin1 = GroongaSchema::Plugin.new("token_filters/stem")
+      plugin2 = GroongaSchema::Plugin.new("token_filters/stop_word")
+      assert_not_equal(plugin1, plugin2)
+    end
+  end
+
+  test "#to_register_groonga_command" do
+    plugin = GroongaSchema::Plugin.new("token_filters/stem")
+    assert_equal("plugin_register --name \"token_filters/stem\"",
+                 plugin.to_register_groonga_command.to_command_format)
+  end
+
+  test "#to_unregister_groonga_command" do
+    plugin = GroongaSchema::Plugin.new("token_filters/stem")
+    assert_equal("plugin_unregister --name \"token_filters/stem\"",
+                 plugin.to_unregister_groonga_command.to_command_format)
+  end
+end

data/test/test-schema.rb

@@ -0,0 +1,138 @@
+# 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 SchemaTest < Test::Unit::TestCase
+  def setup
+    @schema = GroongaSchema::Schema.new
+  end
+
+  def register(arguments)
+    Groonga::Command::Register.new(arguments)
+  end
+
+  def plugin_register(arguments)
+    Groonga::Command::PluginRegister.new(arguments)
+  end
+
+  def table_create(arguments)
+    Groonga::Command::TableCreate.new(arguments)
+  end
+
+  def column_create(arguments)
+    Groonga::Command::ColumnCreate.new(arguments)
+  end
+
+  sub_test_case "#apply_command" do
+    test "plugin - register" do
+      command = register("path" => "token_filters/stem")
+      @schema.apply_command(command)
+
+      assert_equal(["token_filters/stem"],
+                   @schema.plugins.collect(&:name))
+    end
+
+    test "plugin - plugin_register" do
+      command = plugin_register("name" => "token_filters/stem")
+      @schema.apply_command(command)
+
+      assert_equal(["token_filters/stem"],
+                   @schema.plugins.collect(&:name))
+    end
+
+    test "lexicon" do
+      arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      command = table_create(arguments)
+      @schema.apply_command(command)
+
+      table_data = @schema.tables.collect do |name, table|
+        {
+          :name                => name,
+          :type                => table.type,
+          :flags               => table.flags,
+          :key_type            => table.key_type,
+          :value_type          => table.value_type,
+          :default_tokenizer   => table.default_tokenizer,
+          :normalizer          => table.normalizer,
+          :token_filters       => table.token_filters,
+          :reference_key_type? => table.reference_key_type?,
+        }
+      end
+      assert_equal([
+                     {
+                       :name                => "Words",
+                       :type                => :pat_key,
+                       :flags               => [],
+                       :key_type            => "ShortText",
+                       :value_type          => nil,
+                       :default_tokenizer   => "TokenBigram",
+                       :normalizer          => "NormalizerAuto",
+                       :token_filters       => ["TokenStem", "TokenStopWord"],
+                       :reference_key_type? => false,
+                     },
+                   ],
+                   table_data)
+    end
+
+    test "index column" do
+      @schema.apply_command(table_create("name"  => "Entries",
+                                         "flags" => "TABLE_NO_KEY"))
+      arguments = {
+        "table"  => "Words",
+        "name"   => "entries_text",
+        "flags"  => "COLUMN_INDEX|WITH_POSITION|WITH_SECTION|INDEX_TINY",
+        "type"   => "Entries",
+        "source" => "title, content",
+      }
+      command = column_create(arguments)
+      @schema.apply_command(command)
+
+      column_data = []
+      @schema.columns.each do |table_name, columns|
+        columns.each do |column_name, column|
+          column_data << {
+            :table_name            => table_name,
+            :name                  => column_name,
+            :type                  => column.type,
+            :flags                 => column.flags,
+            :value_type            => column.value_type,
+            :sources               => column.sources,
+            :reference_value_type? => column.reference_value_type?,
+          }
+        end
+      end
+      flags = ["WITH_POSITION", "WITH_SECTION", "INDEX_TINY"]
+      assert_equal([
+                     {
+                       :table_name            => "Words",
+                       :name                  => "entries_text",
+                       :type                  => :index,
+                       :flags                 => flags,
+                       :value_type            => "Entries",
+                       :sources               => ["title", "content"],
+                       :reference_value_type? => true,
+                     },
+                   ],
+                   column_data)
+    end
+  end
+end

data/test/test-table.rb

@@ -0,0 +1,92 @@
+# 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 TableTest < Test::Unit::TestCase
+  def table_create(arguments)
+    Groonga::Command::TableCreate.new(arguments)
+  end
+
+  sub_test_case "#apply_command" do
+    test "lexicon" do
+      arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      command = table_create(arguments)
+      table = GroongaSchema::Table.new("Words")
+      table.apply_command(command)
+      assert_equal({
+                     :name              => "Words",
+                     :type              => :pat_key,
+                     :flags             => [],
+                     :key_type          => "ShortText",
+                     :value_type        => nil,
+                     :default_tokenizer => "TokenBigram",
+                     :normalizer        => "NormalizerAuto",
+                     :token_filters     => ["TokenStem", "TokenStopWord"],
+                   },
+                   {
+                     :name              => table.name,
+                     :type              => table.type,
+                     :flags             => table.flags,
+                     :key_type          => table.key_type,
+                     :value_type        => table.value_type,
+                     :default_tokenizer => table.default_tokenizer,
+                     :normalizer        => table.normalizer,
+                     :token_filters     => table.token_filters,
+                   })
+    end
+  end
+
+  sub_test_case "#==" do
+    test "equal" do
+      arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      command = table_create(arguments)
+      table1 = GroongaSchema::Table.new("Words")
+      table1.apply_command(command)
+      table2 = GroongaSchema::Table.new("Words")
+      table2.apply_command(command)
+      assert_equal(table1, table2)
+    end
+
+    test "not equal" do
+      arguments = {
+        "name"              => "Words",
+        "flags"             => "TABLE_PAT_KEY",
+        "key_type"          => "ShortText",
+        "default_tokenizer" => "TokenBigram",
+        "normalizer"        => "NormalizerAuto",
+        "token_filters"     => "TokenStem|TokenStopWord",
+      }
+      table1 = GroongaSchema::Table.new("Words1")
+      table1.apply_command(table_create(arguments.merge("name" => "Words1")))
+      table2 = GroongaSchema::Table.new("Words2")
+      table2.apply_command(table_create(arguments.merge("name" => "Words2")))
+      assert_not_equal(table1, table2)
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: groonga-schema
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kouhei Sutou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: groonga-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+- !ruby/object:Gem::Dependency
+  name: groonga-command-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: packnga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- kou@clear-code.com
+executables:
+- groonga-schema-diff
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- Gemfile
+- README.md
+- Rakefile
+- bin/groonga-schema-diff
+- doc/text/lgpl-2.1.txt
+- doc/text/news.md
+- groonga-schema.gemspec
+- lib/groonga-schema.rb
+- lib/groonga-schema/column.rb
+- lib/groonga-schema/command-line/groonga-schema-diff.rb
+- lib/groonga-schema/diff.rb
+- lib/groonga-schema/differ.rb
+- lib/groonga-schema/plugin.rb
+- lib/groonga-schema/schema.rb
+- lib/groonga-schema/table.rb
+- lib/groonga-schema/version.rb
+- test/run-test.rb
+- test/test-column.rb
+- test/test-diff.rb
+- test/test-differ.rb
+- test/test-plugin.rb
+- test/test-schema.rb
+- test/test-table.rb
+homepage: https://github.com/groonga/groonga-schema
+licenses:
+- LGPLv2.1+
+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: Groonga-schema is a Ruby library and tool to processes [Groonga](http://groonga.org/)'s
+  schema.
+test_files:
+- test/test-plugin.rb
+- test/test-column.rb
+- test/test-diff.rb
+- test/run-test.rb
+- test/test-table.rb
+- test/test-schema.rb
+- test/test-differ.rb
+has_rdoc: