redis_assist 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e106eceead9af03beab72f68a1b50447fe5b7ef8
-  data.tar.gz: 1074d7edf5d0264c57b1d2b356066983f5226996
+  metadata.gz: 9d4ea0740c8e9da01b4fc9cd16be301974435766
+  data.tar.gz: 4b3a675d57e7a2ee4c7fafb88e731a0a5a3d6fde
 SHA512:
-  metadata.gz: ab3732eb75c8040010dbd40e2b318abea7faa835192a6fc474ae3c0c09f8c4299db014d002e6cc98742f13cc5e01fec0f1362449a935e93a19a1a17f6317308d
-  data.tar.gz: 0f31ad582470bf564cab920d61a9a01d2b00114197e276c87fe1eca2542000907e2b10d22d8bc91991e3c1d4a413cb25d9458db9575349949f63d7473e00f9d2
+  metadata.gz: 869875ea789eabf01018c43aebe0777f4cc4bc712d047728add8f317d73e72ffe40cd992a0df0a49209e705fd93a036d1b9ba0c2e31ccbae2d9c1fbf4f37009a
+  data.tar.gz: f6eaee0706cd91d18240d458d7466d2c5ec8903a46f8cd66429da9a76df10993ca69d950f441ab78b7155ef2f221414936dd75c55c52aab3480e4370843326c5

data/lib/redis_assist.rb

@@ -8,6 +8,7 @@ require 'redis_assist/transform'
 require 'redis_assist/callbacks'
 require 'redis_assist/validations'
 require 'redis_assist/associations'
+require 'redis_assist/finders'
 require 'redis_assist/base'
 require 'redis_assist/utils'
 

data/lib/redis_assist/base.rb

@@ -4,6 +4,10 @@ module RedisAssist
     include Callbacks
     include Validations
     include Associations
+
+
+    extend RedisAssist::Finders
+
   
     def self.inherited(base)
       base.before_create {|record| record.send(:created_at=, Time.now.to_f) if record.respond_to?(:created_at) }
@@ -32,77 +36,6 @@ module RedisAssist
       def count
         redis.zcard(index_key_for(:id))
       end
-
-
-      def all
-        ids = redis.zrange(index_key_for(:id), 0, -1)
-        find(ids)
-      end
-
-
-      def first(limit=1, offset=0)
-        from    = offset
-        to      = from + limit - 1
-        members = redis.zrange(index_key_for(:id), from, to)
-
-        find(limit > 1 ? members : members.first)
-      end
-
-
-      def last(limit=1, offset=0)
-        from    = offset
-        to      = from + limit - 1
-        members = redis.zrange(index_key_for(:id), (to * -1) + -1, (from * -1) + -1).reverse
-
-        find(limit > 1 ? members : members.first)
-      end
-
-
-      def find(ids, opts={})
-        ids.is_a?(Array) ? find_by_ids(ids, opts) : find_by_id(ids, opts)
-      end
-
-
-      # find articles in batches
-      def find_in_batches(params={})
-        start       = params[:start]      || 0
-        marker      = start
-        batch_size  = params[:batch_size] || 500
-        record_ids  = redis.zrange(index_key_for(:id), marker, marker + batch_size - 1)
-
-        while record_ids.length > 0
-          records_count   = record_ids.length
-          marker          += records_count
-          records         = find(record_ids)
-
-          yield records
-
-          break if records_count < batch_size
-
-          record_ids = redis.zrange(index_key_for(:id), marker, marker + batch_size - 1)
-        end
-      end
-
-
-      # Deprecated finds
-      def find_by_id(id, opts={})
-        raw_attributes = load_attributes(id)
-        return nil unless raw_attributes[id][:exists].value
-        obj = new(id: id, raw_attributes: raw_attributes[id])
-        (obj.deleted? && !opts[:deleted].eql?(true)) ? nil : obj
-      end
-  
-
-      def find_by_ids(ids, opts={})
-        attrs = load_attributes(*ids)
-        raw_attributes = attrs
-        ids.each_with_object([]) do |id, instances| 
-          if raw_attributes[id][:exists].value
-            instance = new(id: id, raw_attributes: raw_attributes[id])
-            instances << instance if instance && (!instance.deleted? || opts[:deleted].eql?(true))
-          end
-        end
-      end
   
 
       def create(attrs={})
@@ -111,11 +44,6 @@ module RedisAssist
       end
 
 
-      def exists?(id)
-        redis.exists(key_for(id, :attributes))      
-      end
-
-
       # TODO: needs a refactor. Should this be an interface for skipping validations?
       # Should we optimize and skip the find? Support an array of ids?
       def update(id, params={}, opts={})
@@ -509,6 +437,12 @@ module RedisAssist
     end
 
 
+    def inspect
+      attr_list = self.class.persisted_attrs.map{|key,val| "#{key}: #{send(key).to_s[0, 200]}" } * ", "
+      "#<#{self.class.name} id: #{id}, #{attr_list}>"
+    end
+
+
     protected 
   
   

data/lib/redis_assist/finders.rb

@@ -0,0 +1,102 @@
+module RedisAssist
+  module Finders
+
+    # Checks to see if a record exists for the given `id`
+    # @param id [Integer] the record id
+    # @return [true, false]
+    def exists?(id)
+      redis.exists(key_for(id, :attributes))      
+    end
+ 
+
+    # Find every saved record 
+    # @return [Array] the array of models
+    def all
+      ids = redis.zrange(index_key_for(:id), 0, -1)
+      find(ids)
+    end
+
+
+    # Find the first saved record
+    # @note `first` uses a sorted set as an index of `ids` and finds the lowest id. 
+    # @param limit [Integer] returns one or many
+    # @param offset [Integer] from the beginning of the index, forward.
+    # @return [Base, Array]
+    def first(limit=1, offset=0)
+      from    = offset
+      to      = from + limit - 1
+      members = redis.zrange(index_key_for(:id), from, to)
+
+      find(limit > 1 ? members : members.first)
+    end
+
+
+    # Find the first saved record
+    # @note `last` uses a sorted set as an index of `ids` and finds the highest id. 
+    # @param limit [Integer] returns one or many
+    # @param offset [Integer] from the end of the index, back
+    # @return [Base, Array] 
+    def last(limit=1, offset=0)
+      from    = offset
+      to      = from + limit - 1
+      members = redis.zrange(index_key_for(:id), (to * -1) + -1, (from * -1) + -1).reverse
+
+      find(limit > 1 ? members : members.first)
+    end
+
+    # Find a record by `id`
+    # @param ids [Integer, Array<Integer>] of the record(s) to lookup.
+    # @return [Base, Array] matching records
+    def find(ids, opts={})
+      ids.is_a?(Array) ? find_by_ids(ids, opts) : find_by_id(ids, opts)
+    end
+
+
+    # @deprecated Use {#find} instead
+    def find_by_id(id, opts={})
+      raw_attributes = load_attributes(id)
+      return nil unless raw_attributes[id][:exists].value
+      obj = new(id: id, raw_attributes: raw_attributes[id])
+      (obj.deleted? && !opts[:deleted].eql?(true)) ? nil : obj
+    end
+  
+
+    # @deprecated Use {#find} instead
+    def find_by_ids(ids, opts={})
+      attrs = load_attributes(*ids)
+      raw_attributes = attrs
+      ids.each_with_object([]) do |id, instances| 
+        if raw_attributes[id][:exists].value
+          instance = new(id: id, raw_attributes: raw_attributes[id])
+          instances << instance if instance && (!instance.deleted? || opts[:deleted].eql?(true))
+        end
+      end
+    end
+
+
+    # Iterate over all records in batches
+    # @param options [Hash] accepts options
+    #   `:start` to offset from the beginning of index,
+    #   `:batch_size` the size of the batch, default is 500.
+    # @param &block [Proc] passes each batch of articles to the Proc.
+    def find_in_batches(options={})
+      start       = options[:start]      || 0
+      marker      = start
+      batch_size  = options[:batch_size] || 500
+      record_ids  = redis.zrange(index_key_for(:id), marker, marker + batch_size - 1)
+
+      while record_ids.length > 0
+        records_count   = record_ids.length
+        marker          += records_count
+        records         = find(record_ids)
+
+        yield records
+
+        break if records_count < batch_size
+
+        record_ids = redis.zrange(index_key_for(:id), marker, marker + batch_size - 1)
+      end
+    end
+
+  end
+end

data/lib/redis_assist/version.rb

@@ -1,3 +1,3 @@
 module RedisAssist
-  VERSION = '0.9.0' unless defined?(::RedisAssist::VERSION)
+  VERSION = '0.10.0' unless defined?(::RedisAssist::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_assist
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Tyler Love
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -105,6 +105,7 @@ files:
 - lib/redis_assist/base.rb
 - lib/redis_assist/callbacks.rb
 - lib/redis_assist/config.rb
+- lib/redis_assist/finders.rb
 - lib/redis_assist/transform.rb
 - lib/redis_assist/transforms/boolean_transform.rb
 - lib/redis_assist/transforms/float_transform.rb