eex2slime 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1beaf57748184f55101b8b74c57b4a2543b2ba65
-  data.tar.gz: 9debc17d21b9e7c7cb0659d0857a916082cff1e1
+  metadata.gz: 36918c220cf3167b9e2ee99ed463046f11c210bd
+  data.tar.gz: 34b61cc5e0e804843b428b1162f5bb579e0b4f85
 SHA512:
-  metadata.gz: e4a18eb89292a887c46d93544bccafe0f1e44396dc3076f964de7fb7f84c4a686158cf8b9078355462eb9535bf362c1bcbccf52e9b98105d940326dbea4313b2
-  data.tar.gz: 7a39ad41e70f475b8185f08af92e8cdab386076f80e3aeb1dc4e3ab209028684bc1903c774749cdcc3573704e7f3ce1e86975cf80cd2696bc534f50240df2601
+  metadata.gz: dd509471dbf78b58e891dae7b604761931e7c30ad60cbff8ea24812ebf228174bc6970888345ef02a621ea0db90f23350dd05e0fc9e9001342c2522da313ba91
+  data.tar.gz: c606b14331370634cd4e32590a16fbc9a86f1685356f06b08914ec73401e0002063d3fd205e74af37537eb9943e6d7e49d217ce139a7e1ac28b11b8922ae22ba

data/README.md

@@ -1,20 +1,32 @@
 ## EEx2Slime
 
+[![Gem Version](https://badge.fury.io/rb/eex2slime.svg)](https://badge.fury.io/rb/eex2slime)
+[![Build Status](https://travis-ci.org/hedgesky/eex2slime.svg?branch=master)](https://travis-ci.org/hedgesky/eex2slime)
+
 Script for converting EEx templates to [Slime](http://slime-lang.com). Slime is a lightweight template language.
 
 ## Usage
 
-You may convert files using the included executable `eex2slime`.
+You may convert files using the included executable `eex2slime`:
+
+```bash
+$ gem install eex2slime
 
-    # eex2slime -h
+$ eex2slime foo.html.eex                   # outputs to foo.html.slime by default
+$ eex2slime foo.html.eex bar.html.slime    # outputs to bar.html.slime
+$ eex2slime foo.html.eex -                 # outputs to stdout
+$ cat foo.eex | eex2slime                  # input from stdin, outputs to stdout
+$ eex2slime dir/                           # convert all .eex files recursively
+$ eex2slime --delete dir/                  # delete .eex files after convertion. Be sure you have a backup!
+```
 
-    Usage: eex2slime INPUT_FILENAME_OR_DIRECTORY [OUTPUT_FILENAME_OR_DIRECTORY] [options]
-            --trace                      Show a full traceback on error
-        -d, --delete                     Delete EEx files
-        -h, --help                       Show this message
-        -v, --version                    Print version
+Alternatively you could use the following API:
 
-Alternatively, to convert files or strings on the fly in your application, you may do so by calling `EEx2Slime.convert!(file)`.
+```ruby
+require 'eex2slime'
+EEx2Slime.convert('path/to/file')
+EEx2Slime.convert_string('<nav class="navbar"></nav>')
+```
 
 ## Installation
 
@@ -23,3 +35,41 @@ Alternatively, to convert files or strings on the fly in your application, you m
 ## Regards
 
 Huge thanks to [Maiz Lulkin](https://github.com/joaomilho) and his original [html2slim repo](https://github.com/slim-template/html2slim).
+
+## Does it really work?
+
+It might fail in some cases, but in general yes, it does! I've checked it on the opersourced [changelog.com app](https://github.com/thechangelog/changelog.com). After a bit of preparing this tool finely converted all EEx templates.
+
+CI runs tests on Rubies 2.2, 1.9.3. Ruby 1.8.7 isn't supported.
+
+## Known issues
+
+- Incorrect HTML will break inner HTML parser. Example (notice misplaced slash):
+
+    ```html
+    <img width="75" / height="75">
+    ```
+
+- Nested interpolation won't play well with Slime. This:
+
+    ```erb
+    <img src="<%= static_url(@conn, "/images/podcasts/#{@podcast.slug}.svg") %>">
+    ```
+
+    should be rewritten to:
+
+    ```erb
+    <% image_url = static_url(@conn, "/images/podcasts/#{@podcast.slug}.svg") %>
+    <img src="<%= image_url %>">
+    ```
+
+- This library doesn't support inline `if`'s interpolation:
+
+    ```erb
+    <!-- such constructions aren't supported -->
+    <article class="<%= if index == 0 do %>is-active<% end %>"></article>
+    ```
+
+## License
+
+This project uses MIT license.

data/lib/eex2slime/command.rb

@@ -1,3 +1,5 @@
+# This class parses CLI arguments and runs converter.
+
 require 'optparse'
 require 'eex2slime'
 
@@ -14,10 +16,10 @@ module EEx2Slime
       @opts.parse!(@args)
       process!
       exit 0
-    rescue Exception => ex
-      raise ex if @options[:trace] || SystemExit === ex
-      $stderr.print "#{ex.class}: " if ex.class != RuntimeError
-      $stderr.puts ex.message
+    rescue => error
+      raise error if @options[:trace] || SystemExit === error
+      $stderr.print "#{error.class}: " if error.class != RuntimeError
+      $stderr.puts error.message
       $stderr.puts '  Use --trace for backtrace.'
       exit 1
     end
@@ -102,7 +104,7 @@ module EEx2Slime
         else
           $stdout
         end
-      @options[:output].puts EEx2Slime.convert!(in_file)
+      @options[:output].puts EEx2Slime.convert(in_file)
       @options[:output].close
 
       File.delete(file) if @options[:delete]

data/lib/eex2slime/converter.rb

@@ -1,7 +1,9 @@
-require_relative 'hpricot_monkeypatches'
+# This class takes EEx string and replaces all embedded elixir with
+# <elixir code="...">...</elixir> tags, which are parsed with Hpricot.
+require_relative "hpricot_monkeypatches"
 
 module EEx2Slime
-  class EExConverter
+  class Converter
     def self.from_stream(stream)
       input =
         if stream.is_a?(IO)
@@ -19,8 +21,8 @@ module EEx2Slime
       prepare_else_statements!
       prepare_elixir_condition_expressions!
       prepare_end_statements!
-      prepare_regular_elixir_code!
       prepare_elixir_inside_attributes!
+      prepare_regular_elixir_code!
       @slime = Hpricot(@eex).to_slime
     end
 
@@ -30,16 +32,11 @@ module EEx2Slime
 
     private
 
-    def prepare_curly_blocks!
-      @eex.gsub!(/<%(.+?)\s*\{\s*(\|.+?\|)?\s*%>/) {
-        %(<%#{$1} do #{$2}%>)
-      }
-    end
-
     def prepare_control_flow_statements!
-      @eex.gsub!(/<%(-\s+)?((\s*(case|if|for|unless) .+?)|.+?do\s*(\|.+?\|)?\s*)-?%>/) {
-        %(<elixir code="#{$2.gsub(/"/, '&quot;')}">)
-      }
+      regex1 = /<%(?:-\s+)?((\s*(case|if|for|unless) ((?:(?!%>).)+)?))-?%>/
+      regex2 = /<%(?:-\s+)?(((?:(?!%>).)+)?do\s*(\|.+?\|)?\s*)-?%>/
+      @eex.gsub!(regex1) { %(<elixir code="#{$1.gsub(/"/, '&quot;')}">) }
+      @eex.gsub!(regex2) { %(<elixir code="#{$1.gsub(/"/, '&quot;')}">) }
     end
 
     def prepare_elixir_anonymous_functions!
@@ -62,38 +59,37 @@ module EEx2Slime
       @eex.gsub!(/<%=?\s*(end|}|end\s+-)\s*%>/, %(</elixir>))
     end
 
-    def prepare_regular_elixir_code!
-      @eex.gsub!(/<%-?(.+?)\s*-?%>/m) {
-        %(<elixir code="#{$1.gsub(/"/, '&quot;')}"></elixir>)
-      }
-    end
-
-    # test string
-    # <div class="form <%= a() %>" data="<%= b() %>"></div>
+    # test string:
+    #   <div class="form <%= a() %> " data="<%= b() %> another"></div>
+    #   <%= another() %>
     def prepare_elixir_inside_attributes!
-      # /
-      #   ="        # ensure we are in attribute value
-      #   ([^"]*)   # match possible other values
-      #   (
-      #     <elixir code="= ?
-      #     ( # match all code inside elixir tag
-      #       (?:.(?!elixir))+ # but forbid spanning over other attributes
-      #     )
-      #     "><\/elixir>
-      #   )
-      # /x
+      # ="                ensure we are inside attributes
+      # ([^"]*)           capture other attributes
+      # <%=               ensure we are inside outputting elixir tag
+      # ((?:(?!%>).)+)    capture code, don't span across multiple elixir tags
+      # \s*               swallow spaces
+      # -?%>              end of elixir tag
       #
       # Example match data:
       #   Match 1
       #   1.  form
-      #   2.  <elixir code="= a()"></elixir>
-      #   3.  a()
+      #   2.  a()
       #   Match 2
       #   1.
-      #   2.  <elixir code="= b()"></elixir>
-      #   3.  b()
-      regex = /="([^"]*)(<elixir code="= ?((?:.(?!elixir))+)"><\/elixir>)/
-      @eex.gsub!(regex, '="\\1#{\\3}')
+      #   2.  b()
+      regex = /="([^"]*)<%=((?:(?!%>).)+)\s*-?%>/
+      @eex.gsub!(regex) {
+        # use variables, because gsub changes $1 and $2 values
+        attrs = $1
+        elixir = $2.gsub('"', "&quot;").strip
+        %Q(="#{attrs}\#{#{elixir}})
+      }
+    end
+
+    def prepare_regular_elixir_code!
+      @eex.gsub!(/<%-?(.+?)\s*-?%>/m) {
+        %(<elixir code="#{$1.gsub(/"/, '&quot;')}"></elixir>)
+      }
     end
   end
 end

data/lib/eex2slime/hpricot_monkeypatches.rb

@@ -1,3 +1,4 @@
+# Patch Hpricot to support our custom <elixir> tags.
 require 'hpricot'
 
 Hpricot::XHTMLTransitional.tagset[:elixir] = [:code]
@@ -83,12 +84,12 @@ class Hpricot::Elem
     end
   end
 
+  private
+
   def elixir?
     name == "elixir"
   end
 
-  private
-
   def children_slime(lvl)
     children
       .map { |c| c.to_slime(lvl+1) }
@@ -130,7 +131,8 @@ class Hpricot::Elem
   def slime_attributes
     remove_css_class
     remove_attribute('id')
-    has_attributes? ? "[#{attributes_as_html.to_s.strip}]" : ""
+    return "" unless has_attributes?
+    "[#{attrs_with_restored_interpolation}]"
   end
 
   def has_attributes?
@@ -149,26 +151,47 @@ class Hpricot::Elem
     name == "div"
   end
 
+  def attrs_with_restored_interpolation
+    regex = /\#{([^{}]+)}/
+    attributes_as_html.to_s.strip.gsub(regex) do
+      code = $1.gsub("&quot;", '"')
+      "\#{ #{code} }"
+    end
+  end
+
   def remove_css_class
     if has_class? && cryptic_classes.any?
       self["class"] = cryptic_classes.join(" ")
     else
-      remove_attribute('class')
+      remove_attribute("class")
     end
   end
 
   def non_cryptic_classes
-    return [] unless has_attribute?('class')
-    classes = self['class'].strip.split(/\s+/)
-    classes.reject { |s| s.match(/[=#]/) }
+    crypto_analyzer.last
+  end
+
+  def cryptic_classes
+    crypto_analyzer.first
   end
 
   # We can have interpolation inside attributes.
   # Such classes should always be in attributes section (not shortened)
-  def cryptic_classes
-    return [] unless has_attribute?('class')
-    classes = self['class'].strip.split(/\s+/)
-    classes.select { |s| s.match(/[=#]/) }
+  # This handles cituations like this:
+  #   <div class="form foo-<%= error_class f, :slug %>-bar"></div>
+  def crypto_analyzer
+    return [[], []] unless has_attribute?("class")
+    @crypto_analyzer ||= begin
+      class_value = self["class"].strip
+      interpolation_regex = /[-\w]*\#{(?:[^{}]+)}[-\w]*/
+      interpolated_classes = class_value.scan(interpolation_regex)
+      class_value.gsub!(interpolation_regex, "")
+
+      crypt, non_crypt = class_value.split(/\s+/).partition do |klass|
+        klass.match(/[=#"&()]/)
+      end
+      [crypt + interpolated_classes, non_crypt]
+    end
   end
 end
 

data/lib/eex2slime/version.rb

@@ -1,3 +1,3 @@
 module EEx2Slime
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/lib/eex2slime.rb

@@ -1,8 +1,15 @@
+# This library converts EEx templates to Slime. It's based on html2slim
+# library by @joaomilho. Usage examples are in README.
+
 require_relative 'eex2slime/version'
 require_relative 'eex2slime/converter'
 
 module EEx2Slime
-  def self.convert!(input)
-    EExConverter.from_stream(input).to_s
+  def self.convert(input)
+    Converter.from_stream(input).to_s
+  end
+
+  def self.convert_string(eex)
+    Converter.new(eex).to_s
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eex2slime
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Anton Chuchkalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hpricot
@@ -81,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="