modis 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d72c95fa261834b9a837e642e63e3ef9094e6a00
-  data.tar.gz: d43a8f952fc05fc725adc94354d77ef4d8318a98
+  metadata.gz: bb24ac739595677e1200448641dc4e7c35a26f1d
+  data.tar.gz: 428715902d2b7e335e16d7ee2b65aa58c3864b52
 SHA512:
-  metadata.gz: 8cf44d0818eb8c163064cee228732b1d86811b08475c033f45b90a4b23cc8e0fc8a1fe030c6822c4ae1e69e7e0873d53a3f0d304572ad3d538ad3d6c18a7490d
-  data.tar.gz: 1293bc123e53195e5cc5e44c4b77669a52927e5fd6ec3ee20c3523fc3f0ff875905b861a02be07c0f276e2571e951ba35d73d0bf1ef03b59da7139adf3594e00
+  metadata.gz: 7f34d83dd16b16bd113a116d060523c8f832593f604e318077be24d279d8a9f06ce269f86a3935f5fbe8e1a70d815075a54f69c9ee3f4d45eaa0fafc211a461e
+  data.tar.gz: a3451db68ba6943d667fb11470c9635dfb0c74ac9449b330125ffe7be4d9b0c3e94df459d8a2acb8ab0069a6fa80fadf4c83a8630898ef26c023857f34cfa473

data/README.md

@@ -36,6 +36,19 @@ end
 MyModel.create!(:name => 'Ian', :age => 28)
 ```
 
+### all index
+
+Modis, by default, creates an `all` index in redis in which it stores all the IDs for records created. As a result, a large amount of memory will be consumed if many ids are stored. The `all` index functionality can be turned off by using `enable_all_index`
+
+```ruby
+  class MyModel
+    include Modis::Model
+    enable_all_index false
+  end
+```
+
+By disabling the `all` index functionality, the IDs of each record created won't be saved. As a side effect, using `all` finder method will raise a `IndexError` exception as we would not have enough information to fetch all records. See https://github.com/ileitch/modis/pull/7 for more context.
+
 ## Supported Features
 
 TODO.

data/lib/modis/finder.rb

@@ -13,6 +13,11 @@ module Modis
       end
 
       def all
+        unless all_index_enabled?
+          raise IndexError, "Unable to retrieve all records of #{name}, "\
+            "because you disabled all index. See :enable_all_index for more."
+        end
+
         records = Modis.with_connection do |redis|
           ids = redis.smembers(key_for(:all))
           redis.pipelined do

data/lib/modis/persistence.rb

@@ -61,6 +61,14 @@ module Modis
         "#{sti_base_absolute_namespace}:#{id}"
       end
 
+      def enable_all_index(bool)
+        @use_all_index = bool
+      end
+
+      def all_index_enabled?
+        @use_all_index == true || @use_all_index.nil?
+      end
+
       def create(attrs)
         model = new(attrs)
         model.save
@@ -128,8 +136,10 @@ module Modis
         run_callbacks :destroy do
           redis.pipelined do
             remove_from_indexes(redis)
-            redis.srem(self.class.key_for(:all), id)
-            redis.srem(self.class.sti_base_key_for(:all), id) if self.class.sti_child?
+            if self.class.all_index_enabled?
+              redis.srem(self.class.key_for(:all), id)
+              redis.srem(self.class.sti_base_key_for(:all), id) if self.class.sti_child?
+            end
             redis.del(key)
           end
         end
@@ -198,8 +208,10 @@ module Modis
               future = attrs.any? ? redis.hmset(key, attrs) : :unchanged
 
               if new_record?
-                redis.sadd(self.class.key_for(:all), id)
-                redis.sadd(self.class.sti_base_key_for(:all), id) if self.class.sti_child?
+                if self.class.all_index_enabled?
+                  redis.sadd(self.class.key_for(:all), id)
+                  redis.sadd(self.class.sti_base_key_for(:all), id) if self.class.sti_child?
+                end
                 add_to_indexes(redis)
               else
                 update_indexes(redis)

data/lib/modis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modis
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/finder_spec.rb

@@ -22,6 +22,10 @@ module FindersSpec
 
   class Worker < Producer
   end
+
+  class UserNoAllIndex < User
+    enable_all_index false
+  end
 end
 
 describe Modis::Finder do
@@ -67,6 +71,12 @@ describe Modis::Finder do
       model.destroy
       expect(FindersSpec::User.all).to eq([])
     end
+
+    it 'throws error when enable_all_index option is set to false' do
+      FindersSpec::UserNoAllIndex.create!(name: 'Yana')
+      expect { FindersSpec::UserNoAllIndex.all }
+        .to raise_error(Modis::IndexError)
+    end
   end
 
   it 'identifies a found record as not being new' do

data/spec/persistence_spec.rb

@@ -47,6 +47,10 @@ module PersistenceSpec
       called_callbacks << :test_before_save
     end
   end
+
+  class MockModelNoAllIndex < MockModel
+    enable_all_index false
+  end
 end
 
 describe Modis::Persistence do
@@ -296,4 +300,22 @@ describe Modis::Persistence do
       expect(model.update_attributes(name: nil)).to be false
     end
   end
+
+  describe 'key for all records' do
+    let(:all_key_name) { "#{PersistenceSpec::MockModel.absolute_namespace}:all" }
+
+    describe 'when :enable_all_index option is set to false' do
+      it 'does not save new record to the *:all key' do
+        model = PersistenceSpec::MockModel.create!(name: 'Sage')
+        expect(Redis.new.smembers(all_key_name).map(&:to_i)).to include(model.id)
+      end
+    end
+
+    describe 'when :enable_all_index option is set to false' do
+      it 'does not save new record to the *:all key' do
+        model = PersistenceSpec::MockModelNoAllIndex.create!(name: 'Alex')
+        expect(Redis.new.smembers(all_key_name).map(&:to_i)).to_not include(model.id)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modis
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel