ohm-contrib 0.0.14 → 0.0.15

data/README.markdown

@@ -1,16 +1,20 @@
 ohm-contrib
 ===========
 
-A collection of drop-in modules for Ohm.
+A collection of drop-in modules for Ohm. Read the full documentation at
+[http://labs.sinefunc.com/ohm-contrib](http://labs.sinefunc.com/ohm-contrib).
 
 List of modules
 ---------------
-* `Ohm::Boundaries`
-* `Ohm::Timestamping`
-* `Ohm::ToHash`
-* `Ohm::WebValidations`
-* `Ohm::NumberValidations`
-* `Ohm::Typecast`
+1. [`Ohm::Boundaries`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/Boundaries.html)
+2. [`Ohm::Callbacks`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/Callbacks.html)
+3. [`Ohm::Timestamping`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/Timestamping.html)
+4. [`Ohm::ToHash`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/ToHash.html)
+5. [`Ohm::WebValidations`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/WebValidations.html)
+6. [`Ohm::NumberValidations`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/NumberValidations.html)
+7. [`Ohm::ExtraValidations`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/ExtraValidations.html)
+8. [`Ohm::Typecast`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/Typecast.html)
+9. [`Ohm::Locking`](http://labs.sinefunc.com/ohm-contrib/doc/Ohm/Locking.html)
 
 Example usage
 -------------
@@ -102,4 +106,4 @@ Note on Patches/Pull Requests
 
 Copyright
 ---------
-Copyright (c) 2010 Cyril David. See LICENSE for details.
+Copyright (c) 2010 Cyril David. See LICENSE for details.

data/Rakefile

@@ -8,7 +8,7 @@ begin
     gem.summary = %Q{A collection of ohm related modules}
     gem.description = %Q{Highly decoupled drop-in functionality for Ohm models}
     gem.email = "cyx.ucron@gmail.com"
-    gem.homepage = "http://github.com/sinefunc/ohm-contrib"
+    gem.homepage = "http://labs.sinefunc.com/ohm-contrib"
     gem.authors = ["Cyril David"]
     gem.add_development_dependency "contest", ">= 0"
     gem.add_development_dependency "redis", ">= 0"
@@ -53,4 +53,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "ohm-contrib #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/lib/ohm/contrib.rb

@@ -1,6 +1,6 @@
 module Ohm
   module Contrib
-    VERSION = '0.0.14'
+    VERSION = '0.0.15'
   end
 
   autoload :Boundaries,        "ohm/contrib/boundaries"

data/lib/ohm/contrib/boundaries.rb

@@ -1,4 +1,19 @@
 module Ohm
+  # Dirt cheap ::first and ::last support.
+  #
+  # @example
+  #
+  #   class Post < Ohm::Model
+  #     include Ohm::Boundaries
+  #   end
+  #
+  #   post1 = Post.create
+  #   post2 = Post.create
+  #   post1 == Post.first
+  #   # => true
+  #
+  #   post2 == Post.last
+  #   # => true
   module Boundaries
     def self.included(base)
       base.extend ClassMethods
@@ -8,10 +23,11 @@ module Ohm
       def first
         all.first
       end
-
+  
+      # @todo Add support for passing in conditions
       def last
         self[db.get(key(:id))]
       end
     end
   end
-end
+end

data/lib/ohm/contrib/callbacks.rb

@@ -1,5 +1,5 @@
 module Ohm
-  # Minimalist callback support for Ohm::Model.
+  # Minimalistic callback support for Ohm::Model.
   #
   # @example
   #

data/lib/ohm/contrib/extra_validations.rb

@@ -1,4 +1,34 @@
 module Ohm
+  # Includes Ohm::NumberValidations and Ohm::WebValidations.
+  #
+  # @example
+  #
+  #   class Post < Ohm::Model
+  #     include Ohm::ExtraValidations
+  #     
+  #     attribute :price
+  #     attribute :state
+  #     attribute :slug
+  #     attribute :author_email
+  #     attribute :url
+  #     attribute :ipaddr
+  #
+  #     def validate
+  #       super
+  #
+  #       assert_decimal :price
+  #       assert_member  :state, ['published', 'unpublished']
+  #       assert_ipaddr  :ipaddr
+  #       assert_url     :url
+  #       assert_email   :author_email
+  #     end
+  #   end
+  #
+  #   post = Post.new
+  #   post.valid?
+  #   post.errors
+  #   # [[:price, :not_decimal], [:state, :not_member], [:ipaddr, :not_ipaddr],
+  #   #  [:url, :not_url], [:author_email, :not_email]]
   module ExtraValidations
     include NumberValidations
     include WebValidations

data/lib/ohm/contrib/locking.rb

@@ -1,12 +1,14 @@
 module Ohm
   # This module is a straight extraction from Ohm. The only difference is
   # that this allows for a custom sleep value.
+  #
   # In addition, since future ohm versions might drop mutexes, I thought it
   # might be a good idea to preseve this feature as a drop-in module.
   module Locking
-    # Public: Lock the object before executing the block, and release it once the block is done.
+    # Lock the object before executing the block, and release it once the block 
+    # is done.
     # 
-    # Examples:
+    # @example
     #
     #   post = Order.create(:customer => Customer.create)
     #   post.mutex(0.01) do

data/lib/ohm/contrib/number_validations.rb

@@ -1,4 +1,7 @@
 module Ohm
+  # This module will include all numeric validation needs.
+  # As of VERSION 0.0.15, Ohm::NumberValidations#assert_decimal
+  # is the only method provided.
   module NumberValidations
 
   protected
@@ -6,4 +9,4 @@ module Ohm
       assert_format(att, /^(\d+)?(\.\d+)?$/, error)
     end
   end
-end
+end

data/lib/ohm/contrib/timestamping.rb

@@ -1,4 +1,20 @@
 module Ohm
+  # Provides created_at / updated_at timestamps.
+  #
+  # @example
+  #
+  #   class Post < Ohm::Model
+  #     include Ohm::Timestamping
+  #   end
+  #
+  #   post = Post.create
+  #   post.created_at.to_s == Time.now.utc.to_s
+  #   # => true
+  #
+  #   post = Post[post.id]
+  #   post.save
+  #   post.updated_at.to_s == Time.now.utc.to_s
+  #   # => true
   module Timestamping
     def self.included(base)
       base.attribute :created_at
@@ -18,4 +34,4 @@ module Ohm
       super
     end
   end
-end
+end

data/lib/ohm/contrib/to_hash.rb

@@ -1,4 +1,30 @@
 module Ohm
+  # Ohm has already added its own `to_hash` method. The difference
+  # is that it chose the albeit better whitelisted approach.
+  #
+  # @example
+  #   
+  #   # this is the core Ohm#to_hash implementation
+  #   class Post < Ohm::Model
+  #     attribute :body
+  #     def validate
+  #       assert_present :body
+  #     end
+  #   end
+  #
+  #   Post.create.to_hash == { :errors => [[:body, :not_present]] }
+  #   # => true
+  #
+  #   Post.create(:body => "The body").to_hash == { :id => 1 }
+  #   # => true
+  #
+  #   # now this is the all-in-one (kinda Railsy) method.
+  #   class Post < Ohm::Model
+  #     attribute :body
+  #   end
+  #
+  #   Post.create(:body => "Body").to_hash == { :id => 1, :body => "Body" }
+  #   # => true
   module ToHash
     def to_hash
       atts = attributes + counters
@@ -8,4 +34,4 @@ module Ohm
     end
     alias :to_h :to_hash
   end
-end
+end

data/lib/ohm/contrib/typecast.rb

@@ -3,6 +3,14 @@ require 'time'
 require 'date'
 
 module Ohm
+  # Provides all the primitive types. The following are included:
+  #
+  # * String
+  # * Decimal
+  # * Integer
+  # * Float
+  # * Date
+  # * Time
   module Types
     class Primitive < BasicObject
       def initialize(value)
@@ -73,7 +81,58 @@ module Ohm
       end
     end
   end
-
+  
+  # Provides unobtrusive, non-explosive typecasting.Instead of exploding on set 
+  # of an invalid value, this module takes the approach of just taking in 
+  # parameters and letting you do validation yourself. The only thing this 
+  # module does for you is the boilerplate casting you might need to do.
+  #
+  # @example
+  #   
+  #   # without typecasting
+  #   class Item < Ohm::Model
+  #     attribute :price
+  #     attribute :posted
+  #   end
+  #
+  #   item = Item.create(:price => 299, :posted => Time.now.utc)
+  #   item = Item[item.id]
+  #
+  #   # now when you try and grab `item.price`, its a string.
+  #   "299" == item.price
+  #   # => true
+  #
+  #   # you can opt to manually cast everytime, or do it in the model, i.e.
+  #   
+  #   class Item
+  #     def price
+  #       BigDecimal(read_local(:price))
+  #     end
+  #   end
+  #
+  # The Typecasted way
+  # ------------------
+  #
+  #   class Item < Ohm::Model
+  #     include Ohm::Typecast
+  #
+  #     attribute :price, Decimal
+  #     attribute :posted, Time
+  #   end
+  #
+  #   item = Item.create(:price => "299", :posted => Time.now.utc)
+  #   item = Item[item.id]
+  #   item.price.class == Ohm::Types::Decimal
+  #   # => true
+  #
+  #   item.price.to_s == "299"
+  #   # => true
+  #
+  #   item.price * 2 == 598
+  #   # => true
+  #
+  #   item.posted.strftime('%m/%d/%Y')
+  #   # => works!!!
   module Typecast
     include Types
 
@@ -96,4 +155,4 @@ module Ohm
       end
     end
   end
-end
+end

data/lib/ohm/contrib/web_validations.rb

@@ -32,4 +32,4 @@ module Ohm
         assert_ipv4(att, error)
     end
   end
-end
+end

data/ohm-contrib.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ohm-contrib}
-  s.version = "0.0.14"
+  s.version = "0.0.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
      "test/test_ohm_typecast.rb",
      "test/test_ohm_web_validations.rb"
   ]
-  s.homepage = %q{http://github.com/sinefunc/ohm-contrib}
+  s.homepage = %q{http://labs.sinefunc.com/ohm-contrib}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 15
+  version: 0.0.15
 platform: ruby
 authors: 
 - Cyril David
@@ -115,7 +115,7 @@ files:
 - test/test_ohm_typecast.rb
 - test/test_ohm_web_validations.rb
 has_rdoc: true
-homepage: http://github.com/sinefunc/ohm-contrib
+homepage: http://labs.sinefunc.com/ohm-contrib
 licenses: []
 
 post_install_message: