dldinternet-mixlib-thor 0.7.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92e001459d25a189e5430f6794b22de3a9729853
-  data.tar.gz: c3f18989af8e2419050f606b07ba417a7589f0b5
+  metadata.gz: e304facbf9df8b0d9f56707bb2fff2c05e7eeb33
+  data.tar.gz: acf675f70dfd8c77efb5f58ceaee071802094762
 SHA512:
-  metadata.gz: 5a80c92d83ba89917814d6c7581895bc1ff568e562ffee76b60f81f84821ef84a8ce6f31cab26f865ce18adfd52eca8c53b92b3a554ffbb95595b6a54079a859
-  data.tar.gz: c3e32340ceeae019939d0853366c89e1b226ac24d61c693b0610a11af676c6a41e37a96569960def018a6753e165b7395f9f92c0e93bc688b7b455f5f4cca2c7
+  metadata.gz: 9981d254c00a9be82d1db0936dcd7222ad2dff0212ab1d01ed00486b71ab8d204a7d4ee893156dbaf6c7d01bc92c14ea9723c82531c3cd8797d020c7dc00ba56
+  data.tar.gz: e65fada56e6859ec0b78f1a1e30b9e4e2864d9ba45a267d0159c6b053a5f070cb69d4a5959768f9155082d1686aba5f573720707662b5c67d6813aa4b35ae362

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dldinternet-mixlib-thor (0.7.0)
+    dldinternet-mixlib-thor (0.9.1)
       activesupport (~> 5.1, >= 5.1.4)
       awesome_print
       command_line_reporter (~> 3.3, >= 3.3.6)
@@ -9,6 +9,7 @@ PATH
       dldinternet-mixlib-logging (>= 0.7.0)
       hashie
       inifile
+      json-pointer (~> 0.0, < 0.1)
       paint-shortcuts
       thor (~> 0.19, >= 0.19.4)
       vcr (~> 3.0, >= 3.0.3)
@@ -43,6 +44,7 @@ GEM
     i18n (0.8.6)
     inifile (3.0.0)
     json (2.0.3)
+    json-pointer (0.0.1)
     little-plugger (1.1.4)
     logging (2.2.2)
       little-plugger (~> 1.1)

data/dldinternet-mixlib-thor.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency              'config-factory'                      #, '~> '
   gem.add_dependency              'vcr', '~> 3.0', '>= 3.0.3'
   gem.add_dependency              'activesupport', '~> 5.1', '>= 5.1.4'
+  gem.add_dependency              'json-pointer', '~> 0.0', '< 0.1'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.add_development_dependency 'rake', '~> 10'

data/lib/dldinternet/formatters/awesome.rb

@@ -7,16 +7,14 @@ module DLDInternet
   module Formatters
     # Awesome formatter
     class Awesome < DLDInternet::Formatters::Basic
-      attr_reader :format
-      attr_reader :object
-      attr_reader :title
 
       def initialize(obj, format, options)
         super
       end
 
-      def format_it
-        object.ai
+      def format_it(item=nil)
+        item ||= object
+        item.ai
       end
     end
   end

data/lib/dldinternet/formatters/basic.rb

@@ -2,6 +2,7 @@
 
 require 'json'
 require 'yaml'
+require 'csv'
 require 'awesome_print'
 require 'hashie/mash'
 
@@ -72,8 +73,10 @@ module DLDInternet
           @widths = Hashie::Mash.new
           if @is_a_hash
             widths_hash
-          else
+          elsif @object.is_a?(Array)
             widths_array
+          else
+            widths_object
           end
         end
         @widths
@@ -106,11 +109,75 @@ module DLDInternet
       private
 
       def format_item(item, header=false)
-        case format.to_s.downcase
+        fmt = format.to_s.downcase
+        if /json|yaml|csv/.match?(fmt)
+          item = if @columns.nil?
+                   item
+                 else
+                   item = item.dup
+                   if item.is_a?(Array)
+                     nitm = item.map do |itm|
+                       hitm = Hash[itm.map do |key, val|
+                         if @columns.keys.include?(key) && @columns[key].nil?
+                           [key,val]
+                         end
+                       end.select{ |e| !e.nil? }]
+                     end
+                     nitm
+                   elsif item.is_a?(Hash)
+                   else
+                     item
+                   end
+                 end
+        end
+        case fmt
         when 'json'
           JSON.pretty_generate(item)
         when 'yaml'
           item.to_yaml
+        when 'csv'
+          columns = if @columns.nil?
+                      if item.is_a?(Array)
+                        if item[0].is_a?(Array)
+                          # [2017-10-06 Christo] Assume first row is headings?
+                          item[0] # raise StandardError, "Cannot find column headings"
+                        elsif item[0].is_a?(Hash)
+                          item[0].keys
+                        else
+                          # [2017-10-06 Christo] Assume first row is headings?
+                          item
+                        end
+                      elsif item.is_a?(Hash)
+                        item.keys
+                      else
+                        item
+                      end
+                    else
+                      @columns.keys
+                    end
+          nitm = if item.is_a?(Array)
+                  item.map { |itm|
+                    if itm.is_a?(Array)
+                      itm
+                    elsif itm.is_a?(Hash)
+                      itm.values.map{|v| v.nil? ? '' : v}
+                    else
+                      [itm]
+                    end
+                  }
+                elsif item.is_a?(Hash)
+                  itm.values.map{|v| v.nil? ? '' : v}
+                else
+                  [itm]
+                 end
+          nitm.unshift(columns)
+          header_row = true
+          nitm.map! { |row|
+            o = CSV::Row.new(columns,row,header_row)
+            header_row = false
+            o
+          }
+          csv = CSV::Table.new(nitm).to_csv
         when 'none'
           item
         else
@@ -130,13 +197,14 @@ module DLDInternet
             }
             nitm.join(" ")
           elsif item.is_a?(Hash)
-            item.map do |key, val|
+            nitm = item.map do |key, val|
               if @columns.nil? || (@columns.keys.include?(key) && @columns[key].nil?)
                 sprintf("%-#{widths[key]}s", val.to_s)
-              else
+              elsif !key.index('.').nil?
                 sprintf("%-#{widths[key]}s", subcolumn(key, val))
               end
             end
+            nitm.select{|s| !s.nil?}.join(" ")
           else
             item.to_s
           end
@@ -161,21 +229,24 @@ module DLDInternet
         end
       end
 
+      def widths_object
+        set_width(0, @object)
+      end
+
       def widths_array
-        idx = 0
         @object.each do |val|
-          set_width(idx, val)
-          idx += 1
+          widths_hash(val)
         end
       end
 
-      def widths_hash
-        @object.each do |key, _|
+      def widths_hash(item=nil)
+        item ||= @object
+        item.each do |key, _|
           klen         = key.to_s.length
           wid          = @widths[key]
           @widths[key] = klen if !wid || wid < klen
         end
-        obj_width(@object)
+        obj_width(item)
       end
 
       def set_width(idx, val)

data/lib/dldinternet/formatters/table.rb

@@ -17,39 +17,64 @@ module DLDInternet
         @values  = Hashie::Mash.new
       end
 
-      def run
-        suppress_output
+      def capture_output
+        @previous_stdout, $stdout = $stdout, StringIO.new
+        begin
+          yield
+        rescue Exception => e
+          previous_stdout.write $stdout.string
+          raise e
+        end
+
+        $stdout.string
+      ensure
+        # Restore the previous value of stdout (typically equal to stdout).
+        $stdout = @previous_stdout
+      end
+
+      def suppress_output
+        @previous_stdout, $stdout = $stdout, StringIO.new
+      end
 
-        header(title: @title, align: 'center') if @title #&& !@title.empty?
+      def restore_output
+        string = $stdout.string
+        $stdout = @previous_stdout
+        string
+      end
+
+      def run
+        # suppress_output
+        capture_output do
+          header(title: @title, align: 'center') if @title #&& !@title.empty?
 
-        table border: true, encoding: :ascii do
-          header_row
-          idx = 0
-          list = @object.is_a?(Array) ? @object : [@object]
-          list.each do |obj|
-            obj_row(idx, obj)
+          table border: true, encoding: :ascii do
+            header_row
+            idx = 0
+            list = @object.is_a?(Array) ? @object : [@object]
+            list.each do |obj|
+              obj_row(idx, obj)
+            end
           end
         end
 
-        capture_output
+        # string = restore_output
       rescue => exe
         restore_output
         raise exe
       end
 
       def header_row
-        if @is_a_hash
-          row color: 'light_yellow', bold: true, encoding: :ascii do
-            @object[0].each do |key, _|
-              column key.to_s, width: widths[key] if (@columns.nil? || @columns.keys.include?(key))
-            end
+        list = @object.is_a?(Array) ? @object : [@object]
+        row color: 'light_yellow', bold: true, encoding: :ascii do
+          list[0].each do |key, _|
+            column key.to_s, width: widths[key] if (@columns.nil? || @columns.keys.include?(key))
           end
         end
       end
 
       def obj_row(idx, obj)
         row color: 'white', bold: false do
-          if @is_a_hash
+          if obj.is_a? Hash
             obj.each do |key, val|
               if @columns.nil? || (@columns.keys.include?(key) && @columns[key].nil?)
                 column val.to_s
@@ -64,7 +89,12 @@ module DLDInternet
         end
       end
 
-      def format_it
+      def format_it(item=nil)
+        if item
+          @object = item
+          @is_a_hash = @object.is_a?(Hash)
+          @widths = nil
+        end
         run
       end
     end

data/lib/dldinternet/thor/command.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require 'dldinternet/thor/dynamic_command'
+require 'dldinternet/thor/errors'
 require 'awesome_print'
 
 module DLDInternet

data/lib/dldinternet/thor/errors.rb

@@ -0,0 +1,5 @@
+module DLDInternet
+  module Thor
+    class BadArgumentError < StandardError ; end
+  end
+end

data/lib/dldinternet/thor/mixins/no_commands.rb

@@ -4,6 +4,7 @@ require 'yaml'
 require 'dldinternet/formatters'
 require 'hashie/mash'
 require 'dldinternet/thor/version'
+require 'dldinternet/thor/errors'
 require 'inifile'
 require 'config/factory'
 require 'dldinternet/thor/vcr'
@@ -45,22 +46,32 @@ module DLDInternet
     LOG_LEVELS = [:trace, :debug, :info, :note, :warn, :error, :fatal, :todo]
 
     class OptionsMash < ::Hashie::Mash ; end
+    class ConfigMash < ::Hashie::Mash
+      def initialize(source_hash = nil, default = nil, &blk)
+        self.class.disable_warnings
+        super
+      end
+    end
 
     module MixIns
       module NoCommands
         require 'dldinternet/mixlib/logging'
         include DLDInternet::Mixlib::Logging
 
-        def validate_options
+        def validate_options(*args)
           writeable_options
           if options[:log_level]
             log_level = options[:log_level].to_sym
             raise "Invalid log-level: #{log_level}" unless LOG_LEVELS.include?(log_level)
             options[:log_level] = log_level
           end
-          @options[:log_level] ||= :warn
           @options[:format] ||= @options[:output]
           @options[:output] ||= @options[:format]
+
+          args.flatten!
+          if !args.empty? && args.map{ |a| /^-/.match(a) }.any?
+            raise DLDInternet::Thor::BadArgumentError, "Invalid arguments provided: #{args}"
+          end
         end
 
         def writeable_options
@@ -113,21 +124,25 @@ module DLDInternet
         end
 
         def load_config
-          unless @options[:config].blank?
-            @options[:config] = File.expand_path(@options[:config])
-            if ::File.exist?(@options[:config])
+          if @options[:configfile].blank?
+            @logger.error 'Invalid/No configuration file specified'
+          else
+            @options[:configfile] = File.expand_path(@options[:configfile])
+            if ::File.exist?(@options[:configfile])
               begin
-                envs = ::Config::Factory::Environments.load_file(@options[:config])
+                # envs = ::Config::Factory::Environments.load_file(@options[:configfile])
+                hash = config_to_yaml
+                envs = ::Config::Factory::Environments.load_hash(hash)
                 if envs and envs.is_a?(Hash) and @options[:environment]
                   @options[:environments] = ::Hashie::Mash.new(envs)
                 else
-                  yaml = ::YAML.load(File.read(@options[:config]))
+                  yaml = ::YAML.load(File.read(@options[:configfile]))
                   if yaml
                     yaml.each {|key, value|
                       @options[key.to_s.gsub(%r{[-]}, '_').to_sym]=value
                     }
                   else
-                    msg = "#{options.config} is not a valid configuration!"
+                    msg = "#{options[:configfile]} is not a valid configuration!"
                     @logger.error msg
                     raise StandardError.new(msg)
                   end
@@ -137,27 +152,67 @@ module DLDInternet
                 raise e
               end
             else
-              @logger.warn "#{options.config} not found"
+              @logger.warn "'#{options[:configfile]}' not found"
               @logger.error "Invalid/No configuration file specified"
               exit 2
               #@options[:environments] = ::Hashie::Mash.new
             end
-          else
-            @logger.error 'Invalid/No configuration file specified'
           end
         end
 
-        def parse_options
-          validate_options
+        def solve_pointers(haystack, hash=nil)
+          hash ||= haystack
+          return haystack unless hash.is_a?(Hash) && hash.size
 
+          hash.dup.each do |k,v|
+            if %r{^[#/]}.match?(k) && v.nil?
+              begin
+                require 'hana'
+                pointer = Hana::Pointer.new k
+                v = pointer.eval(haystack)
+                hash.delete(k)
+                hash.merge!(v)
+              rescue Exception => e
+                require 'json-pointer'
+                pointer = ::JsonPointer.new(haystack, k, :symbolize_keys => true)
+                if pointer.exists?
+                  hash.delete(k)
+                  hash.merge!(pointer.value)
+                end
+              end
+            end
+          end
+          hash.each do |k,v|
+            if v && v.is_a?(Hash)
+              haystack = solve_pointers(haystack, v)
+            end
+          end
+          haystack
+        end
+
+        def config_to_yaml
+          begin
+            yaml = ConfigMash.new(::YAML.load(File.read(@options[:configfile])))
+            yaml = solve_pointers(yaml)
+            yaml
+          rescue StandardError => e
+            raise e
+          end
+        end
+
+        def parse_options(*args)
           get_logger(true)
 
+          args.flatten!
+          check_for_help(args)
+          validate_options(args)
+
           if @options[:inifile]
             @options[:inifile] = File.expand_path(@options[:inifile])
             load_inifile
-          elsif @options[:config]
-            if @options[:config] =~ /\.ini/i
-              @options[:inifile] = @options[:config]
+          elsif @options[:configfile]
+            if @options[:configfile] =~ /\.ini/i
+              @options[:inifile] = @options[:configfile]
               load_inifile
             else
               load_config
@@ -166,19 +221,22 @@ module DLDInternet
           if options[:debug]
             @logger.info "Options:\n#{options.ai}"
           end
-          if options[:stubber].is_a?(String)
-            options[:stubber] = options[:stubber].split(/\s*,\s*/).map(&:to_sym)
-          elsif options[:stubber].is_a?(Array) && options[:stubber].size == 1 && options[:stubber][0].is_a?(String)
-            options[:stubber] = options[:stubber][0].split(/\s*,\s*/).map(&:to_sym)
-          elsif options[:stubber].is_a?(Array) && options[:stubber].size > 1 && options[:stubber][0].is_a?(String)
-            options[:stubber] = options[:stubber].map(&:to_sym)
-          end
 
         end
 
+        # Child classes can override this if desired
+        def check_for_help(args)
+          if args && args.size > 0 && (args[0] && args[0].downcase.eql?('help') || args.select {|a| a.match(/--help/i)}.any?)
+            invocations = @_invocations.map {|_, v| v[0]}
+            self.class.command_help(shell, invocations[-1], invocations)
+            exit 0
+          end
+        end
+
         def get_logger(force=false)
           return unless force || @logger.nil?
           writeable_options
+          @options[:log_level] ||= :warn
           lcs             = ::Logging::ColorScheme.new('compiler', :levels => {
               :trace => :blue,
               :debug => :cyan,
@@ -217,7 +275,7 @@ module DLDInternet
         end
 
         def notation
-          @config[:output] || :none
+          @config[:format] || :none
         end
 
         def default_formatter(obj, opts=nil)
@@ -226,8 +284,9 @@ module DLDInternet
           case notation.to_sym
           when :json
           when :yaml
+          when :csv
           when :none
-          when :basic
+          # when :basic
           when :text
             # noop
           when :awesome
@@ -291,8 +350,8 @@ module DLDInternet
         end
 
         def command_pre(*args)
-          args.flatten!
-          parse_options
+          # args.flatten!
+          parse_options(args)
           @logger.info @_invocations.map{ |_,v| v[0]}.join(' ') if options[:verbose]
           command_pre_start_vcr(args)
         end
@@ -308,6 +367,8 @@ module DLDInternet
             fmtr = formatter.call(res, options)
             fmtr.table_widths
           end
+          # [2017-10-06 Christo] header_line and format_line serves to invoke client hooks if provided.
+          # It means we may go through the process once with an object and a second time with a formatted string
           case options[:format]
           when /text|none|plain/
             output(header_line(res, fmtr), fmtr, true) unless options[:header] === false
@@ -361,6 +422,13 @@ module DLDInternet
 
         def command_pre_start_vcr(*args)
           args.flatten!
+          if options[:stubber].is_a?(String)
+            options[:stubber] = options[:stubber].split(/\s*,\s*/).map(&:to_sym)
+          elsif options[:stubber].is_a?(Array) && options[:stubber].size == 1 && options[:stubber][0].is_a?(String)
+            options[:stubber] = options[:stubber][0].split(/\s*,\s*/).map(&:to_sym)
+          elsif options[:stubber].is_a?(Array) && options[:stubber].size > 1 && options[:stubber][0].is_a?(String)
+            options[:stubber] = options[:stubber].map(&:to_sym)
+          end
           if options[:vcr]
             unless options[:cassette_path].match(%r{^#{File::SEPARATOR}})
               if File.dirname($0).eql?(Dir.pwd)
@@ -369,19 +437,24 @@ module DLDInternet
               end
             end
 
-            @vcr_logger ||= ::DLDInternet::Thor::VCR::Logger.new(nil, @logger)
-            ::VCR.configure do |config|
-              config.cassette_library_dir = options[:cassette_path]
-              config.hook_into *options[:stubber]
-              config.logger = @vcr_logger
-            end
+            command_pre_config_vcr
             opts = args[0].is_a?(Hash) ? args.shift : {}
             options[:cassette] ||= @_invocations.map{ |_,v| v[0]}.join('-')
-            @cassette = ::VCR.insert_cassette(opts[:cassette] || options[:cassette], match_requests_on: [:method,:uri,:headers,:body], record: options[:record_mode])
+            @cassette = ::VCR.insert_cassette(opts[:cassette] || options[:cassette])
           end
           yield if block_given?
         end
 
+        def command_pre_config_vcr
+          @vcr_logger ||= ::DLDInternet::Thor::VCR::Logger.new(nil, @logger)
+          ::VCR.configure do |config|
+            config.cassette_library_dir = options[:cassette_path]
+            config.hook_into *options[:stubber]
+            config.logger = @vcr_logger
+            config.default_cassette_options.merge!({ match_requests_on: [:method, :uri, :headers, :body], record: options[:record_mode] })
+          end
+        end
+
         def command_post_stop_vcr
           if options[:vcr]
             ::VCR.eject_cassette

data/lib/dldinternet/thor/version.rb

@@ -1,7 +1,7 @@
 module Dldinternet
   module Mixlib
     module Thor
-      VERSION = '0.7.0'
+      VERSION = '0.9.1'
 
       module Version # :nodoc: all
         MAJOR, MINOR, RELEASE, *OTHER = VERSION.split '.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dldinternet-mixlib-thor
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Christo De Lange
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -174,6 +174,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: json-pointer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -239,6 +259,7 @@ files:
 - lib/dldinternet/formatters/table.rb
 - lib/dldinternet/thor/command.rb
 - lib/dldinternet/thor/dynamic_command.rb
+- lib/dldinternet/thor/errors.rb
 - lib/dldinternet/thor/mixins/no_commands.rb
 - lib/dldinternet/thor/vcr.rb
 - lib/dldinternet/thor/vcr/logger.rb
@@ -263,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Thor no_commands reuse