groonga-client-rails 0.9.0

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# NEWS
+
+## 0.9.0 - 2016-03-28
+
+Initial release!!!

data/groonga-client-rails.gemspec

@@ -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
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, "") + "\n"
+end
+
+$LOAD_PATH.unshift(File.join(__dir__, "lib"))
+require "groonga/client/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "groonga-client-rails"
+  spec.version = Groonga::Client::Rails::VERSION
+  spec.homepage = "https://github.com/ranguba/groonga-client-rails"
+  spec.authors = ["Kouhei Sutou"]
+  spec.email = ["kou@clear-code.com"]
+
+  readme = File.read("README.md", :encoding => "UTF-8")
+  entries = readme.split(/^\#\#\s(.*)$/)
+  clean_white_space.call(entries[entries.index("Description") + 1])
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "LGPLv2.1+"
+  spec.files = ["README.md", "Rakefile", "Gemfile", "#{spec.name}.gemspec"]
+  spec.files += [".yardopts"]
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("doc/text/*")
+  spec.test_files += Dir.glob("test/**/*")
+
+  spec.add_runtime_dependency("groonga-client", ">= 0.2.4")
+  spec.add_runtime_dependency("rails")
+
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("test-unit")
+  spec.add_development_dependency("test-unit-rr")
+  spec.add_development_dependency("packnga")
+  spec.add_development_dependency("kramdown")
+end

data/lib/groonga-client-rails.rb

@@ -0,0 +1,23 @@
+# 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/client/rails/version"
+
+require "groonga/client/searcher"
+
+if defined?(Rails)
+  require "groonga/client/railtie"
+end

data/lib/groonga/client/rails/fixture.rb

@@ -0,0 +1,35 @@
+# 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/client/rails/groonga_server_runner"
+
+module Groonga
+  class Client
+    module Rails
+      module Fixture
+        def setup_groonga
+          @groonga_server_runner = GroongaServerRunner.new
+          @groonga_server_runner.run
+        end
+
+        def teardown_groonga
+          return if @groonga_server_runner.nil?
+          @groonga_server_runner.stop
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/rails/groonga_server_runner.rb

@@ -0,0 +1,164 @@
+# 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 "rbconfig"
+require "fileutils"
+
+module Groonga
+  class Client
+    module Rails
+      class GroongaServerRunner
+        def initialize
+          @pid = nil
+          @using_running_server = false
+          @url = build_url
+          @groonga = find_groonga
+          @tmp_dir = nil
+        end
+
+        def run
+          if groonga_server_running?
+            @using_running_server = true
+          else
+            return if @groonga.nil?
+            @tmp_dir = create_tmp_dir
+            db_path = @tmp_dir + "db"
+            @pid = spawn(@groonga,
+                         "--port", @url.port.to_s,
+                         "--log-path", (@tmp_dir + "groonga.log").to_s,
+                         "--query-log-path", (@tmp_dir + "query.log").to_s,
+                         "--protocol", "http",
+                         "-s",
+                         "-n", db_path.to_s)
+            wait_groonga_ready
+          end
+          sync_schema
+        end
+
+        def stop
+          if @using_running_server
+            Groonga::Client.open do |client|
+              schema = client.schema
+              schema.tables.each do |name, _|
+                client.delete(table: name,
+                              filter: "true")
+              end
+            end
+          else
+            if @pid
+              Groonga::Client.open do |client|
+                client.shutdown
+              end
+              wait_groonga_shutdown
+            end
+            if @tmp_dir
+              FileUtils.rm_rf(@tmp_dir)
+            end
+          end
+        end
+
+        private
+        def build_url
+          default_options = Groonga::Client.default_options
+          url = default_options[:url]
+          if url.nil?
+            host = default_options[:host] || default_options[:address]
+            port = default_options[:port] || 10041
+            path = default_options[:path]
+            url = URI("http://#{host}:#{port}#{path}")
+          end
+          url
+        end
+
+        def groonga_server_running?
+          begin
+            TCPSocket.open(@url.host, @url.port) do
+            end
+          rescue SystemCallError
+            false
+          else
+            true
+          end
+        end
+
+        def sync_schema
+          ::Rails.application.eager_load!
+          ObjectSpace.each_object(Class) do |klass|
+            klass.sync_schema if klass < Searcher
+          end
+        end
+
+        def find_groonga
+          paths = ENV["PATH"].split(File::PATH_SEPARATOR)
+          exeext = RbConfig::CONFIG["EXEEXT"]
+          paths.each do |path|
+            groonga = File.join(path, "groonga#{exeext}")
+            return groonga if File.executable?(groonga)
+          end
+          nil
+        end
+
+        def create_tmp_dir
+          tmpfs_dir = "/dev/shm"
+          if File.directory?(tmpfs_dir)
+            base_tmp_dir = Pathname(tmpfs_dir)
+          else
+            base_tmp_dir = ::Rails.root + "tmp"
+          end
+          tmp_dir = base_tmp_dir + "groonga-client-rails.#{Process.pid}"
+          FileUtils.rm_rf(tmp_dir)
+          FileUtils.mkdir_p(tmp_dir)
+          tmp_dir
+        end
+
+        def wait_groonga_ready
+          n_retried = 0
+          while n_retried <= 20
+            n_retried += 1
+            sleep(0.05)
+            if groonga_server_running?
+              break
+            else
+              begin
+                pid = Process.waitpid(@pid, Process::WNOHANG)
+              rescue SystemCallError
+                @pid = nil
+                break
+              end
+            end
+          end
+        end
+
+        def wait_groonga_shutdown
+          # TODO: Remove me when Groonga 6.0.1 has been released.
+          # Workaround to shutdown as soon as possible.
+          groonga_server_running?
+
+          n_retried = 0
+          while n_retried <= 20
+            n_retried += 1
+            sleep(0.05)
+            pid = Process.waitpid(@pid, Process::WNOHANG)
+            return if pid
+          end
+
+          Process.kill(:KILL, @pid)
+          Process.waitpid(@pid)
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/rails/spec_helper.rb

@@ -0,0 +1,39 @@
+# 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/client/rails/fixture"
+
+module Groonga
+  class Client
+    module Rails
+      module SpecHelper
+        include Fixture
+
+        extend ActiveSupport::Concern
+
+        included do
+          before(:each) do
+            setup_groonga
+          end
+
+          after(:each) do
+            teardown_groonga
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/rails/test_helper.rb

@@ -0,0 +1,39 @@
+# 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/client/rails/fixture"
+
+module Groonga
+  class Client
+    module Rails
+      module TestHelper
+        include Fixture
+
+        extend ActiveSupport::Concern
+
+        included do
+          setup do
+            setup_groonga
+          end
+
+          teardown do
+            teardown_groonga
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/rails/version.rb

@@ -0,0 +1,23 @@
+# 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 Groonga
+  class Client
+    module Rails
+      VERSION = "0.9.0"
+    end
+  end
+end

data/lib/groonga/client/railtie.rb

@@ -0,0 +1,70 @@
+# 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/client"
+
+module Groonga
+  class Client
+    # @private
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "groonga/client/railties/groonga.rake"
+      end
+
+      initializer "groonga-client.eager_load" do |app|
+        app.paths.add("app/searchers",
+                      eager_load: true,
+                      glob: "**/*_searcher.rb")
+      end
+
+      initializer "groonga-client.configure" do |app|
+        config_name = :groonga_client
+        config_path = Pathname(app.paths["config"].existent.first)
+        yaml_path = config_path + "#{config_name}.yml"
+        unless yaml_path.exist?
+          yaml_path.open("w") do |yaml|
+            yaml.puts(<<-YAML)
+default: &default
+  protocol: http
+  # protocol: https
+  host: 127.0.0.1
+  port: 10041
+  # user: alice
+  # password: secret
+  read_timeout: -1
+  # read_timeout: 3
+  backend: synchronous
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+  port: 20041
+
+production:
+  <<: *default
+  host: 127.0.0.1
+  read_timeout: 10
+            YAML
+          end
+        end
+        Groonga::Client.default_options =
+          app.config_for(:groonga_client).deep_symbolize_keys
+      end
+    end
+  end
+end