phlexing 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ca848b92899d1a6c218053bc730d321b550766aed6797467018e8a7bb10fa8
-  data.tar.gz: 145d06606a772720817fc8bc30befb4c34cd5e5685f2bf1d8911b4e66d28b8ab
+  metadata.gz: 36dca58e17556b8b085edeb24dbe3fc5f8c8cb976056a6f739a655c5d94d7a36
+  data.tar.gz: 21f2b6dbec24a29a4dbfe52bb25d77887e52c72d29098e41c5a80a2173e8cc66
 SHA512:
-  metadata.gz: 15d9ab5288501b69858b18e054ab254c6069adb66d6420d50371f1a008677a2dd62b9d219826d114bac054a16b887937dda370e5b50bfb339e5ab5b890a90f7e
-  data.tar.gz: 800aa986cecaadbdca99aeadd44b2b2d3f4584b28864b5cab5aa6f40f4ee2e392efa7218f5327fefd92752494022af02237227cc4e6c1c30507797302b472afb
+  metadata.gz: e52e0c6836f3e701c24f6ccf2338f823b5507497863e3af93d089712a2503213d2e86d5f3516f1f9d3e60bffd907de7ffbfc3661610141dd0f917f43a7cc2008
+  data.tar.gz: 00730543e38df6d87c1f5a1263ea964bfc27024de00dea885df86a5d60626afd665485899aad1d8cf350fba3df7e914879fda76040953125a4e9842e387c4b7b

data/Gemfile.lock

@@ -17,7 +17,7 @@ GIT
 PATH
   remote: .
   specs:
-    phlexing (0.1.0)
+    phlexing (0.2.0)
       erb_parser (~> 0.0.2)
       html_press (~> 0.8.2)
       nokogiri (~> 1.0)
@@ -45,13 +45,15 @@ GEM
       css_press
     multi_js (0.1.0)
       uglifier (~> 2)
-    nokogiri (1.13.9-x86_64-darwin)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
     polyglot (0.3.5)
-    racc (1.6.0)
+    racc (1.6.2)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.0)
@@ -60,7 +62,7 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     rufo (0.13.0)
-    treetop (1.6.11)
+    treetop (1.6.12)
       polyglot (~> 0.3)
     uglifier (2.7.2)
       execjs (>= 0.3.0)
@@ -69,6 +71,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)

data/README.md

@@ -1,9 +1,5 @@
 # Phlexing
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/phlexing`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -14,10 +10,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install phlexing
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## 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.

data/lib/phlexing/converter.rb

@@ -12,16 +12,22 @@ module Phlexing
 
     using ::Phlexing::Refinements::StringRefinements
 
-    attr_accessor :html, :custom_elements
+    attr_accessor :html, :custom_elements, :ivars, :locals, :idents
 
-    def self.convert(html)
-      new(html).buffer
+    def self.convert(html, **options)
+      new(html, **options).output
     end
 
-    def initialize(html)
+    def initialize(html, **options)
       @html = html
       @buffer = StringIO.new
       @custom_elements = Set.new
+      @ivars = Set.new
+      @locals = Set.new
+      @includes = Set.new
+      @idents = Set.new
+      @options = options
+      analyze_ruby
       handle_node
     end
 
@@ -30,7 +36,7 @@ module Phlexing
 
       if text.squish.empty? && text.length.positive?
         @buffer << indent(level)
-        @buffer << "whitespace\n"
+        @buffer << whitespace(@options)
 
         text.strip!
       end
@@ -42,16 +48,17 @@ module Phlexing
           @buffer << "text "
         end
 
-        @buffer << double_quote(text)
+        @buffer << quote(text)
         @buffer << "\n" if newline
       end
     end
 
     def handle_erb_element(node, level, newline: true)
       if erb_safe_output?(node)
-        @buffer << "raw "
+        @buffer << "unsafe_raw "
         @buffer << node.text.from(1)
         @buffer << "\n" if newline
+
         return
       end
 
@@ -99,7 +106,7 @@ module Phlexing
     def handle_comment_node(node, level)
       @buffer << indent(level)
       @buffer << "comment "
-      @buffer << double_quote(node.text.strip)
+      @buffer << quote(node.text.strip)
       @buffer << "\n"
     end
 
@@ -161,6 +168,76 @@ module Phlexing
       @buffer.string.strip
     end
 
+    def output
+      out = StringIO.new
+
+      if @options.fetch(:phlex_class, false)
+        component_name = @options.fetch(:component_name, "Component")
+        component_name = "A#{component_name}" if component_name[0] == "0" || component_name[0].to_i != 0
+
+        parent_component = @options.fetch(:parent_component, "Phlex::HTML")
+        parent_component = "A#{parent_component}" if parent_component[0] == "0" || parent_component[0].to_i != 0
+
+        out << "class #{component_name}"
+        out << "< #{parent_component}\n"
+
+        if locals.any?
+          out << indent(1)
+          out << "attr_accessor "
+          out << locals.sort.map { |local| ":#{local}" }.join(", ")
+          out << "\n\n"
+        end
+
+        @custom_elements.sort.each do |element|
+          out << indent(1)
+          out << "register_element :#{element}\n"
+        end
+
+        kwargs = Set.new(ivars + locals).sort
+
+        if kwargs.any?
+          out << indent(1)
+          out << "def initialize("
+          out << kwargs.map { |kwarg| "#{kwarg}: " }.join(", ")
+          out << ")\n"
+
+          kwargs.each do |dep|
+            out << indent(2)
+            out << "@#{dep} = #{dep}\n"
+          end
+
+          out << indent(1)
+          out << "end\n"
+        end
+
+        out << indent(1)
+        out << "def template\n"
+
+        out << indent(2)
+        out << @buffer.string
+
+        out << indent(1)
+        out << "end\n"
+        out << "end\n"
+      else
+        out << @buffer.string
+      end
+
+      Rufo::Formatter.format(out.string.strip)
+    rescue Rufo::SyntaxError
+      out.string.strip
+    end
+
+    def analyze_ruby
+      ruby_code = ErbParser.parse(html).tokens.map { |tag| tag.is_a?(ErbParser::ErbTag) && !tag.to_s.start_with?("<%#") ? tag.ruby_code.delete_prefix("=") : nil }.join("\n")
+      visitor = Phlexing::Visitor.new(self)
+      program = SyntaxTree.parse(ruby_code)
+      # puts program.construct_keys
+      visitor.visit(program)
+    rescue StandardError => e
+      puts e.inspect
+    end
+
     def converted_erb
       ErbParser.transform_xml(html).gsub("\n", "").gsub("\r", "")
     rescue StandardError

data/lib/phlexing/helpers.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
+require "phlex"
+
 module Phlexing
   module Helpers
+    KNOWN_ELEMENTS = Phlex::HTML::VOID_ELEMENTS.values + Phlex::HTML::STANDARD_ELEMENTS.values
+
     def indent(level)
       return "" if level == 1
 
       "  " * level
     end
 
+    def whitespace(options)
+      options.fetch(:whitespace, true) ? "whitespace\n" : ""
+    end
+
     def double_quote(string)
       "\"#{string}\""
     end
@@ -16,12 +24,23 @@ module Phlexing
       "'#{string}'"
     end
 
+    def percent_literal_string(string)
+      "%(#{string})"
+    end
+
+    def quote(string)
+      return double_quote(string) unless string.include?('"')
+      return single_quote(string) unless string.include?("'")
+
+      percent_literal_string(string)
+    end
+
     def node_name(node)
       return "template_tag" if node.name == "template"
-      return node.name unless node.name.include?("-")
 
       name = node.name.gsub("-", "_")
-      @custom_elements << name
+
+      @custom_elements << name unless KNOWN_ELEMENTS.include?(name)
 
       name
     end

data/lib/phlexing/name_suggestor.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Phlexing
+  class NameSuggestor
+    def self.suggest(html)
+      converter = Phlexing::Converter.new(html)
+
+      ivars  = converter.ivars
+      locals = converter.locals
+
+      ids     = extract(converter, :extract_id_from_element)
+      classes = extract(converter, :extract_class_from_element)
+      tags    = extract(converter, :extract_tag_name_from_element)
+
+      return wrap(ivars.first) if ivars.one? && locals.none?
+      return wrap(locals.first) if locals.one? && ivars.none?
+      return wrap(ids.first) if ids.any?
+      return wrap(ivars.first) if ivars.any?
+      return wrap(locals.first) if locals.any?
+      return wrap(classes.first) if classes.any?
+      return wrap(tags.first) if tags.any?
+
+      "Component"
+    end
+
+    def self.wrap(name)
+      "#{name}_component".gsub("-", "_").gsub(" ", "_").camelize
+    end
+
+    def self.extract(converter, method)
+      return [] unless converter.parsed
+
+      converter.parsed.children.map { |element| send(method, element) }.compact
+    end
+
+    def self.extract_id_from_element(element)
+      return if element.nil?
+      return if element.is_a?(Nokogiri::XML::Text)
+
+      id_attribute = element.attributes.try(:[], "id")
+      return if id_attribute.nil?
+
+      id = id_attribute.value.to_s.strip
+      return if id.include?("<erb")
+
+      id
+    end
+
+    def self.extract_class_from_element(element)
+      return if element.nil?
+      return if element.is_a?(Nokogiri::XML::Text)
+
+      class_attribute = element.attributes.try(:[], "class")
+
+      return if class_attribute.nil?
+
+      classes = class_attribute.value.strip.split
+
+      return if classes.empty?
+
+      classes[0]
+    end
+
+    def self.extract_tag_name_from_element(element)
+      return if element.nil?
+      return if element.is_a?(Nokogiri::XML::Text)
+
+      return if ["div", "span", "p", "erb"].include?(element.name)
+
+      element.name
+    end
+  end
+end

data/lib/phlexing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phlexing
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/phlexing/visitor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "syntax_tree"
+
+module Phlexing
+  class Visitor < SyntaxTree::Visitor
+    def initialize(converter)
+      @converter = converter
+    end
+
+    def visit_ivar(node)
+      @converter.ivars << node.value.from(1)
+    end
+
+    def visit_vcall(node)
+      @converter.locals << node.value.value
+    end
+
+    def visit_ident(node)
+      @converter.idents << node.value
+    end
+  end
+end

data/lib/phlexing.rb

@@ -3,6 +3,8 @@
 require_relative "phlexing/version"
 require_relative "phlexing/helpers"
 require_relative "phlexing/refinements/string_refinements"
+require_relative "phlexing/visitor"
+require_relative "phlexing/name_suggestor"
 require_relative "phlexing/converter"
 
 module Phlexing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexing
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-29 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_parser
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  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: Simple ERB to Phlex converter
 email:
 - marco.roth@hey.com
@@ -83,8 +97,10 @@ files:
 - lib/phlexing.rb
 - lib/phlexing/converter.rb
 - lib/phlexing/helpers.rb
+- lib/phlexing/name_suggestor.rb
 - lib/phlexing/refinements/string_refinements.rb
 - lib/phlexing/version.rb
+- lib/phlexing/visitor.rb
 - sig/phlexing.rbs
 homepage: https://github.com/marcoroth/phlexing
 licenses: