pass 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4c0d21c2d761abefac101b65714ce241d2a8450d
-  data.tar.gz: ae1a4f552e22f3786e8dde74dc4481eda7710163
+SHA256:
+  metadata.gz: 12c7cafaf8a91ed0368e4614da00d55b6523851122a14330daf44a5fbcf7637c
+  data.tar.gz: 3e591a5f56b686d273aafbadf40da32e3a70a0a16f9f97e832db5a6347896a92
 SHA512:
-  metadata.gz: 5bff40017f7c2f257877f6b8ad3475cc3f26298c3d5a28d5925fa8887222c2427ace2e090cf7dabeba1291fc053eb9d4ad343747fc3b31179c02f504f2d2f2b3
-  data.tar.gz: 241aeafbeeefe989c0d2894f051387bcba20f45bc8ca545cb9df833c29339ade99e084a91d027112521eccdc60dbec409826efd751a8d8766f6421bf31cd1ac2
+  metadata.gz: 17be1cb82ca32d01d359d11fd14bde4b93a4f6efe956396415c12e54c06a0fbed66b2978047db3ddc8ffe3b4ea9a6710020609483d19336ac627abc531dd45fc
+  data.tar.gz: ee878a0713c20dfcdc3a349f2951df271503bb86174b7024d38490b9ff10393cd8be58a4c5124e4c42e32459883e8489f17542f1bab30193841fd451e5b8f774

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '2.5', '2.6', '2.7', '3.0', '3.1' ]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+      # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests for ${{ matrix.ruby }}
+      run: bundle exec rake

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .DS_Store
+/.idea/

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pass.gemspec
 gemspec
+
+ruby '>= 2.5'
+
+group :development do
+  gem 'rubocop', '~> 1.16.0'
+end

data/README.md

@@ -1,45 +1,65 @@
-# Pass
+# pass
 
 [![Gem Version](https://badge.fury.io/rb/pass.svg)](https://badge.fury.io/rb/pass)
-[![Build Status](https://travis-ci.org/krhitoshi/pass.svg?branch=master)](https://travis-ci.org/krhitoshi/pass)
+![Testing workflow](https://github.com/krhitoshi/pass/workflows/Testing%20workflow/badge.svg)
 
 ## Description
 
-Pass is a command-line tool to generate random passwords.
+The 'pass' command generates random passwords.
 
 ## Installation
 
-The first step is to install the gem
+All you have to do is to install the gem
 
 ```
-  gem install pass
+$ gem install pass
 ```
 
 ## Usage
 
-You can run Pass to generate one random password. A generated password has 12 characters with more than one upper case letter, lower case letter, and numeric character.
+You can run 'pass' to generate one random password.
+Generated passwords have 20 characters and does not include ambiguous characters ``l o I O 1 " ' ` |``.
+As default, a password consists of upper case letters, lower case letters, and numbers.
 
 ```
-  pass
+$ pass
 ```
 
 If you need more passwords, you can specify the number of passwords.
 
 ```
-  pass 12
+$ pass 12
 ```
 
-You can specify the password length by -c option.
+You can specify the password length with -l or --length option.
 
 ```
-  pass -c 18
+$ pass -l 30
+$ pass --length 50
+```
+
+You can use -s or --symbols option to include symbols in passwords.
+
+```
+$ pass -s
+$ pass --symbols
+```
+
+You can specify certain characters you don't want to put in passwords with -e or --exclude option.
+
+```
+$ pass -e 'ABCD678'
+$ pass --symbols --exclude '*[]{}/\'
 ```
 
 ## Options
 
 ```
-  -c NUM                           specify password length
-  -v, --version                    show version
+-c [NUMBER]                      (deprecated) specify password length
+-l, --length [NUMBER]            specify password length
+-s, --symbols                    include symbols
+-e, --exclude [CHARACTERS]       exclude characters
+-v, --version                    show version
 ```
 
 ## License

data/exe/pass

@@ -3,6 +3,6 @@
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'rubygems'
-require 'pass'
+require 'pass/cli'
 
-Pass.new.exec(ARGV)
+Pass::CLI.new.exec(ARGV)

data/lib/pass/cli.rb

@@ -0,0 +1,77 @@
+require 'optparse'
+require 'pass'
+require 'pass/version'
+
+class Pass
+  class CLI
+    class Error < StandardError; end
+
+    def exec(argv)
+      options = {}
+      options[:length] = Pass::DEFAULT_PASSWORD_LENGTH
+
+      opts = OptionParser.new
+
+      opts.on('-c [NUMBER]', '(deprecated) specify password length') do |value|
+        options[:length] = option_to_i(value)
+      end
+
+      opts.on('-l', '--length [NUMBER]', 'specify password length') do |value|
+        options[:length] = option_to_i(value)
+      end
+
+      opts.on('-s', '--symbols', 'include symbols') do |value|
+        options[:symbols] = value
+      end
+
+      opts.on('-e', '--exclude [CHARACTERS]', 'exclude characters') do |value|
+        options[:exclude] = value
+      end
+
+      opts.on_tail('-v', '--version', 'show version') do
+        puts "pass #{Pass::VERSION}"
+        exit 0
+      end
+
+      opts.banner = banner
+
+      begin
+        res_argv = opts.parse!(argv)
+        num_passwords = if res_argv[0]
+                          option_to_i(res_argv[0])
+                        else
+                          Pass::DEFAULT_NUM_PASSWORDS
+                        end
+
+        pass = Pass.new(**options)
+
+        num_passwords.times do
+          puts pass.generate
+        end
+      rescue Pass::Error, Pass::CLI::Error, OptionParser::ParseError => e
+        abort "Error: #{e.message}"
+      end
+
+      exit 0
+    end
+
+    private
+
+    def option_to_i(opt)
+      Integer(opt)
+    rescue ArgumentError => _e
+      raise Error, "the option must be an integer: '#{opt}'"
+    end
+
+    def banner
+      <<~BANNER
+        Usage: pass [options] [number of passwords]
+
+        Description:
+          The 'pass' command generates random passwords.
+
+        Options:
+      BANNER
+    end
+  end
+end

data/lib/pass/version.rb

@@ -1,3 +1,3 @@
 class Pass
-  VERSION = "0.0.5"
+  VERSION = '0.0.6'
 end

data/lib/pass.rb

@@ -1,109 +1,72 @@
-require 'optparse'
-require 'pass/version'
-
 class Pass
-  MIN_NUM_CHARACTERS = 3
-  NUM_CHARACTERS = 12
+  MIN_PASSWORD_LENGTH     = 5
+  DEFAULT_NUM_PASSWORDS   = 1
+  DEFAULT_PASSWORD_LENGTH = 20
 
-  class Error < StandardError; end
+  ALPHABETIC_CHARS = ('a'..'z').to_a + ('A'..'Z').to_a
+  NUMERIC_CHARS    = ('1'..'9').to_a
+  SYMBOL_CHARS     = ('!'..'/').to_a + (':'..'@').to_a + ('['..'`').to_a + ('{'..'~').to_a
+  AMBIGUOUS_CHARS  = %w[l o I O 1 " ' ` |]
 
-  def initialize
-    @list_carachters = ('a'..'z').to_a + ('A'..'Z').to_a + ('1'..'9').to_a - %w[l o I O 1]
-    @num_iteration = 100
+  class Error < StandardError; end
 
-    # Password must include digit, upper case, and lower case.
-    @validation_regexps = [/\d/, /[a-z]/, /[A-Z]/]
+  def initialize(**options)
+    @options = { length: DEFAULT_PASSWORD_LENGTH }
+    @options.update(options)
   end
 
-  def generate(num = NUM_CHARACTERS)
-    if !integer?(num) || num < MIN_NUM_CHARACTERS
-      raise Pass::Error, "Invalid Argument: number of characters should be more than #{MIN_NUM_CHARACTERS}."
-    end
+  def char_list
+    list = ALPHABETIC_CHARS + NUMERIC_CHARS
 
-    @num_iteration.times do
-      rest_num = num
-      pass = ""
-      while rest_num > list_size do
-        pass += generate_password(list_size)
-        rest_num -= list_size
-      end
-      pass += generate_password(rest_num)
-      return pass if valid?(pass)
-    end
-    raise Pass::Error, "Not Converged: #{@num_iteration} times"
-  end
+    list += SYMBOL_CHARS if @options[:symbols]
 
-  def valid?(pass)
-    @validation_regexps.all?{|reg| reg =~ pass}
-  end
+    list -= exclude_char_list
 
-  def multi_generate(num_password, num_character = NUM_CHARACTERS)
-    passwords = []
-    num_password.times do
-      passwords << generate(num_character)
-    end
-    passwords
+    list
   end
 
-  def Pass.generate(num = NUM_CHARACTERS)
-    Pass.new.generate(num)
+  def exclude_char_list
+    list = AMBIGUOUS_CHARS
+    list += @options[:exclude].split(//).sort.uniq if @options[:exclude]
+    list
   end
 
-  def exec(argv)
-    num_characters = NUM_CHARACTERS
-    opts = OptionParser.new
-    opts.on('-c NUM', 'specify password length') do |value|
-      num_characters = value
-    end
-    opts.on_tail('-v', '--version', 'show version') do
-      puts "#{self.class.name} #{version}"
-      exit 0
-    end
-    opts.banner = <<END
-Usage: pass [options] [number of passwords]
-
-Description:
-  Generates random passwords.
-
-Options:
-END
-    begin
-      res_argv = opts.parse!(argv)
-      num_times = res_argv[0] || 1
-      puts multi_generate(num_times.to_i, num_characters.to_i)
-    rescue SystemExit
-    rescue Exception => e
-      $stderr.puts "Error: #{e.message}"
-      exit 1
+  def generate
+    length = @options[:length]
+
+    if length < MIN_PASSWORD_LENGTH
+      raise Pass::Error,
+            "Invalid Argument: password length must be more than #{MIN_PASSWORD_LENGTH}."
     end
-    exit 0
-  end
 
-  def num_iteration
-    @num_iteration
-  end
+    rest_length = length
+    result = ""
+    # append append password string until 'result' reaches the 'length'
+    while rest_length > char_list_size
+      result += generate_password_base(char_list_size)
+      rest_length -= char_list_size
+    end
+    result += generate_password_base(rest_length)
 
-  def num_iteration=(value)
-    raise(Error, "Invalid Argument: num_iteration #{value}") if !integer?(value) || value <= 0
-    @num_iteration = value
+    result
   end
 
-  def version
-    VERSION
+  def self.generate(num = DEFAULT_PASSWORD_LENGTH)
+    new(length: num).generate
   end
 
   private
-  def integer?(value)
-    value.kind_of?(Integer)
-  end
 
-  def list_size
-    @list_carachters.size
+  def char_list_size
+    char_list.size
   end
 
-  def generate_password(num)
-    raise ArgumentError, "argument must be less than #{list_size}" if num > list_size
-    @list_carachters.sample(num).join
-  end
+  # generate a password that is long less than 'char_list_size'
+  def generate_password_base(length)
+    if length > char_list_size
+      raise ArgumentError, "argument must be less than #{char_list_size}"
+    end
 
+    char_list.sample(length).join
+  end
 end

data/pass.gemspec

@@ -21,8 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pass
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Hitoshi Kurokawa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,9 +60,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -85,13 +71,14 @@ files:
 - bin/setup
 - exe/pass
 - lib/pass.rb
+- lib/pass/cli.rb
 - lib/pass/version.rb
 - pass.gemspec
 homepage: http://github.com/krhitoshi/pass
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,9 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Password Generator (CLI)
 test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.0.0-p648
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-before_install: gem install bundler -v 1.13.5