valhammer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bbc167cf3bd0b5da8157c01558742ba809d6efb
+  data.tar.gz: 0e478898f5ce6d7f5338e03e0010d72179e4e06c
+SHA512:
+  metadata.gz: d166959c57a0f15af70b4cedf85c51a8a41f676bb9fb9f8e656c1d00b7816a1685cd6b540343dce5619ed7238a5b37a7550f10a6c39014c0aee7cc6f5d59f8ec
+  data.tar.gz: c135af6ebcfa1d6d9a1a8dca65f11f90ac37d6bff1ca0cf9deb223523f01a218af3244eebb706e42cb6390bf22675ed6d10ede83b6c0cb1cbe4594aded4e9570

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/db/*.sqlite3
+/spec/dummy/log/
+/log/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,10 @@
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter('spec')
+end

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valhammer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{spec/(db|dummy)/.*\.rb}) { 'spec' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,190 @@
+# Valhammer
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+
+[Gem Version]: https://rubygems.org/gems/valhammer
+[Build Status]: https://travis-ci.org/ausaccessfed/valhammer
+[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
+[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
+
+Automatically validate ActiveRecord models based on the database schema.
+
+Author: Shaun Mangelsdorf
+
+```
+Copyright 2015, Australian Access Federation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valhammer'
+```
+
+Use Bundler to install the dependency:
+
+```
+bundle install
+```
+
+In Rails, Valhammer is automatically added to `ActiveRecord::Base`. If you're
+using ActiveRecord outside of Rails, you may have to do this yourself:
+
+```ruby
+ActiveRecord::Base.extend(Valhammer::Validations)
+```
+
+## Usage
+
+Call the `valhammer` method inside your model class, after any `belongs_to`
+relationships are defined:
+
+```ruby
+class Widget < ActiveRecord::Base
+  belongs_to :supplier
+
+  valhammer
+end
+```
+
+Generated validations are:
+
+* `:presence` &mdash; added to non-nullable, non-boolean columns
+* `:inclusion` &mdash; added to boolean columns to emulate the functionality of
+  `presence` which doesn't work correctly for booleans
+* `:uniqueness` &mdash; added to match unique keys
+* `:numericality` &mdash; added to `integer`/`decimal` columns with the
+  `only_integer` option set appropriately
+* `:length` &mdash; 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:
+
+```ruby
+class Widget < ActiveRecord::Base
+  belongs_to :supplier
+
+  valhammer uniqueness: false
+end
+```
+
+## Composite Unique Keys
+
+When Valhammer encounters a composite unique key, it inspects the columns
+involved in the key and uses them to build a `scope`. For example:
+
+```ruby
+create_table(:widgets) do |t|
+  t.string :supplier_code, null: false, default: nil
+  t.string :item_code, null: false, default: nil
+
+  t.index [:supplier_code, :item_code], unique: true
+end
+```
+
+When this table is examined by Valhammer, the uniqueness validation created will
+be the same as if you had written:
+
+```ruby
+class Widget < ActiveRecord::Base
+  validates :item_code, uniqueness: { scope: :supplier_code }
+end
+```
+
+That is, the last column in the key is the field which gets validated, and the
+other columns form the `scope` argument.
+
+## Duplicate Unique Keys
+
+Valhammer is able to handle the simple case when multiple unique keys reference
+the same field, as in the following contrived example:
+
+```ruby
+create_table(:order_update) do |t|
+  t.belongs_to :order
+  t.string :state
+  t.string :identifier
+
+  t.index [:order_id, :state], unique: true
+  t.index [:order_id, :state, :identifier], unique: true
+end
+```
+
+Uniqueness validations are created as though the model was defined using:
+
+```ruby
+class OrderUpdate < ActiveRecord::Base
+  validates :state, uniqueness: { scope: :order_id }
+  validates :identifier, uniqueness: { scope: [:order_id, :state] }
+end
+```
+
+In the case where multiple unique keys have the same column in the last
+position, Valhammer is unable to determine which is the "authoritative" scope
+for the validation. Take the following contrived example:
+
+```ruby
+create_table(:order_enquiry) do |t|
+  t.belongs_to :order
+  t.belongs_to :customer
+  t.string :date
+
+  t.index [:order_id, :date], unique: true
+  t.index [:customer_id, :date], unique: true
+end
+```
+
+Valhammer is unable to resolve which `scope` to apply, so no `uniqueness`
+validation is applied.
+
+## Unique Keys and Associations
+
+In the case where a foreign key is the last column in a key, that key will not
+be given a uniqueness validation.
+
+```ruby
+create_table(:order_payment) do |t|
+  t.belongs_to :customer
+  t.string :reference
+  t.boolean :complete
+  t.integer :amount
+
+  t.index [:reference, :customer_id], unique: true
+end
+```
+
+To work around this, put associations first in your unique keys (often a
+[good idea](http://dev.mysql.com/doc/refman/5.6/en/multiple-column-indexes.html)
+anyway, if it means your association queries benefit from the index).
+
+Alternatively, apply the validation yourself using ActiveRecord.
+
+## Contributing
+
+Refer to [GitHub Flow](https://guides.github.com/introduction/flow/) for
+help contributing to this project.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/valhammer.rb

@@ -0,0 +1,7 @@
+require 'valhammer/version'
+
+module Valhammer
+end
+
+require 'valhammer/validations'
+require 'valhammer/railtie' if defined?(Rails::Railtie)

data/lib/valhammer/railtie.rb

@@ -0,0 +1,9 @@
+module Valhammer
+  class Railtie < ::Rails::Railtie
+    initializer 'valhammer.install' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.extend Valhammer::Validations
+      end
+    end
+  end
+end

data/lib/valhammer/validations.rb

@@ -0,0 +1,112 @@
+module Valhammer
+  module Validations
+    VALHAMMER_DEFAULT_OPTS = { presence: true, uniqueness: true,
+                               numericality: true, length: true,
+                               inclusion: true }.freeze
+
+    VALHAMMER_EXCLUDED_FIELDS = %w(created_at updated_at)
+
+    private_constant :VALHAMMER_DEFAULT_OPTS, :VALHAMMER_EXCLUDED_FIELDS
+
+    def valhammer(opts = {})
+      @valhammer_indexes ||= connection.indexes(table_name)
+      opts = VALHAMMER_DEFAULT_OPTS.merge(opts)
+      columns_hash.each do |name, column|
+        valhammer_validate(name, column, opts)
+      end
+    end
+
+    private
+
+    def valhammer_validate(name, column, opts)
+      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 if column.null || !opts[:presence]
+      validates(assoc_name, presence: true)
+    end
+
+    def valhammer_validations(column, opts)
+      logger.debug("Valhammer generating options for #{valhammer_info(column)}")
+
+      validations = {}
+      valhammer_presence(validations, column, opts)
+      valhammer_inclusion(validations, column, opts)
+      valhammer_unique(validations, column, opts)
+      valhammer_numeric(validations, column, opts)
+      valhammer_length(validations, column, opts)
+
+      logger.debug("Valhammer options for #{valhammer_log_key(column)} " \
+                   "are: #{validations.inspect}")
+      validations
+    end
+
+    def valhammer_presence(validations, column, opts)
+      return unless opts[:presence] && column.type != :boolean
+
+      validations[:presence] = true unless column.null
+    end
+
+    def valhammer_inclusion(validations, column, opts)
+      return unless opts[:inclusion] && column.type == :boolean
+
+      validations[:inclusion] = { in: [false, true], allow_nil: column.null }
+    end
+
+    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
+
+      return unless unique_keys.one?
+
+      scope = unique_keys.first.columns[0..-2]
+      validations[:uniqueness] = scope.empty? ? true : { scope: scope }
+    end
+
+    def valhammer_numeric(validations, column, opts)
+      return unless opts[:numericality]
+
+      case column.type
+      when :integer
+        validations[:numericality] = { only_integer: true,
+                                       allow_nil: column.null }
+      when :decimal
+        validations[:numericality] = { only_integer: false,
+                                       allow_nil: column.null }
+      end
+    end
+
+    def valhammer_length(validations, column, opts)
+      return unless opts[:length] && column.type == :string && column.limit
+
+      validations[:length] = { maximum: column.limit }
+    end
+
+    def valhammer_log_key(column)
+      "`#{table_name}`.`#{column.name}`"
+    end
+
+    def valhammer_info(column)
+      "#{valhammer_log_key(column)} (type=:#{column.type} " \
+        "null=#{column.null || 'false'} limit=#{column.limit || 'nil'})"
+    end
+
+    def valhammer_exclude?(field)
+      field == primary_key || VALHAMMER_EXCLUDED_FIELDS.include?(field)
+    end
+
+    def valhammer_assoc_name(field)
+      reflect_on_all_associations(:belongs_to)
+        .find { |a| a.foreign_key == field }.try(:name)
+    end
+  end
+end

data/lib/valhammer/version.rb

@@ -0,0 +1,3 @@
+module Valhammer
+  VERSION = '0.1.0'
+end

data/spec/db/schema.rb

@@ -0,0 +1,40 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table :resources, force: true do |t|
+    t.belongs_to :organisation, null: false, default: nil
+
+    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 :description, null: true, default: nil
+    t.integer :age, null: true, default: nil
+    t.decimal :gpa, null: false, default: 3.0
+    t.integer :socialness, null: false, default: 5
+    t.boolean :injected, null: false, default: false
+
+    t.timestamps null: false
+
+    t.index :identifier, 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.boolean :core, null: true, default: nil
+
+    t.timestamps null: false
+
+    t.index [:organisation_id, :name], unique: true
+  end
+
+  create_table :organisations, force: true do |t|
+    t.string :name, null: false
+    t.string :country, null: false
+    t.string :city, null: false
+
+    t.timestamps null: false
+
+    t.index [:country, :name], unique: true
+    t.index [:city, :name], unique: true
+  end
+end

data/spec/dummy/app/models/capability.rb

@@ -0,0 +1,5 @@
+class Capability < ActiveRecord::Base
+  belongs_to :organisation
+
+  valhammer
+end

data/spec/dummy/app/models/organisation.rb

@@ -0,0 +1,6 @@
+class Organisation < ActiveRecord::Base
+  has_many :resources
+  has_many :capabilities
+
+  valhammer
+end

data/spec/dummy/app/models/resource.rb

@@ -0,0 +1,5 @@
+class Resource < ActiveRecord::Base
+  belongs_to :organisation
+
+  valhammer
+end

data/spec/dummy/config.ru

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

data/spec/dummy/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'active_record/railtie'
+require 'valhammer'
+
+module Dummy
+  class Application < Rails::Application
+    config.cache_classes = true
+    config.eager_load = false
+
+    config.consider_all_requests_local = true
+    config.action_dispatch.show_exceptions = false
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,4 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  pool: 1
+  timeout: 5000
+  database: '../db/test.sqlite3'

data/spec/dummy/config/environment.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../application', __FILE__)
+Rails.application.initialize!

data/spec/dummy/config/secrets.yml

@@ -0,0 +1,2 @@
+test:
+  secret_key_base: 890f88caa9641d1845e85a49fd9aedbd30cf507f223dcb1cb6ccc53ba23731d

data/spec/lib/valhammer/validations_spec.rb

@@ -0,0 +1,233 @@
+RSpec.describe Valhammer::Validations do
+  def validation_impl(kind)
+    name = "#{kind.to_s.camelize}Validator"
+
+    if ActiveRecord::Validations.const_defined?(name)
+      ActiveRecord::Validations.const_get(name)
+    else
+      ActiveModel::Validations.const_get(name)
+    end
+  end
+
+  RSpec::Matchers.define :a_validator_for do |field, kind, opts = nil|
+    match do |v|
+      v.is_a?(validation_impl(kind)) && (opts.nil? || v.options == opts) &&
+        v.attributes.map(&:to_s) == [field.to_s]
+    end
+
+    description do
+      "a #{kind.inspect} validator for #{field.inspect}" \
+        "#{opts && " with options: #{opts.inspect}"}"
+    end
+  end
+
+  RSpec::Matchers.define_negated_matcher :not_include, :include
+
+  subject { Resource.validators }
+
+  context 'with non-nullable columns' do
+    it { is_expected.not_to include(a_validator_for(:id, :presence)) }
+    it { is_expected.not_to include(a_validator_for(:created_at, :presence)) }
+    it { is_expected.not_to include(a_validator_for(:updated_at, :presence)) }
+    it { is_expected.to include(a_validator_for(:name, :presence)) }
+    it { is_expected.to include(a_validator_for(:mail, :presence)) }
+    it { is_expected.to include(a_validator_for(:identifier, :presence)) }
+    it { is_expected.not_to include(a_validator_for(:description, :presence)) }
+    it { is_expected.to include(a_validator_for(:gpa, :presence)) }
+    it { is_expected.not_to include(a_validator_for(:injected, :presence)) }
+  end
+
+  context 'with a non-nullable boolean' do
+    let(:opts) { { in: [false, true], allow_nil: false } }
+
+    it { is_expected.to include(a_validator_for(:injected, :inclusion, opts)) }
+  end
+
+  context 'with a nullable boolean' do
+    subject { Capability.validators }
+    let(:opts) { { in: [false, true], allow_nil: true } }
+
+    it { is_expected.to include(a_validator_for(:core, :inclusion, opts)) }
+  end
+
+  context 'with a non-nullable association' do
+    it { is_expected.to include(a_validator_for(:organisation, :presence)) }
+
+    it 'excludes numericality validator' do
+      expect(subject)
+        .not_to include(a_validator_for(:organisation, :numericality))
+    end
+
+    it 'excludes validators on the foreign key' do
+      expect(subject)
+        .not_to include(a_validator_for(:organisation_id, :presence))
+      expect(subject)
+        .not_to include(a_validator_for(:organisation_id, :numericality))
+    end
+  end
+
+  context 'with a nullable association' do
+    subject { Capability.validators }
+
+    it { is_expected.not_to include(a_validator_for(:organisation, :presence)) }
+
+    it 'excludes validators on the foreign key' do
+      expect(subject)
+        .not_to include(a_validator_for(:organisation_id, :presence))
+      expect(subject)
+        .not_to include(a_validator_for(:organisation_id, :numericality))
+    end
+  end
+
+  context 'with a unique index' do
+    it { is_expected.not_to include(a_validator_for(:id, :uniqueness)) }
+    it { is_expected.to include(a_validator_for(:identifier, :uniqueness)) }
+    it { is_expected.not_to include(a_validator_for(:mail, :uniqueness)) }
+  end
+
+  context 'with a composite unique index' do
+    subject { Capability.validators }
+
+    let(:opts) { { scope: ['organisation_id'], case_sensitive: true } }
+    it { is_expected.to include(a_validator_for(:name, :uniqueness, opts)) }
+  end
+
+  context 'with duplicate unique indexes' do
+    subject { Organisation.validators }
+
+    it { is_expected.not_to include(a_validator_for(:name, :uniqueness)) }
+    it { is_expected.not_to include(a_validator_for(:country, :uniqueness)) }
+    it { is_expected.not_to include(a_validator_for(:city, :uniqueness)) }
+  end
+
+  context 'with an integer column' do
+    context 'with allow_nil' do
+      let(:opts) { { only_integer: true, allow_nil: true } }
+      it { is_expected.to include(a_validator_for(:age, :numericality, opts)) }
+    end
+    context 'without allow_nil' do
+      let(:opts) { { only_integer: true, allow_nil: false } }
+      it 'sets allow_nil to false for socialness' do
+        expect(subject)
+          .to include(a_validator_for(:socialness, :numericality, opts))
+      end
+    end
+  end
+
+  context 'with a numeric column' do
+    let(:opts) { { only_integer: false, allow_nil: false } }
+    it { is_expected.to include(a_validator_for(:gpa, :numericality, opts)) }
+  end
+
+  context 'with a limited length string' 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
+
+    let(:klass) do
+      opts = { disabled_validator => false }
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'resources'
+
+        belongs_to :organisation
+
+        valhammer(opts)
+      end
+    end
+
+    subject { klass.validators }
+
+    context ':presence' do
+      let(:disabled_validator) { :presence }
+
+      it 'excludes the presence validator' 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))
+      end
+    end
+
+    context ':inclusion' do
+      let(:disabled_validator) { :inclusion }
+
+      it 'excludes the inclusion validator' do
+        expect(subject)
+          .not_to include(a_validator_for(:injected, :inclusion))
+      end
+    end
+
+    context ':uniqueness' do
+      let(:disabled_validator) { :uniqueness }
+
+      it 'excludes the uniqueness validator' do
+        expect(subject)
+          .not_to include(a_validator_for(:identifier, :uniqueness))
+      end
+    end
+
+    context ':numericality' do
+      let(:disabled_validator) { :numericality }
+
+      it 'excludes the numericality validator' do
+        expect(subject).to not_include(a_validator_for(:age, :numericality))
+          .and not_include(a_validator_for(:gpa, :numericality))
+      end
+    end
+
+    context ':length' do
+      let(:disabled_validator) { :length }
+
+      it 'excludes the length validator' do
+        expect(subject).not_to include(a_validator_for(:name, :length))
+      end
+    end
+  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')
+    end
+
+    context Resource do
+      subject do
+        Resource.new(name: 'Orson Orchestrator', identifier: 'orson',
+                     mail: 'orson@synergize.example.com',
+                     description: 'A dedicated but indifferent resource',
+                     gpa: 3.5, injected: false, organisation: organisation)
+      end
+
+      it { is_expected.to be_valid }
+    end
+
+    context Capability do
+      subject do
+        Capability.create!(organisation: organisation, core: true,
+                           name: 'Project Management')
+      end
+
+      it { is_expected.to be_valid }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+Bundler.setup
+require 'simplecov'
+
+ENV['RAILS_ENV'] = 'test'
+FileUtils.rm_f 'spec/db/test.sqlite3'
+
+require_relative 'dummy/config/environment.rb'
+require_relative 'db/schema.rb'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.order = :random
+  Kernel.srand config.seed
+end

data/valhammer.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'valhammer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'valhammer'
+  spec.version       = Valhammer::VERSION
+  spec.authors       = ['Shaun Mangelsdorf']
+  spec.email         = ['s.mangelsdorf@gmail.com']
+  spec.summary       = 'Automatically validate ActiveRecord models based on ' \
+                       'the database schema.'
+  spec.homepage      = 'https://github.com/ausaccessfed/valhammer'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 4.1'
+
+  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 '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 'sqlite3'
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: valhammer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shaun Mangelsdorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- s.mangelsdorf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/valhammer.rb
+- lib/valhammer/railtie.rb
+- lib/valhammer/validations.rb
+- lib/valhammer/version.rb
+- spec/db/schema.rb
+- spec/dummy/app/models/capability.rb
+- spec/dummy/app/models/organisation.rb
+- spec/dummy/app/models/resource.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/secrets.yml
+- spec/lib/valhammer/validations_spec.rb
+- spec/spec_helper.rb
+- valhammer.gemspec
+homepage: https://github.com/ausaccessfed/valhammer
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically validate ActiveRecord models based on the database schema.
+test_files:
+- spec/db/schema.rb
+- spec/dummy/app/models/capability.rb
+- spec/dummy/app/models/organisation.rb
+- spec/dummy/app/models/resource.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/secrets.yml
+- spec/lib/valhammer/validations_spec.rb
+- spec/spec_helper.rb