argvise 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96b6f0c2b58c2c978c647f988896d96377fa798b5df00eb372d8f2c13de6d479
-  data.tar.gz: ebdd6ef0219a35ab0c585f9310be93ac6f8a22b6376289002b8c414e4ffa6b4e
+  metadata.gz: e698d11b5f582bd557fd6f4d1a1d2d9f9cda5512d2ba26af3e59d803016093a8
+  data.tar.gz: 182e7a4cad5e576575335d22413eac4868c8ab7f993c17d9f344f898d8e86291
 SHA512:
-  metadata.gz: 6124154af43827d0b5d65d5c086ecb0941daf7f5b56a35655072ee6ba75486340d0eede11aebeb29e95cf69540cd3932e41f0d498d578e68e8ea580abef9ece2
-  data.tar.gz: 82a72a33658ea1e190a6f16f181e2d4a9f4c6bad414aa815307e4118a45d53624685809488e276ab84609509467b9fa7e7cda4001e89cfb3a428b073de6247a4
+  metadata.gz: 24c9621fa200763a833f02bb019026b8a75b49f0948f88cb765ba38196bd5f1c4406313f8f5d837b70da259cf241a248bee41040615bb7ab354b7e7335ebefdd
+  data.tar.gz: 44e70c7e0b19e25e180e21851b0582e9e3ca1507aab3de9168abd24dff8f0d785087b5a302294046a5a366e6add6a8b3e98579d2573c7a0ed6b1146810aeaed2

data/.rubocop.yml

@@ -1,2 +1,32 @@
+# ln ~/.config/rubocop/config.yml .rubocop.yml
 AllCops:
   TargetRubyVersion: 3.1
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+Lint/RedundantCopDisableDirective:
+  Enabled: false
+Lint/EmptyExpression:
+  # disabled => allow ()
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyle: diff_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyle: diff_comma
+Style/Lambda:
+  EnforcedStyle: literal
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+Style/BlockDelimiters:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_layout.html
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver

data/bin/console.rb

@@ -44,6 +44,7 @@ raw_cmd
 puts_division_line
 # -----------
 
+using Argvise::HashRefin
 puts 'GNU-style + kebab_case_flags(true)'
 raw_cmd
   .to_argv

data/bin/irb.rb

@@ -0,0 +1,10 @@
+#!/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/docs/Readme.md

@@ -23,6 +23,9 @@ raw_cmd_hash = {
   cargo: (), b: (), r: true, target: "wasm32-wasip2"
 }
 
+using Argvise::HashRefin
+  # OR: include Argvise::HashMixin
+
 raw_cmd_hash
   .to_argv
   # .to_argv({bsd_style: false, kebab_case_flags: true})
@@ -183,16 +186,57 @@ Argvise.build(raw_cmd_hash)
 
 ### Shortcut
 
+#### Mixin
+
 ```ruby
-{ v: true, dir: '/path/to/dir' }.to_argv
-# => ["-v", "--dir", "/path/to/dir"]
+require 'argvise'
+
+module A
+  module_function
+  include Argvise::HashMixin
+
+  def demo
+    { path: '/path/to/dir' }.to_argv.then { p it }
+    #=> ["--path", "/path/to/dir"]
+
+    { path: '/path/to/dir' }.to_argv_bsd.then { p it }
+    #=> ["-path", "/path/to/dir"]
+  end
+end
+
+A.demo
+Hash.method_defined?(:to_argv) # => true
+{}.respond_to?(:to_argv) #=> true
+```
+
+#### Refinement
+
+```ruby
+require 'argvise'
+class A
+  using Argvise::HashRefin
+
+  def self.demo
+    { target: "wasm32-wasip2" }.to_argv.then { p it }
+      # => ["--target", "wasm32-wasip2"]
+
+    { target: "wasm32-wasip2" }.to_argv_bsd.then { p it }
+      # => ["-target", "wasm32-wasip2"]
+
+    {}.respond_to?(:to_argv).then { p it } #=> true
+  end
+end
+
+A.demo
+Hash.method_defined?(:to_argv) # => false
+{}.respond_to?(:to_argv) #=> false
 ```
 
 ### Configurable builder
 
 > Required
 >
-> - argvise: >= v0.0.6
+> - argvise: >= v0.0.9
 > - ruby: >= v3.1.0
 
 ```ruby
@@ -225,6 +269,10 @@ raw_cmd
 #=> ["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"]
 
 p '----------------'
+
+# argvise: >= v0.0.9
+using Argvise::HashRefin
+
 p 'GNU-style + kebab-case-flags=true'
 # argvise: >= v0.0.6
 raw_cmd
@@ -235,15 +283,13 @@ raw_cmd
 
 p '----------------'
 p 'BSD-style + kebab-case-flags=true'
-# argvise: >= v0.0.4
+# argvise: >= v0.0.9
 raw_cmd
-  .then(&Argvise.new_proc)
-  .with_bsd_style
-  .with_kebab_case_flags
-  .build
+  .to_argv_bsd
   .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"]
+p '----------------'
 ```
 
 ## Data Type
@@ -302,15 +348,27 @@ raw_cmd
 
 - `{ cargo: () }` => `["cargo"]`
 - `{ cargo: nil, b: nil }` => `["cargo", "b"]`
-- `{ "-fv": nil }` => `["-fv"]`
+- `{ "-fv": () }` => `["-fv"]`
 
 ## Changelog
 
 ### v0.0.6 (2025-11-05)
 
-Breaking Changes:
+Breaking Change:
 
 - `cmd_hash |> hash_to_argv` => `cmd_hash.to_argv(opts)`
-  - i.e.,
-    - old: `{a: true}.then(&hash_to_argv)`
-    - new: `{a: true}.to_argv`
+  - Previous: `{a: true}.then(&hash_to_argv)`
+  - Current: `{a: true}.to_argv`
+
+### v0.0.9 (2025-11-30)
+
+- add refinements for Hash
+- add `Hash#to_argv_bsd`
+
+Breaking Change:
+  - Mitigated side effects introduced by monkey patching.
+    - Previous:
+      - Simply calling `require 'argvise'` was enough to import `Hash#to_argv`;
+      - no explicit `include` or `using` was required.
+    - Current:
+      - We must manually `include Argvise::HashMixin` or `using Argvise::HashRefin` to import `Hash#to_argv`.

data/lib/argvise/core.rb

@@ -216,21 +216,21 @@ class Argvise
   # 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]
+      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"]
+  #     {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|
@@ -241,9 +241,9 @@ class Argvise
 
   # Processes hash values (generates key=value format)
   #
-  # {label: { env: "test", key: "value" }}
-  #   => (flag: "--label", hash)
-  #   => ["--label", "env=test", "--label", "key=value"]
+  #     {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|
@@ -253,30 +253,80 @@ class Argvise
   end
 end
 
-class ::Hash # rubocop:disable Style/Documentation
-  # Converts a hash into command-line arguments
+class Argvise
+  module HashExt # rubocop:disable Style/Documentation
+    # Converts a hash map into GNU-style command-line arguments.
+    #
+    # == Example：
+    #
+    #     require 'argvise'
+    #     using Argvise::HashRefin
+    #
+    #     { 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:)
+    end
+
+    # Converts a hash map into BSD-style command-line arguments.
+    #
+    # == Example：
+    #
+    #     require 'argvise'
+    #     using Argvise::HashRefin
+    #
+    #     { path: '/path/to/dir' }.to_argv_bsd
+    #     #=> ["-path", "/path/to/dir"]
+    #
+    def to_argv_bsd(options = {})
+      # if options is not Hash Type => {}
+      options = {} unless options.is_a?(::Hash)
+
+      opts = options.merge({ bsd_style: true })
+      Argvise.build(self, opts:)
+    end
+  end
+
+  # Converts a hash map into command-line arguments.
   #
   # == Example：
   #
-  #   { v: true, path: '/path/to/dir' }.to_argv
-  #   #=> ["-v", "--path", "/path/to/dir"]
-  #
-  # == params:
+  #     require 'argvise'
   #
-  # - opts: See also [Argvise::new]
+  #     module A
+  #       module_function
+  #       include Argvise::HashMixin
   #
-  # == raw_cmd_hash.to_argv is equivalent to:
+  #       def demo
+  #         puts({ path: '/path/to/dir' }.to_argv)
+  #         #=> ["--path", "/path/to/dir"]
   #
-  #  raw_cmd_hash
-  #    .then(&Argvise.new_proc)
-  #    .with_bsd_style(false)
-  #    .with_kebab_case_flags(true)
-  #    .build
+  #         puts({ path: '/path/to/dir' }.to_argv_bsd)
+  #         #=> ["-path", "/path/to/dir"]
+  #       end
+  #     end
   #
-  # ---
-  #
-  # sig { params(opts: T.nilable(Hash)).returns(T::Array[String]) }
-  def to_argv(opts = nil)
-    Argvise.build(self, opts:)
+  #     A.demo
+  #     Hash.method_defined?(:to_argv) # => true
+  #     {}.respond_to?(:to_argv) #=> true
+  module HashMixin
+    def self.included(_host)
+      ::Hash.include(HashExt)
+    end
   end
 end

data/lib/argvise/refinement.rb

@@ -0,0 +1,37 @@
+# typed: true
+# frozen_string_literal: true
+
+# To maintain `mruby` compatibility, define `private_constant` and
+#  `refinements` in this file rather than in **core.rb**.
+
+class Argvise
+  private_constant :HashExt
+
+  # Refinements: Hash#to_argv, Hash#to_argv_bsd
+  #
+  # = Example
+  #
+  #     require 'argvise'
+  #     class A
+  #       using Argvise::HashRefin
+  #       def self.demo
+  #         puts({ target: "wasm32-wasip2" }.to_argv)
+  #           # => ["--target", "wasm32-wasip2"]
+  #
+  #         puts({ target: "wasm32-wasip2" }.to_argv_bsd)
+  #           # => ["-target", "wasm32-wasip2"]
+  #
+  #         {}.respond_to?(:to_argv) #=> true
+  #       end
+  #     end
+  #
+  #     A.demo
+  #     Hash.method_defined?(:to_argv) # => false
+  #     {}.respond_to?(:to_argv) #=> false
+  #
+  module HashRefin
+    refine ::Hash do
+      import_methods HashExt
+    end
+  end
+end

data/lib/argvise/version.rb

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

data/lib/argvise.rb

@@ -3,3 +3,4 @@
 
 require_relative 'argvise/version'
 require_relative 'argvise/core'
+require_relative 'argvise/refinement'

data/rbi/lib/argvise.rbi

@@ -6,7 +6,7 @@ class Argvise
   class << self
     sig do
       params(
-        raw_cmd_hash: Hash,
+        raw_cmd_hash: T.any(Hash, HashExt),
         opts: T.nilable(T::Hash[Symbol, T::Boolean])
       ).returns(T::Array[String])
     end
@@ -15,7 +15,7 @@ class Argvise
 
   sig do
     params(
-      raw_cmd_hash: Hash,
+      raw_cmd_hash: T.any(Hash, HashExt),
       opts: T.nilable(T::Hash[Symbol, T::Boolean])
     ).void
   end
@@ -34,4 +34,7 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argvise
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - 2moe
@@ -21,9 +21,11 @@ files:
 - 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