ohm 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Michel Martens and Damian Janowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,74 @@
+Ohm
+============
+
+Object-hash mapping library for Redis.
+
+Description
+-----------
+
+Ohm is a library that allows to store an object in
+[Redis](http://code.google.com/p/redis/), a persistent key-value
+database. It includes an extensible list of validations and has very
+good performance.
+
+Usage
+-----
+
+    require 'ohm'
+
+    $redis = Redis.new
+
+    class Event < Ohm::Model
+      attribute :name
+      set :participants
+
+      def validate
+        assert_present :name
+      end
+    end
+
+    event = Event.create(:name => "Ruby Tuesday")
+    event.participants << "Michel Martens"
+    event.participants << "Damian Janowski"
+
+    another_event = Event.new
+    another_event.valid?    #=> false
+    another_event.errors    #=> [[:name, :nil]]
+
+    another_event.name = ""
+    another_event.valid?    #=> false
+    another_event.errors    #=> [[:name, :empty]]
+
+    another_event.name = "Ruby Lunch"
+    another_event.save      #=> true
+
+Installation
+------------
+
+    $ sudo gem install ohm
+
+License
+-------
+
+Copyright (c) 2009 Michel Martens and Damian Janowski
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rake/clean'
+require "rake/testtask"
+require 'rake/gempackagetask'
+
+task :default => :test
+
+def gem_spec_file
+  'ohm.gemspec'
+end
+
+def gem_spec
+  $gem_spec ||= eval(File.read(gem_spec_file)) rescue nil
+end
+
+desc 'Run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+  rm_f FileList['pkg/**/*.*']
+end if gem_spec
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
+end
+
+desc "Builds and installs the gem."
+task :install => :repackage do
+  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
+end
+
+def package(ext='')
+  "pkg/ohm-#{gem_spec.version}" + ext
+end
+
+desc 'Build packages'
+task :package => %w[.gem .tar.gz].map {|e| package(e)}
+
+desc 'Build and install as local gem'
+task :install => package('.gem') do
+  sh "gem install #{package('.gem')}"
+end
+
+directory 'pkg/'
+CLOBBER.include('pkg')
+
+file package('.gem') => %w[pkg/ ohm.gemspec] + gem_spec.files do |f|
+  sh "gem build ohm.gemspec"
+  mv File.basename(f.name), f.name
+end
+
+file package('.tar.gz') => %w[pkg/] + gem_spec.files do |f|
+  sh <<-SH
+    git archive \
+      --prefix=ohm-#{gem_spec.version}/ \
+      --format=tar \
+      HEAD | gzip > #{f.name}
+  SH
+end
+
+# Rubyforge Release / Publish Tasks ==================================
+
+desc 'Publish gem and tarball to rubyforge'
+task 'release' => [package('.gem'), package('.tar.gz')] do |t|
+  sh <<-end
+    rubyforge add_release ohm ohm #{gem_spec.version} #{package('.gem')} &&
+    rubyforge add_file    ohm ohm #{gem_spec.version} #{package('.tar.gz')}
+  end
+end

data/lib/ohm.rb

@@ -0,0 +1,242 @@
+require "rubygems"
+require "redis"
+
+module Ohm
+  module Validations
+    def valid?
+      errors.clear
+      validate
+      errors.empty?
+    end
+
+    def validate
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+  private
+
+    def assert_format(att, format)
+      if assert_present(att)
+        assert attribute(att).match(format), [att, :format]
+      end
+    end
+
+    def assert_present(att)
+      if assert_not_nil(att)
+        assert attribute(att).any?, [att, :empty]
+      end
+    end
+
+    def assert_not_nil(att)
+      assert attribute(att), [att, :nil]
+    end
+
+    def assert(value, error)
+      value or errors.push(error) && false
+    end
+
+    def attribute(att)
+      instance_variable_get("@#{att}")
+    end
+  end
+
+  module Attributes
+    class Collection < Array
+      attr_accessor :key, :db
+
+      def initialize(db, key)
+        self.db = db
+        self.key = key
+        super(retrieve)
+      end
+    end
+
+    class List < Collection
+      def retrieve
+        db.list_range(key, 0, -1)
+      end
+
+      def << value
+        super(value) if db.push_tail(key, value)
+      end
+    end
+
+    class Set < Collection
+      def retrieve
+        db.set_members(key).sort
+      end
+
+      def << value
+        super(value) if db.set_add(key, value)
+      end
+
+      def delete(value)
+        super(value) if db.set_delete(key, value)
+      end
+
+      def include?(value)
+        db.set_member?(key, value)
+      end
+    end
+  end
+
+  class Model
+    include Validations
+
+    ModelIsNew = Class.new(StandardError)
+
+    @@attributes = Hash.new { |hash, key| hash[key] = [] }
+    @@collections = Hash.new { |hash, key| hash[key] = [] }
+
+    attr_accessor :id
+
+    def self.attribute(name)
+      attr_writer(name)
+      attr_value_reader(name)
+      attributes << name
+    end
+
+    def self.list(name)
+      attr_list_reader(name)
+      collections << name
+    end
+
+    def self.set(name)
+      attr_set_reader(name)
+      collections << name
+    end
+
+    # TODO Encapsulate access to db?
+    def self.attr_value_reader(name)
+      class_eval <<-EOS
+        def #{name}
+          @#{name} ||= db[key("#{name}")]
+        end
+      EOS
+    end
+
+    def self.attr_list_reader(name)
+      class_eval <<-EOS
+        def #{name}
+          @#{name} ||= Attributes::List.new(db, key("#{name}"))
+        end
+      EOS
+    end
+
+    def self.attr_set_reader(name)
+      class_eval <<-EOS
+        def #{name}
+          @#{name} ||= Attributes::Set.new(db, key("#{name}"))
+        end
+      EOS
+    end
+
+    def self.[](id)
+      new(:id => id) if exists?(id)
+    end
+
+    def self.all
+      filter(:all).map do |id|
+        new(:id => id)
+      end
+    end
+
+    def self.attributes
+      @@attributes[self]
+    end
+
+    def self.collections
+      @@collections[self]
+    end
+
+    def self.create(*args)
+      new(*args).create
+    end
+
+    def initialize(attrs = {})
+      attrs.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    end
+
+    def create
+      return unless valid?
+      initialize_id
+      create_model_membership
+      save!
+    end
+
+    def save
+      return unless valid?
+      save!
+    end
+
+    def delete
+      delete_attributes(collections)
+      delete_attributes(attributes)
+      delete_model_membership
+      self
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def collections
+      self.class.collections
+    end
+
+  private
+
+    def self.db
+      $redis
+    end
+
+    def self.key(*args)
+      args.unshift(self).join(":")
+    end
+
+    def self.filter(name)
+      db.set_members(key(name))
+    end
+
+    def self.exists?(id)
+      db.set_member?(key(:all), id)
+    end
+
+    def initialize_id
+      self.id = db.incr(self.class.key("id"))
+    end
+
+    def db
+      self.class.db
+    end
+
+    def key(*args)
+      raise ModelIsNew unless id
+      self.class.key(id, *args)
+    end
+
+    def delete_attributes(atts)
+      atts.each do |att|
+        db.delete(key(att))
+      end
+    end
+
+    def create_model_membership
+      db.set_add(self.class.key(:all), id)
+    end
+
+    def delete_model_membership
+      db.set_delete(self.class.key(:all), id)
+    end
+
+    def save!
+      attributes.each { |att| db[key(att)] = send(att) }
+      self
+    end
+  end
+end

data/test/all_tests.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/model_test.rb'
+require File.dirname(__FILE__) + '/validations_test.rb'

data/test/benchmarks.rb

@@ -0,0 +1,32 @@
+require "rubygems"
+require "bench"
+require File.dirname(__FILE__) + "/../lib/ohm"
+
+$redis = Redis.new(:port => 6381)
+$redis.flush_db
+
+class Event < Ohm::Model
+  attribute :name
+  set :attendees
+
+  def validate
+    assert_present :name
+  end
+end
+
+event = Event.create(:name => "Ruby Tuesday")
+array = []
+
+benchmark "redis add to set" do
+  $redis.set_add("foo", 1)
+end
+
+benchmark "ohm add to set" do
+  event.attendees << 1
+end
+
+benchmark "ruby array push" do
+  array.push(1)
+end
+
+run 10000

data/test/db/redis.pid

@@ -0,0 +1 @@
+6416

data/test/model_test.rb

@@ -0,0 +1,244 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Event < Ohm::Model
+  attribute :name
+  set :attendees
+end
+
+class User < Ohm::Model
+  attribute :email
+end
+
+class Post < Ohm::Model
+  attribute :body
+  list :comments
+end
+
+class TestRedis < Test::Unit::TestCase
+  context "An event initialized with a hash of attributes" do
+    should "assign the passed attributes" do
+      event = Event.new(:name => "Ruby Tuesday")
+      assert_equal event.name, "Ruby Tuesday"
+    end
+  end
+
+  context "An event created from a hash of attributes" do
+    should "assign an id and save the object" do
+      event1 = Event.create(:name => "Ruby Tuesday")
+      event2 = Event.create(:name => "Ruby Meetup")
+      assert_equal event1.id + 1, event2.id
+    end
+  end
+
+  context "Finding an event" do
+    setup do
+      $redis.set_add("Event", 1)
+      $redis["Event:1:name"] = "Concert"
+    end
+
+    should "return an instance of Event" do
+      assert Event[1].kind_of?(Event)
+      assert_equal 1, Event[1].id
+      assert_equal "Concert", Event[1].name
+    end
+  end
+
+  context "Finding a user" do
+    setup do
+      $redis.set_add("User:all", 1)
+      $redis["User:1:email"] = "albert@example.com"
+    end
+
+    should "return an instance of User" do
+      assert User[1].kind_of?(User)
+      assert_equal 1, User[1].id
+      assert_equal "albert@example.com", User[1].email
+    end
+  end
+
+  context "Updating a user" do
+    setup do
+      $redis.set_add("User:all", 1)
+      $redis["User:1:email"] = "albert@example.com"
+
+      @user = User[1]
+    end
+
+    should "change its attributes" do
+      @user.email = "maria@example.com"
+      assert_equal "maria@example.com", @user.email
+    end
+
+    should "save the new values" do
+      @user.email = "maria@example.com"
+      @user.save
+
+      @user.email = "maria@example.com"
+      @user.save
+
+      assert_equal "maria@example.com", User[1].email
+    end
+  end
+
+  context "Creating a new model" do
+    should "assign a new id to the event" do
+      event1 = Event.new
+      event1.create
+
+      event2 = Event.new
+      event2.create
+
+      assert event1.id
+      assert_equal event1.id + 1, event2.id
+    end
+  end
+
+  context "Saving a model" do
+    should "not save a new model" do
+      assert_raise Ohm::Model::ModelIsNew do
+        Event.new.save
+      end
+    end
+
+    should "save it only if it was previously created" do
+      event = Event.new
+      event.name = "Lorem ipsum"
+      event.create
+
+      event.name = "Lorem"
+      event.save
+
+      assert_equal "Lorem", Event[event.id].name
+    end
+  end
+
+  context "Delete" do
+    class ModelToBeDeleted < Ohm::Model
+      attribute :name
+      set :foos
+      list :bars
+    end
+
+    setup do
+      @model = ModelToBeDeleted.create(:name => "Lorem")
+
+      @model.foos << "foo"
+      @model.bars << "bar"
+    end
+
+    should "delete an existing model" do
+      id = @model.id
+
+      @model.delete
+
+      assert_nil $redis[ModelToBeDeleted.key(id)]
+      assert_nil $redis[ModelToBeDeleted.key(id, :name)]
+      assert_equal Set.new, $redis.set_members(ModelToBeDeleted.key(id, :foos))
+      assert_equal Array.new, $redis.list_range(ModelToBeDeleted.key(id, :bars), 0, -1)
+
+      assert ModelToBeDeleted.all.empty?
+    end
+  end
+
+  context "Listing" do
+    should "find all" do
+      event1 = Event.new
+      event1.name = "Ruby Meetup"
+      event1.create
+
+      event2 = Event.new
+      event2.name = "Ruby Tuesday"
+      event2.create
+
+      all = Event.all
+
+      assert all.detect {|e| e.name == "Ruby Meetup" }
+      assert all.detect {|e| e.name == "Ruby Tuesday" }
+    end
+  end
+
+  context "Loading attributes" do
+    setup do
+      event = Event.new
+      event.name = "Ruby Tuesday"
+      @id = event.create.id
+    end
+
+    should "load attributes lazily" do
+      event = Event[@id]
+
+      assert_nil event.send(:instance_variable_get, "@name")
+      assert_equal "Ruby Tuesday", event.name
+    end
+
+    should "load attributes as a strings" do
+      event = Event.create(:name => 1)
+
+      assert_equal "1", Event[event.id].name
+    end
+  end
+
+  context "Attributes of type Set" do
+    setup do
+      @event = Event.new
+      @event.name = "Ruby Tuesday"
+    end
+
+    should "not be available if the model is new" do
+      assert_raise Ohm::Model::ModelIsNew do
+        @event.attendees << 1
+      end
+    end
+
+    should "return an array if the model exists" do
+      @event.create
+      assert @event.attendees.kind_of?(Array)
+    end
+
+    should "remove an element if sent :delete" do
+      @event.create
+      @event.attendees << "1"
+      @event.attendees << "2"
+      @event.attendees << "3"
+      assert_equal ["1", "2", "3"], @event.attendees
+      @event.attendees.delete("2")
+      assert_equal ["1", "3"], Event[@event.id].attendees
+    end
+
+    should "return true if the set includes some member" do
+      @event.create
+      @event.attendees << "1"
+      @event.attendees << "2"
+      @event.attendees << "3"
+      assert @event.attendees.include?("2")
+      assert_equal false, @event.attendees.include?("4")
+    end
+  end
+
+  context "Attributes of type List" do
+    setup do
+      @post = Post.new
+      @post.body = "Hello world!"
+      @post.create
+    end
+
+    should "return an array" do
+      assert @post.comments.kind_of?(Array)
+    end
+
+    should "keep the inserting order" do
+      @post.comments << "1"
+      @post.comments << "2"
+      @post.comments << "3"
+      assert_equal ["1", "2", "3"], @post.comments
+    end
+
+    should "keep the inserting order after saving" do
+      @post.comments << "1"
+      @post.comments << "2"
+      @post.comments << "3"
+      @post.save
+      assert_equal ["1", "2", "3"], Post[@post.id].comments
+    end
+  end
+end

data/test/test.conf

@@ -0,0 +1,15 @@
+daemonize yes
+dir ./test/db
+pidfile ./redis.pid
+port 6381
+timeout 300
+
+save 900 1
+save 300 10
+save 60 10000
+
+loglevel debug
+
+logfile stdout
+
+databases 16

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "ruby-debug"
+require "contest"
+require File.dirname(__FILE__) + "/../lib/ohm"
+
+$redis = Redis.new(:port => 6381)
+$redis.flush_db

data/test/validations_test.rb

@@ -0,0 +1,152 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ValidationsTest < Test::Unit::TestCase
+  class Event < Ohm::Model
+    attribute :name
+
+    def validate
+      assert_format(:name, /^\w+$/)
+    end
+  end
+
+  context "A new model with validations" do
+    setup do
+      @event = Event.new
+    end
+
+    context "That must have a present name" do
+      should "not be created if the name is never assigned" do
+        @event.create
+        assert_nil @event.id
+      end
+
+      should "not be created if the name assigned is empty" do
+        @event.name = ""
+        @event.create
+        assert_nil @event.id
+      end
+
+      should "be created if the name assigned is not empty" do
+        @event.name = "hello"
+        @event.create
+        assert_not_nil @event.id
+      end
+
+      context "And must have a name with only \w+" do
+        should "not be created if the name doesn't match /^\w+$/" do
+          @event.name = "hello-world"
+          @event.create
+          assert_nil @event.id
+        end
+      end
+    end
+  end
+
+  context "An existing model with a valid name" do
+    setup do
+      @event = Event.create(:name => "original")
+    end
+
+    context "That has the name changed" do
+      should "not be saved if the new name is nil" do
+        @event.name = nil
+        @event.save
+        assert_equal false, @event.valid?
+        assert_equal "original", Event[@event.id].name
+      end
+
+      should "not be saved if the name assigned is empty" do
+        @event.name = ""
+        @event.save
+        assert_equal false, @event.valid?
+        assert_equal "original", Event[@event.id].name
+      end
+
+      should "be saved if the name assigned is not empty" do
+        @event.name = "hello"
+        @event.save
+        assert @event.valid?
+        assert_equal "hello", Event[@event.id].name
+      end
+    end
+  end
+
+  context "Validations module" do
+    class Validatable
+      attr_accessor :name
+
+      include Ohm::Validations
+    end
+
+    setup do
+      @target = Validatable.new
+    end
+
+    context "assert" do
+      should "add errors to a collection" do
+        def @target.validate
+          assert(false, "Something bad")
+        end
+
+        @target.validate
+
+        assert_equal ["Something bad"], @target.errors
+      end
+
+      should "allow for nested validations" do
+        def @target.validate
+          if assert(true, "No error")
+            assert(false, "Chained error")
+          end
+
+          if assert(false, "Parent error")
+            assert(false, "No chained error")
+          end
+        end
+
+        @target.validate
+
+        assert_equal ["Chained error", "Parent error"], @target.errors
+      end
+    end
+
+    context "assert_present" do
+      setup do
+        def @target.validate
+          assert_present(:name)
+        end
+      end
+
+      should "fail when the attribute is nil" do
+        @target.validate
+
+        assert_equal [[:name, :nil]], @target.errors
+      end
+
+      should "fail when the attribute is empty" do
+        @target.name = ""
+        @target.validate
+
+        assert_equal [[:name, :empty]], @target.errors
+      end
+    end
+
+    context "assert_not_nil" do
+      should "fail when the attribute is nil" do
+        def @target.validate
+          assert_not_nil(:name)
+        end
+
+        @target.validate
+
+        assert_equal [[:name, :nil]], @target.errors
+
+        @target.errors.clear
+        @target.name = ""
+        @target.validate
+
+        assert_equal [], @target.errors
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: ohm
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michel Martens, Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-13 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: 
+email: michel@soveran.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ohm.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- test/all_tests.rb
+- test/benchmarks.rb
+- test/db/dump.rdb
+- test/db/redis.pid
+- test/model_test.rb
+- test/test.conf
+- test/test_helper.rb
+- test/validations_test.rb
+has_rdoc: false
+homepage: http://github.com/soveran/ohm
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 2
+summary: Object-hash mapping library for Redis.
+test_files: []
+