xkpassword 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a85ce5f07e033d7e20eb30071b644c118ac1e67426c321df01ec2574590eb06f
-  data.tar.gz: f5505a6dddc828b5cb673d32c90b29dd073a0b7143017b2766e54274eba61315
+  metadata.gz: 9feced30408ade895b492ff621703dd5d6a1cb6f6d4aaa6fe195534a249cb519
+  data.tar.gz: 8f7bde17464c36aba01028a650daaa3e37d357018e5892bd9331384f25068a6a
 SHA512:
-  metadata.gz: 37b272ecbb57d3e652fa01e6ddd1c047241640e957dd733d9323e57c9daa0e92e5fbb8dbbcf3c82eb5eb5f1c72ca51bac2188f60464d6e4c57dfb6453b07ec4a
-  data.tar.gz: 47778296384d3398000a0b4cf3f890d847e11461da40f0f8a269ebe4bc6a718a8194b4ea3e3369f8a81c5fb056bcc85e3ee5c89b8568819b72286ce423ce88c2
+  metadata.gz: 158d3daab0101987cb7062a907125d80858aa7dbfdea51c6448ade83d4e155e5af31a87e37715ebde7a1965572008d2f56e64d747e53eb21a9a51e66c948d95b
+  data.tar.gz: cfa02254cb10af01efe5387605d9036750c419031e40bb47cb8a2b23f97c4364ba534f66e3629b3b335dc450fb99d965f5827b654e0e5556d81a2f202eae7664

data/README.md

@@ -53,7 +53,7 @@ Or install it yourself as:
 ## Usage
 
 You can use this app stand-alone in the command line or include it in any of your Ruby
-applications.
+applications. For a fuller guide to presets and examples, see [doc/README.md](doc/README.md).
 
 ### Comamnd Line
 The commandline application accepts the same collection of configuration options as would
@@ -71,11 +71,7 @@ full list of options.
 require 'xkpassword'
 
 options = {
-  max_length: 8,
-  min_length: 4,
-  case_transform: :capitalize,
-  separator: '-',
-  words: 4,
+  preset: :security,
 }
 
 XKPassword.generate(options)
@@ -88,11 +84,7 @@ the following as then it will only load and parse the databse once.
 require 'xkpassword/generator'
 
 options = {
-  max_length: 8,
-  min_length: 4,
-  case_transform: :capitalize,
-  separator: '-',
-  words: 4,
+  preset: :wifi,
 }
   
 generator = XKPassword::Generator.new
@@ -101,18 +93,18 @@ generator.generate(options)
 # 10.times { generator.generate(options) }
 ```
 
+`preset` supports `:xkcd` (default), `:web32`, `:wifi`, `:security`, and `:apple_id`.
+You can still override any individual option in the selected preset.
+
+The default `:xkcd` preset keeps the gem's original behavior of generating 4 words.
+
 `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
-bumped a minor (resulting 0.2.3 ~> 0.3.0) for adding Travis CI which doesn't change any
-functional aspect of the app.
-
-I am thinking of releasing gems only on functional updates (real code changes) that
-happen with new features and bug fixes. So for now, there will be no 0.3.0v available
-in Ruby GEMs and the latest would be 0.2.3.
+Releases are intended for functional updates such as new features and bug fixes.
+Check the Git tags or RubyGems release history for the latest published version.
 
 ## Development
 

data/exe/xkpassword

@@ -40,9 +40,9 @@ OptionParser.new do |opts|
   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 }
+  opts.on('--preset [STRING]', 'Preset to use: xkcd, web32, wifi, security, or apple_id') { |preset| options[:preset] = preset }
 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

@@ -2,16 +2,60 @@ require 'xkpassword/words'
 
 # The Generator class which finds words based on the requirement and using the provided options to build a
 # new random passowrd.
+# Presets provide convenient defaults for common password styles, and callers can override any
+# preset-derived value by passing explicit generation options.
 # 
 # @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: '-',
-    words: 4,
+  # The preset used when `:preset` is omitted.
+  DEFAULT_PRESET = :xkcd
+
+  # Built-in password presets.
+  #
+  # - `:xkcd` generates 4 words between 4 and 8 letters separated by `-`, preserving the gem's
+  #   original default behavior.
+  # - `:web32` generates 4 shorter words between 4 and 5 letters separated by `-`.
+  # - `:wifi` generates 6 words between 4 and 8 letters separated by `-`.
+  # - `:security` generates 6 lowercase words between 4 and 8 letters separated by spaces.
+  # - `:apple_id` generates 3 words between 4 and 7 letters separated by `-`.
+  PRESETS = {
+    xkcd: {
+      case_transform: nil,
+      max_length: 8,
+      min_length: 4,
+      separator: '-',
+      words: 4,
+    },
+    web32: {
+      case_transform: nil,
+      max_length: 5,
+      min_length: 4,
+      separator: '-',
+      words: 4,
+    },
+    wifi: {
+      case_transform: nil,
+      max_length: 8,
+      min_length: 4,
+      separator: '-',
+      words: 6,
+    },
+    security: {
+      case_transform: :downcase,
+      max_length: 8,
+      min_length: 4,
+      separator: ' ',
+      words: 6,
+    },
+    apple_id: {
+      case_transform: nil,
+      max_length: 7,
+      min_length: 4,
+      separator: '-',
+      words: 3,
+    },
   }
+  VALID_CASE_TRANSFORMS = [:upcase, :downcase, :capitalize]
 
   attr_reader :words
 
@@ -20,8 +64,14 @@ class XKPassword::Generator
   end
 
   # Generates a password absed on the configuration provided.
+  # A preset supplies a base configuration and any explicit options passed in `options` override
+  # those preset defaults.
   #
   # @param [Hash] options The options to populate a generator
+  # @option options [String, Symbol] :preset The preset to use. Supports `:xkcd`, `:web32`,
+  #                                          `:wifi`, `:security`, and `:apple_id`.
+  #                                          String values like `"apple_id"` and `"apple-id"`
+  #                                          are normalized to `:apple_id`. Defaults to `:xkcd`.
   # @option options [Integer] :words      The number of words to include in the generated password
   # @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
@@ -30,20 +80,37 @@ class XKPassword::Generator
   #
   # @return [String]                      The generated password
   #
-  # @example Populating the method with all options (current default)
+  # @example Using the default xkcd preset
+  #   generator = XKPassword::Generator.new
+  #   generator.generate
+  #
+  # @example Using the security preset
+  #   generator = XKPassword::Generator.new
+  #   generator.generate(preset: :security)
+  #
+  # @example Populating the method with a preset and explicit overrides
   #   options = {
+  #     preset: :security,
   #     separator: ' ',
-  #     words: 4,
+  #     words: 6,
   #     min_length: 4,
   #     max_length: 8,
-  #     case_transform: :capitalize
+  #     case_transform: :downcase
   #   }
   #
   #   generator = XKPassword::Generator.new
   #   generator.generate(options)
+  #
+  # @example Built-in preset defaults
+  #   :xkcd     # 4 words, 4..8 letters, "-" separator, random per-word uppercasing
+  #   :web32    # 4 words, 4..5 letters, "-" separator, random per-word uppercasing
+  #   :wifi     # 6 words, 4..8 letters, "-" separator, random per-word uppercasing
+  #   :security # 6 words, 4..8 letters, " " separator, lowercase
+  #   :apple_id # 3 words, 4..7 letters, "-" separator, random per-word uppercasing
   def generate(options = nil)
-    options ||= {}
-    options = DEFAULTS.merge(options)
+    options = (options || {}).dup
+    preset = normalize_preset(options.delete(:preset))
+    options = PRESETS.fetch(preset).merge(options)
     case_transform = normalize_case_transform(options[:case_transform])
     length_vals = (options[:min_length]..options[:max_length]).to_a
 
@@ -73,11 +140,20 @@ class XKPassword::Generator
     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)
+    return case_transform if VALID_CASE_TRANSFORMS.include?(case_transform)
+
+    fail ArgumentError, "case_transform should be one of: #{ VALID_CASE_TRANSFORMS.join(', ') }"
+  end
+
+  def normalize_preset(preset)
+    return DEFAULT_PRESET if preset.nil?
+
+    preset = preset.strip.downcase.tr(' -', '_').to_sym if preset.is_a?(String)
+
+    return preset if PRESETS.key?(preset)
 
-    fail ArgumentError, "case_transform should be one of: #{ valid_case_transforms.join(', ') }"
+    fail ArgumentError, "preset should be one of: #{ PRESETS.keys.join(', ') }"
   end
 
 end

data/lib/xkpassword/version.rb

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

data/lib/xkpassword.rb

@@ -7,12 +7,29 @@ module XKPassword
   # use the `XKPassword::Generator` class as it will be faster since it will only need to load
   # the dictionary once.
   #
+  # Presets provide named defaults for common password styles, and any explicit options passed to
+  # this method override the selected preset.
+  #
   # @param [Hash] options The options to populate a generator
+  # @option options [String, Symbol] :preset The preset to use. Supports `:xkcd`, `:web32`,
+  #                                          `:wifi`, `:security`, and `:apple_id`.
+  #                                          Defaults to `:xkcd`.
+  #                                          - `:xkcd` uses 4 words of 4..8 letters joined by `-`
+  #                                          - `:web32` uses 4 words of 4..5 letters joined by `-`
+  #                                          - `:wifi` uses 6 words of 4..8 letters joined by `-`
+  #                                          - `:security` uses 6 lowercase words of 4..8 letters joined by spaces
+  #                                          - `:apple_id` uses 3 words of 4..7 letters joined by `-`
   # @option options [Integer] :words      The number of words to include in the generated password
   # @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
+  #
+  # @example Generate with the default preset
+  #   XKPassword.generate
+  #
+  # @example Generate with a preset and override one of its defaults
+  #   XKPassword.generate(preset: :apple_id, separator: '.')
   def self.generate(options = nil)
     generator = XKPassword::Generator.new
     generator.generate(options)
@@ -22,4 +39,3 @@ end
 
 require 'xkpassword/version'
 require 'xkpassword/generator'
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xkpassword
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ziyan Junaideen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-10 00:00:00.000000000 Z
+date: 2026-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artii