automagical_validations 0.1.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "activerecord", ">= 3.0.0"
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "sqlite3-ruby", "~> 1.3.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Toms Mikoss
+
+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,43 @@
+#automagical_validations
+
+automagical_validations provides way to automatically apply validations to ActiveRecord models based on the information that can be inferred from database schema.
+
+##Use
+
+automagical_validations defines an `ActiveRecord::Base` class method that takes column type (like ones you would use in a migration) as argument:
+
+    class Post < ActiveRecord::Base
+      automagically_validate :string, :text
+    end
+
+##What it does
+###Column maximum length validations
+
+automagical_validations will define maximum length validations on all columns matching the passed types.
+
+If `automagically_validate` is invoked for columns that do not support `limit` attribute (depends chiefly on the adapter used), no validations will be created.
+
+If a maximum length validation already exists for column (for example, `automagically_validate` is invoked after `validates_length_of`), additional validation will not be created.
+
+##Installation
+
+Add the following line to your `Gemfile`
+
+    gem "automagical_validations"
+
+and run the `bundle install` command.
+
+##Contributing to automagical_validations
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright &copy; 2012 Toms Mikoss. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "automagical_validations"
+  gem.homepage = "http://github.com/tmikoss/automagical_validations"
+  gem.license = "MIT"
+  gem.summary = %Q{ActiveRecord extension that allows to infer validation rules from database}
+  gem.description = %Q{ActiveRecord extension that allows to infer validation rules from database}
+  gem.email = "toms.mikoss@gmail.com"
+  gem.authors = ["Toms Mikoss"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+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/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/automagical_validations.rb

@@ -0,0 +1,22 @@
+module AutomagicalValidations
+  def automagically_validate(*types_to_validate)
+    types_to_validate.map!{ |type| type.to_sym }
+
+    columns.each do |column|
+      # Do not touch the columns not specified
+      next unless types_to_validate.include? column.type
+
+      # Do not define validator on columns that have no limit information, even if asked to
+      next unless column.limit
+
+      # Do not define additional length validators if any are already in place
+      next if validators_on(column.name).any? do |validator|
+        validator.is_a?(ActiveModel::Validations::LengthValidator) && validator.options[:maximum]
+      end
+
+      validates_length_of column.name, :maximum => column.limit
+    end
+  end
+end
+
+ActiveRecord::Base.extend AutomagicalValidations

data/spec/automagical_validations_spec.rb

@@ -0,0 +1,171 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AutomagicalValidations" do
+  subject { Post.new }
+
+  context "maximum length validator" do
+    context "presence of validators" do
+      before(:all) do
+        Post.rebuild_table do |t|
+          t.string  :title
+          t.text    :content
+        end
+
+        Post.automagically_validate :string
+      end
+
+      it "should define length validator on specified type of column" do
+        Post.should have(1).validators_on(:title)
+        Post.validators_on(:title).first.should be_a ActiveModel::Validations::LengthValidator
+      end
+
+      it "should not define any validators on other types of columns" do
+        Post.validators_on(:content).should be_empty
+      end
+    end
+
+    context "when asked to define validation on column that provides no limit information" do
+      before(:all) do
+        Post.rebuild_table do |t|
+          t.date :published_at
+        end
+
+        Post.automagically_validate :date
+      end
+
+      it "should not define any validators" do
+        Post.validators_on(:published_at).should be_empty
+      end
+    end
+
+    context "when column type is provided as string" do
+      before(:all) do
+        Post.rebuild_table do |t|
+          t.string  :title
+        end
+
+        Post.automagically_validate 'string'
+      end
+
+      it "should define validators" do
+        Post.should have(1).validators_on(:title)
+      end
+    end
+
+    context "when a table is defined with implicit limits (defaults)" do
+      before(:all) do
+        Post.rebuild_table do |t|
+          t.string  :title
+        end
+
+        Post.automagically_validate :string
+      end
+
+      it "should be valid when content is not specified" do
+        subject.should be_valid
+      end
+
+      it "should be valid when content is empty" do
+        subject.title = ''
+        subject.should be_valid
+      end
+
+      it "should be valid when under or equal to default Rails string column length (255)" do
+        subject.title = "a"*255
+        subject.should be_valid
+      end
+
+      it "should not be valid when over default Rails string column length (255)" do
+        subject.title = "a"*256
+        subject.should_not be_valid
+      end
+    end
+
+    context "when a table is defined with explicit limits" do
+      before(:all) do
+        Post.rebuild_table do |t|
+          t.string  :title, :limit => 20
+        end
+
+        Post.automagically_validate :string
+      end
+
+      it "should be valid when content is not specified" do
+        subject.should be_valid
+      end
+
+      it "should be valid when content is empty" do
+        subject.title = ''
+        subject.should be_valid
+      end
+
+      it "should be valid when under or equal to specified limit" do
+        subject.title = "a"*20
+        subject.should be_valid
+      end
+
+      it "should not be valid when over specified limit" do
+        subject.title = "a"*21
+        subject.should_not be_valid
+      end
+    end
+
+    context "when explicit validation exists" do
+      context "when explicit validation is defined before automagical validation" do
+        before(:all) do
+          Post.rebuild_table do |t|
+            t.string  :title,   :limit => 20
+          end
+
+          Post.validates_length_of :title, :maximum => 10
+          Post.automagically_validate :string
+        end
+
+        it "should not overwrite explicit validation" do
+          subject.title = "a"*15
+          subject.should_not be_valid
+        end
+
+        it "should not define additional validation" do
+          Post.should have(1).validators_on(:title)
+        end
+      end
+
+      context "when explicit validation without maximum parameter is defined before automagical validation" do
+        before(:all) do
+          Post.rebuild_table do |t|
+            t.string  :title,   :limit => 20
+          end
+
+          Post.validates_length_of :title, :minimum => 10
+          Post.automagically_validate :string
+        end
+
+        it "should provide validation for max value" do
+          subject.title = "a"*21
+          subject.should_not be_valid
+        end
+
+        it "should define additional validation to take care of maximum length" do
+          Post.should have(2).validators_on(:title)
+        end
+      end
+
+      context "when explicit validation is defined after automagical validation" do
+        before(:all) do
+          Post.rebuild_table do |t|
+            t.string  :title,   :limit => 20
+          end
+
+          Post.automagically_validate :string
+          Post.validates_length_of :title, :maximum => 10
+        end
+
+        it "explicit validation should take precedence" do
+          subject.title = "a"*15
+          subject.should_not be_valid
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'automagical_validations'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "#{File.dirname(__FILE__)}/automagical_validations.db"
+)
+
+class Post < ActiveRecord::Base
+  def self.rebuild_table
+    ActiveRecord::Schema.define do
+      self.verbose = false
+
+      create_table :posts, :force => true do |t|
+        yield t
+      end
+    end
+
+    reset_column_information
+
+    # Reset all validators to prevent test cases from messing with each other
+    self._validators = columns.inject({}) do |memo, column|
+      memo[column.name.to_sym] = []
+      memo
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: automagical_validations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Toms Mikoss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &891825110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *891825110
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &891824830 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *891824830
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &891824540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *891824540
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &891824100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *891824100
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &891823040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *891823040
+description: ActiveRecord extension that allows to infer validation rules from database
+email: toms.mikoss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/automagical_validations.rb
+- spec/automagical_validations_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tmikoss/automagical_validations
+licenses:
+- MIT
+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: 802746131
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: ActiveRecord extension that allows to infer validation rules from database
+test_files: []