validates_lengths_from_database_tmp 0.1.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Ben Hughes
+
+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.rdoc

@@ -0,0 +1,30 @@
+== Validates Lengths from Database
+
+Few people add length validations to fields in their database, and when saving such fields that have exhausted their length, an SQL error occurs.
+This gem introspects your table schema for maximum lengths on string and text fields and automatically adds length validations to the model.
+
+== Installation
+
+Include the gem using bundler in your Gemfile:
+
+  gem "validates_lengths_from_database"
+
+== Usage
+
+In your model you can activate validations:
+
+  class Post < ActiveRecord::Base
+    validates_lengths_from_database
+  end
+
+It also supports filter-style :only and :except options:
+
+  class Post < ActiveRecord::Base
+    validates_lengths_from_database :only => [:title, :contents]
+  end
+
+  class Post < ActiveRecord::Base
+    validates_lengths_from_database :except => [:other_field]
+  end
+
+Note that this cannot be done at a global level directly against ActiveRecord::Base, since the +validates_length_from_database+ method requires the class to have a table name (with the ability to load the schema).

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+desc "Generate documentation for the plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "validates_lengths_from_database"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }
+

data/init.rb

@@ -0,0 +1,4 @@
+require "validates_lengths_from_database"
+
+ValidatesLengthsFromDatabase::Railtie.insert
+

data/lib/validates_lengths_from_database.rb

@@ -0,0 +1,45 @@
+require "rubygems"
+require "active_record"
+
+module ValidatesLengthsFromDatabase
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+    base.send(:include, InstanceMethods)
+  end
+
+  module ClassMethods
+    def validates_lengths_from_database(options = {})
+      return unless self.table_exists? #return if table does not exist. Happens in test env during migration
+      options.symbolize_keys!
+
+      raise ArgumentError, "The :only option to validates_lengths_from_database must be an array." if options[:only] and !options[:only].is_a?(Array)
+      raise ArgumentError, "The :except option to validates_lengths_from_database must be an array." if options[:except] and !options[:except].is_a?(Array)
+
+      if options[:only]
+        columns_to_validate = options[:only].map(&:to_s)
+      else
+        columns_to_validate = column_names.map(&:to_s)
+        columns_to_validate -= options[:except].map(&:to_s) if options[:except]
+      end
+
+      columns_to_validate.each do |column|
+        column_schema = columns.find {|c| c.name == column }
+        next if column_schema.nil?
+        next if ![:string, :text].include?(column_schema.type)
+        next if column_schema.limit.nil?
+
+        class_eval do
+          validates_length_of column, :maximum => column_schema.limit, :allow_blank => true
+        end
+      end
+
+      nil
+    end
+
+  end
+
+  module InstanceMethods
+  end
+end
+
+require "validates_lengths_from_database/railtie"

data/lib/validates_lengths_from_database/railtie.rb

@@ -0,0 +1,20 @@
+module ValidatesLengthsFromDatabase
+  if defined?(Rails::Railtie)
+    require "rails"
+    
+    class Railtie < Rails::Railtie
+      initializer "validates_lengths_from_database.extend_active_record" do
+        ActiveSupport.on_load(:active_record) do
+          ValidatesLengthsFromDatabase::Railtie.insert
+        end
+      end
+    end
+  end
+  
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, ValidatesLengthsFromDatabase)
+    end
+  end
+end
+

data/lib/validates_lengths_from_database/version.rb

@@ -0,0 +1,3 @@
+module ValidatesLengthsFromDatabase
+  VERSION = "0.1.2"
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require "validates_lengths_from_database"
+
+ValidatesLengthsFromDatabase::Railtie.insert
+

data/spec/db/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  adapter: sqlite
+  database: spec/db/test.sqlite
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/db/test.sqlite3
+
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: has_draft_plugin_test
+  min_messages: ERROR
+
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: has_draft_plugin_test

data/spec/db/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+  
+  create_table :articles, :force => true do |t|
+    t.string :string_1, :limit => 5
+    t.string :string_2, :limit => 5
+    t.text :text_1, :limit => 5
+    t.date :date_1
+    t.integer :integer_1
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "rspec"
+require "active_record"
+
+# Establish DB Connection
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'db', 'database.yml')))
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+require File.dirname(__FILE__) + '/../init'

data/spec/validates_lengths_from_database_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+describe ValidatesLengthsFromDatabase do
+
+  LONG_ATTRIBUTES = {
+    :string_1 => "123456789",
+    :string_2 => "123456789",
+    :text_1 => "123456789",
+    :date_1 => Date.today,
+    :integer_1 => 123
+  }
+
+  SHORT_ATTRIBUTES = {
+    :string_1 => "12",
+    :string_2 => "12",
+    :text_1 => "12",
+    :date_1 => Date.today,
+    :integer_1 => 123
+  }
+
+  context "Model with validates_lengths_from_database" do
+    before do
+      class ArticleValidateAll < ActiveRecord::Base
+        set_table_name "articles"
+        validates_lengths_from_database
+      end
+    end
+
+    context "an article with overloaded attributes" do
+      before { @article = ArticleValidateAll.new(LONG_ATTRIBUTES); @article.valid? }
+
+      it "should not be valid" do
+        @article.should_not be_valid
+      end
+
+      it "should have errors on all string/text attributes" do
+        @article.errors["string_1"].join.should =~ /too long/
+        @article.errors["string_2"].join.should =~ /too long/
+        @article.errors["text_1"].join.should =~ /too long/
+      end
+    end
+
+    context "an article with short attributes" do
+      before { @article = ArticleValidateAll.new(SHORT_ATTRIBUTES); @article.valid? }
+
+      it "should be valid" do
+        @article.should be_valid
+      end
+    end
+  end
+  
+  context "Model with validates_lengths_from_database :only => [:string_1, :text_1]" do
+    before do
+      class ArticleValidateOnly < ActiveRecord::Base
+        set_table_name "articles"
+        validates_lengths_from_database :only => [:string_1, :text_1]
+      end
+    end
+
+    context "an article with long attributes" do
+      before { @article = ArticleValidateOnly.new(LONG_ATTRIBUTES); @article.valid? }
+
+      it "should not be valid" do
+        @article.should_not be_valid
+      end
+
+      it "should have errors on only string_1 and text_1" do
+        @article.errors["string_1"].join.should =~ /too long/
+        (@article.errors["string_2"] || []).should be_empty
+        @article.errors["text_1"].join.should =~ /too long/
+      end
+    end
+
+    context "an article with short attributes" do
+      before { @article = ArticleValidateOnly.new(SHORT_ATTRIBUTES); @article.valid? }
+
+      it "should be valid" do
+        @article.should be_valid
+      end
+    end
+  end
+
+  context "Model with validates_lengths_from_database :except => [:string_1, :text_1]" do
+    before do
+      class ArticleValidateExcept < ActiveRecord::Base
+        set_table_name "articles"
+        validates_lengths_from_database :except => [:string_1, :text_1]
+      end
+    end
+
+    context "an article with long attributes" do
+      before { @article = ArticleValidateExcept.new(LONG_ATTRIBUTES); @article.valid? }
+
+      it "should not be valid" do
+        @article.should_not be_valid
+      end
+
+      it "should have errors on columns other than string_1 and text_1 only" do
+        (@article.errors["string_1"] || []).should be_empty
+        (@article.errors["text_1"] || []).should be_empty
+        @article.errors["string_2"].join.should =~ /too long/
+      end
+    end
+
+    context "an article with short attributes" do
+      before { @article = ArticleValidateOnly.new(SHORT_ATTRIBUTES); @article.valid? }
+
+      it "should be valid" do
+        @article.should be_valid
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: validates_lengths_from_database_tmp
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+  type: :development
+  version_requirements: *id003
+description: Introspects your database string field maximum lengths and automatically defines length validations.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/validates_lengths_from_database/railtie.rb
+- lib/validates_lengths_from_database/version.rb
+- lib/validates_lengths_from_database.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/spec_helper.rb
+- spec/validates_lengths_from_database_spec.rb
+- rails/init.rb
+- Gemfile
+- LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/rubiety/validates_lengths_from_database
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: validates_lengths_from_database_tmp
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Automatic maximum-length validations.
+test_files: []
+