argvise 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc2e3625fabe3294535d920c085b82f1c2718032de5f3921a7a9f74424c1ca5f
-  data.tar.gz: 2005628bc2fc53ea8937a310111b4217289051e3c634d5960287ed9e4db4dca0
+  metadata.gz: baf5e36d57cbce4d441556b353f25a40cccb258762496b029ea31931c5f0a9ce
+  data.tar.gz: 6727e52bba5ce34e77e5649700c9c404fce0a66d7f7223f5a8f8e9e6abbfd21d
 SHA512:
-  metadata.gz: 1f78e1ea42b3d355ec65da36c69bbf31b7dfa7386c7483ed42c625ef15dc826f052e7009f040a47ef0f685a2f4d26de347edfeeba9c53c09cdb7941bc5b6915a
-  data.tar.gz: a9c6c99a0590f822f5dda6782a3a12c664008c8eff472c234f004e9b2fb69033e12dba58d8efd6c9bb77ec449cc97dab121cf875e80535f226f0ec29c3aea45c
+  metadata.gz: 97ad4a558c1b08ec2b64607e92761bb9ea1592cbfbb3d96fa9307179ae77e1123d6a2ef28725b36d77a2bd15d11dcf4a00cafe11868fab20adf3d73a926a9b3b
+  data.tar.gz: 3de59adb8b956fdb71342fb84064ba9a5a0fcc6030bf5e83a17ba2512223cc4185685057c9e2bd18efa0fefd0e4485d165282fc33efca534b9f8059ceff95417

data/bin/console.rb

@@ -1,9 +1,12 @@
 #!/usr/bin/env ruby
+# typed: ignore
 # frozen_string_literal: true
 
 # lib_path = File.expand_path('../lib', __dir__)
 # exec "irb -I #{lib_path} -r argvise"
 
+# require "bundler/setup"
+# require "argvise"
 require 'irb'
 require_relative '../lib/argvise'
 
@@ -43,7 +46,7 @@ puts_division_line
 
 puts 'GNU-style + kebab_case_flags(true)'
 raw_cmd
-  .then(&hash_to_argv)
+  .to_argv
   .display
 
 puts_division_line

data/docs/Readme.md

@@ -19,16 +19,21 @@ system "gem install argvise"
 # RUBY
 require 'argvise'
 
-{ cargo: nil, b: nil, r: true, target: "wasm32-wasip2" }
-  .then(&hash_to_argv)
+raw_cmd_hash = {
+  cargo: (), b: (), r: true, target: "wasm32-wasip2"
+}
+
+raw_cmd_hash
+  .to_argv
+  # .to_argv({bsd_style: false, kebab_case_flags: true})
 
 #=> ["cargo", "b", "-r", "--target", "wasm32-wasip2"]
 ```
 
-`raw_cmd_hash.then(&hash_to_argv)` is equivalent to:
+`raw_cmd_hash.to_argv` is equivalent to:
 
 ```ruby
-{ cargo: nil, b: nil, r: true, target: "wasm32-wasip2" }
+raw_cmd_hash
   .then(&Argvise.new_proc)
   .with_bsd_style(false) #=> GNU style
   .with_kebab_case_flags(true) #=> replace "--cli_flag" with "--cli-flag"
@@ -37,6 +42,8 @@ require 'argvise'
 
 ## Installation
 
+### Ruby MRI
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -61,6 +68,10 @@ Or install it directly:
 gem install argvise
 ```
 
+### mruby
+
+[More details](../mruby/Readme.md)
+
 ## Conversion Rules
 
 ### Common
@@ -70,6 +81,7 @@ gem install argvise
 | `{ "-k2": nil }`        | `["-k2"]`                    |
 | `{ "--r_a-w_": nil }`   | `["--r_a-w_"]`               |
 | `{ key: nil }`          | `["key"]`                    |
+| `{ key: () }`           | `["key"]`                    |
 | `{ key: [] }`           | `[]`                         |
 | `{ key: {} }`           | `[]`                         |
 | `{ key: false }`        | `[]`                         |
@@ -78,7 +90,6 @@ gem install argvise
 | `{ k: ["a", "b"] }`     | `["-k", "a", "-k", "b"]`     |
 | `{ k: { a: 1, b: 2 } }` | `["-k", "a=1", "-k", "b=2"]` |
 
-
 ### GNU Style
 
 | Hash Format               | Result                             |
@@ -90,7 +101,7 @@ gem install argvise
 
 ---
 
-#### `with_kebab_case_flags(true)`:
+#### `with_kebab_case_flags(true)`
 
 | Hash Format       | Result        |
 | ----------------- | ------------- |
@@ -98,13 +109,12 @@ gem install argvise
 
 ---
 
-#### `with_kebab_case_flags(false)`:
+#### `with_kebab_case_flags(false)`
 
 | Hash Format       | Result        |
 | ----------------- | ------------- |
 | `{ key_b: true }` | `["--key_b"]` |
 
-
 ### BSD Style
 
 | Hash Format               | Result                           |
@@ -116,7 +126,9 @@ gem install argvise
 
 ---
 
-#### `with_kebab_case_flags(true)`:
+<!-- markdownlint-disable MD024 no-duplicate-heading -->
+
+#### `with_kebab_case_flags(true)`
 
 | Hash Format       | Result       |
 | ----------------- | ------------ |
@@ -124,13 +136,12 @@ gem install argvise
 
 ---
 
-#### `with_kebab_case_flags(false)`:
+#### `with_kebab_case_flags(false)`
 
 | Hash Format       | Result       |
 | ----------------- | ------------ |
 | `{ key_d: true }` | `["-key_d"]` |
 
-
 ### Notes
 
 > When the value of a flag key is `nil`, the `kebab_case_flags` option has
@@ -173,20 +184,21 @@ Argvise.build(raw_cmd_hash)
 ### Lambda Shortcut
 
 ```ruby
-{ v: true, dir: '/path/to/dir' }.then(&hash_to_argv)
+{ v: true, dir: '/path/to/dir' }.to_argv
 # => ["-v", "--dir", "/path/to/dir"]
 ```
 
 ### Configurable builder
 
 > Required
->   - argvise: >= v0.0.4
->   - ruby: >= v3.1.0
+>
+> - argvise: >= v0.0.6
+> - ruby: >= v3.1.0
 
 ```ruby
 raw_cmd = {
-  compiler: nil,
-  build: nil,
+  compiler: (),
+  build: (),
   pack_type: 'tar+zstd',
   push: true,
   v: true,
@@ -197,7 +209,7 @@ raw_cmd = {
     maintainer: 'user',
     description: 'Demo'
   },
-  "/path/to/dir": nil
+  "/path/to/dir": ()
 }
 
 p '----------------'
@@ -214,7 +226,7 @@ raw_cmd
 p '----------------'
 p 'GNU-style + kebab-case-flags=true'
 raw_cmd
-  .then(&hash_to_argv)
+  .to_argv
   .display
 
 #=> ["compiler", "build", "--pack-type", "tar+zstd", "--push", "-v", "-f", "p2", "--tag", "v0.0.1", "--tag", "beta", "--platform", "wasi/wasm", "--label", "maintainer=user", "--label", "description=Demo", "/path/to/dir"]
@@ -237,15 +249,15 @@ raw_cmd
 
 #### GNU style
 
-- `{ verbose: true }` => "--verbose"
-- `{ v: true }` => "-v"
-- `{ v: false }` => no argument generated
+- `{ verbose: true }` => `["--verbose"]`
+- `{ v: true }` => `["-v"]`
+- `{ v: false }` => `[]`
 
 #### BSD style
 
-- `{ verbose: true }` => "-verbose"
-- `{ v: true }` => "-v"
-- `{ v: false }` => no argument generated
+- `{ verbose: true }` => `["-verbose"]`
+- `{ v: true }` => `["-v"]`
+- `{ v: false }` => `[]`
 
 ### String
 
@@ -285,5 +297,17 @@ raw_cmd
 
 ## Nil => Raw
 
-- `{ cargo: nil, b: nil}` => `["cargo", "b"]`
-- `{ "-fv": nil}` => `["-fv"]`
+- `{ cargo: () }` => `["cargo"]`
+- `{ cargo: nil, b: nil }` => `["cargo", "b"]`
+- `{ "-fv": nil }` => `["-fv"]`
+
+## Changelog
+
+### v0.0.6 (2025-11-05)
+
+Breaking Changes:
+
+- `cmd_hash |> hash_to_argv` => `cmd_hash.to_argv(opts)`
+  - i.e.,
+    - old: `{a: true}.then(&hash_to_argv)`
+    - new: `{a: true}.to_argv`

data/lib/argvise/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 class Argvise
-  VERSION = '0.0.5'
+  VERSION = '0.0.7'
 end

data/lib/core.rb

@@ -19,9 +19,9 @@
 #
 # === GNU Style:
 #   - Boolean values:
-#     - `{ verbose: true }` => "--verbose"
-#     - `{ v: true }` => "-v"
-#     - `{ v: false }` => no argument generated
+#     - `{ verbose: true }` => ["--verbose"]
+#     - `{ v: true }` => ["-v"]
+#     - `{ v: false }` => [] #no argument generated
 #   - String values:
 #     - `{ f: "a.txt" }` => ["-f", "a.txt"]
 #     - `{ file: "a.txt" }` => ["--file", "a.txt"]
@@ -34,9 +34,9 @@
 #
 # === BSD Style:
 #   - Boolean values:
-#     - `{ verbose: true }` => "-verbose"
-#     - `{ v: true }` => "-v"
-#     - `{ v: false }` => no argument generated
+#     - `{ verbose: true }` => ["-verbose"]
+#     - `{ v: true }` => ["-v"]
+#     - `{ v: false }` => [] #no argument generated
 #   - String values:
 #     - `{ f: "a.txt" }` => ["-f", "a.txt"]
 #     - `{ file: "a.txt" }` => ["-file", "a.txt"]
@@ -253,23 +253,30 @@ class Argvise
   end
 end
 
-# A convenient lambda method: converts a hash into command-line arguments
-#
-# == Example：
-#   { v: true, path: '/path/to/dir' }.then(&hash_to_argv)
-#   #=> ["-v", "--path", "/path/to/dir"]
-#
-# == raw_cmd_hash.then(&hash_to_argv) is equivalent to:
-#
-#  raw_cmd_hash
-#    .then(&Argvise.new_proc)
-#    .with_bsd_style(false)
-#    .with_kebab_case_flags(true)
-#    .build
-#
-# sig { returns(T.proc.params(raw_cmd_hash: Hash).returns(T::Array[String])) }
-def hash_to_argv
-  ->(raw_cmd_hash) do
-    Argvise.build(raw_cmd_hash)
+class ::Hash # rubocop:disable Style/Documentation
+  # Converts a hash into command-line arguments
+  #
+  # == Example：
+  #
+  #   { v: true, path: '/path/to/dir' }.to_argv
+  #   #=> ["-v", "--path", "/path/to/dir"]
+  #
+  # == params:
+  #
+  # - opts: See also [Argvise::new]
+  #
+  # == raw_cmd_hash.to_argv is equivalent to:
+  #
+  #  raw_cmd_hash
+  #    .then(&Argvise.new_proc)
+  #    .with_bsd_style(false)
+  #    .with_kebab_case_flags(true)
+  #    .build
+  #
+  # ---
+  #
+  # sig { params(opts: T.nilable(Hash)).returns(T::Array[String]) }
+  def to_argv(opts = nil)
+    Argvise.build(self, opts: opts)
   end
 end

data/rbi/lib/argvise.rbi

@@ -21,15 +21,17 @@ class Argvise
   end
   def initialize(raw_cmd_hash, opts: nil); end
 
-  sig { params(value: T::Boolean).returns(self) }
+  sig { params(value: T::Boolean).returns(T.self_type) }
   def with_bsd_style(value = true); end # rubocop:disable Style/OptionalBooleanParameter
 
-  sig { params(value: T::Boolean).returns(self) }
+  sig { params(value: T::Boolean).returns(T.self_type) }
   def with_kebab_case_flags(value = true); end # rubocop:disable Style/OptionalBooleanParameter
 
   sig { returns(T::Array[String]) }
   def build; end
 end
 
-sig { returns(T.proc.params(raw_cmd_hash: T::Hash[T.any(Symbol, String), T.untyped]).returns(T::Array[String])) }
-def hash_to_argv; end
+class ::Hash
+  sig { params(opts: T.nilable(Hash)).returns(T::Array[String]) }
+  def to_argv(opts = nil); end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argvise
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - 2moe
@@ -19,7 +19,6 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - License
-- argvise.gemspec
 - bin/build.rb
 - bin/console.rb
 - docs/Readme.md
@@ -48,5 +47,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.2
 specification_version: 4
-summary: Turns a hash into CLI arguments
+summary: Converts a hash into CLI arguments [Array]
 test_files: []

data/argvise.gemspec

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/argvise/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'argvise'
-  # spec.version = '0.0.1'
-  spec.version = Argvise::VERSION
-  spec.authors = ['2moe']
-  spec.email = ['m@tmoe.me']
-
-  spec.summary = 'Turns a hash into CLI arguments'
-  spec.description = 'Provides flexible command-line argument generation with support for complex data structures'
-  spec.license = 'Apache-2.0'
-  # spec.extra_rdoc_files = ['docs/rdoc/Readme.rdoc']
-  spec.required_ruby_version = '>= 3.1.0'
-  # spec.metadata['allowed_push_host'] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.homepage = 'https://github.com/2moe/argvise-gem'
-  spec.metadata['homepage_uri'] = spec.homepage
-  # spec.metadata['source_code_uri'] = spec.homepage
-  # 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.
-  # gemspec = File.basename(__FILE__)
-  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
-    ls.readlines("\x0", chomp: true).reject do |f|
-      # (f == gemspec) ||
-      f.start_with?(
-        # bin/ test/ Gemfile Rakefile assets docs/Readme-zh-
-        *%w[
-          spec/ features/ .git .github appveyor
-        ]
-      )
-    end
-  end
-  # spec.bindir = 'exe'
-  # spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end