pwm 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 189dbb4eaa91cc5fb097644d22f10ee25d20ad9d
-  data.tar.gz: 36bc9792cdc0b9015616475726ffd2f6e077a9bf
+  metadata.gz: 0516128f2c7326827ece168be83d0150566ad4ab
+  data.tar.gz: a177d696b45ffaf3150dd37ed6c92dcd19cbd143
 SHA512:
-  metadata.gz: 260b7f490b18c101b0a5d04b8757a17df69df963cadb125c6e89bf2adeb08de8e0737bc38472752a76ae67384047b4accf243597fdd2dfd3fc01e22d9bc497db
-  data.tar.gz: 2f82eeadb7224e6c4b9107b88e6137df44de0a41e09d7a889bb319be6406f560ad5f84ad7cf26f047f699c0bdc6d4cfdefd02a8675d2cd87af52d02dbb9c0ada
+  metadata.gz: 14a6e31cf9d26a9e8476706f0de518863f766c3eccd66132c90e15b83c10b445e79e18506328ac3a351f2c0282d5d48fcc1f0e09f2ae7bccab7c954efac2ef95
+  data.tar.gz: ef66a41a1138980c4b4f579c21314993972244a637fafae3d346ce3958d51715efee76d54b8ee1bcae049ce38d722d5703141bf17e3df136eabbdea616c3265e

data/.gitignore

@@ -1,7 +1,10 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-.ruby-version
-vendor
-coverage
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rspec

@@ -1 +1,2 @@
---colour --format documentation
+--format documentation
+--color

data/.rubocop.yml

@@ -1,7 +1,5 @@
 AllCops:
-  Excludes:
-    - vendor/**
-Documentation:
-  Enabled: false
-Encoding:
-  Enabled: false
+  Exclude:
+    - vendor/**/*
+LineLength:
+  Max: 104

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.0.0, available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pwm.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,28 @@
+group :fail_fast, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard 'cucumber' do
+    watch(%r{^features/.+\.feature$})
+    watch(%r{^features/support/.+$}) { 'features' }
+
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+      Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
+    end
+  end
+
+  guard :rubocop do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -1,15 +1,50 @@
 # pwm
 
-pwm very simply generates reasonably secure passwords. That's it; that's
-all it does.
+pwm very simply generates reasonably secure passwords. That's it; that's all it
+does.
 
-Passwords are chosen from the set of all upper-case letters except I and
-O, all lower-case letters except l, and the digits 2 through 9. 0 and O
-are not used to avoid confusion with each other. I, l, and 1 are not
-used for the same reason.
+Passwords are chosen from the set of all upper-case letters except I and O, all
+lower-case letters except l, and the digits 2 through 9. 0 and O are not used to
+avoid confusion with each other. I, l, and 1 are not used for the same reason.
 
-Starting with version 1.1.0, passwords are guaranteed to contain at
-least one upper-case letter, one lower-case letter, and one number.
+Starting with version 1.1.0, passwords are guaranteed to contain at least one
+upper-case letter, one lower-case letter, and one number.
+
+## We Interrupt This README.md
+
+pwm is a stable, mature piece of code. It's one that I haven't modified
+significantly in years. Recently, I've become interested in JavaScript and am
+focusing my attention on a JS rewrite called
+[powm](https://github.com/markcornick/powm). Unless some kind of serious bug
+gets found in pwm, I'm unlikely to do any further development on it, or to
+accept pull requests. Please note that pwm is, and has always been, in the
+public domain, so if it doesn't do something you want it to do, I not only don't
+mind if you fork it and make it your own, I urge you to.
+
+In short, I'm closing the book on pwm as far as I'm concerned, but if you want
+to write the next chapter, fork away and do great things with my compliments.
+
+_We now return you to README.md already in progress._
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pwm'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install pwm
+```
 
 ## Usage
 
@@ -38,18 +73,31 @@ $ echo $?
 1
 ```
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests or `rake spec` to run the Cucumber features. You
+can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+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 tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/markcornick/pwm>. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
 ## Author
 
-Mark Cornick <mark@cornick.io>
+Mark Cornick <https://github.com/markcornick>
 
 ## (Lack of) Copyright
 
 To the extent possible under law, Mark Cornick has waived all copyright
 and related or neighboring rights to pwm.
-
-## Flair
-
-[![Build Status][travis-image]][travis-link]
-
-[travis-image]: https://secure.travis-ci.org/markcornick/pwm.png?branch=master
-[travis-link]: http://travis-ci.org/markcornick/pwm

data/Rakefile

@@ -6,6 +6,6 @@ require 'rubocop/rake_task'
 
 Cucumber::Rake::Task.new(:features)
 RSpec::Core::RakeTask.new(:spec)
-Rubocop::RakeTask.new
+RuboCop::RakeTask.new
 
-task :default => [:rubocop, :spec, :features]
+task default: [:spec, :features, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pwm'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/cucumber

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'cucumber' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('cucumber', 'cucumber')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pwm.rb

@@ -1,19 +1,23 @@
 require 'pwm/version'
 
+##
+# This module is the heart of pwm.
 module Pwm
-  # Internal: The exception raised when a requested password length is
-  # too short.
+  ##
+  # The exception raised when a requested password length is too short.
   class TooShortException < Exception; end
 
-  # Internal: The set of characters from which passwords will be assembled.
+  ##
+  # The set of characters from which passwords will be assembled.
   # This could be overridden if you don't like the default.
   #
   # Returns the set of characters as an Array.
   def self.characters
-    (('A'..'Z').to_a  + ('a'..'z').to_a + ('2'..'9').to_a) - %w(I O l)
+    (('A'..'Z').to_a + ('a'..'z').to_a + ('2'..'9').to_a) - %w(I O l)
   end
 
-  # Public: Generate a password.
+  ##
+  # Generate a password.
   #
   # length - The length of the password. Minimum is 8. Default is 16.
   #
@@ -31,7 +35,7 @@ module Pwm
     fail Pwm::TooShortException, "#{length} is too short." if length < 8
     password = ''
     until acceptable?(password)
-      password = (0..length - 1).reduce('') do |pw, n|
+      password = (0..length - 1).reduce('') do |pw, _n|
         pw + characters[rand(characters.length)]
       end
     end
@@ -40,7 +44,8 @@ module Pwm
 
   private
 
-  # Private: Checks if a password is acceptable.
+  ##
+  # Checks if a password is acceptable.
   #
   # password - the password to check
   #
@@ -55,8 +60,6 @@ module Pwm
   # Returns true if password has at least one of each required character
   # class, or false if not.
   def self.acceptable?(password)
-    password.match(/[A-Z]/) &&
-    password.match(/[a-z]/) &&
-    password.match(/[0-9]/)
+    password.match(/[A-Z]/) && password.match(/[a-z]/) && password.match(/[0-9]/)
   end
 end

data/lib/pwm/version.rb

@@ -1,3 +1,5 @@
+##
+# The version of pwm.
 module Pwm
-  VERSION = '1.2.2'
+  VERSION = '1.2.3'
 end

data/pwm.gemspec

@@ -1,25 +1,31 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "pwm/version"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pwm/version'
 
-Gem::Specification.new do |s|
-  s.name        = "pwm"
-  s.version     = Pwm::VERSION
-  s.authors     = ["Mark Cornick"]
-  s.email       = ["mark@cornick.io"]
-  s.homepage    = "https://bitbucket.org/markcornick/pwm"
-  s.summary     = %q{A reasonably secure password maker}
-  s.description = %q{A tiny class and command-line tool to generate reasonably secure passwords.}
+Gem::Specification.new do |spec|
+  spec.name          = 'pwm'
+  spec.version       = Pwm::VERSION
+  spec.authors       = ['Mark Cornick']
+  spec.email         = ['mark@markcornick.com']
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.summary       = 'A reasonably secure password maker'
+  spec.description   = 'A tiny class and command-line tool to generate reasonably secure passwords.'
+  spec.homepage      = 'https://github.com/markcornick/pwm'
+  spec.license       = 'Public domain'
 
-  # specify any dependencies here; for example:
-  s.add_development_dependency "aruba"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.14.0"
-  s.add_development_dependency "rubocop"
-  s.add_development_dependency "simplecov"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'aruba', '~> 0.9.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard-cucumber'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,17 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: pwm
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Mark Cornick
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,16 +98,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -82,31 +138,34 @@ dependencies:
         version: '0'
 description: A tiny class and command-line tool to generate reasonably secure passwords.
 email:
-- mark@cornick.io
+- mark@markcornick.com
 executables:
 - pwm
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemtest"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
-- CONTRIBUTING.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
-- bin/pwm
-- features/pwm.feature
-- features/step_definitions/pwm.rb
-- features/support/env.rb
+- bin/console
+- bin/cucumber
+- bin/guard
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- exe/pwm
 - lib/pwm.rb
 - lib/pwm/version.rb
 - pwm.gemspec
-- spec/pwm_spec.rb
-homepage: https://bitbucket.org/markcornick/pwm
-licenses: []
+homepage: https://github.com/markcornick/pwm
+licenses:
+- Public domain
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -124,12 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A reasonably secure password maker
-test_files:
-- features/pwm.feature
-- features/step_definitions/pwm.rb
-- features/support/env.rb
-- spec/pwm_spec.rb
+test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-script: bundle exec rake

data/CONTRIBUTING.md

@@ -1,12 +0,0 @@
-# Contribution guidelines for pwm
-
-pwm is intended to be small, simple, fast, and easy to understand. All
-contributions must maintain these four qualities. If your pull request
-is large, complicated, makes pwm slow, or is impossible to understand, I
-will reject it.
-
-pwm is in the public domain. All contributions must therefore also be in
-the public domain. Pull requests containing copyright or license notices
-will be rejected. Because pwm is in the public domain, you can fork it
-and put whatever license you like on it; however, the canonical pwm code
-base is in the public domain and will remain so.

data/features/pwm.feature

@@ -1,20 +0,0 @@
-Feature: Pwm
-
-  In order to generate random passwords
-  As a person needing random passwords
-  I want to use the pwm command-line tool
-
-  Scenario: Generating a password of no specific length
-    When I run `pwm`
-    Then the password should be 16 characters long
-    And the exit status should be 0
-
-  Scenario: Generating a password of a valid specific length
-    When I run `pwm 8`
-    Then the password should be 8 characters long
-    And the exit status should be 0
-
-  Scenario: Generating a password of an invalid specific length
-    When I run `pwm 4`
-    Then the output should contain "length must be >= 8"
-    And the exit status should be 1

data/features/step_definitions/pwm.rb

@@ -1,3 +0,0 @@
-Then(/^the password should be (\d+) characters long$/) do |length|
-  expect(all_output.strip.length).to eq(length.to_i)
-end

data/features/support/env.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'aruba/cucumber'
-require 'fileutils'
-require 'rspec/expectations'

data/spec/pwm_spec.rb

@@ -1,64 +0,0 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/vendor/'
-end
-require 'pwm'
-
-describe Pwm do
-  describe 'The default set of characters' do
-    (('A'..'Z').to_a - %w(I O)).each do |character|
-      it "includes #{character}" do
-        expect(Pwm.characters).to include(character)
-      end
-    end
-    (('a'..'z').to_a - ['l']).each do |character|
-      it "includes #{character}" do
-        expect(Pwm.characters).to include(character)
-      end
-    end
-    ('2'..'9').each do |character|
-      it "includes #{character}" do
-        expect(Pwm.characters).to include(character)
-      end
-    end
-    %w(I O l 0 1).each do |character|
-      it "does not include #{character}" do
-        expect(Pwm.characters).not_to include(character)
-      end
-    end
-  end
-
-  describe 'The password method' do
-    context 'when given a length' do
-      context 'equal to 8' do
-        it 'generates a password of that length' do
-          expect(Pwm.password(8).length).to eq(8)
-        end
-      end
-      context 'greater than 8' do
-        it 'generates a password of that length' do
-          expect(Pwm.password(9).length).to eq(9)
-        end
-      end
-      context 'less than 8' do
-        it 'raises Pwm::TooShortException' do
-          expect { Pwm.password(7) }.to raise_error(Pwm::TooShortException)
-        end
-      end
-    end
-    context 'when not given a length' do
-      it 'generates a 16-character password' do
-        expect(Pwm.password.length).to eq(16)
-      end
-    end
-    it 'generates passwords containing at least one upper-case letter' do
-      expect(Pwm.password).to match(/[A-Z]/)
-    end
-    it 'generates passwords containing at least one lower-case letter' do
-      expect(Pwm.password).to match(/[a-z]/)
-    end
-    it 'generates passwords containing at least one number' do
-      expect(Pwm.password).to match(/[2-9]/)
-    end
-  end
-end