redis_app_join 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 443ea24957f1e3e8ea260db70ac1206aefee6be9
-  data.tar.gz: be5d4b45715e15ef856fb3bd3ce0f92fc183baff
+  metadata.gz: f0254b1ea1caa6281771b11bb2457c7c27e0e1ca
+  data.tar.gz: f51c7597abee8e79fec7034a9fce12f5f1e1782d
 SHA512:
-  metadata.gz: 3c649246ab9a2770fd5570877bc5490aafe8b86d7880f192a5bc4a5ddbb7d00d0fcf134e035a1ef16e7e1db6d5d231892ba7272d8b3fd56fbd801bd4b584ac1a
-  data.tar.gz: 8c747b2de354770ebb916a23a75e51b5a078b48b56cea9ac866971591b036b34a4c3ec75cd171be00269f08eedca35934d08bde93a4f514d7ccd92402e57f80a
+  metadata.gz: bf7863cac7483b98c5bf03b8aa20794d98b7d907a3764e23264ec0e5f578ddc471901a48c045fe5cd3b6121f4b6b71b1af1ce739d3d3398c3eab383861bdc75f
+  data.tar.gz: 35b9feb9220403d25edb0be5402430a15998705ad127c64a6c385562e55fdd62c820ab3e37829cdc6bbff041cd2818ce6bc83af94f204a966f2da0be2fd82e80

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+*.gem

data/README.md

@@ -33,7 +33,7 @@ In the Ruby class where you need to implement application-side join add `include
 
 ```ruby
 class ReportGen
-include RedisAppJoin
+  include RedisAppJoin
   def perform
     comments = Comment.gte(created_at: Date.yesterday).only(:body, :article_id)
     cache_records(records: comments)
@@ -47,7 +47,7 @@ include RedisAppJoin
     user_ids = fetch_records_field(record_class: 'Article', record_ids: article_ids, field: 'user_id')
     users = User.in(id: user_ids).only(:name)
     cache_records(records: users)
-    # => instead of using cached comments we just query DB again
+    # => instead of using cached comments we could query DB again
     cached_comments = fetch_records(record_class: 'Comment', record_ids: comment_ids)
     cached_comments.each do |comment|
       article = fetch_records(record_class: 'Article', record_ids: [comment.article_id]).first
@@ -59,14 +59,6 @@ include RedisAppJoin
 end
 ```
 
-`cache_records` expects an array of [ActiveModels](http://api.rubyonrails.org/classes/ActiveModel/Model.html).  It will loop through them creating keys using combination of class and ID.  Hash value will be record's attributes.  
-
-`delete_records` expects an array ActiveModels.  You can pass different types of records (users and articles) in the same method call.  
-
-`fetch_records` expects class name and array of IDs.  It will return an array of objects and include the original record ID as one of the attributes for each object.  
-
-`fetch_records_field` expects class name, array of IDs and the field name you want.  It will return an array of values for that feild.
-
 Data in Redis will be stored like this:
 
 ```ruby
@@ -97,6 +89,10 @@ You can do `article.title` and `user = fetch_records(record_class: 'User', recor
 
 Write tests
 
+Default TTL of 1.week
+
+Support JSON structures in caching (getting data from API), not just ActiveModels
+
 Support non-string fields.  For example, if your DB supports array fields you cannot store those attributes in Redis hash values.  
 
 Methods to fetch associated records so we can do `article.user.name` from Redis cache.

data/lib/redis_app_join.rb

@@ -2,6 +2,12 @@ require "redis_app_join/version"
 
 module RedisAppJoin
 
+  # will loop through records creating keys using combination of class and ID.
+  # can combine different record types (Users and Articles) in the same method call
+  # record's attributes will be hash fields
+  #
+  # @see https://github.com/dmitrypol/redis_app_join
+  # @param records [Array] ActiveModels to cache
   def cache_records(records:)
     records.each do |record|
       key = [record.class.name, record.id.to_s].join(':')
@@ -10,6 +16,10 @@ module RedisAppJoin
     end
   end
 
+  # used to delete cached records after the process is done
+  # can combine different record types (Users and Articles) in the same method call
+  #
+  # @param records [Array] ActiveModels to delete
   def delete_records(records:)
     records.each do |record|
       key = [record.class.name, record.id.to_s].join(':')
@@ -17,10 +27,16 @@ module RedisAppJoin
     end
   end
 
+  # fetch recors from cache,
+  # cannot combine different record types (Users and Articles) in the same method call
+  #
+  # @param record_class [String] - name of class, used in lookup
+  # @param record_ids [Array] array of IDs to lookup
+  # @return [Array] array of objects and include the original record ID as one of the attributes for each object.
   def fetch_records(record_class:, record_ids:)
     output = []
     record_ids.each do |record_id|
-      key = [record_class.titleize, record_id.to_s].join(':')
+      key = [record_class, record_id.to_s].join(':')
       data = REDIS_APP_JOIN.hgetall(key)
       # => add the key as ID attribute
       output << OpenStruct.new(data.merge(id: record_id.to_s))
@@ -28,14 +44,22 @@ module RedisAppJoin
     return output
   end
 
+  # retrieves specific field for an array or records (all user_ids for articles)
+  # only returns the field if it's present
+  # cannot combine different record types in the same method call
+  #
+  # @param record_class [String] - name of class, used in lookup
+  # @param record_ids [Array] array of IDs to lookup
+  # @param field [String] name of field/attribute to retrieve
+  # @return [Array] array of unique strings
   def fetch_records_field(record_class:, record_ids:, field:)
     output = []
     record_ids.each do |record_id|
-      key = [record_class.titleize, record_id.to_s].join(':')
+      key = [record_class, record_id.to_s].join(':')
       data = REDIS_APP_JOIN.hget(key, field)
       output << data
     end
-    return output
+    return output.uniq
   end
 
 end

data/lib/redis_app_join/version.rb

@@ -1,3 +1,3 @@
 module RedisAppJoin
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/redis_app_join.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dmitrypol@gmail.com"]
 
   spec.summary       = %q{Uses Redis to cache data for application-side joins.}
-  spec.description   = %q{Instead of building your own data structures why not use Redis Hashes.}
+  spec.description   = %q{Uses Redis hashes to cache data for application-side joins instead of building internal own data structures.}
   spec.homepage      = "https://github.com/dmitrypol/redis_app_join"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_app_join
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dmitry Polyakovsky
@@ -120,7 +120,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-description: Instead of building your own data structures why not use Redis Hashes.
+description: Uses Redis hashes to cache data for application-side joins instead of
+  building internal own data structures.
 email:
 - dmitrypol@gmail.com
 executables: []