rein 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0615a7f2e565c2f358a695bde5ca27c1dc38dd09
-  data.tar.gz: 4dc8082ed6921296954d8802b296f74ca9ad2fd6
+  metadata.gz: 7a9c78af74657a1a1a30eddab52f82f308dd1a1c
+  data.tar.gz: 72b3d37a29e6d2384ab7c6bc46268544dc560271
 SHA512:
-  metadata.gz: 662ac24aca4142d7dc22db7a5de022dd89df180c745a8d944551dabdc29ae62b0c2fd9a92a353bbd9a4c4e28debf7c500879f98e84d046d5377bb8bb285f8c63
-  data.tar.gz: faf7c737bce89979103b5f382742982e108512e0598d041fae995c8b5c5c10fbfa73168b53b26a434b6134298921539a95861fe886b81eac202ffabe834ae727
+  metadata.gz: 2c0229b55c19e5fded597a3f3d0b8836ba073fac83365efcf88fbe0c2a37ab9cde6989d2db7587fd093316742c5aa4692e383c4bb021edc774596a3cc8cf2a2f
+  data.tar.gz: 6bc108d82d305dc4115d7944e4dc84aafc789f92ae2d1349b8ed5273b44e4e07492f75e59bfae3c83ee44d38b7d5b30232bcff695207e652157f865cbb846baf

data/CHANGELOG.md

@@ -1,8 +1,26 @@
 # Changelog
 
+## 2.1.0
+
+- Add `if` option to inclusion constraints.
+- Add `name` option to constraints.
+- Add null constraint.
+- Ensure presence constraint enforces not null.
+
 ## 2.0.0
 
 - Add support for enumerated types.
 - Add `if` option to numericality constraints.
 - Add `if` option to presence constraints.
 - Fix a bug in presence contraints.
+
+## 1.1.0
+
+- Update README.
+- Code cleanups.
+- Disable monkey patching in rspec.
+
+## 1.0.0
+
+- Fix `Mysql2Adapter` for Rails 3.2.
+- Add `column` option to `add_primary_key`.

data/README.md

@@ -1,5 +1,7 @@
 # Rein
 
+[![Build Status](https://travis-ci.org/nullobject/rein.svg?branch=master)](https://travis-ci.org/nullobject/rein)
+
 [Data integrity](http://en.wikipedia.org/wiki/Data_integrity) is a good thing.
 Constraining the values allowed by your application at the database-level,
 rather than at the application-level, is a more robust way of ensuring your
@@ -20,10 +22,13 @@ can easily tame the data in your database.
     * [Inclusion constraints](#inclusion-constraints)
     * [Numericality constraints](#numericality-constraints)
     * [Presence constraints](#presence-constraints)
+    * [Null constraints](#null-constraints)
   * [Data types](#data-types)
     * [Enumerated types](#enumerated-types)
   * [Views](#views)
+  * [Schemas](#schemas)
   * [Example](#example)
+  * [Contributing](#contributing)
   * [License](#license)
 
 ## Getting started
@@ -90,7 +95,7 @@ For example, we can ensure that `state` column values can only ever be
 `available` or `on_loan`:
 
 ```ruby
-add_inclusion_constraint :books, :state, in: %w(available on_loan)
+add_inclusion_constraint :books, :state, in: %w[available on_loan]
 ```
 
 To remove an inclusion constraint:
@@ -99,6 +104,23 @@ To remove an inclusion constraint:
 remove_inclusion_constraint :books, :state
 ```
 
+You may also include an `if` option to enforce the constraint only under
+certain conditions, like so:
+
+```ruby
+add_inclusion_constraint :books, :state,
+  in: %w[available on_loan],
+  if: "deleted_at IS NULL"
+```
+
+You may optionally provide a `name` option to customize the name:
+
+```ruby
+add_inclusion_constraint :books, :state,
+  in: %w[available on_loan],
+  name: "books_state_is_valid"
+```
+
 ### Numericality constraints
 
 *(PostgreSQL only)*
@@ -124,8 +146,8 @@ Here's all the options for constraining the values:
 - `greater_than`
 - `greater_than_or_equal_to`
 
-You may also include an `if` option to enforce the constraint only under certain conditions,
-like so:
+You may also include an `if` option to enforce the constraint only under
+certain conditions, like so:
 
 ```ruby
 add_numericality_constraint :books, :publication_month,
@@ -134,6 +156,15 @@ add_numericality_constraint :books, :publication_month,
   if: "status = 'published'"
 ```
 
+You may optionally provide a `name` option to customize the name:
+
+```ruby
+add_numericality_constraint :books, :publication_month,
+  greater_than_or_equal_to: 1,
+  less_than_or_equal_to: 12,
+  name: "books_publication_month_is_valid"
+```
+
 To remove a numericality constraint:
 
 ```ruby
@@ -160,12 +191,39 @@ you can pass an optional `if` option:
 add_presence_constraint :books, :isbn, if: "status = 'published'"
 ```
 
+You may optionally provide a `name` option to customize the name:
+
+```ruby
+add_presence_constraint :books, :isbn, name: "books_isbn_is_valid"
+```
+
 To remove a presence constraint:
 
 ```ruby
 remove_presence_constraint :books, :title
 ```
 
+### Null constraints
+
+*(PostgreSQL only)*
+
+A null constraint ensures that a column does *not* contain a null value. This
+is the same as adding `NOT NULL` to a column, the difference being that it can
+be _applied conditionally_.
+
+For example, we can add a constraint to enforce that a book has a `due_date`,
+but only if it's `on_loan`:
+
+```ruby
+add_null_constraint :books, :due_date, if: "state = 'on_loan'"
+```
+
+To remove a null constraint:
+
+```ruby
+remove_null_constraint :books, :due_date
+```
+
 ## Data types
 
 ### Enumerated types
@@ -175,7 +233,7 @@ remove_presence_constraint :books, :title
 An enum is a data type that represents a static, ordered set of values.
 
 ```ruby
-create_enum_type :book_type, ['paperback', 'hardcover']
+create_enum_type :book_type, %w[paperback hardcover]
 ```
 
 To drop an enum type from the database:
@@ -193,64 +251,112 @@ For example, we can define an `available_books` view that returns only the
 books which are currently available:
 
 ```ruby
-create_view(:available_books, "SELECT * FROM books WHERE state = 'available'")
+create_view :available_books, "SELECT * FROM books WHERE state = 'available'"
 ```
 
 To drop a view from the database:
 
 ```ruby
-drop_view(:available_books)
+drop_view :available_books
 ```
 
-## Example
+## Schemas
 
-Let's have a look at constraining database values for this simple library
-application.
+*(PostgreSQL only)*
 
-Here we have a table of authors:
+A database can contain one or more named schemas, which in turn contain tables.
+Sometimes it might be helpful to split your database into multiple schemas to
+logically group tables together.
 
 ```ruby
-create_table :authors do |t|
-  t.string :name, null: false
-  t.timestamps, null: false
-end
-
-# An author must have a name.
-add_presence_constraint :authors, :name
+create_schema :archive
 ```
 
-We also have a table of books:
+To drop a schema from the database:
 
 ```ruby
-create_table :books do |t|
-  t.belongs_to :author, null: false
-  t.string :title, null: false
-  t.string :state, null: false
-  t.integer :published_year, null: false
-  t.integer :published_month, null: false
-  t.timestamps, null: false
-end
+drop_schema :archive
+```
 
-# A book should always belong to an author. The database should prevent us from
-# deleteing an author who has books.
-add_foreign_key_constraint :books, :authors, on_delete: :restrict
+## Example
 
-# A book must have a non-empty title.
-add_presence_constraint :books, :title
+Let's have a look at some example migrations to constrain database values for
+our simple library application:
 
-# State is always either "available" or "on_loan".
-add_inclusion_constraint :books, :state, in: %w(available on_loan)
+```ruby
+class CreateAuthorsTable < ActiveRecord::Migration
+  def change
+    # The authors table contains all the authors of the books in the library.
+    create_table :authors do |t|
+      t.string :name, null: false
+      t.timestamps, null: false
+    end
+
+    # An author must have a name.
+    add_presence_constraint :authors, :name
+  end
+end
 
-# Our library doesn't deal in classics.
-add_numericality_constraint :books, :published_year,
-  greater_than_or_equal_to: 1980
+class CreateBooksTable < ActiveRecord::Migration
+  def change
+    # The books table contains all the books in the library, and their state
+    # (i.e. whether they are on loan or available).
+    create_table :books do |t|
+      t.belongs_to :author, null: false
+      t.string :title, null: false
+      t.string :state, null: false
+      t.integer :published_year, null: false
+      t.integer :published_month, null: false
+      t.date :due_date
+      t.timestamps, null: false
+    end
+
+    # A book should always belong to an author. The database should
+    # automatically delete an author's books when we delete an author.
+    add_foreign_key_constraint :books, :authors, on_delete: :cascade
+
+    # A book must have a non-empty title.
+    add_presence_constraint :books, :title
+
+    # State is always either "available", "on_loan", or "on_hold".
+    add_inclusion_constraint :books, :state, in: %w[available on_loan on_hold]
+
+    # Our library doesn't deal in classics.
+    add_numericality_constraint :books, :published_year,
+      greater_than_or_equal_to: 1980
+
+    # Month is always between 1 and 12.
+    add_numericality_constraint :books, :published_month,
+      greater_than_or_equal_to: 1,
+      less_than_or_equal_to: 12
+
+    # A book has a due date if it is on loan.
+    add_null_constraint :books, :due_date, if: "state = 'on_loan'"
+  end
+end
 
-# Month is always between 1 and 12.
-add_numericality_constraint :books, :published_month,
-  greater_than_or_equal_to: 1,
-  less_than_or_equal_to: 12
+class CreateArchivedBooksTable < ActiveRecord::Migration
+  def change
+    # The archive schema contains all of the archived data. We want to keep
+    # this separate from the public schema.
+    create_schema :archive
+
+    # The archive.books table contains all the achived books.
+    create_table "archive.books" do |t|
+      t.belongs_to :author, null: false
+      t.string :title, null: false
+    end
+
+    # A book should always belong to an author. The database should prevent us
+    # from deleteing an author who has books.
+    add_foreign_key_constraint "archive.books", :authors, on_delete: :restrict
+
+    # A book must have a non-empty title.
+    add_presence_constraint "archive.books", :title
+  end
+end
 ```
 
 ## License
 
-Rein is licensed under the [MIT License](/LICENSE).
+Rein is licensed under the [MIT License](/LICENSE.md).

data/lib/rein.rb

@@ -1,13 +1,16 @@
 require "active_record"
 require "active_record/connection_adapters/abstract_mysql_adapter"
 
+require "rein/constraint/options"
 require "rein/constraint/primary_key"
 require "rein/constraint/foreign_key"
 require "rein/constraint/inclusion"
+require "rein/constraint/null"
 require "rein/constraint/numericality"
 require "rein/constraint/presence"
 require "rein/type/enum"
 require "rein/view"
+require "rein/schema"
 
 module ActiveRecord
   module ConnectionAdapters # :nodoc:
@@ -27,10 +30,12 @@ module ActiveRecord
       include Rein::Constraint::PrimaryKey
       include Rein::Constraint::ForeignKey
       include Rein::Constraint::Inclusion
+      include Rein::Constraint::Null
       include Rein::Constraint::Numericality
       include Rein::Constraint::Presence
       include Rein::Type::Enum
       include Rein::View
+      include Rein::Schema
     end
   end
 end

data/lib/rein/constraint/foreign_key.rb

@@ -1,3 +1,5 @@
+require "active_support/inflector"
+
 module Rein
   module Constraint
     # This module contains methods for defining foreign key constraints.

data/lib/rein/constraint/inclusion.rb

@@ -5,16 +5,17 @@ module Rein
     # This module contains methods for defining inclusion constraints.
     module Inclusion
       include ActiveRecord::ConnectionAdapters::Quoting
+      include Rein::Constraint::Options
 
       def add_inclusion_constraint(table, attribute, options = {})
-        name = "#{table}_#{attribute}"
+        name = constraint_name(table, attribute, options)
         values = options[:in].map { |value| quote(value) }.join(", ")
-        conditions = "#{attribute} IN (#{values})"
+        conditions = conditions_with_if("#{attribute} IN (#{values})", options)
         execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
       end
 
-      def remove_inclusion_constraint(table, attribute)
-        name = "#{table}_#{attribute}"
+      def remove_inclusion_constraint(table, attribute, options = {})
+        name = constraint_name(table, attribute, options)
         execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
       end
     end

data/lib/rein/constraint/null.rb

@@ -0,0 +1,20 @@
+module Rein
+  module Constraint
+    # This module contains methods for defining null constraints.
+    module Null
+      include ActiveRecord::ConnectionAdapters::Quoting
+      include Rein::Constraint::Options
+
+      def add_null_constraint(table, attribute, options = {})
+        name = constraint_name(table, attribute, options)
+        conditions = conditions_with_if("#{attribute} IS NOT NULL", options)
+        execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
+      end
+
+      def remove_null_constraint(table, attribute, options = {})
+        name = constraint_name(table, attribute, options)
+        execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
+      end
+    end
+  end
+end

data/lib/rein/constraint/numericality.rb

@@ -2,6 +2,8 @@ module Rein
   module Constraint
     # This module contains methods for defining numericality constraints.
     module Numericality
+      include Rein::Constraint::Options
+
       OPERATORS = {
         greater_than: :>,
         greater_than_or_equal_to: :>=,
@@ -12,22 +14,20 @@ module Rein
       }.freeze
 
       def add_numericality_constraint(table, attribute, options = {})
-        name = "#{table}_#{attribute}"
+        name = constraint_name(table, attribute, options)
 
         conditions = OPERATORS.slice(*options.keys).map do |key, operator|
           value = options[key]
           [attribute, operator, value].join(" ")
         end.join(" AND ")
 
-        if options[:if].present?
-          conditions = "NOT (#{options[:if]}) OR (#{conditions})"
-        end
+        conditions = conditions_with_if(conditions, options)
 
         execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
       end
 
-      def remove_numericality_constraint(table, attribute)
-        name = "#{table}_#{attribute}"
+      def remove_numericality_constraint(table, attribute, options = {})
+        name = constraint_name(table, attribute, options)
         execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
       end
     end

data/lib/rein/constraint/options.rb

@@ -0,0 +1,18 @@
+module Rein
+  module Constraint
+    # This module defines methods for handling options command to several constraints.
+    module Options
+      def conditions_with_if(conditions, options = {})
+        if options[:if].present?
+          "NOT (#{options[:if]}) OR (#{conditions})"
+        else
+          conditions
+        end
+      end
+
+      def constraint_name(table, attribute, options = {})
+        options[:name].presence || "#{table}_#{attribute}"
+      end
+    end
+  end
+end

data/lib/rein/constraint/presence.rb

@@ -3,18 +3,19 @@ module Rein
     # This module contains methods for defining presence constraints.
     module Presence
       include ActiveRecord::ConnectionAdapters::Quoting
+      include Rein::Constraint::Options
 
       def add_presence_constraint(table, attribute, options = {})
-        name = "#{table}_#{attribute}"
-        conditions = "#{attribute} !~ '^\\s*$'"
-        if options[:if].present?
-          conditions = "NOT (#{options[:if]}) OR (#{conditions})"
-        end
+        name = constraint_name(table, attribute, options)
+        conditions = conditions_with_if(
+          "(#{attribute} IS NOT NULL) AND (#{attribute} !~ '^\\s*$')",
+          options
+        )
         execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
       end
 
-      def remove_presence_constraint(table, attribute)
-        name = "#{table}_#{attribute}"
+      def remove_presence_constraint(table, attribute, options = {})
+        name = constraint_name(table, attribute, options)
         execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
       end
     end

data/lib/rein/schema.rb

@@ -0,0 +1,14 @@
+module Rein
+  # This module contains methods for creating/dropping schemas.
+  module Schema
+    def create_schema(name)
+      sql = "CREATE SCHEMA #{name}"
+      execute(sql)
+    end
+
+    def drop_schema(name)
+      sql = "DROP SCHEMA #{name}"
+      execute(sql)
+    end
+  end
+end

data/lib/rein/version.rb

@@ -1,3 +1,3 @@
 module Rein
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/rein/view.rb

@@ -1,5 +1,5 @@
 module Rein
-  # This module contains methods for defining views.
+  # This module contains methods for creating/dropping views.
   module View
     def create_view(view_name, sql)
       sql = "CREATE VIEW #{view_name} AS #{sql}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rein
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Joshua Bassett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,26 +141,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
-- Rakefile
 - lib/rein.rb
 - lib/rein/constraint/foreign_key.rb
 - lib/rein/constraint/inclusion.rb
+- lib/rein/constraint/null.rb
 - lib/rein/constraint/numericality.rb
+- lib/rein/constraint/options.rb
 - lib/rein/constraint/presence.rb
 - lib/rein/constraint/primary_key.rb
+- lib/rein/schema.rb
 - lib/rein/type/enum.rb
 - lib/rein/version.rb
 - lib/rein/view.rb
-- rein.gemspec
 homepage: http://github.com/nullobject/rein
 licenses:
 - MIT

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-.yardoc
-Gemfile.lock

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,35 +0,0 @@
-AllCops:
-  Exclude:
-    - "bin/**/*"
-    - "rein.gemspec"
-
-Metrics/AbcSize:
-  Max: 27
-
-Metrics/BlockLength:
-  ExcludedMethods: describe
-
-Metrics/CyclomaticComplexity:
-  Max: 7
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 11
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/Documentation:
-  Exclude:
-    - "spec/**/*"
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/.travis.yml

@@ -1,2 +0,0 @@
-language: ruby
-before_install: gem install bundler -v 1.14.5

data/.yardopts

@@ -1 +0,0 @@
---markup markdown

data/Gemfile

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

data/Rakefile

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

data/rein.gemspec

@@ -1,26 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "rein/version"
-
-Gem::Specification.new do |spec|
-  spec.name        = "rein"
-  spec.version     = Rein::VERSION
-  spec.author      = "Joshua Bassett"
-  spec.email       = "josh.bassett@gmail.com"
-  spec.summary     = "Database constraints made easy for ActiveRecord."
-  spec.description = "Rein adds bunch of methods to your ActiveRecord migrations so you can easily tame your database."
-  spec.homepage    = "http://github.com/nullobject/rein"
-  spec.license     = "MIT"
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "activerecord", ">= 3.2.0"
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "rubocop", "~> 0.47"
-end