victor-cli 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc2b1c5e3ce6627c982daf91c5ecb7c8427f61064f5df3474619ab4eb1e5f220
-  data.tar.gz: 04c775439539bb96ddb866354d7c8f3925ade9ddb768cb6b9e23f1cae22a017f
+  metadata.gz: 3c9131b3ef1b179385c510630bc7c14407b72f4f0857bd1f2ae9fd8f493c0871
+  data.tar.gz: 4c67b9435f4aba166207f4811341a258cc98eb19a5900e5489c7efaa6499db69
 SHA512:
-  metadata.gz: 2453dcea1067196ae6e71ba9ef1c0c509ccc45c2c9ea109632612892a1b115fba64303b43aff65aa590bc75f4ea1a5ba3b8e91d3516a49478750492b2f7b104c
-  data.tar.gz: d5099606414fe52ff0e27c5da5b411751c38c47c8d98ac5968077b9895158f1de881030a7b00b5e405565618a233aac1a51f728ac201aaa0f4682eeb96be8d2c
+  metadata.gz: a5dc91865331fef5f231e2d66192a561156955c1000fa1377d850fe649431b24f3c218ddea06d16e2f17da4a599db4a3b1378415a21dffe33d60a00c0ee40aac
+  data.tar.gz: 61f002991c4b896c7e4cc221540a83d2f1cde375c120997401f3a2126404cb500efee44b57edc7581ec940f44435884c957cd5b08ddeb6dfcae89efaf3bafa2a

data/lib/victor/cli/commands/convert.rb

@@ -18,10 +18,13 @@ module Victor
         example "victor convert example.svg example.rb"
 
         def run
-          svg_data = File.read(args["SVG_FILE"])
-          svg_source = SVGSource.new svg_data, template: args['--template']
+          svg_file = args["SVG_FILE"]
+          template = args['--template']
+          svg_node = SVGNode.load_file svg_file, layout: template
 
-          code = svg_source.ruby_code
+          validate_template template if template
+
+          code = svg_node.render
           ruby_file = args["RUBY_FILE"]
 
           if ruby_file
@@ -31,6 +34,13 @@ module Victor
             puts code
           end
         end
+
+        def validate_template(template)
+          allowed = %w[cli dsl standalone]
+          unless allowed.include? template
+            raise "Template not found #{template}\nAvailable templates: #{allowed.join ', '}"
+          end
+        end
       end
     end
   end

data/lib/victor/cli/commands/render.rb

@@ -47,8 +47,10 @@ module Victor
 
         def watch
           say "Watching #{ruby_file} for changes"
-          file_watcher.watch do |file, event|
-            yield unless event == :deleted
+          file_watcher.watch do |changes|
+            changes.each do |path, event|
+              yield unless event == :deleted
+            end
           end
         end
 

data/lib/victor/cli/css_data.rb

@@ -0,0 +1,27 @@
+require "css_parser"
+
+module Victor
+  module CLI
+    class CSSData
+      attr_reader :css_string
+
+      def initialize(css_string)
+        @css_string = css_string
+      end
+
+      def to_h
+        parser.load_string! css_string
+        parser.to_h['all']
+      end
+
+    private
+
+      def parser
+        @parser ||= CssParser::Parser.new
+      end
+
+    end
+  end
+end
+
+

data/lib/victor/cli/refinements/rendering.rb

@@ -0,0 +1,46 @@
+module Victor
+  module CLI
+    module Rendering
+      refine Hash do
+        def render
+          # TODO: Reduce cognitive complexity
+          map do |key, value|
+            key = key.to_key if key.is_a? String
+
+            if key == "style"
+              value = "{ #{value.style_to_hash.render} }"
+            elsif value.is_a? String
+              value = value.to_value
+            end
+
+            "#{key}: #{value}"
+          end.join ", "
+        end
+
+      end
+
+      refine String do
+        def to_key
+          gsub('-', '_').to_sym.inspect[1..-1]
+        end
+
+        def to_value
+          if to_f.to_s == self or to_i.to_s == self
+            self
+          else
+            %Q["#{self}"]
+          end
+        end
+
+        # Transforms the valus of a style attribute to a hash
+        # Example: "color: black; top: 10" => { color: black, top: 10 }
+        def style_to_hash
+          parser = CssParser::Parser.new
+          parser.load_string! "victor { #{self} }"
+          parser.to_h["all"]["victor"]
+        end
+
+      end
+    end
+  end
+end

data/lib/victor/cli/svg_node.rb

@@ -0,0 +1,141 @@
+require 'nokogiri'
+require 'erb'
+require 'rufo'
+
+module Victor
+  module CLI
+    class SVGNode
+      using Rendering
+      attr_reader :node, :layout
+
+      # Returns a new instance from an SVG file
+      def self.load_file(path, layout: nil)
+        load File.read(path), layout: layout
+      end
+
+      # Returns a new instance from raw SVG string
+      def self.load(svg_string, layout: nil)
+        doc = Nokogiri::XML svg_string
+        root = doc.children.last
+        new root, layout: layout
+      end
+
+      # Initializes with a Nokogiri XML node
+      def initialize(node, layout: nil)
+        @node = node
+        @layout = layout || :cli
+      end
+
+      # Returns formatted Ruby code
+      def render
+        Rufo::Formatter.format ruby_code
+      rescue Rufo::SyntaxError => e
+        raise ruby_code
+      end
+
+      def inspect
+        "#<#{self.class} name=#{name}, type=#{type}>"
+      end
+
+      # Returns the tag name
+      def name
+        node.name
+      end
+
+      # Returns one of our internal types (symbol)
+      def type
+        @type ||= type!
+      end
+
+      # Returns a hash of attributes
+      def attributes
+        @attributes ||= attributes!
+      end
+
+      # Returns the content (body) of the lement
+      def content
+        @content ||= content!
+      end
+
+      # Returns an array of children elements (SVGNode)
+      def children
+        @children ||= children!
+      end
+
+      # Returns the ruby code, unformatted
+      def ruby_code
+        erb erb_template
+      end
+
+    private
+
+      # Returns true if the element should be ignored
+      def rejected?
+        (node.text? and node.text.strip.empty?) or type == :junk
+      end
+
+      # Renders ERB code
+      def erb(code)
+        ERB.new(code, trim_mode: '%-').result(binding)
+      end
+
+      # Returns the content of the appropriate ERB tempalte, based on type
+      def erb_template
+        @erb_template ||= File.read(erb_template_file)
+      end
+
+      # Returns the path to the appropriate ERB template, based on type
+      def erb_template_file
+        file = type == :root ? "root_#{layout}" : type
+        path = File.expand_path "templates/nodes/#{file}.erb", __dir__
+      end
+
+      # Returns the internal element type
+      def type!
+        if node.text?
+          :text
+        elsif node.comment?
+          :junk
+        elsif node.name == 'style'
+          :css
+        elsif node.name == 'svg'
+          :root
+        else
+          :element
+        end
+      end
+
+      # Returns a filtered list of SVGNode children
+      def children!
+        node.children.map do |child|
+          SVGNode.new child
+        end.reject(&:rejected?)
+      end
+
+      # Returns a hash of attributes
+      def attributes!
+        node.attribute_nodes.map do |attr|
+          name = attr.name
+          value = attr.value
+          key = attr.respond_to?(:prefix) ? "#{attr.prefix}:#{name}" : name
+          
+          [key, value]
+        end.to_h
+      end
+
+      def content!
+        if type == :css
+          CSSData.new(node.content).to_h
+        elsif node.content.is_a? String
+          node.content.strip
+        else
+          # TODO: do we need this?
+          # :nocov:
+          node.content
+          # :nocov:
+        end
+      end
+
+    end
+  end
+end

data/lib/victor/cli/templates/init/cli.rb

@@ -7,8 +7,8 @@ build do
   circle cx: 50, cy: 50, r: 40, fill: 'yellow'
   rect x: 10, y: 50, width: 80, height: 50, fill: 'yellow'
 
-  [25, 50].each do |y|
-    circle cx: y, cy: 40, r: 8, fill: 'white'
+  [25, 50].each do |x|
+    circle cx: x, cy: 40, r: 8, fill: 'white'
   end
 
   path d: "M11 100 l13 -15 l13 15 l13 -15 l13 15 l13 -15 l13 15 Z", fill: 'white'

data/lib/victor/cli/templates/init/dsl.rb

@@ -8,8 +8,8 @@ build do
   circle cx: 50, cy: 50, r: 40, fill: 'yellow'
   rect x: 10, y: 50, width: 80, height: 50, fill: 'yellow'
 
-  [25, 50].each do |y|
-    circle cx: y, cy: 40, r: 8, fill: 'white'
+  [25, 50].each do |x|
+    circle cx: x, cy: 40, r: 8, fill: 'white'
   end
 
   path d: "M11 100 l13 -15 l13 15 l13 -15 l13 15 l13 -15 l13 15 Z", fill: 'white'

data/lib/victor/cli/templates/init/standalone.rb

@@ -8,8 +8,8 @@ svg.build do
   circle cx: 50, cy: 50, r: 40, fill: 'yellow'
   rect x: 10, y: 50, width: 80, height: 50, fill: 'yellow'
 
-  [25, 50].each do |y|
-    circle cx: y, cy: 40, r: 8, fill: 'white'
+  [25, 50].each do |x|
+    circle cx: x, cy: 40, r: 8, fill: 'white'
   end
 
   path d: "M11 100 l13 -15 l13 15 l13 -15 l13 15 l13 -15 l13 15 Z", fill: 'white'

data/lib/victor/cli/templates/nodes/css.erb

@@ -0,0 +1,7 @@
+<%= "# :css" if ENV['DEBUG'] -%>
+<%- content.each do |selector, declarations| %>
+css[<%= selector.inspect %>] = {
+  <%- declarations.each do |key, value| -%>
+  <%= key.to_key %>: <%= value.to_value %>,
+  <%- end -%>}
+<%- end -%>

data/lib/victor/cli/templates/nodes/element.erb

@@ -0,0 +1,18 @@
+<%= "# :element" if ENV['DEBUG'] -%>
+<%- if children.any? -%>
+  <%- if children.count == 1 and children.first.node.text? -%>
+    <%- if attributes.any? -%>
+<%= name %> "<%= content %>", <%= attributes.render %>
+    <%- else -%>
+<%= name %> "<%= content %>"
+    <%- end -%>
+  <%- else -%>
+<%= name %> <%= attributes.render %> do
+    <%- children.each do |child| -%>
+<%= child.render %>
+    <%- end -%>
+end
+  <%- end -%>
+<%- else -%>
+<%= name %> <%= attributes.render %>
+<%- end -%>

data/lib/victor/cli/templates/nodes/root_cli.erb

@@ -0,0 +1,12 @@
+<%= "# :root" if ENV['DEBUG'] -%>
+# Render this template by running 'victor render FILE'
+
+<%- if attributes.any? -%>
+setup <%= attributes.render %>
+<%- end -%>
+
+build do
+<%- children.each do |child| -%>
+<%= child.render %>
+<%- end -%>
+end

data/lib/victor/cli/templates/nodes/root_dsl.erb

@@ -0,0 +1,17 @@
+<%= "# :root" if ENV['DEBUG'] -%>
+# Render this template by running 'ruby FILE' or 'victor render FILE'
+
+require 'victor/script'
+
+<%- if attributes.any? -%>
+setup <%= attributes.render %>
+<%- end -%>
+
+build do
+<%- children.each do |child| -%>
+<%= child.render %>
+<%- end -%>
+end
+
+puts render
+save 'output'

data/lib/victor/cli/templates/nodes/root_standalone.erb

@@ -0,0 +1,14 @@
+<%= "# :root" if ENV['DEBUG'] -%>
+# Render this template by running 'ruby FILE' or 'victor render FILE'
+
+require "victor"
+
+svg = Victor::SVG.new <%= attributes.render %>
+
+svg.build do
+<%- children.each do |child| -%>
+<%= child.render %>
+<%- end -%>
+end
+
+svg.save "result"

data/lib/victor/cli/templates/nodes/text.erb

@@ -0,0 +1,2 @@
+<%= "# :text" if ENV['DEBUG'] -%>
+_ "<%= content %>"

data/lib/victor/cli/version.rb

@@ -1,5 +1,5 @@
 module Victor
   module CLI
-    VERSION = "0.3.0"
+    VERSION = "0.3.3"
   end
 end

data/lib/victor/cli.rb

@@ -1,11 +1,12 @@
 require 'victor'
 require 'requires'
 requires 'cli/refinements'
-require_relative 'cli/parser'
-require_relative 'cli/svg_source'
 require_relative 'cli/ruby_source'
+require_relative 'cli/css_data'
 require_relative 'cli/command_line'
-require_relative 'cli/xml_node'
-require_relative 'cli/xml_text'
+require_relative 'cli/svg_node'
 
-require 'byebug' if ENV['BYEBUG']
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: victor-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filewatcher
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -138,19 +152,20 @@ files:
 - lib/victor/cli/commands/convert.rb
 - lib/victor/cli/commands/init.rb
 - lib/victor/cli/commands/render.rb
-- lib/victor/cli/parser.rb
-- lib/victor/cli/refinements/stirng_refinements.rb
+- lib/victor/cli/css_data.rb
+- lib/victor/cli/refinements/rendering.rb
 - lib/victor/cli/ruby_source.rb
-- lib/victor/cli/svg_source.rb
-- lib/victor/cli/templates/import/cli.rb
-- lib/victor/cli/templates/import/dsl.rb
-- lib/victor/cli/templates/import/standalone.rb
+- lib/victor/cli/svg_node.rb
 - lib/victor/cli/templates/init/cli.rb
 - lib/victor/cli/templates/init/dsl.rb
 - lib/victor/cli/templates/init/standalone.rb
+- lib/victor/cli/templates/nodes/css.erb
+- lib/victor/cli/templates/nodes/element.erb
+- lib/victor/cli/templates/nodes/root_cli.erb
+- lib/victor/cli/templates/nodes/root_dsl.erb
+- lib/victor/cli/templates/nodes/root_standalone.erb
+- lib/victor/cli/templates/nodes/text.erb
 - lib/victor/cli/version.rb
-- lib/victor/cli/xml_node.rb
-- lib/victor/cli/xml_text.rb
 homepage: https://github.com/dannyben/victor-cli
 licenses:
 - MIT
@@ -163,14 +178,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: CLI for Victor, the SVG Library

data/lib/victor/cli/parser.rb

@@ -1,61 +0,0 @@
-require "nokogiri"
-
-module Victor
-  module CLI
-    class Parser
-      attr_reader :raw_svg
-
-      def initialize(raw_svg)
-        @raw_svg = raw_svg
-      end
-
-      def parse
-        parse_node svg_root
-      end
-
-    private
-
-      def parse_node(node)
-        case node
-        when Nokogiri::XML::Comment
-          nil
-        when Nokogiri::XML::Text
-          parse_text node
-        else
-          parse_normal_node node
-        end
-      end
-
-      def parse_text(node)
-        text_node = XMLText.new(node.text)
-        return text_node if text_node.text.length > 0
-      end
-
-      def parse_normal_node(node)
-        XMLNode.new(
-          node.name,
-          node_attrs(node),
-          node.children.map(&method(:parse_node)).compact,
-        )
-      end
-
-      def node_attrs(node)
-        node.attributes.values.reduce({}) do |acc, attr|
-          name = attr.name
-          value = attr.value
-          key = attr.respond_to?(:prefix) ? "#{attr.prefix}:#{name}" : name
-          acc[key] = value
-          acc
-        end
-      end
-
-      def xml_doc
-        Nokogiri::XML raw_svg
-      end
-
-      def svg_root
-        xml_doc.children.last
-      end
-    end
-  end
-end

data/lib/victor/cli/refinements/stirng_refinements.rb

@@ -1,19 +0,0 @@
-module Victor
-  module CLI
-    module Refinements
-      refine String do
-        def format_as_key
-          gsub('-', '_')
-        end
-
-        def format_as_value
-          if to_f.to_s == self or to_i.to_s == self
-            self
-          else
-            %Q["#{self}"]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/victor/cli/svg_source.rb

@@ -1,105 +0,0 @@
-require "rufo"
-
-module Victor
-  module CLI
-    class SVGSource
-      using Refinements
-      attr_reader :svg_tree, :template
-
-      def initialize(svg_tree, template: nil)
-        @svg_tree = svg_tree
-        @svg_tree = Parser.new(@svg_tree).parse if @svg_tree.is_a? String
-        @template = template || :cli
-      end
-
-      def ruby_code
-        @ruby_code ||= Rufo::Formatter.format(code_for_node(svg_tree))
-      end
-
-      private
-
-      def code_for_node(node)
-        return text_to_ruby node if node.is_a?(XMLText)
-        
-        case node.type
-        when "svg"
-          root_to_ruby node
-        when "text", "tspan"
-          text_node_to_ruby node
-        else
-          node_to_ruby node
-        end
-      end
-
-      def text_node_to_ruby(node)
-        children = node.children
-        if children.length == 1 && children.first.is_a?(XMLText)
-          short_text_to_ruby node
-        else
-          node_to_ruby node
-        end
-      end
-
-      def short_text_to_ruby(node)
-        attrs = node.attributes.empty? ? "" : ",#{attrs_to_ruby(node.attributes)}"
-        inner_text = node.children.first.text
-        "text #{inner_text.inspect} #{attrs}"
-      end
-
-      def node_to_ruby(node)
-        code = "#{node.type} #{attrs_to_ruby(node.attributes)} "
-        unless node.children.empty?
-          code << " do\n"
-          code << nodes_to_ruby(node.children)
-          code << "\nend\n"
-        end
-        code
-      end
-
-      def nodes_to_ruby(nodes)
-        nodes.map do |node|
-          code_for_node node
-        end.join "\n"
-      end
-
-      def text_to_ruby(node)
-        "_ #{node.text.inspect}"
-      end
-
-      def attrs_to_ruby(attrs)
-        attrs.map do |key, value|
-          "#{key.format_as_key}: #{value.format_as_value}"
-        end.join ", "
-      end
-
-      def root_to_ruby(node)
-        values = {
-          attributes: attrs_to_ruby(node.attributes),
-          nodes: nodes_to_ruby(node.children),
-        }
-
-        template_content(template) % values
-      end
-
-      def template_content(name)
-        filename = File.join templates_path, "#{name}.rb"
-
-        unless File.exist? filename
-          raise "Template not found #{name}\nAvailable templates: #{available_templates.join ', '}"
-        end
-
-        File.read filename
-      end
-
-      def templates_path
-        @templates_path ||= File.expand_path "templates/import", __dir__
-      end
-
-      def available_templates
-        @available_templates ||= Dir["#{templates_path}/*.rb"].map do |path|
-          File.basename path, '.rb'
-        end.sort
-      end
-    end
-  end
-end

data/lib/victor/cli/templates/import/cli.rb

@@ -1,8 +0,0 @@
-# Render this template by running 'victor render FILE'
-
-setup %{attributes}
-
-build do
-  %{nodes}
-end
-

data/lib/victor/cli/templates/import/dsl.rb

@@ -1,12 +0,0 @@
-# Render this template by running 'ruby FILE' or 'victor render FILE'
-
-require 'victor/script'
-
-setup %{attributes}
-
-build do
-  %{nodes}
-end
-
-puts render
-save 'output'

data/lib/victor/cli/templates/import/standalone.rb

@@ -1,10 +0,0 @@
-# Render this template by running 'ruby FILE' or 'victor render FILE'
-
-require "victor"
-
-svg = Victor::SVG.new %{attributes}
-svg.build do
-  %{nodes}
-end
-
-svg.save "generated"

data/lib/victor/cli/xml_node.rb

@@ -1,14 +0,0 @@
-module Victor
-  module CLI
-    class XMLNode
-      attr_reader :type, :attributes, :children
-
-      def initialize(type, attributes, children)
-        @type = type
-        @attributes = attributes
-        @children = children
-      end
-
-    end
-  end
-end

data/lib/victor/cli/xml_text.rb

@@ -1,11 +0,0 @@
-module Victor
-  module CLI
-    class XMLText
-      attr_reader :text
-
-      def initialize(text)
-        @text = text.strip
-      end
-    end
-  end
-end