validates_type 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e375accce8736d3c0507854a2376f120bef33ad
-  data.tar.gz: c87bdb0cc929a00367e84107f4179fb966ea3e8e
+  metadata.gz: 4eaad53649c687b0db1d873919a5e0d3977abfc1
+  data.tar.gz: 216e38fc24aed68917f29979875fc0518bbaa5f2
 SHA512:
-  metadata.gz: 1ead0fd0a56040f24f0cd22fb00aef94a2a147d69b7d36aa72bff418a2c277c893bff23bf31a42277ca131aecbb7eaebc9fd2dfc11cddb42904fc9ad80ceb12a
-  data.tar.gz: ff938b6e88cf84482e361fa5c658ce1c11c662a56051d25856531e3bf391594aa473387323f6a3d846f5730ec5d0970ecdc42d46e4a640ea768903f1ea802b21
+  metadata.gz: 0d3d79da0e73d4a8a37abb36ea65c5e936e862a655faf280a95233d50f5f61759c6214cd8d935214b62fe4ab334cc548ba5db878a47381c73a8a12f477f002e0
+  data.tar.gz: 517ec6573c60bfe54372fec7c9f9681ec9735b63eb5955ad6df79510d7fbdceba22a96a21a0e781a64a031cc5f3f6efeaa43a47d01eb2bbb2345d7a8073115dc

data/.gitignore

@@ -1,2 +1,4 @@
 .ruby*
 *.gem
+.bundle
+.idea

data/README.md

@@ -37,6 +37,9 @@ class Foo < ActiveRecord::Base
 
   # validate that attribute :birthday is a Date or blank
   validates_type :birthday, :date, allow_blank: true
+
+  # validate that attribute :fox is of type Custom
+  validates_type :fox, Custom
 end
 ```
 
@@ -98,4 +101,4 @@ end
 - `:symbol`
 - `:time`
 
-
+#### Any class name, possibly something custom defined in your app, is also game.

data/lib/validates_type.rb

@@ -16,7 +16,7 @@ module ActiveModel
       #   return: result of ActiveModel::Validations::EachValidator initialize
       def initialize(options)
         merged_options = {
-          :message => "is expected to be a #{ symbol_class(options[:type]) } and is not."
+          :message => "is expected to be a #{ type_class(options[:type]) } and is not."
         }.merge(options)
 
         super(merged_options)
@@ -31,7 +31,7 @@ module ActiveModel
       #   return: nil
       def validate_each(record, attribute, value)
         value_to_test = type_before_coercion(record, attribute, value)
-        expected_type = symbol_class(options[:type])
+        expected_type = type_class(options[:type])
 
         add_errors_or_raise(options, record, attribute) unless value_to_test.is_a?(expected_type)
       end
@@ -71,6 +71,21 @@ module ActiveModel
         end
       end
 
+      # Helper method to get back a class constant from the given type option
+      # If the type option is a class, it will be returned as is.
+      # If it is not a class, the method will try to convert it to a class constant.
+      #
+      # ex:
+      #   type_class(:string) -> String
+      #   type_class(String)  -> String
+      #   type_class(Custom)  -> Custom
+      # @type_class
+      #   param: type <Class, Symbol>
+      #   return: <Class> class constant
+      def type_class(type)
+        @type_class ||= type.is_a?(Class) ? type : symbol_class(type)
+      end
+
       # Helper method to convert a symbol into a class constant
       #
       # ex:
@@ -79,10 +94,10 @@ module ActiveModel
       #  symbol_class(:hash)    -> Hash
       #
       # @symbol_class
-      #   param: symbol <Symbol> - symbol to turn into a classconstant
+      #   param: symbol <Symbol> - symbol to turn into a class constant
       #   return: class constant of supported types or raises UnsupportedType
       def symbol_class(symbol)
-        @symbol_class ||= {
+        {
           :array       => Array,
           :boolean     => Boolean,
           :float       => Float,
@@ -122,20 +137,23 @@ module ActiveModel
       #   - :date
       #   - :big_decimal
       #
+      # Also validates the type of an attribute given a custom type class constant.
+      #
       # class Foo
       #   include ActiveModel::Validations
       #
-      #   attr_accessor :thing, :something
+      #   attr_accessor :thing, :something, :custom_thing
       #
       #   validates_type :thing, :boolean
       #   validates_type :something, :array
+      #   validates_type :custom_thing, Custom
       # end
       #
       # @validates_type
       #   param: attribute_name <Symbol> - name of attribute to validate
-      #   param: attribute_type <Symbol> - type of attribute to validate against
-      #   param: options <Hash>          - other common options to validate methods calls
-      #                                    i.e. message: 'my custom error message'
+      #   param: attribute_type <Symbol, Class> - type of attribute to validate against
+      #   param: options <Hash> - other common options to validate methods calls
+      #                           i.e. message: 'my custom error message'
       #   return: nil
       def validates_type(attribute_name, attribute_type, options = {})
         args = ValidatesType::Arguments.new(attribute_name, attribute_type, options)

data/spec/active_model/types_spec.rb

@@ -292,4 +292,35 @@ describe 'ValidatesType' do
       end
     end
   end
+
+  context 'custom class' do
+    class Custom; end
+    subject { ActiveModel::TypeValidationTestClass.set_accessor_and_long_validator(Custom) }
+
+    before do
+      subject.attribute = value
+    end
+
+    context 'field value is of type Custom' do
+      let(:value) { Custom.new }
+
+      specify do
+        expect(subject).to be_valid
+      end
+    end
+
+    context 'field value is not of type Custom' do
+      let(:value) { -1 }
+
+      specify do
+        expect(subject).to_not be_valid
+      end
+
+      specify do
+        subject.validate
+        expect(subject.errors).to_not be_empty
+        expect(subject.errors.messages[:attribute][0]).to match(/is expected to be a Custom and is not/)
+      end
+    end
+  end
 end

data/spec/active_model_helper.rb

@@ -12,14 +12,14 @@ module ActiveModel
     # end
     #
     # @set_accessor_and_long_validator
-    #   param: type <Symbol> - type which to validate against
+    #   param: type <Symbol, Class> - type which to validate against
     #   param: options<Hash *Optional*> - extra modifiers/custom messaging
     #   return: TypeValidationTestClass instance with set validator
     def self.set_accessor_and_long_validator(type, options = {})
       self.new.tap do |test_class|
         test_class._validators = {}
         test_class.class_eval { attr_accessor :attribute }
-        test_class.class_eval { validates_type :attribute, type.to_sym, options }
+        test_class.class_eval { validates_type :attribute, type, options }
       end
     end
 
@@ -33,7 +33,7 @@ module ActiveModel
     # end
     #
     # @set_accessor_and_long_validator
-    #   param: type <Symbol> - type which to validate against
+    #   param: type <Symbol, Class> - type which to validate against
     #   param: options<Hash *Optional*> - extra modifiers/custom messaging
     #   return: TypeValidationTestClass instance with set validator
     def self.set_accessor_and_validator(type, options = {})

data/spec/active_record_helper.rb

@@ -20,7 +20,7 @@ class TypeValidationTest < ActiveRecord::Base
   def self.set_accessor_and_long_validator(type, options = {})
     self.new.tap do |test_class|
       test_class._validators = {}
-      test_class.class_eval { validates_type :test_attribute, type.to_sym, options }
+      test_class.class_eval { validates_type :test_attribute, type, options }
     end
   end
 

data/spec/activerecord/types_spec.rb

@@ -385,4 +385,49 @@ describe 'ValidatesType' do
       end
     end
   end
+
+  context 'custom class' do
+    drop_and_create_column_with_type(:string)
+    class Custom; end
+    subject { TypeValidationTest.set_accessor_and_long_validator(Custom) }
+
+    before do
+      subject.test_attribute = value
+    end
+
+    context 'field value is of type Custom' do
+      let(:value) { Custom.new }
+
+      specify do
+        expect(subject).to be_valid
+      end
+    end
+
+    context 'field value is not of type Custom' do
+      let(:value) { -1 }
+
+      specify do
+        expect(subject).to_not be_valid
+      end
+
+      specify do
+        subject.validate
+        expect(subject.errors).to_not be_empty
+        expect(subject.errors.messages[:test_attribute][0]).to match(/is expected to be a Custom and is not/)
+      end
+    end
+
+    context 'passing in a custom message' do
+      subject { TypeValidationTest.set_accessor_and_long_validator(Custom, message: 'is not Custom!') }
+
+      context 'when validation fails' do
+        let(:value) { 1 }
+
+        specify do
+          subject.validate
+          expect(subject.errors.messages[:test_attribute][0]).to match(/is not Custom!/)
+        end
+      end
+    end
+  end
 end

data/version.rb

@@ -1,3 +1,3 @@
 module ValidatesType
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validates_type
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-16 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-boolean