victor-cli 0.3.8 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae572af3658e7deee923e58a2cf98291d33c3916002d02a236a61b444e93e54e
-  data.tar.gz: c4c9b1075a852bfebfd008c45a14032d42df459356ec646ee12cd0bdc5c3fca4
+  metadata.gz: f0ed324cb5ba0472bebcb5eb497c288d88c90f4ec4edb2fdb6d7a752323424ba
+  data.tar.gz: 3ce04218f855f60ca6c303ac83a28f48d413508cad29619c02c3d9d3c1a05118
 SHA512:
-  metadata.gz: f642ac864d24273b28c6539925cb109a725f2c21bf3f83fee7bb5cede14267f8af5a2e968aa9290738a2a2e3f5b15f10d9a416d6fafa13f91d6558f5eb2c85ef
-  data.tar.gz: fdc56653a55b1f2d6a4a1cb5ef99c1856e62982611749a2a1ea99e0e114cfc5f5d66a800efb8839e5ff0d7c4c0934948b45c54a4a84c184b1a340c0615314964
+  metadata.gz: 688682610e101eb864750e8c2e3906b7bea4d50ce7c8bb96fe7c748ae561bc85e46c924a8f37122af7ffc5c58f6b2dac30e365c09953547ddcdc47967d6704cd
+  data.tar.gz: 989722f87a901add75dc40e2cf51f24d38209068178a4e6772d28940d8dcdc0e0a790c1fae8aeef6b782cb6b724b9ae7110ea7e7ea9ad25292f67cec04436e07

data/README.md

@@ -1,15 +1,7 @@
 # Victor CLI
 
-[![Gem Version](https://badge.fury.io/rb/victor-cli.svg)](https://badge.fury.io/rb/victor-cli)
-[![Build Status](https://github.com/DannyBen/victor-cli/workflows/Test/badge.svg)](https://github.com/DannyBen/victor-cli/actions?query=workflow%3ATest)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ab7a46b42d268e374ee1/maintainability)](https://codeclimate.com/github/DannyBen/victor-cli/maintainability)
-
----
-
 Command line interface for [Victor][victor], the SVG Library.
 
----
-
 ## Installation
 
     $ gem install victor-cli
@@ -32,21 +24,24 @@ Given this Ruby code:
 # example.rb
 setup width: 140, height: 100
 
+# allow changing parameters from the command line
+color = params[:color] || :yellow
+
 build do
-  circle cx: 50, cy: 50, r: 30, fill: "yellow"
+  circle cx: 50, cy: 50, r: 30, fill: color
 end
 ```
 
 Run this command:
 ```shell
-$ victor render example.rb --template minimal
+$ victor render example.rb --template minimal color=blue
 ```
 
 To generate this code:
 
 ```xml
 <svg width="140" height="100">
-  <circle cx="50" cy="50" r="30" fill="yellow"/>
+  <circle cx="50" cy="50" r="30" fill="blue"/>
 </svg>
 ```
 

data/bin/victor

@@ -3,6 +3,7 @@ require 'victor/cli'
 require 'pretty_trace/enable-trim'
 
 include Colsole
+
 PrettyTrace.filter [/gem/, /lib/, %r{bin/victor}, %r{bin/bundle}]
 PrettyTrace.debug_tip
 

data/lib/victor/cli/command_line.rb

@@ -6,7 +6,7 @@ module Victor
   module CLI
     class CommandLine
       def self.router
-        router = MisterBin::Runner.new version: VERSION,
+        router = MisterBin::Runner.new version: "#{Victor::CLI::VERSION} (victor #{Victor::VERSION})",
           header: 'Victor SVG Utilities'
 
         router.route 'init',    to: Commands::Init

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

@@ -4,7 +4,7 @@ module Victor
       class Convert < Base
         summary 'Convert SVG to Ruby code'
 
-        usage 'victor convert SVG_FILE [RUBY_FILE --template NAME]'
+        usage 'victor convert SVG_FILE [--save RUBY_FILE --template NAME]'
         usage 'victor convert (-h|--help)'
 
         option '-t, --template NAME', <<~USAGE
@@ -14,21 +14,15 @@ module Victor
             cli          a Victor CLI compatible DSL script (default)
         USAGE
 
-        param 'SVG_FILE', 'Input SVG file'
+        option '-o, --save RUBY_FILE', 'Save to RUBY file instead of printing to stdout'
+
         param 'RUBY_FILE', 'Output Ruby file. Leave empty to write to stdout'
 
-        example 'victor convert example.svg example.rb'
+        example 'victor convert example.svg --save example.rb'
 
         def run
-          svg_file = args['SVG_FILE']
-          template = args['--template']
-          svg_node = SVGNode.load_file svg_file, layout: template
-
           validate_template template if template
 
-          code = svg_node.render
-          ruby_file = args['RUBY_FILE']
-
           if ruby_file
             File.write ruby_file, code
             say "Saved #{ruby_file}"
@@ -37,6 +31,17 @@ module Victor
           end
         end
 
+      protected
+
+        def svg_file = args['SVG_FILE']
+        def template = args['--template']
+        def ruby_file = args['--save']
+
+        def svg_node = @svg_node ||= SVGNode.load_file(svg_file, layout: template)
+        def code = @code ||= svg_node.render
+
+      private
+
         def validate_template(template)
           allowed = %w[cli dsl standalone]
           return if allowed.include? template

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

@@ -4,9 +4,11 @@ module Victor
   module CLI
     module Commands
       class Render < Base
+        using PairSplit
+
         summary 'Render Ruby code to SVG'
 
-        usage 'victor render RUBY_FILE [SVG_FILE] [options]'
+        usage 'victor render RUBY_FILE [options] [PARAMS...]'
         usage 'victor render (-h|--help)'
 
         option '-t, --template TEMPLATE', <<~USAGE
@@ -15,28 +17,33 @@ module Victor
         USAGE
 
         option '-w, --watch', 'Watch the source file and regenerate on change'
+        option '-o, --save SVG_FILE', 'Save to SVG file instead of printing to stdout'
 
         param 'RUBY_FILE', 'Input Ruby file'
-        param 'SVG_FILE', 'Output SVG file. Leave empty to write to stdout'
+        param 'PARAMS', 'One or more key=value pairs that will be available in the `params` hash for the Ruby script'
 
-        example 'victor render input.rb output.svg'
-        example 'victor render input.rb output.svg --watch'
+        example 'victor render input.rb -o output.svg'
+        example 'victor render input.rb --save output.svg --watch'
         example 'victor render input.rb --template minimal'
+        example 'victor render input.rb color=black "text=Hello World"'
 
         def run
-          if args['--watch']
-            watch_and_generate
-          else
-            generate
-          end
+          args['--watch'] ? watch_and_generate : generate
         end
 
+      protected
+
+        def ruby_file = args['RUBY_FILE']
+        def svg_file = args['--save']
+        def template = args['--template']
+        def params = @params ||= args['PARAMS'].pair_split
+
       private
 
         def generate
           code = File.read ruby_file
 
-          ruby_source = RubySource.new code, ruby_file
+          ruby_source = RubySource.new code, filename: ruby_file, params: params
           ruby_source.evaluate
           ruby_source.template template if template
 
@@ -68,18 +75,6 @@ module Victor
         def file_watcher
           @file_watcher ||= Filewatcher.new(ruby_file, immediate: true)
         end
-
-        def ruby_file
-          args['RUBY_FILE']
-        end
-
-        def svg_file
-          args['SVG_FILE']
-        end
-
-        def template
-          args['--template']
-        end
       end
     end
   end

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

@@ -0,0 +1,13 @@
+module Victor
+  module CLI
+    module PairSplit
+      refine Array do
+        def pair_split(operator = '=')
+          return {} if empty?
+
+          to_h { |pair| pair.split(operator, 2) }.transform_keys(&:to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/victor/cli/ruby_source.rb

@@ -2,14 +2,18 @@ module Victor
   module CLI
     class RubySource
       include Victor::DSL
-      attr_reader :code, :filename
 
-      def initialize(code, filename = nil)
+      attr_reader :code, :filename, :global_params, :params
+
+      def initialize(code, filename: nil, params: nil)
         @code = code
         @filename = filename
+        @global_params = params || {}
+        @params = global_params
       end
 
-      def evaluate
+      def evaluate(local_params = nil)
+        @params = local_params || global_params
         if filename
           instance_eval code, filename
         else

data/lib/victor/cli/version.rb

@@ -1,5 +1,5 @@
 module Victor
   module CLI
-    VERSION = '0.3.8'
+    VERSION = '0.4.1'
   end
 end

data/lib/victor/cli.rb

@@ -5,3 +5,4 @@ require_relative 'cli/ruby_source'
 require_relative 'cli/css_data'
 require_relative 'cli/command_line'
 require_relative 'cli/svg_node'
+require_relative 'cli/version'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 - Max Brosnahan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -137,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: CLI for Victor, the SVG Library
 email: db@dannyben.com
 executables:
@@ -153,6 +166,7 @@ files:
 - lib/victor/cli/commands/init.rb
 - lib/victor/cli/commands/render.rb
 - lib/victor/cli/css_data.rb
+- lib/victor/cli/refinements/pair_split.rb
 - lib/victor/cli/refinements/rendering.rb
 - lib/victor/cli/ruby_source.rb
 - lib/victor/cli/svg_node.rb
@@ -174,7 +188,6 @@ metadata:
   changelog_uri: https://github.com/DannyBen/victor-cli/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/DannyBen/victor-cli
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,15 +195,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CLI for Victor, the SVG Library
 test_files: []