ohm 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed9503debac38501951e7e6847229e79e1289626
-  data.tar.gz: a754d5fef582a8c80dc1ad3b51b006820d03006a
+  metadata.gz: 4ecea4a8e9a9d11936a4dd250c91171ae3a47530
+  data.tar.gz: ad07199ffc7506ab69d7193d439cbd5373e41cac
 SHA512:
-  metadata.gz: cad32b03019a2c5f2e058446cb44947e0f3261e8d9c6dd30ff780eb21c7382e4384da950e057d0762307682f25fde152dda8b8f1f59f991642315c8cbf254ef0
-  data.tar.gz: 3e2ecb21022c7fb91441077a6d2566e344c61cba242a93b9675a9a41c0271448321c0ab2e2b9daa2b3110d97856d7d6d30a1675be2ae77362d927b8a313e852f
+  metadata.gz: b36d7473878642e18e827de61079b5fd36f083abba8aea39265927f0ad2370b1702bab376b37297d3b0bbb8d487ada008c6f98818cd82de84d9d4698405ec21e
+  data.tar.gz: 8ad17db1d2c0e6d9c4a2c661a75dac9b571cca89f7b542751826852512406a6aebeca58c38838ceb69904920fc63e08be55ab696d34618f23536237d7da7be0c

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## 3.0.0
+
+- Use JSON instead of msgpack for internal encoding.
+
+  When Ohm started using Lua internally for saving, updating and
+  deleting objects, it used msgpack for serializing. Redis supports
+  both msgpack and JSON, and we picked msgpack because it produces
+  a more compact representation. At some point, the Ruby msgpack
+  library and the internal msgpack support in Redis diverged, and
+  we were forced to lock the dependency to a specific gem version.
+  Recently, some people complained about encoding issues originating
+  from msgpack inside Redis, and once they tried a modified Ohm
+  that uses JSON instead of msgpack, all their issues disappeared.
+  That's why we think it's time for removing msgpack altogether and
+  use JSON instead.
+
+- Move the raise of MissingID to Ohm::Model#key.
+
+  In previous versions, trying to access an instance's `id` would
+  raise a `MissingID` error. The reason why raising that error is
+  convenient is because it allows Ohm to fail as early as possible
+  when you try to use an object that hasn't been saved yet. The
+  error can arise from comparisons, from direct calls to `id`, and
+  also from any call to methods that need `object.key` to return a
+  proper value, as `key` in turn calls the `id` method. But it turns
+  out that many form builders rely on the fact that sending the
+  `id` message to most ORMs results in either a valid ID or `nil`,
+  and here Ohm was the exception. By moving the check from `id` to
+  `key`, we can keep most of the previous behavior and we can return
+  `nil` when sending the `id` message to a new instance, thus making
+  Ohm compatible with most form builders.
+
+- Add `Ohm::Model#increment` and `Ohm::Model#decrement`. These methods
+  are aliases of `incr` and `decr` respectively.
+
 ## 2.3.0
 
 - Retry save and delete if scripts were flushed in the server.

data/README.md

@@ -28,6 +28,7 @@ These are libraries in other languages that were inspired by Ohm.
 * [Redisco](https://github.com/iamteem/redisco) for Python, created by iamteem
 * [redis3m](https://github.com/luca3m/redis3m) for C++, created by luca3m
 * [Ohmoc](https://github.com/seppo0010/ohmoc) for Objective-C, created by seppo0010
+* [Sohm](https://github.com/xxuejie/sohm.lua) for Lua, compatible with Twemproxy
 
 Articles and Presentations
 --------------------------
@@ -162,7 +163,7 @@ Event[2]
 
 # Finding all the events
 Event.all.to_a
-# => [<Event:1 name='Ohm Worldwide Conference 2031'>]
+# => [<Event:1 name='Ohm Worldwide Conference 2032'>]
 ```
 
 This example shows some basic features, like attribute declarations and
@@ -171,9 +172,9 @@ querying. Keep reading to find out what you can do with models.
 Attribute types
 ---------------
 
-Ohm::Model provides 4 attribute types: 
+Ohm::Model provides 4 attribute types:
 
-* {Ohm::Model.attribute attribute}, 
+* {Ohm::Model.attribute attribute},
 * {Ohm::Model.set set}
 * {Ohm::Model.list list}
 * {Ohm::Model.counter counter}
@@ -207,8 +208,8 @@ and for keeping elements in order.
 A `counter` is like a regular attribute, but the direct manipulation
 of the value is not allowed. You can retrieve, increase or decrease
 the value, but you can not assign it. In the example above, we used a
-counter attribute for tracking votes. As the incr and decr operations
-are atomic, you can rest assured a vote won't be counted twice.
+counter attribute for tracking votes. As the `increment` and `decrement`
+operations are atomic, you can rest assured a vote won't be counted twice.
 
 ### reference
 

data/benchmarks/common.rb

@@ -10,11 +10,6 @@ class Event < Ohm::Model
 
   index :name
   index :location
-
-  def validate
-    assert_present :name
-    assert_present :location
-  end
 end
 
 class Sequence

data/examples/tagging.rb

@@ -161,14 +161,14 @@ class Post
 protected
   def before_update
     assigned_tags = tags
-    tag(get(:tags)).map(&Tag).each { |t| t.decr :total }
+    tag(get(:tags)).map(&Tag).each { |t| t.decrement :total }
     self.tags = assigned_tags
   end
 
   # And of course, we increment all new tags for a particular record
   # after successfully saving it.
   def after_save
-    tag.map(&Tag).each { |t| t.incr :total }
+    tag.map(&Tag).each { |t| t.increment :total }
   end
 end
 

data/lib/ohm.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require "msgpack"
+require "json"
 require "nido"
 require "redic"
 require "stal"
@@ -477,16 +477,28 @@ module Ohm
       sort(options.merge(:by => to_key(att)))
     end
 
-    # Syntactic sugar for `sort_by` or `sort` when you only need the
-    # first element.
+    # Returns the first record of the set. Internally uses `sort` or
+    # `sort_by` if a `:by` option is given. Accepts all options supported
+    # by `sort`.
     #
-    # Example:
+    #   class User < Ohm::Model
+    #     attribute :name
+    #   end
+    #
+    #   User.create(name: "alice")
+    #   User.create(name: "bob")
+    #   User.create(name: "eve")
+    #
+    #   User.all.first.name # => "alice"
+    #   User.all.first(by: :name).name # => "alice"
+    #
+    #   User.all.first(order: "ASC")  # => "alice"
+    #   User.all.first(order: "DESC") # => "eve"
     #
-    #   User.all.first ==
-    #     User.all.sort(:limit => [0, 1]).first
+    # You can use the `:order` option to bring the last record:
     #
-    #   User.all.first(:by => :name, "ALPHA") ==
-    #     User.all.sort_by(:name, :order => "ALPHA", :limit => [0, 1]).first
+    #   User.all.first(order: "DESC").name             # => "eve"
+    #   User.all.first(by: :name, order: "ALPHA DESC") # => "eve"
     #
     def first(options = {})
       opts = options.dup
@@ -535,9 +547,10 @@ module Ohm
     #
     #   set = User.find(:status => "active")
     #   set.combine(:name => ["John", "Jane"])
-    #   
+    #
     #   # The result will include all users with active status
     #   # and with names "John" or "Jane".
+    #
     def combine(dict)
       Ohm::Set.new(
         model, namespace, [:SINTER, key, [:SUNION, *model.filters(dict)]]
@@ -652,7 +665,7 @@ module Ohm
   #   end
   #
   #   u = User.create(:name => "John", :email => "foo@bar.com")
-  #   u.incr :points
+  #   u.increment :points
   #   u.posts.add(Post.create)
   #
   # When you execute `User.create(...)`, you run the following Redis
@@ -1041,9 +1054,9 @@ module Ohm
 
     # Declare a counter. All the counters are internally stored in
     # a different Redis hash, independent from the one that stores
-    # the model attributes. Counters are updated with the `incr` and
-    # `decr` methods, which interact directly with Redis. Their value
-    # can't be assigned as with regular attributes.
+    # the model attributes. Counters are updated with the `increment`
+    # and `decrement` methods, which interact directly with Redis. Their
+    # value can't be assigned as with regular attributes.
     #
     # Example:
     #
@@ -1052,7 +1065,7 @@ module Ohm
     #   end
     #
     #   u = User.create
-    #   u.incr :points
+    #   u.increment :points
     #
     #   u.points
     #   # => 1
@@ -1088,6 +1101,7 @@ module Ohm
     # Returns the namespace for the keys generated using this model.
     # Check `Ohm::Model.key` documentation for more details.
     def key
+      raise MissingID if not defined?(@id)
       model.key[id]
     end
 
@@ -1118,7 +1132,6 @@ module Ohm
     #   # => User:1
     #
     def id
-      raise MissingID if not defined?(@id)
       @id
     end
 
@@ -1191,20 +1204,50 @@ module Ohm
     #   u.save
     #   u.new?
     #   # => false
+    #
     def new?
       !defined?(@id)
     end
 
-    # Increment a counter atomically. Internally uses HINCRBY.
-    def incr(att, count = 1)
+    # Increments a counter atomically. Internally uses `HINCRBY`.
+    #
+    #   class Ad
+    #     counter :hits
+    #   end
+    #
+    #   ad = Ad.create
+    #
+    #   ad.increment(:hits)
+    #   ad.hits # => 1
+    #
+    #   ad.increment(:hits, 2)
+    #   ad.hits # => 3
+    #
+    def increment(att, count = 1)
       redis.call("HINCRBY", key[:counters], att, count)
     end
 
-    # Decrement a counter atomically. Internally uses HINCRBY.
-    def decr(att, count = 1)
-      incr(att, -count)
+    # Decrements a counter atomically. Internally uses `HINCRBY`.
+    #
+    #   class Post
+    #     counter :score
+    #   end
+    #
+    #   post = Post.create
+    #
+    #   post.decrement(:score)
+    #   post.score # => -1
+    #
+    #   post.decrement(:hits, 2)
+    #   post.score # => -3
+    #
+    def decrement(att, count = 1)
+      increment(att, -count)
     end
 
+    alias_method(:incr, :increment)
+    alias_method(:decr, :decrement)
+
     # Return a value that allows the use of models as hash keys.
     #
     # Example:
@@ -1305,10 +1348,10 @@ module Ohm
       end
 
       @id = script(LUA_SAVE, 0,
-        features.to_msgpack,
-        _sanitized_attributes.to_msgpack,
-        indices.to_msgpack,
-        uniques.to_msgpack
+        features.to_json,
+        _sanitized_attributes.to_json,
+        indices.to_json,
+        uniques.to_json
       )
 
       return self
@@ -1330,9 +1373,9 @@ module Ohm
         { "name" => model.name,
           "id" => id,
           "key" => key
-        }.to_msgpack,
-        uniques.to_msgpack,
-        model.tracked.to_msgpack
+        }.to_json,
+        uniques.to_json,
+        model.tracked.to_json
       )
 
       return self

data/lib/ohm/json.rb

@@ -1,5 +1,3 @@
-require "json"
-
 module Ohm
   class Model
     # Export a JSON representation of the model by encoding `to_hash`.

data/lib/ohm/lua/delete.lua

@@ -1,5 +1,5 @@
 -- This script receives three parameters, all encoded with
--- MessagePack. The decoded values are used for deleting a model
+-- JSON. The decoded values are used for deleting a model
 -- instance in Redis and removing any reference to it in sets
 -- (indices) and hashes (unique indices).
 --
@@ -19,9 +19,9 @@
 -- Keys that share the lifecycle of this model instance, that
 -- should be removed as this object is deleted.
 --
-local model   = cmsgpack.unpack(ARGV[1])
-local uniques = cmsgpack.unpack(ARGV[2])
-local tracked = cmsgpack.unpack(ARGV[3])
+local model   = cjson.decode(ARGV[1])
+local uniques = cjson.decode(ARGV[2])
+local tracked = cjson.decode(ARGV[3])
 
 local function remove_indices(model)
 	local memo = model.key .. ":_indices"

data/lib/ohm/lua/save.lua

@@ -1,5 +1,5 @@
 -- This script receives four parameters, all encoded with
--- MessagePack. The decoded values are used for saving a model
+-- JSON. The decoded values are used for saving a model
 -- instance in Redis, creating or updating a hash as needed and
 -- updating zero or more sets (indices) and zero or more hashes
 -- (unique indices).
@@ -30,10 +30,10 @@
 -- value), an error is returned with the UniqueIndexViolation
 -- message and the field that triggered the error.
 --
-local model   = cmsgpack.unpack(ARGV[1])
-local attrs   = cmsgpack.unpack(ARGV[2])
-local indices = cmsgpack.unpack(ARGV[3])
-local uniques = cmsgpack.unpack(ARGV[4])
+local model   = cjson.decode(ARGV[1])
+local attrs   = cjson.decode(ARGV[2])
+local indices = cjson.decode(ARGV[3])
+local uniques = cjson.decode(ARGV[4])
 
 local function save(model, attrs)
 	if model.id == nil then

data/ohm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ohm"
-  s.version = "2.3.0"
+  s.version = "3.0.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"]
@@ -15,7 +15,6 @@ Gem::Specification.new do |s|
   s.add_dependency "redic", "~> 1.5.0"
   s.add_dependency "nido"
   s.add_dependency "stal"
-  s.add_dependency "msgpack", "~> 0.5.0"
 
   s.add_development_dependency "cutest"
 end

data/test/core.rb

@@ -19,6 +19,6 @@ test "assign an ID and save the object" do
 end
 
 test "save the attributes in UTF8" do
- event = Event.create(name: "32° Kisei-sen")
- assert_equal "32° Kisei-sen", Event[event.id].name
+  event = Event.create(name: "32° Kisei-sen")
+  assert_equal "32° Kisei-sen", Event[event.id].name
 end

data/test/counters.rb

@@ -9,12 +9,12 @@ test "counters aren't overwritten by competing saves" do
   Ad.counter :hits
 
   instance1 = Ad.create
-  instance1.incr :hits
+  instance1.increment :hits
 
   instance2 = Ad[instance1.id]
 
-  instance1.incr :hits
-  instance1.incr :hits
+  instance1.increment :hits
+  instance1.increment :hits
 
   instance2.save
 
@@ -31,7 +31,7 @@ test "you can increment counters even when attributes is empty" do
   ex = nil
 
   begin
-    ad.incr :hits
+    ad.increment :hits
   rescue ArgumentError => e
     ex = e
   end
@@ -44,7 +44,7 @@ test "an attribute gets saved properly" do
   Ad.counter :hits
 
   ad = Ad.create(:name => "foo")
-  ad.incr :hits, 10
+  ad.increment :hits, 10
   assert_equal 10, ad.hits
 
   # Now let's just load and save it.
@@ -59,7 +59,7 @@ test "an attribute gets saved properly" do
   # If we load and save again while we incr behind the scenes,
   # the latest counter values should be respected.
   ad = Ad[ad.id]
-  ad.incr :hits, 5
+  ad.increment :hits, 5
   ad.save
 
   ad = Ad[ad.id]

data/test/model.rb

@@ -73,7 +73,7 @@ end
 
 test "counters are cleaned up during deletion" do
   e = Event.create(:name => "Foo")
-  e.incr :votes, 10
+  e.increment :votes, 10
 
   assert_equal 10, e.votes
 
@@ -286,7 +286,7 @@ end
 test "save counters" do
   event = Event.create(:name => "Foo")
 
-  event.incr(:votes)
+  event.increment(:votes)
   event.save
 
   assert_equal 1, Event[event.id].votes
@@ -561,7 +561,7 @@ setup do
   @event = Event.create(:name => "Ruby Tuesday")
   {'D' => 4, 'C' => 2, 'B' => 5, 'A' => 3}.each_pair do |name, logins|
     person = Person.create(:name => name)
-    person.incr :logins, logins
+    person.increment :logins, logins
     @event.attendees.add(person)
   end
 end
@@ -630,18 +630,18 @@ test "be zero if not initialized" do
 end
 
 test "be able to increment a counter" do
-  @event.incr(:votes)
+  @event.increment(:votes)
   assert 1 == @event.votes
 
-  @event.incr(:votes, 2)
+  @event.increment(:votes, 2)
   assert 3 == @event.votes
 end
 
 test "be able to decrement a counter" do
-  @event.decr(:votes)
+  @event.decrement(:votes)
   assert @event.votes == -1
 
-  @event.decr(:votes, 2)
+  @event.decrement(:votes, 2)
   assert @event.votes == -3
 end
 
@@ -739,7 +739,7 @@ end
 # Persistence
 test "persist attributes to a hash" do
   event = Event.create(:name => "Redis Meetup")
-  event.incr(:votes)
+  event.increment(:votes)
 
   assert "hash" == Ohm.redis.call("TYPE", "Event:1")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ohm
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michel Martens
@@ -10,76 +10,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: nido
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: stal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: msgpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: cutest
   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: Ohm is a library that allows to store an object in Redis, a persistent
@@ -92,8 +78,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gems
-- .gitignore
+- ".gems"
+- ".gitignore"
 - CHANGELOG.md
 - CONTRIBUTING
 - LICENSE
@@ -141,17 +127,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: ohm
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Object-hash mapping library for Redis.