xkpassword 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cef9e3a5c2d5e5b5c1e0fc020c5452cc124e3e2621dbaef3d2e8534a8d32fc7
-  data.tar.gz: d3505fb27f342fd47d4eabe8908be4512548d73c1415370cdf161027cf1ffca3
+  metadata.gz: a85ce5f07e033d7e20eb30071b644c118ac1e67426c321df01ec2574590eb06f
+  data.tar.gz: f5505a6dddc828b5cb673d32c90b29dd073a0b7143017b2766e54274eba61315
 SHA512:
-  metadata.gz: 2de3ac2952363281897ba7b7ff0a360ab33a5a1802d0f27df6fe3b8662a68e8ecd20265a21879e172528bee87862e0cfe10e36b05844415fe0c0f273630b8339
-  data.tar.gz: 41ead76491703805aefc73a7a7e9d2351293e59e19d9493e83b4b9886b0aaa18e57101dd10067f1624db3b0764bcdce48bfa7746a30ca97c070e9fbb1c4bb00b
+  metadata.gz: 37b272ecbb57d3e652fa01e6ddd1c047241640e957dd733d9323e57c9daa0e92e5fbb8dbbcf3c82eb5eb5f1c72ca51bac2188f60464d6e4c57dfb6453b07ec4a
+  data.tar.gz: 47778296384d3398000a0b4cf3f890d847e11461da40f0f8a269ebe4bc6a718a8194b4ea3e3369f8a81c5fb056bcc85e3ee5c89b8568819b72286ce423ce88c2

data/Gemfile

@@ -6,4 +6,5 @@ gemspec
 group :development do
   gem 'yard'
   gem 'pry'
+  gem 'rubocop', require: false
 end

data/README.md

@@ -73,6 +73,7 @@ require 'xkpassword'
 options = {
   max_length: 8,
   min_length: 4,
+  case_transform: :capitalize,
   separator: '-',
   words: 4,
 }
@@ -89,6 +90,7 @@ require 'xkpassword/generator'
 options = {
   max_length: 8,
   min_length: 4,
+  case_transform: :capitalize,
   separator: '-',
   words: 4,
 }
@@ -99,6 +101,9 @@ generator.generate(options)
 # 10.times { generator.generate(options) }
 ```
 
+`case_transform` supports `:upcase`, `:downcase`, and `:capitalize`, and applies the
+selected transform to every generated word in the password.
+
 ## The GEM
 
 I run a policy of tagging any improvement done for the code base. For example, I just
@@ -140,4 +145,3 @@ conduct.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/exe/xkpassword

@@ -39,10 +39,10 @@ OptionParser.new do |opts|
   opts.on('--min-length [INTEGER]', 'Minimum length of a word') { |min| options[:min_length] = min.to_i }
   opts.on('--max-length [INTEGER]', 'Maximum length of a word') { |max| options[:max_length] = max.to_i }
   opts.on('--separator [STRING]', 'The separator to separate password') { |separator| options[:separator] = separator }
+  opts.on('--case-transform [STRING]', 'Transform each word using upcase, downcase, or capitalize') { |case_transform| options[:case_transform] = case_transform }
 end.parse!
 
 puts message if options[:info]
 puts XKPassword::VERSION if options[:version]
 puts XKPassword.generate(options) if !options[:info] && !options[:version]
 
-

data/lib/xkpassword/generator.rb

@@ -6,6 +6,7 @@ require 'xkpassword/words'
 # @attr_reader [XKPassword::Words] words  A word database that gen provide you words for the length required
 class XKPassword::Generator
   DEFAULTS = {
+    case_transform: nil,
     max_length: 8,
     min_length: 4,
     separator: '-',
@@ -25,6 +26,7 @@ class XKPassword::Generator
   # @option options [String]  :separator  The separator symbol to use joining words used in password
   # @option options [Integer] :min_length The minimum length of a word to be used in the process
   # @option options [Integer] :max_length The maximum length of a word to be used in the process
+  # @option options [String, Symbol] :case_transform The transform to apply to every generated word
   #
   # @return [String]                      The generated password
   #
@@ -33,7 +35,8 @@ class XKPassword::Generator
   #     separator: ' ',
   #     words: 4,
   #     min_length: 4,
-  #     max_length: 8
+  #     max_length: 8,
+  #     case_transform: :capitalize
   #   }
   #
   #   generator = XKPassword::Generator.new
@@ -41,16 +44,40 @@ class XKPassword::Generator
   def generate(options = nil)
     options ||= {}
     options = DEFAULTS.merge(options)
+    case_transform = normalize_case_transform(options[:case_transform])
     length_vals = (options[:min_length]..options[:max_length]).to_a
 
     data = options[:words].times.map do
       word = words.random(length_vals.sample)
-      upcase = [true, false].sample
-      word = word.upcase if upcase
-      word
+      transform_word(word, case_transform)
     end
     
     data.join(options[:separator])
   end
-  
+
+  private
+
+  def transform_word(word, case_transform)
+    return randomly_upcase(word) unless case_transform
+
+    word.public_send(case_transform)
+  end
+
+  def randomly_upcase(word)
+    upcase = [true, false].sample
+    word = word.upcase if upcase
+    word
+  end
+
+  def normalize_case_transform(case_transform)
+    return nil if case_transform.nil?
+
+    case_transform = case_transform.to_sym if case_transform.is_a?(String)
+    valid_case_transforms = [:upcase, :downcase, :capitalize]
+
+    return case_transform if valid_case_transforms.include?(case_transform)
+
+    fail ArgumentError, "case_transform should be one of: #{ valid_case_transforms.join(', ') }"
+  end
+
 end

data/lib/xkpassword/version.rb

@@ -1,3 +1,3 @@
 module XKPassword
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/xkpassword.rb

@@ -12,6 +12,7 @@ module XKPassword
   # @option options [String]  :separator  The separator symbol to use joining words used in password
   # @option options [Integer] :min_length The minimum length of a word to be used in the process
   # @option options [Integer] :max_length The maximum length of a word to be used in the process
+  # @option options [String, Symbol] :case_transform The transform to apply to every generated word
   def self.generate(options = nil)
     generator = XKPassword::Generator.new
     generator.generate(options)
@@ -22,4 +23,3 @@ end
 require 'xkpassword/version'
 require 'xkpassword/generator'
 
-

data/mise.toml

@@ -0,0 +1,14 @@
+[tools]
+ruby = "3.3"
+
+[tasks.test]
+description = "Run the test suite"
+run = "bundle exec rspec"
+
+[tasks.format]
+description = "Format and lint the code with RuboCop"
+run = "bundle exec rubocop -a"
+
+[tasks.publish]
+description = "Build and publish the gem to RubyGems"
+run = "bundle exec rake release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xkpassword
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Ziyan Junaideen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2026-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artii
@@ -81,8 +81,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -99,6 +97,7 @@ files:
 - lib/xkpassword/store.rb
 - lib/xkpassword/version.rb
 - lib/xkpassword/words.rb
+- mise.toml
 - xkpassword.gemspec
 homepage: https://github.com/jdeen/xkpassword
 licenses:
@@ -119,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Hard to crack - XKPassword Generator for Ruby

data/.ruby-gemset

@@ -1 +0,0 @@
-xkpassword_gem

data/.ruby-version

@@ -1 +0,0 @@
-2.3.0