activegroonga 1.0.4 → 1.0.5

data/README.textile

@@ -0,0 +1,55 @@
+h1. README
+
+h2. Name
+
+ActiveGroonga
+
+h2. Description
+
+A library to use groonga with ActiveRecord like API.
+
+groonga provides both of full text search and column store
+features. ActiveGroonga + groonga can be used as an
+alternative of ActiveRecord + RDB.
+
+ActiveGroonga is based on rroonga. See the following URLs
+about rroonga and groonga.
+
+* "rroonga":http://groonga.rubyforge.org/
+* "groonga":http://groonga.org/
+
+h2. Authors
+
+* Kouhei Sutou <kou@clear-code.com>
+
+h2. License
+
+LGPL 2.1. See license/LGPL for details.
+
+(Kouhei Sutou has a right to change license inclidng
+contributed patches.)
+
+h2. Dependencies
+
+* rroonga
+
+h2. Install
+
+<pre>
+!!!command_line
+% sudo gem install activegroonga
+</pre>
+
+h2. Documents
+
+* "Reference manual in English":http://groonga.rubyforge.org/rroonga/en/
+* "Reference manual in Japanese":http://groonga.rubyforge.org/rroonga/ja/
+
+h2. Mailing list
+
+* English: "groonga-users-en":http://rubyforge.org/mailman/listinfo/groonga-users-en
+* Japanese: "groonga-dev":http://lists.sourceforge.jp/mailman/listinfo/groonga-dev
+
+h2. Thanks
+
+* ...

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- coding: utf-8; mode: ruby -*-
 #
-# Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2009-2011  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
@@ -17,199 +17,79 @@
 
 require 'English'
 
-require 'find'
-require 'fileutils'
 require 'pathname'
-require 'erb'
 require 'rubygems'
-if RUBY_VERSION < "1.9"
-  gem 'rdoc'
-end
-require 'hoe'
-
-ENV["NODOT"] = "yes"
+require 'rubygems/package_task'
+require "jeweler"
+require "packnga"
 
-base_dir = File.join(File.dirname(__FILE__))
-truncate_base_dir = Proc.new do |x|
-  x.gsub(/^#{Regexp.escape(base_dir + File::SEPARATOR)}/, '')
-end
+base_dir = Pathname.new(__FILE__).dirname.expand_path
 
-@rroonga_base_dir = File.expand_path(File.join(base_dir, '..', 'rroonga'))
-rroonga_ext_dir = File.join(@rroonga_base_dir, 'ext', "groonga")
-rroonga_lib_dir = File.join(@rroonga_base_dir, 'lib')
-$LOAD_PATH.unshift(rroonga_ext_dir)
-$LOAD_PATH.unshift(rroonga_lib_dir)
+@rroonga_base_dir = base_dir.parent.expand_path + 'rroonga'
+rroonga_ext_dir = @rroonga_base_dir + 'ext' + "groonga"
+rroonga_lib_dir = @rroonga_base_dir + 'lib'
+$LOAD_PATH.unshift(rroonga_ext_dir.to_s)
+$LOAD_PATH.unshift(rroonga_lib_dir.to_s)
 ENV["RUBYLIB"] = "#{rroonga_lib_dir}:#{rroonga_ext_dir}:#{ENV['RUBYLIB']}"
 
-active_groonga_lib_dir = File.join(base_dir, "lib")
-$LOAD_PATH.unshift(active_groonga_lib_dir)
+active_groonga_lib_dir = base_dir + "lib"
+$LOAD_PATH.unshift(active_groonga_lib_dir.to_s)
 
 def guess_version
   require 'active_groonga/version'
   ActiveGroonga::VERSION::STRING
 end
 
-manifest = File.join(base_dir, "Manifest.txt")
-manifest_contents = []
-base_dir_included_components = %w(AUTHORS
-                                  NEWS.rdoc NEWS.ja.rdoc
-                                  README.rdoc README.ja.rdoc
-                                  Rakefile extconf.rb)
-excluded_components = %w(.cvsignore .gdb_history CVS depend Makefile pkg
-                         .git .svn doc vendor .test-result)
-excluded_suffixes = %w(.png .ps .pdf .o .so .a .txt .~)
-Find.find(base_dir) do |target|
-  target = truncate_base_dir[target]
-  components = target.split(File::SEPARATOR)
-  if components.size == 1 and !File.directory?(target)
-    next unless base_dir_included_components.include?(components[0])
-  end
-  Find.prune if (excluded_components - components) != excluded_components
-  next if excluded_suffixes.include?(File.extname(target))
-  manifest_contents << target if File.file?(target)
-end
-
-File.open(manifest, "w") do |f|
-  f.puts manifest_contents.sort.join("\n")
-end
-
-# For Hoe's no user friendly default behavior. :<
-File.open("README.txt", "w") {|file| file << "= Dummy README\n== XXX\n"}
-FileUtils.cp("NEWS.rdoc", "History.txt")
-at_exit do
-  FileUtils.rm_f("README.txt")
-  FileUtils.rm_f("History.txt")
-  FileUtils.rm_f(manifest)
-end
-
 def cleanup_white_space(entry)
   entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
 end
 
 ENV["VERSION"] ||= guess_version
 version = ENV["VERSION"].dup
-project = nil
-Hoe.spec('activegroonga') do |_project|
-  Hoe::Test::SUPPORTED_TEST_FRAMEWORKS[:testunit2] = "test/run-test.rb"
-  project = _project
-  project.version = version
-  project.rubyforge_name = 'groonga'
-  authors = File.join(base_dir, "AUTHORS")
-  project.author = File.readlines(authors).collect do |line|
-    if /\s*<[^<>]*>$/ =~ line
-      $PREMATCH
-    else
-      nil
-    end
-  end.compact
-  project.email = ['groonga-users-en@rubyforge.org',
-                   'groonga-dev@lists.sourceforge.jp']
-  project.url = 'http://groonga.rubyforge.org/'
-  project.testlib = :testunit2
-  project.test_globs = ["test/run-test.rb"]
-  project.spec_extras = {
-    :extra_rdoc_files => Dir.glob("*.rdoc"),
-  }
-  project.readme_file = "README.ja.rdoc"
-  project.extra_deps = [["rroonga", ">= 1.0.4"],
-                        ["activemodel", ">= 3.0.1"]]
-
-  news_of_current_release = File.read("NEWS.rdoc").split(/^==\s.*$/)[1]
-  project.changes = cleanup_white_space(news_of_current_release)
-
-  entries = File.read("README.rdoc").split(/^==\s(.*)$/)
+spec = nil
+Jeweler::Tasks.new do |_spec|
+  spec = _spec
+  spec.name = "activegroonga"
+  spec.version = version
+  spec.rubyforge_project = "groonga"
+  spec.homepage = "http://groonga.rubyforge.org/"
+  spec.authors = ["Kouhei Sutou"]
+  spec.email = ["kou@clear-code.com"]
+  entries = File.read("README.textile").split(/^h2\.\s(.*)$/)
   description = cleanup_white_space(entries[entries.index("Description") + 1])
-  project.summary, project.description, = description.split(/\n\n+/, 3)
-
-  project.remote_rdoc_dir = "activegroonga"
-end
-
-project.spec.dependencies.delete_if {|dependency| dependency.name == "hoe"}
-
-ObjectSpace.each_object(Rake::RDocTask) do |rdoc_task|
-  options = rdoc_task.options
-  t_option_index = options.index("-t") || options.index("--title")
-  rdoc_task.options[t_option_index, 2] = nil
-  rdoc_task.title = "ActiveGroonga - #{version}"
-  rdoc_task.rdoc_files = Dir.glob("lib/**/*.rb")
-  rdoc_task.rdoc_files += Dir.glob("*.rdoc")
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "LGPLv2"
+  spec.files = FileList["{lib,test}/**/*.rb",
+                        "lib/**/railties/**/*.rake",
+                        "lib/**/locale/**/*.yml",
+                        "Rakefile",
+                        "README.textile",
+                        "doc/text/**/*"]
 end
 
-task :publish_docs => [:prepare_docs_for_publishing]
-
-
-include ERB::Util
-
-def apply_template(file, head, header, footer)
-  content = File.read(file)
-  content = content.sub(/lang="en"/, 'lang="ja"')
-
-  title = nil
-  content = content.sub(/<title>(.+?)<\/title>/) do
-    title = $1
-    head.result(binding)
-  end
-
-  content = content.sub(/<body(?:.*?)>/) do |body_start|
-    "#{body_start}\n#{header.result(binding)}\n"
-  end
-
-  content = content.sub(/<\/body/) do |body_end|
-    "\n#{footer.result(binding)}\n#{body_end}"
-  end
-
-  File.open(file, "w") do |file|
-    file.print(content)
-  end
+Rake::Task["release"].prerequisites.clear
+Jeweler::RubygemsDotOrgTasks.new do
 end
 
-def erb_template(name)
-  file = File.join(@rroonga_base_dir, "html", "#{name}.html.erb")
-  template = File.read(file)
-  erb = ERB.new(template, nil, "-")
-  erb.filename = file
-  erb
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar_gz = true
 end
 
-task :prepare_docs_for_publishing do
-  head = erb_template("head")
-  header = erb_template("header")
-  footer = erb_template("footer")
-  Find.find("doc") do |file|
-    if /\.html\z/ =~ file and /_(?:c|rb)\.html\z/ !~ file
-      apply_template(file, head, header, footer)
-    end
+Packnga::DocumentTask.new(spec) do |task|
+  task.yard do |yard_task|
+    yard_task.options += ["--exclude", "/templates/"]
+    yard_task.options += ["--markup", "textile"]
   end
-end
-
-namespace :backward_compatibility do
-  desc "Publish HTML for backward compatibility."
-  task :publish_html do
-    config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-    host = "#{config["username"]}@rubyforge.org"
-
-    rsync_args = "-av --exclude .svn --delete"
-    remote_dir = "/var/www/gforge-projects/#{project.rubyforge_name}/"
-    mkdir_p "active_groonga"
-    File.open("active_groonga/.htaccess", "w") do |htaccess|
-      htaccess.puts(<<-EOH)
-Redirect permanent / http://groonga.rubyforge.org/activegroonga/
-EOH
-    end
-    sh "rsync #{rsync_args} active_groonga/ #{host}:#{remote_dir}"
+  task.reference do |reference_task|
+    # reference_task.mode = "xhtml"
   end
 end
 
-desc "Tag the current revision."
-task :tag do
-  sh("git tag -a #{version} -m 'release #{version}!!!'")
+Packnga::ReleaseTask.new(spec) do |task|
 end
 
-desc "generate activegroonga.gemspec"
-task :generate_gemspec do
-  spec = project.spec
-  spec_name = File.join(base_dir, project.spec.spec_name)
-  File.open(spec_name, "w") do |spec_file|
-    spec_file.puts(spec.to_ruby)
-  end
+task :test do
+  ruby("test/run-test.rb")
 end
+
+task :default => :test

data/doc/text/news.textile

@@ -0,0 +1,60 @@
+h1. NEWS
+
+h2. 1.0.5: 2011-05-01
+
+h3. Improvements
+
+* Supported Rails 3.1.0.
+* groonga:seed showes seed candidate files on not found.
+* Used YARD.
+* Added {ActiveGroonga::Base.sort_keys}.
+* Added {ActiveGroonga::Base.limit}.
+
+h3. Fixes
+
+* Fixed groonga:seed dependency.
+
+h2. 1.0.4: 2011-04-01
+
+h3. Improvements
+
+* Supported Kaminari. (View interface only)
+
+h2. 1.0.3: 2010-12-25
+
+h3. Improvements
+
+* Supported score.
+
+h2. 1.0.1: 2010-11-29
+
+h3. Improvements
+
+* generator: Supported table type customize.
+* Added ActiveGroonga::Base.exists?.
+* Added ActiveGroonga::Base.all.
+
+h3. Changes
+
+* Changed to use record key instead of record ID for record
+  identifier for hash table and patricia trie.
+
+h2. 1.0.0: 2010-11-29
+
+* Support Rails 3.
+
+h2. 0.0.7: 2009-10-02
+
+* Support Ruby/groonga 0.0.7.
+
+h2. 0.0.6: 2009-07-31
+
+* Support Ruby/groonga 0.0.6.
+
+h2. 0.0.2: 2009-06-05
+
+* Support Ruby/groonga 0.0.2.
+
+h2. 0.0.1: 2009-04-30
+
+* Initial release!

data/doc/text/tutorial.textile

@@ -0,0 +1,3 @@
+h1. Tutorial
+
+Comming soon...

data/lib/active_groonga/base.rb

@@ -38,6 +38,45 @@ module ActiveGroonga
     @@encoding = "utf8"
     cattr_reader :encoding, :instance_reader => false
 
+    # The default sort keys for {ResultSet#sort} and
+    # {ResultSet#paginate}.
+    #
+    # @scope class
+    # @attribute [rw] sort_keys
+    # @return [Array<Array<String, Symbol>>] An array of
+    #   sort key. Each sort key is an array of sort key
+    #   column name and order.
+    # @example
+    #   # Sorts by "name" column value in ascending order by default.
+    #   User.sort_keys = [["name", :ascending]]
+    #
+    #   # Sorts by "name" column value in ascending order and
+    #   # sorts by "age" column value in descending order for
+    #   # the same name records by default.
+    #   User.sort_keys = [["name", :ascending], ["age", :descending]]
+    #
+    #   # Sorts by id value in ascending order by default.
+    #   User.sort_keys = nil
+    #
+    # @since 1.0.5
+    class_attribute :sort_keys
+
+    # The default limit for {ResultSet#sort} and
+    # {ResultSet#paginate}.
+    #
+    # @scope class
+    # @attribute [rw] limit
+    # @return [Integer] The default limit value.
+    # @example
+    #   # Limits sorted records by default.
+    #   User.limit = 20
+    #
+    #   # Doesn't limit sorted records by default.
+    #   User.limit = nil
+    #
+    # @since 1.0.5
+    class_attribute :limit
+
     class << self
       def configure(configuration)
         case configuration
@@ -100,11 +139,11 @@ module ActiveGroonga
         records = table.select do |record|
           yield(record)
         end
-        ResultSet.new(records, self, :expression => records.expression)
+        create_result_set(records, :expression => records.expression)
       end
 
       def all(options={})
-        ResultSet.new(table, self)
+        create_result_set(table)
       end
 
       def count
@@ -207,6 +246,15 @@ module ActiveGroonga
       def instance_method_already_implemented?(method_name)
         super(method_name)
       end
+
+      private
+      def create_result_set(records, options={})
+        default_options = {
+          :default_sort_keys => sort_keys,
+          :default_limit => limit,
+        }
+        ResultSet.new(records, self, default_options.merge(options))
+      end
     end
 
     def initialize(record_or_attributes=nil)