argvise 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ffc3b336215c132bac812e0a592a576f8c052e061363cfa337b876fd8d8ba5c
-  data.tar.gz: 2b13e0ffb309f4473249775fbe44161289573395eb3fc2df8b10e1ffa49b2620
+  metadata.gz: e3de7b6cddf4e360892acc8de90364c77af210c9f66f171e496d5f1cc5b21ab0
+  data.tar.gz: 950cadc2c4ed07b55b828d1d20e361b529f5516cb6a47693dab887bb94c3cba0
 SHA512:
-  metadata.gz: b0f93d1d83200a891f6ca6d70227931f15fd605d474ca108bc6e402e1fafe45d3b164f3e0b669eb42511ef81a61c0fe4b33bf80675291c36e47a0300aefbce95
-  data.tar.gz: 075aa56b3faa272177d7536cd6753ed5e8e95684510906bde68083008fac4c956ad80b69c6e8486b20e0e41b445edeace7eb7206195524225b9512ff770bce96
+  metadata.gz: 70703568c2b83a629b81292bcfc933252fb47ec9904c60e3d2d3aa1fad0de5035684d6b3da5ae952d5df76f31a6d1f29b022c60431fcf2915920237cce314483
+  data.tar.gz: 01e6b640fd724a74778ddbc211ad86d8d52bd39ce1c92d4ac5afdbc3ea4558a756eb2bc13a74b4ea5380f247f11d3cead6e5086809b81d40df3fbfaed77e9bd9

data/docs/Readme.md

@@ -0,0 +1,119 @@
+# Argvise
+
+[![Gem Version](https://badge.fury.io/rb/argvise.svg?icon=si%3Arubygems)](https://rubygems.org/gems/argvise)
+
+A Ruby gem for converting hash structures into command-line argument arrays.
+
+> **Note:** This is *not* a command-line parser — quite the opposite. Argvise helps you **build** CLI commands programmatically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'argvise'
+```
+
+And then execute:
+
+```bash
+bundler install
+```
+
+Or install it directly:
+
+```bash
+gem install argvise
+```
+
+## Usage
+
+### Basic Conversion
+
+```ruby
+require 'argvise'
+
+options = { 
+  docker: nil,  #=> docker
+  build: nil, 
+  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
+  label: {
+    maintainer: "user",
+    description: "A Docker build example"
+  }, # => --label maintainer=user --label description=A..example
+  file: "wasi.dockerfile",
+  path: nil,
+}
+
+Argvise.build(options)
+# => [
+#   "docker", "build", "--push", 
+#   "--tag", "ghcr.io/[user]/repo:latest", "--tag", "ghcr.io/[user]/repo:v0.0.1", 
+#   "--platform", "wasi/wasm", 
+#   "--label", "maintainer=user", "--label", "description=A Docker build example", 
+#   "--file", "wasi.dockerfile", "path"
+# ]
+```
+
+### Lambda Shortcut
+
+```ruby
+{ v: true, dir: '/path/to/dir' }.then(&hash_to_args)
+# => ["-v", "--dir", "/path/to/dir"]
+```
+
+## Supported Data Structures
+
+### 1. Simple Flags
+
+```ruby
+{ verbose: true }.then(&hash_to_args)  # => ["--verbose"]
+```
+
+### 2. Boolean Values
+
+```ruby
+{ silent: false }.then(&hash_to_args) # => []
+```
+
+### 3. Array Values
+
+```ruby
+{ tag: %w[a b] }.then(&hash_to_args)
+# => ["--tag", "a", "--tag", "b"]
+```
+
+### 4. Hash Values
+
+```ruby
+{ label: { env: 'test', k2: 'v2' } }.then(&hash_to_args)
+# => ["--label", "env=test", "--label", "k2=v2"]
+```
+
+## API Documentation
+
+### `Argvise.build(options)`
+
+Main method to convert hash to command-line arguments array
+
+**Parameters:**
+
+- `options` (Hash) - The hash to be converted
+
+**Returns:**
+
+- Array<String> generated command-line arguments
+
+### Conversion Rules
+
+| Hash Format               | Result Example                     |
+| ------------------------- | ---------------------------------- |
+| `{ key: nil }`            | `["key"]`                          |
+| `{ key: false }`          | `[]`                               |
+| `{ key: true }`           | `["--key"]`                        |
+| `{ k: true }`             | `["-k"]`                           |
+| `{ key: "value" }`        | `["--key", "value"]`               |
+| `{ key: ["a", "b"] }`     | `["--key", "a", "--key", "b"]`     |
+| `{ key: { a: 1, b: 2 } }` | `["--key", "a=1", "--key", "b=2"]` |

data/lib/{argvise.rb → core.rb}

@@ -18,6 +18,8 @@ class Argvise
   #
   # @param options [Hash] The hash to be converted
   # @return [Array<String>] The generated array of command-line arguments
+  #
+  # sig { params(options: Hash).returns(T::Array[String]) }
   def self.build(options)
     new.build(options)
   end
@@ -92,9 +94,11 @@ class Argvise
 end
 
 # A convenient lambda method: converts a hash into command-line arguments
-# 
+#
 # Example：
 #   { v: true, path: '/path/to/dir' }.then(&hash_to_args) # => ["-v", "--path", "/path/to/dir"]
+#
+# sig { returns(T.proc.params(options: Hash).returns(T::Array[String])) }
 def hash_to_args
   ->(options) do
     Argvise.build(options)

data/rbi/lib/argvise.rbi

@@ -0,0 +1,12 @@
+# typed: true
+# frozen_string_literal: true
+
+class Argvise
+  class << self
+    sig { params(options: Hash).returns(T::Array[String]) }
+    def build(options); end
+  end
+end
+
+sig { returns(T.proc.params(options: Hash).returns(T::Array[String])) }
+def hash_to_args; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argvise
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - 2moe
@@ -18,7 +18,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - License
-- lib/argvise.rb
+- docs/Readme.md
+- lib/core.rb
+- rbi/lib/argvise.rbi
 homepage: https://github.com/2moe/argvise-gem
 licenses:
 - Apache-2.0