valle 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.0.2 / 2012-12-11
+
+* fixed inherited behavior; switched to valid? method (Fixes #3) [Anton Kalyaev]
+* added support for integer columns [Anton Kalyaev]
+* added 3 types of columns: character_limited, byte_limited and unlimited [Anton Kalyaev]
+* removed engine [Anton Kalyaev]
+* fix typos in README.md [Aleksandr Ivanov]
+
+## 0.0.1 / 2012-12-09
+
+* Initial release (with basic strings support)

data/README.md

@@ -9,14 +9,14 @@ hands.
 
     validates :field_name, length: { maximum: 255 }
 
-Note: If you do not do this (and usually you are) and try to enter 2147483648 into the field with type: `interger` (see [Numeric types](http://www.postgresql.org/docs/9.2/static/datatype-numeric.html) section of PostgreSQL docs), you will get 500 error.
+Note: If you do not do this (and usually you are) and try to enter 2147483648 into the field with type: `integer` (see [Numeric types](http://www.postgresql.org/docs/9.2/static/datatype-numeric.html) section of PostgreSQL docs), you will get 500 error.
 
 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 simular gem, called [validates_lengths_from_database](http://github.com/rubiety/validates_lengths_from_database). It solves only one part -
+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.
 
 ## Installation
@@ -59,12 +59,16 @@ Also, you should be able to turn it off temporary by setting `enabled` option to
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
 
-## Core team
+## Credits
+
+Team members:
 
 - [Anton Kalyaev](http://github.com/akalyaev)
 - [Andrew Kulakov](http://github.com/Andrew8xx8)
 - [Alexander Kirillov](http://github.com/saratovsource)
 
+Thank you to all our amazing [contributors](http://github.com/kaize/valle/contributors)!
+
 ## License
 
 Valle is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -5,7 +5,7 @@ require 'cucumber/rake/task'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/lib/*_test.rb']
+  t.test_files = FileList['test/lib/**/*_test.rb']
   t.verbose = true
 end
 

data/features/adds_validators.feature

@@ -11,6 +11,8 @@ Feature: adds validators
       def self.up
         create_table :users do |t|
           t.string :name
+          t.text :bio
+          t.integer :age
         end
       end
     end
@@ -23,12 +25,14 @@ Feature: adds validators
     """
 
   @disable-bundler
-  Scenario: generate a rails 3 application and use factory definitions
+  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
     """

data/lib/valle.rb

@@ -4,24 +4,21 @@ module Valle
   extend Configuration
 
   # core
-  autoload :BoundMapper, 'valle/bound_mapper'
   autoload :BoundsManager, 'valle/bounds_manager'
   autoload :ValidationSetter, 'valle/validation_setter'
 
+  # extensions
+  module AbstractAdapter
+    autoload :ColumnWrapper, 'valle/abstract_adapter/column_wrapper'
+    autoload :AbstractColumn, 'valle/abstract_adapter/abstract_column'
+    autoload :ByteLimitedColumn, 'valle/abstract_adapter/byte_limited_column'
+    autoload :CharacterLimitedColumn, 'valle/abstract_adapter/character_limited_column'
+    autoload :UnlimitedColumn, 'valle/abstract_adapter/unlimited_column'
+  end
+
   # hooks
   autoload :Hooks, 'valle/hooks'
 end
 
-# load Rails/Railtie
-begin
-  require 'rails'
-rescue LoadError
-  #do nothing
-end
-
-# if not using Railtie, call `Valle::Hooks.init` directly
-# TODO [AK 09/12/12] move this block to initializers
-if defined? Rails
-  require 'valle/railtie'
-  require 'valle/engine'
-end
+## if not using Railtie, call `Valle::Hooks.init` directly
+require 'valle/railtie' if defined? Rails

data/lib/valle/abstract_adapter/abstract_column.rb

@@ -0,0 +1,48 @@
+module Valle
+  module AbstractAdapter
+    class AbstractColumn
+
+      ##
+      # Adds more functionality to the standard ActiveRecord::ConnectionAdapters::Column
+      #
+      # @param [ActiveRecord::ConnectionAdapters::Column] original_column the original column
+      #
+      # @example
+      #   c = AbstractAdapter::AbstractColumn.new(original_column)
+      #
+      #   c.minimum
+      #     => -128
+      #   c.maximum
+      #     => 127
+      #
+      def initialize(original_column)
+        @original_column = original_column
+      end
+
+      ##
+      # Proxy all methods missing to original column
+      #
+      def method_missing(method_name, *arguments, &block)
+        @original_column.send(method_name, *arguments, &block)
+      end
+
+      def respond_to_method_missing?(method_name, include_private = false)
+        @original_column.respond_to?(method_name)
+      end
+
+      ##
+      # Get maximum possible value/length for this column
+      #
+      def maximum
+        raise NotImplementedError.new("You must implement maximum method.")
+      end
+
+      ##
+      # Get minimum value/length for this column
+      #
+      def minimum
+        raise NotImplementedError.new("You must implement minimum method.")
+      end
+    end
+  end
+end

data/lib/valle/abstract_adapter/byte_limited_column.rb

@@ -0,0 +1,26 @@
+module Valle
+  module AbstractAdapter
+    class ByteLimitedColumn < AbstractColumn
+
+      def maximum
+        case limit
+        when 1; 127
+        when 2; 32767
+        when 3; 8388607
+        when 4; 2147483647
+        when 8; 9223372036854775807
+        end
+      end
+
+      def minimum
+        case limit
+        when 1; -128
+        when 2; -32768
+        when 3; -8388608
+        when 4; -2147483648
+        when 8; -9223372036854775808
+        end
+      end
+    end
+  end
+end

data/lib/valle/abstract_adapter/character_limited_column.rb

@@ -0,0 +1,14 @@
+module Valle
+  module AbstractAdapter
+    class CharacterLimitedColumn < AbstractColumn
+
+      def maximum
+        limit
+      end
+
+      def minimum
+        nil
+      end
+    end
+  end
+end

data/lib/valle/abstract_adapter/column_wrapper.rb

@@ -0,0 +1,55 @@
+module Valle
+  module AbstractAdapter
+    class ColumnWrapper
+
+      class << self
+
+        ##
+        # Wraps original column
+        #
+        # @param [ActiveRecord::ConnectionAdapters::Column] original_column the original column
+        #
+        def wrap(original_column)
+          case
+          when limit_in_bytes?(original_column)
+            ByteLimitedColumn.new(original_column)
+          when limit_in_characters?(original_column)
+            CharacterLimitedColumn.new(original_column)
+          else
+            UnlimitedColumn.new(original_column)
+          end
+        end
+
+        private
+
+        ##
+        # Determines whether the limit's method returned value is count of bytes
+        #
+        # Limit is number of bytes for :binary and :integer columns.
+        # @see http://apidock.com/rails/ActiveRecord/ConnectionAdapters/TableDefinition/column
+        #
+        def limit_in_bytes?(column)
+          case column.type
+          # when :binary; true
+          when :integer; true
+          else false
+          end
+        end
+
+        ##
+        # Determines whether the limit's method returned value is count of characters
+        #
+        # Limit is number of characters for :string and :text columns
+        # @see http://apidock.com/rails/ActiveRecord/ConnectionAdapters/TableDefinition/column
+        #
+        def limit_in_characters?(column)
+          case column.type
+          when :string; true
+          when :text; true
+          else false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/valle/abstract_adapter/unlimited_column.rb

@@ -0,0 +1,12 @@
+module Valle
+  module AbstractAdapter
+    class UnlimitedColumn < AbstractColumn
+
+      def maximum
+      end
+
+      def minimum
+      end
+    end
+  end
+end

data/lib/valle/bounds_manager.rb

@@ -6,19 +6,13 @@ module Valle
       ##
       # Add validators for all columns of a given class
       #
-      # 2 steps:
-      #   1) get bound for the column
-      #   2) set validation
-      #
       # @param [ActiveRecord::Base] klass the AR model class
       #
       def add_validators(klass)
-        mapper = BoundMapper.new
-
         columns = klass.columns
-        columns.each do |column|
-          bound = mapper.bound(column)
-          ValidationSetter.add_validator(bound, column, klass)
+        columns.each do |original_column|
+          column = AbstractAdapter::ColumnWrapper.wrap(original_column)
+          ValidationSetter.add_validator(column, klass)
         end
       end
     end

data/lib/valle/hooks.rb

@@ -3,17 +3,51 @@ module Valle
 
     class << self
 
+      ##
+      # Runs all the hooks, required for this gem
+      #
       def init
         ActiveSupport.on_load(:active_record) do
-          ActiveRecord::Base.class_eval do
-            # TODO [AK 09/12/12] possible we should run it after the class was inherited
-            # @see http://stackoverflow.com/q/7093992/820520
-            def self.inherited(subclass)
-              Valle::BoundsManager.add_validators(subclass)
+          Valle::Hooks.extend_inherited_method
+        end
+      end
+
+      ##
+      # Extends the functionality of inherited method
+      #
+      def extend_inherited_method
+        ActiveRecord::Base.class_eval do
+          class << self
+            def inherited_with_valle_validators(subclass)
+              inherited_without_valle_validators(subclass)
+              Valle::Hooks.extend_ar_validations_valid_method(subclass)
             end
+
+            alias_method_chain :inherited, :valle_validators
           end
         end
       end
+
+      ##
+      # Extends the functionality of ActiveRecord::Validations valid? method
+      #
+      # @param [ActiveRecord::Base] subclass the AR::Base child class
+      # @note ActiveRecord::Validations should be defined at this point
+      #
+      def extend_ar_validations_valid_method(subclass)
+        subclass.instance_eval do
+          cattr_accessor :valle_validators
+        end
+
+        subclass.class_eval do
+          def valid_with_valle_validators?(context = nil)
+            self.class.valle_validators ||= Valle::BoundsManager.add_validators(self.class)
+            valid_without_valle_validators?(context)
+          end
+
+          alias_method_chain :valid?, :valle_validators
+        end
+      end
     end
   end
 end

data/lib/valle/validation_setter.rb

@@ -5,14 +5,20 @@ module Valle
       ##
       # Adds validator to the klass column depending on its type
       #
-      # @param [Bound] bound the bound
-      # @param [Column] column the column
+      # @param [AbstractAdapter::AbstractColumn] column the column
       # @param [ActiveRecord::Base] klass the AR model class
       #
-      def add_validator(bound, column, klass)
+      def add_validator(column, klass)
+        options = {}
+        options[:minimum] = column.minimum if column.minimum
+        options[:maximum] = column.maximum if column.maximum
+        return false unless options.present?
+
         case column.type
-        when :string
-          klass.validates column.name, length: { maximum: bound.maximum }
+        when :string, :text
+          klass.validates column.name, length: options
+        when :integer
+          klass.validates column.name, numericality: options
         end
       end
     end

data/lib/valle/version.rb

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

data/test/lib/abstract_adapter/character_limited_column_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class CharacterLimitedColumnTest < TestCase
+
+  def test_maximum_should_return_value_for_string_column
+    original_column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "", "string(255)")
+    column = Valle::AbstractAdapter::CharacterLimitedColumn.new(original_column)
+
+    assert column.maximum
+  end
+
+  def test_maximum_should_return_correct_value_for_string_column_if_user_redefine_limit
+    original_column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "", "string(200)")
+    column = Valle::AbstractAdapter::CharacterLimitedColumn.new(original_column)
+
+    assert_equal 200, column.maximum
+  end
+
+  def test_minimum_should_return_nil
+    original_column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "", "string")
+    column = Valle::AbstractAdapter::CharacterLimitedColumn.new(original_column)
+
+    assert_nil column.minimum
+  end
+end

data/test/lib/abstract_adapter/column_wrapper_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+require "active_record"
+
+class ColumnWrapperTest < TestCase
+
+  def test_wrap_should_return_instance_of_character_limited_column_for_string_column
+    column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "", "string")
+    wrapped_column = Valle::AbstractAdapter::ColumnWrapper.wrap(column)
+
+    assert wrapped_column.is_a?(Valle::AbstractAdapter::CharacterLimitedColumn)
+  end
+
+  def test_wrap_should_return_instance_of_byte_limited_column_for_int_column
+    column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "", "int")
+    wrapped_column = Valle::AbstractAdapter::ColumnWrapper.wrap(column)
+
+    assert wrapped_column.is_a?(Valle::AbstractAdapter::ByteLimitedColumn)
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,8 @@
 require 'bundler/setup'
 Bundler.require
 
+require "active_record"
+
 MiniTest::Unit.autorun
 
 class TestCase < MiniTest::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,6 +53,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -62,15 +63,19 @@ files:
 - features/step_definitions/rails_steps.rb
 - features/support/env.rb
 - lib/valle.rb
-- lib/valle/bound_mapper.rb
+- lib/valle/abstract_adapter/abstract_column.rb
+- lib/valle/abstract_adapter/byte_limited_column.rb
+- 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/engine.rb
 - lib/valle/hooks.rb
 - lib/valle/railtie.rb
 - lib/valle/validation_setter.rb
 - lib/valle/version.rb
-- test/lib/bound_mapper_test.rb
+- test/lib/abstract_adapter/character_limited_column_test.rb
+- test/lib/abstract_adapter/column_wrapper_test.rb
 - test/test_helper.rb
 - valle.gemspec
 homepage: http://github.com/kaize/valle
@@ -87,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1528972839465003213
+      hash: 1761133230881238709
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1528972839465003213
+      hash: 1761133230881238709
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -108,5 +113,6 @@ test_files:
 - features/adds_validators.feature
 - features/step_definitions/rails_steps.rb
 - features/support/env.rb
-- test/lib/bound_mapper_test.rb
+- test/lib/abstract_adapter/character_limited_column_test.rb
+- test/lib/abstract_adapter/column_wrapper_test.rb
 - test/test_helper.rb

data/lib/valle/bound_mapper.rb

@@ -1,36 +0,0 @@
-module Valle
-
-  Bound = Struct.new :minimum, :maximum
-
-  class BoundMapper
-
-    ##
-    # Returns a new bound for the column
-    #
-    # @param [Column] column the column
-    #
-    def bound(column)
-      Bound.new minimum(column), maximum(column)
-    end
-
-    private
-
-    ##
-    # Get the lower limit for a given column
-    #
-    # @param [Column] column the column
-    #
-    def minimum(column)
-
-    end
-
-    ##
-    # Get the upper limit for a given column
-    #
-    # @param [Column] column the column
-    #
-    def maximum(column)
-      column.limit
-    end
-  end
-end

data/lib/valle/engine.rb

@@ -1,4 +0,0 @@
-module Valle#:nodoc:
-  class Engine < ::Rails::Engine #:nodoc:
-  end
-end

data/test/lib/bound_mapper_test.rb

@@ -1,21 +0,0 @@
-require "test_helper"
-require "active_record"
-
-class BoundMapperTest < TestCase
-
-  def setup
-    @bound_mapper = Valle::BoundMapper.new
-  end
-
-  def test_should_return_bound
-    column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "")
-    assert @bound_mapper.bound(column), "Bound for column '#{column.name}' not found"
-  end
-
-  def test_should_return_maximum_for_column_with_type_string
-    column = ::ActiveRecord::ConnectionAdapters::Column.new("test_column", "", "string(255)")
-    bound = @bound_mapper.bound(column)
-
-    assert_equal 255, bound.maximum
-  end
-end