elasticsearch-rails-dynamic-json-support 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e85e58d9e5a62bdd3b7655df5cd3e598b5891483
-  data.tar.gz: c2a6e09a1bb1fa8fc06cda7d9d41a5a2031a4afb
+  metadata.gz: 32d652e44a9c8d46c731096776d6a497d9cb8cf3
+  data.tar.gz: d64a1aae4f1bad05cebcfec376f848024ce6b93f
 SHA512:
-  metadata.gz: 98224260289cfb9db249661a8010ac72837e735290dd7448b5deb123cfb7434bd1743ca0fd005465c9d0a57212c1de832ebc122993f5ac5a5cdb03f9e8d59e61
-  data.tar.gz: 59ac4629c3fd231a6a246dc75af1a6ce1ab7f8ac3f8857fd589acc2cc695b770adb362305a918dbd7ad7ac9773a44e470c538927be553432313d6b8c2dd778ca
+  metadata.gz: 1ea410e65b98eaf8d25323a3bb7fccb7fa5d32ea0a24623a7e1c64812048f86d85f2f483d8cded1eaf6403fb63d712e8677059c57a3cd12468199d61197ac445
+  data.tar.gz: 39525f858190479557b85197654eec43d7b0fea400585bfc005430637dd155940a277654e5b84bff26c347d5d0471515b859d9aeeccdacb31fb9584fca087656

data/Gemfile

@@ -9,9 +9,10 @@ source "https://rubygems.org"
 gem 'elasticsearch-rails', "~> 0.1.9"
 
 group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
-  gem "simplecov", ">= 0"
+  gem 'shoulda', '>= 0'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0.1'
+  gem 'simplecov', '>= 0'
+  gem 'concurrent-ruby'
 end

data/Gemfile.lock

@@ -75,11 +75,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
+  concurrent-ruby
   elasticsearch-rails (~> 0.1.9)
   jeweler (~> 2.0.1)
   rdoc (~> 3.12)
   shoulda
   simplecov
-
-BUNDLED WITH
-   1.12.5

data/README.md

@@ -0,0 +1,121 @@
+# Introduction
+
+ElasticsearchRails DynamicJsonSupport - Small little change to help your model update easier in elasticsearch.
+
+## Problem it solved
+
+In ElasicSearch, if you define your model the following way:
+
+    ```ruby
+		# app/models/article.rb
+		class Article < ActiveRecord::Base
+			include Elasticsearch::Model
+			include Elasticsearch::Model::Callbacks
+
+			has_many :reviews
+
+			def as_indexed_json options={}
+				{
+						id: id,
+						title: title,
+						article: content,
+						created_at: created_at,
+						updated_at: updated_at,
+						reviews: reviews.map(&:as_json),
+				}
+			end
+
+		# app/models/review.rb
+		class Review < ActiveRecord::Base
+			belongs_to :article
+		end
+    ```
+
+There're 2 issues with the implementation above:
+
+1. when the `content` is updated, this change would never be synced to the the
+   `article` field in ElasticSearch, since the key is `artile` instead
+2. when the corresponding review is updated, the `article` is never updated,
+   since it's not awared of the change.
+
+This library aims to solve these 2 issues, with the following convention:
+
+- `es_json_changes(changed_attributes)` - for a given set of changed attributes,
+  it would response with the update to be processed by this record
+- `Elasticsearch::Model::CascadeUpdate` - class, when included, providing:
+  - class methods:
+    - `es_register_attributes { key => lambda }`: to register a hash of `key, 
+      lambda` pairs, to be used for rendering the json. if lambda is nil,
+      default to the public method of this resource named `key`.
+    - `key_name, relationship_name: nil, reverse_relationship_name: nil, &blk`:
+      to register an association of key, lambda. relationship_name default to
+      key if not given, and reverse_relationship_name default to the singular
+      form of the class name if not given. After this registration, whenever the
+      corresponding resource is updated, it would trigger this resource (which
+      is related to the resource) to update.
+
+Example usage (which solves the 2 issues above) is as given below:
+
+    ```ruby
+		# app/models/article.rb
+		class Article < ActiveRecord::Base
+			include Elasticsearch::Model
+			include Elasticsearch::Model::Callbacks
+			include Elasticsearch::Model::CascadeUpdate
+
+			has_many :reviews
+			es_register_attributes id: nil, title: nil, article: lambda {|rec| rec.content }, created_at: nil, updated_at: nil
+			es_register_assoc(:reviews) { |review| review.as_indexed_json }
+
+			def elasticsearch_json_changes(changed_attributes)
+				keys_to_update = changed_attributes.keys.map {|k| key_map k}
+				self.as_indexed_json.select { |k,_| keys_to_update.include? k.to_s }
+			end
+
+			private
+			def key_map(key)
+				key = key.to_s
+				case key
+				when 'content'
+					'article'
+				else
+					key
+				end
+			end
+		end
+
+		# app/models/review.rb
+		class Review < ActiveRecord::Base
+			# Make sure to register Article
+			Article
+
+			belongs_to :article
+
+			def as_indexed_json(options = {})
+				as_json
+			end
+		end
+    ```
+
+# Issues
+
+- Tests.. since I don't have time to write test case for this project yet.
+- Due to the `lazy-loading` of model in rails, you need to specifically specify
+  the model in rails. Like in the `Review` class above, it's reference to
+  `Article` 
+
+== Contributing to elasticsearch-rails-dynamic-json-support
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2016 Song Yangyu. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/elasticsearch-rails-dynamic-json-support.gemspec

@@ -2,32 +2,34 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: elasticsearch-rails-dynamic-json-support 0.0.1 ruby lib
+# stub: elasticsearch-rails-dynamic-json-support 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "elasticsearch-rails-dynamic-json-support".freeze
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Song Yangyu".freeze]
-  s.date = "2016-08-26"
+  s.date = "2016-08-30"
   s.description = "Enhance elasticsearch-rails with `elasticsearch_json_changes` to translate the attribute changes into document updates".freeze
   s.email = "flyfy1@gmail.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "elasticsearch-rails-dynamic-json-support.gemspec",
     "lib/elasticsearch-rails-dynamic-json-support.rb",
+    "lib/elasticsearch/model/cascade_update.rb",
+    "lib/elasticsearch/model/indexing_decorator.rb",
     "test/helper.rb",
     "test/test_elasticsearch-rails-dynamic-json-support.rb"
   ]
@@ -46,6 +48,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_development_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
     else
       s.add_dependency(%q<elasticsearch-rails>.freeze, ["~> 0.1.9"])
       s.add_dependency(%q<shoulda>.freeze, [">= 0"])
@@ -53,6 +56,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
       s.add_dependency(%q<jeweler>.freeze, ["~> 2.0.1"])
       s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
     end
   else
     s.add_dependency(%q<elasticsearch-rails>.freeze, ["~> 0.1.9"])
@@ -61,6 +65,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
     s.add_dependency(%q<jeweler>.freeze, ["~> 2.0.1"])
     s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
   end
 end
 

data/lib/elasticsearch-rails-dynamic-json-support.rb

@@ -1,23 +1,4 @@
-module Elasticsearch
-  module Model
-    module Indexing
-      module InstanceMethods
-        def update_document options = {}
-          if changed_attributes = self.instance_variable_get(:@__changed_attributes)
-            attributes = if target.respond_to? :elasticsearch_json_changes
-                           target.elasticsearch_json_changes changed_attributes
-                         elsif respond_to?(:as_indexed_json)
-                           self.as_indexed_json.select { |k,v| changed_attributes.keys.map(&:to_s).include? k.to_s }
-                         else
-                           changed_attributes
-                         end
+require 'elasticsearch/model'
 
-            update_document_attributes attributes, options
-          else
-            index_document(options)
-          end
-        end
-      end
-    end
-  end
-end
+require_relative 'elasticsearch/model/indexing_decorator'
+require_relative 'elasticsearch/model/cascade_update'

data/lib/elasticsearch/model/cascade_update.rb

@@ -0,0 +1,107 @@
+module Elasticsearch
+  module Model
+    module CascadeUpdate
+
+      # Only for internal use. Holds the mapping from relationship, to the corresponding json
+      class Actor
+        def initialize(relationship_name, singularity, resource_to_json)
+          @relationship_name = relationship_name
+          @singularity = singularity.to_sym
+          @resource_to_json = resource_to_json
+        end
+
+        def to_json(record)
+          resource = record.public_send @relationship_name
+          if(@singularity == :plural)
+            resource.map {|record| @resource_to_json[record] }
+          else  # treat it as singular otherwise
+            @resource_to_json[resource]
+          end
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      # update, just for a specific key, or set of keys
+      def es_partial_update(*keys)
+        keys = keys.map(&:to_s)
+
+        res_json = {}
+        keys.each do |key|
+          res_json[key] = self.class.es_register_assoc(key).to_json(self)
+        end
+
+        self.__elasticsearch__.update_document_attributes res_json
+      end
+
+      def as_indexed_json(options = {})
+        self.class.to_indexed_json(self, options)
+      end
+
+      class_methods do
+
+        # attributes is a pair of <key, block>
+        def es_register_attributes attributes
+          attributes.each do |k, v|
+            k = k.to_s
+            json_attribute_registry[k] = v || lambda { |record| record.public_send k }
+          end
+        end
+
+        # default `reverse_relationship_name` to be singular case if not given
+        def es_register_assoc key_name, relationship_name: nil, reverse_relationship_name: nil, &blk
+          key_name = key_name.to_s
+          return json_relationship_registry[key_name] unless blk
+
+          relationship_name = key_name unless relationship_name
+          reverse_relationship_name = self.name.downcase unless reverse_relationship_name
+
+          reflection = reflect_on_association relationship_name
+          reflected_class = reflection.class_name.constantize
+
+          actor = Actor.new relationship_name, get_singularity(reflection), blk
+          json_relationship_registry[key_name] = actor
+
+          reflected_class.class_eval do
+            after_commit do
+              Array.wrap(self.public_send reverse_relationship_name).each do |record|
+                record.es_partial_update(key_name)
+              end
+            end
+          end
+        end
+
+        def to_indexed_json(record, options = {})
+          result = {}
+          json_attribute_registry.each do |k, blk|
+            result[k] = blk[record]
+          end
+
+          json_relationship_registry.each do |k, actor|
+            result[k] = actor.to_json(record)
+          end
+
+          result
+        end
+
+        private
+        def json_relationship_registry
+          @@__json_actor_registry_ ||= {}
+        end
+
+        def json_attribute_registry
+          @@__json_attribute_registry ||= {}
+        end
+
+        def get_singularity(reflection)
+          case reflection
+          when ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasManyThroughAssociation
+            :plural
+          else
+            :singular
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/model/indexing_decorator.rb

@@ -0,0 +1,23 @@
+module Elasticsearch
+  module Model
+    module Indexing
+      module InstanceMethods
+        def update_document options = {}
+          if changed_attributes = self.instance_variable_get(:@__changed_attributes)
+            attributes = if target.respond_to? :elasticsearch_json_changes
+                           target.elasticsearch_json_changes changed_attributes
+                         elsif respond_to?(:as_indexed_json)
+                           self.as_indexed_json.select { |k,v| changed_attributes.keys.map(&:to_s).include? k.to_s }
+                         else
+                           changed_attributes
+                         end
+
+            update_document_attributes attributes, options
+          else
+            index_document(options)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-rails-dynamic-json-support
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Song Yangyu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch-rails
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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: Enhance elasticsearch-rails with `elasticsearch_json_changes` to translate
   the attribute changes into document updates
 email: flyfy1@gmail.com
@@ -101,17 +115,19 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - ".document"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - elasticsearch-rails-dynamic-json-support.gemspec
 - lib/elasticsearch-rails-dynamic-json-support.rb
+- lib/elasticsearch/model/cascade_update.rb
+- lib/elasticsearch/model/indexing_decorator.rb
 - test/helper.rb
 - test/test_elasticsearch-rails-dynamic-json-support.rb
 homepage: http://github.com/flyfy1/elasticsearch-rails-dynamic-json-support

data/README.rdoc

@@ -1,19 +0,0 @@
-= elasticsearch-rails-dynamic-json-support
-
-Description goes here.
-
-== Contributing to elasticsearch-rails-dynamic-json-support
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2016 Song Yangyu. See LICENSE.txt for
-further details.
-