fylla 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99136984f7eb5a2b198e68ee41681aff9bfa3c97
-  data.tar.gz: 2396f92bc99adcba4049207a0c6f19977c76fa4a
+  metadata.gz: e9146ead4c4c7a8a7d72096188734b6f439ffff2
+  data.tar.gz: 5533724b62e9c629c99d62f68eb7cf2c55b4dadd
 SHA512:
-  metadata.gz: 3cc21ab97adc324024605fbab5ffb62c3cae1b4e4d90eb2308cbed9d4a025e1c3b31fc943e88b07e133cea46697477acc13936ab67da26110295a3faf490d4b1
-  data.tar.gz: 654490096828d6a4416533dd07088e783a4e1c9703104b48db939f84598d35d9ecd88d4c86047e8d7ca074125260c914244cbb23472c5e439562e5e7ced3f9da
+  metadata.gz: ca9a24cb0a6829f9b0c814892c80684eed43a31c9d5d6c64b9d15b031aaa27850a8a53a0143b6da439f4d49b4a18cb6a9e7512272c088fa352a49659fb55a912
+  data.tar.gz: 737af6d0958eb919b9a8e9d2ec6dfb6e57fea009d337bd66853dee3f7aadbd18365222a4c56a0e93111f8bb5fd99845d22e54a1c95c6d88d0b34ef54892e2a60

data/fylla.gemspec

@@ -10,14 +10,11 @@ Gem::Specification.new do |spec|
   spec.email = ['tyler.b.thrailkill@gmail.com']
 
   spec.summary = 'Adds functions for generating autocomplete scripts for Thor applications'
-  spec.description = '
-  Fylla generates zsh and bash autocomplete scripts for Thor CLI applications.
-  '
+  spec.description = 'Fylla generates zsh and bash autocomplete scripts for Thor CLI applications.'
   spec.homepage = 'https://github.com/snowe2010/fylla'
   spec.license = 'MIT'
 
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
-  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # 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.
@@ -32,10 +29,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'codecov', '~> 0.1.14'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-hooks', '~> 1.5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  # spec.add_development_dependency 'thor', '~> 0.20.3'
   spec.add_dependency 'thor', '>= 0.19.0'
 end
 # rubocop:enable BlockLength

data/lib/fylla/completion_generator.rb

@@ -22,16 +22,36 @@ module Fylla
         # @param executable_name [String]
         #   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
 
           help = create_completion_string(read_template(:zsh, :help), binding)
-          builder = map_to_completion_string [command], executable_name
+          builder = map_to_completion_string [command]
           completion = "#compdef _#{executable_name} #{executable_name}\n"
           completion += builder
           completion += help
           completion
         end
 
+        #
+        # Generates a bash _[executable_name] completion
+        # script for the entire Thor application
+        #
+        # @param executable_name [String]
+        #   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
+
+          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
+
         private
 
         # Takes a list of [ParsedCommand]s and [ParsedSubcommand]s
@@ -49,17 +69,14 @@ module Fylla
         #          "_sub1_sub2_sub3"
         # @param class_options [List<Thor::Option>]
         #   a list of global or class level options for the current context
-        # @param executable_name [String] the executable name, for use in
-        #   method calls and to name the completion script.
         def map_to_completion_string(commands,
-                                     context = '',
-                                     class_options = [],
-                                     executable_name = '',
-                                     style = :zsh)
+                                     context: '',
+                                     class_options: [],
+                                     style: :zsh)
           builder = ''
           commands.each do |command|
             context_name = generate_context_name(context, command)
-            result = generate_completion_string(command, class_options, context_name, executable_name, style)
+            result = generate_completion_string(command, class_options, context_name, style)
             builder += result
           end
           builder
@@ -80,11 +97,15 @@ module Fylla
           "#{context}#{command_name}"
         end
 
-        def generate_completion_string(command, class_options, context_name, executable_name, style)
+        def generate_completion_string(command, class_options, context_name, style)
           builder = ''
           if command.is_a? ParsedSubcommand
             class_options = (class_options + command.class_options).uniq
-            builder += map_to_completion_string(command.commands, context_name, class_options, executable_name)
+            builder += map_to_completion_string(command.commands,
+                                                context: context_name,
+                                                class_options: class_options,
+                                                style: style)
+
             builder += create_completion_string(read_template(style, :subcommand), binding)
           else
             builder += create_completion_string(read_template(style, :command), binding)
@@ -125,7 +146,7 @@ module Fylla
         # (see #recursively_find_commands) for more documentation
         def create_command_map(command_map, subcommand_map)
           command_map = recursively_find_commands command_map, subcommand_map
-          ParsedSubcommand.new(nil, '', command_map, [])
+          ParsedSubcommand.new(nil, '', command_map, class_options.values)
         end
 
         # Helper method to load an [ERB] template

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

@@ -0,0 +1,5 @@
+_<%= @executable_name %><%= context_name %> ()
+{
+  local cur="${COMP_WORDS[COMP_CWORD]}"
+  COMPREPLY=($(compgen -W "<%= command.options.map(&:switch_name).join(" ") %> --help -h" -- "$cur"))
+}

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

@@ -0,0 +1,36 @@
+_<%= @executable_name %><%= context_name %>() {
+  local i=1 subcommand_index
+
+  # find the subcommand
+  while [[ $i -lt $COMP_CWORD ]]; do
+    local s="${COMP_WORDS[i]}"
+    case "$s" in
+    <%= command.name || @executable_name %>)<%# if command.name is empty, then we're at the top level command. therefore we need to use the @executable_name %>
+      subcommand_index=$i
+      break
+      ;;
+    esac
+    (( i++ ))
+  done
+
+  while [[ $subcommand_index -lt $COMP_CWORD ]]; do
+    local s="${COMP_WORDS[subcommand_index]}"
+    case "$s" in
+      <%- unless command.commands.empty? -%>
+        <%- command.commands.each do |command| -%>
+          <%= command.name %>)
+            _<%= @executable_name %><%= context_name %>_<%= command.name %>
+            return ;;
+        <%- end -%>
+      <%- end -%>
+      help)
+        COMPREPLY=""
+        return
+        ;;
+    esac
+    (( subcommand_index++ ))
+  done
+
+  local cur="${COMP_WORDS[COMP_CWORD]}"
+  COMPREPLY=($(compgen -W "<%= command.commands.map(&:name).join(" ") %> <%= command.class_options.map(&:switch_name).join(" ") %>" -- "$cur"))
+}

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

@@ -1,4 +1,4 @@
-function _<%= executable_name %><%= context_name %> {
+function _<%= @executable_name %><%= context_name %> {
   _arguments \
   <%- unless command.options.nil? -%>
     <%- command.options.each do |option| -%>

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

@@ -1,4 +1,4 @@
-function _<%= executable_name %>_help {
+function _<%= @executable_name %>_help {
   <%- unless command.commands.empty? %>
     function _commands {
     local -a commands

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

@@ -1,4 +1,4 @@
-function _<%= executable_name %><%= context_name %> {
+function _<%= @executable_name %><%= context_name %> {
   local line
   <%- unless command.commands.empty? %>
     function _commands {
@@ -28,7 +28,7 @@ function _<%= executable_name %><%= context_name %> {
   case $line[1] in
   <%- command.commands.each do |command| -%>
     <%= command.name %>)
-    _<%= executable_name %><%= context_name %>_<%= command.name %>
+    _<%= @executable_name %><%= context_name %>_<%= command.name %>
     ;;
   <%- end -%>
   esac

data/lib/fylla/version.rb

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

data/lib/fylla.rb

@@ -9,12 +9,29 @@ require 'thor'
 # Contains one method for initializing Fylla
 #
 module Fylla
+  #
+  # this method initializes [Fylla]
+  # Call this _before_ #Thor.start is called.
   def self.load(executable_name = nil)
     @executable_name = executable_name || nil
     ::Thor.prepend Fylla::Thor::CompletionGenerator
   end
 
+  #
+  # @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.
+  # @return [String] containing the entire zsh completion script.
   def self.zsh_completion(binding, executable_name = @executable_name)
     binding.class.zsh_completion(executable_name)
   end
+
+  #
+  # @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.
+  # @return [String] containing the entire bash completion script.
+  def self.bash_completion(binding, executable_name = @executable_name)
+    binding.class.bash_completion(executable_name)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fylla
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Thrailkill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-12 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.14
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.0
-description: "\n  Fylla generates zsh and bash autocomplete scripts for Thor CLI applications.\n
-  \ "
+description: Fylla generates zsh and bash autocomplete scripts for Thor CLI applications.
 email:
 - tyler.b.thrailkill@gmail.com
 executables:
@@ -98,6 +111,9 @@ files:
 - fylla.gemspec
 - lib/fylla.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