valle 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.3 / 2012-12-13
+
+* added primary_key type [Anton Kalyaev]
+* added missing argument to respond_to? [Anton Kalyaev]
+* config is now working [Anton Kalyaev]
+
 ## 0.0.2 / 2012-12-11
 
 * fixed inherited behavior; switched to valid? method (Fixes #3) [Anton Kalyaev]

data/README.md

@@ -1,7 +1,8 @@
 # Valle [![Build Status](https://secure.travis-ci.org/kaize/valle.png "Build Status")](http://travis-ci.org/kaize/valle) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kaize/valle)
 
-Valle adds validators to all the fields of your ActiveRecord models,
-so you should not think that string length or ID value exceeds the permissible limits.
+Valle automatically sets minimum and maximum values for the fields of your
+ActiveRecord model(s), so you shouldn't worry, that string length or ID
+value will exceed the permissible DB limit for this type of field.
 
 For example, maximum length of the string in PostgreSQL is 255. We will
 setup the following validator for you, so you don't need to write it by
@@ -16,8 +17,12 @@ Example:
     PG::Error: ERROR:  value "2147483648" is out of range for type integer
     : SELECT  "users".* FROM "users"  WHERE "users"."id" = $1 LIMIT 1
 
-There is a similar gem, called [validates_lengths_from_database](http://github.com/rubiety/validates_lengths_from_database). It solves only one part -
-applicable to strings. This gem is designed to work with all possible field types.
+### Supported ActiveRecord field types
+
+- `:primary_key`
+- `:integer`
+- `:string`
+- `:text`
 
 ## Installation
 
@@ -50,6 +55,11 @@ Also, you should be able to turn it off temporary by setting `enabled` option to
       config.enabled = false
     end
 
+## Alternatives
+
+There is a similar gem, called [validates_lengths_from_database](http://github.com/rubiety/validates_lengths_from_database). It solves only one part -
+applicable to strings. This gem is designed to work with all possible field types.
+
 ## Contributing
 
 1. Fork it

data/features/configuration.feature

@@ -0,0 +1,79 @@
+@disable-bundler
+Feature:
+  In order to temporary disable Valle or apply it only to a subset of models,
+  as a user of Rails, I would like to use valle initializer options.
+
+  Background:
+    Given I successfully run `bundle exec rails new testapp --skip-bundle --skip-sprockets --skip-javascript`
+    And I cd to "testapp"
+    And I add "factory_girl_rails" as a dependency
+    And I add "valle" from this project as a dependency
+    And I successfully run `bundle install`
+    And I successfully run `bundle exec rails g model User name:string`
+    And I successfully run `bundle exec rake db:migrate --trace`
+
+  Scenario: Setting enabled option to false disable Valle
+    When I write to "config/initializers/valle.rb" with:
+      """
+      Valle.configure do |config|
+        config.enabled = false
+      end
+      """
+    And I write to "test/unit/user_test.rb" with:
+      """
+      require 'test_helper'
+
+      class UserTest < ActiveSupport::TestCase
+        test "should raise ActiveRecord::StatementInvalid error when name is too long" do
+          user = FactoryGirl.create(:user)
+          user.name = 'a' * 256
+
+          # SQLLite3 do not throw an ActiveRecord::StatementInvalid error
+          # so just check that record gets saved
+          assert user.save
+        end
+      end
+      """
+    When I successfully run `bundle exec rake test --trace`
+    Then the output should contain "1 tests, 1 assertions, 0 failures, 0 errors"
+
+  Scenario: Using the models option should limit the effect of the Valle to the models specified in the list
+    When I successfully run `bundle exec rails g model Post title:string`
+    And I successfully run `bundle exec rake db:migrate --trace`
+    And I write to "config/initializers/valle.rb" with:
+      """
+      Valle.configure do |config|
+        config.models = %w(Post)
+      end
+      """
+    And I write to "test/unit/user_test.rb" with:
+      """
+      require 'test_helper'
+
+      class UserTest < ActiveSupport::TestCase
+        test "should raise ActiveRecord::StatementInvalid error when name is too long" do
+          user = FactoryGirl.create(:user)
+          user.name = 'a' * 256
+
+          # SQLLite3 do not throw an ActiveRecord::StatementInvalid error
+          # so just check that record gets saved
+          assert user.save
+        end
+      end
+      """
+    And I write to "test/unit/post_test.rb" with:
+      """
+      require 'test_helper'
+
+      class PostTest < ActiveSupport::TestCase
+        test "should not save post when title is too long" do
+          post = FactoryGirl.create(:post)
+          post.title = 'a' * 256
+
+          assert !post.save
+          assert_equal 1, post.errors.count
+        end
+      end
+      """
+    When I successfully run `bundle exec rake test --trace`
+    Then the output should contain "2 tests, 3 assertions, 0 failures, 0 errors"

data/features/sets_validations.feature

@@ -0,0 +1,28 @@
+Feature: sets validations
+  Background:
+    Given I successfully run `bundle exec rails new testapp --skip-bundle --skip-sprockets --skip-javascript`
+    And I cd to "testapp"
+    And I add "factory_girl_rails" as a dependency
+    And I add "valle" from this project as a dependency
+    And I successfully run `bundle install`
+    And I successfully run `bundle exec rails g model User name:string`
+    And I successfully run `bundle exec rake db:migrate --trace`
+
+  @disable-bundler
+  Scenario: Using Valle automatically sets validations
+    When I write to "test/unit/user_test.rb" with:
+      """
+      require 'test_helper'
+
+      class UserTest < ActiveSupport::TestCase
+        test "should not save user when name is too long" do
+          user = FactoryGirl.create(:user)
+          user.name = 'a' * 256
+
+          assert !user.save
+          assert_equal 1, user.errors.count
+        end
+      end
+      """
+    When I successfully run `bundle exec rake test --trace`
+    Then the output should contain "1 tests, 2 assertions, 0 failures, 0 errors"

data/lib/valle.rb

@@ -4,7 +4,7 @@ module Valle
   extend Configuration
 
   # core
-  autoload :BoundsManager, 'valle/bounds_manager'
+  autoload :Manager, 'valle/manager'
   autoload :ValidationSetter, 'valle/validation_setter'
 
   # extensions
@@ -18,6 +18,32 @@ module Valle
 
   # hooks
   autoload :Hooks, 'valle/hooks'
+
+  class << self
+
+    ##
+    # Is gem enabled (true by default)
+    #
+    # @see Valle::Configuration
+    #
+    def enabled?
+      options[:enabled]
+    end
+
+    ##
+    # Can we process this model
+    #
+    # If the user turned gem on only for certain models,
+    # we need to check whether the model is in the list.
+    #
+    # @param [String] model_name the model name
+    # @see Valle::Configuration
+    #
+    def can_process_model?(model_name)
+      options[:models].nil? ||
+        options[:models].is_a?(Array) && options[:models].include?(model_name)
+    end
+  end
 end
 
 ## if not using Railtie, call `Valle::Hooks.init` directly

data/lib/valle/abstract_adapter/abstract_column.rb

@@ -19,15 +19,12 @@ module Valle
         @original_column = original_column
       end
 
-      ##
-      # Proxy all methods missing to original column
-      #
-      def method_missing(method_name, *arguments, &block)
+      def method_missing(method_name, *arguments, &block) # :nodoc:
         @original_column.send(method_name, *arguments, &block)
       end
 
-      def respond_to_method_missing?(method_name, include_private = false)
-        @original_column.respond_to?(method_name)
+      def respond_to_method_missing?(method_name, include_private = false) # :nodoc:
+        @original_column.respond_to?(method_name, include_private)
       end
 
       ##

data/lib/valle/abstract_adapter/column_wrapper.rb

@@ -30,6 +30,7 @@ module Valle
         #
         def limit_in_bytes?(column)
           case column.type
+          when :primary_key; true
           # when :binary; true
           when :integer; true
           else false

data/lib/valle/hooks.rb

@@ -8,7 +8,7 @@ module Valle
       #
       def init
         ActiveSupport.on_load(:active_record) do
-          Valle::Hooks.extend_inherited_method
+          Valle::Hooks.extend_inherited_method if Valle.enabled?
         end
       end
 
@@ -20,7 +20,9 @@ module Valle
           class << self
             def inherited_with_valle_validators(subclass)
               inherited_without_valle_validators(subclass)
-              Valle::Hooks.extend_ar_validations_valid_method(subclass)
+              if Valle.can_process_model?(subclass.model_name)
+                Valle::Hooks.extend_ar_validations_valid_method(subclass)
+              end
             end
 
             alias_method_chain :inherited, :valle_validators
@@ -41,7 +43,7 @@ module Valle
 
         subclass.class_eval do
           def valid_with_valle_validators?(context = nil)
-            self.class.valle_validators ||= Valle::BoundsManager.add_validators(self.class)
+            self.class.valle_validators ||= Valle::Manager.add_validators(self.class)
             valid_without_valle_validators?(context)
           end
 

data/lib/valle/{bounds_manager.rb → manager.rb}

@@ -1,5 +1,5 @@
 module Valle
-  class BoundsManager
+  class Manager
 
     class << self
 

data/lib/valle/version.rb

@@ -1,3 +1,3 @@
 module Valle
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/valle.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/valle/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Anton Kalyaev"]
   gem.email         = ["anton.kalyaev@gmail.com"]
-  gem.description   = %q{Valle adds validators to all the fields of your ActiveRecord models, so you should not think that string length or ID value exceeds the permissible limits}
-  gem.summary       = %q{Set automatically the minimum and maximum values for your ActiveRecord model fields}
+  gem.description   = %q{Valle automatically sets minimum and maximum values for the fields of your ActiveRecord model(s), so you shouldn't worry, that string length or ID value will exceed the permissible limit.}
+  gem.summary       = %q{Built-in limit validations for your ActiveRecord model.}
   gem.homepage      = "http://github.com/kaize/valle"
 
   gem.files         = `git ls-files`.split($\)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -43,8 +43,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Valle adds validators to all the fields of your ActiveRecord models,
-  so you should not think that string length or ID value exceeds the permissible limits
+description: Valle automatically sets minimum and maximum values for the fields of
+  your ActiveRecord model(s), so you shouldn't worry, that string length or ID value
+  will exceed the permissible limit.
 email:
 - anton.kalyaev@gmail.com
 executables: []
@@ -59,7 +60,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- features/adds_validators.feature
+- features/configuration.feature
+- features/sets_validations.feature
 - features/step_definitions/rails_steps.rb
 - features/support/env.rb
 - lib/valle.rb
@@ -68,9 +70,9 @@ files:
 - lib/valle/abstract_adapter/character_limited_column.rb
 - lib/valle/abstract_adapter/column_wrapper.rb
 - lib/valle/abstract_adapter/unlimited_column.rb
-- lib/valle/bounds_manager.rb
 - lib/valle/configuration.rb
 - lib/valle/hooks.rb
+- lib/valle/manager.rb
 - lib/valle/railtie.rb
 - lib/valle/validation_setter.rb
 - lib/valle/version.rb
@@ -92,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1761133230881238709
+      hash: 1309560054681721189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,16 +103,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1761133230881238709
+      hash: 1309560054681721189
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Set automatically the minimum and maximum values for your ActiveRecord model
-  fields
+summary: Built-in limit validations for your ActiveRecord model.
 test_files:
-- features/adds_validators.feature
+- features/configuration.feature
+- features/sets_validations.feature
 - features/step_definitions/rails_steps.rb
 - features/support/env.rb
 - test/lib/abstract_adapter/character_limited_column_test.rb

data/features/adds_validators.feature

@@ -1,52 +0,0 @@
-Feature: adds validators
-  Background:
-    When I successfully run `bundle exec rails new testapp`
-  And I cd to "testapp"
-  And I add "factory_girl_rails" as a dependency
-  And I add "valle" from this project as a dependency
-  When I successfully run `bundle install`
-  And I write to "db/migrate/1_create_users.rb" with:
-    """
-    class CreateUsers < ActiveRecord::Migration
-      def self.up
-        create_table :users do |t|
-          t.string :name
-          t.text :bio
-          t.integer :age
-        end
-      end
-    end
-    """
-  When I successfully run `bundle exec rake db:migrate --trace`
-  And I write to "app/models/user.rb" with:
-    """
-    class User < ActiveRecord::Base
-    end
-    """
-
-  @disable-bundler
-  Scenario: generate a rails 3 application and try out automatically injected validations
-  When I write to "test/factories.rb" with:
-    """
-    FactoryGirl.define do
-      factory :user do
-        name "John"
-        bio "A nice write up about this guy"
-        age 22
-      end
-    end
-    """
-  When I write to "test/unit/user_test.rb" with:
-    """
-    require 'test_helper'
-
-    class UserTest < ActiveSupport::TestCase
-      test "should not save user when name is too long" do
-        user = FactoryGirl.create(:user)
-        user.name = 'a' * 256
-        assert !user.save
-      end
-    end
-    """
-  When I successfully run `bundle exec rake test --trace`
-  Then the output should contain "1 tests, 1 assertions, 0 failures, 0 errors"