sonic_pass 0.2.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e4a2e45c294c05b0f9a731d4b1ea486a682b48ccf88bee3704bd173852980c
-  data.tar.gz: a584318ca8872d323452cdb483951aa6476fb29b9ddfd15290855fe69ea2763d
+  metadata.gz: a1c4a6286b2d93f78db52e719f7f28f702751c9240b30ec4a2ecad442d0d68f6
+  data.tar.gz: '089e15a109f23d546ed21716560df086e99af335bf3cc292ad6d6eb0e252d300'
 SHA512:
-  metadata.gz: 4dacbdd5965f0ff8c1058910094392eb38a021c8d52b8da3aed02f24fba1c149628c70314650f31d762e20587df71373a80ce65f3b12751499b8b3d74c8fd2ee
-  data.tar.gz: 399abfa3c530b420ad42823c6a7ac5a3460c371fe147a441062465333b9816e9013ef294671efa899b52a65fb5f537f46d5a7c9fb05ec9fccc1929a5f68c4927
+  metadata.gz: 4250bd1b0bad9e1303767162a0dcc11abd2f3ca2c8cb83840cdfae30194389ecfdc7312c5172797d698dceaeb6299df14aed2d10f79ea62c65235cbd06db9008
+  data.tar.gz: aff82dfb93cefa920c3b852aab3b797398e6c067e245d85d643e7af541e16d27f8368d760ebe5a52221f3d04a737c3feaac2ea43636fe87096186030826ce590

data/.rubocop.yml

@@ -8,12 +8,9 @@ inherit_gem:
   rubocop-rake:
     - config/default.yml
 
+# Rake:
+#   Enabled: true
+
 AllCops:
-  TargetRubyVersion: 3.x
+  DisabledByDefault: true
   NewCops: enable
-
-# Style/StringLiterals:
-#   EnforcedStyle: double_quotes
-
-# Style/StringLiteralsInInterpolation:
-#   EnforcedStyle: double_quotes

data/README.md

@@ -1,11 +1,15 @@
+![Ruby version](https://img.shields.io/badge/ruby-%3E%3D2.4.0-brightgreen?logo=ruby&logoColor=red)
+![RubyGem version](https://img.shields.io/gem/v/sonic_pass?color=%25234cc61f&label=Gem%20version&logo=rubygems&logoColor=red&link=https%3A%2F%2Frubygems.org%2Fgems%2Fsonic_pass)
+![RubyGem download](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)
+![Rubocop](https://img.shields.io/github/actions/workflow/status/papakvy/sonic_pass/main.yml?branch=master&logo=rubocop&logoColor=red&label=Rubocop%20Lint)
+![Test](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 +44,67 @@ require 'sonic_pass'
 You can then generate a password using the `SonicPass.generate` method:
 
 ```ruby
-password = SonicPass.generate(length: 12)
+# Default `length = 12`
+password = SonicPass.generate # equals `SonicPass.generate(12)`
 puts password
+
+# cpzmh3OV\",C7
+```
+
+Or you can generate multiple passwords, using `count > 1` params
+
+```ruby
+passwords = SonicPass.generate(12, 5)
+puts passwords
+
+# ,Y36.9H-XqS;
+# vRzCyIq.=$W5
+# 1}-'D*'ya$Vg
+# %66db&y$rjhU
+# x';2I7y$<&5f
 ```
 
-This will output a strong password of the specified length.
+### How to use CLI command `sonic_pass`
 
-### Configuration
+- Put executable path into `PATH` directly
 
-The Sonic Pass gem can be configured to use different character sets for password generation. The available character sets are:
+```bash
+gem_bin_path=$(gem env | grep "EXECUTABLE DIRECTORY" | awk -F ': ' '{print $2}')
+export PATH="$PATH:$gem_bin_path"
+```
 
-* `ALPHANUMERIC_CHARSETS`: A combination of uppercase letters, lowercase letters, and digits.
-* `SPECIAL_CHARSETS`: A set of special characters.
+- Put executable path into `PATH` in the appropriate configuration file
 
-You can specify the character set to use when generating a password:
+Assume executable path is: `/home/user/.asdf/installs/ruby/3.0.0/bin`
 
-```ruby
-password = SonicPass.generate(length: 12, charset: SonicPass::ALPHANUMERIC_CHARSETS)
-puts password
+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 +112,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

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require_relative '../lib/sonic_pass'
+require_relative '../cli_ext/base'
 require 'clipboard'
 
 length = ARGV[0] ? ARGV[0].to_i : 12
@@ -9,10 +10,14 @@ count  = ARGV[1] ? ARGV[1].to_i : 1
 
 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")
+  begin
+    # puts "#{count} passwords generated:"
+    SonicPass::CLI.call(passwords)
+  rescue StandardError => _e
+    puts passwords.join("\n")
+  end
 end

data/cli_ext/base.rb

@@ -0,0 +1,24 @@
+require 'terminal-table'
+
+module SonicPass
+  class CLI
+
+    def initialize(pwds)
+      @pwds = pwds
+    end
+
+    def self.call(*args, &block)
+      new(*args, &block).print
+    end
+
+    def print
+      rows = @pwds.each_with_index.map { |value, index| [index.next, value] }
+
+      table = Terminal::Table.new :title => "Passwords generated", :rows => rows
+      table.align_column(1, :center)
+      table.align_column(2, :center)
+
+      puts table
+    end
+  end
+end

data/lib/sonic_pass/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SonicPass
-  VERSION = '0.2.1'
+  VERSION = '1.0.1'
 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,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sonic_pass
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.1
 platform: ruby
 authors:
 - papakvy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -43,6 +57,7 @@ files:
 - bin/console
 - bin/setup
 - bin/sonic_pass
+- cli_ext/base.rb
 - lib/sonic_pass.rb
 - lib/sonic_pass/version.rb
 - sig/sonic_pass.rbs
@@ -62,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="