redpear 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43b9457346f8717f197abb7126edf776529ac0a7
-  data.tar.gz: ba0cfb07aadfb5c6d9aed9a2a6db569e75d6472c
+  metadata.gz: cacc5c94b76adaeb44603c1a18f71463aa44d80f
+  data.tar.gz: 649491711dd699d7e6730dc10185558c95cdd87e
 SHA512:
-  metadata.gz: eb419ed421012e2ddcf0a1d4075df2dc6b7e574a7a7bdb9dbb3d212876add05e4323ab4a3fce6e70cfff8840a9e6945afaacdcf658c6acd2155daacdd7a37d89
-  data.tar.gz: c9a515798435daf015f72795356b388e9b4344bcbd307014974a2b726b6fada421410e426edc257029ebf52e73613a87e8c1adaefb1083c3a67fa68213e64690
+  metadata.gz: e0bac811996bae661d84db2017bfd47a17d442af9e81e864c49c6052e18576f3a9cd7284241057741330852d905d154eecd5c48b71b0ad469482f81cf7cf8775
+  data.tar.gz: e28106cc8bf5a052e66c5978765d504baf5cad398c033f9a52e51ba9d0fe8a1090e609bc8e80720fb1cec22c2bf117ee9141dcf0ce323505966e50abc6ca201a

data/lib/redpear/model.rb

@@ -33,10 +33,10 @@ class Redpear::Model < Hash
 
     alias_method :create, :new
 
-    # @param [Redis] define a custom connection
+    # @attr_writer [Redis] connection define a custom connection
     attr_writer :connection
 
-    # @param [String] define a custom scope
+    # @attr_writer [String] scope define a custom scope
     attr_writer :scope
 
     # @return [Redis] the connection
@@ -90,6 +90,7 @@ class Redpear::Model < Hash
     end
 
     # Allocate an instance
+    # @param [String] id the ID of the record to allocate
     def instantiate(id)
       instance = allocate
       instance.send :store, 'id', id.to_s
@@ -257,14 +258,14 @@ class Redpear::Model < Hash
 
   # Cheap after create callback, override in subclasses and don't forget to
   # call `super()`.
-  # @params [Hash] attrs attributes used on initialization
+  # @param [Hash] attrs attributes used on initialization
   def after_create(attrs)
     self.class.members.add(id)
   end
 
   # Cheap after save callback, override in subclasses and don't forget to
   # call `super()`.
-  # @params [Hash] attrs attributes used on save
+  # @param [Hash] attrs attributes used on save
   def after_save(attrs)
   end
 

data/lib/redpear/schema/collection.rb

@@ -1,7 +1,9 @@
 # Stores the column information
 class Redpear::Schema::Collection < Array
 
-  # @param [multiple] the column definition. Please see Redpear::Schema::Column#initialize
+  # @param [Class] klass
+  # @param [multiple] args the column definition.
+  # @see Redpear::Schema::Column#initialize
   def store(klass, *args)
     reset!
     klass.new(*args).tap do |col|
@@ -24,13 +26,13 @@ class Redpear::Schema::Collection < Array
     @indicies ||= to_a.select {|i| i.is_a?(Redpear::Schema::Index) }
   end
 
-  # @param [String] the column name
+  # @param [String] name the column name
   # @return [Boolean] if name is part of the collection
   def include?(name)
     lookup.key?(name.to_s)
   end
 
-  # @param [String] the column name
+  # @param [String] name the column name
   # @return [Redpear::Schema::Column] the column for the given name
   def [](name)
     lookup[name.to_s]

data/lib/redpear/schema/index.rb

@@ -6,7 +6,7 @@ class Redpear::Schema::Index < Redpear::Schema::Column
     members record.send(name)
   end
 
-  # @param [String] index value
+  # @param [String] value index value
   # @return [Redpear::Store::Set] the set holding the IDs for the given `foreign_key`
   def members(value)
     value = '_' if value.nil?

data/lib/redpear/schema.rb

@@ -8,21 +8,21 @@ module Redpear::Schema
       @columns ||= Redpear::Schema::Collection.new
     end
 
-    # @param [multiple] the column definition. Please see Redpear::Schema::Column#initialize
+    # @param [multiple] args the column definition. Please see Redpear::Schema::Column#initialize
     def column(*args)
       columns.store(Redpear::Schema::Column, self, *args).tap do |col|
         __define_attribute_accessors__(col)
       end
     end
 
-    # @param [multiple] the index definition. Please see Redpear::Index#initialize
+    # @param [multiple] args the index definition. Please see Redpear::Index#initialize
     def index(*args)
       columns.store(Redpear::Schema::Index, self, *args).tap do |col|
         __define_attribute_accessors__(col)
       end
     end
 
-    # @param [multiple] the sorted index definition. Please see Redpear::ZIndex#initialize
+    # @param [multiple] args the sorted index definition. Please see Redpear::ZIndex#initialize
     def score(*args)
       columns.store(Redpear::Schema::Score, self, *args).tap do |col|
         __define_attribute_accessors__(col)

data/lib/redpear/store/counter.rb

@@ -1,5 +1,5 @@
 class Redpear::Store::Counter < Redpear::Store::Value
-  
+
   # @return [Integer] the value
   def get
     case value = super
@@ -11,7 +11,7 @@ class Redpear::Store::Counter < Redpear::Store::Value
   end
 
   # Sets the value
-  # @param [Integer] the value to set
+  # @param [Integer] value the value to set
   def set(value)
     super Kernel::Integer(value)
   end

data/lib/redpear/store/lock.rb

@@ -81,6 +81,16 @@ class Redpear::Store::Lock < Redpear::Store::Base
     false
   end
 
+  # Tries to reserve a lock. Low-level method, please see #reserve
+  # for the high-level API.
+  #
+  # @param [Integer] seconds the number of seconds
+  # @return [Boolean] true if lock was reserved
+  def reserve?(seconds)
+    timestamp = to_time(seconds).to_f
+    lock_obtained?(timestamp) || expired_lock_obtained?(timestamp)
+  end
+
   # Reserves a lock and yields a transaction, but only if not reserved by
   # someone else. This is useful when processes can be triggered by concurrent
   # threads, but should only be executed once.
@@ -110,8 +120,7 @@ class Redpear::Store::Lock < Redpear::Store::Base
   #   Clear the lock after execution, defaults to false
   # @yield [] processes the block within the lock
   def reserve(seconds, options = {})
-    timestamp = to_time(seconds).to_f
-    yield if lock_obtained?(timestamp) || expired_lock_obtained?(timestamp)
+    yield if reserve?(seconds)
   ensure
     purge! if options[:clear]
   end
@@ -152,4 +161,4 @@ class Redpear::Store::Lock < Redpear::Store::Base
       end
     end
 
-end
+end

data/lib/redpear/store/set.rb

@@ -102,7 +102,7 @@ class Redpear::Store::Set < Redpear::Store::Enumerable
   alias_method :merge, :union
 
   # Store the result of a union in a new +target+ key
-  # @param [Redpear::Store::Set] other
+  # @param [Redpear::Store::Set] target
   #   The other set
   # @param [multiple] others
   #   The other sets
@@ -112,7 +112,7 @@ class Redpear::Store::Set < Redpear::Store::Enumerable
     self.class.new target.to_s, conn
   end
 
-  # @param [multiple] other
+  # @param [multiple] others
   #   The other sets
   # @return [Array] the intersection +other+ set
   def inter(*others)

data/lib/redpear/store/sorted_set.rb

@@ -196,11 +196,10 @@ class Redpear::Store::SortedSet < Redpear::Store::Enumerable
   end
 
   # Store the result of a union in a new +target+ key
-  # @param [Redpear::Store::Set] other
-  #   The other set
+  # @param [Redpear::Store::Set] target
+  #   The target set
   # @param [multiple] others
-  #   The other sets
-  # @param [Hash] options
+  #   The other sets & options
   # @option [Array] weights
   # @option [Symbol] aggregate
   # @return [Redpear::Store::Set] the result set
@@ -214,8 +213,7 @@ class Redpear::Store::SortedSet < Redpear::Store::Enumerable
   # @param [String] target
   #   The target key
   # @param [multiple] others
-  #   The other sets
-  # @param [Hash] options
+  #   The other sets & options
   # @option [Array] weights
   # @option [Symbol] aggregate
   # @return [Redpear::Store::SortedSet] the result set

data/lib/redpear/store/value.rb

@@ -15,7 +15,7 @@ class Redpear::Store::Value < Redpear::Store::Base
   end
 
   # Sets the value
-  # @param [String] the value to set
+  # @param [String] value the value to set
   def set(value)
     conn.set(key, value)
   end
@@ -45,7 +45,7 @@ class Redpear::Store::Value < Redpear::Store::Base
   def ==(other)
     case value = self.value
     when Redis::Future
-      value.instance_eval { @transformation = ->v { v == other } }
+      value.instance_eval { @transformation = Kernel.lambda {|v| v == other } }
     else
       value == other
     end

data/lib/redpear/version.rb

@@ -2,7 +2,7 @@ module Redpear
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

metadata

@@ -1,117 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: redpear
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.5
-    - - <
+    - - "<"
       - !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.0.5
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !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: bundler
   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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   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: machinist
   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: factory_girl
   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: yard
+  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: coveralls
+  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: Simple, elegant & efficient ORM for Redis
@@ -120,29 +148,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/redpear/schema.rb
-- lib/redpear/store/lock.rb
-- lib/redpear/store/set.rb
-- lib/redpear/store/base.rb
-- lib/redpear/store/value.rb
-- lib/redpear/store/sorted_set.rb
-- lib/redpear/store/enumerable.rb
-- lib/redpear/store/hash.rb
-- lib/redpear/store/counter.rb
-- lib/redpear/store/list.rb
+- lib/redpear.rb
 - lib/redpear/concern.rb
-- lib/redpear/store.rb
 - lib/redpear/model.rb
-- lib/redpear/schema/column.rb
-- lib/redpear/schema/score.rb
-- lib/redpear/schema/index.rb
-- lib/redpear/schema/collection.rb
+- lib/redpear/model/expiration.rb
 - lib/redpear/model/factory_girl.rb
 - lib/redpear/model/finders.rb
 - lib/redpear/model/machinist.rb
-- lib/redpear/model/expiration.rb
+- lib/redpear/schema.rb
+- lib/redpear/schema/collection.rb
+- lib/redpear/schema/column.rb
+- lib/redpear/schema/index.rb
+- lib/redpear/schema/score.rb
+- lib/redpear/store.rb
+- lib/redpear/store/base.rb
+- lib/redpear/store/counter.rb
+- lib/redpear/store/enumerable.rb
+- lib/redpear/store/hash.rb
+- lib/redpear/store/list.rb
+- lib/redpear/store/lock.rb
+- lib/redpear/store/set.rb
+- lib/redpear/store/sorted_set.rb
+- lib/redpear/store/value.rb
 - lib/redpear/version.rb
-- lib/redpear.rb
 homepage: https://github.com/bsm/redpear
 licenses: []
 metadata: {}
@@ -152,17 +180,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Redpear, a Redis ORM