sanitize_email 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7496020f3a0eb3316969b622590c311c5684de54acf9141521043017a534b842
-  data.tar.gz: b9d715acafb0d1ce744720756524ce1235dc95e6744f375d11ee2689125184e7
+  metadata.gz: 01fa948760859a93fec72f7222ef550a8d14fb1366181977d5c951c127b3c5f5
+  data.tar.gz: 0c39cdac07dad7125f8644e69a10ce019e645f75cfde524f0ef389bb00bc2453
 SHA512:
-  metadata.gz: e7878f30073db37643499d8c21610030f63cba4444c703c20c06fce00180a53c29b618b0fbe0396cb613897f837387245164b2fe27e65c2f2fce7638c35e8abe
-  data.tar.gz: 18c5def158cb17a95a1587b3a4bdcf28b5bfe12c5dc6a085d7027b97b7897ab69c7c9efb8bae9f48b0f8e356650f9f28c3625b47dc711f64217e3f9777ae5eea
+  metadata.gz: e8d523a93e0ddb26df9d244b93e4a11256fe8da667b88a08af0fad36da07b3adac86a9b2c82404805cbb532d17718cd3788691e103b903fe88527e510e37278e
+  data.tar.gz: 5a29e1bb4b70cd51ae401d7d789484a904881ae2431f3296fcc89c8daf7d055d05cc4ed191763aab3a2962cdbd8e34ace6434ed4fdc97f93bfef2ca84a397cc3

data/.gitignore

@@ -9,3 +9,4 @@ spec/tmp
 Gemfile.lock
 gemfiles/*.lock
 rdoc/*
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,73 @@
+require: rubocop-rspec
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop_rspec.yml
+AllCops:
+  DisplayCopNames: true # Display the name of the failing cops
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'gemfiles/vendor/**/*'
+    - 'vendor/**/*'
+    - '**/.irbrc'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 4
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'gemfiles/vendor/**/*'
+    - 'vendor/**/*'
+    - '**/.irbrc'
+
+Style/ClassVars:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    map:      'collect'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/Encoding:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.rubocop_rspec.yml

@@ -0,0 +1,35 @@
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/RepeatedExample:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Lambda:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+# Once we drop Rubies that lack support for __dir__ we can turn this on.
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false

data/Appraisals

@@ -1,55 +1,57 @@
-appraise "rails-3-0" do
-    gem "rails", "~> 3.0.0"
-    gem "reek", "~> 2.0" # for Ruby < 2.0
-    gem "tins", "~> 1.6.0" # for Ruby < 2.0
-    gem "json", "~> 1.8.3"
-    gem "rake", "~> 11.2.2"
-    gem "rest-client", "~> 1.8.0"
+# frozen_string_literal: true
+
+appraise 'rails-3-0' do
+  gem 'rails', '~> 3.0.0'
+  gem 'reek', '~> 2.0' # for Ruby < 2.0
+  gem 'tins', '~> 1.6.0' # for Ruby < 2.0
+  gem 'json', '~> 1.8.3'
+  gem 'rake', '~> 11.2.2'
+  gem 'rest-client', '~> 1.8.0'
 end
-appraise "rails-3-1" do
-    gem "actionmailer", "~> 3.1.0"
-    gem "railties", "~> 3.1.0"
-    gem "reek", "~> 2.0" # for Ruby < 2.0
-    gem "tins", "~> 1.6.0" # for Ruby < 2.0
-    gem "json", "~> 1.8.3"
-    gem "rake", "~> 11.2.2"
-    gem "rest-client", "~> 1.8.0"
+appraise 'rails-3-1' do
+  gem 'actionmailer', '~> 3.1.0'
+  gem 'railties', '~> 3.1.0'
+  gem 'reek', '~> 2.0' # for Ruby < 2.0
+  gem 'tins', '~> 1.6.0' # for Ruby < 2.0
+  gem 'json', '~> 1.8.3'
+  gem 'rake', '~> 11.2.2'
+  gem 'rest-client', '~> 1.8.0'
 end
-appraise "rails-3-2" do
-    gem "actionmailer", "~> 3.2.0"
-    gem "railties", "~> 3.2.0"
-    # reek >= 4.0 requires Ruby 2.1 minimum
-    gem "reek", "~>3.11.0"
-    gem "json", "~> 1.8.3"
-    gem "rake", "~> 11.2.2"
+appraise 'rails-3-2' do
+  gem 'actionmailer', '~> 3.2.0'
+  gem 'railties', '~> 3.2.0'
+  # reek >= 4.0 requires Ruby 2.1 minimum
+  gem 'reek', '~>3.11.0'
+  gem 'json', '~> 1.8.3'
+  gem 'rake', '~> 11.2.2'
 end
 
-appraise "rails-4-0" do
-    gem "actionmailer", "~> 4.0.0"
-    gem "railties", "~> 4.0.0"
-    # reek >= 4.0 requires Ruby 2.1 minimum
-    gem "reek", "~>3.11.0"
-    gem "json", "~> 1.8.3"
-    gem "rake", "~> 11.2.2"
+appraise 'rails-4-0' do
+  gem 'actionmailer', '~> 4.0.0'
+  gem 'railties', '~> 4.0.0'
+  # reek >= 4.0 requires Ruby 2.1 minimum
+  gem 'reek', '~>3.11.0'
+  gem 'json', '~> 1.8.3'
+  gem 'rake', '~> 11.2.2'
 end
-appraise "rails-4-1" do
-    gem "actionmailer", "~> 4.1.0"
-    gem "railties", "~> 4.1.0"
-    # reek >= 4.0 requires Ruby 2.1 minimum
-    gem "reek", "~>3.11.0"
-    gem "json", "~> 1.8.3"
-    gem "rake", "~> 11.2.2"
+appraise 'rails-4-1' do
+  gem 'actionmailer', '~> 4.1.0'
+  gem 'railties', '~> 4.1.0'
+  # reek >= 4.0 requires Ruby 2.1 minimum
+  gem 'reek', '~>3.11.0'
+  gem 'json', '~> 1.8.3'
+  gem 'rake', '~> 11.2.2'
 end
-appraise "rails-4-2" do
-    gem "actionmailer", "~> 4.2.0"
-    gem "railties", "~> 4.2.0"
-    gem "json", "~> 1.8.3"
-    gem "rake", "~> 11.2.2"
+appraise 'rails-4-2' do
+  gem 'actionmailer', '~> 4.2.0'
+  gem 'railties', '~> 4.2.0'
+  gem 'json', '~> 1.8.3'
+  gem 'rake', '~> 11.2.2'
 end
 
-appraise "rails-5-0" do
-    gem "actionmailer", "~> 5.0.0"
-    gem "railties", "~> 5.0.0"
-    gem "json", "~> 2.0.2"
-    gem "rake", "~> 11.2.2"
+appraise 'rails-5-0' do
+  gem 'actionmailer', '~> 5.0.0'
+  gem 'railties', '~> 5.0.0'
+  gem 'json', '~> 2.0.2'
+  gem 'rake', '~> 11.2.2'
 end

data/Gemfile

@@ -1,4 +1,17 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group :test do
+  ruby_version = Gem::Version.new(RUBY_VERSION)
+  if ruby_version >= Gem::Version.new('2.1')
+    gem 'rubocop', '~> 0.53.0'
+    gem 'rubocop-rspec', '~> 1.24.0'
+  end
+  gem 'byebug' if ruby_version >= Gem::Version.new('2.0')
+end
 
 # Specify your gem's dependencies in sanitize_email.gemspec
 gemspec

data/Rakefile

@@ -1,50 +1,52 @@
-# encoding: utf-8
-#!/usr/bin/env rake
-require "rubygems"
-require "bundler/setup"
-require "bundler/gem_tasks"
-require "rake"
+
+# frozen_string_literal: true
+
+# !/usr/bin/env rake
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake'
 
 begin
-  require "wwtd/tasks"
-  require "rspec/core/rake_task"
+  require 'wwtd/tasks'
+  require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
   task :default => :spec
   task :test => :spec
 rescue LoadError
-  warn "Failed to load rspec or wwtd"
+  warn 'Failed to load rspec or wwtd'
 end
 
 begin
-  require "reek/rake/task"
+  require 'reek/rake/task'
   Reek::Rake::Task.new do |t|
     t.fail_on_error = true
     t.verbose = false
-    t.source_files = "lib/**/*.rb"
+    t.source_files = 'lib/**/*.rb'
   end
 rescue LoadError
-  warn "Failed to load reek"
+  warn 'Failed to load reek'
 end
 
 begin
-  require "roodi"
-  require "roodi_task"
+  require 'roodi'
+  require 'roodi_task'
   RoodiTask.new do |t|
     t.verbose = false
   end
 rescue LoadError
-  warn "Failed to load roodi"
+  warn 'Failed to load roodi'
 end
 
-require File.expand_path("../lib/sanitize_email/version", __FILE__)
-require "rdoc"
-require "rdoc/task"
+require File.expand_path('lib/sanitize_email/version', __dir__)
+require 'rdoc'
+require 'rdoc/task'
 RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
+  rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = "SanitizeEmail #{SanitizeEmail::VERSION}"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 Bundler::GemHelper.install_tasks

data/gemfiles/rails_4_2.gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "actionmailer", "~> 4.2.0"
-gem "railties", "~> 4.2.0"
-gem "json", "~> 2.1"
-gem "rake", "~> 12.0"
+gem 'actionmailer', '~> 4.2.0'
+gem 'json', '~> 2.1'
+gem 'railties', '~> 4.2.0'
+gem 'rake', '~> 12.0'
 
-gemspec :path => "../"
+gemspec :path => '../'

data/gemfiles/rails_5_0.gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "actionmailer", "~> 5.0.0"
-gem "railties", "~> 5.0.0"
-gem "json", "~> 2.1"
-gem "rake", "~> 12.0"
+gem 'actionmailer', '~> 5.0.0'
+gem 'json', '~> 2.1'
+gem 'railties', '~> 5.0.0'
+gem 'rake', '~> 12.0'
 
-gemspec :path => "../"
+gemspec :path => '../'

data/gemfiles/rails_5_1.gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "actionmailer", "~> 5.1.0"
-gem "railties", "~> 5.1.0"
-gem "json", "~> 2.1"
-gem "rake", "~> 12.0"
+gem 'actionmailer', '~> 5.1.0'
+gem 'json', '~> 2.1'
+gem 'railties', '~> 5.1.0'
+gem 'rake', '~> 12.0'
 
-gemspec :path => "../"
+gemspec :path => '../'

data/gemfiles/rails_5_2.gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "actionmailer", "5.2.0"
-gem "railties", "5.2.0"
-gem "json", "~> 2.1"
-gem "rake", "~> 12.0"
+gem 'actionmailer', '5.2.0'
+gem 'json', '~> 2.1'
+gem 'railties', '5.2.0'
+gem 'rake', '~> 12.0'
 
-gemspec :path => "../"
+gemspec :path => '../'

data/init.rb

@@ -1,2 +1,3 @@
-require "sanitize_email"
+# frozen_string_literal: true
 
+require 'sanitize_email'

data/lib/sanitize_email.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
-module SanitizeEmail
-  require "sanitize_email/version"
-  require "sanitize_email/deprecation"
-  require "sanitize_email/config"
-  require "sanitize_email/mail_header_tools"
-  require "sanitize_email/overridden_addresses"
-  require "sanitize_email/bleach"
+require 'sanitize_email/version'
+require 'sanitize_email/deprecation'
+require 'sanitize_email/config'
+require 'sanitize_email/mail_header_tools'
+require 'sanitize_email/overridden_addresses'
+require 'sanitize_email/bleach'
 
+module SanitizeEmail
   # Error is raised when a block parameter is required and not provided to a method
   class MissingBlockParameter < StandardError; end
 
   # Allow non-rails implementations to use this gem
   if defined?(::Rails)
     if defined?(::Rails::Engine)
-      require "sanitize_email/engine"
-    elsif ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
-      require "sanitize_email/railtie"
+      require 'sanitize_email/engine'
+    elsif ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR.zero?
+      require 'sanitize_email/railtie'
     else
-      raise "Please use the 0.X.X versions of sanitize_email for Rails 2.X and below."
+      raise 'Please use the 0.X.X versions of sanitize_email for Rails 2.X and below.'
     end
   else
     if defined?(Mailer)
@@ -30,7 +32,7 @@ module SanitizeEmail
     if mailer.respond_to?(:register_interceptor)
       mailer.register_interceptor(SanitizeEmail::Bleach)
     else
-      warn "SanitizeEmail was unable to detect a compatible Mail class to register an interceptor on."
+      warn 'SanitizeEmail was unable to detect a compatible Mail class to register an interceptor on.'
     end
   end
 
@@ -39,7 +41,7 @@ module SanitizeEmail
     SanitizeEmail::Config.config[key.to_sym]
   end
 
-  def self.method_missing(name, *_)
+  def self.method_missing(name, *_args)
     SanitizeEmail[name]
   end
 
@@ -80,9 +82,9 @@ module SanitizeEmail
   #   end
   # end
   #
-  def self.sanitary(config_options = {}, &block)
-    raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given?
-    janitor({:forcing => true}) do
+  def self.sanitary(config_options = {})
+    raise MissingBlockParameter, 'SanitizeEmail.sanitary must be called with a block' unless block_given?
+    janitor(:forcing => true) do
       original = SanitizeEmail::Config.config.dup
       SanitizeEmail::Config.config.merge!(config_options)
       yield
@@ -102,15 +104,15 @@ module SanitizeEmail
   #   end
   # end
   #
-  def self.unsanitary &block
-    raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
-    janitor({:forcing => false}) do
+  def self.unsanitary
+    raise MissingBlockParameter, 'SanitizeEmail.unsanitary must be called with a block' unless block_given?
+    janitor(:forcing => false) do
       yield
     end
   end
 
-  def self.janitor(options, &block)
-    raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given?
+  def self.janitor(options)
+    raise MissingBlockParameter, 'SanitizeEmail.janitor must be called with a block' unless block_given?
     original = SanitizeEmail.force_sanitize
     SanitizeEmail.force_sanitize = options[:forcing]
     yield
@@ -123,5 +125,4 @@ module SanitizeEmail
     deprecated_alias :sanitized_recipients, :sanitized_to
     deprecated :local_environments, :activation_proc
   end
-
 end