strip_attributes 1.14.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d901257abbca144b30becb86cd248e512f8f8b140a6f822d3965f1896356d7c
-  data.tar.gz: 798c083261f25f554767c216cfb399961e48e723a5d06355a12f82cb591eed45
+  metadata.gz: 6edf6d84e674dcc78436bec4732122630b57b187744c3e8b57b6eb2ffed615cb
+  data.tar.gz: ef1ef5a59f057bda5c4f6df19f8b867d225e80f8db646c4fdb9339e6eff56ff0
 SHA512:
-  metadata.gz: 01a7956efa14fa00820e59171bbc1324d015a457db4224f1d5903d1c9ecce31b39d2cc9fb34c26a7e9ae2dcf868fc49034682d5d2f6a0bb532ab89c16898a938
-  data.tar.gz: 41ac5050c3810cd7de390efff4564a6cec3b025fc90455ce3b6c084444821a3deeb4873155b4ee00cc86f9dfaa426a31f88d1aeaca8195ee0965c606ea56d04b
+  metadata.gz: 915da1ef26816ff9d32886d44310ac77b927de8f0a49f67a76605d945779ec32a44ac30e0489e4ac9999757aea15dca2a738eeb69e03430a00fb1725cde2cc8c
+  data.tar.gz: f63d3b8dbc5555c787f0f4d5520f10f31f069ac5361dc67dacb4a237061370fc1e0d3e68bed868a3a261c14c4f2e5c340c6c91a2d3bc7a65c2b182e2b56300c5

data/README.md

@@ -1,7 +1,7 @@
 # StripAttributes
 
 [![Gem Version](http://img.shields.io/gem/v/strip_attributes.svg)](https://rubygems.org/gems/strip_attributes)
-[![Build Status](https://github.com/rmm5t/strip_attributes/workflows/CI/badge.svg?branch=master)](https://github.com/rmm5t/strip_attributes/actions?query=workflow%3ACI)
+[![Build Status](https://github.com/rmm5t/strip_attributes/workflows/CI/badge.svg)](https://github.com/rmm5t/strip_attributes/actions/workflows/ci.yml)
 [![Gem Downloads](https://img.shields.io/gem/dt/strip_attributes.svg)](https://rubygems.org/gems/strip_attributes)
 
 StripAttributes is an ActiveModel extension that automatically strips all
@@ -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

data/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__)

data/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")

data/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 @@ module StripAttributes
       StripAttributeMatcher.new(attributes)
     end
 
-    alias_method :strip_attributes, :strip_attribute
+    alias strip_attributes strip_attribute
 
     class StripAttributeMatcher
       def initialize(attributes)
@@ -31,12 +30,17 @@ module StripAttributes
       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 @@ module StripAttributes
         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

data/lib/strip_attributes/version.rb

@@ -1,3 +1,3 @@
 module StripAttributes
-  VERSION = "1.14.1"
+  VERSION = "2.0.1".freeze
 end

data/lib/strip_attributes.rb

@@ -27,8 +27,11 @@ module StripAttributes
   #   U+FEFF ZERO WIDTH NO-BREAK SPACE
   MULTIBYTE_WHITE = "\u180E\u200B\u200C\u200D\u2060\uFEFF".freeze
   MULTIBYTE_SPACE = /[[:space:]#{MULTIBYTE_WHITE}]/.freeze
+  MULTIBYTE_SPACE_AT_ENDS = /\A#{MULTIBYTE_SPACE}+|#{MULTIBYTE_SPACE}+\z/.freeze
   MULTIBYTE_BLANK = /[[:blank:]#{MULTIBYTE_WHITE}]/.freeze
+  MULTIBYTE_BLANK_REPEATED = /#{MULTIBYTE_BLANK}+/.freeze
   MULTIBYTE_SUPPORTED = "\u0020" == " "
+  NEWLINES = /[\r\n]+/.freeze
 
   def self.strip(record_or_string, options = {})
     if record_or_string.respond_to?(:attributes)
@@ -52,26 +55,26 @@ module StripAttributes
 
   def self.strip_string(value, options = {})
     return value unless value.is_a?(String)
-    return value if value.frozen?
 
     allow_empty      = options[:allow_empty]
     collapse_spaces  = options[:collapse_spaces]
     replace_newlines = options[:replace_newlines]
     regex            = options[:regex]
 
+    value = value.dup
     value.gsub!(regex, "") if regex
 
     if MULTIBYTE_SUPPORTED && Encoding.compatible?(value, MULTIBYTE_SPACE)
-      value.gsub!(/\A#{MULTIBYTE_SPACE}+|#{MULTIBYTE_SPACE}+\z/, "")
+      value.gsub!(MULTIBYTE_SPACE_AT_ENDS, "")
     else
       value.strip!
     end
 
-    value.gsub!(/[\r\n]+/, " ") if replace_newlines
+    value.gsub!(NEWLINES, " ") if replace_newlines
 
     if collapse_spaces
       if MULTIBYTE_SUPPORTED && Encoding.compatible?(value, MULTIBYTE_BLANK)
-        value.gsub!(/#{MULTIBYTE_BLANK}+/, " ")
+        value.gsub!(MULTIBYTE_BLANK_REPEATED, " ")
       else
         value.squeeze!(" ")
       end

data/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 @@ describe SampleMockRecord do
     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

data/test/strip_attributes_test.rb

@@ -204,10 +204,12 @@ class StripAttributesTest < Minitest::Test
     assert_equal "",            record.bang
   end
 
-  def test_should_skip_frozen_values
-    record = StripAllMockRecord.new(frozen: " ice ".freeze)
+  def test_should_not_mutate_values
+    record = StripAllMockRecord.new(foo: " foo ")
+    old_value = record.foo
     record.valid?
-    assert_equal " ice ", record.frozen
+    assert_equal "foo",        record.foo
+    refute_equal old_value,    record.foo
   end
 
   def test_should_collapse_duplicate_spaces
@@ -428,7 +430,7 @@ class StripAttributesTest < Minitest::Test
       skip "multi-byte characters not supported by this version of Ruby" unless StripAttributes::MULTIBYTE_SUPPORTED
 
       assert_equal "foo", StripAttributes.strip("\u200A\u200B foo\u200A\u200B ")
-      assert_equal "foo\u20AC".force_encoding("ASCII-8BIT"), StripAttributes.strip("foo\u20AC ".force_encoding("ASCII-8BIT"))
+      assert_equal "foo\u20AC".b, StripAttributes.strip("foo\u20AC ".b)
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: strip_attributes
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Ryan McGeary
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -112,6 +111,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/rake
 - lib/strip_attributes.rb
 - lib/strip_attributes/matchers.rb
 - lib/strip_attributes/shoulda.rb
@@ -128,7 +129,6 @@ metadata:
   changelog_uri: https://github.com/rmm5t/strip_attributes/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rmm5t/strip_attributes
   funding_uri: https://github.com/sponsors/rmm5t
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Whitespace cleanup for ActiveModel attributes
 test_files: