valhammer 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5cc152c6e61d42ceb78240e85b5c864341736ad
-  data.tar.gz: 1eb227b60d2c901dbb84105774725419574a7167
+  metadata.gz: 758eec1c687a507398055fdb46d849004962b1b6
+  data.tar.gz: bda97ef82eb60f40da4789514710c122897a35ab
 SHA512:
-  metadata.gz: f285efa488450a71180ea6c9065c79c120a1c005a51a7c3640e9566c79ad10428d76b1af4e88fb58d3a1b64b9f5fdf88168a7c4dcdff3f0c47c2fb854aa01772
-  data.tar.gz: b495dc9987aa836118f8eb062a0c2d7ed3079be5640c5e372520af8e99aab2225fe5adc2231b92133b54aa4be115dd377033975f60c148c1dbf9d859f0883a55
+  metadata.gz: 6a8dc0e51c7b2ebb78fc0a6536be61a49a7b66257807f6dd901e28736631b755c7fdebd4639d350780862af0f8de2fce2846b7a1e55566b435aaee018e1c83a7
+  data.tar.gz: af035d6d7dab4931dbbabe1fa1602b30fd98610e90b2ec46f8a631749b4ae734caf1774afec8f7f57f495602a6c68a1a534ca7d7aa5466713303630c06a42c89

data/.simplecov

@@ -1,6 +1,4 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
-
+SimpleCov.command_name 'rspec'
 SimpleCov.start do
   add_filter('spec')
 end

data/README.md

@@ -82,13 +82,40 @@ Generated validations are:
 * `:length` — added to `string` columns to ensure the value fits in the
   column
 
-To disable a kind of validation, pass an option to the `valhammer` method:
+### Disabling Validators
+
+Passing a block to `valhammer` allows some selective calls to `disable` to
+customise the validators which are applied to your model:
+
+```ruby
+class Widget < ActiveRecord::Base
+  valhammer do
+    disable item_code: [:presence, :uniqueness]
+  end
+end
+```
+
+Disabling an attribute instructs Valhammer not to apply *any* validators for
+that attribute:
+
+```ruby
+class Widget < ActiveRecord::Base
+  valhammer do
+    disable :supplier_code
+  end
+end
+```
+
+When disabling validations for an association, disable the validations on the
+**association name**, not the name of the foreign key column:
 
 ```ruby
 class Widget < ActiveRecord::Base
   belongs_to :supplier
 
-  valhammer uniqueness: false
+  valhammer do
+    disable supplier: :presence
+  end
 end
 ```
 

data/lib/valhammer/validations.rb

@@ -1,37 +1,68 @@
 module Valhammer
   module Validations
-    VALHAMMER_DEFAULT_OPTS = { presence: true, uniqueness: true,
-                               numericality: true, length: true,
-                               inclusion: true }.freeze
+    class DisabledFieldConfig
+      def self.perform(&bl)
+        new.tap { |obj| obj.instance_eval(&bl) if block_given? }.to_opts
+      end
+
+      def initialize
+        @disabled_validations = {}
+      end
+
+      ALL = %i(presence uniqueness inclusion length numericality).freeze
+
+      def disable(opts)
+        opts = { opts => ALL } if opts.is_a?(Symbol)
+
+        opts.each do |k, v|
+          @disabled_validations[k] ||= []
+          @disabled_validations[k] += Array(v)
+        end
+      end
+
+      def to_opts
+        @disabled_validations.stringify_keys.transform_values do |v|
+          Hash[v.zip(Array.new(v.length, false))]
+        end
+      end
+    end
 
     VALHAMMER_EXCLUDED_FIELDS = %w(created_at updated_at).freeze
 
-    private_constant :VALHAMMER_DEFAULT_OPTS, :VALHAMMER_EXCLUDED_FIELDS
+    private_constant :VALHAMMER_EXCLUDED_FIELDS, :DisabledFieldConfig
 
-    def valhammer(opts = {})
+    def valhammer(&bl)
       @valhammer_indexes = connection.indexes(table_name)
-      opts = VALHAMMER_DEFAULT_OPTS.merge(opts)
+      config = DisabledFieldConfig.perform(&bl)
+
       columns_hash.each do |name, column|
-        valhammer_validate(name, column, opts)
+        valhammer_validate(name, column, config)
       end
     end
 
     private
 
-    def valhammer_validate(name, column, opts)
+    def valhammer_validate(name, column, config)
       return if valhammer_exclude?(name)
 
       assoc_name = valhammer_assoc_name(name)
-      if assoc_name.nil?
-        validations = valhammer_validations(column, opts)
-        validates(name, validations) unless validations.empty?
-        return
-      end
+      return valhammer_validate_assoc(assoc_name, column, config) if assoc_name
 
+      opts = valhammer_field_config(config, name)
+      validations = valhammer_validations(column, opts)
+      validates(name, validations) unless validations.empty?
+    end
+
+    def valhammer_validate_assoc(assoc_name, column, config)
+      opts = valhammer_field_config(config, assoc_name)
       return if column.null || !opts[:presence]
       validates(assoc_name, presence: true)
     end
 
+    def valhammer_field_config(config, field)
+      Hash.new(true).merge(config[field.to_s] || {})
+    end
+
     def valhammer_validations(column, opts)
       logger.debug("Valhammer generating options for #{valhammer_info(column)}")
 
@@ -66,7 +97,6 @@ module Valhammer
       return unless unique_keys.one?
 
       scope = unique_keys.first.columns[0..-2]
-
       validations[:uniqueness] = valhammer_unique_opts(scope)
     end
 
@@ -80,9 +110,7 @@ module Valhammer
     end
 
     def valhammer_numeric(validations, column, opts)
-      return unless opts[:numericality]
-
-      return if defined_enums.key?(column.name)
+      return if !opts[:numericality] || defined_enums.key?(column.name)
 
       case column.type
       when :integer
@@ -96,7 +124,6 @@ module Valhammer
 
     def valhammer_length(validations, column, opts)
       return unless opts[:length] && column.type == :string && column.limit
-
       validations[:length] = { maximum: column.limit }
     end
 

data/lib/valhammer/version.rb

@@ -1,3 +1,3 @@
 module Valhammer
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/spec/db/schema.rb

@@ -4,7 +4,7 @@ ActiveRecord::Schema.define(version: 0) do
 
     t.string :name, null: false, default: nil, limit: 100
     t.string :mail, null: false, default: nil
-    t.string :identifier, null: false, default: nil
+    t.string :identifier, null: false, default: nil, limit: 100
     t.string :description, null: true, default: nil
     t.integer :age, null: true, default: nil
     t.decimal :gpa, null: false, default: 3.0

data/spec/lib/valhammer/validations_spec.rb

@@ -180,77 +180,114 @@ RSpec.describe Valhammer::Validations do
     it { is_expected.to include(a_validator_for(:name, :length, maximum: 100)) }
   end
 
-  context 'with disabled validations' do
-    around do |example|
-      old = ActiveRecord::Base.logger
-
-      begin
-        ActiveRecord::Base.logger = Logger.new('/dev/null')
-        example.run
-      ensure
-        ActiveRecord::Base.logger = old
-      end
-    end
-
+  context 'when passing a block' do
     let(:klass) do
-      opts = { disabled_validator => false }
+      opts = disable_opts
+
       Class.new(ActiveRecord::Base) do
         self.table_name = 'resources'
 
         belongs_to :organisation
 
-        valhammer(opts)
+        valhammer do
+          disable opts
+        end
       end
     end
 
     subject { klass.validators }
 
-    context ':presence' do
-      let(:disabled_validator) { :presence }
+    context 'disabling an attribute' do
+      let(:disable_opts) { :name }
+
+      it 'excludes all validators for the field' do
+        [:presence, :length, :uniqueness].each do |v|
+          expect(subject).not_to include(a_validator_for(:name, v))
+        end
+      end
+    end
+
+    context 'disabling a presence validator' do
+      let(:disable_opts) { { name: :presence } }
+
+      it 'excludes the disabled validator' do
+        expect(subject).not_to include(a_validator_for(:name, :presence))
+      end
 
-      it 'excludes the presence validator' do
+      it 'includes other validators of the same type' do
+        expect(subject).to include(a_validator_for(:mail, :presence))
+      end
+
+      it 'includes other validators for the same field' do
         expect(subject)
-          .to not_include(a_validator_for(:name, :presence))
-          .and not_include(a_validator_for(:mail, :presence))
-          .and not_include(a_validator_for(:identifier, :presence))
-          .and not_include(a_validator_for(:gpa, :presence))
-          .and not_include(a_validator_for(:organisation, :presence))
+          .to include(a_validator_for(:name, :length, maximum: 100))
       end
     end
 
-    context ':inclusion' do
-      let(:disabled_validator) { :inclusion }
+    context 'disabling a presence validator for an association' do
+      let(:disable_opts) { { organisation: :presence } }
 
-      it 'excludes the inclusion validator' do
+      it 'excludes the disabled validator' do
         expect(subject)
-          .not_to include(a_validator_for(:injected, :inclusion))
+          .not_to include(a_validator_for(:organisation, :presence))
+      end
+    end
+
+    context 'disabling an inclusion validator' do
+      let(:disable_opts) { { injected: :inclusion } }
+
+      it 'excludes the disabled validator' do
+        expect(subject).not_to include(a_validator_for(:injected, :inclusion))
       end
     end
 
-    context ':uniqueness' do
-      let(:disabled_validator) { :uniqueness }
+    context 'disabling a uniqueness validator' do
+      let(:disable_opts) { { identifier: :uniqueness } }
 
-      it 'excludes the uniqueness validator' do
+      it 'excludes the disabled validator' do
         expect(subject)
           .not_to include(a_validator_for(:identifier, :uniqueness))
       end
+
+      it 'includes other validators of the same type' do
+        expect(subject).to include(a_validator_for(:name, :uniqueness))
+      end
+
+      it 'includes other validators for the same field' do
+        expect(subject).to include(a_validator_for(:identifier, :presence))
+      end
     end
 
-    context ':numericality' do
-      let(:disabled_validator) { :numericality }
+    context 'disabling a numericality validator' do
+      let(:disable_opts) { { gpa: :numericality } }
+
+      it 'excludes the disabled validator' do
+        expect(subject).not_to include(a_validator_for(:gpa, :numericality))
+      end
+
+      it 'includes other validators of the same type' do
+        expect(subject).to include(a_validator_for(:age, :numericality))
+      end
 
-      it 'excludes the numericality validator' do
-        expect(subject).to not_include(a_validator_for(:age, :numericality))
-          .and not_include(a_validator_for(:gpa, :numericality))
+      it 'includes other validators for the same field' do
+        expect(subject).to include(a_validator_for(:gpa, :presence))
       end
     end
 
-    context ':length' do
-      let(:disabled_validator) { :length }
+    context 'disabling a length validator' do
+      let(:disable_opts) { { name: :length } }
 
-      it 'excludes the length validator' do
+      it 'excludes the disabled validator' do
         expect(subject).not_to include(a_validator_for(:name, :length))
       end
+
+      it 'includes other validators of the same type' do
+        expect(subject).to include(a_validator_for(:identifier, :length))
+      end
+
+      it 'includes other validators for the same field' do
+        expect(subject).to include(a_validator_for(:name, :presence))
+      end
     end
   end
 

data/valhammer.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activerecord', '> 4.1'
+  spec.add_dependency 'activesupport', '> 4.1'
 
   spec.add_development_dependency 'rails', '> 4.1'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valhammer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Shaun Mangelsdorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement