valhammer 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ea291bcc9bb1f0c3931b9f5f83b8837f75be21e
-  data.tar.gz: 508cdc21ee92a31b986f5dbc9c6d449f5948355a
+  metadata.gz: a17bafd0cee09ccf70430c604c381aa2cf9bcd1d
+  data.tar.gz: 1104fae993e967539bf5f96eb2f2b917cfe9fc9f
 SHA512:
-  metadata.gz: 15ccdb15b5890eecf69712db5dd761562389294bbb18eee58aaf76f5a15a7b6ffb73fe50c21fe89974c13ed4e5493f8ceb736c03fc351e34806b6a2f525df9d3
-  data.tar.gz: e73bcfc221876e783226d08f9ce828ccb15783b4147df604f89c3259ed9d8f279d54f4b0716f7076c0cce20274d4436f9434f08d3eaf47ec1305728ce2fb1545
+  metadata.gz: e48594d0e505482ab9a8915c7336890351e245dd97ba4849ddcf604ae836ef3421b07985a93338d984ba21475064332b3c0008a739b3b515ed360fdf8344fb55
+  data.tar.gz: 75fc238355ba8e2338af112a085f340f427c32c8a0e0b9bfea5fcdc0d89369694d426d15b45055620e2600a7efc9ca5a38e08a683a74b0b94cc09ba948002910

data/.simplecov

@@ -1,9 +1,5 @@
-require 'coveralls'
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 
 SimpleCov.start do
   add_filter('spec')

data/README.md

@@ -4,19 +4,18 @@
 [![Build Status][BS img]][Build Status]
 [![Dependency Status][DS img]][Dependency Status]
 [![Code Climate][CC img]][Code Climate]
-[![Coverage Status][CS img]][Coverage Status]
+[![Coverage Status][CS img]][Code Climate]
 
 [Gem Version]: https://rubygems.org/gems/valhammer
-[Build Status]: https://travis-ci.org/ausaccessfed/valhammer
+[Build Status]: https://codeship.com/projects/91215
 [Dependency Status]: https://gemnasium.com/ausaccessfed/valhammer
 [Code Climate]: https://codeclimate.com/github/ausaccessfed/valhammer
-[Coverage Status]: https://coveralls.io/r/ausaccessfed/valhammer
 
 [GV img]: https://img.shields.io/gem/v/valhammer.svg
-[BS img]: https://img.shields.io/travis/ausaccessfed/valhammer/develop.svg
+[BS img]: https://img.shields.io/codeship/eb0d3cd0-0cd1-0133-3c85-7aae0ba3591b/develop.svg
 [DS img]: https://img.shields.io/gemnasium/ausaccessfed/valhammer.svg
 [CC img]: https://img.shields.io/codeclimate/github/ausaccessfed/valhammer.svg
-[CS img]: https://img.shields.io/coveralls/ausaccessfed/valhammer.svg
+[CS img]: https://img.shields.io/codeclimate/coverage/github/ausaccessfed/valhammer.svg
 
 Automatically validate ActiveRecord models based on the database schema.
 
@@ -119,6 +118,39 @@ end
 That is, the last column in the key is the field which gets validated, and the
 other columns form the `scope` argument.
 
+If any of the scope columns are nullable, the validation will be conditional on
+the presence of the scope values. This avoids the situation where your
+underlying database would accept a row (because it considers `NULL` values not
+equal to each other, which is true of [SQLite][sqlite-null-index],
+[PostgreSQL][postgres-null-index] and [MySQL/MariaDB][mysql-null-index] at the
+least.)
+
+If the above example table had nullable columns, for example:
+
+```ruby
+create_table(:widgets) do |t|
+  t.string :supplier_code, null: true, default: nil
+  t.string :item_code, null: true, default: nil
+
+  t.index [:supplier_code, :item_code], unique: true
+end
+```
+
+This amended table structure causes Valhammer to create validations as though
+you had written:
+
+```ruby
+class Widget < ActiveRecord::Base
+  validates :item_code, uniqueness: { scope: :supplier_code,
+                                      if: -> { supplier_code },
+                                      allow_nil: true }
+end
+```
+
+[sqlite-null-index]: https://www.sqlite.org/lang_createindex.html
+[postgres-null-index]: http://www.postgresql.org/docs/9.0/static/indexes-unique.html
+[mysql-null-index]: https://dev.mysql.com/doc/refman/5.0/en/create-index.html
+
 ## Duplicate Unique Keys
 
 Valhammer is able to handle the simple case when multiple unique keys reference
@@ -184,6 +216,24 @@ anyway, if it means your association queries benefit from the index).
 
 Alternatively, apply the validation yourself using ActiveRecord.
 
+## Partial Unique Keys
+
+When a unique key is partially applied to a relation, that key will not be given
+a uniqueness validation.
+
+```ruby
+create_table(:widgets) do |t|
+  t.string :supplier_code, null: true, default: nil
+  t.string :item_code, null: true, default: nil
+
+  t.index [:supplier_code, :item_code], unique: true,
+                                        where: 'item_code LIKE "a%"'
+end
+```
+
+In this case, it is not possible for valhammer to determine the behaviour of the
+`where` clause, so the validation must be manually created.
+
 ## Contributing
 
 Refer to [GitHub Flow](https://guides.github.com/introduction/flow/) for

data/lib/valhammer/validations.rb

@@ -62,16 +62,21 @@ module Valhammer
     def valhammer_unique(validations, column, opts)
       return unless opts[:uniqueness]
 
-      unique_keys = @valhammer_indexes.select do |i|
-        i.unique && i.columns.last == column.name
-      end
-
+      unique_keys = valhammer_unique_keys(column)
       return unless unique_keys.one?
 
       scope = unique_keys.first.columns[0..-2]
 
-      opts = validations[:uniqueness] = { allow_nil: true }
+      validations[:uniqueness] = valhammer_unique_opts(scope)
+    end
+
+    def valhammer_unique_opts(scope)
+      nullable = scope.select { |c| columns_hash[c].null }
+
+      opts = { allow_nil: true }
       opts[:scope] = scope if scope.any?
+      opts[:if] = -> { nullable.all? { |c| send(c) } } if nullable.any?
+      opts
     end
 
     def valhammer_numeric(validations, column, opts)
@@ -108,6 +113,12 @@ module Valhammer
       field == primary_key || VALHAMMER_EXCLUDED_FIELDS.include?(field)
     end
 
+    def valhammer_unique_keys(column)
+      @valhammer_indexes.select do |i|
+        i.unique && !i.where && i.columns.last == column.name
+      end
+    end
+
     def valhammer_assoc_name(field)
       reflect_on_all_associations(:belongs_to)
         .find { |a| a.foreign_key == field }.try(:name)

data/lib/valhammer/version.rb

@@ -1,3 +1,3 @@
 module Valhammer
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/spec/db/schema.rb

@@ -15,17 +15,20 @@ ActiveRecord::Schema.define(version: 0) do
     t.timestamps null: false
 
     t.index :identifier, unique: true
+    t.index [:organisation_id, :name], unique: true
   end
 
   create_table :capabilities, force: true do |t|
     t.belongs_to :organisation, null: true, default: nil
 
     t.string :name, null: false, default: nil
+    t.string :identifier, null: false, default: nil
     t.boolean :core, null: true, default: nil
 
     t.timestamps null: false
 
     t.index [:organisation_id, :name], unique: true
+    t.index :identifier, unique: true, where: 'organisation_id IS NULL'
   end
 
   create_table :organisations, force: true do |t|

data/spec/dummy/config.ru

@@ -1,2 +1,2 @@
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/spec/lib/valhammer/validations_spec.rb

@@ -1,4 +1,11 @@
 RSpec.describe Valhammer::Validations do
+  around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      fail(ActiveRecord::Rollback)
+    end
+  end
+
   def validation_impl(kind)
     name = "#{kind.to_s.camelize}Validator"
 
@@ -10,8 +17,11 @@ RSpec.describe Valhammer::Validations do
   end
 
   RSpec::Matchers.define :a_validator_for do |field, kind, opts = nil|
+    include RSpec::Matchers::Composable
+
     match do |v|
-      v.is_a?(validation_impl(kind)) && (opts.nil? || v.options == opts) &&
+      v.is_a?(validation_impl(kind)) &&
+        (opts.nil? || values_match?(opts, v.options)) &&
         v.attributes.map(&:to_s) == [field.to_s]
     end
 
@@ -85,13 +95,46 @@ RSpec.describe Valhammer::Validations do
     it { is_expected.not_to include(a_validator_for(:mail, :uniqueness)) }
   end
 
-  context 'with a composite unique index' do
+  context 'with a partial unique index' do
     subject { Capability.validators }
 
+    it { is_expected.not_to include(a_validator_for(:identifier, :uniqueness)) }
+  end
+
+  context 'with a composite unique index' do
     let(:opts) do
       { scope: ['organisation_id'], case_sensitive: true, allow_nil: true }
     end
+
+    it { is_expected.to include(a_validator_for(:name, :uniqueness, opts)) }
+  end
+
+  context 'with a composite unique index with nullable scope column' do
+    subject { Capability.validators }
+
+    let(:opts) do
+      { scope: ['organisation_id'], case_sensitive: true, allow_nil: true,
+        if: an_instance_of(Proc) }
+    end
+
     it { is_expected.to include(a_validator_for(:name, :uniqueness, opts)) }
+
+    it 'skips validation when the nullable scope column is null' do
+      o = Organisation.create!(country: 'Australia', city: 'Brisbane',
+                               name: 'Test Organisation')
+
+      attrs = { organisation_id: o.id, name: 'Software Development',
+                identifier: SecureRandom.urlsafe_base64 }
+
+      Capability.create!(attrs)
+
+      attrs[:identifier] = SecureRandom.urlsafe_base64
+      Capability.create!(attrs.merge(organisation_id: nil))
+
+      attrs[:identifier] = SecureRandom.urlsafe_base64
+      expect(Capability.new(attrs.merge(organisation_id: nil))).to be_valid
+      expect(Capability.new(attrs)).not_to be_valid
+    end
   end
 
   context 'with duplicate unique indexes' do
@@ -205,13 +248,6 @@ RSpec.describe Valhammer::Validations do
   end
 
   context 'sanity check' do
-    around do |example|
-      ActiveRecord::Base.transaction do
-        example.run
-        fail(ActiveRecord::Rollback)
-      end
-    end
-
     let(:organisation) do
       Organisation.create!(name: 'Enhanced Collaborative Methodologies Pty Ltd',
                            country: 'Australia', city: 'Brisbane')
@@ -231,7 +267,7 @@ RSpec.describe Valhammer::Validations do
     context Capability do
       subject do
         Capability.create!(organisation: organisation, core: true,
-                           name: 'Project Management')
+                           name: 'Project Management', identifier: 'pm')
       end
 
       it { is_expected.to be_valid }

data/valhammer.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rails', '~> 4.1'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.34'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-bundler'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valhammer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Shaun Mangelsdorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -175,7 +189,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.1
-branches:
-  only:
-    - master
-    - develop