victor-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 126abee42ab8abfde3a3f12704e20c5bb59175bf7e8789acee1423728c733c17
-  data.tar.gz: 5799eb27256c286e10bc8f710fcf08d1d6a4d7726553e99765a843839b8e3f06
+  metadata.gz: 9acf122e53e375434a1cad7cf0a5c1e93c7b804304f02e0907d0b95776739d4e
+  data.tar.gz: 93bbaa1caa3ccc7747f291f60de666fefd90696ed69c48f055f6ef0136c11bce
 SHA512:
-  metadata.gz: dd97b8db3ac7653addec886f4f4a079cf8a2edff1fe037ba4e01e7b80542032d983a4281441febcaf73fd848a336b0a76bfefdfc131a2b0d7b80df9483c63612
-  data.tar.gz: d1ccb5205691afe44679219e018dfd4f44873fc01536197ef9ad1fc1515e1967c6aecdce162f6a941f8685e3f7f20f60be1f9cf13a226e2a1bb7e58355082098
+  metadata.gz: f8f6f15561beecff52a10e4ab4c02837a10ac2037a65ea62467bc1a27d78140917b0f6a0f59d597b41f746b42835e30a3613e45b395d891eaa1113efe241c45f
+  data.tar.gz: de421ce4109502beaffc76f8a3df3b9d27e4f4a5117c411b1f9d417ecc85f01de61030c3623ee76d32e666f04401f94cf803eacd224e2cd80d64d8d0a073e9a9

data/README.md

@@ -14,31 +14,60 @@ Command line interface for [Victor][victor], the SVG Library.
 
     $ gem install victor-cli
 
-
 ## Usage
 
+### Convert SVG to Ruby
+
+Given this SVG file:
+
+```xml
+<!-- example.svg -->
+<svg width="140" height="100">
+  <circle cx="50" cy="50" r="30" fill="yellow"/>
+</svg>
+```
+
+Run this command:
+
+```shell
+$ victor to-ruby example.svg
+```
+
+To generate this Ruby code:
+
+```ruby
+setup width: "140", height: "100"
+
+build do
+  circle cx: "50", cy: "50", r: "30", fill: "yellow"
+end
+
 ```
-$ victor generate --help
-Generate Ruby code from SVG
 
-Usage:
-  victor generate SVG_FILE [RUBY_FILE]
-  victor generate (-h|--help)
+### Convert Ruby to SVG
 
-Options:
-  -h --help
-    Show this help
+Given this Ruby code:
 
-Parameters:
-  SVG_FILE
-    Input SVG file
+```ruby
+# example.rb
+setup width: 140, height: 100
 
-  RUBY_FILE
-    Output Ruby file. Leave empty to write to stdout
+build do
+  circle cx: 50, cy: 50, r: 30, fill: "yellow"
+end
+```
+
+Run this command:
+```shell
+$ victor to-svg example.rb --template minimal
+```
 
-Examples:
-  victor generate example.svg example.rb
+To generate this code:
 
+```xml
+<svg width="140" height="100">
+  <circle cx="50" cy="50" r="30" fill="yellow"/>
+</svg>
 ```
 
 ---

data/bin/victor

@@ -1,13 +1,9 @@
 #!/usr/bin/env ruby
 require 'victor/cli'
+require 'pretty_trace/enable-trim'
+
 include Colsole
+PrettyTrace.filter [/gem/, /lib/, /bin\/victor/]
 
 router = Victor::CLI::CommandLine.router
-
-begin
-  exit router.run ARGV
-rescue => e
-  puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!txtred!#{e.class}: #{e.message}"
-  exit 1
-end
+exit router.run ARGV

data/lib/victor/cli.rb

@@ -1,5 +1,7 @@
+require 'victor'
 require_relative 'cli/parser'
 require_relative 'cli/code_generator'
+require_relative 'cli/ruby_code'
 require_relative 'cli/command_line'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/victor/cli/code_generator.rb

@@ -3,24 +3,25 @@ require "rufo"
 module Victor
   module CLI
     class CodeGenerator
-      def initialize(svg_tree)
+      attr_reader :svg_tree, :template
+
+      def initialize(svg_tree, template: nil)
         @svg_tree = svg_tree
+        @template = template || :cli
       end
 
       def generate
         Rufo::Formatter.format(code_for_node(svg_tree))
       end
 
-      private
-
-      attr_reader :svg_tree
+    private
 
       def code_for_node(node)
         case node.first
         when "svg"
-          root_to_ruby(node)
+          root_to_ruby node
         else
-          node_to_ruby(node)
+          node_to_ruby node
         end
       end
 
@@ -48,16 +49,32 @@ module Victor
 
       def root_to_ruby(node)
         _, attrs, children = node
-        <<~RUBY
-          require "victor"
+        values = {
+          attributes: attrs_to_ruby(attrs),
+          nodes: nodes_to_ruby(children)
+        }
+
+        template_content(template) % values
+      end
+
+      def template_content(name)
+        filename = File.join templates_path, "#{name}.rb"
 
-          svg = Victor::SVG.new #{attrs_to_ruby(attrs)}
-          svg.build do
-            #{nodes_to_ruby(children)}
-          end
+        unless File.exist? filename
+          raise "Template not found #{name}\nAvailable templates: #{available_templates.join ', '}"
+        end
 
-          svg.save "generated"
-        RUBY
+        File.read filename
+      end
+
+      def templates_path
+        @templates_path ||= File.expand_path "templates", __dir__
+      end
+
+      def available_templates
+        @available_templates ||= Dir["#{templates_path}/*.rb"].map do |path|
+          File.basename path, '.rb'
+        end
       end
     end
   end

data/lib/victor/cli/command_line.rb

@@ -1,6 +1,7 @@
 require 'mister_bin'
 require_relative 'commands/base'
-require_relative 'commands/generate'
+require_relative 'commands/generate_ruby'
+require_relative 'commands/generate_svg'
 
 module Victor
   module CLI
@@ -9,7 +10,8 @@ module Victor
         router = MisterBin::Runner.new version: VERSION,
           header: "Victor SVG Utilities"
 
-        router.route 'generate', to: Commands::Generate
+        router.route 'to-ruby', to: Commands::GenerateRuby
+        router.route 'to-svg',  to: Commands::GenerateSVG
 
         router
       end

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

@@ -0,0 +1,38 @@
+module Victor
+  module CLI
+    module Commands
+      class GenerateRuby < Base
+        summary "Convert SVG to Ruby code"
+
+        usage "victor to-ruby SVG_FILE [RUBY_FILE --template NAME]"
+        usage "victor to-ruby (-h|--help)"
+
+        option "-t, --template NAME", "Name of the Ruby template to use. Can be:\n" +
+          "  standalone   a full standalone Ruby script\n" +
+          "  dsl          a Victor DSL script\n" +
+          "  cli          a Victor CLI compatible DSL script (default)"
+
+        param "SVG_FILE", "Input SVG file"
+        param "RUBY_FILE", "Output Ruby file. Leave empty to write to stdout"
+
+        example "victor to-ruby example.svg example.rb"
+
+        def run
+          svg_file = File.read(args["SVG_FILE"])
+          svg_tree = Parser.new(svg_file).parse
+          generator = CodeGenerator.new svg_tree, template: args['--template']
+
+          code = generator.generate
+          ruby_file = args["RUBY_FILE"]
+
+          if ruby_file
+            File.write ruby_file, code
+            say "Saved #{ruby_file}"
+          else
+            puts code
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Victor
+  module CLI
+    module Commands
+      class GenerateSVG < Base
+        summary "Convert Ruby code to SVG"
+
+        usage "victor to-svg RUBY_FILE [SVG_FILE --template TEMPLATE]"
+        usage "victor to-svg (-h|--help)"
+
+        option '-t, --template TEMPLATE', "Set SVG template\n"+
+          "Can be: default, html, minimal, or a file path"
+
+        param "RUBY_FILE", "Input Ruby file"
+        param "SVG_FILE", "Output SVG file. Leave empty to write to stdout"
+
+        example "victor to-svg input.rb output.svg"
+        example "victor to-svg input.rb --template minimal"
+
+        def run
+          ruby_file = args["RUBY_FILE"]
+          svg_file = args["SVG_FILE"]
+          template = args['--template']
+          code = File.read ruby_file
+
+          ruby_code = RubyCode.new code
+          ruby_code.evaluate
+          ruby_code.template template if template
+          
+          if svg_file
+            ruby_code.svg.save svg_file
+            say "Saved #{svg_file}"
+          else
+            puts ruby_code.svg.render
+          end
+        end
+      end
+    end
+  end
+end

data/lib/victor/cli/parser.rb

@@ -3,21 +3,28 @@ 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)
+        parse_node svg_root
       end
 
-      private
+    private
 
-      attr_reader :raw_svg
 
       def parse_node(node)
-        return parse_text(node) if node.is_a?(Nokogiri::XML::Text)
-        parse_normal_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)
@@ -46,7 +53,7 @@ module Victor
       end
 
       def xml_doc
-        Nokogiri::XML(raw_svg)
+        Nokogiri::XML raw_svg
       end
 
       def svg_root

data/lib/victor/cli/ruby_code.rb

@@ -0,0 +1,33 @@
+module Victor
+  module CLI
+    class RubyCode
+      include Victor::DSL
+      attr_reader :code
+
+      def initialize(code)
+        @code = code
+      end
+
+      def evaluate
+        instance_eval code
+      end
+
+      def template(template)
+        if built_in_templates.include? template
+          template = template.to_sym
+        elsif !File.exist? template
+          raise "Template not found #{template}\nAvailable templates: #{built_in_templates.join ', '}, or a file path"
+        end
+
+        svg.template = template
+      end
+
+    private
+
+      def built_in_templates
+        %w[default minimal html]
+      end
+
+    end
+  end
+end

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

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

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

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

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

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

data/lib/victor/cli/version.rb

@@ -1,5 +1,5 @@
 module Victor
   module CLI
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: victor-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pretty_trace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: CLI for Victor, the SVG Library
 email: db@dannyben.com
 executables:
@@ -94,8 +108,13 @@ files:
 - lib/victor/cli/code_generator.rb
 - lib/victor/cli/command_line.rb
 - lib/victor/cli/commands/base.rb
-- lib/victor/cli/commands/generate.rb
+- lib/victor/cli/commands/generate_ruby.rb
+- lib/victor/cli/commands/generate_svg.rb
 - lib/victor/cli/parser.rb
+- lib/victor/cli/ruby_code.rb
+- lib/victor/cli/templates/cli.rb
+- lib/victor/cli/templates/dsl.rb
+- lib/victor/cli/templates/standalone.rb
 - lib/victor/cli/version.rb
 homepage: https://github.com/dannyben/victor-cli
 licenses:

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

@@ -1,30 +0,0 @@
-module Victor
-  module CLI
-    module Commands
-      class Generate < Base
-        summary "Generate Ruby code from SVG"
-
-        usage "victor generate SVG_FILE [RUBY_FILE]"
-        usage "victor generate (-h|--help)"
-
-        param "SVG_FILE", "Input SVG file"
-        param "RUBY_FILE", "Output Ruby file. Leave empty to write to stdout"
-
-        example "victor generate example.svg example.rb"
-
-        def run
-          svg_file = File.read(args["SVG_FILE"])
-          svg_tree = Parser.new(svg_file).parse
-          code = CodeGenerator.new(svg_tree).generate
-          ruby_file = args["RUBY_FILE"]
-
-          if ruby_file
-            File.write ruby_file, code
-          else
-            puts code
-          end
-        end
-      end
-    end
-  end
-end