grnline 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44d56d43a90369f18d1aa19fdc07bf421dcecf5e
+  data.tar.gz: 5bbe730053f6f9f9e7f078c092db8f18ccda8329
+SHA512:
+  metadata.gz: 0c52903b18b55ae289e9230148741617add595ce573f552e7290c7694fd7a4198a4d66c39b60574e3c7df535d694995aa6fb3ee6d0c393a8f2911ff642ae4407
+  data.tar.gz: cf0c35b7c52faadc58414278d4fd5fd93934e075dbdd3b556ae8de1887517ff47c88ebe91bbad34c0fcb8ac93dbade18ba81ca76c2dc9d2f7c7b9f993155885e

data/README.md

@@ -1,5 +1,7 @@
 # Grnline
 
+[![Build Status](https://travis-ci.org/yoshihara/grnline.png?branch=master)](https://travis-ci.org/yoshihara/grnline)
+
 ## Description
 
 GrnLine is the wrapper for the interactive mode of [groonga](http://groonga.org/).

data/doc/text/news.md

@@ -1,5 +1,19 @@
 # News
 
+## <a id="0-0-3">0.0.3</a>: 2013-11-23
+
+### Improvements
+
+* Showed the build status image in Travis-CI.
+* Added groonga's command parameters (e.g. "--name", "--table", "--output_columns"...) to the completion list.
+* Added groonga's function (e.g. "now", "rand", "geo_distance"...) to the completion list.
+* Supported command history. It is stored to the file "ENV['HOME']/.grnline-history".
+* Added "*" in command-line prefix when you typed a continuous command.
+
+### Changes
+
+* Removed "groonga" string from command-line prefix.
+
 ## <a id="0-0-2">0.0.2</a>: 2013-05-31
 
 ### Improvements

data/grnline.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   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("test-unit-notify")
   spec.add_development_dependency("redcarpet")
 end

data/lib/grnline/history.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+
+module GrnLine
+  class History
+    attr_reader :lines
+
+    def initialize(file)
+      @history_file = file
+      @lines = []
+    end
+
+    def load
+      @lines = read
+      Readline::HISTORY.push(*@lines)
+    end
+
+    def save
+      saved_history = read
+      return if saved_history == @lines
+
+      new_history = (@lines + saved_history).uniq
+
+      File.open(@history_file, "w") do |file|
+        file.print(new_history.join("\n"))
+      end
+    end
+
+    def store(line)
+      @lines << line
+    end
+
+    private
+
+    def read
+      return [] unless File.exist?(@history_file)
+      File.readlines(@history_file).collect {|line| line.chomp}
+    end
+  end
+end

data/lib/grnline/options-parser.rb

@@ -14,7 +14,7 @@ module GrnLine
       @options.pager = "less"
       @options.groonga_arguments = []
       @options.output = $stdout
-      @options.pretty_print = true
+      @options.use_pretty_print = true
     end
 
     def parse(argv)
@@ -60,8 +60,8 @@ module GrnLine
 
       parser.on("-p", "--[no-]pretty-print",
                 "Pretty print responses from groonga.",
-                "(#{@options.pretty_print})") do |pretty_print|
-        @options.pretty_print = pretty_print
+                "(#{@options.use_pretty_print})") do |use_pretty_print|
+        @options.use_pretty_print = use_pretty_print
       end
 
       # TODO: supports pager for displaying results from groonga

data/lib/grnline/version.rb

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

data/lib/grnline/wrapper.rb

@@ -4,6 +4,7 @@ require "readline"
 require "json"
 require "open3"
 require "grnline/options-parser"
+require "grnline/history"
 
 module GrnLine
   class Wrapper
@@ -17,8 +18,32 @@ module GrnLine
       "table_create", "table_list", "table_remove", "table_rename",
       "tokenize", "truncate"
     ]
+
+    GROONGA_VARIABLES = [
+      "--cache", "--columns", "--default_tokenizer", "--drilldown",
+      "--drilldown_limit", "--drilldown_offset",
+      "--drilldown_output_columns", "--drilldown_sortby", "--each",
+      "--filter", "--flags", "--id", "--ifexists", "--input_type",
+      "--key", "--key_type", "--level", "--limit", "--match_columns",
+      "--match_escalation_threshold", "--max", "--message", "--name",
+      "--new_name", "--normalizer", "--obj", "--offset",
+      "--output_columns", "--path", "--query", "--query_expander",
+      "--query_expansion", "--query_flags", "--scorer", "--seed",
+      "--sortby", "--source", "--string", "--table", "--tables",
+      "--target_name", "--threshold", "--tokenizer", "--type",
+      "--value_type", "--values"
+    ]
+
+    GROONGA_FUNCTIONS = [
+      "all_records", "edit_distance", "geo_distance", "geo_distance2",
+      "geo_distance3", "geo_in_circle", "geo_in_rectangle", "max",
+      "min", "now", "query", "rand", "snippet_html", "sub_filter"
+    ]
+
     GROONGA_SHUTDOWN_COMMANDS = ["quit", "shutdown"]
 
+    HISTORY_FILE = File.join(ENV["HOME"], ".grnline-history")
+
     class << self
       def run(argv)
         new.run(argv)
@@ -27,6 +52,8 @@ module GrnLine
 
     def initialize
       @options = nil
+      @history = GrnLine::History.new(HISTORY_FILE)
+      @commandline_prefix = ""
       setup_input_completion
     end
 
@@ -42,12 +69,18 @@ module GrnLine
 
         setup_interrupt_shutdown
 
-        while(command = Readline.readline("groonga> ", true)) do
+        command = nil
+        @history.load
+
+        while(command = Readline.readline("#{@commandline_prefix}> ", true)) do
+          @history.store(Readline::HISTORY.to_a.last)
           process_command(command)
-          exit(true) if GROONGA_SHUTDOWN_COMMANDS.include?(command)
+          break if GROONGA_SHUTDOWN_COMMANDS.include?(command)
         end
 
-        shutdown_groonga
+        shutdown_groonga unless GROONGA_SHUTDOWN_COMMANDS.include?(command)
+        @history.save
+        true
       end
     end
 
@@ -72,7 +105,10 @@ module GrnLine
 
       if raw_response and not raw_response.empty?
         # TODO: support pretty print for formats except JSON
+        @commandline_prefix = ""
         output_response(raw_response)
+      else
+        @commandline_prefix = "*"
       end
     end
 
@@ -97,19 +133,23 @@ module GrnLine
     def output_response(raw_response)
       # TODO: support pretty print for formats except JSON
       response = raw_response
-      if @options.pretty_print
+      if @options.use_pretty_print
         begin
           response = JSON.pretty_generate(JSON.parse(response))
         rescue
         end
       end
 
+      output(response)
+    end
+
+    def output(object)
       if @options.output.instance_of?(String)
         File.open(@options.output, "w") do |file|
-          file.puts(response)
+          file.puts(object)
         end
       else
-        @options.output.puts(response)
+        @options.output.puts(object)
       end
     end
 
@@ -127,19 +167,21 @@ module GrnLine
     def setup_interrupt_shutdown
       trap("INT") do
         shutdown_groonga
+        @history.save
         exit(true)
       end
     end
 
     def setup_input_completion
       Readline.completion_proc = lambda do |word|
-        GROONGA_COMMANDS.grep(/\A#{Regexp.escape(word)}/)
+        completions = (GROONGA_COMMANDS + GROONGA_VARIABLES + GROONGA_FUNCTIONS)
+        completions.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)
+        output(@output.read)
         return false
       end
       return true

data/test/bin/fake-groonga.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+case ARGV.first
+when "not-running"
+  puts("not-running")
+  exit(false)
+
+when "status"
+  output = ARGV.last
+  case output
+  when "true"
+    puts("status")
+    exit(true)
+  when "false"
+    STDERR.puts("status")
+    exit(false)
+  end
+
+else
+  puts $stdin.gets.chomp
+end

data/test/run-test.rb

@@ -8,6 +8,7 @@ lib_dir = File.join(base_dir, "lib")
 test_dir = File.join(base_dir, "test")
 
 require "test-unit"
+require "test/unit/rr"
 require "test/unit/notify"
 
 $LOAD_PATH.unshift(lib_dir)

data/test/test-history.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+require "grnline/history"
+require "tempfile"
+
+class TestHistory < Test::Unit::TestCase
+  def setup
+    @file = Tempfile.new("history")
+    @file.print(history)
+    @file.close
+    @history = GrnLine::History.new(@file.path)
+  end
+
+  def teardown
+    @file.close!
+  end
+
+  def test_load
+    @history.load
+    history_lines = history.split("\n")
+    assert_equal(history_lines, @history.lines)
+    assert_equal(history_lines, Readline::HISTORY.to_a)
+  end
+
+  def test_store
+    @history.store("test_command")
+
+    assert_equal(["test_command"], @history.lines)
+  end
+
+  def test_save
+    test_store
+
+    @history.save
+    expected_history = history + "test_command"
+
+    @file.open do |file|
+      assert_equal(expected_history, file.read)
+    end
+  end
+
+  def history
+    <<HISTORY
+table_list
+table_create SHOW
+column_create --table SHOW --name title --type ShortText
+select SHOW
+HISTORY
+  end
+end

data/test/test-options-parser.rb

@@ -12,7 +12,7 @@ class OptionsParserTest < Test::Unit::TestCase
     argv = @separator + ["--no-pretty-print"]
     options = @parser.parse(argv)
 
-    assert_options(options, :pretty_print => false)
+    assert_options(options, :use_pretty_print => false)
   end
 
   def test_separator_in_both_arguments
@@ -49,11 +49,11 @@ class OptionsParserTest < Test::Unit::TestCase
   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?
+    use_pretty_print = expected_options[:use_pretty_print]
+    use_pretty_print = true if use_pretty_print.nil?
 
     assert_equal(output, options.output)
     assert_equal(groonga_arguments, options.groonga_arguments)
-    assert_equal(pretty_print, options.pretty_print)
+    assert_equal(use_pretty_print, options.use_pretty_print)
   end
 end

data/test/test-wrapper.rb

@@ -2,18 +2,91 @@
 
 require "grnline/wrapper"
 require "stringio"
+require "tempfile"
 require "ostruct"
 
 class TestWrapper < Test::Unit::TestCase
   def setup
     @grnline = GrnLine::Wrapper.new
     @grnline.options = OpenStruct.new
-    @output = StringIO.new
+  end
+
+  class RunTest < self
+    def setup
+      super
+      fake_groonga = File.join(File.dirname(__FILE__), "bin",
+                                "fake-groonga.rb")
+      @stdout = Tempfile.new("output")
+      @grnline_arguments = [
+        "--groonga", fake_groonga,
+        "--output",  @stdout.path
+      ]
+    end
+
+    private
+
+    def generate_argv(arguments)
+      arguments + [GrnLine::OptionsParser::SEPARATOR] + @grnline_arguments
+    end
+
+    def stdout_output
+      File.read(@stdout)
+    end
+
+    public
+
+    def test_not_running
+      argv = generate_argv(["not-running"])
+
+      assert_true(@grnline.run(argv))
+      assert_equal("not-running\n", stdout_output)
+    end
+
+    def test_ready
+      argv = generate_argv(["status", "true"])
+
+      assert_true(@grnline.run(argv))
+      assert_equal("status\n", stdout_output)
+    end
+
+    def test_not_ready
+      old_stderr = $stderr.dup
+      stderr = StringIO.new
+      $stderr = stderr
+
+      argv = generate_argv(["status", "false"])
+
+      assert_false(@grnline.run(argv))
+      assert_empty(stdout_output)
+      assert_equal("status\n", stderr.string)
+
+      $stderr = old_stderr
+    end
+
+    def test_running
+      description = "The_quit_commands_exits_running_groonga."
+      argv = generate_argv([])
+      mock(Readline).readline("> ", true) do
+        "quit"
+      end
+      mock(@grnline).process_command("quit") do
+        @stdout.puts(description)
+        @stdout.flush
+      end
+
+      assert_true(@grnline.run(argv))
+      assert_equal("#{description}\n", stdout_output)
+    end
   end
 
   class OutputResponseTest < self
+    def setup
+      super
+      @output = StringIO.new
+    end
+
     def test_prerry_print
-      @grnline.options.pretty_print = true
+      @grnline.options.use_pretty_print = true
       @grnline.options.output = @output
 
       @grnline.send(:output_response, raw_response)
@@ -21,7 +94,7 @@ class TestWrapper < Test::Unit::TestCase
     end
 
     def test_no_prerry_print
-      @grnline.options.pretty_print = false
+      @grnline.options.use_pretty_print = false
       @grnline.options.output = @output
 
       @grnline.send(:output_response, raw_response)

metadata

@@ -1,135 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: grnline
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Haruka Yoshihara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-11-23 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-rr
+  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: 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.
-
+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:
@@ -143,48 +139,46 @@ files:
 - Rakefile
 - Gemfile
 - grnline.gemspec
+- lib/grnline/history.rb
 - lib/grnline/options-parser.rb
 - lib/grnline/version.rb
 - lib/grnline/wrapper.rb
 - lib/grnline.rb
 - doc/text/news.md
+- test/bin/fake-groonga.rb
 - test/run-test.rb
+- test/test-history.rb
 - test/test-options-parser.rb
 - test/test-wrapper.rb
 - bin/grnline
 homepage: 
 licenses:
 - MIT
+metadata: {}
 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: 855349197423195369
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 855349197423195369
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: GrnLine is the wrapper for the interactive mode of [groonga](http://groonga.org/).
 test_files:
+- test/bin/fake-groonga.rb
 - test/run-test.rb
+- test/test-history.rb
 - test/test-options-parser.rb
 - test/test-wrapper.rb
 has_rdoc: