command_lion 1.0.2 → 1.0.3geff

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1a46eb35cac2757a52188adce29bcb41c03a26c
-  data.tar.gz: f38a9d1c5559252a4232a5ec0d221e6f73708e55
+  metadata.gz: d7cda4297c39ea6846426e97a497a5cf04647435
+  data.tar.gz: 5b783c285cd06038f9cc99427d13656472ce5f46
 SHA512:
-  metadata.gz: 8a2c13b8007fdeff85b9bbeadcc1157deb5008e5087910b3b0c6216d0c993e25d264c2583204f968f843e4c0d03f89dc39c5f3b75c8e357f837977656090753c
-  data.tar.gz: 1a8513c041c2097d2fce2bb393f654aa76a718860640404af10ef25e0b1bc31ec9b7352076648f699ea008783ef9e3e5451d7349d6386c398bb22e34803cade1
+  metadata.gz: 6c4d111fcb3c61e8490832a38293d9fe25ab2591b14b949fd32999a68eea7810a854377b3c05d6b51638d70004263a3d6c94ba7b06093bf0c21236d0e5453497
+  data.tar.gz: 47240995ed6c20214dd46da5fb8e35bd91ceee7f720f417052da1bb883dabff2109187607b4c232adf812b1b164128c35a816b231959c911b698c8dab01d4212

data/examples/example.rb

@@ -20,7 +20,10 @@ CommandLion::App.run do
     end
     
     option :rainbow do
-      flag "--rainbow"
+      flags do
+        short "-r"
+        long  "--rainbow"
+      end
       action do
         require 'lolize/auto'
       end

data/examples/hello_multi.rb

@@ -24,7 +24,10 @@ CommandLion::App.run do
     
     option :ignore do
       description "Optionally ignore one person."
-      flag "--ignore"
+      flags do
+        short "-i"
+        long  "--ignore"
+      end
       type :string
     end
   end

data/examples/read.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'command_lion'
+require 'pry'
+
+CommandLion::App.run do
+  # ...
+  command :read_stdin do
+    flag "--read"
+    type :stdin_stream
+    action do
+      # Separate into two operations to make it faster.
+      if options[:filter].given?
+        # Filter lines that contain string.
+        inclusive = options[:filter].argument
+        arguments do |argument|
+          next unless argument.include?(inclusive)
+          puts argument
+        end
+      else
+        # Just print lines. 
+        arguments do |argument|
+          puts argument
+        end
+      end
+    end
+    option :filter do
+      flag "--filter"
+      type :string
+    end
+  end
+end

data/examples/test.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'command_lion'
+require 'pry'
+
+CommandLion::App.run do
+
+  name "Printr"
+  version "1.0.0"
+  remove_default_help_menu
+
+  command :print do
+    type :string
+    
+    action do
+      arguments do |argument|
+        puts argument 
+      end
+    end
+  end
+
+  #help do
+  #  flags do
+  #    short "-h"
+  #    long  "--help"
+  #  end
+  # 
+  #  action do
+  #    puts "So helpfulp!"
+  #  end 
+  #end
+
+end

data/lib/command_lion/app.rb

@@ -100,10 +100,11 @@ module CommandLion
       max_flag = flagz.map(&:length).max + 2
       max_desc = app.commands.values.map(&:description).select{|d| d unless d.nil? }.map(&:length).max
       puts app.name
+      puts
       if app.version?
-        puts
         puts "VERSION"
         puts app.version
+        puts
       end
       if app.description?
         puts 
@@ -141,17 +142,33 @@ module CommandLion
       end
     end
 
+    # This run method is a pretty important method when using command lion typically.
+    #
+    # Under the hood, an application object is initialized. The block of code passed to
+    # this method is then used as the code that is ran in the context of a application 
+    # object. So all of those methods will be available.
+    #
     def self.run(&block)
+      # Initialize an instance of an App object.
       app = new
+      # Evaluate the block of code within the context of that App object.
       app.instance_eval(&block)
+      # Parse the application logic out.
+      app.parse
+      # Sometimes a command-line application is run without being given any arguments.
       if ARGV.empty?
-        if app.help?
-          puts app.help
+        # Default to a help menu.
+        if cmd = app.commands[:help]
+          cmd.before.call if cmd.before?
+          cmd.action.call if cmd.action?
+          cmd.after.call  if cmd.after?
+          # maybe exit?
         else
-          default_help(app)
+          # Use the default help menu for the application unless that's been
+          # explictly removed by the author for whatever reason.
+          default_help(app) unless app.default_help_menu_removed?
         end
       else
-        app.parse
         threadz = false
         app.commands.each do |_, cmd|
           next unless cmd.given?
@@ -172,6 +189,22 @@ module CommandLion
       end
     end
 
+    # Check if there has been an indexed help command.
+    def help?
+      return true if @commands[:help]
+      false
+    end
+
+    # Explicitly remove the default help menu from the application.
+    def remove_default_help_menu
+      @remove_default_help_menu = true
+    end
+
+    # Check if the default help menu for the application has been explicitly removed.
+    def default_help_menu_removed?
+      @remove_default_help_menu || false
+    end
+
     # A tiny bit of rainbow magic is included. You can simple include
     # this option within your application and, if you have the `lolize` gem
     # installed, then rainbows will automagically be hooked to STDOUT to make your
@@ -232,8 +265,8 @@ module CommandLion
       if cmd.options?
         cmd.options.each do |_, option|
           if option.flags?
-            @flags << option.flags.short if cmd.flags.short?
-            @flags << option.flags.long  if cmd.flags.long?
+            @flags << option.flags.short if option.flags.short?
+            @flags << option.flags.long  if option.flags.long?
           else # just use index
             @flags << option.index.to_s
           end
@@ -245,6 +278,11 @@ module CommandLion
       cmd
     end
 
+    def help(&block)
+      command :help, &block
+    end
+
+
     # Plugin a command that's probably been built outside of the application's run or build block.
     # This is helpful for sharing or reusing commands in applications.
     # @param command [Command] 
@@ -268,7 +306,8 @@ module CommandLion
     def parse
       @commands.each do |_, cmd|
         if cmd.flags?
-          next unless argv_index = ARGV.index(cmd.flags.short) or ARGV.index(cmd.flags.long)
+          # or for the || seems to not do what I want it to do...
+          next unless argv_index = ARGV.index(cmd.flags.short) || ARGV.index(cmd.flags.long)
         else
           next unless argv_index = ARGV.index(cmd.index.to_s)
         end
@@ -292,7 +331,7 @@ module CommandLion
     def parse_cmd(cmd, flags)
       if cmd.flags?
         args = Raw.arguments_to(cmd.flags.short, flags)
-        if args.empty?
+        if args.nil? || args.empty?
           args = Raw.arguments_to(cmd.flags.long, flags)
         end
       else
@@ -307,7 +346,13 @@ module CommandLion
       when :stdin_string
         args = STDIN.gets.strip
       when :stdin_strings
-        args = STDIN.gets.strip
+        args = []
+        while arg = STDIN.gets
+          next if arg.nil?
+          arg = arg.strip
+          args << arg
+        end
+        args
       when :stdin_integer
         args = STDIN.gets.strip.to_i
       when :stdin_integers
@@ -324,7 +369,7 @@ module CommandLion
       when :stdin_bool
         args = STDIN.gets.strip.downcase == "true"
       when :single, :string
-        args.first
+        args = args.first
       when :strings, :multi
         if cmd.delimiter?
           if args.count > 1
@@ -338,7 +383,7 @@ module CommandLion
         end
         args
       when :integer
-        args.first.to_i
+        args = args.first.to_i
       when :integers
         if cmd.delimiter?
           if args.count > 1
@@ -349,7 +394,7 @@ module CommandLion
             args = args.map { |arg| arg.split(cmd.delimiter) }.flatten
           end
         end
-        args.map(&:to_i)
+        args = args.map(&:to_i)
       when :bool, :bools
         if cmd.delimiter?
           if args.count > 1
@@ -360,7 +405,7 @@ module CommandLion
             args = args.map { |arg| arg.split(cmd.delimiter) }.flatten
           end
         end
-        args.map { |arg| arg == "true" }
+        args = args.map { |arg| arg == "true" }
       end
     rescue => e# this is dangerous
       puts e

data/lib/command_lion/version.rb

@@ -1,3 +1,3 @@
 module CommandLion
-  VERSION = "1.0.2"
+  VERSION = "1.0.3geff"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_lion
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3geff
 platform: ruby
 authors:
 - Kent 'picat' Gruber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,12 +87,14 @@ files:
 - examples/packet_head.rb
 - examples/pcapr.rb
 - examples/plugin.rb
+- examples/read.rb
 - examples/read_file.rb
 - examples/read_stdin.rb
 - examples/readme.rb
 - examples/sample.rb
 - examples/simple_attr_example.rb
 - examples/simple_attrs_example.rb
+- examples/test.rb
 - examples/words.txt
 - lib/command_lion.rb
 - lib/command_lion/app.rb
@@ -117,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.12