fylla 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9146ead4c4c7a8a7d72096188734b6f439ffff2
-  data.tar.gz: 5533724b62e9c629c99d62f68eb7cf2c55b4dadd
+  metadata.gz: 90d49bc51792ace89262f2175d3590427cdb9d92
+  data.tar.gz: 9cd74325c692ddce6371ddaea10d4e972ec721e2
 SHA512:
-  metadata.gz: ca9a24cb0a6829f9b0c814892c80684eed43a31c9d5d6c64b9d15b031aaa27850a8a53a0143b6da439f4d49b4a18cb6a9e7512272c088fa352a49659fb55a912
-  data.tar.gz: 737af6d0958eb919b9a8e9d2ec6dfb6e57fea009d337bd66853dee3f7aadbd18365222a4c56a0e93111f8bb5fd99845d22e54a1c95c6d88d0b34ef54892e2a60
+  metadata.gz: a53727a1901bbe8cde4260fd3acaa75db30755b8fb8900cdaea12f6980028d9ef66b250ea6bc948b92e43460f3c5eeb27b4bad163d16a0480dbe5dce20876c32
+  data.tar.gz: d4adaac549e8dc82aad501442ad406ca8cb3d14594b0a1abb059f0c6b05893808e1d5b9b53bbf1941082936133567632344c6cd5ba682c90b5a42f16fdc1138d

data/fylla.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
 
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+  spec.metadata['changelog_uri'] = 'https://github.com/snowe2010/fylla/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'

data/lib/fylla/completion_extension.rb

@@ -0,0 +1,21 @@
+require 'thor'
+
+class Thor
+  class Option
+    attr_accessor :completion
+    old_initialize = instance_method(:initialize)
+    define_method(:initialize) do |name, options = {}|
+      old_initialize.bind(self).call(name, options)
+      @completion = options[:completion]
+    end
+    # def initialize(name, options = {})
+    #   old_initialize
+    # end
+
+    class << self
+      def completion(completion)
+        @completion = completion
+      end
+    end
+  end
+end

data/lib/fylla/completion_generator.rb

@@ -1,3 +1,4 @@
+require_relative 'parsed_option'
 require_relative 'parsed_command'
 require_relative 'parsed_subcommand'
 require 'erb'
@@ -23,13 +24,11 @@ module Fylla
         #   the name of the executable to generate the script for
         def zsh_completion(executable_name)
           @executable_name = executable_name
-          command = create_command_map commands, subcommand_classes
+          command = create_command_map all_commands, subcommand_classes
 
-          help = create_completion_string(read_template(:zsh, :help), binding)
           builder = map_to_completion_string [command]
           completion = "#compdef _#{executable_name} #{executable_name}\n"
           completion += builder
-          completion += help
           completion
         end
 
@@ -41,13 +40,11 @@ module Fylla
         #   the name of the executable to generate the script for
         def bash_completion(executable_name)
           @executable_name = executable_name
-          command = create_command_map commands, subcommand_classes
+          command = create_command_map all_commands, subcommand_classes
 
-          help = create_completion_string(read_template(:bash, :help), binding)
           builder = map_to_completion_string [command], style: :bash
           completion = ''
           completion += builder
-          completion += help
           completion += "complete -F _#{executable_name} #{executable_name}\n"
           completion
         end
@@ -125,11 +122,12 @@ module Fylla
         # @param subcommand_map [Hash<String, Class < Thor>]
         #   a map indicating the subcommands and their respective classes
         def recursively_find_commands(command_map, subcommand_map)
-          map = Hash[command_map.map { |k, v| [v, subcommand_map[k]] }]
+          map = Hash[command_map.map {|k, v| [v, subcommand_map[k]]}]
           map.map do |command, subcommand_class|
             if subcommand_class.nil?
               ancestor_name = command.ancestor_name if command.respond_to? :ancestor_name
-              ParsedCommand.new(ancestor_name, command.description, command.name, command.options.values)
+              options = parse_options(command.options.values)
+              ParsedCommand.new(ancestor_name, command.description, command.name, options)
             else
               commands = recursively_find_commands subcommand_class.commands, subcommand_class.subcommand_classes
               ParsedSubcommand.new(command.name, command.description, commands, subcommand_class.class_options.values)
@@ -163,7 +161,7 @@ module Fylla
         # from a file and return it as a [String]
         #
         # @param name [Symbol] type of template to retrieve
-        #   can be either :help, :subcommand, or :command
+        #   can be either :subcommand or :command
         # @param style [Symbol] style of template to retrieve
         #   can be either :zsh or :bash
         # @return [String] template string retrieved from erb file
@@ -173,6 +171,13 @@ module Fylla
           erb_path = "erb_templates/#{style}/#{name}.erb"
           File.read(File.join(__dir__, erb_path))
         end
+
+        def parse_options(options)
+          options.map do |opt|
+            description = opt.completion || opt.description || opt.banner
+            ParsedOption.new(opt.name, description, opt.aliases)
+          end
+        end
       end
     end
   end

data/lib/fylla/erb_templates/bash/command.erb

@@ -1,5 +1,14 @@
 _<%= @executable_name %><%= context_name %> ()
 {
   local cur="${COMP_WORDS[COMP_CWORD]}"
-  COMPREPLY=($(compgen -W "<%= command.options.map(&:switch_name).join(" ") %> --help -h" -- "$cur"))
+  local options=()
+  <%- command.options.each do |opt| -%>
+    options+=("--<%= opt.name %>")
+    <%- opt.aliases.each do |a| -%>
+    options+=("-<%= a %>")
+    <%- end -%>
+  <%- end -%>
+  options+=("--help")
+  options+=("-h")
+  COMPREPLY=($(compgen -W "${options[*]}" -- "$cur"))
 }

data/lib/fylla/erb_templates/zsh/command.erb

@@ -2,8 +2,10 @@ function _<%= @executable_name %><%= context_name %> {
   _arguments \
   <%- unless command.options.nil? -%>
     <%- command.options.each do |option| -%>
-      "-<%= option.name%>=[<%= option.banner %>]"
-      "-<%= option.aliases[0]%>=[<%= option.banner %>]"
+    "--<%= option.name%>=[<%= option.description %>]" \
+    <%- option.aliases.each do |al| -%>
+    "-<%= al %>=[<%= option.description %>]" \
+    <%- end -%>
     <%- end -%>
   <%- end -%>
     "-h[Show help information]" \

data/lib/fylla/erb_templates/zsh/subcommand.erb

@@ -5,7 +5,7 @@ function _<%= @executable_name %><%= context_name %> {
     local -a commands
     commands=(
     <%-# remove newlines and leading space on this loop -%>
-    <%- command.commands.each do |command| -%>
+    <%- command.commands.sort_by(&:name).each do |command| -%>
       '<%= command.name %>:<%= command.description %>'
     <%- end -%>
     )
@@ -16,9 +16,9 @@ function _<%= @executable_name %><%= context_name %> {
   <%- unless class_options.nil? -%>
     <%- class_options.each do |option| -%>
       <%- option.aliases.each do |al| -%>
-        "-<%= al %>=[<%= option.banner %>]"
+        "-<%= al %>=[<%= option.description %>]" \
       <%- end -%>
-      "--<%= option.name%>=[<%= option.banner %>]"
+      "--<%= option.name%>=[<%= option.description %>]" \
     <%- end -%>
   <%- end -%>
     "-h[Show help information]" \
@@ -26,7 +26,7 @@ function _<%= @executable_name %><%= context_name %> {
     "1: :_commands" \
     "*::arg:->args"/.
   case $line[1] in
-  <%- command.commands.each do |command| -%>
+  <%- command.commands.sort_by(&:name).each do |command| -%>
     <%= command.name %>)
     _<%= @executable_name %><%= context_name %>_<%= command.name %>
     ;;

data/lib/fylla/parsed_option.rb

@@ -0,0 +1,11 @@
+module Fylla
+  class ParsedOption
+    attr_accessor :aliases, :description, :name
+
+    def initialize(name, description, aliases)
+      @name = name
+      @description = description
+      @aliases = aliases
+    end
+  end
+end

data/lib/fylla/version.rb

@@ -1,3 +1,3 @@
 module Fylla
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/fylla.rb

@@ -2,6 +2,7 @@ require 'fylla/version'
 require 'fylla/completion_generator'
 require 'fylla/parsed_command'
 require 'fylla/parsed_subcommand'
+require 'fylla/completion_extension'
 require 'thor'
 
 #
@@ -12,12 +13,16 @@ module Fylla
   #
   # this method initializes [Fylla]
   # Call this _before_ #Thor.start is called.
+  # @param executable_name [String] name of your thor executable, must be provided
+  # here or through #self.zsh_completion or #self.bash_completion
   def self.load(executable_name = nil)
     @executable_name = executable_name || nil
     ::Thor.prepend Fylla::Thor::CompletionGenerator
+    # ::Thor::Option.prepend Fylla::Thor::Option
   end
 
   #
+  # Method to generate bash completions for the current [Thor] application
   # @param binding [Binding] _must always be self_
   # @param executable_name [String] name of your thor executable,
   #   must either be provided through #self.load or here.
@@ -27,6 +32,7 @@ module Fylla
   end
 
   #
+  # Method to generate bash completions for the current [Thor] application
   # @param binding [Binding] _must always be self_
   # @param executable_name [String] name of your thor executable,
   #   must either be provided through #self.load or here.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fylla
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Thrailkill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,14 +110,14 @@ files:
 - exe/fylla
 - fylla.gemspec
 - lib/fylla.rb
+- lib/fylla/completion_extension.rb
 - lib/fylla/completion_generator.rb
 - lib/fylla/erb_templates/bash/command.erb
-- lib/fylla/erb_templates/bash/help.erb
 - lib/fylla/erb_templates/bash/subcommand.erb
 - lib/fylla/erb_templates/zsh/command.erb
-- lib/fylla/erb_templates/zsh/help.erb
 - lib/fylla/erb_templates/zsh/subcommand.erb
 - lib/fylla/parsed_command.rb
+- lib/fylla/parsed_option.rb
 - lib/fylla/parsed_subcommand.rb
 - lib/fylla/version.rb
 homepage: https://github.com/snowe2010/fylla
@@ -125,6 +125,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
+  changelog_uri: https://github.com/snowe2010/fylla/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/fylla/erb_templates/zsh/help.erb

@@ -1,19 +0,0 @@
-function _<%= @executable_name %>_help {
-  <%- unless command.commands.empty? %>
-    function _commands {
-    local -a commands
-    commands=(
-    <%-# remove newlines and leading space on this loop -%>
-    <%- command.commands.each do |command| -%>
-      '<%= command.name %>:<%= command.description %>'
-    <%- end -%>
-    )
-    _describe 'command' commands
-    }
-  <%- end %>
-  _arguments \
-    "-h[Show help information]" \
-    "--help[Show help information]" \
-    "1: :_commands" \
-    "*::arg:->args"/.
-}