slimi 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a503c590465e63f43b6d9ef8047700ff415bfea923df65be323f2d37f5d94b71
-  data.tar.gz: 4ad486738d38c81b670cb693afa31c9c7f8acb92ab05a844d47cf3df1d0219c8
+  metadata.gz: 94ce8aacd3d29798f0831cedcd033b1706b2ccebe85264cff5321d8671d7fda3
+  data.tar.gz: 5cbe5fe9791eafac5951f02853bb9600efb726f10d4a990d96b8ef5bfb2c4c38
 SHA512:
-  metadata.gz: '08dc1c84baa6a338564757e6c28143a77f1ecc03eb4ba7f72bf2af82ce673eb2c573debbbbf5eaf16673b53e07a49dd3493888875e6b9e5016557ab7f8373368'
-  data.tar.gz: dd3bb74308363284ff648f80d2dcc37fe9b7faa75df2b31210ca4567fa088debca11b5831bb8ec745800bd15e9886e5ff5bf6074bcb6aa673ca826421e10bc31
+  metadata.gz: ba6180bd2e6e890dd2149e19390a4cb030c85ddbaac97f89d259fc9cd476673ea62cc788f84654561642ec6e86055ac5c0ae0cd8d3f4eb86a7225ca200b82d30
+  data.tar.gz: 537418a830f3b7d791e98ac107eea63732ede37d531c1d879eb9ded7588ab2a4897569fb05a552e73f543d6a4ce159fe9a66c0f0c2d6cd870e9976d58b6a46a2

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.5.0 - 2022-01-02
+
+### Added
+
+- Add Slimi::Engine.
+
 ## 0.4.2 - 2021-12-27
 
 ### Fixed

data/Gemfile

@@ -9,4 +9,3 @@ gem 'rake', '~> 13.0'
 gem 'rspec'
 gem 'rubocop'
 gem 'rubocop-rspec'
-gem 'slim'

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    slimi (0.4.2)
+    slimi (0.5.0)
       temple
+      tilt
 
 GEM
   remote: https://rubygems.org/
@@ -43,9 +44,6 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slim (4.1.0)
-      temple (>= 0.7.6, < 0.9)
-      tilt (>= 2.0.6, < 2.1)
     temple (0.8.2)
     tilt (2.0.10)
     unicode-display_width (2.1.0)
@@ -58,7 +56,6 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-rspec
-  slim
   slimi!
 
 BUNDLED WITH

data/README.md

@@ -5,28 +5,18 @@
 
 Yet another implementation for [Slim](https://github.com/slim-template/slim) template language.
 
-Slimi is used by [Slimcop](https://github.com/r7kamura/slimcop).
+## Introduction
 
-## Installation
+Slimi provides almost the same functionality as Slim, with a few additional useful features,
+such as generating AST with detailed location information about embedded Ruby codes.
 
-Add this line to your application's Gemfile:
+Originally, Slimi was developed for [Slimcop](https://github.com/r7kamura/slimcop), a RuboCop runner for Slim template.
+It uses Slimi to apply `rubocop --auto-correct` to embedded Ruby codes in Slim template.
 
-```ruby
-gem 'slimi'
-```
-
-And then execute:
-
-```
-bundle install
-```
+## Usage
 
-Or install it yourself as:
+Just replace `gem 'slim'` with `gem 'slimi'` in your application's Gemfile.
 
+```ruby
+gem 'slimi'
 ```
-gem install slimi
-```
-
-## Usage
-
-TBD.

data/lib/slimi/engine.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'temple'
+
+module Slimi
+  # Convert Slim code into Ruby code.
+  class Engine < ::Temple::Engine
+    define_options(
+      attr_quote: '"',
+      default_tag: 'div',
+      format: :xhtml,
+      merge_attrs: { 'class' => ' ' },
+      pretty: false,
+      sort_attrs: true
+    )
+
+    use Parser
+    use Filters::Unposition
+    use Filters::Embedded
+    use Filters::Interpolation
+    use Filters::DoInserter
+    use Filters::EndInserter
+    use Filters::Control
+    use Filters::Output
+    use Filters::Text
+    html :AttributeSorter
+    html :AttributeMerger
+    use Filters::Attribute
+    use(:AttributeRemover) { ::Temple::HTML::AttributeRemover.new(remove_empty_attrs: options[:merge_attrs].keys) }
+    html :Pretty
+    filter :Escapable
+    filter :ControlFlow
+    filter :MultiFlattener
+    filter :StaticMerger
+    generator :StringBuffer
+  end
+end

data/lib/slimi/filters/attribute.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # Handle `[:slimi, :attributes, ...]`.
+    class Attribute < ::Temple::HTML::Filter
+      define_options :merge_attrs
+
+      # @param [Array<Array>] expressions
+      # @return [Array]
+      def on_html_attrs(*expressions)
+        [:multi, *expressions.map { |expression| compile(expression) }]
+      end
+
+      # @param [String] name
+      # @param [Array] value
+      # @return [Array]
+      def on_html_attr(name, value)
+        if value[0] == :slim && value[1] == :attrvalue && !options[:merge_attrs][name]
+          escape = value[2]
+          code = value[3]
+          case code
+          when 'true'
+            [:html, :attr, name, [:multi]]
+          when 'false', 'nil'
+            [:multi]
+          else
+            tmp = unique_name
+            [:multi,
+             [:code, "#{tmp} = #{code}"],
+             [:if, tmp,
+              [:if, "#{tmp} == true",
+               [:html, :attr, name, [:multi]],
+               [:html, :attr, name, [:escape, escape, [:dynamic, tmp]]]]]]
+          end
+        else
+          @attr = name
+          super
+        end
+      end
+
+      # @param [Boolean] escape
+      # @param [String] code\
+      # @return [Array]\
+      def on_slim_attrvalue(escape, code)
+        if (delimiter = options[:merge_attrs][@attr])
+          tmp = unique_name
+          [:multi,
+           [:code, "#{tmp} = #{code}"],
+           [:if, "Array === #{tmp}",
+            [:multi,
+             [:code, "#{tmp} = #{tmp}.flatten"],
+             [:code, "#{tmp}.map!(&:to_s)"],
+             [:code, "#{tmp}.reject!(&:empty?)"],
+             [:escape, escape, [:dynamic, "#{tmp}.join(#{delimiter.inspect})"]]],
+            [:escape, escape, [:dynamic, tmp]]]]
+        else
+          [:escape, escape, [:dynamic, code]]
+        end
+      end
+    end
+  end
+end

data/lib/slimi/filters/control.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # Handle `[:slim, :control, code, multi]`.
+    class Control < ::Temple::HTML::Filter
+      # @param [String] code
+      # @param [Array] multi
+      # @return [Array]
+      def on_slim_control(code, multi)
+        [
+          :multi,
+          [:code, code],
+          compile(multi)
+        ]
+      end
+    end
+  end
+end

data/lib/slimi/filters/do_inserter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # Append missing `do` to embedded Ruby code.
+    class DoInserter < ::Temple::HTML::Filter
+      VALID_RUBY_LINE_REGEXP = /(\A(if|unless|else|elsif|when|begin|rescue|ensure|case)\b)|\bdo\s*(\|[^|]*\|\s*)?\Z/.freeze
+
+      # @param [String] code
+      # @param [Array] expressio
+      # @return [Array]
+      def on_slim_control(code, expression)
+        code += ' do' unless code.match?(VALID_RUBY_LINE_REGEXP) || empty_exp?(expression)
+        [:slim, :control, code, compile(expression)]
+      end
+
+      # @param [Boolean] escape
+      # @param [String] code
+      # @param [Array] expression
+      # @return [Array]
+      def on_slim_output(escape, code, expression)
+        code += ' do' unless code.match?(VALID_RUBY_LINE_REGEXP) || empty_exp?(expression)
+        [:slim, :output, escape, code, compile(expression)]
+      end
+    end
+  end
+end

data/lib/slimi/filters/embedded.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # @api private
+    class TextCollector < ::Temple::HTML::Filter
+      def call(exp)
+        @collected = ''
+        super(exp)
+        @collected
+      end
+
+      def on_slim_interpolate(text)
+        @collected << text
+        nil
+      end
+    end
+
+    # @api private
+    class NewlineCollector < ::Temple::HTML::Filter
+      def call(exp)
+        @collected = [:multi]
+        super(exp)
+        @collected
+      end
+
+      def on_newline
+        @collected << [:newline]
+        nil
+      end
+    end
+
+    # @api private
+    class OutputProtector < ::Temple::HTML::Filter
+      def call(exp)
+        @protect = []
+        @collected = ''
+        @tag = "%#{object_id.abs.to_s(36)}%"
+        super(exp)
+        @collected
+      end
+
+      def on_static(text)
+        @collected << text
+        nil
+      end
+
+      def on_slim_output(escape, text, content)
+        @collected << @tag
+        @protect << [:slim, :output, escape, text, content]
+        nil
+      end
+
+      def unprotect(text)
+        block = [:multi]
+        while text =~ /#{@tag}/
+          block << [:static, Regexp.last_match.pre_match]
+          block << @protect.shift
+          text = Regexp.last_match.post_match
+        end
+        block << [:static, text]
+      end
+    end
+
+    # Temple filter which processes embedded engines
+    # @api private
+    class Embedded < ::Temple::HTML::Filter
+      @engines = {}
+
+      class << self
+        attr_reader :engines
+
+        # Register embedded engine
+        #
+        # @param [String] name Name of the engine
+        # @param [Class]  klass Engine class
+        # @param option_filter List of options to pass to engine.
+        #                      Last argument can be default option hash.
+        def register(name, klass, *option_filter)
+          name = name.to_sym
+          local_options = option_filter.last.respond_to?(:to_hash) ? option_filter.pop.to_hash : {}
+          define_options(name, *option_filter)
+          klass.define_options(name)
+          engines[name.to_sym] = proc do |options|
+            klass.new({}.update(options).delete_if { |k, _v| !option_filter.include?(k) && k != name }.update(local_options))
+          end
+        end
+
+        def create(name, options)
+          constructor = engines[name] || raise(Temple::FilterError, "Embedded engine #{name} not found")
+          constructor.call(options)
+        end
+      end
+
+      define_options :enable_engines, :disable_engines
+
+      def initialize(opts = {})
+        super
+        @engines = {}
+        @enabled = normalize_engine_list(options[:enable_engines])
+        @disabled = normalize_engine_list(options[:disable_engines])
+      end
+
+      def on_slim_embedded(name, body, attrs)
+        name = name.to_sym
+        raise(Temple::FilterError, "Embedded engine #{name} is disabled") unless enabled?(name)
+
+        @engines[name] ||= self.class.create(name, options)
+        @engines[name].on_slim_embedded(name, body, attrs)
+      end
+
+      def enabled?(name)
+        (!@enabled || @enabled.include?(name)) &&
+          (!@disabled || !@disabled.include?(name))
+      end
+
+      protected
+
+      def normalize_engine_list(list)
+        raise(ArgumentError, 'Option :enable_engines/:disable_engines must be String or Symbol list') unless !list || list.is_a?(Array)
+
+        list&.map(&:to_sym)
+      end
+
+      class Engine < ::Temple::HTML::Filter
+        protected
+
+        def collect_text(body)
+          @text_collector ||= TextCollector.new
+          @text_collector.call(body)
+        end
+
+        def collect_newlines(body)
+          @newline_collector ||= NewlineCollector.new
+          @newline_collector.call(body)
+        end
+      end
+
+      # Basic tilt engine
+      class TiltEngine < Engine
+        def on_slim_embedded(engine, body, _attrs)
+          tilt_engine = Tilt[engine] || raise(Temple::FilterError, "Tilt engine #{engine} is not available.")
+          tilt_options = options[engine.to_sym] || {}
+          tilt_options[:default_encoding] ||= 'utf-8'
+          [:multi, tilt_render(tilt_engine, tilt_options, collect_text(body)), collect_newlines(body)]
+        end
+
+        protected
+
+        def tilt_render(tilt_engine, tilt_options, text)
+          [:static, tilt_engine.new(tilt_options) { text }.render]
+        end
+      end
+
+      # Sass engine which supports :pretty option
+      class SassEngine < TiltEngine
+        define_options :pretty
+
+        protected
+
+        def tilt_render(tilt_engine, tilt_options, text)
+          text = tilt_engine.new(tilt_options.merge(
+                                   style: options[:pretty] ? :expanded : :compressed,
+                                   cache: false
+                                 )) { text }.render
+          text = text.chomp
+          [:static, text]
+        end
+      end
+
+      # Static template with interpolated ruby code
+      class InterpolateTiltEngine < TiltEngine
+        def collect_text(body)
+          output_protector.call(interpolation.call(body))
+        end
+
+        def tilt_render(tilt_engine, tilt_options, text)
+          output_protector.unprotect(tilt_engine.new(tilt_options) { text }.render)
+        end
+
+        private
+
+        def interpolation
+          @interpolation ||= Interpolation.new
+        end
+
+        def output_protector
+          @output_protector ||= OutputProtector.new
+        end
+      end
+
+      # Tag wrapper engine
+      # Generates a html tag and wraps another engine (specified via :engine option)
+      class TagEngine < Engine
+        disable_option_validator!
+
+        def on_slim_embedded(engine, body, attrs)
+          unless options[:attributes].empty?
+            options[:attributes].map do |k, v|
+              attrs << [:html, :attr, k, [:static, v]]
+            end
+          end
+
+          if options[:engine]
+            opts = {}.update(options)
+            opts.delete(:engine)
+            opts.delete(:tag)
+            opts.delete(:attributes)
+            @engine ||= options[:engine].new(opts)
+            body = @engine.on_slim_embedded(engine, body, attrs)
+          end
+
+          [:html, :tag, options[:tag], attrs, body]
+        end
+      end
+
+      # Javascript wrapper engine.
+      # Like TagEngine, but can wrap content in html comment or cdata.
+      class JavaScriptEngine < TagEngine
+        disable_option_validator!
+
+        set_options tag: :script, attributes: {}
+
+        def on_slim_embedded(engine, body, attrs)
+          super(engine, [:html, :js, body], attrs)
+        end
+      end
+
+      # Embeds ruby code
+      class RubyEngine < Engine
+        def on_slim_embedded(_engine, body, _attrs)
+          [:multi, [:newline], [:code, "#{collect_text(body)}\n"]]
+        end
+      end
+
+      # These engines are executed at compile time, embedded ruby is interpolated
+      register :markdown,   InterpolateTiltEngine
+      register :textile,    InterpolateTiltEngine
+      register :rdoc,       InterpolateTiltEngine
+
+      # These engines are executed at compile time
+      register :coffee,     JavaScriptEngine, engine: TiltEngine
+      register :less,       TagEngine, tag: :style,  attributes: { type: 'text/css' },         engine: TiltEngine
+      register :sass,       TagEngine, :pretty, tag: :style, attributes: { type: 'text/css' }, engine: SassEngine
+      register :scss,       TagEngine, :pretty, tag: :style, attributes: { type: 'text/css' }, engine: SassEngine
+
+      # Embedded javascript/css
+      register :javascript, JavaScriptEngine
+      register :css,        TagEngine, tag: :style, attributes: { type: 'text/css' }
+
+      # Embedded ruby code
+      register :ruby,       RubyEngine
+    end
+  end
+end

data/lib/slimi/filters/end_inserter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # Append missing `end` line to embedded Ruby code in control block.
+    class EndInserter < ::Temple::HTML::Filter
+      # @param [Array<Array>] expressions
+      def on_multi(*expressions)
+        result = [:multi]
+        prev_indent = false
+        expressions.each do |source|
+          expression = Expression.new(source)
+          if expression.control?
+            raise ::Temple::FilterError, 'Explicit end statements are forbidden.' if expression.end?
+
+            result << code_end if prev_indent && !expression.else?
+
+            prev_indent = expression.if?
+          elsif !expression.newline? && prev_indent
+            result << code_end
+            prev_indent = false
+          end
+
+          result << compile(source)
+        end
+
+        result << code_end if prev_indent
+        result
+      end
+
+      private
+
+      # @return [Array]
+      def code_end
+        [:code, 'end']
+      end
+
+      class Expression
+        IF_REGEXP = /\A(if|begin|unless|else|elsif|when|rescue|ensure)\b|\bdo\s*(\|[^|]*\|)?\s*$/.freeze
+
+        ELSE_REGEXP = /\A(else|elsif|when|rescue|ensure)\b/.freeze
+
+        END_REGEXP = /\Aend\b/.freeze
+
+        # @param [Array] expression
+        def initialize(expression)
+          @expression = expression
+        end
+
+        # @return [Boolean]
+        def control?
+          @expression[0] == :slim && @expression[1] == :control
+        end
+
+        # @return [Boolean]
+        def if?
+          @expression[2].match?(IF_REGEXP)
+        end
+
+        # @return [Boolean]
+        def else?
+          @expression[2].match?(ELSE_REGEXP)
+        end
+
+        # @return [Boolean]
+        def end?
+          @expression[2].match?(END_REGEXP)
+        end
+
+        # @return [Boolean]
+        def newline?
+          @expression[0] == :newline
+        end
+      end
+    end
+  end
+end

data/lib/slimi/filters/output.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # Handle `[:slim, :output, escape, code, multi]`.
+    class Output < ::Temple::HTML::Filter
+      define_options :disable_capture
+
+      IF_REGEXP = /\A(if|unless)\b|\bdo\s*(\|[^|]*\|)?\s*$/.freeze
+
+      # @param [Boolean] escape
+      # @param [String] code
+      # @param [Array] multi
+      # @return [Array]
+      def on_slim_output(escape, code, multi)
+        if code.match?(IF_REGEXP)
+          tmp = unique_name
+          [
+            :multi,
+            [:block, "#{tmp} = #{code}", options[:disable_capture] ? compile(multi) : [:capture, unique_name, compile(multi)]],
+            [:escape, escape, [:dynamic, tmp]]
+          ]
+        else
+          [
+            :multi,
+            [:escape, escape, [:dynamic, code]],
+            multi
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/slimi/filters/text.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Slimi
+  module Filters
+    # Handle `[:slim, :text, multi]`.
+    class Text < ::Temple::HTML::Filter
+      # @param [Symbol] _type
+      # @param [Array] multi
+      # @return [Array]
+      def on_slim_text(_type, multi)
+        compile(multi)
+      end
+    end
+  end
+end

data/lib/slimi/filters.rb

@@ -2,7 +2,14 @@
 
 module Slimi
   module Filters
+    autoload :Attribute, 'slimi/filters/attribute'
+    autoload :Control, 'slimi/filters/control'
+    autoload :DoInserter, 'slimi/filters/do_inserter'
+    autoload :Embedded, 'slimi/filters/embedded'
+    autoload :EndInserter, 'slimi/filters/end_inserter'
     autoload :Interpolation, 'slimi/filters/interpolation'
+    autoload :Output, 'slimi/filters/output'
+    autoload :Text, 'slimi/filters/text'
     autoload :Unposition, 'slimi/filters/unposition'
   end
 end

data/lib/slimi/rails_template_handler.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Slimi
+  class RailsTemplateHandler
+    def initialize
+      @engine = Engine.new
+    end
+
+    def call(template, source = nil)
+      source ||= template.source
+      @engine.call(source)
+    end
+  end
+end

data/lib/slimi/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Slimi
+  class Railtie < ::Rails::Railtie
+    initializer 'Register Slimi template handler' do
+      ::ActiveSupport.on_load(:action_view) do
+        ::ActionView::Template.register_template_handler(
+          RailsTemplateHandler.new
+        )
+      end
+    end
+  end
+end

data/lib/slimi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slimi
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/slimi.rb

@@ -3,8 +3,12 @@
 require_relative 'slimi/version'
 
 module Slimi
+  autoload :Engine, 'slimi/engine'
   autoload :Errors, 'slimi/errors'
   autoload :Filters, 'slimi/filters'
   autoload :Parser, 'slimi/parser'
+  autoload :RailsTemplateHandler, 'slimi/rails_template_handler'
   autoload :Range, 'slimi/range'
 end
+
+require_relative 'slimi/railtie' if defined?(Rails)

data/slimi.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   }
 
   spec.add_dependency 'temple'
+  spec.add_dependency 'tilt'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimi
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2022-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  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: 
 email:
 - r7kamura@gmail.com
@@ -43,11 +57,21 @@ files:
 - bin/console
 - bin/setup
 - lib/slimi.rb
+- lib/slimi/engine.rb
 - lib/slimi/errors.rb
 - lib/slimi/filters.rb
+- lib/slimi/filters/attribute.rb
+- lib/slimi/filters/control.rb
+- lib/slimi/filters/do_inserter.rb
+- lib/slimi/filters/embedded.rb
+- lib/slimi/filters/end_inserter.rb
 - lib/slimi/filters/interpolation.rb
+- lib/slimi/filters/output.rb
+- lib/slimi/filters/text.rb
 - lib/slimi/filters/unposition.rb
 - lib/slimi/parser.rb
+- lib/slimi/rails_template_handler.rb
+- lib/slimi/railtie.rb
 - lib/slimi/range.rb
 - lib/slimi/version.rb
 - slimi.gemspec