rein 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c374a01203d81386e0d12d076ad23d4b07715f8
-  data.tar.gz: 9059371da28496cdd1bd84f37dffddbdbdf4a21f
+  metadata.gz: 0615a7f2e565c2f358a695bde5ca27c1dc38dd09
+  data.tar.gz: 4dc8082ed6921296954d8802b296f74ca9ad2fd6
 SHA512:
-  metadata.gz: 83a4fbf3978a81f1f2ecbdda5966a3ae493543ab4a9777cc5086fd4eefbb557571cd27a910d4ecc492e8985319ca9d8f890692bb747570642d706557a390cbf8
-  data.tar.gz: 0e4c36f501367e281afac4ac0828232b0b33b7550127c4fdb3fd77ad963c9a406cc010c8b1604678ee3d81d6d6a1ef637de5811e45ebf6ff87656eed90345f29
+  metadata.gz: 662ac24aca4142d7dc22db7a5de022dd89df180c745a8d944551dabdc29ae62b0c2fd9a92a353bbd9a4c4e28debf7c500879f98e84d046d5377bb8bb285f8c63
+  data.tar.gz: faf7c737bce89979103b5f382742982e108512e0598d041fae995c8b5c5c10fbfa73168b53b26a434b6134298921539a95861fe886b81eac202ffabe834ae727

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 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.

data/README.md

@@ -20,6 +20,9 @@ can easily tame the data in your database.
     * [Inclusion constraints](#inclusion-constraints)
     * [Numericality constraints](#numericality-constraints)
     * [Presence constraints](#presence-constraints)
+  * [Data types](#data-types)
+    * [Enumerated types](#enumerated-types)
+  * [Views](#views)
   * [Example](#example)
   * [License](#license)
 
@@ -70,6 +73,12 @@ Here's all the options for specifying the delete/update behaviour:
   referenced row is deleted.
 - `restrict`: prevents deletion of a referenced row.
 
+To remove a foreign key constraint:
+
+```ruby
+remove_foreign_key_constraint :books, :authors
+```
+
 ### Inclusion constraints
 
 *(PostgreSQL only)*
@@ -84,6 +93,12 @@ For example, we can ensure that `state` column values can only ever be
 add_inclusion_constraint :books, :state, in: %w(available on_loan)
 ```
 
+To remove an inclusion constraint:
+
+```ruby
+remove_inclusion_constraint :books, :state
+```
+
 ### Numericality constraints
 
 *(PostgreSQL only)*
@@ -109,6 +124,22 @@ 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:
+
+```ruby
+add_numericality_constraint :books, :publication_month,
+  greater_than_or_equal_to: 1,
+  less_than_or_equal_to: 12,
+  if: "status = 'published'"
+```
+
+To remove a numericality constraint:
+
+```ruby
+remove_numericality_constraint :books, :publication_month
+```
+
 ### Presence constraints
 
 *(PostgreSQL only)*
@@ -122,6 +153,55 @@ you want to ensure that there is an actual value for a string:
 add_presence_constraint :books, :title
 ```
 
+If you only want to enforce the constraint under certain conditions,
+you can pass an optional `if` option:
+
+```ruby
+add_presence_constraint :books, :isbn, if: "status = 'published'"
+```
+
+To remove a presence constraint:
+
+```ruby
+remove_presence_constraint :books, :title
+```
+
+## Data types
+
+### Enumerated types
+
+*(PostgreSQL only)*
+
+An enum is a data type that represents a static, ordered set of values.
+
+```ruby
+create_enum_type :book_type, ['paperback', 'hardcover']
+```
+
+To drop an enum type from the database:
+
+```ruby
+drop_enum_type :book_type
+```
+
+## Views
+
+A view is a named query that you can refer to just like an ordinary table. You
+can even create ActiveRecord models that are backed by views in your database.
+
+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'")
+```
+
+To drop a view from the database:
+
+```ruby
+drop_view(:available_books)
+```
+
 ## Example
 
 Let's have a look at constraining database values for this simple library

data/Rakefile

@@ -5,4 +5,4 @@ require "rubocop/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: [:spec, :rubocop]
+task default: %w(spec rubocop)

data/lib/rein.rb

@@ -6,6 +6,7 @@ require "rein/constraint/foreign_key"
 require "rein/constraint/inclusion"
 require "rein/constraint/numericality"
 require "rein/constraint/presence"
+require "rein/type/enum"
 require "rein/view"
 
 module ActiveRecord
@@ -28,6 +29,7 @@ module ActiveRecord
       include Rein::Constraint::Inclusion
       include Rein::Constraint::Numericality
       include Rein::Constraint::Presence
+      include Rein::Type::Enum
       include Rein::View
     end
   end

data/lib/rein/constraint/inclusion.rb

@@ -7,11 +7,16 @@ module Rein
       include ActiveRecord::ConnectionAdapters::Quoting
 
       def add_inclusion_constraint(table, attribute, options = {})
-        name       = "#{table}_#{attribute}"
-        values     = options[:in].map { |value| quote(value) }.join(", ")
+        name = "#{table}_#{attribute}"
+        values = options[:in].map { |value| quote(value) }.join(", ")
         conditions = "#{attribute} IN (#{values})"
         execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
       end
+
+      def remove_inclusion_constraint(table, attribute)
+        name = "#{table}_#{attribute}"
+        execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
+      end
     end
   end
 end

data/lib/rein/constraint/numericality.rb

@@ -19,8 +19,17 @@ module Rein
           [attribute, operator, value].join(" ")
         end.join(" AND ")
 
+        if options[:if].present?
+          conditions = "NOT (#{options[:if]}) OR (#{conditions})"
+        end
+
         execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
       end
+
+      def remove_numericality_constraint(table, attribute)
+        name = "#{table}_#{attribute}"
+        execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
+      end
     end
   end
 end

data/lib/rein/constraint/presence.rb

@@ -4,11 +4,19 @@ module Rein
     module Presence
       include ActiveRecord::ConnectionAdapters::Quoting
 
-      def add_presence_constraint(table, attribute)
-        name       = "#{table}_#{attribute}"
-        conditions = "#{attribute} !~ '^\s*$'"
+      def add_presence_constraint(table, attribute, options = {})
+        name = "#{table}_#{attribute}"
+        conditions = "#{attribute} !~ '^\\s*$'"
+        if options[:if].present?
+          conditions = "NOT (#{options[:if]}) OR (#{conditions})"
+        end
         execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
       end
+
+      def remove_presence_constraint(table, attribute)
+        name = "#{table}_#{attribute}"
+        execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
+      end
     end
   end
 end

data/lib/rein/type/enum.rb

@@ -0,0 +1,23 @@
+require "active_record/connection_adapters/abstract/quoting"
+
+module Rein
+  module Type
+    # This module contains methods for defining enum types.
+    module Enum
+      include ActiveRecord::ConnectionAdapters::Quoting
+
+      def create_enum_type(enum_name, enum_values = [])
+        enum_values = enum_values.map { |value| quote(value) }.join(", ")
+        execute("CREATE TYPE #{enum_name} AS ENUM (#{enum_values})")
+      end
+
+      def drop_enum_type(enum_name)
+        execute("DROP TYPE #{enum_name}")
+      end
+
+      def add_enum_value(enum_name, new_value)
+        execute("ALTER TYPE #{enum_name} ADD VALUE #{quote(new_value)}")
+      end
+    end
+  end
+end

data/lib/rein/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rein
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Joshua Bassett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -92,6 +92,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -102,6 +103,7 @@ files:
 - lib/rein/constraint/numericality.rb
 - lib/rein/constraint/presence.rb
 - lib/rein/constraint/primary_key.rb
+- lib/rein/type/enum.rb
 - lib/rein/version.rb
 - lib/rein/view.rb
 - rein.gemspec