rein 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9f1047d5663ba27fedf399e87223e024fe7a6fa
-  data.tar.gz: fe37532d4ee714cd1e1fa281611f4ae61cd5561a
+  metadata.gz: cc7bf976b250a0cfaa15db1ec4a937afcdf9e6af
+  data.tar.gz: 79dcf97dbe8bdb932f42198675c9cc229f5f9ac3
 SHA512:
-  metadata.gz: b3c700dd2bc15a2edf547ac390ec78e4972bc1bb3c7d4f534a495969d4e2e8b014121f9c11a230e415ba892c0e22a16d62bf391f21c69cf5d88bc7eef3d43f02
-  data.tar.gz: 4153810c938897f244d72088e9c0095e99f7f8476c09069f647a4b974d7ad180860d019f6962b3192cf28fa70c2f8a0e549a32f9c6b3cd366d03ca9577bb8d42
+  metadata.gz: 3a2353e83aeae5a7f05787725a25c553689efb27c7093315e48a900ad0ed2e35069f8c6706571cb8b41080c6e04cff484e1574e9768d4f15bf11f7f6d2458ec7
+  data.tar.gz: 2cfeef3a3d05f9c483309fb0585bfc2733b1862dbb0b73dbccace17f652e28a606d53553f1b3cbe7d0dbbf59eea3c501cdbeb2c5bb772198db94008ba6e2bb33

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.1.0
+- Add length constraint.
+
 ## 3.0.0
 
 - Dropped MySQL support.

data/README.md

@@ -23,6 +23,7 @@ advantage of reversible Rails migrations.
   * [Constraint types](#constraint-types)
     * [Foreign key constraints](#foreign-key-constraints)
     * [Inclusion constraints](#inclusion-constraints)
+    * [Length constraints](#length-constraints)
     * [Numericality constraints](#numericality-constraints)
     * [Presence constraints](#presence-constraints)
     * [Null constraints](#null-constraints)
@@ -146,6 +147,54 @@ add_inclusion_constraint :books, :state,
   name: "books_state_is_valid"
 ```
 
+### Length constraints
+
+A length constraint specifies the range of values that the length of a string
+column value can take.
+
+For example, we can ensure that the `call_number` can only ever be a
+value between 1 and 255:
+
+```ruby
+add_length_constraint :books, :call_number,
+  greater_than_or_equal_to: 1,
+  less_than_or_equal_to: 255
+```
+
+Here's all the options for constraining the values:
+
+- `equal_to`
+- `not_equal_to`
+- `less_than`
+- `less_than_or_equal_to`
+- `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_length_constraint :books, :call_number,
+  greater_than_or_equal_to: 1,
+  less_than_or_equal_to: 12,
+  if: "status = 'published'"
+```
+
+You may optionally provide a `name` option to customize the name:
+
+```ruby
+add_length_constraint :books, :call_number,
+  greater_than_or_equal_to: 1,
+  less_than_or_equal_to: 12,
+  name: "books_call_number_is_valid"
+```
+
+To remove a length constraint:
+
+```ruby
+remove_length_constraint :books, :call_number
+```
+
 ### Numericality constraints
 
 A numericality constraint specifies the range of values that a numeric column

data/lib/rein.rb

@@ -1,6 +1,7 @@
 require "active_record"
 require "rein/constraint/foreign_key"
 require "rein/constraint/inclusion"
+require "rein/constraint/length"
 require "rein/constraint/null"
 require "rein/constraint/numericality"
 require "rein/constraint/presence"
@@ -13,6 +14,7 @@ module ActiveRecord
   class Migration # :nodoc:
     include Rein::Constraint::ForeignKey
     include Rein::Constraint::Inclusion
+    include Rein::Constraint::Length
     include Rein::Constraint::Null
     include Rein::Constraint::Numericality
     include Rein::Constraint::Presence

data/lib/rein/constraint/length.rb

@@ -0,0 +1,49 @@
+require "rein/util"
+
+module Rein
+  module Constraint
+    # This module contains methods for defining length constraints.
+    module Length
+      OPERATORS = {
+        greater_than: :>,
+        greater_than_or_equal_to: :>=,
+        equal_to: :"=",
+        not_equal_to: :"!=",
+        less_than: :<,
+        less_than_or_equal_to: :<=
+      }.freeze
+
+      def add_length_constraint(*args)
+        reversible do |dir|
+          dir.up { _add_length_constraint(*args) }
+          dir.down { _remove_length_constraint(*args) }
+        end
+      end
+
+      def remove_length_constraint(*args)
+        reversible do |dir|
+          dir.up { _remove_length_constraint(*args) }
+          dir.down { _add_length_constraint(*args) }
+        end
+      end
+
+      private
+
+      def _add_length_constraint(table, attribute, options = {})
+        name = Util.constraint_name(table, attribute, "length", options)
+        attribute_length = "length(#{attribute})"
+        conditions = OPERATORS.slice(*options.keys).map do |key, operator|
+          value = options[key]
+          [attribute_length, operator, value].join(" ")
+        end.join(" AND ")
+        conditions = Util.conditions_with_if(conditions, options)
+        execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
+      end
+
+      def _remove_length_constraint(table, attribute, options = {})
+        name = Util.constraint_name(table, attribute, "length", options)
+        execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
+      end
+    end
+  end
+end

data/lib/rein/version.rb

@@ -1,3 +1,3 @@
 module Rein
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rein
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Joshua Bassett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,6 +147,7 @@ files:
 - lib/rein.rb
 - lib/rein/constraint/foreign_key.rb
 - lib/rein/constraint/inclusion.rb
+- lib/rein/constraint/length.rb
 - lib/rein/constraint/null.rb
 - lib/rein/constraint/numericality.rb
 - lib/rein/constraint/presence.rb
@@ -176,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Database constraints made easy for ActiveRecord.