secure-keys 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb9a148f4ac19f7be01927996960b0020bbcacbcf7fb7b96638782103f966e1
-  data.tar.gz: 558cb14cab97a77d118ef1b21f4c45501eb98a078d05e02e1898181d9cf7c214
+  metadata.gz: 8cd5c377f201fdb4fd22802645629371e0846768d444398b5fc8de07152edb58
+  data.tar.gz: 845e7fb862ec80987753479bfba9b978336c3090123c41b7dac765ec20a1465b
 SHA512:
-  metadata.gz: df3de7c5d209a1b5d6f6193b1100d09ec5bfd74fb34ad67dd0612d31d72ba12d59b8ab2d340967ebea5db2090f92ad70d2e6bb3cba9638f99351cb404be5ad8c
-  data.tar.gz: 3f0b41426c81b87caa9326b81c92ef28bd508abae330813249c37ffe6cd43c1504d2310f77b463ae51d8079fe59b72a342d5e31ea9be64d5acba77db6a43e2c3
+  metadata.gz: 301b39d752b908b2f8817223a74ee84d8f08a9e3da3f7c41be022d03f392af2a0cb0dd2a320ed73e0c643536826606dad87a9c384da4c3c58c2e2e1af8149c6c
+  data.tar.gz: bd83843339d9169c06e80e31ed3b0fb98f574cd2367001158e668ae38534cc287f8f959b57fbadf343da89e9ddd216f89952c2289a489a9843dbd6ab2bff80ba

data/README.md

@@ -128,6 +128,33 @@ Using bundler:
 bundle exec secure-keys
 ```
 
+To get more information about the command, you can use the `--help` option.
+
+```bash
+secure-keys --help
+
+# Output
+
+Usage: secure-keys [--options]
+
+    -h, --help                       Use the provided commands to select the params
+    -d, --delimiter DELIMITER        The delimiter to use for the key access (default: ",")
+    -i, --identifier IDENTIFIER      The identifier to use for the key access (default: "secure-keys")
+    -v, --version                    Show the secure-keys version
+```
+
+To avoid defining the `SECURE_KEYS_IDENTIFIER` and `SECURE_KEYS_DELIMITER` env variables, you can use the `--identifier` and `--delimiter` options.
+
+```bash
+secure-keys --identifier "your-keychain-or-env-variable-identifier" --delimiter "|"
+```
+
+Also, you can use the short options:
+
+```bash
+secure-keys -i "your-keychain-or-env-variable-identifier" -d "|"
+```
+
 ### iOS project
 
 Within the iOS project, you can use the `SecureKeys` target dependency like:
@@ -189,7 +216,7 @@ The process when the script is executed is:
 
 1. Create a `.secure-keys` directory.
 2. Create a temporary `Swift Package` in the `.secure-keys` directory.
-3. Copy the `Keys` source code to the temporary `Swift Package`.
+3. Copy the `SecureKeys` source code to the temporary `Swift Package`.
 
    ```swift
    public enum SecureKey {

data/lib/core/console/arguments/handler.rb

@@ -0,0 +1,30 @@
+module SecureKeys
+  module Core
+    module Console
+      module Argument
+        class Handler
+          class << self
+            attr_reader :arguments
+          end
+
+          # Configure the default arguments
+          @arguments = {
+            delimiter: nil,
+            identifier: nil,
+          }
+
+          # Fetch the argument value by key
+          # from CLI arguments or environment variables
+          #
+          # @param key [Symbol] the argument key
+          # @param default [String] the default value
+          #
+          # @return [String] the argument value
+          def self.fetch(key:, default: nil)
+            @arguments[key.to_sym] || ENV.fetch("secure_keys_#{key}".upcase, nil) || default
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core/console/arguments/parser.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../../globals/globals'
+require_relative './handler'
+
+module SecureKeys
+  module Core
+    module Console
+      module Argument
+        class Parser < OptionParser
+          # Initialize the argument parser with the default options
+          def initialize
+            super('Usage: secure-keys [--options]')
+            separator('')
+
+            # Configure the arguement parser
+            configure!
+            parse!(into: Handler.arguments)
+          end
+
+          private
+
+          # Configure the argument parser
+          def configure!
+            on('-h', '--help', 'Use the provided commands to select the params') do
+              puts self
+              exit(0)
+            end
+
+            on('-d', '--delimiter DELIMITER', String, "The delimiter to use for the key access (default: \"#{Globals.default_key_delimiter}\")")
+            on('-i', '--identifier IDENTIFIER', String, "The identifier to use for the key access (default: \"#{Globals.default_key_access_identifier}\")")
+
+            on('-v', '--version', 'Show the secure-keys version') do
+              puts "secure-keys version: v#{SecureKeys::VERSION}"
+              exit(0)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core/globals/globals.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require_relative '../console/arguments/handler'
+
 module SecureKeys
   module Globals
     module_function
@@ -40,7 +42,15 @@ module SecureKeys
     # Returns the identifier to get all the key names
     # @return [String] key access identifier
     def key_access_identifier
-      ENV['SECURE_KEYS_IDENTIFIER'] || default_key_access_identifier
+      Core::Console::Argument::Handler.fetch(key: :identifier,
+                                             default: default_key_access_identifier)
+    end
+
+    # Returns the keys delimiter
+    # @return [String] keys delimiter
+    def key_delimiter
+      Core::Console::Argument::Handler.fetch(key: :delimiter,
+                                             default: default_key_delimiter)
     end
 
     # Returns the default key access identifier
@@ -49,12 +59,6 @@ module SecureKeys
       'secure-keys'
     end
 
-    # Returns the keys delimiter
-    # @return [String] keys delimiter
-    def key_delimiter
-      ENV['SECURE_KEYS_DELIMITER'] || default_key_delimiter
-    end
-
     # Returns the default keys delimiter
     # @return [String] default keys delimiter
     def default_key_delimiter

data/lib/keys.rb

@@ -8,6 +8,7 @@ require_relative './core/utils/swift/package'
 require_relative './core/utils/swift/swift'
 require_relative './core/utils/swift/xcframework'
 require_relative './core/utils/openssl/cipher'
+require_relative './core/console/arguments/parser'
 
 module SecureKeys
   class Generator
@@ -18,8 +19,8 @@ module SecureKeys
     public
 
     def initialize
-      # If the secure keys identifier is not set, set it to 'secure-keys'
-      ENV['SECURE_KEYS_IDENTIFIER'] = 'secure-keys' unless ENV.key?('SECURE_KEYS_IDENTIFIER')
+      # Configure the argument parser
+      SecureKeys::Core::Console::Argument::Parser.new
 
       puts "🔔 You're using a custom delimiter '#{SecureKeys::Globals.key_delimiter}'" unless SecureKeys::Globals.key_delimiter.eql?(SecureKeys::Globals.default_key_delimiter)
       puts "🔔 You're using a custom key access identifier '#{SecureKeys::Globals.key_access_identifier}'" unless SecureKeys::Globals.key_access_identifier.eql?(SecureKeys::Globals.default_key_access_identifier)

data/lib/version.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 module SecureKeys
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
   SUMMARY = 'Secure Keys is a simple tool for managing your secret keys'.freeze
   DESCRIPTION = 'Secure Keys is a simple tool to manage your secret keys in your iOS project'.freeze
   HOMEPAGE_URI = 'https://github.com/DerianCordobaPerez/secure-keys-generator'.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secure-keys
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Derian Córdoba
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.10.1
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: osx_keychain
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +116,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- "./lib/core/console/arguments/handler.rb"
+- "./lib/core/console/arguments/parser.rb"
 - "./lib/core/environment/ci.rb"
 - "./lib/core/environment/keychain.rb"
 - "./lib/core/globals/globals.rb"