Merge pull request #82 from rmm5t/rmm/matcher-custom-value

Add ability to specify a custom value in matcher

Author: rmm5t

README.md

@@ -236,6 +236,7 @@ describe User do
   it { is_expected.to strip_attribute(:name).replace_newlines }
   it { is_expected.to strip_attribute :email }
   it { is_expected.to strip_attributes(:name, :email) }
+  it { is_expected.to strip_attributes(:ticker).using("AAPL") }
   it { is_expected.not_to strip_attribute :password }
   it { is_expected.not_to strip_attributes(:password, :encrypted_password)  }
 end
@@ -249,6 +250,7 @@ class UserTest < ActiveSupport::TestCase
   should strip_attribute(:name).replace_newlines
   should strip_attribute :email
   should strip_attributes(:name, :email)
+  should strip_attributes(:ticker).using("AAPL")
   should_not strip_attribute :password
   should_not strip_attributes(:password, :encrypted_password)
 end
@@ -265,6 +267,7 @@ describe User do
     must strip_attribute(:name).replace_newlines
     must strip_attribute :email
     must strip_attributes(:name, :email)
+    must strip_attributes(:ticker).using("AAPL")
     wont strip_attribute :password
     wont strip_attributes(:password, :encrypted_password)
   end
@@ -281,6 +284,7 @@ describe User do
   must { strip_attribute(:name).replace_newlines }
   must { strip_attribute :email }
   must { strip_attributes(:name, :email) }
+  must { strip_attributes(:ticker).using("AAPL") }
   wont { strip_attribute :password }
   wont { strip_attributes(:password, :encrypted_password) }
 end

bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "strip_attributes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

lib/strip_attributes/matchers.rb

@@ -1,6 +1,5 @@
 module StripAttributes
   module Matchers
-
     # Whitespace is stripped from the beginning and end of the attribute
     #
     # RSpec Examples:
@@ -20,7 +19,7 @@ def strip_attribute(*attributes)
       StripAttributeMatcher.new(attributes)
     end
 
-    alias_method :strip_attributes, :strip_attribute
+    alias strip_attributes strip_attribute
 
     class StripAttributeMatcher
       def initialize(attributes)
@@ -31,12 +30,17 @@ def initialize(attributes)
       def matches?(subject)
         @attributes.all? do |attribute|
           @attribute = attribute
-          subject.send("#{@attribute}=", " string ")
+          subject.send("#{@attribute}=", " #{value} ")
           subject.valid?
-          subject.send(@attribute) == "string" and collapse_spaces?(subject) and replace_newlines?(subject)
+          subject.send(@attribute) == value and collapse_spaces?(subject) and replace_newlines?(subject)
         end
       end
 
+      def using(value)
+        @options[:value] = value
+        self
+      end
+
       def collapse_spaces
         @options[:collapse_spaces] = true
         self
@@ -47,44 +51,51 @@ def replace_newlines
         self
       end
 
-      def failure_message # RSpec 3.x
+      # RSpec 3.x
+      def failure_message
         "Expected whitespace to be #{expectation} from ##{@attribute}, but it was not"
       end
-      alias_method :failure_message_for_should, :failure_message # RSpec 1.2, 2.x, and minitest-matchers
+      alias failure_message_for_should failure_message # RSpec 1.2, 2.x, and minitest-matchers
 
-      def failure_message_when_negated # RSpec 3.x
+      # RSpec 3.x
+      def failure_message_when_negated
         "Expected whitespace to remain on ##{@attribute}, but it was #{expectation}"
       end
-      alias_method :failure_message_for_should_not, :failure_message_when_negated # RSpec 1.2, 2.x, and minitest-matchers
-      alias_method :negative_failure_message,       :failure_message_when_negated # RSpec 1.1
+      alias failure_message_for_should_not failure_message_when_negated # RSpec 1.2, 2.x, and minitest-matchers
+      alias negative_failure_message       failure_message_when_negated # RSpec 1.1
 
       def description
-        "#{expectation(false)} whitespace from #{@attributes.map {|el| "##{el}" }.to_sentence}"
+        attrs = @attributes.map { |attr| "##{attr}" }.to_sentence
+        "#{expectation(past: false)} whitespace from #{attrs}"
       end
 
       private
 
+      def value
+        @options[:value] || "string"
+      end
+
       def collapse_spaces?(subject)
-        return true if !@options[:collapse_spaces]
+        return true unless @options[:collapse_spaces]
 
-        subject.send("#{@attribute}=", " string    string ")
+        subject.send("#{@attribute}=", " #{value}    #{value} ")
         subject.valid?
-        subject.send(@attribute) == "string string"
+        subject.send(@attribute) == "#{value} #{value}"
       end
 
-      def expectation(past = true)
+      def expectation(past: true)
         expectation = past ? "stripped" : "strip"
         expectation += past ? " and collapsed" : " and collapse" if @options[:collapse_spaces]
-        expectation += past ? " and replaced" : " and replace" if !@options[:replace_newlines]
+        expectation += past ? " and replaced" : " and replace" unless @options[:replace_newlines]
         expectation
       end
 
       def replace_newlines?(subject)
-        return true if !@options[:replace_newlines]
+        return true unless @options[:replace_newlines]
 
-        subject.send("#{@attribute}=", "string\nstring")
+        subject.send("#{@attribute}=", "#{value}\n#{value}")
         subject.valid?
-        subject.send(@attribute) == "string string"
+        subject.send(@attribute) == "#{value} #{value}"
       end
     end
   end

test/matchers_test.rb

@@ -22,6 +22,13 @@ class SampleMockRecord < Tableless
   attribute :replaceable
   attribute :unreplaceable
   strip_attributes only: [:replaceable], replace_newlines: true
+
+  attribute :upcased
+  strip_attributes only: [:upcased]
+
+  def upcased=(value)
+    super((value.upcase if value))
+  end
 end
 
 describe SampleMockRecord do
@@ -57,19 +64,32 @@ class SampleMockRecord < Tableless
     it "should not replace on other attributes" do
       wont strip_attribute(:unreplaceable).replace_newlines
     end
+
+    it "should not strip normalized attributes missing a custom value" do
+      wont strip_attribute(:upcased)
+      wont strip_attribute(:upcased).using("fOO")
+    end
+
+    it "should strip normalized attributes using a custom value" do
+      must strip_attribute(:upcased).using("BIG")
+    end
   else
-      must { strip_attribute :stripped1 }
-      must { strip_attribute :stripped2 }
-      must { strip_attribute :stripped3 }
-      wont { strip_attribute :unstripped1 }
-      wont { strip_attribute :unstripped2 }
-      wont { strip_attribute :unstripped3 }
-
-      must { strip_attribute(:collapsed).collapse_spaces }
-      wont { strip_attribute(:uncollapsed).collapse_spaces }
-
-      must { strip_attribute(:replaceable).replace_newlines }
-      wont { strip_attribute(:unreplaceable).replace_newlines }
+    must { strip_attribute :stripped1 }
+    must { strip_attribute :stripped2 }
+    must { strip_attribute :stripped3 }
+    wont { strip_attribute :unstripped1 }
+    wont { strip_attribute :unstripped2 }
+    wont { strip_attribute :unstripped3 }
+
+    must { strip_attribute(:collapsed).collapse_spaces }
+    wont { strip_attribute(:uncollapsed).collapse_spaces }
+
+    must { strip_attribute(:replaceable).replace_newlines }
+    wont { strip_attribute(:unreplaceable).replace_newlines }
+
+    wont { strip_attribute(:upcased) }
+    wont { strip_attribute(:upcased).using("fOO") }
+    must { strip_attribute(:upcased).using("BIG") }
   end
 
   it "should fail when testing for strip on an unstripped attribute" do