fylla 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99136984f7eb5a2b198e68ee41681aff9bfa3c97
+  data.tar.gz: 2396f92bc99adcba4049207a0c6f19977c76fa4a
+SHA512:
+  metadata.gz: 3cc21ab97adc324024605fbab5ffb62c3cae1b4e4d90eb2308cbed9d4a025e1c3b31fc943e88b07e133cea46697477acc13936ab67da26110295a3faf490d4b1
+  data.tar.gz: 654490096828d6a4416533dd07088e783a4e1c9703104b48db939f84598d35d9ecd88d4c86047e8d7ca074125260c914244cbb23472c5e439562e5e7ced3f9da

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Fylla.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tyler Thrailkill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fylla'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/fylla

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'fylla'

data/fylla.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fylla/version'
+
+# rubocop:disable BlockLength
+Gem::Specification.new do |spec|
+  spec.name = 'fylla'
+  spec.version = Fylla::VERSION
+  spec.authors = ['Tyler Thrailkill']
+  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.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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(.idea|test|spec|features)/|^[.][a-zA-Z0-9]|^.*[.]md|Gemfile.lock})
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  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

@@ -0,0 +1,158 @@
+require_relative 'parsed_command'
+require_relative 'parsed_subcommand'
+require 'erb'
+
+module Fylla
+  module Thor
+    #
+    # module for prepending into +Thor+
+    # inserts methods into Thor that allow generating completion scripts
+    module CompletionGenerator
+      def self.prepended(base)
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      #
+      # Contains the methods +zsh_completion+
+      module ClassMethods
+        #
+        # Generates a zsh _[executable_name] completion
+        # script for the entire Thor application
+        #
+        # @param executable_name [String]
+        #   the name of the executable to generate the script for
+        def zsh_completion(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
+          completion = "#compdef _#{executable_name} #{executable_name}\n"
+          completion += builder
+          completion += help
+          completion
+        end
+
+        private
+
+        # Takes a list of [ParsedCommand]s and [ParsedSubcommand]s
+        # and converts them into completion strings, to be combined
+        # together into one completion script
+        #
+        # @param style [Symbol] style of completions to generate
+        #   defaults to :zsh
+        # @param commands [List<Thor::Command>]
+        #   list of [Thor::Command]s
+        # @param context [String] the current command context
+        #   this is essentially a breadcrumb of our current
+        #   command path:
+        #     e.g. "exe sub1 sub2 sub3 --help" maps to a context of
+        #          "_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)
+          builder = ''
+          commands.each do |command|
+            context_name = generate_context_name(context, command)
+            result = generate_completion_string(command, class_options, context_name, executable_name, style)
+            builder += result
+          end
+          builder
+        end
+
+        # Generate a context name based off of
+        # the current context and the current command
+        #
+        # @param context [String] the current context
+        # @param command [Thor::Command]
+        #   current command we are generating documentation for
+        def generate_context_name(context, command)
+          command_name = if command.name.nil? || command.name.empty?
+                           ''
+                         else
+                           "_#{command.name}"
+                         end
+          "#{context}#{command_name}"
+        end
+
+        def generate_completion_string(command, class_options, context_name, executable_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 += create_completion_string(read_template(style, :subcommand), binding)
+          else
+            builder += create_completion_string(read_template(style, :command), binding)
+          end
+          builder
+        end
+
+        # Recursively generate a command map based off
+        # of the commands and subcommands passed in.
+        #
+        # The [command_map] is a map of [String]s to [Thor::Command] objects,
+        # while the [subcommand_map] is a map of [String]s to [Thor] classes,
+        # usually your own CLI classes that subclass [Thor]
+        #
+        # @param command_map [Hash<String, Thor::Command>]
+        #   a map to recursively generate a completion layout
+        # @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.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)
+            else
+              commands = recursively_find_commands subcommand_class.commands, subcommand_class.subcommand_classes
+              ParsedSubcommand.new(command.name, command.description, commands, subcommand_class.class_options.values)
+            end
+          end
+        end
+
+        # Top level method to begin the recursive map generation
+        # This is needed because we don't have a 'top' level
+        # command to wrap everything under.
+        #
+        # This simplifies the rest of the code.
+        #
+        # (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, [])
+        end
+
+        # Helper method to load an [ERB] template
+        # and generate the corresponding [String]
+        #
+        # @param template [String] an ERB template
+        # @param bind [Binding] a binding to a context
+        def create_completion_string(template, bind)
+          template = ERB.new(template, nil, '-<>')
+          template.result(bind)
+        end
+
+        # Helper method to read an [ERB] template
+        # from a file and return it as a [String]
+        #
+        # @param name [Symbol] type of template to retrieve
+        #   can be either :help, :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
+        def read_template(style, name)
+          style = style.is_a?(Symbol) ? style.to_s : style
+          name = name.is_a?(Symbol) ? name.to_s : name
+          erb_path = "erb_templates/#{style}/#{name}.erb"
+          File.read(File.join(__dir__, erb_path))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+function _<%= executable_name %><%= context_name %> {
+  _arguments \
+  <%- unless command.options.nil? -%>
+    <%- command.options.each do |option| -%>
+      "-<%= option.name%>=[<%= option.banner %>]"
+      "-<%= option.aliases[0]%>=[<%= option.banner %>]"
+    <%- end -%>
+  <%- end -%>
+    "-h[Show help information]" \
+    "--help[Show help information]" \
+    "1: :_commands" \
+    "*::arg:->args"/.
+}

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

@@ -0,0 +1,19 @@
+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"/.
+}

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

@@ -0,0 +1,35 @@
+function _<%= executable_name %><%= context_name %> {
+  local line
+  <%- 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 \
+  <%- unless class_options.nil? -%>
+    <%- class_options.each do |option| -%>
+      <%- option.aliases.each do |al| -%>
+        "-<%= al %>=[<%= option.banner %>]"
+      <%- end -%>
+      "--<%= option.name%>=[<%= option.banner %>]"
+    <%- end -%>
+  <%- end -%>
+    "-h[Show help information]" \
+    "--help[Show help information]" \
+    "1: :_commands" \
+    "*::arg:->args"/.
+  case $line[1] in
+  <%- command.commands.each do |command| -%>
+    <%= command.name %>)
+    _<%= executable_name %><%= context_name %>_<%= command.name %>
+    ;;
+  <%- end -%>
+  esac
+}

data/lib/fylla/parsed_command.rb

@@ -0,0 +1,12 @@
+module Fylla
+  class ParsedCommand
+    attr_accessor :ancestor_name, :description, :name, :options
+
+    def initialize(ancestor_name, description, name, options)
+      @ancestor_name = ancestor_name
+      @description = description
+      @name = name
+      @options = options
+    end
+  end
+end

data/lib/fylla/parsed_subcommand.rb

@@ -0,0 +1,12 @@
+module Fylla
+  class ParsedSubcommand
+    attr_accessor :name, :description, :commands, :class_options
+
+    def initialize(name, description, commands, class_options)
+      @name = name
+      @description = description
+      @commands = commands
+      @class_options = class_options
+    end
+  end
+end

data/lib/fylla/version.rb

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

data/lib/fylla.rb

@@ -0,0 +1,20 @@
+require 'fylla/version'
+require 'fylla/completion_generator'
+require 'fylla/parsed_command'
+require 'fylla/parsed_subcommand'
+require 'thor'
+
+#
+# Top level module for the Fylla project.
+# Contains one method for initializing Fylla
+#
+module Fylla
+  def self.load(executable_name = nil)
+    @executable_name = executable_name || nil
+    ::Thor.prepend Fylla::Thor::CompletionGenerator
+  end
+
+  def self.zsh_completion(binding, executable_name = @executable_name)
+    binding.class.zsh_completion(executable_name)
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: fylla
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Thrailkill
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+description: "\n  Fylla generates zsh and bash autocomplete scripts for Thor CLI applications.\n
+  \ "
+email:
+- tyler.b.thrailkill@gmail.com
+executables:
+- fylla
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fylla
+- fylla.gemspec
+- lib/fylla.rb
+- lib/fylla/completion_generator.rb
+- 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_subcommand.rb
+- lib/fylla/version.rb
+homepage: https://github.com/snowe2010/fylla
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Adds functions for generating autocomplete scripts for Thor applications
+test_files: []