argvise 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e02579f4619b47f97e46fe3052e577680cd88ba737f742fe581fc55ef7a54527
-  data.tar.gz: '08e79eab0d15b6ec23367d39d23e60dbbc0c969b32e632d6aabb54727136d0c1'
+  metadata.gz: 96b6f0c2b58c2c978c647f988896d96377fa798b5df00eb372d8f2c13de6d479
+  data.tar.gz: ebdd6ef0219a35ab0c585f9310be93ac6f8a22b6376289002b8c414e4ffa6b4e
 SHA512:
-  metadata.gz: 87b6122a07799b34702cdc391d8e9c5219ae93c1380f948d0c7359ec71c94e1256274ee03dfd24becd2b0c91f1f2c6992d3a4c8418333dd0a72d8545099a2cc9
-  data.tar.gz: de14f0f04cace2b164919228c0126692682acfaab406cb710b27828f1db1731f9a59281609cd5c09aab4344e78aa9a11f4f55e2148c0022e404bbd636bf36ccc
+  metadata.gz: 6124154af43827d0b5d65d5c086ecb0941daf7f5b56a35655072ee6ba75486340d0eede11aebeb29e95cf69540cd3932e41f0d498d578e68e8ea580abef9ece2
+  data.tar.gz: 82a72a33658ea1e190a6f16f181e2d4a9f4c6bad414aa815307e4118a45d53624685809488e276ab84609509467b9fa7e7cda4001e89cfb3a428b073de6247a4

data/docs/Readme.md

@@ -20,7 +20,7 @@ system "gem install argvise"
 require 'argvise'
 
 raw_cmd_hash = {
-  cargo: nil, b: nil, r: true, target: "wasm32-wasip2"
+  cargo: (), b: (), r: true, target: "wasm32-wasip2"
 }
 
 raw_cmd_hash
@@ -81,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 }`        | `[]`                         |
@@ -89,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                             |
@@ -101,7 +101,7 @@ gem install argvise
 
 ---
 
-#### `with_kebab_case_flags(true)`:
+#### `with_kebab_case_flags(true)`
 
 | Hash Format       | Result        |
 | ----------------- | ------------- |
@@ -109,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                           |
@@ -127,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       |
 | ----------------- | ------------ |
@@ -135,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
@@ -158,8 +158,8 @@ gem install argvise
 require 'argvise'
 
 raw_cmd_hash = {
-  docker: nil,  #=> docker
-  build: nil,
+  docker: (),  #=> docker
+  build: (),
   push: true, #=> --push
   tag: ["ghcr.io/[user]/repo:latest", "ghcr.io/[user]/repo:v0.0.1"], #=> --tag ghcr... --tag ghcr..0.0.1
   platform: "wasi/wasm", #=> --platform wasi/wasm
@@ -168,7 +168,7 @@ raw_cmd_hash = {
     description: "A Docker build example"
   }, # => --label maintainer=user --label description=A..example
   file: "wasi.dockerfile",
-  path: nil,
+  path: (),
 }
 
 Argvise.build(raw_cmd_hash)
@@ -181,7 +181,7 @@ Argvise.build(raw_cmd_hash)
 # ]
 ```
 
-### Lambda Shortcut
+### Shortcut
 
 ```ruby
 { v: true, dir: '/path/to/dir' }.to_argv
@@ -191,13 +191,14 @@ Argvise.build(raw_cmd_hash)
 ### 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,
@@ -208,11 +209,12 @@ raw_cmd = {
     maintainer: 'user',
     description: 'Demo'
   },
-  "/path/to/dir": nil
+  "/path/to/dir": ()
 }
 
 p '----------------'
 p "GNU-style + kebab case flags=false"
+# argvise: >= v0.0.4
 raw_cmd
   .then(&Argvise.new_proc)
   .with_bsd_style(false)
@@ -224,6 +226,7 @@ raw_cmd
 
 p '----------------'
 p 'GNU-style + kebab-case-flags=true'
+# argvise: >= v0.0.6
 raw_cmd
   .to_argv
   .display
@@ -232,6 +235,7 @@ raw_cmd
 
 p '----------------'
 p 'BSD-style + kebab-case-flags=true'
+# argvise: >= v0.0.4
 raw_cmd
   .then(&Argvise.new_proc)
   .with_bsd_style
@@ -248,15 +252,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
 
@@ -296,9 +300,9 @@ 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
 
@@ -306,7 +310,7 @@ raw_cmd
 
 Breaking Changes:
 
-- `.hash_to_argv` => `Hash.to_argv(opts)`
+- `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/{core.rb → argvise/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"]
@@ -254,7 +254,7 @@ class Argvise
 end
 
 class ::Hash # rubocop:disable Style/Documentation
-  # A convenient lambda method: converts a hash into command-line arguments
+  # Converts a hash into command-line arguments
   #
   # == Example：
   #
@@ -277,6 +277,6 @@ class ::Hash # rubocop:disable Style/Documentation
   #
   # sig { params(opts: T.nilable(Hash)).returns(T::Array[String]) }
   def to_argv(opts = nil)
-    Argvise.build(self, opts: opts)
+    Argvise.build(self, opts:)
   end
 end

data/lib/argvise/version.rb

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

data/lib/argvise.rb

@@ -2,4 +2,4 @@
 # frozen_string_literal: true
 
 require_relative 'argvise/version'
-require_relative 'core'
+require_relative 'argvise/core'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argvise
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - 2moe
@@ -23,8 +23,8 @@ files:
 - bin/console.rb
 - docs/Readme.md
 - lib/argvise.rb
+- lib/argvise/core.rb
 - lib/argvise/version.rb
-- lib/core.rb
 - rbi/lib/argvise.rbi
 homepage: https://github.com/2moe/argvise-gem
 licenses: