activerecord_mysql_strict 0.0.1 → 0.1

data/.rspec

@@ -0,0 +1 @@
+--colour

data/README.md

@@ -1,3 +1,75 @@
 # ActiveRecord::MySQL::Strict
 
+[![Gem Version](https://badge.fury.io/rb/activerecord_mysql_strict.png)](https://rubygems.org/gems/activerecord_mysql_strict)
+
 `ActiveRecord::MySQL::Strict` adds validations to ActiveRecord models to make sure they do not trigger errors in MySQL strict mode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_mysql_strict'
+```
+
+## Usage
+
+```ruby
+create_table "events" do |t|
+  t.string   "name"
+  t.text     "description"
+  t.integer  "people_count"
+end
+
+class Event < ActiveRecord::Base
+  validates_strict_columns
+end
+
+# String columns
+
+event = Event.new(name: '.' * 400)
+event.valid? # => false
+
+event = Event.new(name: '.' * 255)
+event.valid? # => true
+
+# Text columns
+
+event = Event.new(description: '.' * 70000)
+event.valid? # => false
+
+event = Event.new(description: '.' * 65535)
+event.valid? # => true
+
+# Integer columns
+
+event = Event.new(people_count: 9999999999)
+event.valid? # => false
+
+event = Event.new(people_count: 2147483647)
+event.valid? # => true
+```
+
+### Options
+
+You can use a few options when calling `validates_strict_columns`:
+
+```ruby
+class Event < ActiveRecord::Base
+  validates_strict_columns, only: [:name]
+end
+
+class Event < ActiveRecord::Base
+  validates_strict_columns, except: [:people_count]
+end
+```
+
+## License
+
+`ActiveRecord::MySQL::Strict` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/activerecord_mysql_strict/blob/master/LICENSE.md) file.
+
+## About Mirego
+
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly build mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development") in beautiful Quebec City.
+
+We also love [open-source software](http://open.mirego.com/) and we try to extract as much code as possible from our projects to give back to the community.

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/activerecord_mysql_strict.gemspec

@@ -22,5 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 3.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
 end

data/lib/active_record/mysql/strict/mixin.rb

@@ -1,5 +1,36 @@
 module ActiveRecord
-  module Mixin
-    # The magic will happen here
+  module MySQL
+    module Strict
+      module Mixin
+        extend ActiveSupport::Concern
+
+        included do
+          define_mysql_strict_validations
+        end
+
+        module ClassMethods
+          def define_mysql_strict_validations
+            except = @mysql_strict_options[:except] || []
+            model_columns = self.columns.dup.reject { |c| except.include?(c.name.to_sym) }
+
+            if only = @mysql_strict_options[:only]
+              model_columns = model_columns.select { |c| only.include?(c.name.to_sym) }
+            end
+
+            model_columns.select { |c| c.type == :string }.each do |field|
+              validates field.name, length: { in: 0..(field.limit || 255) }, allow_blank: true
+            end
+
+            model_columns.select { |c| c.type == :text }.each do |field|
+              validates field.name, length: { in: 0..(field.limit || 65535) }, allow_blank: true
+            end
+
+            model_columns.select { |c| c.type == :integer }.each do |field|
+              validates field.name, numericality: { greather_than_or_equal_to: -2147483647, less_than_or_equal_to: 2147483647 }, allow_blank: true
+            end
+          end
+        end
+      end
+    end
   end
 end

data/lib/active_record/mysql/strict/version.rb

@@ -1,7 +1,7 @@
 module ActiveRecord
   module MySQL
     module Strict
-      VERSION = '0.0.1'
+      VERSION = '0.1'
     end
   end
 end

data/lib/activerecord_mysql_strict.rb

@@ -0,0 +1,13 @@
+require 'active_record/mysql/strict/version'
+
+require 'active_record'
+require 'active_support'
+
+require 'active_record/mysql/strict/mixin'
+
+class ActiveRecord::Base
+  def self.validates_strict_columns(options = {})
+    @mysql_strict_options = options
+    include ActiveRecord::MySQL::Strict::Mixin
+  end
+end

data/spec/activerecord_mysql_strict/mixin_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe ActiveRecord::MySQL::Strict::Mixin do
+  describe :validates_strict_columns do
+    context 'for model without other validations' do
+      let(:model) { strict_model 'User' }
+
+      context 'for `string` columns' do
+        context 'with field with default limit' do
+          before do
+            run_migration do
+              create_table(:users, force: true) { |t| t.string :name }
+            end
+          end
+
+          context 'with field value exceeding limit' do
+            subject { model.new(name: '*' * 400) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value not exceeding limit' do
+            subject { model.new(name: '*' * 100) }
+            it { should be_valid }
+          end
+        end
+
+        context 'with field with custom limit' do
+          before do
+            run_migration do
+              create_table(:users, force: true) { |t| t.string :name, limit: 128 }
+            end
+          end
+
+          context 'with field value exceeding default limit' do
+            subject { model.new(name: '*' * 400) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value exceeding custom limit' do
+            subject { model.new(name: '*' * 140) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value not exceeding custom limit' do
+            subject { model.new(name: '*' * 120) }
+            it { should be_valid }
+          end
+        end
+      end
+
+      context 'for `text` columns' do
+        context 'with field with default limit' do
+          before do
+            run_migration do
+              create_table(:users, force: true) { |t| t.text :bio }
+            end
+          end
+
+          context 'with field value exceeding limit' do
+            subject { model.new(bio: '*' * 70000) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value not exceeding limit' do
+            subject { model.new(bio: '*' * 4000) }
+            it { should be_valid }
+          end
+        end
+
+        context 'with field with custom limit' do
+          before do
+            run_migration do
+              create_table(:users, force: true) { |t| t.text :bio, limit: 10000 }
+            end
+          end
+
+          context 'with field value exceeding default limit' do
+            subject { model.new(bio: '*' * 70000) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value exceeding custom limit' do
+            subject { model.new(bio: '*' * 12000) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value not exceeding custom limit' do
+            subject { model.new(bio: '*' * 4000) }
+            it { should be_valid }
+          end
+        end
+      end
+
+      context 'for `integer` columns' do
+        context 'with field with default limit' do
+          before do
+            run_migration do
+              create_table(:users, force: true) { |t| t.integer :number }
+            end
+          end
+
+          context 'with field value exceeding limit' do
+            subject { model.new(number: 9999999999) }
+            it { should_not be_valid }
+          end
+
+          context 'with field value not exceeding limit' do
+            subject { model.new(number: 2147483647) }
+            it { should be_valid }
+          end
+        end
+      end
+    end
+
+    context 'for model with related validations' do
+      context 'for presence validation' do
+        let(:model) do
+          strict_model 'User' do
+            validates :name, presence: true
+          end
+        end
+
+        before do
+          run_migration do
+            create_table(:users, force: true) { |t| t.string :name }
+          end
+        end
+
+        subject { model.new.tap(&:valid?) }
+        it { expect(subject.errors.full_messages).to eql ["Name can't be blank"] }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'sqlite3'
+
+require 'activerecord_mysql_strict'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+
+  config.before(:each) do
+    # Create the SQLite database
+    setup_database
+  end
+
+  config.after(:each) do
+    # Make sure we remove our test database file
+    cleanup_database
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,33 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def self.database_file
+    @database_file || File.expand_path('../test.db', __FILE__)
+  end
+
+  def setup_database
+    # Make sure the test database file is gone
+    cleanup_database
+
+    # Establish the connection
+    SQLite3::Database.new FileUtils.touch(DatabaseMacros.database_file).first
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: DatabaseMacros.database_file)
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+
+  def cleanup_database
+    FileUtils.rm(DatabaseMacros.database_file) if File.exists?(DatabaseMacros.database_file)
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,19 @@
+module ModelMacros
+  # Create a new microscope model
+  def strict_model(klass_name, options = {}, &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      validates_strict_columns options
+      instance_exec(&block) if block
+    end
+  end
+
+  protected
+
+  # Create a new model class
+  def spawn_model(klass_name, parent_klass, &block)
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+    Object.const_get(klass_name)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_mysql_strict
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ActiveRecord::MySQL::Strict adds validations to ActiveRecord models to
   make sure they do not trigger errors in MySQL strict mode.
 email:
@@ -84,13 +116,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - README.md
 - Rakefile
 - activerecord_mysql_strict.gemspec
 - lib/active_record/mysql/strict/mixin.rb
 - lib/active_record/mysql/strict/version.rb
-- lib/active_record_mysql_strict.rb
+- lib/activerecord_mysql_strict.rb
+- spec/activerecord_mysql_strict/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
 homepage: https://github.com/mirego/activerecord_mysql_strict
 licenses:
 - BSD 3-Clause
@@ -106,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2992963016304571034
+      hash: -412845040514754438
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2992963016304571034
+      hash: -412845040514754438
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -123,4 +160,8 @@ signing_key:
 specification_version: 3
 summary: ActiveRecord::MySQL::Strict adds validations to ActiveRecord models to make
   sure they do not trigger errors in MySQL strict mode.
-test_files: []
+test_files:
+- spec/activerecord_mysql_strict/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb

data/lib/active_record_mysql_strict.rb

@@ -1,6 +0,0 @@
-require 'active_record/mysql/strict/version'
-
-require 'active_record'
-require 'active_support'
-
-require 'active_record/mysql/strict/mixin'