clino 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 371a8130998852d6dd08f5abb9d0a64d1c984fd2c0224ab3b9313b88e9e11d27
-  data.tar.gz: 4fbff42de01c1bb8c746882a9670f4928de0c09c7e7d7ba11fb6e0d4e85cc9bc
+  metadata.gz: b5da44c716b390337107099e942d034e182f87d0c201db938ce33edb25afec00
+  data.tar.gz: aab08f2034e3334083e04f85073a7e3762eaa095a64c5514107e3ddb5899a4e9
 SHA512:
-  metadata.gz: 1a7772c11b06cea8b0c1b71aff7f9ed6afd46d9229dbe0b88c328b2c3df214b70a44268c797bee6f7e43a5a12500de8224c91aa0d036fdcf9b95a5372390e75f
-  data.tar.gz: 060acd626f965c30b4ba9af1ee1241e881c44b9c6af692d1ce70cb272d644bd9be0bd54dd67732aded98602c526ce4b31916dbebcddf4b7b9251858dffadb383
+  metadata.gz: b0a9cb88be968997e96874262e24adb6a6d005babec72d6c797ba6871f5f0f1cfc6d76dffd3a2fc05ac4a88d10ab5182d468a80f746dfdfcebc3622122952e09
+  data.tar.gz: 65354f82b88c9bf681233a6e062aa7c83b848f09c6866f1c3dc51ce48352f707d8699834363ca604d69102b291adecd6f9220fe6526e0ff7a8d13801c3079d2e

data/README.md

@@ -6,12 +6,20 @@ It is inspired by the [Thor](https://github.com/rails/thor) and [Typer](https://
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install this gem as a regular gem:
+
+```bash
+gem install clino
+```
+
+or add this line to your application's Gemfile:
 
 ```ruby
 gem 'clino'
 ```
 
+Link: [RubyGems](https://rubygems.org/gems/clino)
+
 ## Usage
 
 ### Interfaces
@@ -164,7 +172,9 @@ Unfortunately, ruby doesn't allow inspecting the method's signature default valu
 
 #### Randomizer Advanced Example
 
-Let's write an advanced version of the randomizer that has CLI signature.
+Let's write an advanced version of the randomizer that has CLI signature. 
+
+Our entry point is the `run` method, which is called with the parsed and validated input.
 
 ```ruby
 # randomizer.rb
@@ -210,7 +220,7 @@ RandomGeneratorCLI.new.start
 Run the script with the following command:
 
 ```bash
-ruby randomizer.rb 1 2 --alg uni --i y # => some number from [1.0, 2.0]
+ruby randomizer.rb 1 2 --alg uni --i # => some number from [1.0, 2.0]
 ```
 
 Get help with the following command:
@@ -247,7 +257,7 @@ Options:
  # Algorithm to use (uni or exp)
   --alg (-a) [string] 
  # Include upper bound
-  [--[no-]incl] (-[no-]i) [bool]  [default: false]
+  [--incl] (-i) [bool]  [default: false]
 
 Usage: randomizer.rb [arguments] [options]
 Use --h, --help to print this help message.
@@ -316,7 +326,6 @@ Use --h, --help to print this help message.
 - [ ] Add CI/CD
 - [ ] Add more examples
 - [ ] Create a proper documentation
-- [ ] Better boolean flag handling
 
 ## Contributing
 

data/lib/clino/domain/input_parser.rb

@@ -22,14 +22,7 @@ module InputParser
     OptionParser.new do |opt|
       signature.opts.each_key do |name|
         signature_opt = signature.opts[name]
-        type = signature_opt.type
         aliases = signature_opt.aliases
-        if type == :bool
-          opt.on(*aliases, "--[no-]#{name}") do |v|
-            input[name] = v
-          end
-          next
-        end
 
         if signature_opt.required?
           opt.on(*aliases, "--#{name} #{name.upcase}") do |v|

data/lib/clino/domain/signature/cli_signature.rb

@@ -49,7 +49,6 @@ class CliSignature
     unless @opts.empty?
       @help += "\nOptions:\n"
       @opts.each do |name, option|
-        name = "[no-]#{name}" if option.type == :bool
         opt_part = "  #{option.required? ? "--#{name}" : "[--#{name}]"}"
         if option.aliases && !option.aliases.empty?
           aliases = option.aliases.join(", ")

data/lib/clino/interfaces/cli.rb

@@ -16,8 +16,7 @@ class Cli
 
     def opt(name, type: :string, desc: nil, aliases: [], default: :none)
       @opt_buffer ||= {}
-      bool_prefix = type == :bool ? "[no-]" : ""
-      aliases = aliases.map { |a| "-#{bool_prefix}#{general_strip a, "-"}" }
+      aliases = aliases.map { |a| "--#{general_strip a, "-"}" }
       default = load_input type, default unless default == :none
       @opt_buffer[name] = Base::OptSignature.new(name: name, type: type, default: default, desc: desc,
                                                  aliases: aliases)

data/lib/clino/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clino
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clino
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tikhon Zaikin