mutations 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eda7e54196daf6a06659a669f0864921ab376c54f218f4463f7c8b06d1dc075
-  data.tar.gz: 0c6d22af4d18c4ae3041c600f2c61873cae3728514f49d48dfed41bfd6b57e63
+  metadata.gz: 60a9dcaccc2cded1876539ff36b62111b6bfdcec887494265fe4fa510c360ad5
+  data.tar.gz: 7a2bd2aacb4f8b9296e7f4a638fe42a1034ee8736a24a31d811580a87e4ecbe7
 SHA512:
-  metadata.gz: eb82171717884e5ed61fa499c50fa9f5d3b4b1108c988619610b461e76f1a25c70078ad4aa3fff275e32e4b43f711cbe334d402b86e61a53d58778b4792c5986
-  data.tar.gz: 9538cc3fbe474561fe72ff096c072128a03bb13237541e1e21338d72557abd2beeb75e85d1ff2bb72b5c9d9015bb89046b44d4330e6cd3ddde8eebb6f1e3ebb7
+  metadata.gz: 756a1dd30f3affd27ef111ebfbdf066e3e056767f6a08a7b69f8c39831f977bb9ee96b82e2f729cc02d4f6bffa2ea04f8ad8e405b9b6855f7a3bc06a20a4039a
+  data.tar.gz: b18adcdba20934dda3555cb3b72d90e23cd81612e152991338dd750f2d4bbd57ced91037b9900c4d42f8d6090cf4fe662ca0e91c3dba64692a5d0f0e3f46cae3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.9.0
+-----------
+ - Retain `_id` suffix in error keys (#129, @khalilovcmd)
+ - Add a symbol filter: `symbol :color, in: %i(red blue green)` (#119, @estraph)
+ - Add `empty_is_nil` option to string filter (#135, @skylerwshaw)
+
 0.8.3
 -----------
  - Add `min_length` and `max_length` options to array filter (#128, @jwoertink)

data/README.md

@@ -149,7 +149,7 @@ Here, we pass two hashes to CreateComment. Even if the params[:comment] hash has
     ```ruby
     required do
       string :name, max_length: 10
-      string :state, in: %w(AL AK AR ... WY)
+      symbol :state, in: %i(AL AK AR ... WY)
       integer :age
       boolean :is_special, default: true
       model :account

data/lib/mutations.rb

@@ -20,6 +20,7 @@ require 'mutations/file_filter'
 require 'mutations/model_filter'
 require 'mutations/array_filter'
 require 'mutations/hash_filter'
+require 'mutations/symbol_filter'
 require 'mutations/outcome'
 require 'mutations/command'
 

data/lib/mutations/errors.rb

@@ -47,9 +47,20 @@ module Mutations
     #  :index -- index of error if it's in an array
     def message(key, error_symbol, options = {})
       if options[:index]
-        "#{(key || 'array').to_s.titleize}[#{options[:index]}] #{MESSAGES[error_symbol]}"
+        "#{titleize(key || 'array')}[#{options[:index]}] #{MESSAGES[error_symbol]}"
       else
-        "#{key.to_s.titleize} #{MESSAGES[error_symbol]}"
+        "#{titleize(key)} #{MESSAGES[error_symbol]}"
+      end
+    end
+
+    def titleize(key)
+      key = key.to_s.downcase
+      if key == "id"
+        "ID"
+      elsif key.end_with?("_id")
+        "#{key.titleize} ID"
+      else
+        key.titleize
       end
     end
   end

data/lib/mutations/string_filter.rb

@@ -4,6 +4,7 @@ module Mutations
       :strip => true,          # true calls data.strip if data is a string
       :strict => false,        # If false, then symbols, numbers, and booleans are converted to a string with to_s.
       :nils => false,          # true allows an explicit nil to be valid. Overrides any other options
+      :empty_is_nil => false,  # if true, treat empty string as if it were nil
       :empty => false,         # false disallows "".  true allows "" and overrides any other validations (b/c they couldn't be true if it's empty)
       :min_length => nil,      # Can be a number like 5, meaning that 5 codepoints are required
       :max_length => nil,      # Can be a number like 10, meaning that at most 10 codepoints are permitted
@@ -14,6 +15,9 @@ module Mutations
     }
 
     def filter(data)
+      if options[:empty_is_nil] && data == ""
+        data = nil
+      end
 
       # Handle nil case
       if data.nil?

data/lib/mutations/symbol_filter.rb

@@ -0,0 +1,26 @@
+module Mutations
+  class SymbolFilter < AdditionalFilter
+    @default_options = {
+      :nils => false,    # true allows an explicit nil to be valid. Overrides any other options
+      :in => nil,        # Can be an array like %i(red blue green)
+    }
+
+    def filter(data)
+      if data.nil?
+        return [nil, nil] if options[:nils]
+        return [nil, :nils]
+      end
+
+      case data
+      when Symbol # we're good!
+      when String then data = data.to_sym
+      else return [nil, :symbol]
+      end
+
+      # Ensure it matches `in`
+      return [data, :in] if options[:in] && !options[:in].include?(data)
+
+      [data, nil]
+    end
+  end
+end

data/lib/mutations/version.rb

@@ -1,3 +1,3 @@
 module Mutations
-  VERSION = "0.8.3"
+  VERSION = "0.9.0"
 end

data/spec/errors_spec.rb

@@ -55,9 +55,21 @@ describe "Mutations - errors" do
     assert o.errors[:arr1][2].is_a?(Mutations::ErrorAtom)
   end
 
-  it "titleizes keys" do
-    atom = Mutations::ErrorAtom.new(:newsletter_subscription, :boolean)
-    assert_equal "Newsletter Subscription isn't a boolean", atom.message
+  describe "error messages" do
+    it "titleizes keys" do
+      atom = Mutations::ErrorAtom.new(:newsletter_subscription, :boolean)
+      assert_equal "Newsletter Subscription isn't a boolean", atom.message
+    end
+
+    it "titleizes _id postfix as ID" do
+      atom = Mutations::ErrorAtom.new(:newsletter_subscription_id, :boolean)
+      assert_equal "Newsletter Subscription ID isn't a boolean", atom.message
+    end
+
+    it "titleizes id as ID" do
+      atom = Mutations::ErrorAtom.new(:id, :boolean)
+      assert_equal "ID isn't a boolean", atom.message
+    end
   end
 
   describe "Bunch o errors" do

data/spec/string_filter_spec.rb

@@ -59,6 +59,19 @@ describe "Mutations::StringFilter" do
     assert_equal nil, errors
   end
 
+  it "considers empty strings to be nil if empty_is_nil option is used" do
+    f = Mutations::StringFilter.new(:empty_is_nil => true)
+    _filtered, errors = f.filter("")
+    assert_equal :nils, errors
+  end
+
+  it "returns empty strings as nil if empty_is_nil option is used" do
+    f = Mutations::StringFilter.new(:empty_is_nil => true, :nils => true)
+    filtered, errors = f.filter("")
+    assert_equal nil, filtered
+    assert_equal nil, errors
+  end
+
   it "considers empty strings to be invalid" do
     sf = Mutations::StringFilter.new(:empty => false)
     filtered, errors = sf.filter("")

data/spec/symbol_filter_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe "Mutations::SymbolFilter" do
+
+  it "allows strings" do
+    sf = Mutations::SymbolFilter.new
+    filtered, errors = sf.filter("hello")
+    assert_equal :hello, filtered
+    assert_equal nil, errors
+  end
+
+  it "allows symbols" do
+    sf = Mutations::SymbolFilter.new
+    filtered, errors = sf.filter(:hello)
+    assert_equal :hello, filtered
+    assert_equal nil, errors
+  end
+
+  it "doesn't allow non-symbols" do
+    sf = Mutations::SymbolFilter.new
+    [["foo"], {:a => "1"}, Object.new].each do |thing|
+      _filtered, errors = sf.filter(thing)
+      assert_equal :symbol, errors
+    end
+  end
+
+  it "considers nil to be invalid" do
+    sf = Mutations::SymbolFilter.new(:nils => false)
+    filtered, errors = sf.filter(nil)
+    assert_equal nil, filtered
+    assert_equal :nils, errors
+  end
+
+  it "considers nil to be valid" do
+    sf = Mutations::SymbolFilter.new(:nils => true)
+    filtered, errors = sf.filter(nil)
+    assert_equal nil, filtered
+    assert_equal nil, errors
+  end
+
+  it "considers non-inclusion to be invalid" do
+    sf = Mutations::SymbolFilter.new(:in => [:red, :blue, :green])
+    filtered, errors = sf.filter(:orange)
+    assert_equal :orange, filtered
+    assert_equal :in, errors
+  end
+
+  it "considers inclusion to be valid" do
+    sf = Mutations::SymbolFilter.new(:in => [:red, :blue, :green])
+    filtered, errors = sf.filter(:red)
+    assert_equal :red, filtered
+    assert_equal nil, errors
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutations
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Jonathan Novak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2019-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,6 +84,7 @@ files:
 - lib/mutations/model_filter.rb
 - lib/mutations/outcome.rb
 - lib/mutations/string_filter.rb
+- lib/mutations/symbol_filter.rb
 - lib/mutations/time_filter.rb
 - lib/mutations/version.rb
 - mutations.gemspec
@@ -105,6 +106,7 @@ files:
 - spec/simple_command.rb
 - spec/spec_helper.rb
 - spec/string_filter_spec.rb
+- spec/symbol_filter_spec.rb
 - spec/time_filter_spec.rb
 homepage: http://github.com/cypriss/mutations
 licenses:
@@ -125,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Compose your business logic into commands that sanitize and validate input.