ohm-contrib 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cyril David
+
+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,44 @@
+ohm-contrib
+===========
+
+A collection of drop-in modules for Ohm.
+
+List of modules
+---------------
+* `Ohm::Boundaries`
+* `Ohm::Timestamping`
+* `Ohm::ToHash`
+
+Example usage
+-------------
+
+    require 'ohm'
+    require 'ohm/contrib'
+    
+    class Post < Ohm::Model
+      include Ohm::Timestamping
+      include Ohm::ToHash
+      include Ohm::Boundaries
+    end
+
+    Post.first
+    Post.last
+    Post.new.to_hash
+    Post.create.to_hash
+    Post.create.created_at
+    Post.create.updated_at
+
+Note on Patches/Pull Requests
+-----------------------------
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a 
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+Copyright (c) 2010 Cyril David. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ohm-contrib"
+    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.authors = ["Cyril David"]
+    gem.add_development_dependency "contest", ">= 0"
+    gem.add_development_dependency "redis", ">= 0"
+    gem.add_development_dependency "ohm", ">= 0"
+    gem.add_development_dependency "timecop", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ohm-contrib #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/ohm/contrib/boundaries.rb

@@ -0,0 +1,17 @@
+module Ohm
+  module Boundaries
+    def self.included(base)
+      base.extend ClassMethods 
+    end
+
+    module ClassMethods
+      def first
+        all.first
+      end
+
+      def last
+        self[db.get(key(:id))]
+      end
+    end
+  end
+end

data/lib/ohm/contrib/number_validations.rb

@@ -0,0 +1,9 @@
+module Ohm
+  module NumberValidations
+
+  protected
+    def assert_decimal(att, error = [att, :not_decimal])
+      assert_format(att, /^(\d+)?(\.\d+)?$/, error)
+    end
+  end
+end

data/lib/ohm/contrib/timestamping.rb

@@ -0,0 +1,21 @@
+module Ohm
+  module Timestamping
+    def self.included(base)
+      base.attribute :created_at
+      base.attribute :updated_at
+    end
+    
+    def create
+      self.created_at ||= Time.now.utc
+
+      super
+    end
+
+  protected
+    def write
+      self.updated_at ||= Time.now.utc
+
+      super
+    end
+  end
+end

data/lib/ohm/contrib/to_hash.rb

@@ -0,0 +1,11 @@
+module Ohm
+  module ToHash
+    def to_hash
+      atts = attributes + counters
+      hash = atts.inject({}) { |h, att| h[att] = send(att); h }
+      hash[:id] = @id
+      hash
+    end
+    alias :to_h :to_hash
+  end
+end

data/lib/ohm/contrib/web_validations.rb

@@ -0,0 +1,35 @@
+module Ohm
+  # All credit goes to gnrfan of github
+  # Basically an extraction from http://github.com/gnrfan/ohm_extra_validations
+  module WebValidations
+
+  protected
+    def assert_slug(att, error = [att, :not_slug])
+      if assert_present(att, error) and assert_unique(att)
+          assert_format(att, /^[-\w]+$/, error)
+      end
+    end
+
+    def assert_email(att, error = [att, :not_email])
+      if assert_present(att, error)
+        assert_format(att, /^([^@\s*]+)@((?:[-a-z0-9]+\.)+[a-z]{2,6})$/i, error)
+      end
+    end
+
+    def assert_url(att, error = [att, :not_url])
+      if assert_present(att, error)
+        assert_format(att, /^(http|https):\/\/([a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}|(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|localhost)(:[0-9]{1,5})?(\/.*)?$/ix, error)
+      end
+    end
+
+    def assert_ipv4(att, error = [att, :not_ipv4])
+      if assert_present(att, error)
+        assert_format(att, /^(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}$/, error)
+      end
+    end
+
+    def assert_ipaddr(att, error = [att, :not_ipaddr])
+        assert_ipv4(att, error)
+    end
+  end
+end

data/lib/ohm/contrib.rb

@@ -0,0 +1,9 @@
+module Ohm
+  VERSION = '0.0.1'
+
+  autoload :Boundaries,        "ohm/contrib/boundaries"
+  autoload :Timestamping,      "ohm/contrib/timestamping"
+  autoload :ToHash,            "ohm/contrib/to_hash"
+  autoload :WebValidations,    "ohm/contrib/web_validations"
+  autoload :NumberValidations, "ohm/contrib/number_validations"
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'contest'
+require 'redis'
+require 'ohm'
+require 'timecop'
+
+Ohm.connect :host => "localhost", :port => "6380"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ohm/contrib'
+
+class Test::Unit::TestCase
+end

data/test/test_ohm_boundaries.rb

@@ -0,0 +1,52 @@
+require "helper"
+
+class TestOhmBoundaries < Test::Unit::TestCase
+  setup do
+    Ohm.flush
+  end
+  
+  class Person < Ohm::Model
+    include Ohm::Boundaries
+
+    attribute :name
+  end
+  
+  context "when there are no People" do
+    should "have a nil Person.first" do
+      assert_nil Person.first
+    end
+
+    should "have a nil Person.last" do
+      assert_nil Person.last 
+    end
+  end
+
+  context "after creating a single Person named matz" do
+    setup do
+      @matz = Person.create(:name => "matz")
+    end
+
+    should "have matz as the first person" do
+      assert_equal @matz, Person.first
+    end
+
+    should "have matz as the last person" do
+      assert_equal @matz, Person.last 
+    end
+  end
+
+  context "after creating matz first then linus next" do
+    setup do
+      @matz  = Person.create(:name => "matz")
+      @linus = Person.create(:name => "linus")
+    end
+    
+    should "have matz as the first Person" do
+      assert_equal @matz, Person.first
+    end    
+
+    should "have linus as the last Person" do
+      assert_equal @linus, Person.last
+    end    
+  end
+end

data/test/test_ohm_contrib.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class TestOhmContrib < Test::Unit::TestCase
+  test "autoloading of Boundaries" do
+    assert_nothing_raised NameError, LoadError do
+      Ohm::Boundaries
+    end
+  end
+
+  test "autoloading of timestamping" do
+    assert_nothing_raised NameError, LoadError do
+      Ohm::Timestamping
+    end
+  end
+
+  test "autoloading of ToHash" do
+    assert_nothing_raised NameError, LoadError do
+      Ohm::ToHash
+    end
+  end
+
+  test "autoloading of WebValidations" do
+    assert_nothing_raised NameError, LoadError do
+      Ohm::WebValidations
+    end
+  end
+
+  test "autoloading of NumberValidations" do
+    assert_nothing_raised NameError, LoadError do
+      Ohm::NumberValidations
+    end
+  end
+
+end

data/test/test_ohm_number_validations.rb

@@ -0,0 +1,59 @@
+require "helper"
+
+class TestOhmNumberValidations < Test::Unit::TestCase
+  class Product < Ohm::Model
+    include Ohm::NumberValidations
+
+    attribute :price
+    attribute :optional_price
+
+    def validate
+      assert_decimal :price
+      assert_decimal :optional_price unless optional_price.to_s.empty?
+    end
+  end
+  
+  context "given no price" do
+    should "still validate as :not_decimal" do
+      product = Product.new(:price => nil)
+      product.valid?
+
+      assert_equal [[:price, :not_decimal]], product.errors
+    end
+  end
+
+  context "given a 0.10 value" do
+    should "validate as a decimal" do
+      product = Product.new(:price => 0.10)
+
+      assert product.valid?
+    end
+  end
+  
+  context "given 1 as a value" do
+    should "validate as a decimal" do
+      product = Product.new(:price => 1)
+
+      assert product.valid?
+    end
+  end
+
+  context "given 1 dot as a value" do
+    should "not validate as a decimal" do
+      product = Product.new(:price => "1.")
+
+      assert ! product.valid?
+      assert_equal [[:price, :not_decimal]], product.errors
+    end
+  end
+
+  context "given no value for optional price" do
+    should "have no validation errors" do
+      product = Product.new(:price => 10.1, :optional_price => nil)
+      assert product.valid?
+
+      product = Product.new(:price => 10.1, :optional_price => '')
+      assert product.valid?
+    end
+  end
+end

data/test/test_ohm_timestamping.rb

@@ -0,0 +1,60 @@
+require "helper"
+
+class TestOhmTimestamping < Test::Unit::TestCase
+  setup do
+    Ohm.flush
+  end
+
+  class Person < Ohm::Model
+    include Ohm::Timestamping
+  end
+
+  context "a new? record" do
+    should "have no created_at" do
+      assert_nil Person.new.created_at 
+    end
+
+    should "have no updated_at" do
+      assert_nil Person.new.updated_at 
+    end
+  end
+
+  context "on create" do
+    setup do
+      @now    = Time.utc(2010, 5, 12)
+      Timecop.freeze(@now)
+      @person = Person.create
+      @person = Person[@person.id]
+    end
+    
+    
+    should "set the created_at equal to the current time" do
+      assert_equal @now.to_s, @person.created_at
+    end
+
+    should "also set the updated_at equal to the current time" do
+      assert_equal @now.to_s, @person.updated_at
+    end
+  end
+
+  context "on update" do
+    setup do
+      @person = Person.create
+      @old_created_at = @person.created_at.to_s
+
+      @now = Time.utc(2010, 10, 31)
+      Timecop.freeze(@now)
+
+      @person.save
+      @person = Person[@person.id]
+    end
+    
+    should "leave created_at unchanged" do
+      assert_equal @old_created_at, @person.created_at
+    end
+    
+    should "set updated_at to the current Time" do
+      assert_equal @now.to_s, @person.updated_at
+    end
+  end
+end

data/test/test_ohm_to_hash.rb

@@ -0,0 +1,67 @@
+require "helper"
+
+class TestOhmToHash < Test::Unit::TestCase
+  setup do
+    Ohm.flush
+  end
+
+  context "a Person with name: matz, age: nil, skills: 10" do
+    class Person < Ohm::Model
+      include Ohm::ToHash
+
+      attribute :name
+      attribute :age
+      attribute :skills
+    end
+
+    setup do
+      @person = Person.create(:name => 'matz', :skills => 10)
+      @person = Person[@person.id]
+    end
+    
+    should "have a to_hash of { id: 1, name: 'matz', age: nil, skills: 10 }" do
+      assert_equal(
+        { :id => '1', :name => "matz", :age => nil, :skills => '10' },
+        @person.to_hash
+      )
+    end
+  end
+  
+  context "when a Post has a votes counter" do
+    class Post < Ohm::Model
+      include Ohm::ToHash
+
+      counter :votes
+    end
+
+    setup do
+      @post = Post.create
+      @post.incr :votes
+      @post.incr :votes
+      @post.incr :votes
+    end
+
+    should "include the votes in the hash" do
+      assert_equal({ :id => '1', :votes => 3 }, @post.to_hash)
+    end
+  end
+
+  context "when a comment has a reference to a person" do
+    Person = Class.new(Ohm::Model)
+    
+    class Comment < Ohm::Model
+      include Ohm::ToHash
+
+      reference :person, Person
+    end
+
+    setup do
+      @person = Person.create
+      @comment = Comment.create(:person => @person)
+    end
+
+    should "have the person_id in the hash" do
+      assert_equal({ :id => '1', :person_id => '1' }, @comment.to_hash)
+    end
+  end
+end

data/test/test_ohm_web_validations.rb

@@ -0,0 +1,113 @@
+require "helper"
+
+class TestOhmWebValidations < Test::Unit::TestCase
+  class BlogPost < Ohm::Model
+    include Ohm::WebValidations
+
+    attribute :slug
+
+    index :slug
+
+    def validate
+    assert_slug :slug
+    end
+  end
+
+  class Comment < Ohm::Model
+    include Ohm::WebValidations
+
+    attribute :ip_address
+    attribute :homepage
+    attribute :email
+
+    def validate
+      assert_ipaddr :ip_address
+      assert_url :homepage
+      assert_email :email
+    end
+  end
+  
+  context "The slug should be valid" do
+    def setup
+      @blog_post_01 = BlogPost.new
+      @blog_post_02 = BlogPost.new
+    end
+
+    should "fail if the slug is not valid" do
+      @blog_post_01.slug = "This is a title, not a SLUG"
+      @blog_post_01.create
+      
+      assert @blog_post_01.new?
+      assert_equal [[:slug, :not_slug]], @blog_post_01.errors
+    end
+
+    #should "succeed if the slug is valid" do
+    #  @blog_post_02.slug = "this-is-a-valid-slug"
+    #  @blog_post_02.create
+    #  assert_not_nil @blog_post_02.id
+    #end
+
+    should "fail if the slug is not unique" do
+
+      @blog_post_01.slug = "this-is-a-valid-slug"
+      @blog_post_01.create
+
+      @blog_post_02.slug = "this-is-a-valid-slug"
+      @blog_post_02.create
+
+      assert @blog_post_02.new?
+      assert_equal [[:slug, :not_unique]], @blog_post_02.errors
+    end
+  end
+
+  context "the ip address should be valid" do
+    def setup
+      @comment = Comment.new
+    end
+
+    should "fail if the ip address is not valid" do
+      @comment.ip_address = "400.500.600.700"
+      @comment.create
+
+      assert @comment.new?
+      assert @comment.errors.include? [:ip_address, :not_ipaddr]
+    end
+  end
+
+  context "the email address should be valid" do
+    def setup
+      @comment = Comment.new
+    end
+
+    should "fail if the email address is not valid" do
+      @comment.email = "something.com"
+      @comment.create
+
+      assert @comment.new?
+      assert @comment.errors.include? [:email, :not_email]
+    end
+  end
+
+  context "the homepage URL should be valid" do
+    def setup
+      @comment = Comment.new
+    end
+
+    should "fail if the homepage URL is not valid" do
+      @comment.homepage = "something"
+      @comment.create
+
+      assert @comment.new?
+      assert @comment.errors.include? [:homepage, :not_url]
+    end
+
+    should "fail if the homepage URL protocol is not http or https" do
+      @comment.homepage = "irc://irc.freenode.net/something"
+      @comment.create
+
+      assert @comment.new?
+      assert @comment.errors.include? [:homepage, :not_url]
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: ohm-contrib
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-13 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ohm
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Highly decoupled drop-in functionality for Ohm models
+email: cyx.ucron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/ohm/contrib.rb
+- lib/ohm/contrib/boundaries.rb
+- lib/ohm/contrib/number_validations.rb
+- lib/ohm/contrib/timestamping.rb
+- lib/ohm/contrib/to_hash.rb
+- lib/ohm/contrib/web_validations.rb
+- test/helper.rb
+- test/test_ohm_boundaries.rb
+- test/test_ohm_contrib.rb
+- test/test_ohm_number_validations.rb
+- test/test_ohm_timestamping.rb
+- test/test_ohm_to_hash.rb
+- test/test_ohm_web_validations.rb
+has_rdoc: true
+homepage: http://github.com/sinefunc/ohm-contrib
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A collection of ohm related modules
+test_files: 
+- test/helper.rb
+- test/test_ohm_boundaries.rb
+- test/test_ohm_contrib.rb
+- test/test_ohm_number_validations.rb
+- test/test_ohm_timestamping.rb
+- test/test_ohm_to_hash.rb
+- test/test_ohm_web_validations.rb