oss_active_record 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8d98241b53d0f1f9dc6ee4dcb51ea5fa60f4aca
+  data.tar.gz: 8284c8abaa036e7ee4c80b5ca3b808b540f15320
+SHA512:
+  metadata.gz: 451d6b0de1db3f12699cba08c5fa1c4e5cdf16bc456c5cf35abb64172dfa327ac5e97ae22e4d4b339a095db22e6a9fd14bb5fd9dbd9ec0f7cdc2865ee6b96bf0
+  data.tar.gz: 2cdb7d185b3fdea92cb2b56fcda65241f5e092505a79fae9e8d9f0e5112f443d92ce260ce68dfc4331a7e2c49d9f379c8e3432c1ac11b99f34f1fcfcdf32b640

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Ori Pekelman
+
+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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OssActiveRecord'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/oss_active_record.rb

@@ -0,0 +1,4 @@
+require "oss_active_record/searchable"
+require "oss_active_record/search_request"
+module OssActiveRecord
+end

data/lib/oss_active_record/search_request.rb

@@ -0,0 +1,62 @@
+module OssActiveRecord
+  class SearchRequest
+    def initialize(index, text_fields, sortable_fields)
+      @index = index
+      @params = {'start' => 0,  'rows' => 10}
+      @filters = [];
+      @text_fields = text_fields;
+      @sortable_fields = sortable_fields;
+      @order_by = {};
+    end
+
+    def fulltext(keywords, &block)
+      @params['query'] = keywords
+    end
+
+    def filter(field, value, negative)
+      @filters << {"type"=> "QueryFilter",  "negative"=> negative,  "query"=> "#{field}:#{value}"}
+    end
+
+    def with(field, value)
+      filter field, value, false
+    end
+
+    def without(field, value)
+      filter field, value, true
+    end
+
+    def returns(fields)
+      @params['returnedFields'] = fields.uniq
+    end
+
+    def paginate(params)
+      rows = params[:per_page].to_i
+      page = params[:page].to_i
+      @params['start'] = (page - 1) * rows
+      @params['rows'] = rows
+    end
+
+    def order_by(field = nil, direction = :asc)
+      field = field == :score ? 'score' :@sortable_fields[field]
+      @order_by[field.to_s] = direction.to_s.upcase unless field.nil?
+    end
+
+    def execute(&block)
+      self.instance_eval(&block) unless block.nil?
+      @params['filters'] = @filters unless @filters.length == 0
+      fields = []
+      @text_fields.each do |key, value|
+        fields<<{ "field"=> value,"phrase"=> true,"boost"=> 1.0}
+      end
+      @params['searchFields'] = fields unless fields.length == 0
+      sorts = []
+      @order_by.each do |key, value|
+        sorts<<{ "field"=> key,"direction"=> value}
+      end
+      @params['sorts'] = sorts unless sorts.length == 0
+      return @index.search_field(@params)
+    end
+
+  end
+
+end

data/lib/oss_active_record/searchable.rb

@@ -0,0 +1,128 @@
+module OssActiveRecord
+  module Searchable
+    extend ActiveSupport::Concern
+    def index
+      doc = self.to_indexable
+      oss_doc = Oss::Document.new
+      doc.each do |name,value|
+        oss_doc.fields << Oss::Field.new(name, value)
+      end
+      self.class.oss_index.documents << oss_doc
+      self.class.oss_index.index!
+    end
+
+    module ClassMethods
+      @@field_types= [:integer, :text, :string, :time] #supported field types
+      @@_fields=[]
+      @@_field_id = nil
+      @@_text_fields = {}
+      @@_sortable_fields = {}
+      @@index = nil
+
+      def _fields
+        @@_fields
+      end
+
+      def searchable(options = {}, &block)
+        yield
+        unless options[:auto_index] == false
+          after_save :index
+        end
+      end
+
+      def oss_index
+        if @@index.nil?
+          @@index_name ||= self.name.downcase
+          @@index = Oss::Index.new(@@index_name, Rails.configuration.open_search_server_url)
+          create_schema!
+        end
+        @@index
+      end
+
+      def add_field(name, type, block=nil)
+        @@_fields<<{:name => name, :type => type,:block => block}
+      end
+
+      def create_schema!
+        @@index.create('EMPTY_INDEX') unless @@index.list.include? @@index_name
+        @@_field_id = @@_fields.detect {|f| f[:name] == :id }
+        @@_field_id = {:name => 'id', :type => 'integer',:block => nil} if @@_field_id.nil?
+        @@_fields <<  @@_field_id
+        @@_fields.each do |field|
+          create_schema_field!(field)
+        end
+      end
+
+      def reindex!
+        self.oss_index.delete!
+        self.create_schema!
+
+        self.all.find_in_batches  do |group|
+          group.each { |doc| doc.index }
+        end
+      end
+
+      def create_schema_field!(field)
+        analyzers = { :text => 'StandardAnalyzer',  :integer => 'DecimalAnalyzer'}
+        analyzer = analyzers[field[:type]] if field[:name] != :id
+        termVectors = { :text => 'POSITIONS_OFFSETS'}
+        termVector = termVectors[field[:type]] || 'NO'
+        name =  "#{field[:name]}|#{field[:type]}"
+        params = {
+          'name' => name,
+          'analyzer' => analyzer,
+          'stored' => 'NO',
+          'indexed' => 'YES',
+          'termVector' => termVector
+        }
+        @@_text_fields[field[:name]] = name if field[:type] == :text
+        @@_sortable_fields[field[:name]] = name unless field[:type] == :text
+        self.oss_index.set_field(params)
+        self.oss_index.set_field_default_unique(name, name) if field[:name] == :id
+      end
+
+      def method_missing(method, *args, &block)
+        yield unless block.nil?
+        add_field args[0], method, block if @@field_types.include? method
+      end
+
+      def search(*args, &block)
+        searchRequest = SearchRequest.new(self.oss_index, @@_text_fields, @@_sortable_fields)
+        searchRequest.returns @@_fields.map {|f|"#{f[:name]}|#{f[:type]}"}
+        active_record_from_result searchRequest.execute(&block)
+      end
+
+      def get_ids_from_results(search_result)
+        ids = []
+        id_field_name = "#{@@_field_id[:name]}|#{@@_field_id[:type]}"
+        search_result['documents'].each do |document|
+          document['fields'].each do |field|
+            ids << field['values'].map {|f|f.to_i}.uniq if field['fieldName'] == id_field_name
+          end
+        end
+        return ids
+      end
+
+      def active_record_from_result(search_result)
+        find get_ids_from_results(search_result)
+      end
+
+    end
+
+    def to_indexable
+      doc={}
+      self.class._fields.each do |field|
+        if field[:block].nil?
+          val = self.send(field[:name].to_sym)
+        else
+          val = field[:block].call
+        end
+        doc["#{field[:name]}|#{field[:type]}"]=val
+      end
+      doc
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, OssActiveRecord::Searchable

data/lib/oss_active_record/version.rb

@@ -0,0 +1,3 @@
+module OssActiveRecord
+  VERSION = "0.1.0"
+end

data/lib/tasks/oss_active_record_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :oss_active_record do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/article.rb

@@ -0,0 +1,11 @@
+class Article < ActiveRecord::Base
+
+  searchable do
+    integer  :id
+    text     :title              # fulltext
+    string   :title              # order_by
+    text     :content            #fulltext
+    time     :updated_at
+  end
+
+end

data/test/dummy/app/models/document.rb

@@ -0,0 +1,55 @@
+class CurrentRevision
+  def uuid
+    42
+  end
+
+  def user_id
+    42
+  end
+
+  def file_size
+    42
+  end
+
+  def file_content_type
+    "42/42"
+  end
+
+  def state
+    "42"
+  end
+end
+
+class Folder
+  def room_id
+    42
+  end
+end
+
+class Document < ActiveRecord::Base
+  #  belongs_to :current_revision
+  def self.folder
+    Folder.new
+  end
+
+  def self.current_revision
+    CurrentRevision.new
+  end
+
+  searchable do
+    integer  :id
+    integer  :folder_id
+    integer  :room_id           do folder.room_id end
+
+    text     :name              # fulltext
+    string   :name              # order_by
+    time     :updated_at
+
+    integer  :uuid              do current_revision.uuid end
+    integer  :user_id           do current_revision.user_id end
+    integer  :file_size         do current_revision.file_size end
+    string   :file_content_type do current_revision.file_content_type end
+    string   :state             do current_revision.state end
+  end
+
+end

data/test/dummy/app/models/invalid_article.rb

@@ -0,0 +1,12 @@
+class InvalidArticle < ActiveRecord::Base
+
+  searchable do
+    integer  :id
+    glop     :room_id
+    text     :title             # fulltext
+    string   :title             # order_by
+    text     :content
+    time     :updated_at
+  end
+
+end

data/test/dummy/app/models/invalid_document.rb

@@ -0,0 +1,20 @@
+class InvalidDocument < ActiveRecord::Base
+  #  belongs_to :current_revision
+
+  searchable do
+    integer  :id
+    integer  :folder_id
+    glop  :room_id           do folder.room_id end
+
+    plop     :name              # fulltext
+    string   :name              # order_by
+    time     :updated_at
+
+    integer  :uuid              do current_revision.uuid end
+    integer  :user_id           do current_revision.user_id end
+    integer  :file_size         do current_revision.file_size end
+    string   :file_content_type do current_revision.file_content_type end
+    string   :state             do current_revision.state end
+  end
+
+end