fylla 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e4ab52af2d12b3d0078c3c0451da1a28c0e795c06b9e9867f6188e849c304a
-  data.tar.gz: 8267d2624d22df38cdce36e8b9f245458ec43b6659634e02a5970eaa099fef21
+  metadata.gz: b5a3cc1382f79579d5a8130fbca473d8d056b6b212ed8c8e7968018ec65b7bfe
+  data.tar.gz: a4450072bcfd5092e69b1fe5c655c31cdd6cab163179dcc024baa855bee43494
 SHA512:
-  metadata.gz: 0ff83b9fcc93795be5fc9feadc6dc4cc04cf3fbc178a6430a7f2602e2363d7d0ab5961430f78da4bad91957846690b648638e317ac019f272e5d184272a79971
-  data.tar.gz: f92146028038df7a651eb82579bc5dc437032fb554e1518290cc2f9c40319fd43fa8204bb914b0e4c8bbf0c9c46db09dc9e7da28c8a444e465b4d4b998b0061b
+  metadata.gz: fceea452d546e94729260a6bfd843acd6765214241d1ab2722955b3c6ede8f4a2976041083142dfc54deda0d82da49c38ae14771cd5238a3dd3131ad761b2a84
+  data.tar.gz: 6583452e70354478fd75377855302a78b9147e926cd6b8a6f39e0bcac7747c4cd79c73ddffa8916dbb7d332147d6cf645e03cd012723f3d47ecfa435ed352d0f

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in Fylla.gemspec
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in foodie.gemspec
 gemspec

data/Rakefile

@@ -1,10 +1,16 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+# frozen_string_literal: true
+
+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']
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'fylla'
+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.
@@ -10,5 +10,5 @@ require 'fylla'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/exe/fylla

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

data/fylla.gemspec

@@ -1,21 +1,20 @@
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fylla/version'
+require "fylla/version"
 
-# rubocop:disable BlockLength
 Gem::Specification.new do |spec|
-  spec.name = 'fylla'
+  spec.name = "fylla"
   spec.version = Fylla::VERSION
-  spec.authors = ['Tyler Thrailkill']
-  spec.email = ['tyler.b.thrailkill@gmail.com']
+  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.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'] = 'https://github.com/snowe2010/fylla/blob/master/CHANGELOG.md'
+  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,15 +24,17 @@ Gem::Specification.new do |spec|
     end
   end
 
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
-  spec.require_paths = ['lib']
+  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 '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_dependency 'thor', '>= 0.19.0'
+  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", "~> 13"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-minitest", "~> 0.27.0"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
+  spec.add_dependency "thor", ">= 0.19.0"
 end
-# rubocop:enable BlockLength

data/lib/fylla/completion_extension.rb

@@ -1,4 +1,4 @@
-require 'thor'
+require "thor"
 
 # add more options to Thor::Option
 #
@@ -8,6 +8,7 @@ module Fylla
   module Thor
     module Option
       attr_accessor :completion, :filter
+
       def initialize(name, options = {})
         @completion = options[:fylla]&.[](:completion)
         @filter = options[:fylla]&.[](:filter)

data/lib/fylla/completion_generator.rb

@@ -1,7 +1,7 @@
-require_relative 'parsed_option'
-require_relative 'parsed_command'
-require_relative 'parsed_subcommand'
-require 'erb'
+require_relative "parsed_option"
+require_relative "parsed_command"
+require_relative "parsed_subcommand"
+require "erb"
 
 module Fylla
   module Thor
@@ -29,7 +29,7 @@ module Fylla
           builder = map_to_completion_string [command]
           completion = "#compdef _#{executable_name} #{executable_name}\n"
           completion += builder
-          completion += %Q(_#{executable_name} "$@")
+          completion += %(_#{executable_name} "$@")
           completion
         end
 
@@ -44,7 +44,7 @@ module Fylla
           command = create_command_map all_commands, subcommand_classes
 
           builder = map_to_completion_string [command], style: :bash
-          completion = ''
+          completion = ""
           completion += builder
           completion += "complete -F _#{executable_name} #{executable_name}\n"
           completion
@@ -68,10 +68,10 @@ module Fylla
         # @param class_options [List<Thor::Option>]
         #   a list of global or class level options for the current context
         def map_to_completion_string(commands,
-                                     context: '',
+                                     context: "",
                                      class_options: [],
                                      style: :zsh)
-          builder = ''
+          builder = ""
           commands.each do |command|
             context_name = generate_context_name(context, command)
             result = generate_completion_string(command, class_options, context_name, style)
@@ -88,7 +88,7 @@ module Fylla
         #   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
@@ -96,7 +96,7 @@ module Fylla
         end
 
         def generate_completion_string(command, class_options, context_name, style)
-          builder = ''
+          builder = ""
           if command.is_a? ParsedSubcommand
             class_options = parse_options((class_options + command.class_options).uniq)
             builder += map_to_completion_string(command.commands,
@@ -123,15 +123,17 @@ 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
               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)
+              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
@@ -145,7 +147,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, class_options.values)
+          ParsedSubcommand.new(nil, "", command_map, class_options.values)
         end
 
         # Helper method to load an [ERB] template
@@ -154,7 +156,7 @@ module Fylla
         # @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 = ERB.new(template, trim_mode: "-<>")
           template.result(bind)
         end
 
@@ -176,7 +178,7 @@ module Fylla
         def parse_options(options)
           options.map do |opt|
             description = opt.completion || opt.description || opt.banner || opt.name.to_s.upcase
-            ParsedOption.new(opt.name, description, opt.aliases, opt.enum, opt.filter)
+            ParsedOption.new(opt.name, description, opt.aliases, opt.enum, opt.filter, opt.type)
           end
         end
       end

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

@@ -2,21 +2,10 @@ function _<%= @executable_name %><%= context_name %> {
   _arguments \
   <%- unless command.options.nil? -%>
     <%- command.options.each do |option| -%>
-      <%- enums_exist = option.enum -%>
-      <%- filtered = option.filter -%>
       <%- desc = option.description.gsub('"', %q|\\"|) -%>
-      <%- if enums_exist -%>
-        <%- if filtered -%>
-        <%- actions = ": :_values -s , 'options' #{option.enum.join(' ')}" -%>
-        <%- else -%>
-        <%- actions = ": :_sequence -d compadd - #{option.enum.join(' ')}" -%>
-        <%- end -%>
-    "--<%= option.name %>=[<%= desc %>]<%= actions %>" \
-      <%- else -%>
-    "--<%= option.name %>[<%= desc %>]" \
-      <%- end -%>
+    "--<%= option.name %><%= option.equals_type %>[<%= desc %>]<%= option.action %>" \
       <%- option.aliases.each do |al| -%>
-    "-<%= al %><%= option.enum ? '=' : '' %>[<%= desc %>]<%= option.enum ? actions : '' %>" \
+    "-<%= al %><%= option.equals_type %>[<%= desc %>]<%= option.action %>" \
       <%- end -%>
     <%- end -%>
   <%- end -%>

data/lib/fylla/parsed_option.rb

@@ -1,14 +1,29 @@
 module Fylla
   class ParsedOption
-    attr_accessor :aliases, :description, :name, :enum, :filter
-    attr_reader :completion, :banner # used just for parsing class_options recursively. Don't ever set these.
+    attr_accessor :aliases, :description, :name
+    # used just for parsing class_options recursively. Don't ever set these.
+    # used for erb file action
+    attr_reader :completion, :banner, :enum, :filter, :type, :action, :equals_type
 
-    def initialize(name, description, aliases, enum, filter)
+    def initialize(name, description, aliases, enum, filter, type)
       @name = name
       @description = description
       @aliases = aliases
-      @enum = enum || nil
-      @filter = filter
+      # used for switches that take values (everything, but not necessary for boolean)
+      @equals_type = type == :boolean ? "" : "="
+      @action = ""
+      return unless enum
+
+      case type
+      when :array
+        @action = if filter
+                    %(: :_values -s , 'options' #{enum.join(" ")})
+                  else
+                    %(: :_sequence -d compadd - #{enum.join(" ")})
+                  end
+      when :string
+        @action = %|: :(#{enum.join(" ")})|
+      end
     end
   end
 end

data/lib/fylla/thor/extensions/comma_array_extension.rb

@@ -1,4 +1,4 @@
-require 'thor'
+require "thor"
 
 # Modify how Thor parses array arguments to be POSIX standard per
 # getopt_long(3)
@@ -6,8 +6,9 @@ require 'thor'
 module Fylla
   module Thor
     module Arguments
-      def parse_array(name)
+      def parse_array(_name)
         return shift if peek.is_a?(Array)
+
         array = []
         if peek.include? ","
           array.push(*shift.split(","))
@@ -18,4 +19,4 @@ module Fylla
       end
     end
   end
-end
+end

data/lib/fylla/version.rb

@@ -1,3 +1,3 @@
 module Fylla
-  VERSION = '0.5.0'.freeze
+  VERSION = "0.5.2".freeze
 end

data/lib/fylla.rb

@@ -1,10 +1,10 @@
-require 'fylla/version'
-require 'fylla/completion_generator'
-require 'fylla/parsed_command'
-require 'fylla/parsed_subcommand'
-require 'fylla/completion_extension'
-require 'fylla/thor/extensions/comma_array_extension'
-require 'thor'
+require "fylla/version"
+require "fylla/completion_generator"
+require "fylla/parsed_command"
+require "fylla/parsed_subcommand"
+require "fylla/completion_extension"
+require "fylla/thor/extensions/comma_array_extension"
+require "thor"
 
 # We _must prepend before thor loads_ Ideally this is at require time...
 ::Thor::Option.prepend Fylla::Thor::Option

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fylla
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Tyler Thrailkill
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +169,7 @@ licenses:
 metadata:
   yard.run: yri
   changelog_uri: https://github.com/snowe2010/fylla/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,9 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Adds functions for generating autocomplete scripts for Thor applications
 test_files: []