actionmailer-markdown 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 241e3bc0bc80195ce7c84277d26267685d9ec861e4eb457bd2dd690a7ed8d1e4
-  data.tar.gz: c74e85daf173235889b016eb4c2ec9a4cfc8be79862a9581bc975eea16600fdb
+  metadata.gz: 3ebe1db37d8bd6b28e2831cb9d82b40588c8e941017b5f760bd2e2f05c8b89ce
+  data.tar.gz: 24f0b8c284ecbd0709914ad1b682fb2b24d5736f4e718a8bd9c4e1595faf47a5
 SHA512:
-  metadata.gz: 707a0f1a494260968fea4ba24734b137da663cbc6db4894da83d58a8293845e134f3c382de9d29e52612925f0c7506e1b8511ab5debb2476cdc6fa83d066756d
-  data.tar.gz: 9a143bb2bc4966b3c035d3e8f8b970a678bd328e9e4b0582482f887b0ded12509c4e8181f746b58794268bafe5ca58a5fbd5c3eb94fada913349f8f48c861490
+  metadata.gz: abb1f8588b16bcce4f51a63a51f24e91dc21d451e888791a1baa8c728c2a7ec0293359ac1c41731ce6aa0cef7eb618d73326252174ed0194f6285d26e833fdd5
+  data.tar.gz: 3a9a020648059ef34ac7be7f5add29efd8d9b4a95484ca6b8ffdbc868e37251850ebc4b58c141958e0f4eca441709436a01652642394e2f26c305f2f48677049

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.rubocop.yml

@@ -1,92 +1,21 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-  Exclude:
-    - db/schema.rb
-    - db/seeds.rb
-    - config/environments/**/*.rb
-    - bin/**/*
-    - vendor/**/*
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Layout/SpaceInsideBlockBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: space
-  SpaceBeforeBlockParameters: false
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-  EnforcedStyleForEmptyBraces: no_space
-
-Layout/FirstArrayElementLineBreak:
-  Enabled: true
-
-Layout/FirstHashElementLineBreak:
-  Enabled: true
-
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%": "[]"
-    "%i": "[]"
-    "%q": "[]"
-    "%Q": "[]"
-    "%r": "{}"
-    "%s": "[]"
-    "%w": "[]"
-    "%W": "[]"
-    "%x": "[]"
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
 
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Style/AccessModifierDeclarations:
-  EnforcedStyle: inline
-
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
-Metrics/PerceivedComplexity:
+Layout/LineLength:
   Enabled: false
 
-Style/AsciiComments:
+Metrics:
   Enabled: false
 
-Style/HashSyntax:
-  Exclude:
-    - Rakefile
-    - "**/*.rake"
-
-Style/SymbolArray:
-  Exclude:
-    - Rakefile
-    - "**/*.rake"
-
 Naming/FileName:
   Exclude:
     - lib/actionmailer-markdown.rb
 
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
+Style/OpenStructUse:
+  Exclude:
+    - test/**/*.rb

data/README.md

@@ -1,8 +1,5 @@
 # ActionMailer::Markdown
 
-[![Travis-CI](https://travis-ci.org/fnando/actionmailer-markdown.png)](https://travis-ci.org/fnando/actionmailer-markdown)
-[![Code Climate](https://codeclimate.com/github/fnando/actionmailer-markdown/badges/gpa.svg)](https://codeclimate.com/github/fnando/actionmailer-markdown)
-[![Test Coverage](https://codeclimate.com/github/fnando/actionmailer-markdown/badges/coverage.svg)](https://codeclimate.com/github/fnando/actionmailer-markdown/coverage)
 [![Gem](https://img.shields.io/gem/v/actionmailer-markdown.svg)](https://rubygems.org/gems/actionmailer-markdown)
 [![Gem](https://img.shields.io/gem/dt/actionmailer-markdown.svg)](https://rubygems.org/gems/actionmailer-markdown)
 
@@ -26,7 +23,9 @@ Or install it yourself as:
 
 ## Usage
 
-Imagine that you have a mail named `UserMailer#welcome`. Instead of manually defining your subjects like the following, you can create the subject by defining the `user_mailer.welcome.subject` translation.
+Imagine that you have a mail named `UserMailer#welcome`. Instead of manually
+defining your subjects like the following, you can create the subject by
+defining the `user_mailer.welcome.subject` translation.
 
 ```ruby
 # app/mailers/user_mailer.rb
@@ -45,7 +44,9 @@ en:
       subject: Welcome to my app
 ```
 
-Since I really like defining everything I can in I18n files, I always extend this behavior to the message's body, through the `user_mailer.welcome.body` translation.
+Since I really like defining everything I can in I18n files, I always extend
+this behavior to the message's body, through the `user_mailer.welcome.body`
+translation.
 
 ```yaml
 # config/locales/en.yml
@@ -60,7 +61,8 @@ en:
         Myapp team
 ```
 
-Did you notice that `|`? That allows YAML strings to be multiline. And on your e-mail class you can do something like this:
+Did you notice that `|`? That allows YAML strings to be multiline. And on your
+e-mail class you can do something like this:
 
 ```ruby
 # app/mailers/user_mailer.rb
@@ -71,7 +73,8 @@ class UserMailer < ApplicationMailer
 end
 ```
 
-And if you want to render HTML and text-plain from this string, you may have to do something like this (Markdown class not shown).
+And if you want to render HTML and text-plain from this string, you may have to
+do something like this (Markdown class not shown).
 
 ```ruby
 # app/mailers/user_mailer.rb
@@ -87,7 +90,8 @@ class UserMailer < ApplicationMailer
 end
 ```
 
-This idea is really nice, but you have too much things to deal with. Not anymore!
+This idea is really nice, but you have too much things to deal with. Not
+anymore!
 
 With ActionMailer::Markdown you can just define your mailer action like this:
 
@@ -100,17 +104,20 @@ class UserMailer < ApplicationMailer
 end
 ```
 
-That's right! This gem automatically uses `user_mailer.welcome.{subject,body}` from your translation files. And the best part: it evens supports Markdown.
+That's right! This gem automatically uses `user_mailer.welcome.{subject,body}`
+from your translation files. And the best part: it evens supports Markdown.
 
 ### Passing variables
 
-You're likely to pass in variables to your messages. To do this, just define instance variables. Imagine you want to parse the user's name on your subject and message. Let's suppose you have your translation file defined like this:
+You're likely to pass in variables to your messages. To do this, just define
+instance variables. Imagine you want to parse the user's name on your subject
+and message. Let's suppose you have your translation file defined like this:
 
 ```yaml
 en:
   user_mailer:
     welcome:
-      subject: 'Welcome to Myapp, %{name}'
+      subject: "Welcome to Myapp, %{name}"
       body: |
         Hello, %{name}. And welcome to Myapp.
 ```
@@ -156,7 +163,8 @@ en:
         Myapp team
 ```
 
-You may be wondering what happens with the mail's text part. Don't worry! ActionMailer::Markdown will take care of that. That message will be rendered as:
+You may be wondering what happens with the mail's text part. Don't worry!
+ActionMailer::Markdown will take care of that. That message will be rendered as:
 
 ```text
 Hello, John!
@@ -172,11 +180,16 @@ Myapp team
 
 Lists and other elements are also exported to a more friendly text version.
 
-**PROTIP:** Use [i18n-dot_lookup](https://github.com/fnando/i18n-dot_lookup) if you want to access properties from an object, like `%{user.name}`
+**PROTIP:** Use [i18n-dot_lookup](https://github.com/fnando/i18n-dot_lookup) if
+you want to access properties from an object, like `%{user.name}`
 
 ### Replacing the Markdown engine
 
-[redcarpet](https://github.com/vmg/redcarpet) is the default Markdown parser. You may want to specify different options or even switch out to a different Markdown library. All you have to do is defining a processor that responds to `.call`. Let's say you want to use [kramdown](http://kramdown.gettalong.org/) as your Markdown engine.
+[redcarpet](https://github.com/vmg/redcarpet) is the default Markdown parser.
+You may want to specify different options or even switch out to a different
+Markdown library. All you have to do is defining a processor that responds to
+`.call`. Let's say you want to use [kramdown](http://kramdown.gettalong.org/) as
+your Markdown engine.
 
 ```ruby
 ActionMailer::Markdown.processor = -> text { Kramdown::Document.new(text).to_html }
@@ -184,23 +197,36 @@ ActionMailer::Markdown.processor = -> text { Kramdown::Document.new(text).to_htm
 
 ### Falling back to ActionMailer's default behavior
 
-You can use templates if you want. Just don't define the `.body` part of your translation. Also, if you pass a block to the `mail()` method, it will skip this functionally completely.
+You can use templates if you want. Just don't define the `.body` part of your
+translation. Also, if you pass a block to the `mail()` method, it will skip this
+functionally completely.
 
 ### Using markdown files
 
-If you want to use Markdown files instead of I18n translations, this gem is not for you. Consider using [maildown](https://github.com/schneems/maildown) or [markerb](https://github.com/plataformatec/markerb).
+If you want to use Markdown files instead of I18n translations, this gem is not
+for you. Consider using [maildown](https://github.com/schneems/maildown) or
+[markerb](https://github.com/plataformatec/markerb).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/actionmailer-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/fnando/actionmailer-markdown. This project is intended to be
+a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -17,4 +17,4 @@ Rake::TestTask.new(:test) do |t|
   t.warning = false
 end
 
-task :default => [:test, :rubocop]
+task default: %i[test rubocop]

data/actionmailer-markdown.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/fnando/actionmailer-markdown"
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
@@ -27,6 +28,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rails"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-console"
+  spec.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
 end

data/lib/action_mailer/markdown/ext.rb

@@ -7,19 +7,18 @@ ActionMailer::Base.class_eval do
     options = variables_set_by_user
     subject = get_translation_for("subject", options)
     headers[:subject] ||= subject
-    headers[:locals] = {a: 1}
-    mail_method.bind(self).call(headers, &block)
+    mail_method.bind_call(self, headers, &block)
   end
 
   def get_translation_for(key, options)
-    I18n.t(key, options.merge(scope: [mailer_scope, action_name], raise: true))
+    I18n.t(key, **options.merge(scope: [mailer_scope, action_name], raise: true))
   rescue I18n::MissingTranslationData
     nil
   end
 
   def variables_set_by_user
     instance_variables.each_with_object({}) do |name, buffer|
-      next if name =~ /^@_/
+      next if /^@_/.match?(name)
 
       name = name.to_s[/^@(.*?)$/, 1]
       buffer[name.to_sym] = instance_variable_get("@#{name}")

data/lib/action_mailer/markdown/resolver.rb

@@ -8,7 +8,13 @@ module ActionMailer
         html: :md
       }.freeze
 
-      def find_templates(name, prefix, _partial, details, _outside_app_allowed = false)
+      def find_templates(
+        name,
+        prefix,
+        _partial,
+        details,
+        _outside_app_allowed = false # rubocop:disable Style/OptionalBooleanParameter
+      )
         contents = find_contents(name, prefix, details)
         return [] unless contents
 

data/lib/action_mailer/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module ActionMailer
   module Markdown
-    VERSION = "0.4.1"
+    VERSION = "0.4.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer-markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -185,9 +199,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -207,8 +221,9 @@ files:
 homepage: https://github.com/fnando/actionmailer-markdown
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -216,15 +231,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: A different take on using ActionMailer, Markdown and I18n.
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-rvm:
-- 2.6.1
-- 2.5.3
-- 2.4.1
-script: bundle exec rake
-before_script:
-- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-- chmod +x ./cc-test-reporter
-- "./cc-test-reporter before-build"
-after_script:
-- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
-notifications:
-  email: false
-env:
-  global:
-    secure: pSJLckgoZMZ67Le7TgjbX1ptaeRtPW+IhORZvxoiAR1nVmLCFHOq1ZHSJiw3J0t1A2GMdsTbXH/JDBcrbUzuKgJ3+XIyoAuUa1Hz1UjDkXh4RjwZrG/71hU3x0fVU1JXWDjFkGlqYJqwBYXkX1RK8K30NMnRGi7cr9wOLi0OI7fQ4ImrjIrh7m2hx1mZ97jeZt2HewomPO5OVK4hEDCxKFEzcThE8qOjr1eJRM9yYkwUGvO4Lw7louT95RKbJgjmndKEzbgJ4ggt2wGMvMarOqkM3QNCenp7JaaeaeQNt/szGNYH7bwjDEBNi8bSIIx+jFFpaCoIr/lp12XLDYPgw9dzSeQKLWwXHRDl6GmLNYldXaFfF4OnCaOq68L+0PNz0vD808W3SoTosE7jb5cS3ufRJUMujLRI1Kk2EuG2V0wFpmtCXtBV/LVkhUSqotvjI+ymO1zqyGcPbxVGO6WpIxMhiFC7+ZGsdOm0aliAMd6dAZ/6UPWGTSdMR6MECaCDtqBFv8JCnybWr5xxG3gnR9vqanA3sgrGjWxEIJrtF59vcPgrI6SUM7d4a7FBWHMU0AZSRvVX2umiTZVy/DOJEL/j0COunbcogCbTuAN1/gSNWTUTmF6kIV4BYUYEYx4HnpegIKcYKHKv74nbV4bhaSNuj+M/xOVPb2+Ms5kuG8E=