grnline 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grnline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Haruka Yoshihara
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Grnline
+
+## Description
+
+GrnLine is the wrapper for the interactive mode of [groonga](http://groonga.org/).
+
+GrnLine is created by Ruby.
+This uses [grnwrap](https://github.com/michisu/grnwrap) as a
+reference. grnwrap is created by Python.
+
+## Installation
+
+```
+$ gem install grnline
+```
+
+## Usage
+
+You can use the options of groonga as ones for grnline. For example,
+you execute groonga with a new database:
+
+    $ grnline -n <groonga-db>
+
+Then, grnline has the own options. Please see ```grnline -- -h```.
+When you want to know groonga's options, please type ```grnline -h```.
+
+## Author
+
+Haruka Yoshihara (yshr04hrk at gmail.com)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+require "packnga"
+
+base_dir = File.join(File.dirname(__FILE__))
+lib_dir = File.join(base_dir, "lib")
+$LOAD_PATH.unshift(lib_dir)
+require "grnline/version"
+
+helper = Bundler::GemHelper.new(base_dir)
+helper.install
+def helper.version_tag
+  version
+end
+
+spec = helper.gemspec
+
+Packnga::DocumentTask.new(spec) do
+end
+
+Packnga::ReleaseTask.new(spec) do
+end
+
+desc "Run tests."
+task :test do
+  ruby("test/run-test.rb")
+end
+
+task :default => :test
+

data/TODO

@@ -0,0 +1,2 @@
+* Add tests
+* Supports output format except JSON (MessagePack, XML...)

data/bin/grnline

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8; mode: ruby -*-
+
+require "grnline"
+
+exit_status = GrnLine::Wrapper.new.run(ARGV)
+exit_status = true if exit_status.nil?
+exit(exit_status)

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# News
+
+## <a id="0-0-1">0.0.1</a>: 2013-05-31
+
+The first release !

data/grnline.gemspec

@@ -0,0 +1,47 @@
+# -*- coding: utf-8; mode: ruby -*-
+
+base_dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.expand_path("lib", base_dir))
+
+require "grnline/version"
+version = GrnLine::VERSION.dup
+
+readme_path = File.join(base_dir, "README.md")
+entries = File.read(readme_path).split(/^##\s(.*)$/)
+entry = lambda do |entry_title|
+  entries[entries.index(entry_title) + 1]
+end
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+description = clean_white_space.call(entry.call("Description"))
+summary, description = description.split(/\n\n+/, 2)
+
+Gem::Specification.new do |spec|
+  spec.name          = "grnline"
+  spec.version       = version
+  spec.authors       = ["Haruka Yoshihara"]
+  spec.email         = ["yshr04hrk@gmail.com"]
+  spec.summary       = summary
+  spec.description   = description
+  spec.license       = "MIT"
+
+  spec.files = ["README.md", "LICENSE.txt", "TODO"]
+  spec.files += ["Rakefile", "Gemfile", "grnline.gemspec"]
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("doc/text/*.*")
+  spec.test_files = Dir.glob("test/**/*.rb")
+  Dir.chdir("bin") do
+    spec.executables = Dir.glob("*")
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("json")
+  spec.add_development_dependency("packnga")
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("test-unit")
+  spec.add_development_dependency("test-unit-notify")
+  spec.add_development_dependency("redcarpet")
+end

data/lib/grnline/options-parser.rb

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+
+require "ostruct"
+require "optparse"
+
+module GrnLine
+  class OptionsParser
+
+    SEPARATOR = "--"
+
+    def initialize
+      @options = OpenStruct.new
+      @options.groonga = "groonga"
+      @options.pager = "less"
+      @options.groonga_arguments = []
+      @options.output = $stdout
+      @options.pretty_print = true
+    end
+
+    def parse(argv)
+      parser = generate_parser
+
+      if not argv.include?(SEPARATOR)
+        @options.groonga_arguments = argv
+      else
+        grnline_arguments, groonga_arguments = split_arguments(argv)
+
+        parser.parse!(grnline_arguments)
+        @options.groonga_arguments = groonga_arguments
+      end
+      @options
+    end
+
+    def split_arguments(argv)
+      grnline_arguments = []
+      groonga_arguments = []
+      separator_index = argv.index(SEPARATOR)
+
+      unless separator_index.zero?
+        groonga_arguments = argv[0 .. (separator_index - 1)]
+      end
+      grnline_arguments = argv[(separator_index + 1) .. -1]
+
+      [grnline_arguments, groonga_arguments]
+    end
+
+    def generate_parser
+      parser = OptionParser.new
+      banner = "Usage: #{$0} [groonga_options] -- [grnline_options]\n" +
+                 "      'groonga_options' is options for groonga. " +
+                 "Please type `groonga --help` for the details of them.\n" +
+                 " grnline_options :"
+      parser.banner = banner
+
+      parser.on("-g", "--groonga=GROONGA",
+                "your groonga.",
+                "(#{@options.groonga})") do |groonga|
+        @options.groonga = groonga
+      end
+
+      parser.on("-p", "--[no-]pretty-print",
+                "Pretty print responses from groonga.",
+                "(#{@options.pretty_print})") do |pretty_print|
+        @options.pretty_print = pretty_print
+      end
+
+      # TODO: supports pager for displaying results from groonga
+      # parser.on("-p", "--pager=PAGER",
+      #           "your pager using to display results.") do |pager|
+      #   @options.pager = pager
+      # end
+
+      parser.on("--output=OUTPUT",
+                "Destination to output responses from groonga.",
+                "(STDOUT)") do |output|
+        @options.output = output
+      end
+
+      parser.on("-v", "--version", "Show version and exit.") do
+        puts(GrnLine::VERSION)
+        exit(true)
+      end
+
+      parser.on_tail("-h", "--help", "Show this message and exit.") do
+        puts(parser.help)
+        exit(true)
+      end
+
+      parser
+    end
+  end
+end

data/lib/grnline/version.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+module GrnLine
+  VERSION = "0.0.1"
+end

data/lib/grnline/wrapper.rb

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+
+require "readline"
+require "json"
+require "open3"
+require "grnline/options-parser"
+
+module GrnLine
+  class Wrapper
+    attr_accessor :options
+
+    GROONGA_COMMANDS = [
+      "cache_limit", "check", "clearlock", "column_create", "column_list",
+      "column_remove", "column_rename", "define_selector", "defrag",
+      "delete", "dump", "load", "log_level", "log_put", "log_reopen",
+      "quit", "register", "select", "shutdown", "status", "table_create",
+      "table_list", "table_remove", "table_rename", "truncate"
+    ]
+    GROONGA_SHUTDOWN_COMMANDS = ["quit", "shutdown"]
+
+    class << self
+      def run(argv)
+        new.run(argv)
+      end
+    end
+
+    def initialize
+      @options = nil
+      setup_input_completion
+    end
+
+    def run(argv)
+      @options = parse_commandline_options(argv)
+      groonga_commandline = generate_groonga_commandline
+
+      Open3.popen3(*groonga_commandline) do |input, output, error, _|
+        @input, @output, @error = input, output, error
+
+        return true unless ensure_groonga_running
+        return false unless ensure_groonga_ready
+
+        setup_interrupt_shutdown
+
+        while(command = Readline.readline("groonga> ", true)) do
+          process_command(command)
+          exit(true) if GROONGA_SHUTDOWN_COMMANDS.include?(command)
+        end
+
+        shutdown_groonga
+      end
+    end
+
+    private
+
+    def parse_commandline_options(argv)
+      options_parser = GrnLine::OptionsParser.new
+      options_parser.parse(argv)
+    end
+
+    def generate_groonga_commandline
+      [@options.groonga, *@options.groonga_arguments]
+    end
+
+    def process_command(command)
+      raw_response = nil
+      begin
+        raw_response = read_groonga_response(command)
+      rescue => e
+        raise("Failed to access the groonga database: #{e.message}")
+      end
+
+      if raw_response and not raw_response.empty?
+        # TODO: support pretty print for formats except JSON
+        output_response(raw_response)
+      end
+    end
+
+    def read_groonga_response(command)
+      return nil if command.empty?
+      response = ""
+
+      @input.puts(command)
+      @input.flush
+
+      timeout = 1
+      while IO.select([@output], [], [], timeout)
+        break if @output.eof?
+        read_content = @output.readpartial(1024)
+        response << read_content
+        timeout = 0 if read_content.bytesize < 1024
+      end
+
+      response
+    end
+
+    def output_response(raw_response)
+      # TODO: support pretty print for formats except JSON
+      response = raw_response
+      if @options.pretty_print
+        begin
+          response = JSON.pretty_generate(JSON.parse(response))
+        rescue
+        end
+      end
+
+      if @options.output.instance_of?(String)
+        File.open(@options.output, "w") do |file|
+          file.puts(response)
+        end
+      else
+        @options.output.puts(response)
+      end
+    end
+
+    def execute(command)
+      @input.puts(command)
+      @input.flush
+      @output.gets
+    end
+
+    def shutdown_groonga
+      execute("shutdown")
+      @input.close
+    end
+
+    def setup_interrupt_shutdown
+      trap("INT") do
+        shutdown_groonga
+        exit(true)
+      end
+    end
+
+    def setup_input_completion
+      Readline.completion_proc = lambda do |word|
+        GROONGA_COMMANDS.grep(/\A#{Regexp.escape(word)}/)
+      end
+    end
+
+    def ensure_groonga_running
+      if IO.select([@output], nil, nil, 1) and not @output.eof?
+        puts(@output.read)
+        return false
+      end
+      return true
+    end
+
+    def ensure_groonga_ready
+      begin
+        execute("status")
+      rescue
+        if IO.select([@error], [], [], 0)
+          $stderr.puts(@error.read)
+          return false
+        end
+      end
+      return true
+    end
+  end
+end

data/lib/grnline.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+require "grnline/version"
+require "grnline/wrapper"
+

data/test/run-test.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+$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")
+
+require "test-unit"
+require "test/unit/notify"
+
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.unshift(base_dir)
+
+$LOAD_PATH.unshift(test_dir)
+
+Dir.glob("#{base_dir}/test/**/test{_,-}*.rb") do |file|
+  require file.gsub(/\.rb$/, "")
+end
+
+ENV["TEST_UNIT_MAX_DIFF_TARGET_STRING_SIZE"] ||= "5000"
+
+exit(Test::Unit::AutoRunner.run)

data/test/test-options-parser.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+require "grnline/options-parser"
+
+class OptionsParserTest < Test::Unit::TestCase
+  def setup
+    @parser = GrnLine::OptionsParser.new
+    @separator = [GrnLine::OptionsParser::SEPARATOR]
+  end
+
+  def test_pretty_print
+    argv = @separator + ["--no-pretty-print"]
+    options = @parser.parse(argv)
+
+    assert_options(options, :pretty_print => false)
+  end
+
+  def test_separator_in_both_arguments
+    groonga_arguments = ["-n", "db/db"]
+    argv = groonga_arguments + @separator + ["--output", "output_path"]
+    options = @parser.parse(argv)
+
+    assert_options(options,
+                   :output => "output_path",
+                   :groonga_arguments => groonga_arguments)
+  end
+
+  def test_separator_with_grnline_arguments_only
+    argv = @separator + ["--output", "output_path"]
+    options = @parser.parse(argv)
+
+    assert_options(options, :output => "output_path")
+  end
+
+  def test_separator_with_groonga_arguments_only
+    argv = ["-n", "db/db"]
+    options = @parser.parse(argv)
+    assert_options(options, :groonga_arguments => argv)
+  end
+
+  def test_no_arguments
+    argv = []
+    options = @parser.parse(argv)
+    assert_options(options, {})
+  end
+
+  private
+
+  def assert_options(options, expected_options)
+    output = expected_options[:output] || $stdout
+    groonga_arguments = expected_options[:groonga_arguments] || []
+    pretty_print = expected_options[:pretty_print]
+    pretty_print = true if pretty_print.nil?
+
+    assert_equal(output, options.output)
+    assert_equal(groonga_arguments, options.groonga_arguments)
+    assert_equal(pretty_print, options.pretty_print)
+  end
+end

data/test/test-wrapper.rb

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+
+require "grnline/wrapper"
+require "stringio"
+require "ostruct"
+
+class TestWrapper < Test::Unit::TestCase
+  def setup
+    @grnline = GrnLine::Wrapper.new
+    @grnline.options = OpenStruct.new
+    @output = StringIO.new
+  end
+
+  class OutputResponseTest < self
+    def test_prerry_print
+      @grnline.options.pretty_print = true
+      @grnline.options.output = @output
+
+      @grnline.send(:output_response, raw_response)
+      assert_equal(pretty_response, @output.string)
+    end
+
+    def test_no_prerry_print
+      @grnline.options.pretty_print = false
+      @grnline.options.output = @output
+
+      @grnline.send(:output_response, raw_response)
+      assert_equal(raw_response, @output.string)
+    end
+  end
+
+  def raw_response
+    <<-RESPONSE
+[[0,1369743525.62977,9.20295715332031e-05],{"alloc_count":129,"starttime":1369743522,"uptime":3,"version":"3.0.1","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
+    RESPONSE
+  end
+
+  def pretty_response
+    <<-RESPONSE
+[
+  [
+    0,
+    1369743525.62977,
+    9.20295715332031e-05
+  ],
+  {
+    "alloc_count": 129,
+    "starttime": 1369743522,
+    "uptime": 3,
+    "version": "3.0.1",
+    "n_queries": 0,
+    "cache_hit_rate": 0.0,
+    "command_version": 1,
+    "default_command_version": 1,
+    "max_command_version": 2
+  }
+]
+    RESPONSE
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: grnline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Haruka Yoshihara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: packnga
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-notify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'GrnLine is created by Ruby.
+
+  This uses [grnwrap](https://github.com/michisu/grnwrap) as a
+
+  reference. grnwrap is created by Python.
+
+'
+email:
+- yshr04hrk@gmail.com
+executables:
+- grnline
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE.txt
+- TODO
+- Rakefile
+- Gemfile
+- grnline.gemspec
+- lib/grnline/options-parser.rb
+- lib/grnline/version.rb
+- lib/grnline/wrapper.rb
+- lib/grnline.rb
+- doc/text/news.md
+- test/run-test.rb
+- test/test-options-parser.rb
+- test/test-wrapper.rb
+- bin/grnline
+homepage: 
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1192488674147790038
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1192488674147790038
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: GrnLine is the wrapper for the interactive mode of [groonga](http://groonga.org/).
+test_files:
+- test/run-test.rb
+- test/test-options-parser.rb
+- test/test-wrapper.rb
+has_rdoc: