ohm 0.1.3 → 0.1.4

data/README.markdown

@@ -24,9 +24,20 @@ Related projects
 These are libraries in other languages that were inspired by Ohm.
 
 * [JOhm](https://github.com/xetorthio/johm) for Java, created by xetorthio
+* [Lohm](https://github.com/slact/lua-ohm) for Lua, created by slact
 * [Nohm](https://github.com/maritz/nohm) for Node.js, created by maritz
 * [Redisco](https://github.com/iamteem/redisco) for Python, created by iamteem
 
+Articles and Presentations
+--------------------------
+
+* [Simplicty](http://files.soveran.com/simplicity)
+* [How to Redis](http://www.paperplanes.de/2009/10/30/how_to_redis.html)
+* [Redis and Ohm](http://carlopecchia.eu/blog/2010/04/30/redis-and-ohm-part1/)
+* [Ohm (Redis ORM)](http://blog.s21g.com/articles/1717) (Japanese)
+* [Redis and Ohm](http://www.slideshare.net/awksedgreep/redis-and-ohm)
+* [Ruby off Rails](http://www.slideshare.net/cyx.ucron/ruby-off-rails)
+
 Getting started
 ---------------
 
@@ -66,35 +77,42 @@ set the environment variable `REDIS_URL`.
 
 Here are the options for {Ohm.connect} in detail:
 
-**:url**
-:    A Redis URL of the form `redis://:<passwd>@<host>:<port>/<db>`.
-     Note that if you specify a URL and one of the other options at
-     the same time, the other options will take precedence. Also, if
-     you try and do `Ohm.connect` without any arguments, it will check
-     if `ENV["REDIS_URL"]` is set, and will use it as the argument for
-     `:url`.
+### :url
+
+A Redis URL of the form `redis://:<passwd>@<host>:<port>/<db>`.
+Note that if you specify a URL and one of the other options at
+the same time, the other options will take precedence. Also, if
+you try and do `Ohm.connect` without any arguments, it will check
+if `ENV["REDIS_URL"]` is set, and will use it as the argument for
+`:url`.
+
+### :host
+
+Host where the Redis server is running, defaults to `"127.0.0.1"`.
+
+### :port
+
+Port number, defaults to `6379`.
+
+### :db
 
-**:host**
-:    Host where the Redis server is running, defaults to `"127.0.0.1"`.
+Database number, defaults to `0`.
 
-**:port**
-:    Port number, defaults to `6379`.
+### :password
 
-**:db**
-:    Database number, defaults to `0`.
+It is the secret that will be sent to the Redis server. Use it if the server
+configuration requires it. Defaults to `nil`.
 
-**:password**
-:    It is the secret that will be sent to the Redis server. Use it if the server
-     configuration requires it. Defaults to `nil`.
+### :timeout
 
-**:timeout**
-:    Database timeout in seconds, defaults to `0`.
+Database timeout in seconds, defaults to `0`.
 
-**:thread_safe**
-:    Initializes the client with a monitor. It has a small performance penalty, and
-     it's off by default. For thread safety, it is recommended to use a different
-     instance per thread. I you have no choice, then pass `:thread_safe => true`
-     when connecting.
+### :thread_safe
+
+Initializes the client with a monitor. It has a small performance penalty, and
+it's off by default. For thread safety, it is recommended to use a different
+instance per thread. I you have no choice, then pass `:thread_safe => true`
+when connecting.
 
 Models
 ------
@@ -143,6 +161,10 @@ This is how you interact with IDs:
     Event[2]
     # => nil
 
+    # Finding all the events
+    Event.all
+    # => [#<Event @values={:id=>1, :name=>"Ohm Worldwide Conference 2031"}>]
+
 This example shows some basic features, like attribute declarations and
 validations. Keep reading to find out what you can do with models.
 
@@ -249,68 +271,73 @@ ordered by `id`, and {Ohm::Model::Collection#sort_by 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:
 
-**:order**
-:    Order direction and strategy. You can pass in any of
-     the following:
+### :order
+
+Order direction and strategy. You can pass in any of the following:
 
      1. ASC
      2. ASC ALPHA (or ALPHA ASC)
      3. DESC
      4. DESC ALPHA (or ALPHA DESC)
 
-     It defaults to `ASC`.
+It defaults to `ASC`.
+
+### :start
+
+The offset from which we should start with. Note that
+this is 0-indexed. It defaults to `0`.
+
+### :limit
+
+The number of entries to get. If you don't pass in anything, it will
+get all the results from the LIST or SET that you are sorting.
+
+### :by
 
-**:start**
-:    The offset from which we should start with. Note that
-     this is 0-indexed. It defaults to `0`.
+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
+converts the passed argument with the assumption that it is a hash key
+and it's within the current model you are sorting.
 
-**:limit**
-:    The number of entries to get. If you don't pass in anything, it will
-     get all the results from the LIST or SET that you are sorting.
+    Post.all.sort_by(:title)     # SORT Post:all BY Post:*->title
+    Post.all.sort(:by => :title) # SORT Post:all BY title
 
-**: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
-     converts the passed argument with the assumption that it is a hash key
-     and it's within the current model you are sorting.
+### :get
 
-         Post.all.sort_by(:title)     # SORT Post:all BY Post:*->title
-         Post.all.sort(:by => :title) # SORT Post:all BY title
+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
+that `sort_by` does much of the hand-coding for you.
 
-**: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
-     that `sort_by` does much of the hand-coding for you.
+    Post.all.sort_by(:title, :get => :title)
+    # SORT Post:all BY Post:*->title GET Post:*->title
 
-         Post.all.sort_by(:title, :get => :title)
-         # SORT Post:all BY Post:*->title GET Post:*->title
+    Post.all.sort(:by => :title, :get => :title)
+    # SORT Post:all BY title GET title
 
-         Post.all.sort(:by => :title, :get => :title)
-         # SORT Post:all BY title GET title
 
+### :store
 
-**:store**
-:    An optional key which you may use to cache the sorted result. The key
-     may or may not exist.
+An optional key which you may use to cache the sorted result. The key
+may or may not exist.
 
-     This option can only be used together with `:get`.
+This option can only be used together with `:get`.
 
-     The type that is used for the STORE key is a LIST.
+The type that is used for the STORE key is a LIST.
 
-       Post.all.sort_by(:title, :store => "FOO")
+    Post.all.sort_by(:title, :store => "FOO")
 
-       # Get all the results stored in FOO.
-       Post.db.lrange("FOO", 0, -1)
+    # Get all the results stored in FOO.
+    Post.db.lrange("FOO", 0, -1)
 
-     When using temporary values, it might be a good idea to use a `volatile`
-     key. In Ohm, a volatile key means it just starts with a `~` character.
+When using temporary values, it might be a good idea to use a `volatile`
+key. In Ohm, a volatile key means it just starts with a `~` character.
 
-         Post.all.sort_by(:title, :get => :title,
-                          :store => Post.key.volatile["FOO"])
+    Post.all.sort_by(:title, :get => :title,
+                     :store => Post.key.volatile["FOO"])
 
-         Post.key.volatile["FOO"].lrange 0, -1
+    Post.key.volatile["FOO"].lrange 0, -1
 
 
 Associations
@@ -353,8 +380,8 @@ the following:
       end
     end
 
-_(The only difference with the actual implementation is that the model
-is memoized.)_
+The only difference with the actual implementation is that the model
+is memoized.
 
 The net effect here is we can conveniently set and retrieve `Post` objects,
 and also search comments using the `post_id` index.
@@ -433,7 +460,7 @@ Note that calling these methods results in new sets being created
 on the fly. This is important so that you can perform further operations
 before reading the items to the client.
 
-For more information, see [SINTERSTORE](http://code.google.com/p/redis/wiki/SinterstoreCommand) and [SDIFFSTORE](http://code.google.com/p/redis/wiki/SdiffstoreCommand).
+For more information, see [SINTERSTORE](http://redis.io/commands/sinterstore) and [SDIFFSTORE](http://redis.io/commands/sdiffstore).
 
 Validations
 -----------
@@ -548,7 +575,7 @@ Ohm Extensions
 
 Ohm is rather small and can be extended in many ways.
 
-A lot of amazing contributions are available at [Ohm Contrib](http://labs.sinefunc.com/ohm-contrib/doc/), make sure to check them if you need to extend Ohm's functionality.
+A lot of amazing contributions are available at [Ohm Contrib](http://cyx.github.com/ohm-contrib/doc/), make sure to check them if you need to extend Ohm's functionality.
 
 Tutorials
 =========

data/Rakefile

@@ -30,6 +30,53 @@ task :test do
   Cutest.run(Dir["test/*_test.rb"])
 end
 
+desc "Generate documentation"
+task :doc => [:yard, :rocco]
+
+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 "Generate ROCCO documentation"
+task :rocco do
+  `mkdir doc/examples` unless Dir.exists?("doc/examples")
+  `rocco examples/*.*`
+  `mv examples/*.html doc/examples`
+end
+
+desc "Deploy documentation"
+task :deploy do
+  system "rsync --del -avz doc/* ohm.keyvalue.org:deploys/ohm.keyvalue.org/"
+end
+
 namespace :examples do
   desc "Run all the examples"
   task :run do

data/lib/ohm.rb

@@ -470,7 +470,7 @@ module Ohm
       # @see http://code.google.com/p/redis/wiki/SmembersCommand SMEMBERS
       #      in Redis Command Reference.
       def each(&block)
-        key.smembers.each { |id| block.call(model[id]) }
+        key.smembers.each { |id| block.call(model.to_proc[id]) }
       end
 
       # Convenient way to scope access to a predefined set, useful for access
@@ -784,7 +784,7 @@ module Ohm
       # @see http://code.google.com/p/redis/wiki/LrangeCommand LRANGE
       #      in Redis Command Reference.
       def each(&block)
-        key.lrange(0, -1).each { |id| block.call(model[id]) }
+        key.lrange(0, -1).each { |id| block.call(model.to_proc[id]) }
       end
 
       # Thin wrapper around *RPUSH*.
@@ -845,9 +845,9 @@ module Ohm
       def [](index, limit = nil)
         case [index, limit]
         when Pattern[Fixnum, Fixnum] then
-          key.lrange(index, limit).collect { |id| model[id] }
+          key.lrange(index, limit).collect { |id| model.to_proc[id] }
         when Pattern[Range, nil] then
-          key.lrange(index.first, index.last).collect { |id| model[id] }
+          key.lrange(index.first, index.last).collect { |id| model.to_proc[id] }
         when Pattern[Fixnum, nil] then
           model[key.lindex(index)]
         end
@@ -932,7 +932,7 @@ module Ohm
       end
     end
 
-    # All validations which need to access the _Redis_ database goes here.
+    # All validations that need access to the _Redis_ database go here.
     # As of this writing, {Ohm::Model::Validations#assert_unique} is the only
     # assertion contained within this module.
     module Validations
@@ -1287,7 +1287,7 @@ module Ohm
 
     # @private Used for conveniently doing [1, 2].map(&Post) for example.
     def self.to_proc
-      Proc.new { |id| self[id] }
+      lambda { |id| new(:id => id) }
     end
 
     # Returns a {Ohm::Model::Set set} containing all the members of a given
@@ -1714,8 +1714,8 @@ module Ohm
     #   Post.connect(:port => 6380, :db => 2)
     #
     # @see file:README.html#connecting Ohm.connect options documentation.
-    def self.connect(*options)
-      self.db = Ohm.connection(*options)
+    def self.connect(options = {})
+      @options = options
     end
 
     # @return [Ohm::Key] A key scoped to the model which uses this object's
@@ -1803,7 +1803,9 @@ module Ohm
 
     # Provides access to the Redis database. This is shared accross all models and instances.
     def self.db
-      Ohm.threaded[self] || Ohm.redis
+      return Ohm.redis unless defined?(@options)
+
+      Redis.connect(@options)
     end
 
     def self.db=(connection)
@@ -1999,4 +2001,3 @@ module Ohm
     end
   end
 end
-

data/lib/ohm/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Ohm
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/test/model_test.rb

@@ -659,6 +659,8 @@ class ::Calendar < Ohm::Model
   list :holidays, lambda { |v| Date.parse(v) }
   list :subscribers, lambda { |id| MyActiveRecordModel.find(id) }
   list :appointments, Appointment
+
+  set :events, lambda { |id| MyActiveRecordModel.find(id) }
 end
 
 class ::Appointment < Ohm::Model
@@ -673,6 +675,8 @@ setup do
   @calendar.holidays.key.rpush "2009-07-09"
 
   @calendar.subscribers << MyActiveRecordModel.find(1)
+
+  @calendar.events << MyActiveRecordModel.find(1)
 end
 
 test "apply a transformation" do
@@ -682,6 +686,24 @@ test "apply a transformation" do
   assert [MyActiveRecordModel.find(1)] == @calendar.subscribers.all
 end
 
+test "doing an each on lists" do
+  arr = []
+  @calendar.subscribers.each do |sub|
+    arr << sub
+  end
+
+  assert [MyActiveRecordModel.find(1)] == arr
+end
+
+test "doing an each on sets" do
+  arr = []
+  @calendar.events.each do |sub|
+    arr << sub
+  end
+
+  assert [MyActiveRecordModel.find(1)] == arr
+end
+
 test "allow lambdas in references" do
   appointment = Appointment.create(:subscriber => MyActiveRecordModel.find(1))
   assert MyActiveRecordModel.find(1) == appointment.subscriber
@@ -956,4 +978,4 @@ test "be persisted" do
   assert "hash" == Ohm.redis.type("SomeNamespace::Foo:1")
 
   assert "foo" == SomeNamespace::Foo[1].name
-end
+end

metadata

@@ -1,77 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ohm
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Michel Martens
 - Damian Janowski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-05 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156327100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: cutest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156327100
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: &2156326460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        version: "0.1"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: batch
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2156326460
+- !ruby/object:Gem::Dependency
+  name: batch
+  requirement: &2156325940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :development
-  version_requirements: *id003
-description: Ohm is a library that allows to store an object in Redis, a persistent key-value database. It includes an extensible list of validations and has very good performance.
-email: 
+  prerelease: false
+  version_requirements: *2156325940
+description: Ohm is a library that allows to store an object in Redis, a persistent
+  key-value database. It includes an extensible list of validations and has very good
+  performance.
+email:
 - michel@soveran.com
 - djanowski@dimaion.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/ohm/compat-1.8.6.rb
 - lib/ohm/key.rb
 - lib/ohm/pattern.rb
@@ -97,37 +80,28 @@ files:
 - test/validations_test.rb
 - test/wrapper_test.rb
 - test/test.conf
-has_rdoc: true
 homepage: http://github.com/soveran/ohm
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: ohm
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Object-hash mapping library for Redis.
 test_files: []
-