argvise 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ffc3b336215c132bac812e0a592a576f8c052e061363cfa337b876fd8d8ba5c
-  data.tar.gz: 2b13e0ffb309f4473249775fbe44161289573395eb3fc2df8b10e1ffa49b2620
+  metadata.gz: 8558fd9dd7cf152d33787d2c15c101a18e28d3064e2ecfe54c77d4d488e16119
+  data.tar.gz: 1ef9387ef135826ee91e6409b1c585ba92ee7411487a1fc6dec25a47e7268718
 SHA512:
-  metadata.gz: b0f93d1d83200a891f6ca6d70227931f15fd605d474ca108bc6e402e1fafe45d3b164f3e0b669eb42511ef81a61c0fe4b33bf80675291c36e47a0300aefbce95
-  data.tar.gz: 075aa56b3faa272177d7536cd6753ed5e8e95684510906bde68083008fac4c956ad80b69c6e8486b20e0e41b445edeace7eb7206195524225b9512ff770bce96
+  metadata.gz: d39ff4e6428417cd801f08f077a9f92b742d85bb91a2fd15cfed5bead4b432d4a999a592f93f7339334ec11b5ec4ec5d88fc719a126afc4341cf28424a2d94c0
+  data.tar.gz: cec50ddc41188e914a4967ff97fe914e84ad620f7033823d322d25284d9f7933cf9e1f7f2186f06dfc57f3c92221d0e54828a9739c7681a3eba8f119f792062e

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/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Argvise
+  VERSION = '0.0.2'
+end

data/lib/argvise.rb

@@ -1,102 +1,4 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/Lambda, Lint/MissingCopEnableDirective
-# ------------------
-# Converts hash to command array
-#
-# Example
-#   {cargo: nil, build: nil, v: true, target: "wasm32-wasip2"}.then { Argvise.build _1 }
-#   # Output => ["cargo", "build", "-v", "--target", "wasm32-wasip2"]
-#
-# Supported data structures:
-# - Simple flags: `{ verbose: true }` => "--verbose"
-# - Boolean values: `{ v: false }` => no argument generated
-# - Array values: `{ tag: %w[a b] }` => `["--tag", "a", "--tag", "b"]`
-# - Hash values: `{ label: { env: 'test' } }` => `["--label", "env=test"]`
-class Argvise
-  # Converts a hash into a command-line argument array
-  #
-  # @param options [Hash] The hash to be converted
-  # @return [Array<String>] The generated array of command-line arguments
-  def self.build(options)
-    new.build(options)
-  end
-
-  def build(options)
-    # options.each_pair.flat_map { |k, v| process_pair(k.to_s, v) }
-    options.each_with_object([]) do |(k, v), memo|
-      memo.concat(process_pair(k.to_s, v))
-    end
-  end
-
-  private
-
-  # Processes a single key-value pair and generates the corresponding argument fragment
-  def process_pair(key, value)
-    # e.g., {cargo: nil, build: nil} => ["cargo", "build"]
-    return [key] if value.nil?
-    # e.g., {install: false} => []
-    return [] unless value
-
-    flag = build_flag(key)
-    generate_args(flag, value)
-  end
-
-  # Builds the command-line flag prefix (automatically detects short or long options)
-  #
-  # short key, e.g., {v: true} => "-v"
-  # long key, e.g., {verbose: true} => "--verbose"
-  def build_flag(key)
-    prefix = key.length == 1 ? '-' : '--'
-    "#{prefix}#{key.tr('_', '-')}"
-  end
-
-  # Generates the corresponding argument array based on the value type
-  def generate_args(flag, value)
-    case value
-    when true
-      [flag]
-    when Array
-      expand_array(flag, value)
-    when Hash
-      expand_hash(flag, value)
-    else
-      # e.g., {tag: 'uuu'} => ["--tag", "uuu"]
-      [flag, value.to_s]
-    end
-  end
-
-  # {tag: ["v1", "v2"]}
-  #   => (flag: "--tag", array: ['v1', 'v2'])
-  #   =>  ["--tag", "v1", "--tag", "v2"]
-  def expand_array(flag, array)
-    # FP style: array.flat_map { |v| [flag, v.to_s] }
-    array.each_with_object([]) do |v, memo|
-      memo << flag
-      memo << v.to_s
-    end
-  end
-
-  # Processes hash values (generates key=value format)
-  #
-  # {label: { env: "test", key: "value" }}
-  #   => (flag: "--label", hash)
-  #   => ["--label", "env=test", "--label", "key=value"]
-  def expand_hash(flag, hash)
-    # hash.flat_map { |k, v| [flag, "#{k}=#{v}"] }
-    hash.each_with_object([]) do |(k, v), memo|
-      memo << flag
-      memo << "#{k}=#{v}"
-    end
-  end
-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"]
-def hash_to_args
-  ->(options) do
-    Argvise.build(options)
-  end
-end
+require_relative 'argvise/version'
+require_relative 'core'

data/lib/core.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/Lambda, Lint/MissingCopEnableDirective
+# ------------------
+# Converts hash to command array
+#
+# Example
+#   {cargo: nil, build: nil, v: true, target: "wasm32-wasip2"}.then { Argvise.build _1 }
+#   # Output => ["cargo", "build", "-v", "--target", "wasm32-wasip2"]
+#
+# Supported data structures:
+# - Simple flags: `{ verbose: true }` => "--verbose"
+# - Boolean values: `{ v: false }` => no argument generated
+# - Array values: `{ tag: %w[a b] }` => `["--tag", "a", "--tag", "b"]`
+# - Hash values: `{ label: { env: 'test' } }` => `["--label", "env=test"]`
+class Argvise
+  # Converts a hash into a command-line argument array
+  #
+  # @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
+
+  def build(options)
+    # options.each_pair.flat_map { |k, v| process_pair(k.to_s, v) }
+    options.each_with_object([]) do |(k, v), memo|
+      memo.concat(process_pair(k.to_s, v))
+    end
+  end
+
+  private
+
+  # Processes a single key-value pair and generates the corresponding argument fragment
+  def process_pair(key, value)
+    # e.g., {cargo: nil, build: nil} => ["cargo", "build"]
+    return [key] if value.nil?
+    # e.g., {install: false} => []
+    return [] unless value
+
+    flag = build_flag(key)
+    generate_args(flag, value)
+  end
+
+  # Builds the command-line flag prefix (automatically detects short or long options)
+  #
+  # short key, e.g., {v: true} => "-v"
+  # long key, e.g., {verbose: true} => "--verbose"
+  def build_flag(key)
+    prefix = key.length == 1 ? '-' : '--'
+    "#{prefix}#{key.tr('_', '-')}"
+  end
+
+  # Generates the corresponding argument array based on the value type
+  def generate_args(flag, value)
+    case value
+    when true
+      [flag]
+    when Array
+      expand_array(flag, value)
+    when Hash
+      expand_hash(flag, value)
+    else
+      # e.g., {tag: 'uuu'} => ["--tag", "uuu"]
+      [flag, value.to_s]
+    end
+  end
+
+  # {tag: ["v1", "v2"]}
+  #   => (flag: "--tag", array: ['v1', 'v2'])
+  #   =>  ["--tag", "v1", "--tag", "v2"]
+  def expand_array(flag, array)
+    # FP style: array.flat_map { |v| [flag, v.to_s] }
+    array.each_with_object([]) do |v, memo|
+      memo << flag
+      memo << v.to_s
+    end
+  end
+
+  # Processes hash values (generates key=value format)
+  #
+  # {label: { env: "test", key: "value" }}
+  #   => (flag: "--label", hash)
+  #   => ["--label", "env=test", "--label", "key=value"]
+  def expand_hash(flag, hash)
+    # hash.flat_map { |k, v| [flag, "#{k}=#{v}"] }
+    hash.each_with_object([]) do |(k, v), memo|
+      memo << flag
+      memo << "#{k}=#{v}"
+    end
+  end
+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)
+  end
+end

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.2
 platform: ruby
 authors:
 - 2moe
@@ -18,7 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - License
+- docs/Readme.md
 - lib/argvise.rb
+- lib/argvise/version.rb
+- lib/core.rb
+- rbi/lib/argvise.rbi
 homepage: https://github.com/2moe/argvise-gem
 licenses:
 - Apache-2.0