runes 0.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem "rubberband"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    elasticsearch (0.0.0)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  elasticsearch
+  jeweler (~> 1.5.2)

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2011, Stephano Zanzin
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the Stephano Zanzin nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY STEPHANO ZANZIN ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL STEPHANO ZANZIN BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.markdown

@@ -0,0 +1,39 @@
+Runes
+======
+
+Runes is a Railtie to index your models using the modern Elasticsearch as backend, which have possibilities ranging from a simple single-node index manipulation to a highly populated cluster.
+
+Elasticsearch
+-------------
+
+Elasticsearch is a powerful easy-to-use search engine built on top of Apache Lucene. It aims to solve many problems found when search is needed providing an amazing RESTful interface and complete ability to scale using a innovative distributed architecture. For more information check their [website](http://www.elasticsearch.org/).
+
+Getting started
+-------------
+
+First of all, this plugin was designed using the new Railtie architecture, so it's only supported by Rails 3. If you are new to elasticsearch I encourage you to install it using their [installation guide](http://www.elasticsearch.org/guide/reference/setup/installation.html).
+
+Install the latest gem in the conventional manner:
+
+    gem install runes
+
+Specify the models you want to index:
+
+    class Cake < ActiveRecord::Base
+      acts_as_indexable
+    end
+
+After you have installed Runes and specified the models just fire your Rails app. Voila! You are able to index and search.
+
+    Cake.create!(:name => "chocolate", :category => "fatty")
+    Cake.search("chocolate")
+
+Author
+------
+
+Stephano Zanzin :: me@zan.st :: zanst @ Freenode
+
+NOTICE
+------
+
+Work in progress, if you are not a code diver I recommend wait for a tag.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'psych' unless RUBY_VERSION < '1.9.2'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the runes plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the runes plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Runes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Build gem for the runes railtie.'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'runes'
+    gem.summary = 'Elasticsearch Railtie'
+    gem.description = 'Implements search to your models easily using elasticsearch as engine.'
+    gem.email = 'me@zan.st'
+    gem.homepage = 'http://github.com/zanst/runes'
+    gem.authors = ['Stephano Zanzin']
+    gem.files = Dir['*', '{lib}/**/*']
+    gem.add_dependency('rubberband')
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/runes.rb

@@ -0,0 +1,22 @@
+require 'rails'
+require 'rubberband'
+
+module Runes
+  require 'runes/base'
+  require 'runes/janitor'
+  require 'runes/orm/active_record'
+  require 'runes/railtie' if defined?(Rails)
+  require 'runes/rubberband_ext'
+
+  begin
+    config_path = Rails.root.to_s + '/config/runes.yml'
+    @config = YAML.load_file(config_path)
+  rescue
+    @config = nil
+  end
+
+  if Runes::Janitor.es_is_running?
+    @server_host = @config.nil? ? '127.0.0.1:9200' : @config['host'] + ':' + @config['port']
+    $es_client = ElasticSearch.new(@server_host)
+  end
+end

data/lib/runes/base.rb

@@ -0,0 +1,18 @@
+module Runes
+  module Base
+    class << self
+      def set_actor(model)
+        @actors ||= []
+        @actors << model
+      end
+
+      def actors
+        @actors
+      end
+
+      def search(query, index)
+        $es_client.search(query, :index => index)
+      end
+    end
+  end
+end

data/lib/runes/janitor.rb

@@ -0,0 +1,36 @@
+module Runes
+  module Janitor
+    class << self
+      def setup!
+        if Runes::Janitor.es_is_running?
+          begin
+            Runes::Base.actors.each do |actor|
+              $es_client.create_index(actor)
+            end
+          rescue ElasticSearch::RequestError
+            return true
+          end
+        end
+      end
+
+      # This function was created because rubberband
+      # behaves strangely and doesn't inform properly
+      # when elasticsearch isn't running.
+      def es_is_running?
+        require 'socket'
+        if @config.nil?
+          # getting the longer line possible to avoid problems in different operating systems.
+          process_status = system("ps auxwwww | grep org.elasticsearch.bootstrap | grep -v grep >> /dev/null")
+          return process_status
+        else
+          net_status = TCPSocket.open(@config['host'], @config['port'].to_i)
+          if net_status.nil?
+            return false
+          else
+            return true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/runes/orm/active_record.rb

@@ -0,0 +1,38 @@
+module Runes
+  module Orm
+    module ActiveRecord
+      attr_accessor :index_name
+      attr_accessor :type_name
+
+      def acts_as_indexable(options={})
+        send :include, InstanceMethods
+        @index_name = self.name.underscore.gsub(/\//, '-').pluralize
+        @type_name = self.name.underscore.gsub(/\//, '-').singularize
+        Runes::Base.set_actor(@index_name)
+        after_destroy :destroy_object_from_index
+        after_save :add_object_to_index
+      end
+
+      def search(query)
+        search = Runes::Base.search(query, @index_name)
+        results = search.map{|result| result.ar_equivalence}
+        return results.sort_by(&:created_at)
+      end
+    end
+
+    module InstanceMethods
+      def destroy_object_from_index
+        $es_client.delete(self.id.to_s, :index => self.class.index_name, :type => self.class.type_name)
+      end
+
+      def add_object_to_index
+        begin
+          destroy_object_from_index
+          $es_client.index(self.to_json, :id => self.id, :index => self.class.index_name, :type => self.class.type_name)
+        rescue
+          $es_client.index(self.to_json, :id => self.id, :index => self.class.index_name, :type => self.class.type_name)
+        end
+      end
+    end
+  end
+end

data/lib/runes/railtie.rb

@@ -0,0 +1,33 @@
+require 'runes'
+require 'rails'
+
+module Runes
+  class Railtie < Rails::Railtie
+    # Check if elasticsearch is running.
+    initializer 'runes.check_es_status', :before => 'i18n.callbacks' do
+      if Runes::Janitor.es_is_running? == false
+        raise "Elasticsearch server is not running."
+      end
+    end
+
+    # Include module into Rubberband's ElasticSearch::Api::Hit
+    initializer 'runes.include.rubberband', :before => 'active_record.initialize_timezone' do
+      ElasticSearch::Api::Hit.send :include, Runes::RubberbandExtension
+    end
+
+    # Extends module into active_record.
+    initializer 'runes.extend.active_record', :after => 'runes.include.rubberband' do
+      ActiveRecord::Base.send :extend, Runes::Orm::ActiveRecord
+    end
+    
+    # Initialize models in order to perform the Runes function.
+    initializer 'runes.req_models', :after => :engines_blank_point do
+      Dir.glob(Rails.root.to_s + '/app/models/*.rb').each { |file| require file }
+    end
+
+    # Verify and setup the actors defined by the user.
+    initializer 'runes.create_indexes', :after => 'runes.req_models'  do
+      Runes::Janitor.setup!
+    end
+  end
+end

data/lib/runes/rubberband_extension.rb

@@ -0,0 +1,12 @@
+module Runes
+  module RubberbandExtension
+    def ar_equivalence
+      model = _type.gsub(/-/,'/').classify.constantize
+      begin
+        model.find(id) 
+      rescue ActiveRecord::RecordNotFound
+        nil
+      end
+    end
+  end
+end

data/test/runes_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class RunesTest < ActiveSupport::TestCase
+  setup do
+    setup_db
+    ActiveRecord::Base.send :extend, Runes::Orm::ActiveRecord
+  end
+ 
+  must "execute method and add object to index" do
+    class Nut < ActiveRecord::Base
+      acts_as_indexable
+    end
+    Nut.create!(:name => "nutixious", :content => "nuts do crackle")
+    assert_equal 1, Nut.all.count
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_record'
+require 'test_unit_extension'
+
+def setup_db
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+  ActiveRecord::Schema.define(:version => 0) do
+    create_table :nuts, :force => true do |t|
+      t.string :name
+      t.text :content
+      t.datetime :created_at
+    end
+  end
+
+  require File.dirname(__FILE__) + '/../lib/runes'
+end
+
+ActiveSupport::TestCase.send :extend, Test::Unit

data/test/test_unit_extension.rb

@@ -0,0 +1,21 @@
+module Test::Unit
+  # Used to fix a minor minitest/unit incompatibility in flexmock 
+  AssertionFailedError = Class.new(StandardError)
+  
+  class TestCase
+   
+    def self.must(name, &block)
+      test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+      defined = instance_method(test_name) rescue false
+      raise "#{test_name} is already defined in #{self}" if defined
+      if block_given?
+        define_method(test_name, &block)
+      else
+        define_method(test_name) do
+          flunk "No implementation provided for #{name}"
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: runes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephano Zanzin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-15 00:00:00.000000000 -03:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubberband
+  requirement: &7573140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7573140
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &7564440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *7564440
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &7563100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *7563100
+- !ruby/object:Gem::Dependency
+  name: rubberband
+  requirement: &7561660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7561660
+description: Implements search to your models easily using elasticsearch as engine.
+email: me@zan.st
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/runes.rb
+- lib/runes/base.rb
+- lib/runes/janitor.rb
+- lib/runes/orm/active_record.rb
+- lib/runes/railtie.rb
+- lib/runes/rubberband_extension.rb
+- test/runes_test.rb
+- test/test_helper.rb
+- test/test_unit_extension.rb
+has_rdoc: true
+homepage: http://github.com/zanst/runes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Elasticsearch Railtie
+test_files:
+- test/runes_test.rb
+- test/test_helper.rb
+- test/test_unit_extension.rb