nazrin 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4811b450a57c8fcc72c815cc642d9e0ce7359dfa
-  data.tar.gz: 910cca00b2effa6bfe5d3884b39cfbf560515355
+  metadata.gz: b4f029ada212e4e84f9330f78ed97b3b06442d17
+  data.tar.gz: 7928db6029d307c725cbbd20c8483e3387f3b0cb
 SHA512:
-  metadata.gz: 4c052105d5458141a09041a0ac2baaf266e5a8b1270c2d1a8e1843a276dafad1cd0a28c1d5b46595f2b4b9cb2f4b8d72894529b2b93ebf606dc12387cc4d0a94
-  data.tar.gz: d40a60de6db1046c563a019e5d474f7d96c5b69478285b2c365269dd80f56a6dccd4bcaf15f2d97671d0913a0b0d6ba899f24e2c69b906ab79362901806983d9
+  metadata.gz: 069789e5426be62c5967a54cca18cb05e1a9f5c1a3c0a833e4919b2984004263b07d8edcc3b247cd40cd4a6ed6d8f55f4661fdfd40cd0db34cf4079eea8ccdd8
+  data.tar.gz: f3b4e13c3f1260e1a6b0af4d237f354d9a020771f9c37e684ca87496d6d2da21504368d91b24fe2810a35526cb87da987c5e41dce71abfdd96ededf05d7ab2a3

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+services:
+  - mongodb
 rvm:
   - 2.2.3
 before_install: gem install bundler -v 1.10.3

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [2.2.0](https://github.com/tsuwatch/nazrin/compare/v2.1.2...v2.2.0)
+
+### Breaking changes:
+
+* Include `Nazrin::Searchable` instead of `Nazrin::ActiveRecord::Searchable` [#19](https://github.com/tsuwatch/nazrin/pull/19)
+
+### Features:
+
+* Support Mongoid [#17](https://github.com/tsuwatch/nazrin/pull/17) [#20](https://github.com/tsuwatch/nazrin/pull/20) - [@yefim](https://github.com/yefim)
+
+## [2.1.2](https://github.com/tsuwatch/nazrin/compare/v2.1.1...v2.1.2)
+
+### Fixes:
+
+* Require aws-sdk gem in nazrin [#14](https://github.com/tsuwatch/nazrin/pull/14)
+
 ## [2.1.1](https://github.com/tsuwatch/nazrin/compare/v2.1.0...v2.1.1)
 
 ### Fixes:

data/README.md

@@ -4,7 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/tsuwatch/nazrin/badge.svg?branch=readme&service=github)](https://coveralls.io/github/tsuwatch/nazrin?branch=readme)
 [![Code Climate](https://codeclimate.com/github/tsuwatch/nazrin/badges/gpa.svg)](https://codeclimate.com/github/tsuwatch/nazrin)
 
-Nazrin is a Ruby wrapper for Amazon CloudSearch (aws-sdk), with optional ActiveRecord support for easy integration with your Rails application.
+Nazrin is a Ruby wrapper for Amazon CloudSearch (aws-sdk), with ActiveRecord, Mongoid support for easy integration with your Rails application.
 
 >*Nazrin has the ability of the extent which find what you're looking for...*
 
@@ -44,7 +44,7 @@ end
 
 ```ruby
 class Post < ActiveRecord::Base
-  include Nazrin::ActiveRecord::Searchable
+  include Nazrin::Searchable
 
   searchable do
     fields [:content]
@@ -66,6 +66,7 @@ Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')
 If you want to use other supported pagination libraries, for example, `nazrin-kaminari` generates `Kaminari::PaginatableArray` instead of `Nazrin::PaginatedArray`.
 
 ```ruby
+gem 'nazrin'
 gem 'nazrin-kaminari'
 ```
 

data/lib/nazrin.rb

@@ -1,7 +1,7 @@
 require 'aws-sdk'
 
-require 'nazrin/active_record/searchable'
-require 'nazrin/active_record/data_accessor'
+require 'nazrin/searchable'
+require 'nazrin/data_accessor'
 require 'nazrin/config'
 require 'nazrin/search_client'
 require 'nazrin/document_client'

data/lib/nazrin/data_accessor.rb

@@ -0,0 +1,87 @@
+module Nazrin
+  class DataAccessor
+    class NoAccessorError < StandardError; end
+
+    class << self
+      def for(clazz)
+        accessor = registered_accessor_for(clazz) || register_accessor(clazz)
+        return accessor if accessor
+        raise NoAccessorError, "No accessor for #{clazz.name}"
+      end
+
+      def registered_accessor_for(clazz)
+        return nil if clazz.name.nil? || clazz.name.empty?
+        accessors[clazz.name.to_sym]
+      end
+
+      def register_accessor(clazz)
+        clazz.ancestors.each do |ancestor_class|
+          if accessor = accessor_for(ancestor_class)
+            register(accessor, clazz)
+            return accessor
+          end
+        end
+        nil
+      end
+
+      def accessor_for(clazz)
+        return nil if clazz.name.nil? || clazz.name.empty?
+        if defined?(::ActiveRecord::Base) && clazz.ancestors.include?(::ActiveRecord::Base)
+          require 'nazrin/data_accessor/active_record'
+          return Nazrin::DataAccessor::ActiveRecord
+        elsif defined?(::Mongoid::Document) && clazz.ancestors.include?(::Mongoid::Document)
+          require 'nazrin/data_accessor/mongoid'
+          return Nazrin::DataAccessor::Mongoid
+        end
+        nil
+      end
+
+      def register(accessor, clazz)
+        accessors[clazz.name.to_sym] = accessor
+      end
+
+      def accessors
+        @accessor ||= {}
+      end
+    end
+
+    def initialize(model, options)
+      @model = model
+      @options = options
+    end
+
+    def results(client)
+      @client = client
+
+      res = @client.search
+      collection = load_all(res.data.hits.hit.map(&:id))
+
+      if @client.parameters[:size] && @client.parameters[:start]
+        total_count = res.data.hits.found
+
+        Nazrin::PaginationGenerator.generate(
+          collection,
+          current_page: current_page,
+          per_page: @client.parameters[:size],
+          total_count: total_count,
+          last_page: last_page(total_count))
+      else
+        collection
+      end
+    end
+
+    def load_all
+      raise NotImplementedError
+    end
+
+    private
+
+    def last_page(total_count)
+      (total_count / @client.parameters[:size].to_f).ceil
+    end
+
+    def current_page
+      (@client.parameters[:start] / @client.parameters[:size].to_f).ceil + 1
+    end
+  end
+end

data/lib/nazrin/data_accessor/active_record.rb

@@ -0,0 +1,19 @@
+module Nazrin
+  class DataAccessor
+    class ActiveRecord < Nazrin::DataAccessor
+      # load from activerecord
+      def load_all(ids)
+        records_table = {}
+        @options.each do |k, v|
+          @model = @model.send(k, v)
+        end
+        @model.where(id: ids).each do |record|
+          records_table[record.id] = record
+        end
+        ids.map do |id|
+          records_table.select { |k, _| k == id.to_i }[id.to_i]
+        end.reject(&:nil?)
+      end
+    end
+  end
+end

data/lib/nazrin/data_accessor/mongoid.rb

@@ -0,0 +1,22 @@
+module Nazrin
+  class DataAccessor
+    class Mongoid < Nazrin::DataAccessor
+      def load_all(ids)
+        documents_table = {}
+        @options.each do |k, v|
+          @model = if v.nil?
+                     @model.send(k)
+                   else
+                     @model.send(k, v)
+                   end
+        end
+        @model.where('_id' => { '$in' => ids }).each do |document|
+          documents_table[document._id.to_s] = document
+        end
+        ids.map do |id|
+          documents_table[id]
+        end.reject(&:nil?)
+      end
+    end
+  end
+end

data/lib/nazrin/searchable.rb

@@ -0,0 +1,92 @@
+require 'active_support/concern'
+
+module Nazrin
+  module Searchable
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method :delete_from_index, :nazrin_delete_from_index unless method_defined? :delete_from_index
+      alias_method :add_to_index, :nazrin_add_to_index unless method_defined? :add_to_index
+      alias_method :update_in_index, :nazrin_update_in_index unless method_defined? :update_in_index
+    end
+
+    def nazrin_delete_from_index
+      self.class.nazrin_delete_document(self)
+    end
+
+    def nazrin_add_to_index
+      self.class.nazrin_add_document(self)
+    end
+
+    def nazrin_update_in_index
+      self.class.nazrin_update_document(self)
+    end
+
+    module ClassMethods
+      def self.extended(base)
+        class << base
+          alias_method :search, :nazrin_search unless method_defined? :search
+          alias_method :searchable, :nazrin_searchable unless method_defined? :searchable
+          alias_method :fields, :nazrin_fields unless method_defined? :fields
+          alias_method :field, :nazrin_field unless method_defined? :field
+        end
+      end
+
+      def nazrin_search(options = {})
+        client = Nazrin::SearchClient.new
+        client.data_accessor = Nazrin::DataAccessor.for(self).new(self, options)
+        client
+      end
+
+      def nazrin_searchable(&block)
+        class_variable_set(
+          :@@nazrin_doc_client,
+          Nazrin::DocumentClient.new)
+        class_variable_set(:@@nazrin_search_field_data, {})
+        block.call
+      end
+
+      def nazrin_fields(fields)
+        field_data = class_variable_get(:@@nazrin_search_field_data)
+        fields.each do |field|
+          field_data[field] = proc { public_send(field) }
+        end
+        class_variable_set(:@@nazrin_search_field_data, field_data)
+      end
+
+      def nazrin_field(field, &block)
+        field_data = class_variable_get(:@@nazrin_search_field_data)
+        field_data[field] = block
+        class_variable_set(:@@nazrin_search_field_data, field_data)
+      end
+
+      def nazrin_doc_client
+        class_variable_get(:@@nazrin_doc_client)
+      end
+
+      def nazrin_eval_field_data(obj)
+        data = {}
+        class_variable_get(
+          :@@nazrin_search_field_data).each do |field, block|
+            data[field] = obj.instance_eval(&block)
+            data[field] = data[field].remove(
+              /[[:cntrl:]]/) if data[field].is_a?(String)
+          end
+        data
+      end
+
+      def nazrin_add_document(obj)
+        nazrin_doc_client.add_document(
+          obj.send(:id), nazrin_eval_field_data(obj))
+      end
+
+      def nazrin_update_document(obj)
+        nazrin_add_document(obj)
+      end
+
+      def nazrin_delete_document(obj)
+        nazrin_doc_client.delete_document(obj.send(:id))
+      end
+    end
+  end
+end

data/lib/nazrin/version.rb

@@ -1,3 +1,3 @@
 module Nazrin
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 end

data/nazrin.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'mongoid'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nazrin
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Tomohiro Suwa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for Amazon CloudSearch (aws-sdk), with optional ActiveRecord
   support for easy integration with your Rails application
 email:
@@ -170,13 +184,15 @@ files:
 - lib/generators/nazrin/config_generator.rb
 - lib/generators/nazrin/templates/nazrin_config.rb
 - lib/nazrin.rb
-- lib/nazrin/active_record/data_accessor.rb
-- lib/nazrin/active_record/searchable.rb
 - lib/nazrin/config.rb
+- lib/nazrin/data_accessor.rb
+- lib/nazrin/data_accessor/active_record.rb
+- lib/nazrin/data_accessor/mongoid.rb
 - lib/nazrin/document_client.rb
 - lib/nazrin/paginated_array.rb
 - lib/nazrin/pagination_generator.rb
 - lib/nazrin/search_client.rb
+- lib/nazrin/searchable.rb
 - lib/nazrin/version.rb
 - nazrin.gemspec
 homepage: https://github.com/tsuwatch/nazrin

data/lib/nazrin/active_record/data_accessor.rb

@@ -1,55 +0,0 @@
-module Nazrin
-  module ActiveRecord
-    class DataAccessor
-      def initialize(model, options)
-        @model = model
-        @options = options
-      end
-
-      # a list of all matching AR model objects
-      def results(client)
-        @client = client
-
-        res = @client.search
-        collection = load_all(res.data.hits.hit.map(&:id))
-
-        if @client.parameters[:size] && @client.parameters[:start]
-          total_count = res.data.hits.found
-
-          Nazrin::PaginationGenerator.generate(
-            collection,
-            current_page: current_page,
-            per_page: @client.parameters[:size],
-            total_count: total_count,
-            last_page: last_page(total_count))
-        else
-          collection
-        end
-      end
-
-      # load from activerecord
-      def load_all(ids)
-        records_table = {}
-        @options.each do |k, v|
-          @model = @model.send(k, v)
-        end
-        @model.where(id: ids).each do |record|
-          records_table[record.id] = record
-        end
-        ids.map do |id|
-          records_table.select { |k, _| k == id.to_i }[id.to_i]
-        end.reject(&:nil?)
-      end
-
-      private
-
-      def last_page(total_count)
-        (total_count / @client.parameters[:size].to_f).ceil
-      end
-
-      def current_page
-        (@client.parameters[:start] / @client.parameters[:size].to_f).ceil + 1
-      end
-    end
-  end
-end

data/lib/nazrin/active_record/searchable.rb

@@ -1,95 +0,0 @@
-require 'active_support/concern'
-
-module Nazrin
-  module ActiveRecord
-    module Searchable
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method :delete_from_index, :nazrin_delete_from_index unless method_defined? :delete_from_index
-        alias_method :add_to_index, :nazrin_add_to_index unless method_defined? :add_to_index
-        alias_method :update_in_index, :nazrin_update_in_index unless method_defined? :update_in_index
-      end
-
-      def nazrin_delete_from_index
-        self.class.nazrin_delete_document(self)
-      end
-
-      def nazrin_add_to_index
-        self.class.nazrin_add_document(self)
-      end
-
-      def nazrin_update_in_index
-        self.class.nazrin_update_document(self)
-      end
-
-      module ClassMethods
-        def self.extended(base)
-          class << base
-            alias_method :search, :nazrin_search unless method_defined? :search
-            alias_method :searchable, :nazrin_searchable unless method_defined? :searchable
-            alias_method :fields, :nazrin_fields unless method_defined? :fields
-            alias_method :field, :nazrin_field unless method_defined? :field
-          end
-        end
-
-        def nazrin_search(options = {})
-          client = Nazrin::SearchClient.new
-          client.data_accessor = Nazrin::ActiveRecord::DataAccessor.new(
-            self, options)
-          client
-        end
-
-        def nazrin_searchable(&block)
-          class_variable_set(
-            :@@nazrin_doc_client,
-            Nazrin::DocumentClient.new)
-          class_variable_set(:@@nazrin_search_field_data, {})
-          block.call
-        end
-
-        def nazrin_fields(fields)
-          field_data = class_variable_get(:@@nazrin_search_field_data)
-          fields.each do |field|
-            field_data[field] = proc { public_send(field) }
-          end
-          class_variable_set(:@@nazrin_search_field_data, field_data)
-        end
-
-        def nazrin_field(field, &block)
-          field_data = class_variable_get(:@@nazrin_search_field_data)
-          field_data[field] = block
-          class_variable_set(:@@nazrin_search_field_data, field_data)
-        end
-
-        def nazrin_doc_client
-          class_variable_get(:@@nazrin_doc_client)
-        end
-
-        def nazrin_eval_field_data(obj)
-          data = {}
-          class_variable_get(
-            :@@nazrin_search_field_data).each do |field, block|
-              data[field] = obj.instance_eval(&block)
-              data[field] = data[field].remove(
-                /[[:cntrl:]]/) if data[field].is_a?(String)
-            end
-          data
-        end
-
-        def nazrin_add_document(obj)
-          nazrin_doc_client.add_document(
-            obj.send(:id), nazrin_eval_field_data(obj))
-        end
-
-        def nazrin_update_document(obj)
-          nazrin_add_document(obj)
-        end
-
-        def nazrin_delete_document(obj)
-          nazrin_doc_client.delete_document(obj.send(:id))
-        end
-      end
-    end
-  end
-end