sonic_pass 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e4a2e45c294c05b0f9a731d4b1ea486a682b48ccf88bee3704bd173852980c
-  data.tar.gz: a584318ca8872d323452cdb483951aa6476fb29b9ddfd15290855fe69ea2763d
+  metadata.gz: 2458e31ed5dacfe4ea786518af9263e3f7201e4fa3796defb99f45503f9e61b3
+  data.tar.gz: e0d9c54cfead25c7ac837a73cdc3c134a7a1c02d996c1ce9f8096699c440cef4
 SHA512:
-  metadata.gz: 4dacbdd5965f0ff8c1058910094392eb38a021c8d52b8da3aed02f24fba1c149628c70314650f31d762e20587df71373a80ce65f3b12751499b8b3d74c8fd2ee
-  data.tar.gz: 399abfa3c530b420ad42823c6a7ac5a3460c371fe147a441062465333b9816e9013ef294671efa899b52a65fb5f537f46d5a7c9fb05ec9fccc1929a5f68c4927
+  metadata.gz: de39af42150ca51471aaef119a60f81bd761add3ba9226bed5590605309f96fed4c32713ba09fc7fb6fcb71481b8b659db9d1f5cd3ba03ab8fc90c402ba63806
+  data.tar.gz: 74fcf7d2699ead5d9eb03939093adae22fd4206d5463b8948ae16e7c6c9b8046a7e18bf5f01a4616a002457a3df31d219baf54d77094d30ae078e15efde7aaf4

data/README.md

@@ -1,11 +1,14 @@
+![Gem](https://img.shields.io/gem/v/sonic_pass?color=%25234cc61f&label=Gem%20version&logo=ruby&logoColor=red&link=https%3A%2F%2Frubygems.org%2Fgems%2Fsonic_pass)
+![Gem](https://img.shields.io/gem/dt/sonic_pass?color=%2330c754&label=Downloads&logo=rubygems&logoColor=red&link=https%3A%2F%2Frubygems.org%2Fgems%2Fsonic_pass)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/papakvy/sonic_pass/main.yml?branch=master&logo=rubocop&logoColor=red&label=Rubocop%20Lint)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/papakvy/sonic_pass/main.yml?branch=master&logo=rubocop&logoColor=red&label=Tests%20%F0%9F%A7%AA)
+
 Table of Contents
 -----------------
 
 * [Overview](#overview)
 * [Installation](#installation)
 * [Usage](#usage)
-* [Configuration](#configuration)
-* [Methods](#methods)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -40,31 +43,63 @@ require 'sonic_pass'
 You can then generate a password using the `SonicPass.generate` method:
 
 ```ruby
-password = SonicPass.generate(length: 12)
+password = SonicPass.generate
 puts password
+# cpzmh3OV\",C7
 ```
 
-This will output a strong password of the specified length.
+Or you can generate multiple passwords, using `count > 1` params
 
-### Configuration
+```ruby
+passwords = SonicPass.generate(12, 5)
+puts passwords
+# ,Y36.9H-XqS;
+# vRzCyIq.=$W5
+# 1}-'D*'ya$Vg
+# %66db&y$rjhU
+# x';2I7y$<&5f
+```
 
-The Sonic Pass gem can be configured to use different character sets for password generation. The available character sets are:
+### How to use CLI command `sonic_pass`
 
-* `ALPHANUMERIC_CHARSETS`: A combination of uppercase letters, lowercase letters, and digits.
-* `SPECIAL_CHARSETS`: A set of special characters.
+- Put executable path into `PATH` directly
 
-You can specify the character set to use when generating a password:
+```bash
+gem_bin_path=$(gem env | grep "EXECUTABLE DIRECTORY" | awk -F ': ' '{print $2}')
+export PATH="$PATH:$gem_bin_path"
+```
 
-```ruby
-password = SonicPass.generate(length: 12, charset: SonicPass::ALPHANUMERIC_CHARSETS)
-puts password
+- Put executable path into `PATH` in the appropriate configuration file
+
+Assume executable path is: `/home/user/.asdf/installs/ruby/3.0.0/bin`
+
+For bash (usually ~/.bashrc or ~/.bash_profile):
+
+```bash
+echo 'export PATH="$PATH:/home/user/.asdf/installs/ruby/3.0.0/bin"' >> ~/.bashrc
+source ~/.bashrc
 ```
 
-### Methods
 
-The Sonic Pass gem provides the following methods:
+For zsh (usually ~/.zshrc):
 
-* `SonicPass.generate(length: 12, charset: SonicPass::ALPHANUMERIC_CHARSETS)`: Generates a strong password of the specified length using the specified character set.
+```bash
+echo 'export PATH="$PATH:/home/user/.asdf/installs/ruby/3.0.0/bin"' >> ~/.zshrc
+source ~/.zshrc
+```
+
+Verify the change: After updating your configuration file, you can check if the new path has been added by running:
+
+```bash
+echo $PATH
+```
+
+Finally, run CLI command:
+
+```bash
+sonic_pass
+# Password: mM>]3ERLlD5L copied to clipboard
+```
 
 ### Contributing
 
@@ -72,4 +107,4 @@ Contributions to the Sonic Pass gem are welcome. To contribute, please fork the
 
 ### License
 
-The Sonic Pass gem is released under the MIT License. See the LICENSE file for details.
+The Sonic Pass gem is released under the MIT License. See the LICENSE file for details.

data/bin/sonic_pass

@@ -11,8 +11,8 @@ passwords = SonicPass.generate(length, count)
 
 # Copy the generated password to the clipboard
 if count == 1
-  Clipboard.copy(passwords[0])
-  puts "Password: #{passwords[0]} copied to clipboard"
+  Clipboard.copy(passwords)
+  puts "Password: #{passwords} copied to clipboard"
 else
   puts passwords.join("\n")
 end

data/lib/sonic_pass/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SonicPass
-  VERSION = '0.2.1'
+  VERSION = '1.0.0'
 end

data/lib/sonic_pass.rb

@@ -20,6 +20,8 @@ module SonicPass
   # @param count [Integer] The number of passwords to generate. Defaults to 1.
   # @return [Array<String>] An array of strong passwords of the specified length.
   def self.generate(length = 12, count = 1)
-    Array.new(count) { (Array.new(length) { CHARSETS.sample }).join }
+    passwords = Array.new(count) { (Array.new(length) { CHARSETS.sample }).join }
+
+    count == 1 ? passwords[0] : passwords
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic_pass
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - papakvy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard