email_stylist 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a7dbc9ec3839af59fa380ebf99de6823ccb7a7f07744c64ee0f263a241b3185
+  data.tar.gz: a34457684d2d8fbace05babc07d0accccf184347a516af56657e6b0945a26a4c
+SHA512:
+  metadata.gz: 87ad996ca3c16a2294a84de2ec0a0fa18090862d498c8963cd1996c00302a18f5d6bffe74ed1d524bfa565cf28ec800df17213b3b19e53f926f92b900aacbdbc
+  data.tar.gz: 1238d1d52d270bfa5d2bda9ffe5ea55596baa6926589e4c4d662bab159b5ad84b44cce5920dbed8497da9c8ce4c2a331d024ecdf83d703e16796208729af6c72

data/.editorconfig

@@ -0,0 +1,6 @@
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Email Stylist Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby: ["2.7"]
+        experimental: [false]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundler cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - name: Setup gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4
+      - name: Tests
+        run: bundle exec rspec -f d
+      - name: Rubocop
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,15 @@
+/.idea/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+spec/internal/log/test.log
+spec/spec/internal/log/test.log
+spec/tmp/db.sqlite3
+.tool-versions
+*.code-workspace

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-gp:
+    - .rubocop.yml
+
+AllCops:
+  SuggestExtensions: false

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tracer_client.gemspec
+gemspec
+
+gem 'combustion', '~> 1.3'
+gem 'pry', '~> 0.12'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.9'
+gem 'rspec-rails', '~> 3.9'
+gem 'rubocop-gp', github: 'corp-gp/rubocop-gp'
+gem 'tilt'

data/Gemfile.lock

@@ -0,0 +1,244 @@
+GIT
+  remote: https://github.com/corp-gp/rubocop-gp.git
+  revision: e3d33016bb3b9945ce9d8d22e77825a223de1a5c
+  specs:
+    rubocop-gp (0.0.4)
+      rubocop
+      rubocop-capybara
+      rubocop-factory_bot
+      rubocop-performance
+      rubocop-rails
+      rubocop-rspec
+      rubocop-rspec_rails
+
+PATH
+  remote: .
+  specs:
+    email_stylist (0.2.1)
+      inky-rb
+      premailer
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (8.1.3)
+      actionview (= 8.1.3)
+      activesupport (= 8.1.3)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.1.3)
+      activesupport (= 8.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (8.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    builder (3.3.0)
+    coderay (1.1.3)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.3.7)
+    connection_pool (3.0.2)
+    crass (1.0.7)
+    css_parser (3.0.0)
+      addressable
+      ssrf_filter (~> 1.5)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (6.0.4)
+    erubi (1.13.1)
+    foundation_emails (2.2.1.0)
+    htmlentities (4.4.2)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    inky-rb (1.4.2.1)
+      foundation_emails (~> 2)
+      nokogiri
+    io-console (0.8.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.20.0)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.25.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    nokogiri (1.19.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (2.1.0)
+    parser (3.3.11.1)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.4)
+      prettyprint
+    premailer (1.29.0)
+      addressable
+      css_parser (>= 1.19.0)
+      htmlentities (>= 4.0.0)
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    pry (0.16.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      reline (>= 0.6.0)
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rack (3.2.6)
+    rack-session (2.1.2)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.3.1)
+      rack (>= 3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.7.0)
+      loofah (~> 2.25)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.3)
+      actionpack (= 8.1.3)
+      activesupport (= 8.1.3)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    rbs (4.0.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubocop (1.88.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-capybara (3.0.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    rubocop-factory_bot (2.28.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.35.5)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rspec (3.10.2)
+      lint_roller (~> 1.1)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
+    rubocop-rspec_rails (2.32.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-rspec (~> 3.5)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    ssrf_filter (1.5.0)
+    thor (1.5.0)
+    tilt (2.7.0)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    zeitwerk (2.8.2)
+
+PLATFORMS
+  arm64-darwin-24
+
+DEPENDENCIES
+  combustion (~> 1.3)
+  email_stylist!
+  pry (~> 0.12)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rspec-rails (~> 3.9)
+  rubocop-gp!
+  tilt
+
+BUNDLED WITH
+   2.7.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 corp-gp
+
+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 @@
+Precompiles mailers views using inky-rb and premailer gems. On average, before using this script, 100 emails were sent in 14 seconds. With this script, 100 emails are sent in 2.2 seconds.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task default: :spec

data/email_stylist.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_stylist/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.name          = 'email_stylist'
+  spec.version       = EmailStylist::VERSION
+  spec.authors       = ['ermolaev']
+  spec.email         = ['andrey@ermolaev.me']
+
+  spec.summary       = 'Email Stylist'
+  spec.description   = 'GP email stylist.'
+  spec.homepage      = 'https://gitlab.groupprice.ru/gp-corp/email_stylist'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'inky-rb'
+  spec.add_dependency 'premailer'
+end

data/lib/email_stylist/styled_erb_template.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'inky'
+require 'premailer'
+require 'net/http'
+
+module EmailStylist
+  class StyledErbTemplate
+
+    # GVL может переключить поток между чтением и записью в любой момент — без мьютекса
+    # потоки гонятся компилировать одновременно
+    MUTEX = Mutex.new
+
+    def self.render( # rubocop:disable Metrics/ParameterLists
+      template_path:,
+      layout_path: nil,
+      compiled_path: nil,
+      css_string: nil,
+      disable_caching: false,
+      view_context: nil
+    )
+      template_id = "#{layout_path}#{template_path}"
+
+      @cache ||= {}
+
+      erb_template =
+        MUTEX.synchronize do
+          @cache[template_id] = nil if disable_caching
+
+          @cache[template_id] ||=
+            begin
+              html = compile(template_path, layout_path).gsub(/<%.*?%>/m) { |s| "base64___#{Base64.strict_encode64(s)}___base64" }
+
+              html = Inky::Core.new.release_the_kraken(html)
+
+              pm = Premailer.new(
+                html,
+                css_string:         css_string,
+                with_html_string:   true,
+                include_link_tags:  true,
+                adapter:            :nokogiri,
+                generate_text_part: false,
+                css_to_attributes:  false,
+                remove_scripts:     false,
+              )
+
+              html = pm.to_inline_css.force_encoding('ASCII-8BIT').gsub(/base64___(.+?)___base64/) { Base64.strict_decode64(Regexp.last_match(1)) }
+
+              if compiled_path
+                write_compiled_erb(html, compiled_path)
+                Tilt::ERBTemplate.new(compiled_path)
+              else
+                Tilt::ERBTemplate.new { html }
+              end
+            end
+        end
+
+      erb_template.render(view_context)
+    end
+
+    class << self
+
+      private def write_compiled_erb(html, compiled_path)
+        dir_name = File.dirname(compiled_path)
+        FileUtils.mkdir_p(dir_name)
+
+        # MUTEX защищает только потоки одного процесса, а файл общий для всех
+        # процессов. Пишем во временный файл и атомарно переименовываем — читатель
+        # никогда не увидит обнулённый File.binwrite другого процесса/потока.
+        temp_path = "#{compiled_path}.tmp.#{Process.pid}.#{Thread.current.object_id}"
+        File.binwrite(temp_path, html)
+        File.rename(temp_path, compiled_path)
+      rescue StandardError
+        FileUtils.rm_f(temp_path)
+        raise
+      end
+
+      private def compile(template, layout)
+        html = read_with_lock(layout || template)
+
+        if layout
+          html = html.each_line.map { |s|
+            if s.include?('INCLUDE_BODY')
+              read_with_lock(template)
+            else
+              s
+            end
+          }.join
+        end
+
+        compile_components(html)
+      end
+
+      private def read_with_lock(path)
+        File.open(path, 'rb') do |f|
+          f.flock(File::LOCK_SH)
+          f.read
+        end
+      end
+
+      private def compile_components(html)
+        html.each_line.map { |s|
+          if (m = s.match(/INCLUDE_COMPONENT.*path="(.*)"/)) && m[1]
+            compile_components(read_with_lock(m[1]))
+          else
+            s
+          end
+        }.join
+      end
+
+    end
+
+  end
+end

data/lib/email_stylist/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailStylist
+
+  VERSION = '0.2.1'
+
+end

data/lib/email_stylist.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'email_stylist/version'
+require 'email_stylist/styled_erb_template'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: email_stylist
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- ermolaev
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inky-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: premailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GP email stylist.
+email:
+- andrey@ermolaev.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- email_stylist.gemspec
+- lib/email_stylist.rb
+- lib/email_stylist/styled_erb_template.rb
+- lib/email_stylist/version.rb
+homepage: https://gitlab.groupprice.ru/gp-corp/email_stylist
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Email Stylist
+test_files: []