query_dam 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 896fed6360b0b9d3dff21df3ddfb3109e6c5e74d
-  data.tar.gz: 8e8dd8cab4f43b37d30fa548d02eeea2dee520af
+  metadata.gz: 9fb87fd1ffa39623b5adcb2ec69a061b3bdc0900
+  data.tar.gz: 09d263f82734c093d57a7ac2810a3b35dcbe2d1b
 SHA512:
-  metadata.gz: df5ab48a678f172d00bb7deeb3c9cc844b3f4b50d4457c45eccaa8bfc2b7a7cffc4e421c0591e0e44c26d178daa3e474cc7fd1708f52a4d59ac1c4b6bb586481
-  data.tar.gz: 0994927b0d92dba970edd53b4175cec6ffc928da638f8c584e769679e629fc2e3813eaecddbac035f172ada51ea14f57dd9df52acdab2fa585ec6bbe1f0fdc37
+  metadata.gz: c2b1dd2cb8e77c6e00dd83ef81736640cd4a3e871936fcdaf7de3236db5456c9641438047c625924a498b503e89ae1b43a149a01cd869c017cd9e90e0ae4ee31
+  data.tar.gz: 533a36a6251442c1fc25c9c3868ed7e402aea8619ee27883642c7d3809791e61213fd40885dbd56367a607d3c3da3747affae973d741c21c8865a121391cdc7e

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 *.sqlite3
+.ruby-version

data/.travis.yml

@@ -1,4 +1,4 @@
 rvm:
-  - 2.1.1
+  - 2.1.2
 
 script: 'bundle exec rake spec'

data/README.md

@@ -2,6 +2,7 @@
 [![Build Status](https://travis-ci.org/romankuznietsov/query_dam.svg)](https://travis-ci.org/romankuznietsov/query_dam)
 
 QueryDam is a tool for observing changes in ActiveRecord relation results.
+It uses Redis to store changes metadata.
 
 ## Installation
 
@@ -57,6 +58,13 @@ QueryDam.get_updates(tracking_key)
 #  :exclusions=>[1]}
 ~~~
 
+If updates are not requested for a certain amount of time (5 minutes by default),
+QueryDam will stop observing changes. You can set up expiration time (in an initializer, for example).
+
+~~~ruby
+QueryDam.expiration = 5.minutes
+~~~
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/query_dam/fork )

data/lib/query_dam.rb

@@ -7,45 +7,52 @@ require 'query_dam/concerns/trackable'
 
 module QueryDam
 
-  QUERY_EXPIRE = 5.minutes
+  DEFAULT_EXPIRATION = 5.minutes
 
   class << self
     def watch_relation(relation)
-      key = SecureRandom.uuid
+      tracking_key = SecureRandom.uuid
       query = relation.select("`#{relation.model.table_name}`.`id`").to_sql
-      query_hash = Redis::HashKey.new(key)
+      query_hash = Redis::HashKey.new(tracking_key)
       query_hash.bulk_set(model: relation.model.name, query: query)
-      # query_hash.expire(QUERY_EXPIRE)
-      Redis::Set.new(relation.model.name) << key
-      key
+      query_hash.expire(expiration)
+      Redis::Set.new(relation.model.name) << tracking_key
+      tracking_key
     end
 
-    def get_updates(key)
-      query_hash = Redis::HashKey.new(key)
+    def get_updates(tracking_key)
+      query_hash = Redis::HashKey.new(tracking_key)
       return nil unless query_hash.exists?
+      query_hash.expire(expiration)
 
       model = query_hash[:model].constantize
+      additions_set, updates_set, removals_set = query_sets(tracking_key)
 
-      updated_ids = (additions_set(key).members +
-                     updates_set(key).members).uniq
-      removed_ids = removals_set(key).members
+      updated_ids = (additions_set.members + updates_set.members).uniq
+      removed_ids = removals_set.members
 
       result = {
         model: model,
         updates: model.where(id: updated_ids),
         exclusions: removed_ids.map(&:to_i) }
 
-      additions_set(key).clear
-      updates_set(key).clear
-      removals_set(key).clear
+      [additions_set, updates_set, removals_set].each(&:clear)
 
       result
     end
 
-    %w[additions updates removals].each do |set_type|
-      define_method "#{set_type}_set" do |key|
-        Redis::Set.new("#{key} #{set_type}")
+    def query_sets(tracking_key)
+      %w[additions updates removals].map do |set_type|
+        Redis::Set.new("#{tracking_key} #{set_type}")
       end
     end
+
+    def expiration=(value)
+      @expiration = value
+    end
+
+    def expiration
+      @expiration || DEFAULT_EXPIRATION
+    end
   end
 end

data/lib/query_dam/concerns/trackable.rb

@@ -11,21 +11,20 @@ module QueryDam
     def get_prior_results
       @_prior_results = {}
 
-      queries.each do |key, query|
-        @_prior_results[key] =
+      queries.each do |tracking_key, query|
+        @_prior_results[tracking_key] =
           self.class.connection.select_values(query).map(&:to_i)
       end
     end
 
     def update_queries
-      queries.each do |key, query|
+      queries.each do |tracking_key, query|
         result = self.class.connection.select_values(query).map(&:to_i)
-        added = result - @_prior_results[key]
-        removed = @_prior_results[key] - result
+        added = result - @_prior_results[tracking_key]
+        removed = @_prior_results[tracking_key] - result
 
-        additions_set = QueryDam.additions_set(key)
-        updates_set = QueryDam.updates_set(key)
-        removals_set = QueryDam.removals_set(key)
+        additions_set, updates_set, removals_set =
+          QueryDam.query_sets(tracking_key)
 
         updates_set.add(id) if result.include?(id)
 
@@ -46,17 +45,20 @@ module QueryDam
             removals_set.add(record_id)
           end
         end
+
+        [additions_set, updates_set, removals_set]
+          .each { |set| set.expire(QueryDam.expiration) }
       end
     end
 
     def queries
       queries_set = Redis::Set.new(self.class.name)
-      queries_set.members.reduce({}) do |acc, key|
-        query_hash = Redis::HashKey.new(key)
+      queries_set.members.reduce({}) do |acc, tracking_key|
+        query_hash = Redis::HashKey.new(tracking_key)
         if query_hash.exists?
-          acc.merge(key => query_hash[:query])
+          acc.merge(tracking_key => query_hash[:query])
         else
-          queries_set.delete(key)
+          queries_set.delete(tracking_key)
           acc
         end
       end

data/lib/query_dam/version.rb

@@ -1,3 +1,3 @@
 module QueryDam
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/spec/query_dam_spec.rb

@@ -103,4 +103,34 @@ describe QueryDam do
         {model: Item, updates: [], exclusions: []})
     end
   end
+
+  describe 'expiration' do
+    before :all do
+      QueryDam.expiration = 2
+    end
+
+    let!(:relation) { Item.where(name: 'pen') }
+    let!(:key) { QueryDam.watch_relation(relation) }
+
+    it 'returns nil if expiration time since creation passed' do
+      sleep QueryDam.expiration
+      expect(QueryDam.get_updates(key)).to be_nil
+
+      expect(Redis::HashKey.new(key).exists?).to be_falsey
+      QueryDam.query_sets(key).each do |set|
+        expect(set.exists?).to be_falsey
+      end
+    end
+
+    it 'returns nil if expiration time since last request passed' do
+      expect(QueryDam.get_updates(key)).to be_present
+      sleep QueryDam.expiration
+      expect(QueryDam.get_updates(key)).to be_nil
+
+      expect(Redis::HashKey.new(key).exists?).to be_falsey
+      QueryDam.query_sets(key).each do |set|
+        expect(set.exists?).to be_falsey
+      end
+    end
+  end
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: query_dam
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Kuznietsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: redis-objects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   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'
 - !ruby/object:Gem::Dependency
   name: pry
   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: ''
@@ -143,9 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -167,17 +167,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Detecting query result changes