grn_mini 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 954b7ebeb13d40913ed6022a6b96d972193b73ea
-  data.tar.gz: c64cf4de87e4cf59b172fb1b4d5c64d7f8f17e12
+  metadata.gz: a3573d54bbab536ecc6429349a5326bce7f07e6b
+  data.tar.gz: e8d6c8f86a4b732aea1d84f6aee06ab8521fda97
 SHA512:
-  metadata.gz: 0406c079b5f1fac34c4f35de6e0ca59b1236df413b285ec28d529c054e1e08f1558f03712b24c37d2dba53f843e219db3ecc37e3d3ea33143faf4121c50b6fb1
-  data.tar.gz: 747fe7c71d88f786229ad7461639b9ff4de8cee0bc73e27aff73ce3301c98659311173517434b98b857b91bbbace9aabb084ee3900c968fd828bad8531d43af3
+  metadata.gz: a7471f3cf1a8e784d1aad28d94d84f174aa19fb31a570d4a9b6e2dfd339a15e33341e39c43e0b14134db64deafb05fdc2cca51feded94a679df8179f01bc60bc
+  data.tar.gz: b0ecedae697ebc81e318c815488188db3744b87bac42fc91970b46b41c7158bf3cac1194784d058f8d8b3794eb1d9cf3bbd86d742535c33eaeaee3fea3eb26f7

data/HISTORY.md

@@ -0,0 +1,45 @@
+# HISTORY - grn_mini
+
+## 0.4 - 2014/02/01
+
+- GrnMini
+  - Add GrnMini::create_or_open(db_name)
+  - Add GrnMini::tmpdb
+
+- GrnMini::Table
+  - Extract common function of Array and Hash
+    - Array < Table
+    - Hash < Table
+  - Add Table#setup_columns
+    - Specification of column types explicitly
+    - Support cross-reference between table
+  - Support new column type
+    - VECTOR_COLUMN
+    - GrnMini::Table, Groonga::Table (with define_index_column)
+    - "BOOL"
+  - GrnMini::Table#select
+    - Support block argument
+    - Quit the support of {default_column: "text”}
+
+- GrnMini::Array
+  - Array.new(database_name) -> Array.new(table_name)
+  - Remove Array::tmpdb
+
+- GrnMini::Hash
+  - Hash.new(database_name) -> Hash.new(table_name)
+  - Remove Hash::tmpdb
+
+- README.md
+  - Fix to the new API sample code
+
+## 0.3 - 2014/01/10
+
+- Support GrnMini::Hash
+
+## 0.2 - 2014/01/07
+
+- Support snippet
+
+## 0.1 - 2014/01/05
+
+- 1st Release

data/README.md

@@ -1,8 +1,16 @@
 # GrnMini
 
-Groonga(Rroonga) wrapper for use as the KVS.
-
-Groonga(Rroonga) for using easily. You can add the data in the column without specifying. You can easy to use and persistence, advanced search query, sort, grouping (drill down), snippets, and pagination. You can make an immediate search engine.
+Groonga(Rroonga) wrapper for using easily.
+
+- Automatic generation of the column with data type
+- Specification of column types explicitly
+- Advanced Search Query
+- Persistence
+- Sort
+- Grouping (Drill Down)
+- Snippets
+- Pagination
+- Cooperation between multiple tables
 
 ## Installation
 
@@ -14,7 +22,7 @@ Groonga(Rroonga) for using easily. You can add the data in the column without sp
 
 ```ruby
 require 'grn_mini'
-array = GrnMini::Array.new("test.db")
+GrnMini::create_or_open("test.db")
 ```
 
 ### Add the record with the number column and text column.
@@ -22,6 +30,7 @@ array = GrnMini::Array.new("test.db")
 Determine the column type when you first call "GrnMini::Array#add". (Add inverted index if data type is "string".)
 
 ```ruby
+array = GrnMini::Array.new
 array.add(text: "aaa", number: 1)
 ```
 
@@ -37,14 +46,16 @@ array.size  #=> 3
 
 ```ruby
 require 'grn_mini'
-array = GrnMini::Array.new("test.db")
+GrnMini::create_or_open("test.db")
+array = GrnMini::Array.new
 array.size   #=> 3
 ```
 
 ### Create a temporary database. (Useful for testing)
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
   array << {text: "aaa", number: 1}
   array << {text: "bbb", number: 2}
   array << {text: "ccc", number: 3}
@@ -56,8 +67,8 @@ end
 
 ```ruby
 require 'grn_mini'
-
-hash = GrnMini::Hash.new("test.db")
+GrnMini::create_or_open("test.db")
+hash = GrnMini::Hash.new
 
 # Add
 hash["a"] = {text:"aaa", number:1}
@@ -71,10 +82,57 @@ hash["b"].text       #=> "bbb"
 hash["b"].text = "BBB"
 ```
 
+## Specify table name.
+Default table name is "Array"(GrnMini::Array) or "Hash"(GrnMini::Hash).
+
+```ruby
+GrnMini::tmpdb do
+  array = GrnMini::Array.new("Users")
+  array << {text: "aaa", number: 1}
+end
+```
+
+## Specification of column types explicitly
+
+Use GrnMini::Table#setup_columns.
+
+```ruby
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
+  # Specify dummy data
+  array.setup_columns(filename: "",
+                      int:      0,
+                      float:    0.0,
+                      time:     Time.new,
+                      )
+                      
+  array << {filename: "a.txt", int: 1, float: 1.5, time: Time.at(1999)}
+end
+```
+
+The following is the same meaning.
+
+```ruby
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+  # Automatic generation of the column with data type
+  array << {filename: "a.txt", int: 1, float: 1.5, time: Time.at(1999)}
+end
+```
+
+GrnMini::Table#setup_columns is useful for below.
+
+- Specification of column types explicitly
+- Refer to itself
+- Cross-reference between tables
+  - See "Cooperation between multiple tables"
+
 ## Data Type
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
   array << {filename: "a.txt", int: 1, float: 1.5, time: Time.at(1999)}
   array << {filename: "b.doc", int: 2, float: 2.5, time: Time.at(2000)}
 
@@ -105,7 +163,8 @@ See also [8.4. Data type — Groonga documentation](http://groonga.org/docs/refe
 ```ruby
 require 'grn_mini'
 
-array = GrnMini::Array.new("test2.db")
+GrnMini::create_or_open("test2.db")
+array = GrnMini::Array.new
 array << {name:"Tanaka",  age: 11, height: 162.5}
 array << {name:"Suzuki",  age: 31, height: 170.0}
 ```
@@ -156,7 +215,9 @@ array.first.attributes  #=> {"_id"=>2, "age"=>31, "height"=>170.0, "name"=>"Haya
 It is also possible to pass the block.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {name:"Tanaka",  age: 11, height: 162.5}
   array << {name:"Suzuki",  age: 31, height: 170.0}
   array << {name:"Hayashi", age: 20, height: 165.0}
@@ -173,41 +234,44 @@ end
 ## Search
 
 Use GrnMini::Array#select method.
-`:text` column is set to the `:default_column` implicitly.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text:"aaa", number:1}
   array << {text:"bbb", number:20}
   array << {text:"bbb ccc", number:2}
   array << {text:"bbb", number:15}
   array << {text:"ccc", number:3}
 
-  results = array.select("aaa")
+  results = array.select("text:aaa")
   results.map {|record| record.attributes} #=> [{"_id"=>1, "_key"=>{"_id"=>1, "number"=>1, "text"=>"aaa"}, "_score"=>1}]
 
   # AND
-  results = array.select("bbb ccc")
+  results = array.select("text:@bbb text:@ccc")
   results.map {|record| record.attributes} #=> [{"_id"=>2, "_key"=>{"_id"=>3, "number"=>2, "text"=>"bbb ccc"}, "_score"=>2}]
 
   # Specify column
-  results = array.select("bbb number:<10")
+  results = array.select("text:@bbb number:<10")
   results.map {|record| record.attributes} #=> [{"_id"=>2, "_key"=>{"_id"=>3, "number"=>2, "text"=>"bbb ccc"}, "_score"=>2}]
 
   # AND, OR, Grouping
-  results = array.select("bbb (number:<= 10 OR number:>=20)")
+  results = array.select("text:@bbb (number:<= 10 OR number:>=20)")
   results.map {|record| record.attributes} #=> [{"_id"=>2, "_key"=>{"_id"=>3, "number"=>2, "text"=>"bbb ccc"}, "_score"=>2}, {"_id"=>4, "_key"=>{"_id"=>2, "number"=>20, "text"=>"bbb"}, "_score"=>2}]
 
   # NOT
-  results = array.select("bbb - ccc")
+  results = array.select("text:@bbb - text:@ccc")
   results.map {|record| record.attributes}  #=> [{"_id"=>1, "_key"=>{"_id"=>2, "number"=>20, "text"=>"bbb"}, "_score"=>1}, {"_id"=>3, "_key"=>{"_id"=>4, "number"=>15, "text"=>"bbb"}, "_score"=>1}]
 end 
 ```
 
-Change `:default_column` to `:filename` column.
+Use `:default_column` option.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text: "txt", filename:"a.txt"}
   array << {text: "txt", filename:"a.doc"}
   array << {text: "txt", filename:"a.rb"}
@@ -229,7 +293,9 @@ See also [8.10.1. Query syntax](http://groonga.org/docs/reference/grn_expr/query
 Specify column name to sort.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {name:"Tanaka",  age: 11, height: 162.5}
   array << {name:"Suzuki",  age: 31, height: 170.0}
   array << {name:"Hayashi", age: 21, height: 175.4}
@@ -263,7 +329,9 @@ sorted.map {|r| {name: r.name, age: r.age}}
 Drill down aka.
 
 ```ruby
-GrnMini::Array.tmpdb do |array| 
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text:"aaaa.txt", suffix:"txt", type:1}
   array << {text:"aaaa.doc", suffix:"doc", type:2}
   array << {text:"aabb.txt", suffix:"txt", type:2}
@@ -279,13 +347,15 @@ end
 Grouping from selection results.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text:"aaaa", suffix:"txt"}
   array << {text:"aaaa", suffix:"doc"}
   array << {text:"aaaa", suffix:"txt"}
   array << {text:"cccc", suffix:"txt"}
 
-  results = array.select("aa")
+  results = array.select("text:@aa")
   groups = GrnMini::Util::group_with_sort(results, "suffix")
 
   groups.size                               #=> 2
@@ -300,7 +370,9 @@ Display of keyword surrounding text. It is often used in search engine.
 Use `GrnMini::Util::text_snippet_from_selection_results`.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text: <<EOF, filename: "aaa.txt"}
 [1] This is a pen pep pea pek pet.
 ------------------------------
@@ -314,7 +386,7 @@ GrnMini::Array.tmpdb do |array|
 ------------------------------
 EOF
 
-  results = array.select("This pen")
+  results = array.select("text:@This pen")
   snippet = GrnMini::Util::text_snippet_from_selection_results(results)
 
   record = results.first
@@ -328,14 +400,16 @@ end
 `GrnMini::Util::html_snippet_from_selection_results` is HTML escaped.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text: <<EOF, filename: "aaa.txt"}
 <html>
   <div>This is a pen pep pea pek pet.</div>
 </html>
 EOF
 
-  results = array.select("This pen")
+  results = array.select("text:@This pen")
   snippet = GrnMini::Util::html_snippet_from_selection_results(results, '<span class="strong">', '</span>') # Default value is '<strong>', '</strong>'
 
   record = results.first
@@ -352,7 +426,9 @@ See also [Groonga::Expression#snippet](http://ranguba.org/rroonga/en/Groonga/Exp
  #paginate is more convenient than #sort if you want a pagination.
 
 ```ruby
-GrnMini::Array.tmpdb do |array|
+GrnMini::tmpdb do
+  array = GrnMini::Array.new
+
   array << {text: "aaaa", filename: "1.txt"}
   array << {text: "aaaa aaaa", filename: "2a.txt"}
   array << {text: "aaaa aaaa aaaa", filename: "3.txt"}
@@ -362,7 +438,7 @@ GrnMini::Array.tmpdb do |array|
   array << {text: "aaaa aaaa", filename: "2e.txt"}
   array << {text: "aaaa aaaa", filename: "2f.txt"}
 
-  results = array.select("aaaa")
+  results = array.select("text:@aaaa")
 
   # -- page1 --
   page_entries = results.paginate([["_score", :desc]], :page => 1, :size => 5)
@@ -395,3 +471,38 @@ end
 
 See also [Groonga::Table#pagenate](http://ranguba.org/rroonga/en/Groonga/Table.html#paginate-instance_method)
 
+## Cooperation between multiple tables
+
+Micro blog sample.
+
+```ruby
+GrnMini::tmpdb do
+  users = GrnMini::Hash.new("Users")
+  articles = GrnMini::Hash.new("Articles")
+
+  users.setup_columns(name: "", favorites: [articles])
+  articles.setup_columns(author: users, text: "")
+
+  users["aaa"] = {name: "Mr.A"}
+  users["bbb"] = {name: "Mr.B"}
+  users["ccc"] = {name: "Mr.C"}
+
+  articles["aaa:1"] = {author: "aaa", text: "111"}
+  articles["aaa:2"] = {author: "aaa", text: "222"}
+  articles["aaa:3"] = {author: "aaa", text: "333"}
+  articles["bbb:1"] = {author: "bbb", text: "111"}
+  articles["bbb:2"] = {author: "bbb", text: "222"}
+  articles["ccc:1"] = {author: "ccc", text: "111"}
+
+  users["aaa"].favorites = ["aaa:1", "bbb:2"]
+  users["bbb"].favorites = ["aaa:2"]
+  users["ccc"].favorites = ["aaa:1", "bbb:1", "ccc:1"]
+
+  # Search record.favorites
+  users.select { |record| record.favorites == "aaa:1" }    #=> ["aaa", "ccc"]
+  users.select { |record| record.favorites == "aaa:2" }  #=> ["bbb"]
+
+  # Search record.favorites.text
+  users.select { |record| record.favorites.text =~ "111" } #=> ["aaa", "ccc"]
+end
+```

data/lib/grn_mini.rb

@@ -2,7 +2,24 @@ require "grn_mini/version"
 require "grn_mini/array"
 require "grn_mini/hash"
 require "grn_mini/util"
+require 'groonga'
+require 'tmpdir'
 
 module GrnMini
-  # Your code goes here...
+  module_function
+
+  def create_or_open(path)
+    unless File.exist?(path)
+      Groonga::Database.create(path: path)
+    else
+      Groonga::Database.open(path)
+    end
+  end
+
+  def tmpdb
+    Dir.mktmpdir do |dir|
+      create_or_open(File.join(dir, "tmp.db"))
+      yield
+    end
+  end
 end

data/lib/grn_mini/array.rb

@@ -1,81 +1,23 @@
-require 'grn_mini/util'
-require 'groonga'
-require 'tmpdir'
+require 'grn_mini/table'
 
 module GrnMini
-  class Array
-    attr_accessor :grn
-    include Enumerable
+  class NotSupportColumnType < RuntimeError; end
 
-    def self.tmpdb
-      Dir.mktmpdir do |dir|
-        # p dir
-        yield self.new(File.join(dir, "tmp.db"))
-      end
-    end
-
-    def initialize(path)
-      unless File.exist?(path)
-        Groonga::Database.create(path: path)
-      else
-        Groonga::Database.open(path)
-      end
-
-      unless Groonga["Array"]
-        @grn = Groonga::Array.create(name: "Array", persistent: true) 
-        @terms = Groonga::PatriciaTrie.create(name: "Terms", key_normalize: true, default_tokenizer: "TokenBigramSplitSymbolAlphaDigit")
-      else
-        @grn = Groonga["Array"]
-        @terms = Groonga["Terms"]
-      end
+  class Array < Table
+    def initialize(name = "Array")
+      super(name,
+            Groonga[name] || Groonga::Array.create(name: name, persistent: true))
     end
 
     def add(hash)
-      if @grn.empty?
-        hash.each do |key, value|
-          column = key.to_s
-
-          # @todo Need define_index_column ?
-          if value.is_a?(Time)
-            @grn.define_column(column, "Time")
-          elsif value.is_a?(Float)
-            @grn.define_column(column, "Float")
-          elsif value.is_a?(Numeric)
-            @grn.define_column(column, "Int32")
-          else
-            @grn.define_column(column, "ShortText")
-            @terms.define_index_column("array_#{column}", @grn, source: "Array.#{column}", with_position: true)
-          end
-        end
-      end
-      
+      setup_columns(hash) unless @setup_columns_once
       @grn.add(hash)
     end
 
     alias << add
 
-    def select(query, options = {default_column: "text"})
-      @grn.select(query, options)
-    end
-
-    def size
-      @grn.size
-    end
-
-    alias length size
-
-    def empty?
-      size == 0
-    end
-
-    def each
-      @grn.each do |record|
-        yield record
-      end
-    end
-
     class IdIsGreaterThanZero < RuntimeError; end
-
+    
     def [](id)
       raise IdIsGreaterThanZero if id == 0
       @grn[id]
@@ -89,13 +31,5 @@ module GrnMini
         @grn.delete(id)
       end
     end
-
-    def sort(keys, options = {})
-      @grn.sort(keys, options)
-    end
-
-    def group(key, options = {})
-      @grn.group(key, options)
-    end
   end
 end