activegroonga 0.0.7 → 1.0.0

data/lib/active_groonga/persistence.rb

@@ -0,0 +1,172 @@
+# Copyright (C) 2009-2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module ActiveGroonga
+  module Persistence
+    def new_record?
+      @new_record
+    end
+
+    def destroyed?
+      @destroyed
+    end
+
+    def persisted?
+      not (new_record? or destroyed?)
+    end
+
+    def save(options={})
+      create_or_update
+    end
+
+    def save!(options={})
+      create_or_update or raise(RecordNotSaved)
+    end
+
+    def delete
+      table.delete(record_id) if persisted?
+      @destroyed = true
+      freeze
+    end
+
+    def destroy
+      table.delete(record_id) if persisted?
+      @destroyed = true
+      freeze
+    end
+
+    def becomes(klass)
+      became = klass.new
+      became.instance_variable_set("@attributes", @attributes)
+      became.instance_variable_set("@attributes_cache", @attributes_cache)
+      became.instance_variable_set("@new_record", new_record?)
+      became.instance_variable_set("@destroyed", destroyed?)
+      became
+    end
+
+    def update_attribute(name, value)
+      name = name.to_s
+      send("#{name}=", value)
+      save(:validate => false)
+    end
+
+    def update_attributes(attributes)
+      self.attributes = attributes
+      save
+    end
+
+    def update_attributes!(attributes)
+      self.attributes = attributes
+      save!
+    end
+
+    def reload
+      if new_record?
+        record = nil
+      else
+        record = table[record_id]
+      end
+      reload_attributes(record)
+      @attributes_cache = {}
+      self
+    end
+
+    private
+    def create_or_update
+      success = new_record? ? create : update
+      success != false
+    end
+
+    def create
+      attributes = {}
+      @attributes.each do |key, value|
+        next if value.nil?
+        if value.is_a?(Base)
+          value.save if value.new_record?
+          value = value.id
+        end
+        attributes[key] = value
+      end
+      if table.support_key?
+        record = table.add(key, attributes)
+      else
+        record = table.add(attributes)
+      end
+      record["created_at"] = Time.now if record.have_column?("created_at")
+      reload_attributes(record)
+      @id = record.id
+      @key = record.key if record.support_key?
+      @new_record = false
+      true
+    end
+
+    def update
+      record = self.class.table[record_id]
+      @attributes.each do |key, value|
+        if value.respond_to?(:record_id)
+          value = value.record_id
+        elsif value.is_a?(Hash) and value["id"]
+          value = value["id"]
+        end
+        record[key] = value
+      end
+      record["updated_at"] = Time.now if record.have_column?("updated_at")
+      true
+    end
+
+    def initial_attributes
+      attributes = {}
+      self.class.table.columns.each do |column|
+        next if column.index?
+        attributes[column.local_name] = nil
+      end
+      attributes
+    end
+
+    def extract_attributes(record)
+      attributes = {}
+      if record.support_key?
+        attributes["key"] = record.key
+      else
+        attributes["id"] = record.id
+      end
+      record.columns.each do |column|
+        next if column.is_a?(Groonga::IndexColumn)
+        value = record[column.local_name]
+        if value and column.reference?
+          value_class = self.class.custom_reference_class(column.local_name)
+          value_class ||= column.range.name.camelize.singularize.constantize
+          if column.vector?
+            value = Vector.new(self, value_class, value)
+          else
+            value = value_class.instantiate(value)
+          end
+        end
+        attributes[column.local_name] = value
+      end
+      attributes
+    end
+
+    def reload_attributes(record=nil)
+      if record.nil?
+        @attributes = initial_attributes
+      else
+        @attributes = extract_attributes(record)
+      end
+      @id = @attributes.delete("id")
+      @key = @attributes.delete("key")
+    end
+  end
+end

data/lib/active_groonga/railtie.rb

@@ -0,0 +1,66 @@
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "active_groonga"
+require "rails"
+require "active_model/railtie"
+
+require "active_groonga/railties/configurable"
+
+module ActiveGroonga
+  class Railtie < Rails::Railtie
+    config.active_groonga = ActiveSupport::OrderedOptions.new
+
+    config.generators.orm(:active_groonga,
+                          :migration => true,
+                          :timestamps => true)
+
+    config.before_configuration do
+      application_config = Rails.application.config
+      application_config.extend(Railties::Configurable)
+      application_config.paths.config.groonga("config/groonga.yml")
+    end
+
+    rake_tasks do
+      load "active_groonga/railties/groonga.rake"
+    end
+
+    console do
+      ActiveGroonga::Base
+    end
+
+    initializer("active_groonga.logger") do
+      ActiveSupport.on_load(:active_groonga) do
+        self.logger ||= ::Rails.logger
+      end
+    end
+
+    initializer("active_groonga.set_configurations") do |app|
+      ActiveSupport.on_load(:active_groonga) do
+        app.config.active_groonga.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+    end
+
+    initializer("active_groonga.initialize_database") do |app|
+      ActiveSupport.on_load(:active_groonga) do
+        self.configurations = app.config.groonga_configurations
+        configure(Rails.env)
+        database.ensure_available
+      end
+    end
+  end
+end

data/lib/active_groonga/railties/configurable.rb

@@ -0,0 +1,47 @@
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module ActiveGroonga
+  module Railties
+    module Configurable
+      def groonga_configurations
+        groonga_yml = paths.config.groonga.first
+        unless File.exist?(groonga_yml)
+          groonga_yml_example = "#{groonga_yml}.example"
+          if File.exist?(groonga_yml_example)
+            cp(groonga_yml_example, groonga_yml)
+          else
+            File.open(groonga_yml, "w") do |yml|
+              yml.puts(<<-EOC)
+development:
+  database: db/groonga/development/db
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  database: db/groonga/test/db
+
+production:
+  database: db/groonga/production/db
+              EOC
+            end
+          end
+        end
+        YAML.load(ERB.new(IO.read(groonga_yml)).result)
+      end
+    end
+  end
+end

data/lib/active_groonga/railties/groonga.rake

@@ -0,0 +1,167 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+namespace :groonga do
+  task :load_config => :rails_env do
+    require "active_groonga"
+    configurations = Rails.application.config.groonga_configurations
+    ActiveGroonga::Base.configurations = configurations
+    ActiveGroonga::Base.configure(Rails.env)
+  end
+
+  desc "Drops the database."
+  task :drop => :load_config do
+    database = ActiveGroonga::Base.database
+    database.remove if database
+    database_path = ActiveGroonga::Base.database_path
+    tables_path = Pathname("#{database_path}.talbes")
+    rm_rf(tables_path) if tables_path.exist?
+  end
+
+  desc "Create the database."
+  task :create => :load_config do
+    ActiveGroonga::Base.database.ensure_available
+  end
+
+  migrations_path = Proc.new do
+    Rails.root + "db" + "groonga" + "migrate"
+  end
+  desc "Migrate the database (options: VERSION=x)."
+  task :migrate => :environment do
+    version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+    migrator = ActiveGroonga::Migrator.new(:up, migrations_path.call)
+    migrator.migrate(version)
+    Rake::Task["groonga:schema:dump"].invoke
+  end
+
+  desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
+  task :rollback => :environment do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    migrator = ActiveGroonga::Migrator.new(:down, migrations_path.call)
+    version, migrated_at = migrator.migrated_versions[-step]
+    migrator.migrate(version)
+    Rake::Task["groonga:schema:dump"].invoke
+  end
+
+  namespace :migrate do
+    desc 'Rolls the schema back and migrate the schema again.'
+    task :redo => :environment do
+      if ENV["VERSION"]
+        Rake::Task["groonga:migrate:down"].invoke
+        Rake::Task["groonga:migrate:up"].invoke
+      else
+        Rake::Task["groonga:rollback"].invoke
+        Rake::Task["groonga:migrate"].invoke
+      end
+    end
+
+    desc 'Migrate the schema up to the version (options: VERSION=x).'
+    task :up => :environment do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      migrator = ActiveGroonga::Migrator.new(:up, migrations_path.call)
+      migrator.migrate(version)
+      Rake::Task["groonga:schema:dump"].invoke
+    end
+
+    desc 'Migrate the schema down to the version (options: VERSION=x).'
+    task :down => :environment do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      migrator = ActiveGroonga::Migrator.new(:down, migrations_path.call)
+      migrator.migrate(version)
+      Rake::Task["groonga:schema:dump"].invoke
+    end
+  end
+
+  namespace :schema do
+    schema_name = Proc.new do
+      Pathname(ENV['SCHEMA'] || (Rails.root + "db" + "groonga" + "schema.rb"))
+    end
+
+    desc "Load the schema."
+    task :load => "groonga:load_config" do
+      schema = schema_name.call
+      if schema.exist?
+        load(schema)
+      else
+        Rake::Task["groonga:migrate"].invoke
+      end
+    end
+
+    desc "Dump the schema."
+    task :dump => "groonga:load_config" do
+      schema = schema_name.call
+      mkdir_p(schema.dirname.to_s) unless schema.dirname.exist?
+      begin
+        schema.open("w") do |schema_file|
+          ActiveGroonga::Schema.dump(schema_file)
+        end
+      rescue Exception
+        rm_f(schema.to_s)
+        raise
+      end
+    end
+  end
+
+  desc('Load the seed data from db/groonga/seeds/#{RAILS_ENV}.grn, ' +
+       'db/groonga/seeds/#{RAILS_ENV}.rb, db/groonga/seeds.grn or ' +
+       'db/groonga/seeds.rb')
+  task :seed => :load_config do
+    base_dir = Rails.root + "db" + "groonga"
+    candidates = [base_dir + "seeds" + "#{Rails.env}.grn",
+                  base_dir + "seeds" + "#{Rails.env}.rb",
+                  base_dir + "seeds.grn",
+                  base_dir + "seeds.rb"]
+    seed_file_path = candidates.find(&:exist?)
+    break unless seed_file_path
+    case seed_file_path.extname
+    when /\A\.grn\z/i
+      ActiveGroonga::Base.database.ensure_available
+      context = ActiveGroonga::Base.context
+      seed_file_path.open do |seed_file|
+        seed_file.each_line do |line|
+          puts("> #{line}")
+          context.send(line)
+          id, result = context.receive
+          puts(result) unless result.empty?
+        end
+      end
+    when /\A\.rb\z/i
+      load(seed_file_path)
+    else
+      raise "unsupported seed file type: <#{seed_file_path}>"
+    end
+  end
+
+  desc "Create the database and load the schema."
+  task :setup => [:create, "groonga:schema:load", :seed]
+
+  task :reset => [:drop, :setup]
+
+  namespace :test do
+    desc "Prepare groonga database for testing"
+    task :prepare do
+      ActiveGroonga::Base.configure("test")
+      Rake::Task["groonga:drop"].invoke
+      Rake::Task["groonga:create"].invoke
+      Rake::Task["groonga:schema:load"].invoke
+    end
+  end
+end
+
+task "test:prepare" => "groonga:test:prepare"