argvise 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e698d11b5f582bd557fd6f4d1a1d2d9f9cda5512d2ba26af3e59d803016093a8
-  data.tar.gz: 182e7a4cad5e576575335d22413eac4868c8ab7f993c17d9f344f898d8e86291
+  metadata.gz: 2d90fe07a2a4f58f550d26612903b467d83b99b1a0e0ae4ed00577e8e7459987
+  data.tar.gz: 444080af117dee382d702e6d3148d94733a90d94286187a55adda3744e37fb21
 SHA512:
-  metadata.gz: 24c9621fa200763a833f02bb019026b8a75b49f0948f88cb765ba38196bd5f1c4406313f8f5d837b70da259cf241a248bee41040615bb7ab354b7e7335ebefdd
-  data.tar.gz: 44e70c7e0b19e25e180e21851b0582e9e3ca1507aab3de9168abd24dff8f0d785087b5a302294046a5a366e6add6a8b3e98579d2573c7a0ed6b1146810aeaed2
+  metadata.gz: ea1a7f17329319d8c172c092de516ebbaaf1440d4fafe4a12c3265f20e62e1169c34cc034c011bb84b1cb9feec1434c0eaccad3597d9361fc8b739e381b36d11
+  data.tar.gz: f7195c500e27b7cd429a6d23cbc95c76b1c32c468a22784503c491405cd5079190719ae4df76db9069d3dc54d091385c375bc0ae7984d6cf1f3e663e113d106d

data/.rubocop.yml

@@ -12,21 +12,34 @@ Lint/EmptyExpression:
 
 # https://docs.rubocop.org/rubocop/cops_style.html
 Style/TrailingCommaInHashLiteral:
-  EnforcedStyle: diff_comma
+  EnforcedStyleForMultiline: diff_comma
 Style/TrailingCommaInArrayLiteral:
-  EnforcedStyle: diff_comma
+  EnforcedStyleForMultiline: diff_comma
 Style/Lambda:
   EnforcedStyle: literal
 Style/ModuleFunction:
-  EnforcedStyle: extend_self
+  # EnforcedStyle: extend_self
+  EnforcedStyle: module_function
 Style/BlockDelimiters:
-  Enabled: false
+  EnforcedStyle: braces_for_chaining
 Style/Documentation:
   Enabled: false
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html
+Metrics/MethodLength:
+  Max: 15
 
 # https://docs.rubocop.org/rubocop/cops_layout.html
 Layout/CaseIndentation:
   EnforcedStyle: end
   IndentOneStep: true
 Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver
+  EnforcedStyle: indented
+
+
+Naming/AsciiIdentifiers:
+  # AsciiConstants: false
+  Enabled: false
+

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--title 'Argvise'
+--protected
+--no-private

data/docs/Readme.md

@@ -8,6 +8,12 @@ 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.
 
+## API DOC
+
+![ClassDiagram](../misc/assets/svg/ClassDiagram.svg)
+
+- Github Pages: <https://2moe.github.io/argvise-gem>
+
 ## Quick Start
 
 ```ruby

data/lib/argvise/core.rb

@@ -5,7 +5,7 @@
 # ------------------
 # Converts hash to command array
 #
-# == Example
+# @example
 #
 #   { cargo: nil, b: nil, r: true, target: "wasm32-wasip2" }
 #     .then(&Argvise.new_proc)
@@ -15,9 +15,9 @@
 #
 #   #=> ["cargo", "b", "-r", "--target", "wasm32-wasip2"]
 #
-# == Conversion Rules:
+# # Conversion Rules:
 #
-# === GNU Style:
+# ## GNU Style:
 #   - Boolean values:
 #     - `{ verbose: true }` => ["--verbose"]
 #     - `{ v: true }` => ["-v"]
@@ -32,7 +32,7 @@
 #     - `{ L: { env: 'test' } }` => `["-L", "env=test"]`
 #     - `{ label: { env: 'test' } }` => `["--label", "env=test"]`
 #
-# === BSD Style:
+# ## BSD Style:
 #   - Boolean values:
 #     - `{ verbose: true }` => ["-verbose"]
 #     - `{ v: true }` => ["-v"]
@@ -47,12 +47,12 @@
 #     - `{ L: { env: 'test' } }` => `["-L", "env=test"]`
 #     - `{ label: { env: 'test' } }` => `["-label", "env=test"]`
 #
-# === Common:
+# ## Common:
 #   - Raw values:
 #   - `{ cargo: nil, b: nil}` => `["cargo", "b"]`
 #   - `{ "-fv": nil}` => `["-fv"]`
 #
-# === About kebab_case_flags:
+# ## About kebab_case_flags:
 #   - `with_kebab_case_flags(true)`:
 #     - `{enable_jit: true}` =>
 #         - GNU-style: `["--enable-jit"]`
@@ -70,18 +70,17 @@ class Argvise
   class << self
     # Converts a hash into a command-line argument array
     #
-    # == Example
+    # @example
     #   require 'argvise'
     #   cmd = { ruby: nil, r: "argvise", verbose: true, e: true, "puts Argvise::VERSION": nil }
     #   opts = { bsd_style: false }
     #   Argvise.build(cmd, opts:)
     #
-    # == Params
-    #   - raw_cmd_hash [Hash] The hash to be converted (i.e., raw input data)
-    #   - opts [Hash] See also: [self.new]
+    # @param raw_cmd_hash [Hash] The hash to be converted (i.e., raw input data)
+    # @param opts [Hash]
+    # @see #initialize
     #
-    # == Returns
-    #   [Array<String>] The generated array of command-line arguments
+    # @return [Array<String>] The generated array of command-line arguments
     def build(
       raw_cmd_hash,
       opts: nil
@@ -94,15 +93,16 @@ class Argvise
     #
     # Useful for transforming a hash of CLI arguments into a command array.
     #
-    # == Example
+    # @example
     #
-    #   require 'argvise'
-    #   { ruby: nil, r: "argvise", e: true, "puts Argvise::VERSION": nil }
-    #     .then(&Argvise.new_proc)
-    #     .build
-    #     .then{system *_1}
+    #     require 'argvise'
+    #     { ruby: nil, r: "argvise", e: true, "puts Argvise::VERSION": nil }
+    #       .then(&Argvise.new_proc)
+    #       .build
+    #       .then{system *_1}
     #
-    # > See also: [self.new]
+    # @see #initialize
+    # @return [::Proc] `.call(raw_cmd_hash)` => self
     def new_proc
       ->(raw_cmd_hash) do
         new(raw_cmd_hash)
@@ -111,15 +111,16 @@ class Argvise
     # ----
   end
 
-  # == Example
+  # @example
   #
   #   require 'argvise'
   #   cmd = { ruby: nil, r: "argvise", verbose: true, e: true, "puts Argvise::VERSION": nil }
   #   opts = Argvise::DEFAULT_OPTS
   #   Argvise.new(cmd, opts:).build.then{system *_1}
   #
-  # == opts
-  #   [Hash]: { bsd_style: Boolean, kebab_case_flags: Boolean }
+  # @param opts [Hash]: { bsd_style: Boolean, kebab_case_flags: Boolean }
+  #
+  # ## opts
   #
   # - When `bsd_style` is set to `false`, the builder operates in **GNU-style mode**,
   #   which typically uses hyphenated flags.
@@ -128,12 +129,11 @@ class Argvise
   #   will be automatically converted to hyphens (`-`).
   #   - For example, a flag like `--enable_jit` will be transformed into `--enable-jit`.
   #
-  # When the value of a flag key is `nil`, the `kebab_case_flags` option has no effect
+  # When the value of a flag key is `nil`, the `kebab_case_flags` option has no effect.
   # — i.e., the key will not be transformed.
   #
   # For example, the input `{"a_b-c": nil}` will result in `["a_b-c"]`,
   # and **not** be automatically transformed into `["a-b-c"]`.
-  #
   def initialize(
     raw_cmd_hash,
     opts: nil
@@ -145,16 +145,21 @@ class Argvise
     @kebab_case_flags = opts[:kebab_case_flags]
   end
 
+  # Default: true
+  # @return [self]
   def with_bsd_style(value = true) # rubocop:disable Style/OptionalBooleanParameter
     @bsd_style = value
     self
   end
 
+  # Default: true
+  # @return [self]
   def with_kebab_case_flags(value = true) # rubocop:disable Style/OptionalBooleanParameter
     @kebab_case_flags = value
     self
   end
 
+  # @return [Array<String>]
   def build
     # @raw_cmd_hash.each_pair.flat_map { |k, v| process_pair(k.to_s, v) }
     @raw_cmd_hash.each_with_object([]) do |(k, v), memo|
@@ -185,13 +190,13 @@ class Argvise
   #  - short key, e.g., {verbose: true} => "-verbose"
   #  - no long key
   #
-  # @kebab_case_flags==true:
+  # kebab_case_flags==true:
   #  - "_" => "-"
   #  - e.g., {enable_jit: true} =>
   #    - BSD-style: "-enable-jit"
   #    - GNU-style: "--enable-jit"
   #
-  # @kebab_case_flags==false:
+  # kebab_case_flags==false:
   #  - e.g., {enable_jit: true} =>
   #    - BSD-style: "-enable_jit"
   #    - GNU-style: "--enable_jit"
@@ -254,10 +259,16 @@ class Argvise
 end
 
 class Argvise
-  module HashExt # rubocop:disable Style/Documentation
+  # The foundation of {HashRefin} and {HashMixin}
+  module HashExt
     # Converts a hash map into GNU-style command-line arguments.
     #
-    # == Example：
+    # @param opts [Hash, nil] See also `Argvise.new`
+    #
+    # @see Argvise#initialize
+    # @see to_argv_bsd
+    #
+    # @example Basic usage
     #
     #     require 'argvise'
     #     using Argvise::HashRefin
@@ -265,11 +276,8 @@ class Argvise
     #     { 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:
+    # @example raw_cmd_hash.to_argv is equivalent to:
     #
     #     raw_cmd_hash
     #       .then(&Argvise.new_proc)
@@ -277,15 +285,16 @@ class Argvise
     #       .with_kebab_case_flags(true)
     #       .build
     #
-    # ---
-    # sig { params(opts: T.nilable(Hash)).returns(T::Array[String]) }
+    # @return [Array<String>]
     def to_argv(opts = nil)
       Argvise.build(self, opts:)
     end
 
     # Converts a hash map into BSD-style command-line arguments.
     #
-    # == Example：
+    # @param opts [Hash]
+    # @see to_argv
+    # @example
     #
     #     require 'argvise'
     #     using Argvise::HashRefin
@@ -293,6 +302,7 @@ class Argvise
     #     { path: '/path/to/dir' }.to_argv_bsd
     #     #=> ["-path", "/path/to/dir"]
     #
+    # @return [Array<String>]
     def to_argv_bsd(options = {})
       # if options is not Hash Type => {}
       options = {} unless options.is_a?(::Hash)
@@ -304,7 +314,12 @@ class Argvise
 
   # Converts a hash map into command-line arguments.
   #
-  # == Example：
+  # Monkey Patching:
+  #
+  # - Hash#to_argv
+  # - Hash#to_argv_bsd
+  #
+  # @example
   #
   #     require 'argvise'
   #

data/lib/argvise/refinement.rb

@@ -2,14 +2,18 @@
 # frozen_string_literal: true
 
 # To maintain `mruby` compatibility, define `private_constant` and
-#  `refinements` in this file rather than in **core.rb**.
+#  `refinements` in **refinement.rb** rather than in **core.rb**.
 
-class Argvise
-  private_constant :HashExt
+class Argvise # rubocop:disable Style/ClassAndModuleChildren
+  # Probably no need to mark this as private.
+  # private_constant :HashExt
 
-  # Refinements: Hash#to_argv, Hash#to_argv_bsd
+  # Refinements:
   #
-  # = Example
+  # - Hash#to_argv
+  # - Hash#to_argv_bsd
+  #
+  # @example
   #
   #     require 'argvise'
   #     class A
@@ -21,7 +25,7 @@ class Argvise
   #         puts({ target: "wasm32-wasip2" }.to_argv_bsd)
   #           # => ["-target", "wasm32-wasip2"]
   #
-  #         {}.respond_to?(:to_argv) #=> true
+  #         puts({}.respond_to?(:to_argv)) #=> true
   #       end
   #     end
   #

data/lib/argvise/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argvise
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - 2moe
@@ -11,28 +11,24 @@ date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Provides flexible command-line argument generation with support for complex
   data structures
-email:
-- m@tmoe.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".yardopts"
 - License
-- bin/build.rb
-- bin/console.rb
-- bin/irb.rb
 - docs/Readme.md
 - lib/argvise.rb
 - lib/argvise/core.rb
 - lib/argvise/refinement.rb
 - lib/argvise/version.rb
-- rbi/lib/argvise.rbi
 homepage: https://github.com/2moe/argvise-gem
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/2moe/argvise-gem
+  documentation_uri: https://2moe.github.io/argvise-gem/
 rdoc_options: []
 require_paths:
 - lib

data/bin/build.rb

@@ -1,19 +0,0 @@
-#!/usr/bin/env ruby
-# typed: ignore
-# frozen_string_literal: true
-
-require 'pathname'
-
-Pathname(__dir__ || File.dirname(__FILE__))
-  .parent
-  .then { Dir.chdir(it) }
-
-proj = 'argvise'
-
-system <<~CMD
-  gem uninstall #{proj}
-  gem build #{proj}
-  gem install #{proj}
-CMD
-
-# gem push argvise-*.gem

data/bin/console.rb

@@ -1,67 +0,0 @@
-#!/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'
-
-puts "Argvise: #{Argvise::VERSION}"
-
-def puts_division_line
-  puts
-  puts '-' * 80
-end
-
-raw_cmd = {
-  compiler: nil,
-  build: nil,
-  pack_type: 'tar+zstd',
-  push: true,
-  v: true,
-  f: 'p2',
-  tag: ['v0.0.1', 'beta'],
-  platform: 'wasi/wasm',
-  label: {
-    maintainer: 'user',
-    description: 'Demo'
-  },
-  "/path/to/dir": nil
-}
-
-puts 'GNU-style + kebab_case_flags(false)'
-raw_cmd
-  .then(&Argvise.new_proc)
-  .with_bsd_style(false)
-  .with_kebab_case_flags(false)
-  .build
-  .display
-
-puts_division_line
-# -----------
-
-using Argvise::HashRefin
-puts 'GNU-style + kebab_case_flags(true)'
-raw_cmd
-  .to_argv
-  .display
-
-puts_division_line
-# -----------
-
-puts 'BSD-style + kebab_case_flags(true)'
-raw_cmd
-  .then(&Argvise.new_proc)
-  .with_bsd_style
-  .with_kebab_case_flags
-  .build
-  .display
-
-puts_division_line
-# -----------
-
-IRB.start

data/bin/irb.rb

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'irb'
-load File.expand_path('../lib/argvise.rb', __dir__)
-
-puts "Argvise: #{Argvise.constants}"
-puts Argvise::VERSION
-
-IRB.start

data/rbi/lib/argvise.rbi

@@ -1,40 +0,0 @@
-# rubocop:disable Style/Documentation, Lint/MissingCopEnableDirective
-# typed: true
-# frozen_string_literal: true
-
-class Argvise
-  class << self
-    sig do
-      params(
-        raw_cmd_hash: T.any(Hash, HashExt),
-        opts: T.nilable(T::Hash[Symbol, T::Boolean])
-      ).returns(T::Array[String])
-    end
-    def build(raw_cmd_hash, opts: nil); end
-  end
-
-  sig do
-    params(
-      raw_cmd_hash: T.any(Hash, HashExt),
-      opts: T.nilable(T::Hash[Symbol, T::Boolean])
-    ).void
-  end
-  def initialize(raw_cmd_hash, opts: nil); end
-
-  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(T.self_type) }
-  def with_kebab_case_flags(value = true); end # rubocop:disable Style/OptionalBooleanParameter
-
-  sig { returns(T::Array[String]) }
-  def build; end
-end
-
-class ::Hash
-  sig { params(opts: T.nilable(Hash)).returns(T::Array[String]) }
-  def to_argv(opts = nil); end
-
-  sig { params(options: Hash).returns(T::Array[String]) }
-  def to_argv_bsd(options = {}); end
-end