strip-tags 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af2346bfaf613d78a8cb0451d6913ae788b5a629fff5d72466de3be531370265
+  data.tar.gz: daff9b49baf2be82e9a7846c96e71d0bcab2999a425e4cff3f8816c228745956
+SHA512:
+  metadata.gz: abc5ec6a88ceab556c9ac892e4fe43d409ead3047efb2cadb7f88e602ac70ef2f45a3e6405019dff004f1cd4263b1761e0d14fac9b6ea9da6ff494c10edb92fa
+  data.tar.gz: 046170e57a5a5b993a92265adc4a0624d8201b6257fd331aafdc0324869497f1348d0ea1789e3184a08c52fe14195a58498ca87da37c21038ce04ab710285704

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Main]
+
+## [1.0.0] - 2023-08-03
+
+  - First version.

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    strip-tags (1.0.5)
+      activemodel (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.6)
+      actionview (= 7.0.6)
+      activesupport (= 7.0.6)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.6)
+      activesupport (= 7.0.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.4)
+      actionpack (>= 3.0.2, < 7.1)
+      activemodel (>= 3.0.2, < 7.1)
+      activesupport (>= 3.0.2, < 7.1)
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.18.1)
+    nokogiri (1.15.3-arm64-darwin)
+      racc (~> 1.4)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  active_attr (~> 0.15)
+  rake
+  rspec (>= 3.12.0)
+  strip-tags!
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Martin Moen Wulffeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,265 @@
+# strip-tags
+
+[![Gem Version](http://img.shields.io/gem/v/strip-tags.svg)](https://rubygems.org/gems/strip-tags)
+[![Build Status](https://github.com/wulffeld/strip-tags/workflows/CI/badge.svg?branch=main)](https://github.com/wulffeld/strip-tags/actions?query=workflow%3ACI)
+[![Gem Downloads](https://img.shields.io/gem/dt/strip-tags.svg)](https://rubygems.org/gems/strip-tags)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7b3c646f87ca2d6d691c/maintainability)](https://codeclimate.com/github/wulffeld/strip-tags)
+
+An ActiveModel extension that strips tags from attributes before validation using the strip-tags helper.
+
+It preserves '&', '<' and '>' characters.
+
+It works by adding a before_validation hook to the record.  By default, all
+attributes are stripped of tags, but `:only` and `:except` options can be
+used to limit which attributes are stripped.  Both options accept a single
+attribute (`only: :field`) or arrays of attributes (`except: [:field1,
+:field2, :field3]`).
+
+It's also possible to skip stripping the attributes altogether per model using the `:if` and `:unless` options.
+
+## Installation
+
+Include the gem in your Gemfile:
+
+```ruby
+gem "strip-tags"
+```
+
+## Examples
+
+### Default Behavior
+
+```ruby
+class DrunkPokerPlayer < ActiveRecord::Base
+  strip-tags
+end
+```
+
+### Using `except`
+
+```ruby
+# all attributes will be stripped except :boxers
+class SoberPokerPlayer < ActiveRecord::Base
+  strip-tags except: :boxers
+end
+```
+
+### Using `only`
+
+```ruby
+# only :shoe, :sock, and :glove attributes will be stripped
+class ConservativePokerPlayer < ActiveRecord::Base
+  strip-tags only: [:shoe, :sock, :glove]
+end
+```
+
+### Using `if`
+
+```ruby
+# Only records with odd ids will be stripped
+class OddPokerPlayer < ActiveRecord::Base
+  strip-tags if: :strip_me?
+
+  def strip_me?
+    id.odd?
+  end
+end
+```
+
+### Using `unless`
+
+```ruby
+# strip-tags will be applied randomly
+class RandomPokerPlayer < ActiveRecord::Base
+  strip-tags unless: :strip_me?
+
+  def strip_me?
+    [true, false].sample
+  end
+end
+```
+
+### Using `allow_empty`
+
+```ruby
+# Empty attributes will not be converted to nil
+class BrokePokerPlayer < ActiveRecord::Base
+  strip-tags allow_empty: true
+end
+```
+
+## Usage Patterns
+
+### Other ORMs implementing `ActiveModel`
+
+It also works on other ActiveModel classes, such as [Mongoid](http://mongoid.org/) documents:
+
+```ruby
+class User
+  include Mongoid::Document
+
+  strip-tags only: :email
+end
+```
+
+### Using it with [`ActiveAttr`](https://github.com/cgriego/active_attr)
+
+```ruby
+class Person
+  include ActiveAttr::Model
+  include ActiveModel::Validations::Callbacks
+
+  attribute :name
+  attribute :email
+
+  strip-tags
+end
+
+```
+
+### Using it directly
+
+```ruby
+# where record is an ActiveModel instance
+StripTags.strip(record,: true)
+
+# works directly on Strings too
+StripTags.strip(" foo \t") #=> "foo"
+StripTags.strip(" foo   bar",: true) #=> "foo bar"
+```
+
+## Testing
+
+StripTags provides an RSpec/Shoulda-compatible matcher for easier
+testing of attribute assignment. You can use this with
+[RSpec](http://rspec.info/), [Shoulda](https://github.com/thoughtbot/shoulda),
+[Minitest-MatchersVaccine](https://github.com/rmm5t/minitest-matchers_vaccine)
+(preferred), or
+[Minitest-Matchers](https://github.com/wojtekmach/minitest-matchers).
+
+### Setup `spec_helper.rb` or `test_helper.rb`
+
+#### To initialize **RSpec**, add this to your `spec_helper.rb`:
+
+```ruby
+require "strip-tags/matchers"
+
+RSpec.configure do |config|
+  config.include StripTags::Matchers
+end
+```
+
+#### To initialize **Shoulda (with test-unit)**, add this to your `test_helper.rb`:
+
+```ruby
+require "strip-tags/matchers"
+
+class Test::Unit::TestCase
+  extend StripTags::Matchers
+end
+```
+
+OR if in a Rails environment, you might prefer this:
+
+``` ruby
+require "strip-tags/matchers"
+
+class ActiveSupport::TestCase
+  extend StripTags::Matchers
+end
+```
+
+#### To initialize **Minitest-MatchersVaccine**, add this to your `test_helper.rb`:
+
+```ruby
+require "strip-tags/matchers"
+
+class MiniTest::Spec
+  include StripTags::Matchers
+end
+```
+
+OR if in a Rails environment, you might prefer this:
+
+``` ruby
+require "strip-tags/matchers"
+
+class ActiveSupport::TestCase
+  include StripTags::Matchers
+end
+```
+
+#### To initialize **Minitest-Matchers**, add this to your `test_helper.rb`:
+
+```ruby
+require "strip-tags/matchers"
+
+class MiniTest::Spec
+  include StripTags::Matchers
+end
+```
+
+### Writing Tests
+
+**RSpec**:
+
+```ruby
+describe User do
+  it { is_expected.to strip_tag(:name) }
+  it { is_expected.not_to strip_tag(:password)  }
+end
+```
+
+**Shoulda (with test-unit)**:
+
+```ruby
+class UserTest < ActiveSupport::TestCase
+  should strip_tag(:name)
+  should strip-tags(:name, :email)
+  should_not strip_tag(:password)
+  should_not strip-tags(:password, :encrypted_password)
+end
+```
+
+**Minitest-MatchersVaccine**:
+
+```ruby
+describe User do
+  subject { User.new }
+
+  it "strips attributes" do
+    must strip_tag(:name)
+    must strip-tags(:name, :email)
+    wont strip_tag(:password)
+    wont strip-tags(:password, :encrypted_password)
+  end
+end
+```
+
+**Minitest-Matchers**:
+
+```ruby
+describe User do
+  subject { User.new }
+
+  must { strip_tag(:name) }
+  must { strip-tags(:name, :email) }
+  wont { strip_tag(:password) }
+  wont { strip-tags(:password, :encrypted_password) }
+end
+```
+
+## Support
+
+Submit suggestions or feature requests as a GitHub Issue or Pull
+Request (preferred). If you send a pull request, remember to update the
+corresponding unit tests.  In fact, I prefer new features to be submitted in the
+form of new unit tests.
+
+## Credits
+
+Original code 99% from the [strip_attributes](https://github.com/rmm5t/strip_attributes) gem.
+
+## Versioning
+
+Semantic Versioning 2.0 as defined at <http://semver.org>.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gemfiles/activemodel-5.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activemodel", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/activemodel-6.1.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activemodel", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/activemodel-7.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activemodel", "~> 7.0.0"
+
+gemspec path: "../"

data/lib/strip-tags/matchers.rb

@@ -0,0 +1,61 @@
+module StripTags
+  module Matchers
+    # RSpec Examples:
+    #
+    #   it { is_expected.to strip_tag(:first_name) }
+    #   it { is_expected.to strip_tags(:first_name, :last_name) }
+    #   it { is_expected.not_to strip_tag(:password) }
+    #   it { is_expected.not_to strip_tags(:password, :encrypted_password) }
+    #
+    # Minitest Matchers Examples:
+    #
+    #   must { strip_tag(:first_name) }
+    #   must { strip_tags(:first_name, :last_name) }
+    #   wont { strip_tag(:password) }
+    #   wont { strip_tags(:password, :encrypted_password) }
+    def strip_tag(*attributes)
+      StripTagsMatcher.new(attributes)
+    end
+
+    alias_method :strip_tags, :strip_tag
+
+    class StripTagsMatcher
+      def initialize(attributes)
+        @attributes = attributes
+        @options = {}
+      end
+
+      def matches?(subject)
+        @attributes.all? do |attribute|
+          @attribute = attribute
+          subject.send("#{@attribute}=", "foo> & <<script>alert('xss')</script>")
+          subject.valid?
+          subject.send(@attribute) == "foo> & <"
+        end
+      end
+
+      def failure_message # RSpec 3.x
+        "Expected tags 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
+
+      def failure_message_when_negated # RSpec 3.x
+        "Expected tags 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
+
+      def description
+        "#{expectation(false)} tags from #{@attributes.map {|el| "##{el}" }.to_sentence}"
+      end
+
+      private
+
+      def expectation(past = true)
+        expectation = past ? "stripped" : "strip"
+        expectation += past ? " and replaced" : " and replace"
+        expectation
+      end
+    end
+  end
+end

data/lib/strip-tags/version.rb

@@ -0,0 +1,3 @@
+module StripTags
+  VERSION = "1.0.5"
+end

data/lib/strip-tags.rb

@@ -0,0 +1,70 @@
+require "active_model"
+require "action_controller"
+
+module ActiveModel::Validations::HelperMethods
+  # Strips tags from model fields.
+  def strip_tags(options = {})
+    StripTags.validate_options(options)
+
+    before_validation(options.slice(:if, :unless)) do |record|
+      StripTags.strip(record, options)
+    end
+  end
+end
+
+module StripTags
+  VALID_OPTIONS = [:only, :except, :allow_empty, :regex, :if, :unless].freeze
+
+  def self.strip(record_or_string, options = {})
+    if record_or_string.respond_to?(:attributes)
+      strip_record(record_or_string, options)
+    else
+      strip_string(record_or_string, options)
+    end
+  end
+
+  def self.strip_record(record, options = {})
+    attributes = narrow(record.attributes, options)
+
+    attributes.each do |attr, value|
+      original_value = value
+      value = strip_string(value, options)
+      record[attr] = value if original_value != value
+    end
+
+    record
+  end
+
+  def self.strip_string(value, options = {})
+    return value unless value.is_a?(String)
+    return value if value.frozen?
+
+    allow_empty = options[:allow_empty]
+
+    value = ActionController::Base.helpers.strip_tags(value).gsub("&amp;", "&").gsub("&gt;", ">").gsub("&lt;", "<")
+
+    (value.blank? && !allow_empty) ? nil : value
+  end
+
+  # Necessary because Rails has removed the narrowing of attributes using :only
+  # and :except on Base#attributes
+  def self.narrow(attributes, options = {})
+    if except = options[:except]
+      except = Array(except).collect { |attribute| attribute.to_s }
+      attributes.except(*except)
+    elsif only = options[:only]
+      only = Array(only).collect { |attribute| attribute.to_s }
+      attributes.slice(*only)
+    else
+      attributes
+    end
+  end
+
+  def self.validate_options(options)
+    if keys = options.keys
+      unless (keys - VALID_OPTIONS).empty?
+        raise ArgumentError, "Options does not specify #{VALID_OPTIONS} (#{options.keys.inspect})"
+      end
+    end
+  end
+end

data/strip_tags.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/strip-tags/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "strip-tags"
+  spec.version = StripTags::VERSION
+  spec.authors = ["Martin Moen Wulffeld"]
+  spec.email = ["martin@wulffeld.dk"]
+
+  spec.summary = "Strip tags from fields in your models."
+  spec.description = "An ActiveModel extension that strips tags from attributes before validation using the strip-tags helper."
+  spec.homepage = "https://github.com/wulffeld/strip-tags"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wulffeld/strip-tags"
+  spec.metadata["changelog_uri"] = "https://github.com/wulffeld/strip-tags/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activemodel", ">= 5.2"
+  spec.add_development_dependency "active_attr", "~> 0.15"
+  spec.add_development_dependency "rspec", ">= 3.12.0"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: strip-tags
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- Martin Moen Wulffeld
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An ActiveModel extension that strips tags from attributes before validation
+  using the strip-tags helper.
+email:
+- martin@wulffeld.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- gemfiles/activemodel-5.2.gemfile
+- gemfiles/activemodel-6.1.gemfile
+- gemfiles/activemodel-7.0.gemfile
+- lib/strip-tags.rb
+- lib/strip-tags/matchers.rb
+- lib/strip-tags/version.rb
+- strip_tags.gemspec
+homepage: https://github.com/wulffeld/strip-tags
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wulffeld/strip-tags
+  source_code_uri: https://github.com/wulffeld/strip-tags
+  changelog_uri: https://github.com/wulffeld/strip-tags/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Strip tags from fields in your models.
+test_files: []