randpass 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a815400cfb4c02a5d4fa1f8b1ff46f1b09d37233e03aa4972d040b11dbaf29c
-  data.tar.gz: 755cb66daeb5b6e9fe899daa0e79fe4dd2cd532fbdb919d24b5d66451387b673
+  metadata.gz: 64d1df5909d0a6d92321fddb99e997280e97ca98b02b96ba58e3a22e95ba6ff1
+  data.tar.gz: 020db401b7394baf1edeb26c224bba110ea61216dd5d2f0b56df8486fe5b8ed5
 SHA512:
-  metadata.gz: cd1fb7172ac42c415ab542655b0171a8d610d20e215034f78777e9237a3d3d88161aa8b42f4a9f4c52515853e0c65cf839663d44b10ef9ff8b78b1ff7fe68810
-  data.tar.gz: 9dfdd7b36a6dde71d99bc044c74d23628c1adbf88a6fe5171001c0842486d817da53490a5ffd3162cdf105e03a449f4432b96ce0ed46103e7e77df1d2e344499
+  metadata.gz: 1a38b3a3e9d8f19ef6759b5d031b7f41a657930d98bf56835887cc1b6e789ba8d3a0dfc03ba1d4bb5db46efaebc39a79cc2e936ba04d4f8d7de3e130b2c681e5
+  data.tar.gz: 728d609352f004349c6bb8a8c62101973378febfe200f815c4a8ac30d9c5c30f7a433c022d02827123106aaf4d588e933afec61ece7da14817e762dac65ce31c

data/README.md

@@ -5,23 +5,29 @@ Create random password with ruby. Use `SecureRandom#base64` + few random special
 ## How to install
 
  - install from rubygems
+
 ```
 gem install randpass
 ```
  - download from github with ssh
+
 ```
 git clone git@github.com:alx3dev/randpass \
 cd randpass && bundle install
 ```
  - download from github with https
+
 ```
 git clone https://www.github.com/alx3dev/randpass \
 cd randpass && bundle install
 ```
 
+To build your own gem, run `rake bundle`, and install it locally with `gem install pkg/randpass-0.1.1.gem`
+
 ## How to use:
 
  - use from terminal
+
 ```
 # default 18 characters
 randpass
@@ -31,10 +37,11 @@ randpass
 randpass 30
  => zBv2BXVB/X2WJMqzSE%VRe#Sg!/0_wYpvJC1gyHU
  
- # if you not install from rubygems, you need to run
+ # install from rubygems, or build your own version, otherwise you need to run:
  bin/randpass
 ```
  - use as library
+
 ```ruby
 require 'randpass'
 
@@ -43,4 +50,22 @@ Randpass[20]
 Randpass.randpass 20
  => "0!ZNiAUZCbjo!#hHeX+XX$eAC=!p"
 ```
-Randpass is a module, so you can include/extend it in your class, to call `randpass` method.
+
+Randpass is a module with both class and instance methods `#randpass`, so you can include/extend it in your class.
+
+```ruby
+require 'randpass'
+include Randpass
+
+class MyClass
+  def some_method
+    random_string = randpass 33
+  end
+end
+```
+
+Tested on:
+ - ruby `2.7.5`
+ - ruby `3.0.3`
+ - ruby `3.1.0-preview1`
+ - jruby `9.3.2.0`

data/lib/randpass/random.rb

@@ -2,20 +2,35 @@
 
 require 'securerandom'
 
-# Generate random password with base64 and few random special characters
+# Generate random password with SecureRandom#base64 and a few
+# random special characters. Method #randpass is defined as
+# class and instance method, so you can call it or include it.
+#
+# @note Always shuffle #base64 if it has less than 16 chars, because they end with '=='
 #
 module Randpass
+  #
+  # Random number of times try to add random special character.
+  # Transform to array, shuffle, and join back to string
+  #
+  # @param [Integer] number_of_chars **Required**. Number of password characters.
+  # @return [String]
+  #
+  def randpass(number_of_chars)
+    Randpass[number_of_chars]
+  end
+
   class << self
-    #
-    # Add special characters to base64 random string, and shuffle it
-    # @note Always shuffle #base64 if it has less than 16 chars, because they end with '=='
-    #
-    def [](number_of_chars = 18)
+    # @return [String]
+    def randpass(number_of_chars)
       param = SecureRandom.base64(number_of_chars)
-      rand(5..10).times { param = add_special_chars(param) }
+      rand(5..10).times do
+        param = add_special_chars(param)
+      end
       param.split('').shuffle.join
     end
-    alias randpass []
+
+    alias [] randpass
 
     private
 
@@ -24,6 +39,7 @@ module Randpass
       # bigger number than options - we don't want
       # same number of special chars each time
       count = SecureRandom.random_number 15_000
+
       char = case count
              when 1...1000    then '_'
              when 1000...2000 then '!'
@@ -33,6 +49,7 @@ module Randpass
              when 6000...7000 then '?'
              else return param
              end
+
       param[rand(param.size)] = char
       param
     end

data/lib/randpass/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Randpass
-  VERSION = '0.1.1'
+  # gem version
+  VERSION = '0.1.2'
 end

data/lib/randpass.rb

@@ -2,7 +2,3 @@
 
 require_relative 'randpass/version'
 require_relative 'randpass/random'
-
-module Randpass
-  class Error < StandardError; end
-end

data/randpass.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
                 README.md
                 randpass.gemspec]
 
-  s.required_ruby_version = '>= 2.7', '< 3.2'
+  s.required_ruby_version = '>= 2.6', '< 3.2'
 
   s.add_development_dependency 'bundler', '~> 2.3'
   s.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: randpass
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-20 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,7 +62,7 @@ metadata:
   source_code_uri: https://github.com/alx3dev/randpass
   bug_tracker_uri: https://github.com/alx3dev/randpass/issues
   changelog_uri: https://github.com/alx3dev/randpass/changelog.md
-  documentation_uri: https://rubydoc.info/gems/randpass/0.1.1
+  documentation_uri: https://rubydoc.info/gems/randpass/0.1.2
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -72,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '3.2'