sonic_pass 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e54fe57c1ce55e0e03cdbbb986680c0fc268a7c31196c84dbc57e38f31f1da
-  data.tar.gz: c3675027fbb267f6427b3161803b677d93402b53b5f56e1c2eb4e1a75f6dc222
+  metadata.gz: 2458e31ed5dacfe4ea786518af9263e3f7201e4fa3796defb99f45503f9e61b3
+  data.tar.gz: e0d9c54cfead25c7ac837a73cdc3c134a7a1c02d996c1ce9f8096699c440cef4
 SHA512:
-  metadata.gz: de2fc1041e31b1a6ad9f4fb543cf4c3278b2630ff2afaacc75bf60dbe924b91c73d270c2adefda26846d68349531b7796eed43d4c717fb8b255fc34400e7d951
-  data.tar.gz: a0c0b8e32b09d15a821decf3bdf488febaaf5db2a78f3cd0a757e59274956b966640b9a7e11a072f14b691b98c88904d6e88a855d1838bdd64b0001cb57eac1b
+  metadata.gz: de39af42150ca51471aaef119a60f81bd761add3ba9226bed5590605309f96fed4c32713ba09fc7fb6fcb71481b8b659db9d1f5cd3ba03ab8fc90c402ba63806
+  data.tar.gz: 74fcf7d2699ead5d9eb03939093adae22fd4206d5463b8948ae16e7c6c9b8046a7e18bf5f01a4616a002457a3df31d219baf54d77094d30ae078e15efde7aaf4

data/README.md

@@ -1,39 +1,110 @@
-# SonicPass
+![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)
 
-TODO: Delete this and the text below, and describe your gem
+Table of Contents
+-----------------
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sonic_pass`. To experiment with that code, run `bin/console` for an interactive prompt.
+* [Overview](#overview)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Contributing](#contributing)
+* [License](#license)
 
-## Installation
+### Overview
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Sonic Pass is a Ruby gem designed to generate strong, unique passwords. It provides a simple and efficient way to create passwords of varying lengths, making it an ideal tool for developers and users alike.
 
-Install the gem and add to the application's Gemfile by executing:
+### Installation
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+To install the Sonic Pass gem, run the following command in your terminal:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install sonic_pass
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Alternatively, you can add the following line to your Gemfile:
 
-## Usage
+```ruby
+gem 'sonic_pass'
+```
 
-TODO: Write usage instructions here
+Then, run `bundle install` to install the gem.
 
-## Development
+### Usage
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To use the Sonic Pass gem, simply require it in your Ruby file:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+require 'sonic_pass'
+```
 
-## Contributing
+You can then generate a password using the `SonicPass.generate` method:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sonic_pass. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sonic_pass/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+password = SonicPass.generate
+puts password
+# cpzmh3OV\",C7
+```
 
-## License
+Or you can generate multiple passwords, using `count > 1` params
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+passwords = SonicPass.generate(12, 5)
+puts passwords
+# ,Y36.9H-XqS;
+# vRzCyIq.=$W5
+# 1}-'D*'ya$Vg
+# %66db&y$rjhU
+# x';2I7y$<&5f
+```
 
-## Code of Conduct
+### How to use CLI command `sonic_pass`
 
-Everyone interacting in the SonicPass project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sonic_pass/blob/master/CODE_OF_CONDUCT.md).
+- Put executable path into `PATH` directly
+
+```bash
+gem_bin_path=$(gem env | grep "EXECUTABLE DIRECTORY" | awk -F ': ' '{print $2}')
+export PATH="$PATH:$gem_bin_path"
+```
+
+- 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
+```
+
+
+For zsh (usually ~/.zshrc):
+
+```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
+
+Contributions to the Sonic Pass gem are welcome. To contribute, please fork the repository and submit a pull request with your changes.
+
+### License
+
+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.0'
+  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.0
+  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