atli 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e803318c577bd05f0beff20eb566249010e83ae
-  data.tar.gz: 9640814f9e4de51bfc750833bd4cbcf088b32566
+  metadata.gz: 13e61f293aa7bde2e5ac7b0db815fbe5c7a40751
+  data.tar.gz: f01468bc2b2ec632e392086fe36c068c0eb412f4
 SHA512:
-  metadata.gz: 07fda1a0696a13dabc7809ed25a501ac3082142e4a45993a7ade6b509a1a853d77b1e55e9380b7b1b19907fa3279559f46ef7ace0a8d6fa0f81471a8cf219b2a
-  data.tar.gz: 932503e631f498ae2128a608af0221ea5e75837354e680913c2d90f5aff216808a2df201af280685e696483698a2fe0cc932b8f8e6b800d01cfa76455bdb0e08
+  metadata.gz: f1c315d604b47905681f2a811fc2540730c5a0607159409e6c8c84c05a838dd8385267e011ba30ba1f1369fba15a8917f4cc798738f699d7de3733abab32f9d5
+  data.tar.gz: 12ccd0e704f4a91e51be8b126b8d1f2657924835a9c5a2baef20d308b9168e1b1ca69acb6f7236adf87ad4e703111dd719872a46c1c38d66094fb9a048c2f20f

data/atli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   # ============================================================================
   
   # My guns
-  spec.add_dependency "nrser", '~> 0.3.3'
+  spec.add_dependency "nrser", '~> 0.3.5'
   
   
   # Development Dependencies

data/lib/thor.rb

@@ -2,6 +2,7 @@ require "set"
 require 'nrser'
 require 'semantic_logger'
 require "thor/base"
+require 'thor/example'
 
 
 class Thor
@@ -198,7 +199,11 @@ class Thor
       shell.say "Usage:"
       shell.say "  #{banner(command, nil, subcommand)}"
       shell.say
-      class_options_help(shell, nil => command.options.values)
+      
+      class_options_help \
+        shell,
+        command.options.values.group_by { |option| option.group }
+      
       if command.long_description
         shell.say "Description:"
         shell.print_wrapped(command.long_description, :indent => 2)
@@ -206,6 +211,24 @@ class Thor
         shell.say command.description
       end
       
+      unless command.examples.empty?
+        shell.say "\n"
+        shell.say "Examples:"
+        shell.say "\n"
+        
+        command.examples.each_with_index do |example, index|
+          lines = example.lines
+          
+          shell.say "1.  #{ lines[0] }"
+          
+          lines[1..-1].each do |line|
+            shell.say "    #{ line }"
+          end
+        end
+        
+        shell.say "\n"
+      end
+      
       nil
     end
     alias_method :task_help, :command_help
@@ -435,10 +458,26 @@ class Thor
     def find_shared_method_options *names, groups: nil
       groups_set = Set[*groups]
       
-      shared_method_options.
-        select { |name, option|
-          names.include?( name ) || !(option.groups & groups_set).empty?
-        }
+      shared_method_options.each_with_object( {} ) do |(name, option), results|
+        match = {}
+        
+        if names.include? name
+          match[:name] = true
+        end
+        
+        match_groups = option.groups & groups_set
+          
+        unless match_groups.empty?
+          match[:groups] = match_groups
+        end
+        
+        unless match.empty?
+          results[name] = {
+            option: option,
+            match: match,
+          }
+        end
+      end
     end
     alias_method :find_shared_options, :find_shared_method_options
     
@@ -553,8 +592,8 @@ class Thor
     # 
     def include_method_options *names, groups: nil
       find_shared_method_options( *names, groups: groups ).
-        each do |name, option|
-          method_options[name] = option
+        each do |name, result|
+          method_options[name] = Thor::IncludedOption.new **result
         end
     end
     
@@ -650,16 +689,20 @@ class Thor
         @desc ||= nil
         @long_desc ||= nil
         @hide ||= nil
+        
+        examples = @examples || []
+        @examples = []
 
         if @usage && @desc
           base_class = @hide ? Thor::HiddenCommand : Thor::Command
-          commands[meth] = base_class.new(
-            meth,
-            @desc,
-            @long_desc,
-            @usage,
-            method_options
-          )
+          commands[meth] = base_class.new \
+            name: meth,
+            description: @desc,
+            long_description: @long_desc,
+            usage: @usage,
+            examples: examples,
+            options: method_options
+          
           @usage, @desc, @long_desc, @method_options, @hide = nil
           true
         elsif all_commands[meth] || meth == "method_missing"

data/lib/thor/base/class_methods.rb

@@ -17,10 +17,11 @@ require 'nrser/refinements/types'
 using NRSER::Types
 
 
-# Declarations
+# Namespace
 # =======================================================================
 
-module Thor::Base; end
+class   Thor
+module  Base
 
 
 # Definitions
@@ -29,7 +30,7 @@ module Thor::Base; end
 # Methods that are mixed in as module/class/singleton methods to modules
 # that include {Thor::Base}.
 # 
-module Thor::Base::ClassMethods
+module ClassMethods
   
   # Mixins
   # ==========================================================================
@@ -536,7 +537,7 @@ module Thor::Base::ClassMethods
     # 
     # @return [nil]
     # 
-    def class_options_help(shell, groups = {}) #:nodoc:
+    def class_options_help shell, groups = {}
       # Group options by group
       class_options.each do |_, value|
         groups[value.group] ||= []
@@ -545,7 +546,10 @@ module Thor::Base::ClassMethods
 
       # Deal with default group
       global_options = groups.delete(nil) || []
-      print_options(shell, global_options)
+      print_options \
+        shell,
+        global_options,
+        (groups.empty? ? nil : 'General')
 
       # Print all others
       groups.each do |group_name, options|
@@ -731,4 +735,11 @@ module Thor::Base::ClassMethods
     
   public # end Protected Mixin Methods ***************************************
   
-end # module Thor::Base::ClassMethods
+end # module ClassMethods
+
+
+# /Namespace
+# ========================================================================
+
+end # module Base
+end # class Thor

data/lib/thor/command.rb

@@ -5,14 +5,26 @@ class Thor
                               :description,
                               :long_description,
                               :usage,
+                              :examples,
                               :options,
                               :ancestor_name )
     include SemanticLogger::Loggable
     
     FILE_REGEXP = /^#{Regexp.escape(File.dirname(__FILE__))}/
 
-    def initialize(name, description, long_description, usage, options = nil)
-      super(name.to_s, description, long_description, usage, options || {})
+    def initialize  name:,
+                    description: nil,
+                    long_description: nil,
+                    usage: nil,
+                    examples: [],
+                    options: nil
+      super \
+        name.to_s,
+        description,
+        long_description,
+        usage,
+        examples,
+        options || {}
     end
 
     def initialize_copy(other) #:nodoc:
@@ -301,11 +313,11 @@ class Thor
   # A dynamic command that handles method missing scenarios.
   class DynamicCommand < Command
     def initialize(name, options = nil)
-      super(  name.to_s,
-              "A dynamically-generated command",
-              name.to_s,
-              name.to_s,
-              options )
+      super(  name: name.to_s,
+              description: "A dynamically-generated command",
+              long_description: name.to_s, # why?!
+              usage: name.to_s,
+              options: options )
     end
 
     def run(instance, args = [])

data/lib/thor/example.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Definitions
+# =======================================================================
+
+class Thor
+  
+  # Add an example to the next defined command.
+  # 
+  # @param [String] example
+  #   The example text.
+  # 
+  # @return [nil]
+  # 
+  def self.example example
+    @examples ||= []
+    @examples << example
+    nil
+  end # #example
+  
+end # class Thor

data/lib/thor/group.rb

@@ -251,7 +251,7 @@ class Thor::Group
       end
 
       def create_command(meth) #:nodoc:
-        commands[meth.to_s] = Thor::Command.new(meth, nil, nil, nil, nil)
+        commands[meth.to_s] = Thor::Command.new name: meth
         true
       end
       alias_method :create_task, :create_command

data/lib/thor/parser/option.rb

@@ -1,3 +1,6 @@
+# Need {String#titleize}
+require 'active_support/core_ext/string/inflections'
+
 class Thor
   class Option < Argument #:nodoc:
     attr_reader :aliases, :group, :lazy_default, :hide
@@ -9,7 +12,7 @@ class Thor
       options[:required] = false unless options.key?(:required)
       super
       @lazy_default = options[:lazy_default]
-      @group        = options[:group].to_s.capitalize if options[:group]
+      @group        = options[:group].to_s.titleize if options[:group]
       @aliases      = Array(options[:aliases])
       @hide         = options[:hide]
     end

data/lib/thor/parser/shared_option.rb

@@ -1,5 +1,28 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# ========================================================================
+
+# Stdlib
+# ------------------------------------------------------------------------
 require 'set'
 
+# Deps
+# ------------------------------------------------------------------------
+
+# Need {String#titleize}
+require 'active_support/core_ext/string/inflections'
+
+# Need {NRSER::LazyAttr}
+require 'nrser/meta/lazy_attr'
+
+# Project / Package
+# ------------------------------------------------------------------------
+
+require_relative './option'
+
+
 class Thor
   # A {Thor::Option} that has an additional {#groups} attribute storing a
   # set of group symbols that the option is a part of.
@@ -15,9 +38,80 @@ class Thor
     # 
     # 
     def initialize name, **options
+      @groups = Set.new [*options[:groups]].map( &:to_sym )
+      
+      # # If
+      # if options[:group].nil? && groups.count == 1
+      #   options[:group] = groups.first.to_s.titleize
+      # end
+      
       super name, options
+    end
+    
+    
+    def initialize_options
+      {
+        # {Thor::Argument} options
+        desc:               :@description,
+        required:           :@required,
+        type:               :@type,
+        default:            :@default,
+        banner:             :@banner,
+        eunm:               :@enum,
+        
+        # {Thor::Option} options
+        check_default_type: :@check_default_type,
+        lazy_default:       :@lazy_default,
+        group:              :@group,
+        aliases:            :@aliases,
+        hide:               :@hide,
+        
+        # {Thor::SharedOption} options
+        groups:             :@groups,
+      }.transform_values &method( :instance_variable_get )
+    end
+    
+  end
+  
+  
+  class IncludedOption < SharedOption
+    
+    # The match that resulted in this option getting included.
+    # 
+    # @return [Hash]
+    #     
+    attr_reader :match
+    
+    
+    def initialize option:, match:
+      super option.name, **option.initialize_options
+      @match = match
+    end
+    
+    
+    +NRSER::LazyAttr
+    def group
+      case @group
+      when false
+        nil
+      when String
+        @group
+      when nil
+        default_group
+      else
+        logger.warn "Bad {Option#group}: #{ @group.inspect }",
+          option: self
+        nil
+      end
+    end
+    
+    
+    +NRSER::LazyAttr
+    def default_group
+      return nil unless match[:groups]
       
-      @groups = Set.new [*options[:groups]].map( &:to_sym )
+      match[:groups].map { |group| group.to_s.titleize }.join ' / '
     end
+    
   end
 end

data/lib/thor/version.rb

@@ -14,7 +14,7 @@ class Thor
   # 
   # @return [String]
   # 
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
   
   
   # The version of Thor that Atli is up to date with.
@@ -27,5 +27,5 @@ class Thor
   # 
   # @return [String]
   # 
-  THOR_VERSION = '0.1.7'
+  THOR_VERSION = '0.1.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atli
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Neil Souza (Atli)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-06 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.5
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - lib/thor/core_ext/io_binary_read.rb
 - lib/thor/core_ext/ordered_hash.rb
 - lib/thor/error.rb
+- lib/thor/example.rb
 - lib/thor/execution.rb
 - lib/thor/group.rb
 - lib/thor/invocation.rb