acts_as_solr_reloaded 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright © 2010
+
+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.markdown

@@ -0,0 +1,64 @@
+Description
+======
+This plugin adds full text search capabilities and many other nifty features from Apache's [Solr](http://lucene.apache.org/solr/) to any Rails model.
+It was based on the first draft by Erik Hatcher.
+
+Installation
+======
+
+    script/plugin install git://github.com/dcrec1/acts_as_solr_reloaded.git
+
+Requirements
+------
+* Java Runtime Environment(JRE) 1.5 aka 5.0 or newer [http://www.java.com/en/download/index.jsp](http://www.java.com/en/download/index.jsp)
+* If you have libxml-ruby installed, make sure it's at least version 0.7
+
+Configuration
+======
+If you are using acts_as_solr as a Rails plugin, everything is configured to work out of the box. You can use `rake solr:start` and `rake solr:stop`
+to start and stop the Solr web server (an embedded Jetty). If the default JVM options aren't suitable for
+your environment, you can configure them in solr.yml with the option `jvm_options`. There is a default
+set for the production environment to have some more memory available for the JVM than the defaults, but
+feel free to change them to your liking.
+
+If you are using acts_as_solr as a gem, create a file named lib/tasks/acts_as_solr.rake:
+<pre><code>
+require "acts_as_solr/tasks"
+</code></pre>
+
+Basic Usage
+======
+<pre><code>
+# Just include the line below to any of your ActiveRecord models:
+  acts_as_solr
+
+# Or if you want, you can specify only the fields that should be indexed:
+  acts_as_solr :fields => [:name, :author]
+
+# Then to find instances of your model, just do:
+  Model.search(query) #query is a string representing your query
+
+# Please see ActsAsSolr::ActsMethods for a complete info
+
+</code></pre>
+
+
+`acts_as_solr` in your tests
+======
+To test code that uses `acts_as_solr` you must start a Solr server for the test environment. You can do that with `rake solr:start RAILS_ENV=test`
+
+However, if you would like to mock out Solr calls so that a Solr server is not needed (and your tests will run much faster), just add this to your `test_helper.rb` or similar:
+
+<pre><code>
+class ActsAsSolr::Post
+  def self.execute(request)
+    true
+  end
+end
+</pre></code>
+
+([via](http://www.subelsky.com/2007/10/actsassolr-capistranhttpwwwbloggercomim.html#c1646308013209805416))
+
+Release Information
+======
+Released under the MIT license.

data/README.rdoc

@@ -0,0 +1,93 @@
+= DESCRIPTION
+
+This plugin adds full text search capabilities and many other nifty features from Apache's Solr[http://lucene.apache.org/solr/] to any Rails model, like:
+
+* faceting
+* dynamic attributes
+* integration with acts_as_taggable_on
+* highlighting
+* geolocation
+* relevance
+
+Watch this screencast for a short demo of the latests features:
+
+http://www.vimeo.com/8728276
+
+== INSTALLATION
+
+    script/plugin install git://github.com/dcrec1/acts_as_solr_reloaded.git
+
+== REQUIREMENTS
+
+* Java Runtime Environment(JRE) 1.5 aka 5.0 [http://www.java.com/en/download/index.jsp](http://www.java.com/en/download/index.jsp)
+* If you have libxml-ruby installed, make sure it's at least version 0.7
+
+== CONFIGURATION
+
+If you are using acts_as_solr_reloaded as a Rails plugin, everything is configured to work out of the box. You can use `rake solr:start` and `rake solr:stop`
+to start and stop the Solr web server (an embedded Jetty). If the default JVM options aren't suitable for
+your environment, you can configure them in config/solr.yml with the option `jvm_options`. There is a default
+set for the production environment to have some more memory available for the JVM than the defaults, but
+feel free to change them to your liking.
+
+If you are using acts_as_solr_reloaded as a gem, create a file named lib/tasks/acts_as_solr.rake:
+
+     require "acts_as_solr/tasks"
+
+== USAGE
+
+Just include the line below to any of your ActiveRecord models:
+  acts_as_solr
+
+Or if you want, you can specify only the fields that should be indexed:
+  acts_as_solr :fields => [:name, :author]
+
+Then to find instances of your model, just do:
+  Model.search(query) #query is a string representing your query
+  
+Case you want to use dynamic attributes or geolocalization, you can use this generators that setup the database:
+
+  script/generate dynamic_attributes_migration
+  script/generate local_migration
+  
+and then configure your model like this:
+
+  acts_as_solr :dynamic_attributes => true,
+               :spatial => true
+               
+If you want to integrate the model with acts_as_taggable_on, just add the option :taggable => true :
+
+  acts_as_solr :taggable => true
+
+Please see ActsAsSolr::ActsMethods for a complete info
+
+== TESTING
+
+To test code that uses acts_as_solr_reloaded you must start a Solr server for the test environment. You can do that with 
+
+    rake solr:start RAILS_ENV=test
+
+== LICENSE
+
+(The MIT License)
+
+Copyright © 2010
+
+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/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Dir["#{File.dirname(__FILE__)}/lib/acts_as_solr/tasks/**/*.rake"].sort.each { |ext| load ext }
+
+desc "Default Task"
+task :default => [:test]
+
+desc "Runs the unit tests"
+task :test => "test:unit"
+
+namespace :test do
+  task :setup do
+    RAILS_ROOT = File.expand_path("#{File.dirname(__FILE__)}/test") unless defined? RAILS_ROOT
+    ENV['RAILS_ENV'] = "test"
+    ENV["ACTS_AS_SOLR_TEST"] = "true"
+    require File.expand_path("#{File.dirname(__FILE__)}/config/solr_environment")
+    puts "Using " + DB
+    %x(mysql -u#{MYSQL_USER} < #{File.dirname(__FILE__) + "/test/fixtures/db_definitions/mysql.sql"}) if DB == 'mysql'
+
+    Rake::Task["test:migrate"].invoke
+  end
+
+  desc 'Measures test coverage using rcov'
+  task :rcov => :setup do
+    rm_f "coverage"
+    rm_f "coverage.data"
+    rcov = "rcov --rails --aggregate coverage.data --text-summary -Ilib"
+
+    system("#{rcov} --html #{Dir.glob('test/**/*_shoulda.rb').join(' ')}")
+    system("open coverage/index.html") if PLATFORM['darwin']
+  end
+
+  desc 'Runs the functional tests, testing integration with Solr'
+  Rake::TestTask.new('functional' => :setup) do |t|
+    t.pattern = "test/functional/*_test.rb"
+    t.verbose = true
+  end
+
+  desc "Unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << 'test/unit'
+    t.pattern = "test/unit/*_shoulda.rb"
+    t.verbose = true
+  end
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_dir = "rdoc"
+  rd.rdoc_files.exclude("lib/solr/**/*.rb", "lib/solr.rb")
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "acts_as_solr_reloaded"
+    s.summary = "This gem adds full text search capabilities and many other nifty features from Apache Solr to any Rails model."
+    s.email = "dc.rec1@gmail.com"
+    s.homepage = "http://github.com/dcrec1/acts_as_solr_reloaded"
+    s.description = "This gem adds full text search capabilities and many other nifty features from Apache Solr to any Rails model."
+    s.authors = ["Diego Carrion"]
+    s.files =  FileList["[A-Z]*", "{bin,generators,config,lib,solr}/**/*"] +
+      FileList["test/**/*"].reject {|f| f.include?("test/log")}.reject {|f| f.include?("test/tmp")}
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/TESTING_THE_PLUGIN

@@ -0,0 +1,25 @@
+acts_as_solr comes with a quick and fast unit test suite, and with a longer-running
+functional test suite, the latter testing the actual integration with Solr.
+
+The unit test suite is written using Shoulda, so make sure you have a recent version
+installed.
+
+Running `rake test` or just `rake` will run both test suites. Use `rake test:unit` to
+just run the unit test suite.
+ 
+== How to run functional tests for this plugin:
+To run the acts_as_solr's plugin tests run the following steps:
+
+- create a MySQL database called "actsassolr_test" (if you want to use MySQL)
+
+- create a new Rails project, if needed (the plugin can only be tested from within a Rails project); move/checkout acts_as_solr into its vendor/plugins/, as usual
+
+- copy vendor/plugins/acts_as_solr/config/solr.yml to config/ (the Rails config folder)
+
+- rake solr:start RAILS_ENV=test
+
+- rake test:functional (Accepts the following arguments: DB=sqlite|mysql and MYSQL_USER=user)
+
+== Troubleshooting:
+If for some reason the tests don't run and you get MySQL errors, make sure you edit the MYSQL_USER entry under
+config/environment.rb. It's recommended to create or use a MySQL user with no password.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/config/solr.yml

@@ -0,0 +1,14 @@
+# Config file for the acts_as_solr_reloaded plugin.
+#
+# If you change the host or port number here, make sure you update 
+# them in your Solr config file
+
+development:
+  url: http://127.0.0.1:8982/solr
+  
+test:
+  url: http://127.0.0.1:8981/solr
+  
+production:
+  url: http://127.0.0.1:8983/solr
+  jvm_options: -server -d64 -Xmx1024M -Xms64M

data/config/solr_environment.rb

@@ -0,0 +1,35 @@
+ENV['RAILS_ENV']  = (ENV['RAILS_ENV'] || 'development').dup
+# RAILS_ROOT isn't defined yet, so figure it out.
+require "uri"
+require "fileutils"
+dir = File.dirname(__FILE__)
+SOLR_PATH = File.expand_path("#{dir}/../solr") unless defined? SOLR_PATH
+
+RAILS_ROOT = File.expand_path("#{File.dirname(__FILE__)}/../test") unless defined? RAILS_ROOT
+unless defined? SOLR_LOGS_PATH
+  SOLR_LOGS_PATH = ENV["SOLR_LOGS_PATH"] || "#{RAILS_ROOT}/log"
+end
+unless defined? SOLR_PIDS_PATH
+  SOLR_PIDS_PATH = ENV["SOLR_PIDS_PATH"] || "#{RAILS_ROOT}/tmp/pids"
+end
+unless defined? SOLR_DATA_PATH
+  SOLR_DATA_PATH = ENV["SOLR_DATA_PATH"] || "#{RAILS_ROOT}/solr/#{ENV['RAILS_ENV']}"
+end
+unless defined? SOLR_CONFIG_PATH
+  SOLR_CONFIG_PATH = ENV["SOLR_CONFIG_PATH"] || "#{SOLR_PATH}/solr"
+end
+
+unless defined? SOLR_PORT
+  config = YAML::load_file(RAILS_ROOT+'/config/solr.yml')
+  raise("No solr environment defined for RAILS_ENV the #{ENV['RAILS_ENV'].inspect}") unless config[ENV['RAILS_ENV']]
+  SOLR_PORT = ENV['PORT'] || URI.parse(config[ENV['RAILS_ENV']]['url']).port
+end
+
+SOLR_JVM_OPTIONS = config[ENV['RAILS_ENV']]['jvm_options'] unless defined? SOLR_JVM_OPTIONS
+
+if ENV["ACTS_AS_SOLR_TEST"]
+  require "activerecord"
+  DB = (ENV['DB'] ? ENV['DB'] : 'sqlite') unless defined?(DB)
+  MYSQL_USER = (ENV['MYSQL_USER'].nil? ? 'root' : ENV['MYSQL_USER']) unless defined? MYSQL_USER
+  require File.join(File.dirname(File.expand_path(__FILE__)), '..', 'test', 'db', 'connections', DB, 'connection.rb')
+end

data/generators/dynamic_attributes_migration/dynamic_attributes_migration_generator.rb

@@ -0,0 +1,7 @@
+class DynamicAttributesMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "dynamic_attributes_migration"
+    end
+  end
+end

data/generators/dynamic_attributes_migration/templates/migration.rb

@@ -0,0 +1,15 @@
+class DynamicAttributesMigration < ActiveRecord::Migration
+  def self.up
+    create_table :dynamic_attributes do |t|
+      t.integer :dynamicable_id
+      t.string  :dynamicable_type
+      t.string :name
+      t.text :value
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :dynamic_attributes
+  end
+end

data/generators/local_migration/local_migration_generator.rb

@@ -0,0 +1,7 @@
+class LocalMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "local_migration"
+    end
+  end
+end

data/generators/local_migration/templates/migration.rb

@@ -0,0 +1,16 @@
+class LocalMigration < ActiveRecord::Migration
+  def self.up
+    create_table :locals do |t|
+      t.integer :localizable_id
+      t.string  :localizable_type
+      t.string :latitude
+      t.string :longitude
+
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :locals
+  end
+end

data/lib/acts_as_solr.rb

@@ -0,0 +1,65 @@
+# Copyright (c) 2006 Erik Hatcher, Thiago Jackiw
+#
+# 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.
+
+require 'active_record'
+require 'rexml/document'
+require 'net/http'
+require 'yaml'
+require 'time'
+require 'erb'
+require 'rexml/xpath'
+
+require File.dirname(__FILE__) + '/solr'
+require File.dirname(__FILE__) + '/acts_as_solr/acts_methods'
+require File.dirname(__FILE__) + '/acts_as_solr/common_methods'
+require File.dirname(__FILE__) + '/acts_as_solr/parser_methods'
+require File.dirname(__FILE__) + '/acts_as_solr/class_methods'
+require File.dirname(__FILE__) + '/acts_as_solr/instance_methods'
+require File.dirname(__FILE__) + '/acts_as_solr/common_methods'
+require File.dirname(__FILE__) + '/acts_as_solr/deprecation'
+require File.dirname(__FILE__) + '/acts_as_solr/search_results'
+require File.dirname(__FILE__) + '/acts_as_solr/lazy_document'
+module ActsAsSolr
+  
+  class Post    
+    def self.execute(request, core = nil)
+      begin
+        if File.exists?(RAILS_ROOT+'/config/solr.yml')
+          config = YAML::load_file(RAILS_ROOT+'/config/solr.yml')
+          url = config[ENV['RAILS_ENV']]['url']
+          # for backwards compatibility
+          url ||= "http://#{config[ENV['RAILS_ENV']]['host']}:#{config[ENV['RAILS_ENV']]['port']}/#{config[ENV['RAILS_ENV']]['servlet_path']}"
+        else
+          url = 'http://localhost:8982/solr'
+        end
+        url += "/" + core if !core.nil?
+        connection = Solr::Connection.new(url)
+        return connection.send(request)
+      rescue 
+        raise "Couldn't connect to the Solr server at #{url}. #{$!}"
+        false
+      end
+    end
+  end
+  
+end
+
+# reopen ActiveRecord and include the acts_as_solr method
+ActiveRecord::Base.extend ActsAsSolr::ActsMethods