ohm-contrib 1.0.rc1 → 1.0.0.rc2

data/README.markdown

@@ -9,7 +9,6 @@ List of modules
 1. [`Ohm::Boundaries`](http://cyx.github.com/ohm-contrib/doc/Ohm/Boundaries.html)
 2. [`Ohm::Callbacks`](http://cyx.github.com/ohm-contrib/doc/Ohm/Callbacks.html)
 3. [`Ohm::Timestamping`](http://cyx.github.com/ohm-contrib/doc/Ohm/Timestamping.html)
-4. [`Ohm::ToHash`](http://cyx.github.com/ohm-contrib/doc/Ohm/ToHash.html)
 5. [`Ohm::WebValidations`](http://cyx.github.com/ohm-contrib/doc/Ohm/WebValidations.html)
 6. [`Ohm::NumberValidations`](http://cyx.github.com/ohm-contrib/doc/Ohm/NumberValidations.html)
 7. [`Ohm::ExtraValidations`](http://cyx.github.com/ohm-contrib/doc/Ohm/ExtraValidations.html)
@@ -24,7 +23,6 @@ Example usage
 
     class Post < Ohm::Model
       include Ohm::Timestamping
-      include Ohm::ToHash
       include Ohm::Boundaries
       include Ohm::WebValidations
       include Ohm::NumberValidations

data/lib/ohm/callbacks.rb

@@ -1,176 +1,74 @@
 module Ohm
-  # Minimalistic callback support for Ohm::Model.
-  #
-  # You can implement callbacks by overriding any of the following
-  # methods:
-  #
-  #    - before_create
-  #    - after_create
-  #    - before_save
-  #    - after_save
-  #    - before_update
-  #    - after_update
-  #    - before_delete
-  #    - after_delete
-  #
-  # If you prefer to do a class level declaration that is also possible.
-  #
-  # @example
+  # The following is an example usage of this plugin:
   #
   #   class Post < Ohm::Model
   #     include Ohm::Callbacks
   #
-  #     before :create, :timestamp!
-  #     before :save,   :recalc_votes
-  #
-  #     after  :create, :post_to_twitter!
-  #     after  :save,   :sync_ids
-  #
   #   protected
-  #     def clean_decimals
+  #     def before_create
   #       # sanitize the decimal values here
   #     end
   #
-  #     def timestamp!
-  #       # do timestamping code here
-  #     end
-  #
-  #     def recalc_votes
+  #     def before_save
   #       # do something here
   #     end
   #
-  #     def post_to_twitter!
+  #     def after_create
   #       # do twitter posting here
   #     end
   #
-  #     def sync_ids
+  #     def after_save
   #       # do something with the ids
   #     end
   #   end
-
   module Callbacks
-    def self.included(model)
-      model.extend ClassMethods
-    end
+    def save!
+      is_new = new?
+
+      before_create if is_new
+      before_update if not is_new
+      before_save
 
-    module ClassMethods
-      # Use to add a before callback on `method`. Only symbols
-      # are allowed, no string eval, no block option also.
-      #
-      # @example
-      #
-      #   class Post < Ohm::Model
-      #     include Ohm::Callbacks
-      #
-      #     before :create, :timestamp!
-      #     before :save,   :recalc_votes
-      #
-      #   protected
-      #     def timestamp!
-      #       # do timestamping code here
-      #     end
-      #
-      #     def recalc_votes
-      #       # do something here
-      #     end
-      #   end
-      #
-      # @param [Symbol] method the method type, e.g. `:create`, or `:save`
-      # @param [Symbol] callback the name of the method to execute
-      # @return [Array] the callback in an array if added e.g. [:timestamp]
-      # @return [nil] if the callback already exists
-      def before(method, callback)
-        unless callbacks[:before][method].include?(callback)
-          callbacks[:before][method] << callback
-        end
-      end
+      result = super
 
-      # Use to add an after callback on `method`. Only symbols
-      # are allowed, no string eval, no block option also.
-      #
-      # @example
-      #
-      #   class Post < Ohm::Model
-      #     include Ohm::Callbacks
-      #
-      #     after  :create, :post_to_twitter!
-      #     after  :save,   :sync_ids
-      #
-      #   protected
-      #     def post_to_twitter!
-      #       # do twitter posting here
-      #     end
-      #
-      #     def sync_ids
-      #       # do something with the ids
-      #     end
-      #   end
-      #
-      # @param [Symbol] method the method type, `:validate`, `:create`, or `:save`
-      # @param [Symbol] callback the name of the method to execute
-      # @return [Array] the callback in an array if added e.g. [:timestamp]
-      # @return [nil] if the callback already exists
-      def after(method, callback)
-        unless callbacks[:after][method].include?(callback)
-          callbacks[:after][method] << callback
-        end
-      end
+      after_create if is_new
+      after_update if not is_new
+      after_save
 
-      # @private internally used to maintain the state of callbacks
-      def callbacks
-        @callbacks ||= Hash.new { |h, k| h[k] = Hash.new { |h, k| h[k] = [] }}
-      end
+      return result
     end
 
-    # The overriden create of Ohm::Model. It checks if the
-    # model is valid, and executes all before :create callbacks.
-    #
-    # If the create succeeds, all after :create callbacks are
-    # executed.
-    def write
-      creating = @creating
+    def delete
+      before_delete
+      result = super
+      after_delete
 
-      execute_callback(:before, :create) if creating
-      execute_callback(:before, :update) unless creating
-      execute_callback(:before, :save)
+      return result
+    end
 
-      super
+  protected
+    def before_save
+    end
 
-      execute_callback(:after, :create) if creating
-      execute_callback(:after, :update) unless creating
-      execute_callback(:after, :save)
+    def after_save
     end
 
-    def create
-      @creating = true
-      super.tap { @creating = false }
+    def before_create
     end
 
-    def delete
-      execute_callback(:before, :delete)
-      super
-      execute_callback(:after, :delete)
+    def after_create
     end
 
-  protected
-    def before_validate() end
-    def after_validate()  end
-    def before_save()     end
-    def after_save()      end
-    def before_create()   end
-    def after_create()    end
-    def before_update()   end
-    def after_update()    end
-    def before_delete()   end
-    def after_delete()    end
+    def before_update
+    end
 
-  private
-    def execute_callback(position, method)
-      self.class.callbacks[position][method].each do |callback|
-        __send__(callback)
-      end
+    def after_update
+    end
+
+    def before_delete
+    end
 
-      __send__("#{ position }_#{ method }")
+    def after_delete
     end
   end
-end
+end

data/lib/ohm/contrib.rb

@@ -4,7 +4,8 @@ require_relative "locking"
 require_relative "scope"
 require_relative "slug"
 require_relative "softdelete"
-require_relative "timestamping"
+require_relative "timestamps"
+require_relative "versioned"
 
 module Ohm
   module Contrib

data/lib/ohm/datatypes.rb

@@ -7,7 +7,7 @@ module Ohm
   module DataTypes
     module Type
       Integer   = lambda { |x| x.to_i }
-      Decimal   = lambda { |x| x && BigDecimal(x.to_s) }
+      Decimal   = lambda { |x| BigDecimal(x.to_s) }
       Float     = lambda { |x| x.to_f }
       Boolean   = lambda { |x| !!x }
       Time      = lambda { |t| t && (t.kind_of?(::Time) ? t : ::Time.parse(t)) }

data/lib/ohm/scope.rb

@@ -22,9 +22,8 @@ module Ohm
         extend model::DefinedScopes if defined?(model::DefinedScopes)
       end
     end
-
-    Ohm::Model::Set.send :include, OverloadedSet
   end
 
-  Model::Set.send :include, Scope::OverloadedSet
-end
+  Set.send :include, Scope::OverloadedSet
+  MultiSet.send :include, Scope::OverloadedSet
+end

data/lib/ohm/softdelete.rb

@@ -43,17 +43,19 @@ module Ohm
     end
 
     def delete
-      self.class.all.delete(self)
-      self.class.deleted.add(self)
-
-      update(deleted: DELETED_FLAG)
+      db.multi do
+        model.all.key.srem(id)
+        model.deleted.key.sadd(id)
+        set :deleted, DELETED_FLAG
+      end
     end
 
     def restore
-      self.class.all.add(self)
-      self.class.deleted.delete(self)
-
-      update(deleted: nil)
+      db.multi do
+        model.all.key.sadd(id)
+        model.deleted.key.srem(id)
+        set :deleted, nil
+      end
     end
 
     def deleted?
@@ -62,7 +64,7 @@ module Ohm
 
     module ClassMethods
       def deleted
-        Model::Set.new(key[:deleted], Model::Wrapper.wrap(self))
+        Set.new(key[:deleted], key, self)
       end
 
       def exists?(id)
@@ -70,4 +72,4 @@ module Ohm
       end
     end
   end
-end
+end

data/lib/ohm/{timestamping.rb → timestamps.rb}

@@ -1,4 +1,3 @@
-require_relative "callbacks"
 require_relative "datatypes"
 
 module Ohm
@@ -7,35 +6,28 @@ module Ohm
   # @example
   #
   #   class Post < Ohm::Model
-  #     include Ohm::Timestamping
+  #     include Ohm::Timestamps
   #   end
   #
   #   post = Post.create
-  #   post.created_at.to_s == Time.now.utc.to_s
+  #   post.created_at.to_i == Time.now.utc.to_i
   #   # => true
   #
   #   post = Post[post.id]
   #   post.save
-  #   post.updated_at.to_s == Time.now.utc.to_s
+  #   post.updated_at.to_i == Time.now.utc.to_i
   #   # => true
-  module Timestamping
+  module Timestamps
     def self.included(model)
-      model.send :include, Callbacks
-
       model.attribute :created_at, DataTypes::Type::Timestamp
       model.attribute :updated_at, DataTypes::Type::Timestamp
-
-      model.before :create, :set_created_at
-      model.before :save,   :set_updated_at
     end
 
-  protected
-    def set_created_at
-      self.created_at ||= Time.now.utc.to_i
-    end
-
-    def set_updated_at
+    def save!
+      self.created_at = Time.now.utc.to_i if new?
       self.updated_at = Time.now.utc.to_i
+
+      super
     end
   end
-end
+end

data/lib/ohm/versioned.rb

@@ -0,0 +1,31 @@
+module Ohm
+  module Versioned
+    def self.included(model)
+      model.attribute :_version, lambda { |x| x.to_i }
+    end
+
+    def save!
+      super do |t|
+        t.read do |store|
+          current_version = key.hget(:_version).to_i
+
+          if current_version != _version
+            raise Ohm::VersionConflict.new(attributes)
+          end
+
+          self._version = current_version + 1
+        end
+
+        yield t if block_given?
+      end
+    end
+  end
+
+  class VersionConflict < StandardError
+    attr :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+  end
+end

data/ohm-contrib.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ohm-contrib"
-  s.version = "1.0.rc1"
+  s.version = "1.0.0.rc2"
   s.summary = %{A collection of decoupled drop-in modules for Ohm.}
   s.description = %{Includes a couple of core functions such as callbacks, timestamping, typecasting and lots of generic validation routines.}
   s.author = "Cyril David"
@@ -22,9 +22,9 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "ohm-contrib"
 
   s.has_rdoc = false
-  s.add_dependency "ohm"
+  s.add_dependency "ohm", "1.0.0.rc1"
 
   s.add_development_dependency "cutest"
   s.add_development_dependency "redis"
   s.add_development_dependency "override"
-end
+end

data/test/helper.rb

@@ -2,7 +2,13 @@ $:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 
 require "cutest"
 require "redis"
-require "ohm"
+
+if ENV["SCRIPTED"]
+  require "ohm/scripted"
+else
+  require "ohm"
+end
+
 require "ohm/contrib"
 require "override"
 
@@ -12,10 +18,10 @@ NOW = Time.utc(2010, 5, 12)
 
 include Override
 
-prepare {
+prepare do
   Ohm.flush
   override(Time, :now => NOW)
-}
+end
 
 def assert_nothing_raised(*exceptions)
   begin
@@ -24,4 +30,3 @@ def assert_nothing_raised(*exceptions)
     flunk(caller[1])
   end
 end
-

data/test/plugin.rb

@@ -3,7 +3,7 @@
 require_relative "helper"
 
 class Comment < Ohm::Model
-  include Ohm::Timestamping
+  include Ohm::Timestamps
 end
 
 test "timestamps are added during creation" do
@@ -26,17 +26,15 @@ class Article < Ohm::Model
   include Ohm::Callbacks
 
   attribute :title
-
-  list  :comments, Comment
-  after :save, :append_comment
+  set :comments, Comment
 
 private
   def before_save
     self.title = title.gsub("<br>", " ")
   end
 
-  def append_comment
-    comments.add(Comment.create)
+  def after_save
+    comments.key.sadd(Comment.create.id)
   end
 end
 
@@ -135,7 +133,7 @@ class Product < Ohm::Model
   attribute :published, Type::Boolean
 end
 
-test "typecast" do
+test "datatypes" do
   p = Product.new(stock: "1")
 
   assert_equal 1, p.stock
@@ -155,6 +153,7 @@ test "typecast" do
   assert_equal time, p.bought_at
 
   p = Product.new(date_released: Date.today)
+
   assert p.date_released.kind_of?(Date)
 
   p = Product.new(date_released: "2011-11-22")
@@ -163,13 +162,12 @@ test "typecast" do
   p.save
 
   p = Product[p.id]
-  assert_equal Date.today, p.date_released
+  assert_equal Date.new(2011, 11, 22), p.date_released
 
   sizes = { "XS" => 1, "S" => 2, "L" => 3 }
 
   p = Product.new(sizes: sizes)
   assert p.sizes.kind_of?(Hash)
-
   p.save
 
   p = Product[p.id]
@@ -209,4 +207,4 @@ test "typecast" do
 
   p = Product[p.id]
   assert_equal true, p.published
-end
+end

data/test/scope.rb

@@ -3,11 +3,7 @@
 require_relative "helper"
 
 class Post < Ohm::Model
-  set :comments, Comment
-end
-
-class Video < Ohm::Model
-  list :comments, Comment
+  set :comments, :Comment
 end
 
 module Finders
@@ -38,18 +34,18 @@ end
 test "allows custom methods for the defined scopes" do
   post = Post.create
   comment = Comment.create(:status => "approved")
-  post.comments << comment
+  post.comments.key.sadd(comment.id)
 
-  assert post.comments.approved.is_a?(Ohm::Model::Set)
+  assert post.comments.approved.is_a?(Ohm::MultiSet)
   assert post.comments.approved.include?(comment)
 end
 
 test "allows custom methods to be included from a module" do
   post = Post.create
   comment = Comment.create(:status => "rejected")
-  post.comments << comment
+  post.comments.key.sadd(comment.id)
 
-  assert post.comments.rejected.is_a?(Ohm::Model::Set)
+  assert post.comments.rejected.is_a?(Ohm::MultiSet)
   assert post.comments.rejected.include?(comment)
 end
 
@@ -61,15 +57,3 @@ test "works with the main Comment.all collection as well" do
   assert Comment.all.approved.include?(approved)
   assert Comment.all.rejected.include?(rejected)
 end
-
-test "isolated from List" do
-  video = Video.create
-
-  assert_raise NoMethodError do
-    video.comments.approved
-  end
-
-  assert_raise NoMethodError do
-    video.comments.rejected
-  end
-end

data/test/soft_delete.rb

@@ -40,18 +40,16 @@ test "find does not exclude deleted records" do
   person.delete
 
   assert Person.find(:name => "matz").include?(person)
-  assert Person.all.find(:name => "matz").include?(person)
 end
 
-test "find with many criteria excludes deleted records" do
+test "find with many criteria doesn't exclude deleted records" do
   person = Person.create(:name => "matz", :age => 38)
 
   assert Person.find(:name => "matz", :age => 38).first == person
 
   person.delete
 
-  assert Person.find(:name => "matz", :age => 38).empty?
-  assert Person.all.find(:name => "matz", :age => 38).empty?
+  assert Person.find(:name => "matz", :age => 38).include?(person)
 end
 
 test "exists? returns true for deleted records" do
@@ -79,4 +77,4 @@ test "restoring" do
 
   person.restore
   assert Person.all.include?(person)
-end
+end

data/test/{timestamping.rb → timestamp.rb}

@@ -3,7 +3,7 @@
 require File.expand_path("./helper", File.dirname(__FILE__))
 
 class Person < Ohm::Model
-  include Ohm::Timestamping
+  include Ohm::Timestamps
 end
 
 test "a new? record" do
@@ -28,4 +28,4 @@ test "on update" do
 
   assert NOW == person.created_at
   assert Time.utc(2010, 5, 13) == person.updated_at
-end
+end

data/test/versioned.rb

@@ -0,0 +1,24 @@
+require_relative "helper"
+
+class Article < Ohm::Model
+  include Ohm::Versioned
+
+  attribute :title
+  attribute :content
+end
+
+test do
+  a1 = Article.create(title: "Foo Bar", content: "Lorem ipsum")
+  a2 = Article[a1.id]
+
+  a1.update({})
+
+  begin
+    a2.update(title: "Bar Baz")
+  rescue Ohm::VersionConflict => ex
+  end
+
+  expected = { title: "Bar Baz", _version: "1", content: "Lorem ipsum" }
+
+  assert_equal expected, ex.attributes
+end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: ohm-contrib
 version: !ruby/object:Gem::Version
-  version: 1.0.rc1
-  prerelease: 4
+  version: 1.0.0.rc2
+  prerelease: 6
 platform: ruby
 authors:
 - Cyril David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ohm
-  requirement: &2152921180 !ruby/object:Gem::Requirement
+  requirement: &70287509765700 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - =
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
-  version_requirements: *2152921180
+  version_requirements: *70287509765700
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2152920760 !ruby/object:Gem::Requirement
+  requirement: &70287509764720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152920760
+  version_requirements: *70287509764720
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2152920280 !ruby/object:Gem::Requirement
+  requirement: &70287509763280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152920280
+  version_requirements: *70287509763280
 - !ruby/object:Gem::Dependency
   name: override
-  requirement: &2152919740 !ruby/object:Gem::Requirement
+  requirement: &70287509762640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152919740
+  version_requirements: *70287509762640
 description: Includes a couple of core functions such as callbacks, timestamping,
   typecasting and lots of generic validation routines.
 email: cyx.ucron@gmail.com
@@ -69,20 +69,20 @@ files:
 - lib/ohm/contrib.rb
 - lib/ohm/datatypes.rb
 - lib/ohm/locking.rb
-- lib/ohm/plugin.rb
 - lib/ohm/scope.rb
 - lib/ohm/slug.rb
 - lib/ohm/softdelete.rb
-- lib/ohm/timestamping.rb
+- lib/ohm/timestamps.rb
+- lib/ohm/versioned.rb
 - ohm-contrib.gemspec
 - test/helper.rb
 - test/instance_callbacks.rb
-- test/macro_callbacks.rb
 - test/plugin.rb
 - test/scope.rb
 - test/slug.rb
 - test/soft_delete.rb
-- test/timestamping.rb
+- test/timestamp.rb
+- test/versioned.rb
 homepage: http://github.com/cyx/ohm-contrib
 licenses: []
 post_install_message: 

data/lib/ohm/plugin.rb

@@ -1,54 +0,0 @@
-module Ohm
-  module Plugin
-    def plugin(name)
-      mixin = Plugin[name]
-
-      include mixin
-      extend  mixin::ClassMethods if mixin.const_defined?(:ClassMethods, false)
-
-      mixin.setup(self) if mixin.respond_to?(:setup)
-    end
-
-    def self.[](plugin)
-      case plugin
-      when Module
-        plugin
-      when Symbol
-        name, path = Plugin.registry[plugin]
-
-        raise Unknown.new(plugin) if name.nil?
-
-        require path
-        Ohm.const_get(name, false)
-      else
-        raise Unknown.new(plugin)
-      end
-    end
-
-    def self.register(name, name_and_path)
-      registry[name] = name_and_path
-    end
-
-    def self.registry
-      @registry ||= {
-        :callbacks     => [:Callbacks,    "ohm/contrib/callbacks"],
-        :datatypes     => [:DataTypes,    "ohm/contrib/data_types"],
-        :locking       => [:Locking,      "ohm/contrib/locking"],
-        :scope         => [:Scope,        "ohm/contrib/scope"],
-        :slug          => [:Slug,         "ohm/contrib/slug"],
-        :softdelete    => [:SoftDelete,   "ohm/contrib/soft_delete"],
-        :timestamping  => [:Timestamping, "ohm/contrib/timestamping"]
-      }
-    end
-
-    class Unknown < StandardError
-      def initialize(plugin)
-        @plugin = plugin
-      end
-
-      def message
-        "Unknown plugin: #{@plugin}"
-      end
-    end
-  end
-end

data/test/macro_callbacks.rb

@@ -1,54 +0,0 @@
-# encoding: UTF-8
-
-require File.expand_path("./helper", File.dirname(__FILE__))
-
-class Post < Ohm::Model
-  include Ohm::Callbacks
-
-  attribute :body
-
-  before :create,   :do_before_create
-  after  :create,   :do_after_create
-
-  before :save,     :do_before_save
-  after  :save,     :do_after_save
-
-  before :delete,   :do_before_delete
-  after  :delete,   :do_after_delete
-
-  before :update,   :do_before_update
-  after  :update,   :do_after_update
-
-  def validate
-    assert_present :body
-  end
-
-  def did?(action)
-    instance_variable_get("@#{ action }")
-  end
-
-  def count(action)
-    instance_variable_get("@#{ action }")
-  end
-
-protected
-  def do_before_create()   incr(:do_before_create)   end
-  def do_after_create()    incr(:do_after_create)    end
-  def do_before_save()     incr(:do_before_save)     end
-  def do_after_save()      incr(:do_after_save)      end
-  def do_before_update()   incr(:do_before_update)   end
-  def do_after_update()    incr(:do_after_update)    end
-  def do_before_delete()   incr(:do_before_delete)   end
-  def do_after_delete()    incr(:do_after_delete)    end
-
-
-  def incr(action)
-    val = instance_variable_get("@#{ action }")
-    val ||= 0
-    val += 1
-
-    instance_variable_set("@#{ action }", val)
-  end
-end
-
-load File.expand_path('lint/callbacks.rb', File.dirname(__FILE__))