mongoid_cache_store 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1a24e1f86de642ea4996c917ef482d288d35c13
-  data.tar.gz: f24f6b65d4cf2e66c7b4ba6ec0a95e8cd64a99d9
+  metadata.gz: c75675a4b3ebb01dc4faea3cdcc77e59620e1014
+  data.tar.gz: 4db06917b8bfc8f706d1df5d0ddbc04f89300755
 SHA512:
-  metadata.gz: 6f0096d63056098e5fc8375c631f237f8dda1b005a260a0fc424ce4a197b39825c2b4ce23d4b59aec515689c4e109c4fadc2e5fac714410bbe0c95cd31acb28e
-  data.tar.gz: d9c387013b044778bf5bbbe992cced0d2ca74943e561152a98087f2b22d8035cf38512b7368b12945830df95ca81b7ff968f85fbcdba75586e69c4d32f3afbd6
+  metadata.gz: c934082e5159e27fa6bfe534617d18c198965e83f4b4a47bc4dba158387f60500e0613286cefd676cb7de0ac67785a8df136f4154e97a8721c7d8fecf72822c3
+  data.tar.gz: cc20747f1ccb773fa654c01fd3e89c83d0dbd7b99d2d1872960ddb9e0d88d937924eb0beb2b5474ced8a38774c51ab132247aa1acb552c6bbbe703e433717cd6

data/README.md

@@ -1,8 +1,6 @@
 # MongoidCacheStore
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mongoid_cache_store`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+MongoidCacheStore helps in reducing the number of queries to the database.
 
 ## Installation
 
@@ -21,8 +19,41 @@ Or install it yourself as:
     $ gem install mongoid_cache_store
 
 ## Usage
+For ex:
+```ruby
+class User
+  include Mongoid::Document
+  belongs_to :image, class_name: UserImage, inverse_of: nil
+  # other user fields goes here
+end
+
+class UserImage
+  include Mongoid::Document
+
+  # image field goes here
+end
+```
+
+Now, in order to display list of users on a listing page, we need data for users including their image url.
+Accessing image method again & again will increase number of queries.
+
+```ruby
+cache_store = CacheStore.new.cache_docs(user_ids, User, [{field_name: 'image_id', klass: UserImage}])
+user = cache_store.document(user_id, User)
+user_image = cache_store.document(user.image_id, UserImage)
+```
 
-TODO: Write usage instructions here
+To fetch all documents of a particular klass cached.
+```ruby
+cache_store = CacheStore.new.cache_docs(user_ids, User, [{field_name: 'image_id', klass: UserImage}])
+users = cache_store.sorted_documents(User)
+```
+
+To fetch list of documents for a list of ids ordered as per ids list.
+```ruby
+cache_store = CacheStore.new.cache_docs(user_ids, User, [{field_name: 'image_id', klass: UserImage}])
+users = cache_store.sorted_documents(User, cusrom_user_ids)
+```
 
 ## Development
 

data/lib/mongoid_cache_store.rb

@@ -4,6 +4,7 @@ module MongoidCacheStore
 end
 
 class CacheStore
+
   def initialize
     @doc_ids_hash = {}
     @related_docs_hash = {}
@@ -12,7 +13,7 @@ class CacheStore
 
 #  [{field_name: 'image_id', klass: Users::ProfileImage}]
   def cache_docs(doc_ids, doc_class, related_infos = [])
-    doc_type = doc_class.model_name.underscore
+    doc_type = doc_class.to_s.underscore
     @doc_ids_hash[doc_type] ||= {}
     [doc_ids].flatten.compact.uniq.each{|doc_id| @doc_ids_hash[doc_type][doc_id.to_s] = nil}
     @related_docs_hash[doc_type] ||= []
@@ -23,22 +24,21 @@ class CacheStore
 
   def document(doc_id, doc_class)
     return nil if doc_id.blank?
-    doc_type = doc_class.model_name.underscore
-    ensure_query(doc_class, doc_id.to_s.to_a)
+    doc_type = doc_class.to_s.underscore
+    ensure_query(doc_class, doc_id)
 
     @documents[doc_type][doc_id.to_s]
   end
 
   def valid_doc_ids(doc_class, doc_ids = nil)
-    doc_type = doc_class.model_name.underscore
-    ensure_query(doc_class, doc_ids.map(&:to_s))
+    doc_type = doc_class.to_s.underscore
+    ensure_query(doc_class, doc_ids)
 
     doc_ids.blank? ? cached_ids(doc_type) : doc_ids.select{|doc_id| @documents[doc_type][doc_id.to_s].present?}
   end
 
   def sorted_documents(doc_class, doc_ids = nil)
-    doc_type = doc_class.model_name.underscore
-    doc_ids = doc_ids.map(&:to_s) if doc_ids != nil
+    doc_type = doc_class.to_s.underscore
     ensure_query(doc_class, doc_ids)
     return [] if @documents[doc_type].blank?
 
@@ -56,7 +56,8 @@ class CacheStore
 
   # ensure that there are no missing docs for doc_class
   def ensure_query(doc_class, doc_ids)
-    doc_type = doc_class.model_name.underscore
+    doc_ids = [doc_ids].flatten.uniq.map(&:to_s)
+    doc_type = doc_class.to_s.underscore
 
     if doc_ids.present? && (@doc_ids_hash[doc_type].blank? || doc_ids.reject{|doc_id| @doc_ids_hash[doc_type].has_key?(doc_id.to_s)}.present?)
       cache_docs(doc_ids, doc_class)

data/lib/mongoid_cache_store/version.rb

@@ -1,3 +1,3 @@
 module MongoidCacheStore
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_cache_store
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Amit Chaudhary
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-23 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Module to cache documents from belongs_to relationship in a single query