wisco 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 922149837870023d570403cf2ef875643e7201eee6eb425eab6cb98b360448d5
-  data.tar.gz: a55d53569027d2628c5dffc31cc078582b1ec1feca64bee7c0087f459e4d8172
+  metadata.gz: 684776c3daf8185ae8be30ecc9afbeacdb216190f4f7c9d080ff3d8acc7bf5cb
+  data.tar.gz: b577efaddd5424680968a77acefaad54217cca76665a936c18f5083d8d4b8289
 SHA512:
-  metadata.gz: f46fcfb9b5869a7f7bfd1e797752731bb7850bcd81f62209a878703504b578f9f4333bda6ed67db235c29c638e8af095d23f8588c1cd402c490b406a0ef19047
-  data.tar.gz: b7a6f96e3899a947d6423bdf6877dc539bbf16c7de569ec39e4c5761092c995fcaebc88f9f4e110aaee200df91eacf681e24fc4470cb56302eb3e0f7a4691f9c
+  metadata.gz: 2c13a0b3baad7d55e1c21b02d6be5d9a023e0f119265f57cc604b628711ac9639825505259e362c3f5be3035eec0f3be0523841de48dff6b4184a30a8f3185f7
+  data.tar.gz: a6ff5b3f26ea143eceb6068e76c28fce4622ffd8393fd63b45fc78404e2c28d0be755f6cdddd22cd0f53237892b712e7c7bee406dc23136e01259135fd96ea5a

data/lib/wisco/commands/fixtures.rb

@@ -17,7 +17,7 @@ module Wisco
         config_path = Wisco.config_path(target_dir)
 
         unless File.exist?(config_path)
-          warn "Error: No #{Wisco::WISCO_DIR}/#{Wisco::CONFIG_FILENAME} found in #{target_dir}."
+          Wisco::TerminalOutput.emit_error "Error: No #{Wisco::WISCO_DIR}/#{Wisco::CONFIG_FILENAME} found in #{target_dir}."
           warn "       Run '#{Wisco::CLI_NAME} init' first."
           exit 1
         end
@@ -27,7 +27,7 @@ module Wisco
         connector_file = config.dig('connector', 'file')
 
         if connector_path.nil? || connector_file.nil?
-          warn "Error: #{Wisco::WISCO_DIR}/#{Wisco::CONFIG_FILENAME} is missing connector path/file. Run '#{Wisco::CLI_NAME} init' again."
+          Wisco::TerminalOutput.emit_error "Error: #{Wisco::WISCO_DIR}/#{Wisco::CONFIG_FILENAME} is missing connector path/file. Run '#{Wisco::CLI_NAME} init' again."
           exit 1
         end
 
@@ -53,13 +53,13 @@ module Wisco
             cf_file = File.join(fixtures_dir, 'config_fields.json')
             cf_opt  = nil   # set to cf_file once the user has filled it in
 
-            if raw_cf
+            if raw_cf.present?
               if config_fields_ready?(cf_file)
                 cf_opt = cf_file
               else
                 write_config_fields_template(raw_cf, cf_file)
                 warn "  Written:  #{cf_file}"
-                warn "  Action required: fill in config_fields.json, then re-run fixtures."
+                Wisco::TerminalOutput.emit_warning("  Action required: fill in config_fields.json, then re-run fixtures.")
                 next
               end
             end
@@ -231,7 +231,7 @@ module Wisco
 
       def read_json_without_sentinel(path)
         lines = File.readlines(path)
-        lines.shift if lines.first&.chomp == SENTINEL
+        lines.shift while lines.first&.lstrip&.start_with?('#')
         JSON.parse(lines.join)
       rescue StandardError
         {}
@@ -251,10 +251,29 @@ module Wisco
       def write_config_fields_template(config_fields_array, output_file)
         stringified = stringify_keys_deep(config_fields_array)
         template    = schema_to_template(stringified)
-        content     = "#{SENTINEL}\n#{JSON.pretty_generate(template)}\n"
+        comments    = build_config_fields_comments(stringified)
+        content     = "#{SENTINEL}\n#{comments}#{JSON.pretty_generate(template)}\n"
         File.write(output_file, content)
       end
 
+      def build_config_fields_comments(fields)
+        return '' if fields.empty?
+
+        lines = ['# Config fields:']
+        fields.each do |field|
+          parts = []
+          parts << "label: #{field['label'].inspect}"       if field['label']
+          parts << "hint: #{field['hint'].inspect}"         if field['hint']
+          parts << "type: #{field['type'] || 'string'}"
+          parts << (field.fetch('optional', true) ? 'optional' : 'required')
+          parts << "control_type: #{field['control_type']}" if field['control_type']
+          parts << "pick_list: #{field['pick_list']}"       if field['pick_list']
+          lines << "#   #{field['name']}: #{parts.join(', ')}"
+        end
+        lines << '#'
+        lines.map { |l| "#{l}\n" }.join
+      end
+
       def stringify_keys_deep(obj)
         case obj
         when Hash  then obj.transform_keys(&:to_s).transform_values { |v| stringify_keys_deep(v) }

data/lib/wisco/terminal_output.rb

@@ -0,0 +1,22 @@
+module Wisco
+  module TerminalOutput
+    RED = 31
+    YELLOW = 33
+
+    module_function
+
+    def emit_error(message)
+      warn(colorize(message, RED))
+    end
+
+    def emit_warning(message)
+      warn(colorize(message, YELLOW))
+    end
+
+    def colorize(message, color_code)
+      return message unless $stderr.tty?
+
+      "\e[#{color_code}m#{message}\e[0m"
+    end
+  end
+end

data/lib/wisco/version.rb

@@ -1,3 +1,3 @@
 module Wisco
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

data/lib/wisco.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'thor'
 require_relative 'wisco/version'
+require_relative 'wisco/terminal_output'
 
 module Wisco
   CLI_NAME        = 'wisco'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wisco
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - mbillington
@@ -73,6 +73,7 @@ files:
 - lib/wisco/config.rb
 - lib/wisco/connector.rb
 - lib/wisco/path_utils.rb
+- lib/wisco/terminal_output.rb
 - lib/wisco/version.rb
 - lib/wisco/workato_api.rb
 homepage: https://github.com/billingtonm/wisco