bson_object_id_validations 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bson_object_id_validator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nick Hoffman
+
+MIT License
+
+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.md

@@ -0,0 +1,55 @@
+# BsonObjectIdValidations
+
+Provides an ActiveModel validation that checks if an attribute represents a legal BSON::ObjectId .
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bson_object_id_validations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bson_object_id_validations
+
+
+## Usage
+
+Validate that the specified attribute's value is a legal BSON::ObjectId .
+
+```ruby
+class User
+  include ActiveModel::Validations
+
+  attr_accessor :mongo_id
+
+  validates :mongo_id, :legal_bson_object_id => true
+end
+
+user = User.new :mongo_id => "invalid"
+
+user.valid?
+=> false
+
+user.errors
+=> {:mongo_id=>["is an invalid BSON::ObjectId"]}
+
+user.mongo_id = BSON::ObjectId.new.to_s
+
+user.valid?
+=> true
+```
+
+
+## Contributing
+
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Added some feature'`).
+4. Push to your branch (`git push origin my-new-feature`).
+5. Send a pull request.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/bson_object_id_validations.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bson_object_id_validations/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Hoffman"]
+  gem.email         = ["nick@deadorange.com"]
+  gem.description   = %q{Provides an ActiveModel validation that checks if an attribute represents a legal BSON::ObjectId .}
+  gem.summary       = %q{Provides an ActiveModel validation that checks if an attribute represents a legal BSON::ObjectId .}
+  gem.homepage      = "https://github.com/nickhoffman/bson_object_id_validations"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bson_object_id_validations"
+  gem.require_paths = ["lib"]
+  gem.version       = BsonObjectIdValidations::VERSION
+
+  gem.add_runtime_dependency 'activemodel', '>= 3.0'
+  gem.add_runtime_dependency 'bson_ext',    '>= 1.6'
+
+  gem.add_development_dependency 'rspec', '>= 2.8'
+  gem.add_development_dependency 'rake',  '>= 0.9.0'
+end

data/lib/bson_object_id_validations.rb

@@ -0,0 +1,7 @@
+require 'active_model'
+require 'bson'
+require "bson_object_id_validations/version"
+require "bson_object_id_validations/legal_bson_object_id_validator"
+
+module BsonObjectIdValidations
+end

data/lib/bson_object_id_validations/legal_bson_object_id_validator.rb

@@ -0,0 +1,37 @@
+module BsonObjectIdValidations
+  class LegalBsonObjectIdValidator < ActiveModel::EachValidator
+    @@error_message = 'is an invalid BSON::ObjectId'
+
+    # Validate that the specified attribute's value is a legal BSON::ObjectId .
+    #
+    # @example
+    #   class User
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :mongo_id
+    #
+    #     validates :mongo_id, :legal_bson_object_id => true
+    #   end
+    #
+    #   user = User.new :mongo_id => "invalid"
+    #
+    #   user.valid?
+    #    => false
+    #
+    #   user.errors
+    #    => {:mongo_id=>["is an invalid BSON::ObjectId"]}
+    #
+    #   user.mongo_id = BSON::ObjectId.new.to_s
+    #
+    #   user.valid?
+    #    => true
+    #
+    def validate_each(record, attribute, value)
+      error_message = options[:message] || @@error_message
+
+      unless ::BSON::ObjectId.legal? value
+        record.errors.add attribute, error_message
+      end
+    end
+  end
+end

data/lib/bson_object_id_validations/version.rb

@@ -0,0 +1,3 @@
+module BsonObjectIdValidations
+  VERSION = "1.0.0"
+end

data/spec/bson_object_id_validations/legal_bson_object_id_validator_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe BsonObjectIdValidations::LegalBsonObjectIdValidator  do
+  class User
+    include ActiveModel::Validations
+    include BsonObjectIdValidations
+
+    attr_accessor :mongo_id_1
+    attr_accessor :mongo_id_2
+
+    validates :mongo_id_1, :legal_bson_object_id => true
+    validates :mongo_id_2, :legal_bson_object_id => {:message => 'a custom error message'}
+  end
+
+  it 'inherits from ActiveModel::EachValidator' do
+    described_class.superclass.should equal ActiveModel::EachValidator
+  end
+
+  describe 'class variables' do # {{{
+    it 'has @@error_message' do
+      described_class.class_variable_get(:@@error_message).
+        should == 'is an invalid BSON::ObjectId'
+    end
+  end # }}}
+
+  describe '#validate_each' do # {{{
+    let(:user) do
+      User.new :mongo_id_1 => 'invalid', :mongo_id_2 => 'invalid'
+    end
+
+    context 'when the attribute contains an invalid value' do # {{{
+      it 'adds an error on the attribute' do
+        user.valid?
+        user.errors[:mongo_id_1].count.should be 1
+      end
+
+      it 'uses the standard error message' do
+        user.valid?
+        user.errors[:mongo_id_1].should == ['is an invalid BSON::ObjectId']
+      end
+
+      context 'when a custom error message is provided' do # {{{
+        it 'uses the custom error message' do
+          user.valid?
+          user.errors[:mongo_id_2].should == ['a custom error message']
+        end
+      end # }}}
+    end # }}}
+  end # }}}
+end

data/spec/bson_object_id_validations_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe BsonObjectIdValidations do
+  it 'is at version 0.0.1' do
+    BsonObjectIdValidations::VERSION.should == '1.0.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'bson_object_id_validations'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: bson_object_id_validations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Hoffman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &80618720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80618720
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &80618300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80618300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &80606080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *80606080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &80605760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *80605760
+description: Provides an ActiveModel validation that checks if an attribute represents
+  a legal BSON::ObjectId .
+email:
+- nick@deadorange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bson_object_id_validations.gemspec
+- lib/bson_object_id_validations.rb
+- lib/bson_object_id_validations/legal_bson_object_id_validator.rb
+- lib/bson_object_id_validations/version.rb
+- spec/bson_object_id_validations/legal_bson_object_id_validator_spec.rb
+- spec/bson_object_id_validations_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nickhoffman/bson_object_id_validations
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 394965309
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 394965309
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides an ActiveModel validation that checks if an attribute represents
+  a legal BSON::ObjectId .
+test_files:
+- spec/bson_object_id_validations/legal_bson_object_id_validator_spec.rb
+- spec/bson_object_id_validations_spec.rb
+- spec/spec_helper.rb