ohm 2.0.0.rc2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44f992bf97d394e618f9e3608a13999e6a37ffbf
-  data.tar.gz: 9e97ba2177d8067c64ab4e2b0b7a0a710703bb18
+  metadata.gz: b6a988b7d453e4d23906662c7fd1d8d993634892
+  data.tar.gz: 4673e7432655aeb8b9061d184ff912cb35ac42d3
 SHA512:
-  metadata.gz: a0d5bc81d2fa070ee3b9306844bc61a1d089cf67e464fd8c3939274db918d986f3e6d97c8166ae3f1caf2c0d679c7c1802c55499d65dc0ca35a619ee9446b342
-  data.tar.gz: 50008d8d644b1825507db45e921e78aaa0cd19b48fc587eca43605495155d91e816e49abc75a02f6bc4aef1e5351c81940384da4eb97c8e3e8eb6934ba75ce65
+  metadata.gz: b315cdda1f6011e68b2c1f194f229fc1b757d1cf8b40548df5852f8f5c96b8fe0a7dfb20c43ff8614f9bdd0905b367bab098e6ba209c389ce925859696b09dec
+  data.tar.gz: a64327f9085061116c85d50d63d3719d47b3521833bc72374fa3094444ca6b7d9f4ee1a747497b27b09d4c1bf02b9b6ac54075c0f5b230f3d6c6e4ae0a3cf233

data/CHANGELOG.md

@@ -1,80 +1,81 @@
+## 2.0.0
+
 - Lists now respond to range.
 
   Example:
 
-      class Comment < Ohm::Model
-      end
+  ```ruby
+  class Comment < Ohm::Model
+  end
 
-      class Post < Ohm::Model
-        list :comments, :Comment
-      end
+  class Post < Ohm::Model
+    list :comments, :Comment
+  end
 
-      c1 = Comment.create
-      c2 = Comment.create
-      c3 = Comment.create
+  c1 = Comment.create
+  c2 = Comment.create
+  c3 = Comment.create
 
-      post = Post.create
-      post.comments.push(c1)
-      post.comments.push(c2)
-      post.comments.push(c3)
+  post = Post.create
+  post.comments.push(c1)
+  post.comments.push(c2)
+  post.comments.push(c3)
 
-      post.comments.range(0, 1) == [c1, c2]
-      # => true
+  post.comments.range(0, 1) == [c1, c2]
+  # => true
+  ```
 
-- When a record is created, `#id` returns a string instead of a integer.
-  This ensures ID is string everywhere:
+- When a record is created, `#id` returns a string instead of an integer.
+  This ensures IDs are strings everywhere:
 
   Example:
 
-      ## Before
-
-      Meetup.create(name: "Ruby").id
-      # => 1
-
-      Meetup.find(name: "Ruby").id
-      # => "1"
+  ```ruby
 
-      ## Now
+  # Before
+  Meetup.create(name: "Ruby").id # => 1
+  Meetup.with(:name, "Ruby").id  # => "1"
 
-      Meetup.create.id
-      # => "1"
+  # Now
+  Meetup.create(name: "Ruby").id # => "1"
+  Meetup.with(:name, "Ruby").id  # => "1"
+  ```
 
-      Meetup.find(name: "Ruby").id
-      # => "1"
-
-- If an attribute is set to an empty string, Ohm won't delete the attribute.
+- If an attribute is set to an empty string, Ohm won't delete it.
 
   Example:
 
-      # Before
-      event = Meetup.create(location: "")
-      Meetup[event.id].location
-      # => nil
+  ```ruby
+  # Before
+  event = Meetup.create(location: "")
+  Meetup[event.id].location # => nil
 
-      # Now
-      event = Meetup.create(location: "")
-      Meetup[event.id].location
-      # => ""
+  # Now
+  event = Meetup.create(location: "")
+  Meetup[event.id].location # => ""
+  ```
 
 - Include `Ohm::List#ids` in the public API. It returns an array with all
-  the ID's of the list.
+  the ID's in the list.
 
   Example:
 
-      class Comment < Ohm::Model
-      end
+  ```ruby
+  class Comment < Ohm::Model
+  end
 
-      class Post < Ohm::Model
-        list :comments, :Comment
-      end
+  class Post < Ohm::Model
+    list :comments, :Comment
+  end
 
-      post = Post.create
-      post.comments.push(Comment.create)
-      post.comments.push(Comment.create)
-      post.comments.push(Comment.create)
+  post = Post.create
+  post.comments.push(Comment.create)
+  post.comments.push(Comment.create)
+  post.comments.push(Comment.create)
 
-      post.comments.ids
-      # => ["1", "2", "3"]
+  post.comments.ids
+  # => ["1", "2", "3"]
+  ```
 
 - Include `Ohm::BasicSet#exists?` in the public API. This makes possible
   to check if an id is included in a set. Check `Ohm::BasicSet#exists?`
@@ -82,123 +83,126 @@
 
   Example:
 
-      class Post < Ohm::Model
-      end
-
-      class User < Ohm::Model
-        set :posts, :Post
-      end
+  ```ruby
+  class Post < Ohm::Model
+  end
 
-      user = User.create
-      user.posts.add(post = Post.create)
+  class User < Ohm::Model
+    set :posts, :Post
+  end
 
-      user.posts.exists?(post.id)       # => true
-      user.posts.exists?("nonexistent") # => false
+  user = User.create
+  user.posts.add(post = Post.create)
 
+  user.posts.exists?(post.id)       # => true
+  user.posts.exists?("nonexistent") # => false
+  ```
 
 - Change `Ohm::MultiSet#except` to union keys instead of intersect them
   when passing an array.
 
   Example:
 
-      class User < Ohm::Model
-        attribute :name
-      end
+  ```ruby
+  class User < Ohm::Model
+    attribute :name
+  end
 
-      john = User.create(name: "John")
-      jane = User.create(name: "Jane")
+  john = User.create(name: "John")
+  jane = User.create(name: "Jane")
 
-      res = User.all.except(name: [john.name, jane.name])
+  res = User.all.except(name: [john.name, jane.name])
 
-      # before
-      res.size # => 2
-
-      # now
-      res.size # => 0
+  # Before
+  res.size # => 2
 
+  # Now
+  res.size # => 0
+  ```
 
 - Move ID generation to Lua. With this change, it's no longer possible
   to generate custom ids. All ids are autoincremented.
 
-
 - Add `Ohm::Model.track` method to allow track of custom keys. This key
   is removed when the model is deleted.
 
   Example:
 
-      class Foo < Ohm::Model
-        track :notes
-      end
-
-      foo = Foo.create
+  ```ruby
+  class Foo < Ohm::Model
+    track :notes
+  end
 
-      Foo.redis.call("SET", foo.key[:notes], "something")
-      Foo.redis.call("KEYS", "*").include?("Foo:1:notes")
-      # => true
+  foo = Foo.create
 
-      foo.delete
-      Foo.redis.call("KEYS", "*").include?("Foo:1:notes")
-      # => false
+  Foo.redis.call("SET", foo.key[:notes], "something")
+  Foo.redis.call("GET", "Foo:1:notes")
+  # => "something"
 
+  foo.delete
+  Foo.redis.call("GET", "Foo:1:notes")
+  # => nil
+  ```
 
 - `Ohm::Model#reference` accepts strings as model references.
 
   Example:
 
-      class Bar < Ohm::Model
-        reference :foo, "SomeNamespace::Foo"
-      end
+  ```ruby
+  class Bar < Ohm::Model
+    reference :foo, "SomeNamespace::Foo"
+  end
 
-      Bar.create().foo.class # => SomeNamespace::Foo
+  Bar.create.foo.class # => SomeNamespace::Foo
+  ```
 
-
-- `Ohm::Model#save` sanitizes attributes before sending to Lua.
+- `Ohm::Model#save` sanitizes attributes before sending them to Lua.
   This complies with the original spec in Ohm v1 where a `to_s`
   is done on each value.
 
   Example:
 
-      class Post < Ohm::Model
-        attribute :published
-      end
-
-      post = Post.create(published: true)
-      post = Post[post.id]
+  ```ruby
+  class Post < Ohm::Model
+    attribute :published
+  end
 
-      # before
-      post.published # => "1"
+  post = Post.create(published: true)
+  post = Post[post.id]
 
-      # now
-      post.published # => "true"
+  # Before
+  post.published # => "1"
 
+  # Now
+  post.published # => "true"
+  ```
 
 - `Ohm::Model#save` don't save values for attributes set to false.
 
   Example:
 
-      class Post < Ohm::Model
-        attribute :published
-      end
+  ```ruby
+  class Post < Ohm::Model
+    attribute :published
+  end
 
-      post = Post.create(published: false)
-      post = Post[post.id]
+  post = Post.create(published: false)
+  post = Post[post.id]
 
-      # before
-      post.published # => "0"
-
-      # now
-      post.published # => nil
+  # Before
+  post.published # => "0"
 
+  # Now
+  post.published # => nil
+  ```
 
 - `nest` dependency has been removed. Now, Ohm uses [nido][nido]
   to generate the keys that hold the data.
 
-
 - `scrivener` dependency has been removed. Ohm no longer supports model
   validations and favors filter validation on the boundary layer. Check
   [scrivener][scrivener] project for more information.
 
-
 - `redis` dependency has been removed. Ohm 2 uses [redic][redic],
   a lightweight Redis client. Redic uses the `hiredis` gem for the
   connection and for parsing the replies. Now, it defaults to a
@@ -208,86 +212,101 @@
 
   Example:
 
-      Ohm.redis = Redic.new("redis://:<passwd>@<host>:<port>/<db>")
-
-  Check Redic README for more details.
+  ```ruby
+  Ohm.redis = Redic.new("redis://:<passwd>@<host>:<port>/<db>")
+  ```
 
+  Check the Redic README for more details.
 
 - `Ohm::Model#transaction` and `Ohm::Transaction` have been removed.
 
-
 - Move `save` and `delete` operations to Lua scripts.
 
-
-- Support for Ruby 1.8 and 1.9 has been removed.
+- Support for Ruby 1.8 has been removed.
 
 [nido]: https://github.com/soveran/nido
 [scrivener]: https://github.com/soveran/scrivener
 [redic]: https://github.com/amakawa/redic
 
-1.3.2
------
+## 1.3.2
 
 - Fetching a batch of objects is now done in batches of 1000 objects at
   a time. If you are iterating over large collections, this change should
   provide a significant performance boost both in used memory and total
   execution time.
-- MutableSet#<< is now an alias for #add.
 
-1.3.1
------
+- `MutableSet#&lt;&lt;` is now an alias for `#add`.
 
-- Improve memory consumption when indexing persisted attributes.
+## 1.3.1
 
+- Improve memory consumption when indexing persisted attributes.
   No migration is needed and old indices will be cleaned up as you save
   instances.
 
-1.3.0
------
+## 1.3.0
 
 - Add Model.attributes.
 
-1.2.0
------
+## 1.2.0
 
 - Enumerable fix.
+
 - Merge Ohm::PipelinedFetch into Ohm::Collection.
+
 - Fix Set, MultiSet, and List enumerable behavior.
+
 - Change dependencies to use latest cutest.
 
-1.1.0
------
+## 1.1.0
 
 - Compatible with redis-rb 3.
 
-1.0.0
------
+## 1.0.0
 
 - Fetching a batch of objects is now done through one pipeline, effectively
   reducing the IO to just 2 operations (one for SMEMBERS / LRANGE, one for
   the actual HGET of all the individual HASHes.)
+
 - write_remote / read_remote have been replaced with set / get respectively.
+
 - Ohm::Model.unique has been added.
+
 - Ohm::Model::Set has been renamed to Ohm::Set
+
 - Ohm::Model::List has been renamed to Ohm::List
+
 - Ohm::Model::Collection is gone.
+
 - Ohm::Validations is gone. Ohm now uses Scrivener::Validations.
+
 - Ohm::Key is gone. Ohm now uses Nest directly.
+
 - No more concept of volatile keys.
+
 - Ohm::Model::Wrapper is gone.
+
 - Use Symbols for constants instead of relying on Ohm::Model.const_missing.
-- #sort / #sort_by now uses `limit` as it's used in redis-rb, e.g. you
+
+- `#sort` / `#sort_by` now uses `limit` as it's used in redis-rb, e.g. you
   have to pass in an array like so: sort(limit: [0, 1]).
+
 - Set / List have been trimmed to contain only the minimum number
   of necessary methods.
+
 - You can no longer mutate a collection / set as before, e.g. doing
   User.find(...).add(User[1]) will throw an error.
+
 - The #union operation has been added. You can now chain it with your filters.
+
 - Temporary keys when doing finds are now automatically cleaned up.
+
 - Counters are now stored in their own key instead, i.e. in
   User:<id>:counters.
+
 - JSON support has to be explicitly required by doing `require
   "ohm/json"`.
+
 - All save / delete / update operations are now done using
   transactions (see http://redis.io/topics/transactions).
+
 - All indices are now stored without converting the values to base64.

data/README.md

@@ -48,7 +48,7 @@ with the sources if you want to change some settings.
 
 If you don't have Ohm, try this:
 
-    $ [sudo] gem install ohm -v 2.0.0.rc1
+    $ [sudo] gem install ohm
 
 Or you can grab the code from [http://github.com/soveran/ohm][ohm].
 

data/lib/ohm/lua/delete.lua

@@ -24,44 +24,44 @@ local uniques = cmsgpack.unpack(ARGV[2])
 local tracked = cmsgpack.unpack(ARGV[3])
 
 local function remove_indices(model)
-  local memo = model.key .. ":_indices"
-  local existing = redis.call("SMEMBERS", memo)
+	local memo = model.key .. ":_indices"
+	local existing = redis.call("SMEMBERS", memo)
 
-  for _, key in ipairs(existing) do
-    redis.call("SREM", key, model.id)
-    redis.call("SREM", memo, key)
-  end
+	for _, key in ipairs(existing) do
+		redis.call("SREM", key, model.id)
+		redis.call("SREM", memo, key)
+	end
 end
 
 local function remove_uniques(model, uniques)
-  local memo = model.key .. ":_uniques"
+	local memo = model.key .. ":_uniques"
 
-  for field, _ in pairs(uniques) do
-    local key = model.name .. ":uniques:" .. field
+	for field, _ in pairs(uniques) do
+		local key = model.name .. ":uniques:" .. field
 
-    redis.call("HDEL", key, redis.call("HGET", memo, key))
-    redis.call("HDEL", memo, key)
-  end
+		redis.call("HDEL", key, redis.call("HGET", memo, key))
+		redis.call("HDEL", memo, key)
+	end
 end
 
 local function remove_tracked(model, tracked)
-  for _, tracked_key in ipairs(tracked) do
-    local key = model.key .. ":" .. tracked_key
+	for _, tracked_key in ipairs(tracked) do
+		local key = model.key .. ":" .. tracked_key
 
-    redis.call("DEL", key)
-  end
+		redis.call("DEL", key)
+	end
 end
 
 local function delete(model)
-  local keys = {
-    model.key .. ":counters",
-    model.key .. ":_indices",
-    model.key .. ":_uniques",
-    model.key
-  }
+	local keys = {
+		model.key .. ":counters",
+		model.key .. ":_indices",
+		model.key .. ":_uniques",
+		model.key
+	}
 
-  redis.call("SREM", model.name .. ":all", model.id)
-  redis.call("DEL", unpack(keys))
+	redis.call("SREM", model.name .. ":all", model.id)
+	redis.call("DEL", unpack(keys))
 end
 
 remove_indices(model)

data/lib/ohm/lua/save.lua

@@ -36,82 +36,82 @@ local indices = cmsgpack.unpack(ARGV[3])
 local uniques = cmsgpack.unpack(ARGV[4])
 
 local function save(model, attrs)
-  if model.id == nil then
-    model.id = redis.call("INCR", model.name .. ":id")
-  end
+	if model.id == nil then
+		model.id = redis.call("INCR", model.name .. ":id")
+	end
 
-  model.key = model.name .. ":" .. model.id
+	model.key = model.name .. ":" .. model.id
 
-  redis.call("SADD", model.name .. ":all", model.id)
-  redis.call("DEL", model.key)
+	redis.call("SADD", model.name .. ":all", model.id)
+	redis.call("DEL", model.key)
 
-  if math.mod(#attrs, 2) == 1 then
-    error("Wrong number of attribute/value pairs")
-  end
+	if math.mod(#attrs, 2) == 1 then
+		error("Wrong number of attribute/value pairs")
+	end
 
-  if #attrs > 0 then
-    redis.call("HMSET", model.key, unpack(attrs))
-  end
+	if #attrs > 0 then
+		redis.call("HMSET", model.key, unpack(attrs))
+	end
 end
 
 local function index(model, indices)
-  for field, enum in pairs(indices) do
-    for _, val in ipairs(enum) do
-      local key = model.name .. ":indices:" .. field .. ":" .. tostring(val)
-
-      redis.call("SADD", model.key .. ":_indices", key)
-      redis.call("SADD", key, model.id)
-    end
-  end
+	for field, enum in pairs(indices) do
+		for _, val in ipairs(enum) do
+			local key = model.name .. ":indices:" .. field .. ":" .. tostring(val)
+
+			redis.call("SADD", model.key .. ":_indices", key)
+			redis.call("SADD", key, model.id)
+		end
+	end
 end
 
 local function remove_indices(model)
-  local memo = model.key .. ":_indices"
-  local existing = redis.call("SMEMBERS", memo)
+	local memo = model.key .. ":_indices"
+	local existing = redis.call("SMEMBERS", memo)
 
-  for _, key in ipairs(existing) do
-    redis.call("SREM", key, model.id)
-    redis.call("SREM", memo, key)
-  end
+	for _, key in ipairs(existing) do
+		redis.call("SREM", key, model.id)
+		redis.call("SREM", memo, key)
+	end
 end
 
 local function unique(model, uniques)
-  for field, value in pairs(uniques) do
-    local key = model.name .. ":uniques:" .. field
+	for field, value in pairs(uniques) do
+		local key = model.name .. ":uniques:" .. field
 
-    redis.call("HSET", model.key .. ":_uniques", key, value)
-    redis.call("HSET", key, value, model.id)
-  end
+		redis.call("HSET", model.key .. ":_uniques", key, value)
+		redis.call("HSET", key, value, model.id)
+	end
 end
 
 local function remove_uniques(model)
-  local memo = model.key .. ":_uniques"
+	local memo = model.key .. ":_uniques"
 
-  for _, key in pairs(redis.call("HKEYS", memo)) do
-    redis.call("HDEL", key, redis.call("HGET", memo, key))
-    redis.call("HDEL", memo, key)
-  end
+	for _, key in pairs(redis.call("HKEYS", memo)) do
+		redis.call("HDEL", key, redis.call("HGET", memo, key))
+		redis.call("HDEL", memo, key)
+	end
 end
 
 local function verify(model, uniques)
-  local duplicates = {}
+	local duplicates = {}
 
-  for field, value in pairs(uniques) do
-    local key = model.name .. ":uniques:" .. field
-    local id = redis.call("HGET", key, tostring(value))
+	for field, value in pairs(uniques) do
+		local key = model.name .. ":uniques:" .. field
+		local id = redis.call("HGET", key, tostring(value))
 
-    if id and id ~= tostring(model.id) then
-      duplicates[#duplicates + 1] = field
-    end
-  end
+		if id and id ~= tostring(model.id) then
+			duplicates[#duplicates + 1] = field
+		end
+	end
 
-  return duplicates, #duplicates ~= 0
+	return duplicates, #duplicates ~= 0
 end
 
 local duplicates, err = verify(model, uniques)
 
 if err then
-  error("UniqueIndexViolation: " .. duplicates[1])
+	error("UniqueIndexViolation: " .. duplicates[1])
 end
 
 save(model, attrs)

data/ohm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ohm"
-  s.version = "2.0.0.rc2"
+  s.version = "2.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"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ohm
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0
 platform: ruby
 authors:
 - Michel Martens
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
@@ -83,7 +83,6 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
 - benchmarks/common.rb
 - benchmarks/create.rb
 - benchmarks/delete.rb
@@ -136,9 +135,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: ohm
 rubygems_version: 2.0.3

data/Rakefile

@@ -1,69 +0,0 @@
-REDIS_DIR = File.expand_path(File.join("..", "test"), __FILE__)
-REDIS_CNF = File.join(REDIS_DIR, "test.conf")
-REDIS_PID = File.join(REDIS_DIR, "db", "redis.pid")
-
-task :default => :run
-
-desc "Run tests and manage server start/stop"
-task :run => [:start, :test, :stop]
-
-desc "Start the Redis server"
-task :start do
-  unless File.exists?(REDIS_PID)
-    system "redis-server #{REDIS_CNF}"
-  end
-end
-
-desc "Stop the Redis server"
-task :stop do
-  if File.exists?(REDIS_PID)
-    system "kill #{File.read(REDIS_PID)}"
-    File.delete(REDIS_PID)
-  end
-end
-
-task :test do
-  require File.expand_path("./test/helper", File.dirname(__FILE__))
-
-  Cutest.run(Dir["test/*.rb"])
-end
-
-desc "Generate documentation"
-task :doc => :yard
-
-desc "Generated YARD documentation"
-task :yard do
-  require "yard"
-
-  opts = []
-  opts.push("--protected")
-  opts.push("--no-private")
-  opts.push("--private")
-  opts.push("--title", "Ohm — Object-hash mapping library for Redis")
-
-  YARD::CLI::Yardoc.run(*opts)
-
-  Dir["doc/**/*.html"].each do |file|
-    contents = File.read(file)
-
-    contents.sub! %r{</body>}, <<-EOS
-      <script type="text/javascript">
-      var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
-      document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
-      </script>
-      <script type="text/javascript">
-      try {
-      var pageTracker = _gat._getTracker("UA-11356145-1");
-      pageTracker._trackPageview();
-      } catch(err) {}</script>
-      </body>
-    EOS
-
-    File.open(file, "w") { |f| f.write(contents) }
-  end
-end
-
-desc "Deploy documentation"
-task :deploy do
-  system "rsync --del -avz doc/* ohm.keyvalue.org:deploys/ohm.keyvalue.org/"
-end