dry-cli 0.7.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfd9b78000e6f3ecef16d4eee260eee84bb4661251966e367e4f9a2001d3dac
-  data.tar.gz: df37074af2d1ed387d24ab90ed37920247cc40dc4c508c1325f08e9cb395c277
+  metadata.gz: 3bb38a55577b2607724ceaafe32979ca39b83b62ece8d5e734f522646042d2f5
+  data.tar.gz: 05e3fe644ca5fceb2bd3dc740453faf8aab28faaf7ad5ae9ab39a23474f7f611
 SHA512:
-  metadata.gz: c2b0035c9df7cbe7cf01fabd69a0207aaab945a13debf8b4a1441d764853343ac2a2dd1264c395aeda3296957870fcdcd87fa44041f6948d490afde897f2d837
-  data.tar.gz: c74d981d7c23200a652f75013977a9ea3b720c1264e184fd93af83fcb33995ec00c6284021a7e29b3ea215e9ac5c51aaccbf2ff03c821f215aa52d433bf1fd62
+  metadata.gz: 97ff398081901a642d1d8d898a50eec46e33103defff2e4c77f11a0e5150dcb79fc7e568cbeaaeaa7e6af9f0e05835b265a2ceb7fda144f4983b8dfc27363728
+  data.tar.gz: 39b43443b842724a7096a909bba93dd93ceda1c470a2cfc2ec9ac9e02f2aee0b449f2dd6c2b7bf9c0c92485ad404a14ba1a352518d5070366535bbc19d5cb789

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 1.1.0 2024-07-14
+
+
+### Added
+
+- Added `:flag` option type. This acts like a `:boolean` that can only be set to true, so has no `--no-` prefix to disable it. (@Billiam in #117)
+
+
+[Compare v1.0.0...v1.1.0](https://github.com/dry-rb/dry-cli/compare/v1.0.0...v1.1.0)
+
+## 1.0.0 2022-11-05
+
+
+### Changed
+
+- Version bumped to 1.0.0 (@solnic)
+
+[Compare v0.7.0...v1.0.0](https://github.com/dry-rb/dry-cli/compare/v0.7.0...v1.0.0)
+
 ## 0.7.0 2020-05-08
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 dry-rb team
+Copyright (c) 2015-2023 dry-rb team
 
 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

data/README.md

@@ -1,28 +1,21 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-cli
 [actions]: https://github.com/dry-rb/dry-cli/actions
-[codacy]: https://www.codacy.com/gh/dry-rb/dry-cli
-[chat]: https://dry-rb.zulipchat.com
-[inchpages]: http://inch-ci.org/github/dry-rb/dry-cli
 
-# dry-cli [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
-
-[![Gem Version](https://badge.fury.io/rb/dry-cli.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-cli/workflows/ci/badge.svg)][actions]
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/61dd5d070fc74f0cacf575b19d4930e1)][codacy]
-[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/61dd5d070fc74f0cacf575b19d4930e1)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-cli.svg?branch=master)][inchpages]
+# dry-cli [![Gem Version](https://badge.fury.io/rb/dry-cli.svg)][gem] [![CI Status](https://github.com/dry-rb/dry-cli/workflows/ci/badge.svg)][actions]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-cli)
+* [User documentation](https://dry-rb.org/gems/dry-cli)
 * [API documentation](http://rubydoc.info/gems/dry-cli)
+* [Forum](https://discourse.dry-rb.org)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.5`
-* jruby >= `9.2`
+* MRI `>= 2.4.0`
+* jruby `>= 9.4` (not tested on CI)
 
 ## License
 

data/dry-cli.gemspec

@@ -1,33 +1,35 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/cli/version'
+require "dry/cli/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-cli'
+  spec.name          = "dry-cli"
   spec.authors       = ["Luca Guidi"]
   spec.email         = ["me@lucaguidi.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::CLI::VERSION.dup
 
   spec.summary       = "Common framework to build command line interfaces with Ruby"
   spec.description   = spec.summary
-  spec.homepage      = 'https://dry-rb.org/gems/dry-cli'
+  spec.homepage      = "https://dry-rb.org/gems/dry-cli"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-cli.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-cli/blob/master/CHANGELOG.md'
-  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-cli'
-  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-cli/issues'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-cli/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-cli"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-cli/issues"
 
   spec.required_ruby_version = ">= 2.4.0"
 
   # to update dependencies edit project.yml
+
   spec.add_development_dependency "bundler", ">= 1.6", "< 3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.7"

data/lib/dry/cli/banner.rb

@@ -86,8 +86,8 @@ module Dry
         required_arguments = command.required_arguments
         optional_arguments = command.optional_arguments
 
-        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any? # rubocop:disable Metrics/LineLength
-        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Metrics/LineLength
+        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any? # rubocop:disable Layout/LineLength
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Layout/LineLength
         result = [required, optional].compact
 
         " #{result.join(" ")}" unless result.empty?
@@ -97,7 +97,7 @@ module Dry
       # @api private
       def self.extended_command_arguments(command)
         command.arguments.map do |argument|
-          "  #{argument.name.to_s.upcase.ljust(32)}  # #{"REQUIRED " if argument.required?}#{argument.desc}" # rubocop:disable Metrics/LineLength
+          "  #{argument.name.to_s.upcase.ljust(32)}  # #{"REQUIRED " if argument.required?}#{argument.desc}" # rubocop:disable Layout/LineLength
         end.join("\n")
       end
 
@@ -109,6 +109,8 @@ module Dry
           name = Inflector.dasherize(option.name)
           name = if option.boolean?
                    "[no-]#{name}"
+                 elsif option.flag?
+                   name
                  elsif option.array?
                    "#{name}=VALUE1,VALUE2,.."
                  else

data/lib/dry/cli/command.rb

@@ -45,11 +45,7 @@ module Dry
 
         # @since 0.7.0
         # @api private
-        attr_reader :subcommands
-
-        # @since 0.7.0
-        # @api private
-        attr_writer :subcommands
+        attr_accessor :subcommands
       end
 
       # Set the description of the command
@@ -213,7 +209,7 @@ module Dry
       #   require "dry/cli"
       #
       #   class Console < Dry::CLI::Command
-      #     param :engine
+      #     option :engine
       #
       #     def call(engine: nil, **)
       #       puts "starting console (engine: #{engine || :irb})"
@@ -230,7 +226,7 @@ module Dry
       #   require "dry/cli"
       #
       #   class Console < Dry::CLI::Command
-      #     param :engine, values: %w(irb pry ripl)
+      #     option :engine, values: %w(irb pry ripl)
       #
       #     def call(engine: nil, **)
       #       puts "starting console (engine: #{engine || :irb})"
@@ -250,7 +246,7 @@ module Dry
       #   require "dry/cli"
       #
       #   class Console < Dry::CLI::Command
-      #     param :engine, desc: "Force a console engine"
+      #     option :engine, desc: "Force a console engine"
       #
       #     def call(engine: nil, **)
       #       # ...
@@ -268,7 +264,7 @@ module Dry
       #   require "dry/cli"
       #
       #   class Server < Dry::CLI::Command
-      #     param :code_reloading, type: :boolean, default: true
+      #     option :code_reloading, type: :boolean, default: true
       #
       #     def call(code_reloading:, **)
       #       puts "staring server (code reloading: #{code_reloading})"
@@ -291,7 +287,7 @@ module Dry
       #   require "dry/cli"
       #
       #   class Server < Dry::CLI::Command
-      #     param :port, aliases: ["-p"]
+      #     option :port, aliases: ["-p"]
       #
       #     def call(options)
       #       puts "staring server (port: #{options.fetch(:port, 2300)})"

data/lib/dry/cli/command_registry.rb

@@ -37,7 +37,7 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      #
+      # rubocop:disable Metrics/AbcSize
       def get(arguments)
         @_mutex.synchronize do
           node   = @root
@@ -56,7 +56,7 @@ module Dry
               result = LookupResult.new(node, args, names, false)
               break
             elsif tmp.leaf?
-              args   = arguments[i + 1..-1]
+              args   = arguments[i + 1..]
               names  = arguments[0..i]
               node   = tmp
               result = LookupResult.new(node, args, names, true)
@@ -72,6 +72,7 @@ module Dry
           result
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Node of the registry
       #

data/lib/dry/cli/option.rb

@@ -59,6 +59,11 @@ module Dry
         type == :boolean
       end
 
+      # @api private
+      def flag?
+        type == :flag
+      end
+
       # @since 0.3.0
       # @api private
       def array?
@@ -92,6 +97,8 @@ module Dry
 
         if boolean?
           parser_options << "--[no-]#{dasherized_name}"
+        elsif flag?
+          parser_options << "--#{dasherized_name}"
         else
           parser_options << "--#{dasherized_name}=#{name}"
           parser_options << "--#{dasherized_name} #{name}"
@@ -112,7 +119,7 @@ module Dry
           .compact
           .uniq
           .map { |name| name.size == 1 ? "-#{name}" : "--#{name}" }
-          .map { |name| boolean? ? name : "#{name} VALUE" }
+          .map { |name| boolean? || flag? ? name : "#{name} VALUE" }
       end
     end
 

data/lib/dry/cli/parser.rb

@@ -32,24 +32,24 @@ module Dry
         parsed_options = command.default_params.merge(parsed_options)
         parse_required_params(command, arguments, prog_name, parsed_options)
       rescue ::OptionParser::ParseError
-        Result.failure("ERROR: \"#{prog_name}\" was called with arguments \"#{original_arguments.join(" ")}\"") # rubocop:disable Metrics/LineLength
+        Result.failure("ERROR: \"#{prog_name}\" was called with arguments \"#{original_arguments.join(" ")}\"") # rubocop:disable Layout/LineLength
       end
 
       # @since 0.1.0
       # @api private
       #
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
       def self.parse_required_params(command, arguments, prog_name, parsed_options)
         parsed_params          = match_arguments(command.arguments, arguments)
         parsed_required_params = match_arguments(command.required_arguments, arguments)
-        all_required_params_satisfied = command.required_arguments.all? { |param| !parsed_required_params[param.name].nil? } # rubocop:disable Metrics/LineLength
+        all_required_params_satisfied = command.required_arguments.all? { |param| !parsed_required_params[param.name].nil? } # rubocop:disable Layout/LineLength
 
         unused_arguments = arguments.drop(command.required_arguments.length)
 
         unless all_required_params_satisfied
           parsed_required_params_values = parsed_required_params.values.compact
 
-          usage = "\nUsage: \"#{prog_name} #{command.required_arguments.map(&:description_name).join(" ")}" # rubocop:disable Metrics/LineLength
+          usage = "\nUsage: \"#{prog_name} #{command.required_arguments.map(&:description_name).join(" ")}" # rubocop:disable Layout/LineLength
 
           usage += " | #{prog_name} SUBCOMMAND" if command.subcommands.any?
 
@@ -58,7 +58,7 @@ module Dry
           if parsed_required_params_values.empty?
             return Result.failure("ERROR: \"#{prog_name}\" was called with no arguments#{usage}")
           else
-            return Result.failure("ERROR: \"#{prog_name}\" was called with arguments #{parsed_required_params_values}#{usage}") # rubocop:disable Metrics/LineLength
+            return Result.failure("ERROR: \"#{prog_name}\" was called with arguments #{parsed_required_params_values}#{usage}") # rubocop:disable Layout/LineLength
           end
         end
 
@@ -67,14 +67,14 @@ module Dry
         parsed_options = parsed_options.merge(args: unused_arguments) if unused_arguments.any?
         Result.success(parsed_options)
       end
-      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
 
       def self.match_arguments(command_arguments, arguments)
         result = {}
 
         command_arguments.each_with_index do |cmd_arg, index|
           if cmd_arg.array?
-            result[cmd_arg.name] = arguments[index..-1]
+            result[cmd_arg.name] = arguments[index..]
             break
           else
             result[cmd_arg.name] = arguments.at(index)

data/lib/dry/cli/usage.rb

@@ -55,8 +55,8 @@ module Dry
         required_arguments = command.required_arguments
         optional_arguments = command.optional_arguments
 
-        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any? # rubocop:disable Metrics/LineLength
-        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Metrics/LineLength
+        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any? # rubocop:disable Layout/LineLength
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Layout/LineLength
         result = [required, optional].compact
 
         " #{result.join(" ")}" unless result.empty?

data/lib/dry/cli/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class CLI
     # @since 0.1.0
-    VERSION = "0.7.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2024-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,7 +115,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-cli/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-cli/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-cli
   bug_tracker_uri: https://github.com/dry-rb/dry-cli/issues
 post_install_message: 
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Common framework to build command line interfaces with Ruby