ohm-contrib 2.0.0.alpha5 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b37b722586fa921921b02393434ee62b0df99d9e
-  data.tar.gz: d6cec02d9a3edeb0255440f06a925ca6724d35bd
+  metadata.gz: fe7d66dde39d334e746974535e9c58409ea01946
+  data.tar.gz: 6f1bd0fdb34ea731c84c927c0befdea5e93009ec
 SHA512:
-  metadata.gz: b716eb058df3142838c8095aff4bb445cb39eab699fe95104f86f2873112b34127dd68e0a0040b0a77d87a70bb2c9b5fd3196bfd51c0d32266818f75893fcf3b
-  data.tar.gz: 11e0da50b18ad6bf152ddd443e61ad39a83be55fa2f1a1a9b45837f85e5c360519e80e915571b53d95c30c6ef904bbd8a8b4e61df21c1431eb4559c4e3c12d0c
+  metadata.gz: f710be3a098d1a740b4849d1b2377afffd9709114ab624c4c70d5bfb8536b2cfa7a0418239da997c0c74d20aff80a4f86d660138b1f2b943f908760302e229f5
+  data.tar.gz: 774494ccaf92fa8a29256be6f114e3cd683f560eb258fc1e2393e8e1005afac6197adf7d5f2a0e609f4f1f3360b8d5210ba93453341507c28d61408b9a333447

data/.gems

@@ -0,0 +1,4 @@
+cutest -v 1.2.1
+iconv -v 1.0.4
+ohm -v 2.0.0.rc1
+override -v 0.0.10

data/.gitignore

@@ -0,0 +1,29 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+/.rvmrc
+/.yardoc
+/doc
+/tests
+
+## rbenv
+.rbenv-gemsets
+.rbenv-version

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+* Support for Ohm 1.3.x has been removed. It only supports Ohm 2.x.
+
+1.2
+===
+
+* Support for <= 1.1 versions has been removed.Ohm-contrib v1.2 should be used
+  with Ohm 1.2 and above only, due to the change in the way the `Ohm::Set` and
+  `Ohm::MultiSet` are defined. The way to extend #initialize on both has changed.
+
+1.1.1
+=====
+
+* Add Symbol and Set datatypes.
+
+  Example:
+
+    class Foo < Ohm::Model
+      include Ohm::DataTypes
+
+      attribute :state, Type::Symbol
+      attribute :bar_ids, Type::Set
+    end
+
+1.0.0
+=====
+
+* `Ohm::Typecast` has been removed in favor of `Ohm::DataTypes`.
+
+* `Ohm::Timestamping` has been renamed to `Ohm::Timestamps`.
+
+* `Ohm::Timestamps` now store times as a UNIX Timestamp.
+
+* `All Ohm validation related plugins have been removed.
+  See [scrivener][scrivener] instead.
+
+* `Ohm::Boundaries` has been removed.
+
+* `Ohm::Contrib` no longer uses `autoload`. You can either `require 'ohm/contrib'`,
+  which requires everything, or you can `require 'ohm/datatypes'` for example
+  if you want to cherry pick your requires.
+
+* `Ohm::Callbacks` no longer provides macro style callbacks, i.e.
+  `after :create, :do_something`. Use instance callbacks instead.
+
+[scrivener]: http://github.com/soveran/scrivener

data/README.markdown

@@ -133,7 +133,7 @@ product.meta.kind_of?(Hash)
 product.meta == { resolution: '1280x768', battery: '8 hours' }
 # => true
 
-product.meta.kind_of?(Array)
+product.sizes.kind_of?(Array)
 # => true
 
 product.sizes == ['XS S M L XL']
@@ -159,7 +159,8 @@ post.to_param == "1-using-ohm-contrib-1.0"
 ```
 
 By default, `Ohm::Slug` tries to load iconv in order to transliterate
-non-ascii characters.
+non-ascii characters. For ruby 2 or later, you will need to `gem install iconv`
+to get transliteration.
 
 ```ruby
 post = Post.create(:title => "Décor")
@@ -193,24 +194,3 @@ rescue Ohm::VersionConflict => ex
   # => true
 end
 ```
-
-<a name="upgrade" id="upgrade"></a>
-
-## Important Upgrade notes from 0.1.x
-
-The following lists the major changes:
-
-1. `Ohm::Typecast` has been removed in favor of `Ohm::DataTypes`.
-2. `Ohm::Timestamping` has been renamed to `Ohm::Timestamps`.
-3. `Ohm::Timestamps` now store times as a UNIX Timestamp.
-4. `All Ohm validation related plugins have been removed.
-    See [scrivener][scrivener] instead.
-5. `Ohm::Boundaries` has been removed.
-6. Ohm::Contrib no longer uses `autoload`. You can either
-   `require 'ohm/contrib'`, which requires everything, or you
-   can `require ohm/datatypes` for example if you want to cherry
-   pick your requires.
-7. `Ohm::Callbacks` no longer provides macro style callbacks, i.e.
-   `after :create, :do_something`. Use instance callbacks instead.
-
-[scrivener]: http://github.com/soveran/scrivener

data/lib/ohm/contrib.rb

@@ -1,11 +1,11 @@
-require File.expand_path("../callbacks", __FILE__)
-require File.expand_path("../datatypes", __FILE__)
-require File.expand_path("../locking", __FILE__)
-require File.expand_path("../scope", __FILE__)
-require File.expand_path("../slug", __FILE__)
-require File.expand_path("../softdelete", __FILE__)
-require File.expand_path("../timestamps", __FILE__)
-require File.expand_path("../versioned", __FILE__)
+require_relative "callbacks"
+require_relative "datatypes"
+require_relative "locking"
+require_relative "scope"
+require_relative "slug"
+require_relative "softdelete"
+require_relative "timestamps"
+require_relative "versioned"
 
 module Ohm
   module Contrib

data/lib/ohm/datatypes.rb

@@ -7,26 +7,17 @@ require "set"
 module Ohm
   module DataTypes
     module Type
-      Integer   = lambda { |x| x.to_i }
-      Decimal   = lambda { |x| BigDecimal(x.to_s) }
-      Float     = lambda { |x| x.to_f }
-      Symbol    = lambda { |x| x && x.to_sym }
-      Boolean   = lambda { |x| Ohm::DataTypes.bool(x) }
-      Time      = lambda { |t| t && (t.kind_of?(::Time) ? t : ::Time.parse(t)) }
-      Date      = lambda { |d| d && (d.kind_of?(::Date) ? d : ::Date.parse(d)) }
-      Timestamp = lambda { |t| t && UnixTime.at(t.to_i) }
-      Hash      = lambda { |h| h && SerializedHash[h.kind_of?(::Hash) ? h : JSON(h)] }
-      Array     = lambda { |a| a && SerializedArray.new(a.kind_of?(::Array) ? a : JSON(a)) }
-      Set       = lambda { |s| s && SerializedSet.new(s.kind_of?(::Set) ? s : JSON(s)) }
-    end
-
-    def self.bool(val)
-      case val
-      when "false", "0" then false
-      when "true", "1"  then true
-      else
-        !! val
-      end
+      Integer   = ->(x) { x.to_i }
+      Decimal   = ->(x) { BigDecimal(x.to_s) }
+      Float     = ->(x) { x.to_f }
+      Symbol    = ->(x) { x && x.to_sym }
+      Boolean   = ->(x) { !!x }
+      Time      = ->(t) { t && (t.kind_of?(::Time) ? t : ::Time.parse(t)) }
+      Date      = ->(d) { d && (d.kind_of?(::Date) ? d : ::Date.parse(d)) }
+      Timestamp = ->(t) { t && UnixTime.at(t.to_i) }
+      Hash      = ->(h) { h && SerializedHash[h.kind_of?(::Hash) ? h : JSON(h)] }
+      Array     = ->(a) { a && SerializedArray.new(a.kind_of?(::Array) ? a : JSON(a)) }
+      Set       = ->(s) { s && SerializedSet.new(s.kind_of?(::Set) ? s : JSON(s)) }
     end
 
     class UnixTime < Time

data/lib/ohm/locking.rb

@@ -8,9 +8,7 @@ module Ohm
     # Lock the object before executing the block, and release it once the block
     # is done.
     #
-    # @example
-    #
-    #   post = Order.create(:customer => Customer.create)
+    #   post = Order.create(customer: Customer.create)
     #   post.mutex(0.01) do
     #     # this block is in a mutex!
     #   end
@@ -29,11 +27,11 @@ module Ohm
     #
     # @see Model#mutex
     def lock!(wait = 0.1)
-      until key[:_lock].setnx(lock_timeout)
-        next unless lock = key[:_lock].get
+      until redis.call("SETNX", key[:_lock], lock_timeout)
+        next unless lock = redis.call("HGET", key[:_lock])
         sleep(wait) and next unless lock_expired?(lock)
 
-        break unless lock = key[:_lock].getset(lock_timeout)
+        break unless lock = redis.call("GETSET", key[:_lock], lock_timeout)
         break if lock_expired?(lock)
       end
     end
@@ -41,15 +39,15 @@ module Ohm
     # Release the lock.
     # @see Model#mutex
     def unlock!
-      key[:_lock].del
+      redis.call("DEL", key[:_lock])
     end
 
     def lock_timeout
       Time.now.to_f + 1
     end
 
-    def lock_expired? lock
+    def lock_expired?(lock)
       lock.to_f < Time.now.to_f
     end
   end
-end
+end

data/lib/ohm/slug.rb

@@ -11,12 +11,13 @@ module Ohm
     end
 
     def slug(str = to_s)
-      ret = transcode(str)
+      ret = transcode(str.dup)
       ret.gsub!("'", "")
       ret.gsub!(/[^0-9A-Za-z]/u, " ")
       ret.strip!
       ret.gsub!(/\s+/, "-")
-      ret.downcase
+      ret.downcase!
+      return ret
     end
     module_function :slug
 

data/lib/ohm/softdelete.rb

@@ -1,16 +1,14 @@
 module Ohm
-  # Provides support for soft deletion
-  #
-  # @example
+  # Provides support for soft deletion.
   #
   #   class Post < Ohm::Model
-  #     plugin :softdelete
+  #     include Ohm::SoftDelete
   #
   #     attribute :title
   #     index :title
   #   end
   #
-  #   post = Post.create(:title => 'Title')
+  #   post = Post.create(title: 'Title')
   #
   #   post.deleted?
   #   # => false
@@ -23,7 +21,7 @@ module Ohm
   #   Post.all.empty?
   #   # => true
   #
-  #   Post.find(:title => 'Title').include?(post)
+  #   Post.find(title: 'Title').include?(post)
   #   # => true
   #
   #   Post.exists?(post.id)
@@ -33,11 +31,10 @@ module Ohm
   #
   #   post.deleted?
   #   # => true
+  #
   module SoftDelete
-    DELETED_FLAG = "1"
-
     def self.included(model)
-      model.attribute :deleted
+      model.attribute :deleted, ->(x) { !!x }
 
       model.extend ClassMethods
     end
@@ -46,13 +43,13 @@ module Ohm
       redis.queue("MULTI")
       redis.queue("SREM", model.all.key, id)
       redis.queue("SADD", model.deleted.key, id)
-      redis.queue("HSET", key, :deleted, DELETED_FLAG)
+      redis.queue("HSET", key, :deleted, true)
       redis.queue("EXEC")
       redis.commit
 
-      self.deleted = DELETED_FLAG
+      self.deleted = true
 
-      return self
+      self
     end
 
     def restore
@@ -65,11 +62,11 @@ module Ohm
 
       self.deleted = nil
 
-      return self
+      self
     end
 
     def deleted?
-      deleted == DELETED_FLAG
+      deleted
     end
 
     module ClassMethods
@@ -78,7 +75,7 @@ module Ohm
       end
 
       def exists?(id)
-        super || redis.call("SISMEMBER", key[:deleted], id) == 1
+        super || deleted.exists?(id)
       end
     end
   end

data/lib/ohm/timestamps.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../datatypes", __FILE__)
+require_relative "datatypes"
 
 module Ohm
   # Provides created_at / updated_at timestamps.

data/lib/ohm/versioned.rb

@@ -1,7 +1,7 @@
 module Ohm
   module Versioned
     def self.included(model)
-      model.attribute :_version, lambda { |x| x.to_i }
+      model.attribute :_version, ->(x) { x.to_i }
     end
 
     def save

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest test/*.rb

data/ohm-contrib.gemspec

@@ -1,28 +1,18 @@
 Gem::Specification.new do |s|
   s.name = "ohm-contrib"
-  s.version = "2.0.0.alpha5"
+  s.version = "2.0.0.rc1"
   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"
   s.email = "cyx@cyx.is"
   s.homepage = "http://github.com/cyx/ohm-contrib"
+  s.license = "MIT"
 
-  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.files = `git ls-files`.split("\n")
 
-  s.files = Dir[
-    "LICENSE",
-    "README.markdown",
-    "rakefile",
-    "lib/**/*.rb",
-    "*.gemspec",
-    "test/*.*",
-  ]
-
-  s.require_paths = ["lib"]
-  s.rubyforge_project = "ohm-contrib"
-
-  s.add_dependency "ohm", "2.0.0.alpha5"
+  s.add_dependency "ohm", "~> 2.0.0.rc1"
 
   s.add_development_dependency "cutest"
+  s.add_development_dependency "iconv"
   s.add_development_dependency "override"
 end

data/test/callbacks.rb

@@ -0,0 +1,119 @@
+require_relative "helper"
+require_relative "../lib/ohm/callbacks"
+
+class Post < Ohm::Model
+  include Ohm::Callbacks
+
+  attribute :body
+
+  def did?(action)
+    !!instance_variable_get("@#{ action }")
+  end
+
+  def count(action)
+    instance_variable_get("@#{ action }")
+  end
+
+protected
+
+  def before_create()   incr(:do_before_create)   end
+  def after_create()    incr(:do_after_create)    end
+  def before_save()     incr(:do_before_save)     end
+  def after_save()      incr(:do_after_save)      end
+  def before_update()   incr(:do_before_update)   end
+  def after_update()    incr(:do_after_update)    end
+  def before_delete()   incr(:do_before_delete)   end
+  def 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
+
+test "create invokes all callbacks (except update)" do
+  post = Post.create(body: "The Body")
+
+  assert post.did?(:do_before_create)
+  assert post.did?(:do_after_create)
+  assert post.did?(:do_before_save)
+  assert post.did?(:do_after_save)
+  assert !post.did?(:do_before_update)
+  assert !post.did?(:do_after_update)
+end
+
+test "create only invokes save / create once" do
+  post = Post.create(body: "The Body")
+
+  assert_equal 1, post.count(:do_before_create)
+  assert_equal 1, post.count(:do_after_create)
+  assert_equal 1, post.count(:do_before_save)
+  assert_equal 1, post.count(:do_after_save)
+end
+
+test "ensure create / save callbacks are only called once" do
+  post = Post.new(body: "The Body")
+  post.save
+
+  assert_equal 1, post.count(:do_before_create)
+  assert_equal 1, post.count(:do_after_create)
+  assert_equal 1, post.count(:do_before_save)
+  assert_equal 1, post.count(:do_after_save)
+end
+
+test "save of existing record executes save and update callbacks" do
+  post = Post.create(body: "The Body")
+  post = Post[post.id]
+  post.save
+
+  assert ! post.did?(:do_before_create)
+  assert ! post.did?(:do_after_create)
+
+  assert post.did?(:do_before_save)
+  assert post.did?(:do_after_save)
+  assert post.did?(:do_before_update)
+  assert post.did?(:do_after_update)
+
+  assert_equal 1, post.count(:do_before_save)
+  assert_equal 1, post.count(:do_after_save)
+  assert_equal 1, post.count(:do_before_update)
+  assert_equal 1, post.count(:do_after_update)
+end
+
+test "save of existing record (using #update)" do
+  post = Post.create(body: "The Body")
+  post = Post[post.id]
+  post.update(body: "New Body")
+
+  assert ! post.did?(:do_before_create)
+  assert ! post.did?(:do_after_create)
+
+  assert post.did?(:do_before_save)
+  assert post.did?(:do_after_save)
+  assert post.did?(:do_before_update)
+  assert post.did?(:do_after_update)
+
+  assert_equal 1, post.count(:do_before_save)
+  assert_equal 1, post.count(:do_after_save)
+  assert_equal 1, post.count(:do_before_update)
+  assert_equal 1, post.count(:do_after_update)
+end
+
+test "on delete" do
+  post = Post.create(body: "The Body")
+  post = Post[post.id]
+  post.delete
+
+  assert_equal 1, post.count(:do_before_delete)
+  assert_equal 1, post.count(:do_after_delete)
+
+  assert ! post.did?(:do_before_create)
+  assert ! post.did?(:do_after_create)
+  assert ! post.did?(:do_before_save)
+  assert ! post.did?(:do_after_save)
+  assert ! post.did?(:do_before_update)
+  assert ! post.did?(:do_after_update)
+end