inky-rb 1.3.7.0 → 1.3.7.1

data/lib/inky/configuration.rb

@@ -0,0 +1,31 @@
+module Inky
+  # @return [Inky::Configuration] Inky's current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Set Inky's configuration
+  # @param config [Inky::Configuration]
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  # Modify Inky's current configuration
+  # @yieldparam [Inky::Configuration] config current Inky config
+  # ```
+  # Inky.configure do |config|
+  #   config.template_engine = :slim
+  # end
+  # ```
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :template_engine
+
+    def initialize
+      @template_engine = :erb
+    end
+  end
+end

data/lib/inky/rails/engine.rb

@@ -4,7 +4,7 @@ module Inky
   module Rails
     class Engine < ::Rails::Engine
       if config.respond_to?(:annotations)
-        config.annotations.register_extensions("inky") { |annotation| %r(//\s*(#{annotation}):?\s*(.*)$) }
+        config.annotations.register_extensions("inky") { |annotation| /<!--\s*(#{annotation}):?\s*(.*) -->/ }
       end
     end
   end

data/lib/inky/rails/template_handler.rb

@@ -1,14 +1,26 @@
 module Inky
   module Rails
     class TemplateHandler
-      class << self
-        def erb_handler
-          @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
-        end
+      def initialize(compose_with = nil)
+        @engine_handler = ActionView::Template.registered_template_handler(compose_with) if compose_with
+      end
+
+      def engine_handler
+        return @engine_handler if @engine_handler
+        type = ::Inky.configuration.template_engine
+        ActionView::Template.registered_template_handler(type) ||
+          raise("No template handler found for #{type}")
+      end
 
-        def call(template)
-          compiled_source = erb_handler.call(template)
-          "Inky::Core.new.release_the_kraken(begin; #{compiled_source};end)"
+      def call(template)
+        compiled_source = engine_handler.call(template)
+        "Inky::Core.new.release_the_kraken(begin; #{compiled_source};end)"
+      end
+
+      module Composer
+        def register_template_handler(ext, *)
+          super
+          super :"inky-#{ext}", Inky::Rails::TemplateHandler.new(ext)
         end
       end
     end
@@ -16,5 +28,9 @@ module Inky
 end
 
 ActiveSupport.on_load(:action_view) do
-  ActionView::Template.register_template_handler :inky, Inky::Rails::TemplateHandler
+  ActionView::Template.template_handler_extensions.each do |ext|
+    ActionView::Template.register_template_handler :"inky-#{ext}", Inky::Rails::TemplateHandler.new(ext)
+  end
+  ActionView::Template.register_template_handler :inky, Inky::Rails::TemplateHandler.new
+  ActionView::Template.singleton_class.send :prepend, Inky::Rails::TemplateHandler::Composer
 end

data/lib/inky/rails/version.rb

@@ -1,6 +1,6 @@
 module Inky
   module Rails
-    VERSION = "1.3.7.0".freeze
+    VERSION = "1.3.7.1".freeze
   end
   NODE_VERSION, GEM_VERSION = Rails::VERSION.rpartition('.').map(&:freeze)
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe "Configuration" do
+  around do |spec|
+    Inky.configure do |config|
+      old = config.template_engine
+      spec.run
+      config.template_engine = old
+    end
+  end
+
+  it "default value is :erb" do
+    Inky::Configuration.new.template_engine = :erb
+  end
+
+  describe "#configuration=" do
+    it "can set value" do
+      config = Inky::Configuration.new
+      config.template_engine = :haml
+      expect(config.template_engine).to eq(:haml)
+    end
+  end
+
+  describe "#configuration=" do
+    before do
+      Inky.configure do |config|
+        config.template_engine = :haml
+      end
+    end
+
+    it "returns :haml as configured template_engine" do
+      template_engine = Inky.configuration.template_engine
+
+      expect(template_engine).to be_a(Symbol)
+      expect(template_engine).to eq(:haml)
+    end
+  end
+end

data/spec/inky_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe "Inky#release_the_kraken" do
+  it "works on binary text" do
+    input = '<container/>'.b
+    expected = <<-HTML
+      <table class="container" align="center">
+        <tbody>
+          <tr>
+            <td></td>
+          </tr>
+        </tbody>
+      </table>
+    HTML
+
+    output = Inky::Core.new.release_the_kraken(input)
+    expect_same_html(output, expected)
+  end
+end

data/spec/spec_helper.rb

@@ -16,12 +16,12 @@ def reformat_html(html)
     end
 end
 
+def expect_same_html(input, expected)
+  expect(reformat_html(input)).to eql(reformat_html(expected))
+end
+
 def compare(input, expected)
   inky = Inky::Core.new
   output = inky.release_the_kraken(input)
-
-  # TODO:  Figure out a better way to do html compare in ruby..
-  # this is overly dependent on things like class ordering, making it
-  # fragile
-  expect(reformat_html(output)).to eql(reformat_html(expected))
+  expect_same_html(output, expected)
 end

data/spec/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/test_app/app/controllers/inky_controller.rb

@@ -0,0 +1,9 @@
+class InkyController < ApplicationController
+  layout 'inky_layout', only: [:layout]
+
+  def non_inky
+    @partial_name = params[:partial].presence
+  end
+
+  %w[simple layout slim explicit_slim explicit_builder].each{ |m| define_method(m){} }
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/test_app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/test_app/app/views/inky/_inky_partial.html.inky

@@ -0,0 +1 @@
+<button href="<%= foo -%>">Click me</button>

data/spec/test_app/app/views/inky/explicit_builder.html.inky-builder

@@ -0,0 +1 @@
+xml.container("Built with builder")

data/spec/test_app/app/views/inky/explicit_slim.html.inky-slim

@@ -0,0 +1,2 @@
+container
+	| Explicit slim example

data/spec/test_app/app/views/inky/layout.html.erb

@@ -0,0 +1 @@
+Using inky layout

data/spec/test_app/app/views/inky/non_inky.html.erb

@@ -0,0 +1,3 @@
+<container>
+  <%= render @partial_name, foo: 'bar' if @partial_name %>
+</container>

data/spec/test_app/app/views/inky/simple.html.inky

@@ -0,0 +1 @@
+<container>Simplistic example</container>

data/spec/test_app/app/views/inky/slim.html.inky

@@ -0,0 +1,2 @@
+container
+	| Slim example

data/spec/test_app/app/views/layouts/application.html.erb

@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+<html><body>
+<%= yield -%>
+</body></html>

data/spec/test_app/app/views/layouts/inky_layout.html.inky

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= controller.controller_name %> : <%= controller.action_name %></title>
+</head>
+<body>
+  <container>
+    <%= yield %>
+  </container>
+</body>
+</html>

data/spec/test_app/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/test_app/config/application.rb

@@ -0,0 +1,22 @@
+require_relative 'boot'
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+# require "active_job/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+# require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "inky"
+
+module TestApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

data/spec/test_app/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/test_app/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/spec/test_app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/test_app/config/environments/development.rb

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    } if config.respond_to? :public_file_server
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/spec/test_app/config/environments/production.rb

@@ -0,0 +1,86 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "test_app_#{Rails.env}"
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end