ohm 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a422b709084441dabd2d9c04a38014ec6ddbef
-  data.tar.gz: 8549e0842a0737e65a5d459f483b1002e8914ecf
+  metadata.gz: 65d8dd7c7555b0a26c8f4eb8845c08354b174acc
+  data.tar.gz: b12b6410534f2031ae211eff20604e9ac6da4473
 SHA512:
-  metadata.gz: 404357ab09aa51976a53ddc7fe43a31b29030f6067386daca0787fe8cd7d6cb1dbb80fabaee8c839aa23d576f9772dc66584df17e27c37317392aed7ac7f1927
-  data.tar.gz: 5cffd617b9e7e3119d1dc2d1f241a1107bafd7bdb7b53d4e78745e9d7f1570ceb1c887d488353c9d15782da0c27b750987299c321bb770e0e2eaf34326fb4d84
+  metadata.gz: 322e82928c55dc4fbaa9a370220c8e7c0bc382ef4a709fd96456add67a4b26f56617f7f54af4c5a3c14af59fc27fe50fa0ad6339db9246be7c1bee87fa743ddd
+  data.tar.gz: dbf21bd5c4984b2d6cbbb8c379aa88696c0a2a154d1fcf5cccfad35ca2e24856d223bb6e3b4642c556b163e82ae344e1cf9d45e2fcfe5b625aca6ef8b5c36d3f

data/.gems

@@ -1,5 +1,4 @@
+nest -v 3.0.0
 redic -v 1.5.0
-msgpack -v 0.6.2
-nido -v 0.0.1
 stal -v 0.1.0
-cutest -v 1.2.2
+cutest -v 1.2.3

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 3.1.0
+
+- Use Nest instead of Nido
+
+  A new release of Nest (3.0.0) simplified the interaction
+  with Redis.
+
+- Use Model#hash for equality
+
+  This change just removes some slight redundancy in the code.
+  The external behavior remains unchanged.
+
 ## 3.0.3
 
 - Fix bug that gave false positives for unique indices.

data/README.md

@@ -21,6 +21,7 @@ Related projects
 
 These are libraries in other languages that were inspired by Ohm.
 
+* [Ohm](https://github.com/soveran/ohm-crystal) for Crystal, created by soveran
 * [JOhm](https://github.com/xetorthio/johm) for Java, created by xetorthio
 * [Lohm](https://github.com/slact/lua-ohm) for Lua, created by slact
 * [ohm.lua](https://github.com/amakawa/ohm.lua) for Lua, created by amakawa
@@ -174,15 +175,15 @@ Attribute types
 
 Ohm::Model provides 4 attribute types:
 
-* {Ohm::Model.attribute attribute},
-* {Ohm::Model.set set}
-* {Ohm::Model.list list}
-* {Ohm::Model.counter counter}
+* `Ohm::Model.attribute`,
+* `Ohm::Model.set`
+* `Ohm::Model.list`
+* `Ohm::Model.counter`
 
 and 2 meta types:
 
-* {Ohm::Model.reference reference}
-* {Ohm::Model.collection collection}.
+* `Ohm::Model.reference`
+* `Ohm::Model.collection`.
 
 ### attribute
 
@@ -304,9 +305,9 @@ end
 
 ## Sorting
 
-Since `attendees` is a {Ohm::Model::Set Set}, it exposes two sorting
-methods: {Ohm::Model::Collection#sort sort} returns the elements
-ordered by `id`, and {Ohm::Model::Collection#sort_by sort_by} receives
+Since `attendees` is a `Ohm::Model::Set`, it exposes two sorting
+methods: `Ohm::Model::Collection#sort` returns the elements
+ordered by `id`, and `Ohm::Model::Collection#sort_by` receives
 a parameter with an attribute name, which will determine the sorting
 order. Both methods receive an options hash which is explained below:
 
@@ -337,8 +338,8 @@ Example:
 ### :by
 
 Key or Hash key with which to sort by. An important distinction with
-using {Ohm::Model::Collection#sort sort} and
-{Ohm::Model::Collection#sort_by sort_by} is that `sort_by` automatically
+using `Ohm::Model::Collection#sort` and
+`Ohm::Model::Collection#sort_by` is that `sort_by` automatically
 converts the passed argument with the assumption that it is a hash key
 and it's within the current model you are sorting.
 
@@ -354,8 +355,8 @@ otherwise.
 ### :get
 
 A key pattern to return, e.g. `Post:*->title`. As is the case with
-the `:by` option, using {Ohm::Model::Collection#sort sort} and
-{Ohm::Model::Collection#sort_by sort_by} has distinct differences in
+the `:by` option, using `Ohm::Model::Collection#sort` and
+`Ohm::Model::Collection#sort_by` has distinct differences in
 that `sort_by` does much of the hand-coding for you.
 
 ```ruby
@@ -391,7 +392,7 @@ you can use `post.comments.ids`.
 
 ### References explained
 
-Doing a {Ohm::Model.reference reference} is actually just a shortcut for
+Doing a `Ohm::Model.reference` is actually just a shortcut for
 the following:
 
 ```ruby
@@ -423,10 +424,10 @@ Comment.find(post_id: 1)
 
 ### Collections explained
 
-The reason a {Ohm::Model.reference reference} and a
-{Ohm::Model.collection collection} go hand in hand, is that a collection is
+The reason a `Ohm::Model.reference` and a
+`Ohm::Model.collection` go hand in hand, is that a collection is
 just a macro that defines a finder for you, and we know that to find a model
-by a field requires an {Ohm::Model.index index} to be defined for the field
+by a field requires an `Ohm::Model.index` to be defined for the field
 you want to search.
 
 ```ruby
@@ -460,18 +461,36 @@ Post.to_reference == :post
 # => true
 ```
 
+Modules
+-------
+
+If your models are defined inside a module, you will have to define
+the references and collections as in the following example:
+
+```ruby
+module SomeNamespace
+  class Foo < Ohm::Model
+    attribute :name
+  end
+  
+  class Bar < Ohm::Model
+    reference :foo, 'SomeNamespace::Foo'
+  end
+end
+```
+
 Indices
 -------
 
-An {Ohm::Model.index index} is a set that's handled automatically by Ohm. For
+An `Ohm::Model.index` is a set that's handled automatically by Ohm. For
 any index declared, Ohm maintains different sets of objects IDs for quick
 lookups.
 
 In the `Event` example, the index on the name attribute will
 allow for searches like `Event.find(name: "some value")`.
 
-Note that the methods {Ohm::Model::Set#find find} and
-{Ohm::Model::Set#except except} need a corresponding index in order to work.
+Note that the methods `Ohm::Model::Set#find` and
+`Ohm::Model::Set#except` need a corresponding index in order to work.
 
 ### Finding records
 

data/lib/ohm.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 require "json"
-require "nido"
+require "nest"
 require "redic"
 require "stal"
 
@@ -173,17 +173,17 @@ module Ohm
 
     # Returns the total size of the list using LLEN.
     def size
-      redis.call("LLEN", key)
+      key.call("LLEN")
     end
 
     # Returns the first element of the list using LINDEX.
     def first
-      model[redis.call("LINDEX", key, 0)]
+      model[key.call("LINDEX", 0)]
     end
 
     # Returns the last element of the list using LINDEX.
     def last
-      model[redis.call("LINDEX", key, -1)]
+      model[key.call("LINDEX", -1)]
     end
 
     # Returns an array of elements from the list using LRANGE.
@@ -211,7 +211,7 @@ module Ohm
     #   [c1, c2] == post.comments.range(0, 1)
     #   # => true
     def range(start, stop)
-      fetch(redis.call("LRANGE", key, start, stop))
+      fetch(key.call("LRANGE", start, stop))
     end
 
     # Checks if the model is part of this List.
@@ -255,12 +255,12 @@ module Ohm
 
     # Pushes the model to the _end_ of the list using RPUSH.
     def push(model)
-      redis.call("RPUSH", key, model.id)
+      key.call("RPUSH", model.id)
     end
 
     # Pushes the model to the _beginning_ of the list using LPUSH.
     def unshift(model)
-      redis.call("LPUSH", key, model.id)
+      key.call("LPUSH", model.id)
     end
 
     # Delete a model from the list.
@@ -292,7 +292,7 @@ module Ohm
 
       # LREM key 0 <id> means remove all elements matching <id>
       # @see http://redis.io/commands/lrem
-      redis.call("LREM", key, 0, model.id)
+      key.call("LREM", 0, model.id)
     end
 
     # Returns an array with all the ID's of the list.
@@ -316,7 +316,7 @@ module Ohm
     #   # => ["1", "2", "3"]
     #
     def ids
-      redis.call("LRANGE", key, 0, -1)
+      key.call("LRANGE", 0, -1)
     end
 
   private
@@ -378,7 +378,7 @@ module Ohm
       if Array === key
         Stal.solve(redis, key)
       else
-        redis.call("SMEMBERS", key)
+        key.call("SMEMBERS")
       end
     end
 
@@ -599,7 +599,7 @@ module Ohm
     #   user.posts.add(post)
     #
     def add(model)
-      redis.call("SADD", key, model.id)
+      key.call("SADD", model.id)
     end
 
     alias_method :<<, :add
@@ -614,7 +614,7 @@ module Ohm
     #   user.posts.delete(post)
     #
     def delete(model)
-      redis.call("SREM", key, model.id)
+      key.call("SREM", model.id)
     end
 
     # Replace all the existing elements of a set with a different
@@ -719,18 +719,14 @@ module Ohm
     #   class User < Ohm::Model
     #   end
     #
-    #   User.key == "User"
-    #   User.key.kind_of?(String)
+    #   User.key.kind_of?(Nest)
     #   # => true
     #
-    #   User.key.kind_of?(Nido)
-    #   # => true
-    #
-    # To find out more about Nido, see:
-    #   http://github.com/soveran/nido
+    # To find out more about Nest, see:
+    #   http://github.com/soveran/nest
     #
     def self.key
-      @key ||= Nido.new(self.name)
+      @key ||= Nest.new(self.name, redis)
     end
 
     # Retrieve a record by ID.
@@ -763,7 +759,7 @@ module Ohm
 
     # Check if the ID exists within <Model>:all.
     def self.exists?(id)
-      redis.call("SISMEMBER", key[:all], id) == 1
+      key[:all].call("SISMEMBER", id) == 1
     end
 
     # Find values in `unique` indices.
@@ -781,7 +777,7 @@ module Ohm
     def self.with(att, val)
       raise IndexNotFound unless uniques.include?(att)
 
-      id = redis.call("HGET", key[:uniques][att], val)
+      id = key[:uniques][att].call("HGET", val)
       new(:id => id).load! if id
     end
 
@@ -1079,7 +1075,7 @@ module Ohm
       define_method(name) do
         return 0 if new?
 
-        redis.call("HGET", key[:counters], name).to_i
+        key[:counters].call("HGET", name).to_i
       end
     end
 
@@ -1141,15 +1137,13 @@ module Ohm
     # 2. That they represent the same Redis key.
     #
     def ==(other)
-      other.kind_of?(model) && other.key == key
-    rescue MissingID
-      false
+      other.kind_of?(model) && other.hash == hash
     end
 
     # Preload all the attributes of this model from Redis. Used
     # internally by `Model::[]`.
     def load!
-      update_attributes(Utils.dict(redis.call("HGETALL", key))) unless new?
+      update_attributes(Utils.dict(key.call("HGETALL"))) unless new?
       return self
     end
 
@@ -1170,7 +1164,7 @@ module Ohm
     #                 |    u.get(:name) == "B"
     #
     def get(att)
-      @attributes[att] = redis.call("HGET", key, att)
+      @attributes[att] = key.call("HGET", att)
     end
 
     # Update an attribute value atomically. The best usecase for this
@@ -1181,9 +1175,9 @@ module Ohm
     #
     def set(att, val)
       if val.to_s.empty?
-        redis.call("HDEL", key, att)
+        key.call("HDEL", att)
       else
-        redis.call("HSET", key, att, val)
+        key.call("HSET", att, val)
       end
 
       @attributes[att] = val
@@ -1224,7 +1218,7 @@ module Ohm
     #   ad.hits # => 3
     #
     def increment(att, count = 1)
-      redis.call("HINCRBY", key[:counters], att, count)
+      key[:counters].call("HINCRBY", att, count)
     end
 
     # Decrements a counter atomically. Internally uses `HINCRBY`.

data/ohm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ohm"
-  s.version = "3.0.3"
+  s.version = "3.1.0"
   s.summary = %{Object-hash mapping library for Redis.}
   s.description = %Q{Ohm is a library that allows to store an object in Redis, a persistent key-value database. It has very good performance.}
   s.authors = ["Michel Martens", "Damian Janowski", "Cyril David"]
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "ohm"
 
   s.add_dependency "redic", "~> 1.5.0"
-  s.add_dependency "nido"
+  s.add_dependency "nest", "~> 3"
   s.add_dependency "stal"
 
   s.add_development_dependency "cutest"

data/test/indices.rb

@@ -51,7 +51,7 @@ test "raise an error if the parameter supplied is not a hash" do
 end
 
 test "avoid intersections with the all collection" do
-  assert_equal "User:indices:email:foo", User.find(:email => "foo").key
+  assert_equal "User:indices:email:foo", User.find(:email => "foo").key.to_s
 end
 
 test "allow multiple chained finds" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ohm
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Michel Martens
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
@@ -27,19 +27,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: nido
+  name: nest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: stal
   requirement: !ruby/object:Gem::Requirement