clino 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 371a8130998852d6dd08f5abb9d0a64d1c984fd2c0224ab3b9313b88e9e11d27
-  data.tar.gz: 4fbff42de01c1bb8c746882a9670f4928de0c09c7e7d7ba11fb6e0d4e85cc9bc
+  metadata.gz: df8da7e0b98d842743ff6574a23b88f48382faa9ccc218734b9696db55758799
+  data.tar.gz: ec26f662643aa566eaf2572d79a0d50dbb96a1d23550899329967a3299708b1f
 SHA512:
-  metadata.gz: 1a7772c11b06cea8b0c1b71aff7f9ed6afd46d9229dbe0b88c328b2c3df214b70a44268c797bee6f7e43a5a12500de8224c91aa0d036fdcf9b95a5372390e75f
-  data.tar.gz: 060acd626f965c30b4ba9af1ee1241e881c44b9c6af692d1ce70cb272d644bd9be0bd54dd67732aded98602c526ce4b31916dbebcddf4b7b9251858dffadb383
+  metadata.gz: 1accf77eb7242b41b00a9b19cedecb00a6116d429016123714a9bc0f08dc82d371216b9bfbe733ee411a18da97074c0e919f1e5b88248f5786293003be8ec695
+  data.tar.gz: b96437b5d23babb6a6749e23414ed5aef3bc3effe2690399ccb22136a5e686f3be8ec9f97a8bdd419ef66e69c993495bf4baeb25aac121c40d9f678cb094f9eb

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tikhon.zaikin@ematiq.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at snusmumrmail@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

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
@@ -40,14 +48,10 @@ Let's write a simple script that takes a name as an argument and prints a greeti
 
 require "clino/interfaces/min"
 
-def hello(name)
-  "Hello, #{name}!"
-end
-
-Min.new(:hello).start
+Min.new(->(name) { "Hello, #{name}!" }).start
 ```
 
-Writing method containing only business logic is enough, as the input and output handling is done by the `Min` interface.
+Writing lambda containing only business logic is enough, as the input and output handling is done by the `Min` interface.
 
 Run the script with the following command:
 
@@ -64,7 +68,7 @@ ruby hello.rb --help
 or 
 
 ```bash
-ruby hello.rb --h
+ruby hello.rb -h
 ```
 
 It will print the following output:
@@ -77,7 +81,6 @@ Arguments:
   <name> [string]
 
 Usage: hello.rb [arguments] [options]
-Use --h, --help to print this help message.
 ```
 #### Randomizer Minimalistic Example
 
@@ -132,7 +135,7 @@ ruby min_randomizer.rb --help
 or
 
 ```bash
-ruby min_randomizer.rb --h
+ruby min_randomizer.rb -h
 ```
 
 It will print the following output:
@@ -155,7 +158,6 @@ Options:
   [--incl] [string]  [default: unknown]
 
 Usage: min_randomizer.rb [arguments] [options]
-Use --h, --help to print this help message.
 ```
 
 As we can see, ruby's metaprogramming capabilities allow us to create a simple CLI, however it doesn't provide a way to handle complex input.
@@ -164,7 +166,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 +214,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:
@@ -222,7 +226,7 @@ ruby randomizer.rb --help
 or
 
 ```bash
-ruby randomizer.rb --h
+ruby randomizer.rb -h
 ```
 
 It will print the following output:
@@ -247,10 +251,9 @@ 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.
 ```
 
 As we can see, all the default values, helping notes, and types are written out, and the input validation is handled automatically.
@@ -304,7 +307,6 @@ Arguments:
   <height> [positive_integer]
 
 Usage: weight_calculator.rb [arguments] [options]
-Use --h, --help to print this help message.
 ```
 
 ## Improvements
@@ -316,7 +318,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/common/utils.rb

@@ -6,3 +6,8 @@ def general_strip(str, substring = " ")
   str = str[0...-substring_len] while str.end_with?(substring)
   str
 end
+
+def is_callable_with_parameters?(arg)
+  # Check if the argument is callable
+  arg.respond_to?(:call) && arg.parameters
+end

data/lib/clino/domain/input_parser.rb

@@ -4,10 +4,18 @@ require "optparse"
 
 module InputParser
   def parse_input(args_and_opts, signature)
+    args_and_opts = args_and_opts.map do |arg|
+      idx = 0
+      idx += 1 while arg[idx..].start_with?("-") && idx < arg.length
+      part_to_replace = arg[idx..].gsub("-", "_")
+      arg[0...idx] + part_to_replace
+    end
+
     input = {}
     pos_args = []
+    allowed_options = signature.allowed_options
     args_and_opts.each do |arg|
-      break if arg.start_with?("--")
+      break if allowed_options.include?(arg)
 
       pos_args << arg
     end
@@ -19,32 +27,20 @@ module InputParser
       input[arg.name] = load_input arg.type, val if arg
     end
 
-    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|
-            input[name] = load_input signature.opts[name].type, v
-          end
-        else
-          opt.on(*aliases, "--#{name}") do |v|
-            input[name] = load_input signature.opts[name].type, v
-          end
-        end
-      end
-      opt.on("--h", "--help", "Prints this help") do
-        input[:help] = true
+    prev_opt_name = nil
+    allowed_option_to_name = signature.allowed_option_to_name
+    opts.each do |opt|
+      if allowed_options.include?(opt)
+        prev_opt_name = allowed_option_to_name[opt]
+        input[prev_opt_name] = true
+      elsif input[prev_opt_name] == true
+        input[prev_opt_name] = load_input signature.opts[prev_opt_name].type, opt
+        prev_opt_name = nil
+      else
+        raise ArgumentError, "Can't parse #{opt} option"
       end
-    end.parse!(opts)
+    end
+
     input
   end
 end

data/lib/clino/domain/result_obtainer.rb

@@ -16,8 +16,10 @@ module ResultObtainer
     end
 
     signature.opts.each do |opt_name, opt|
+      next if opt.exec_skip
+
       if opt.required?
-        keyword_values[opt_name] = input[opt_name]
+        keyword_values[opt_name] = input[opt_name] if input.key?(opt_name)
       else
         keyword_values[opt_name] = input[opt_name] unless input[opt_name].nil?
       end
@@ -25,6 +27,8 @@ module ResultObtainer
 
     default_opts = signature.default_opts
     default_opts.each do |opt_name, opt|
+      next if signature.opts[opt_name].exec_skip
+
       keyword_values[opt_name] = opt unless keyword_values.key?(opt_name) || opt == :unknown
     end
 

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

@@ -33,9 +33,9 @@ module Base
     end
   end
 
-  OptSignature = Struct.new(*BaseSignatureStruct.members, :aliases) do
+  OptSignature = Struct.new(*BaseSignatureStruct.members, :aliases, :exec_skip) do
     include BaseSignature
-    def initialize(name:, type: :string, default: :none, desc: nil, aliases: [])
+    def initialize(name:, type: :string, default: :none, desc: nil, aliases: [], exec_skip: false)
       super
     end
   end

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

@@ -10,7 +10,16 @@ class CliSignature
   def initialize
     @args = {}
     @args_arr = []
-    @opts = {}
+    @opts = {
+      help: Base::OptSignature.new(
+        name: :help,
+        type: :bool,
+        desc: "Prints this help message",
+        aliases: %w[-h],
+        default: false,
+        exec_skip: true
+      )
+    }
     @description = nil
     @help = nil
   end
@@ -49,7 +58,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(", ")
@@ -64,8 +72,6 @@ class CliSignature
 
     @help += "\nUsage: #{program_name} [arguments] [options]"
 
-    @help += "\nUse --h, --help to print this help message.\n"
-
     @help
   end
 
@@ -108,4 +114,26 @@ class CliSignature
     end
     args
   end
+
+  def allowed_options
+    if @allowed_options.nil?
+      @allowed_options = Set.new
+      @allowed_option_to_name = {}
+      @opts.each_value do |opt|
+        long_opt = "--#{opt.name}"
+        @allowed_options.add(long_opt)
+        @allowed_option_to_name[long_opt] = opt.name
+        opt.aliases.each do |alias_|
+          @allowed_options.add(alias_)
+          @allowed_option_to_name[alias_] = opt.name
+        end
+      end
+    end
+    @allowed_options
+  end
+
+  def allowed_option_to_name
+    allowed_options if @allowed_option_to_name.nil?
+    @allowed_option_to_name
+  end
 end

data/lib/clino/interfaces/base/base_cli.rb

@@ -5,14 +5,28 @@ module BaseCli
   include ResultObtainer
 
   def start(args = ARGV)
-    input = parse_input args, @signature
+    input = parse_args_by_signature args
+    return if input.nil?
 
+    print_result run_instance input
+  end
+
+  def start_raw(args)
+    input = parse_args_by_signature args
+    return if input.nil?
+
+    run_instance input
+  end
+
+  def parse_args_by_signature(args)
+    parse_input args, @signature
+  end
+
+  def run_instance(input)
     if input[:help]
-      print_help
-      return
+      return @signature.help
     end
-
-    print_result call_method_with_args @signature, @method, input
+    call_method_with_args @signature, @method, input
   end
 
   def print_help

data/lib/clino/interfaces/cli.rb

@@ -8,7 +8,14 @@ require_relative "base/base_cli"
 
 class Cli
   class << self
-    attr_reader :opt_buffer, :arg_buffer, :description
+    attr_reader :description
+    def opt_buffer
+      @opt_buffer || {}
+    end
+
+    def arg_buffer
+      @arg_buffer || {}
+    end
 
     def desc(description)
       @description = description
@@ -16,8 +23,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)
@@ -39,7 +45,7 @@ class Cli
     end
 
     @signature.opts.each_key do |name|
-      @signature.add_opt(self.class.opt_buffer[name])
+      @signature.add_opt(self.class.opt_buffer[name]) if self.class.opt_buffer.key? name
     end
 
     @signature.description = self.class.description

data/lib/clino/interfaces/min.rb

@@ -13,7 +13,7 @@ class Min
 
   def initialize(command)
     @method = method command if command.is_a? Symbol
-    @method = command if command.is_a? Method
+    @method = command if is_callable_with_parameters? command
 
     @signature = CliSignature.from_func @method
   end

data/lib/clino/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clino
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Tikhon Zaikin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies: []
 description: |-
   clino is a minimalistic CLI generator