ohm 1.0.0.rc4 → 1.0.0

data/README.md

@@ -77,7 +77,7 @@ set the environment variable `REDIS_URL`.
 
 Here are the options for {Ohm.connect} in detail:
 
-### :url
+### :url (recommended)
 
 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
@@ -126,8 +126,8 @@ the example below:
 ```ruby
 class Event < Ohm::Model
   attribute :name
-  reference :venue, Venue
-  set :participants, Person
+  reference :venue, :Venue
+  set :participants, :Person
   counter :votes
 
   index :name
@@ -139,7 +139,7 @@ end
 
 class Venue < Ohm::Model
   attribute :name
-  collection :events, Event
+  collection :events, :Event
 end
 
 class Person < Ohm::Model
@@ -259,7 +259,7 @@ Given the following model declaration:
 ```ruby
 class Event < Ohm::Model
   attribute :name
-  set :attendees, Person
+  set :attendees, :Person
 end
 ```
 
@@ -349,12 +349,12 @@ Ohm lets you declare `references` and `collections` to represent associations.
 class Post < Ohm::Model
   attribute :title
   attribute :body
-  collection :comments, Comment
+  collection :comments, :Comment
 end
 
 class Comment < Ohm::Model
   attribute :body
-  reference :post, Post
+  reference :post, :Post
 end
 ```
 
@@ -419,14 +419,14 @@ in the other model. The following all produce the same effect:
 
 ```ruby
 # easiest, with the basic assumption that the index is `:post_id`
-collection :comments, Comment
+collection :comments, :Comment
 
 # we can explicitly declare this as follows too:
-collection :comments, Comment, :post
+collection :comments, :Comment, :post
 
 # finally, we can use the default argument for the third parameter which
 # is `to_reference`.
-collection :comments, Comment, to_reference
+collection :comments, :Comment, to_reference
 
 # exploring `to_reference` reveals a very interesting and simple concept:
 Post.to_reference == :post
@@ -554,6 +554,51 @@ representation. The error code for this assertion is :not_numeric.
 assert_numeric :votes
 ```
 
+### assert_url
+
+Provides a pretty general URL regular expression match. An important
+point to make is that this assumes that the URL should start with
+`http://` or `https://`. The error code for this assertion is
+`:not_url`.
+
+### assert_email
+
+In this current day and age, almost all web applications need to
+validate an email address. This pretty much matches 99% of the emails
+out there. The error code for this assertion is `:not_email`.
+
+### assert_member
+
+Checks that a given field is contained within a set of values (i.e.
+like an `ENUM`).
+
+``` ruby
+def validate
+  assert_member :state, %w{pending paid delivered}
+end
+```
+
+The error code for this assertion is `:not_valid`
+
+### assert_length
+
+Checks that a given field's length falls under a specified range.
+
+``` ruby
+def validate
+  assert_length :username, 3..20
+end
+```
+
+The error code for this assertion is `:not_in_range`.
+
+### assert_decimal
+
+Checks that a given field looks like a number in the human sense
+of the word. Valid numbers are: 0.1, .1, 1, 1.1, 3.14159, etc.
+
+The error code for this assertion is `:not_decimal`.
+
 Errors
 ------
 
@@ -590,51 +635,13 @@ make sure to check them if you need to extend Ohm's functionality.
 
 [contrib]: http://cyx.github.com/ohm-contrib/doc/
 
-Tutorials
+Upgrading
 =========
 
-NOTE: These tutorials were written against Ohm 0.1.x. Please give us
-a while to fully update all of them.
-
-Check the examples to get a feeling of the design patterns for Redis.
-
-1. [Activity Feed](http://ohm.keyvalue.org/examples/activity-feed.html)
-2. [Chaining finds](http://ohm.keyvalue.org/examples/chaining.html)
-3. [Serialization to JSON](http://ohm.keyvalue.org/examples/json-hash.html)
-4. [One to many associations](http://ohm.keyvalue.org/examples/one-to-many.html)
-5. [Philosophy behind Ohm](http://ohm.keyvalue.org/examples/philosophy.html)
-6. [Learning Ohm internals](http://ohm.keyvalue.org/examples/redis-logging.html)
-7. [Slugs and permalinks](http://ohm.keyvalue.org/examples/slug.html)
-8. [Tagging](http://ohm.keyvalue.org/examples/tagging.html)
-
-
-Versions
-========
-
-Ohm uses features from Redis > 2.6.x. If you are stuck in previous
-versions, please use Ohm 0.1.x instead.
-
-Upgrading from 0.0.x to 0.1
----------------------------
-
-Since Ohm 0.1 changes the persistence strategy (from 1-key-per-attribute
-to Hashes), you'll need to run a script to upgrade your old data set.
-Fortunately, it is built in:
-
-```ruby
-require "ohm/utils/upgrade"
-
-Ohm.connect :port => 6380
-
-Ohm::Utils::Upgrade.new([:User, :Post, :Comment]).run
-```
-
-Yes, you need to provide the model names. The good part is that you
-don't have to load your application environment. Since we assume it's
-very likely that you have a bunch of data, the script uses
-[Batch](http://github.com/djanowski/batch) to show you some progress
-while the process runs.
-
+The changes in Ohm 1 break the compatibility with previous versions.
+We will do our best to provide a script to ease the pain of upgrading.
+In the meantime, it's recommended that you use the new version only
+for new projects.
 
 [redis]: http://redis.io
 [ohm]: http://github.com/soveran/ohm

data/Rakefile

@@ -31,7 +31,7 @@ task :test do
 end
 
 desc "Generate documentation"
-task :doc => [:yard, :rocco]
+task :doc => :yard
 
 desc "Generated YARD documentation"
 task :yard do
@@ -65,46 +65,7 @@ task :yard do
   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
-    begin
-      require "cutest"
-    rescue LoadError
-      raise "!! Missing gem `cutest`. Try `gem install cutest`."
-    end
-
-    Cutest.run(Dir["examples/*.rb"])
-  end
-end
-
-task :paste_lua_inline do
-  def wrap(const, data)
-    ret = "#{const} = (<<-EOT).gsub(/^ {4}/, "")\n"
-    ret << data.gsub(/^/, "    ")
-    ret << "  EOT\n"
-  end
-
-  save = File.read("./lua/save.lua")
-  del  = File.read("./lua/delete.lua")
-  # save = "foo"
-  # del  = "bar"
-
-  ohm = File.read("./lib/ohm.rb", :encoding => "utf-8")
-  ohm.gsub!(/SAVE =(.*?)$(.*?)EOT/m, wrap("SAVE", save))
-  ohm.gsub!(/DELETE =(.*?)$(.*?)EOT/m, wrap("DELETE", del))
-
-  puts ohm
-end

metadata

@@ -1,36 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ohm
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc4
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Michel Martens
 - Damian Janowski
+- Cyril David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nest
-  requirement: !ruby/object:Gem::Requirement
+  name: redis
+  requirement: &2156471380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *2156471380
+- !ruby/object:Gem::Dependency
+  name: nest
+  requirement: &2156470820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156470820
 - !ruby/object:Gem::Dependency
   name: scrivener
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156470340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -38,15 +45,10 @@ dependencies:
         version: 0.0.3
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.3
+  version_requirements: *2156470340
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156469880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,41 +56,20 @@ dependencies:
         version: '0.1'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: batch
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.1
+  version_requirements: *2156469880
 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
+- me@cyrildavid.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/ohm/json.rb
 - lib/ohm/transaction.rb
-- lib/ohm/utils/upgrade.rb
 - lib/ohm.rb
 - README.md
 - LICENSE
@@ -111,13 +92,9 @@ files:
 - test/pipeline-performance.rb
 - test/transactions.rb
 - test/uniques.rb
-- test/unused/associations_test.rb
-- test/unused/pattern_test.rb
-- test/unused/upgrade_script_test.rb
-- test/unused/wrapper_test.rb
 - test/validations.rb
 - test/test.conf
-homepage: http://github.com/soveran/ohm
+homepage: http://soveran.github.com/ohm/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -132,13 +109,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: ohm
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Object-hash mapping library for Redis.
 test_files: []
+has_rdoc: 

data/lib/ohm/utils/upgrade.rb

@@ -1,53 +0,0 @@
-begin
-  require "batch"
-rescue LoadError => e
-  e.message << "\nTry `gem install batch`."
-end
-
-module Ohm
-  module Utils
-    class Upgrade
-      def redis
-        Ohm.redis
-      end
-
-      attr :models
-      attr :types
-
-      def initialize(models)
-        @models = models
-        @types = Hash.new { |hash, model| hash[model] = {} }
-      end
-
-      def run
-        models.each do |model|
-          ns = Ohm::Key.new(model, redis)
-
-          puts "Upgrading #{model}..."
-
-          Batch.each(ns[:all].smembers) do |id|
-            instance = ns[id]
-
-            attrs = []
-            deletes = []
-
-            redis.keys(instance["*"]).each do |key|
-              field = key[instance.size.succ..-1]
-
-              type = (types[model][field] ||= redis.type(key).to_sym)
-
-              if type == :string
-                attrs << field
-                attrs << redis.get(key)
-                deletes << key
-              end
-            end
-
-            redis.hmset(instance, *attrs)
-            redis.del(*deletes)
-          end
-        end
-      end
-    end
-  end
-end

data/test/unused/associations_test.rb

@@ -1,100 +0,0 @@
-# encoding: UTF-8
-
-require File.expand_path("./helper", File.dirname(__FILE__))
-
-class Person < Ohm::Model
-  attribute :name
-end
-
-class ::Note < Ohm::Model
-  attribute :content
-  reference :source, Post
-  collection :comments, Comment
-  list :ratings, Rating
-end
-
-class ::Comment < Ohm::Model
-  reference :note, Note
-end
-
-class ::Rating < Ohm::Model
-  attribute :value
-end
-
-class ::Editor < Ohm::Model
-  attribute :name
-  reference :post, Post
-end
-
-class ::Post < Ohm::Model
-  reference :author, Person
-  collection :notes, Note, :source
-  collection :editors, Editor
-end
-
-setup do
-  @post = Post.create
-end
-
-test "return an instance of Person if author_id has a valid id" do
-  @post.author_id = Person.create(:name => "Albert").id
-  @post.save
-  assert "Albert" == Post[@post.id].author.name
-end
-
-test "assign author_id if author is sent a valid instance" do
-  @post.author = Person.create(:name => "Albert")
-  @post.save
-  assert "Albert" == Post[@post.id].author.name
-end
-
-test "assign nil if nil is passed to author" do
-  @post.author = nil
-  @post.save
-  assert Post[@post.id].author.nil?
-end
-
-test "be cached in an instance variable" do
-  @author = Person.create(:name => "Albert")
-  @post.update(:author => @author)
-
-  assert @author == @post.author
-  assert @post.author.object_id == @post.author.object_id
-
-  @post.update(:author => Person.create(:name => "Bertrand"))
-
-  assert_equal "Bertrand", @post.author.name
-  assert_equal @post.author.object_id, @post.author.object_id
-
-  @post.update(:author_id => Person.create(:name => "Charles").id)
-
-  assert_equal "Charles", @post.author.name
-end
-
-setup do
-  @post = Post.create
-  @note = Note.create(:content => "Interesting stuff", :source => @post)
-  @comment = Comment.create(:note => @note)
-end
-
-test "return a set of notes" do
-  assert @note.source == @post
-  assert @note == @post.notes.first
-end
-
-test "return a set of comments" do
-  assert @comment == @note.comments.first
-end
-
-test "return a list of ratings" do
-  @rating = Rating.create(:value => 5)
-  @note.ratings << @rating
-
-  assert @rating == @note.ratings.first
-end
-
-test "default to the current class name" do
-  @editor = Editor.create(:name => "Albert", :post => @post)
-
-  assert @editor == @post.editors.first
-end

data/test/unused/pattern_test.rb

@@ -1,10 +0,0 @@
-# encoding: UTF-8
-
-require File.expand_path("./helper", File.dirname(__FILE__))
-
-prepare.clear
-
-test "should provide pattern matching" do
-  assert(Ohm::Pattern[1, Fixnum] === [1, 2])
-  assert(Ohm::Pattern[String, Array] === ["foo", ["bar"]])
-end

data/test/unused/upgrade_script_test.rb

@@ -1,62 +0,0 @@
-# encoding: UTF-8
-
-require File.expand_path("./helper", File.dirname(__FILE__))
-
-require "ohm/utils/upgrade"
-
-def redis
-  Ohm.redis
-end
-
-setup do
-  redis.flushdb
-
-  @users = Ohm::Key.new(:User, Ohm.redis)
-
-  10.times do
-    @id = redis.incr(@users[:id])
-    @user = @users[@id]
-
-    redis.sadd @users[:all], @id
-
-    redis.set  @user[:name], "Albert"
-    redis.set  @user[:email], "albert-#{@id}@example.com"
-    redis.incr @user[:views]
-
-    redis.sadd @user[:posts], 1
-    redis.sadd @user[:posts], 2
-
-    redis.lpush @user[:comments], 3
-    redis.lpush @user[:comments], 4
-
-    redis.sadd @user[:_indices], @users[:email][Ohm::Model.encode "albert-#{@id}@example.com"]
-    redis.sadd @users[:email][Ohm::Model.encode "albert-#{@id}@example.com"], @id
-  end
-end
-
-test "upgrade to hashes" do
-  require "stringio"
-
-  stderr, stdout = $stderr, $stdout
-
-  $stderr, $stdout = StringIO.new, StringIO.new
-
-  Ohm::Utils::Upgrade.new([:User]).run
-
-  $stderr, $stdout = stderr, stdout
-
-  @user = @users[1]
-
-  assert redis.get(@user[:name]).nil?
-  assert redis.get(@user[:email]).nil?
-  assert redis.get(@user[:views]).nil?
-
-  assert ["1", "2"] == redis.smembers(@user[:posts])
-
-  assert [@users[:email][Ohm::Model.encode "albert-1@example.com"]] == redis.smembers(@user[:_indices])
-  assert ["1"] == redis.smembers(@users[:email][Ohm::Model.encode "albert-1@example.com"])
-
-  assert "Albert" == redis.hget(@user, :name)
-  assert "albert-1@example.com" == redis.hget(@user, :email)
-  assert "1" == redis.hget(@user, :views)
-end

data/test/unused/wrapper_test.rb

@@ -1,22 +0,0 @@
-# encoding: UTF-8
-
-require File.expand_path("./helper", File.dirname(__FILE__))
-
-prepare.clear
-
-$missing_constants = []
-
-class Object
-  def self.const_missing(name)
-    $missing_constants << name
-    super(name)
-  end
-end
-
-class Foo < Ohm::Model
-  set :bars, Bar
-end
-
-test "calls other const_missing hooks" do
-  assert [:Bar] == $missing_constants
-end