Merge pull request #49 from envato/orien/rubocop

Address layout and frozen string literal issues

Author: orien

.rubocop_todo.yml

@@ -6,170 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleAlignWith.
-# SupportedStylesAlignWith: either, start_of_block, start_of_line
-Layout/BlockAlignment:
-  Exclude:
-    - 'zxcvbn-ruby.gemspec'
-
-# This cop supports safe autocorrection (--autocorrect).
-Layout/ElseAlignment:
-  Exclude:
-    - 'lib/zxcvbn/entropy.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/zxcvbn/entropy.rb'
-    - 'lib/zxcvbn/matchers/date.rb'
-    - 'lib/zxcvbn/matchers/l33t.rb'
-    - 'lib/zxcvbn/matchers/new_l33t.rb'
-    - 'lib/zxcvbn/math.rb'
-    - 'lib/zxcvbn/omnimatch.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterMagicComment:
-  Exclude:
-    - 'zxcvbn-ruby.gemspec'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EmptyLineBetweenMethodDefs, EmptyLineBetweenClassDefs, EmptyLineBetweenModuleDefs, DefLikeMacros, AllowAdjacentOneLineDefs, NumberOfEmptyLines.
-Layout/EmptyLineBetweenDefs:
-  Exclude:
-    - 'lib/zxcvbn/omnimatch.rb'
-    - 'lib/zxcvbn/scorer.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLines:
-  Exclude:
-    - 'lib/zxcvbn/omnimatch.rb'
-    - 'lib/zxcvbn/scorer.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: empty_lines, no_empty_lines
-Layout/EmptyLinesAroundBlockBody:
-  Exclude:
-    - 'spec/scorer_spec.rb'
-    - 'spec/scoring/entropy_spec.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
-Layout/EmptyLinesAroundClassBody:
-  Exclude:
-    - 'lib/zxcvbn/matchers/new_l33t.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleAlignWith, Severity.
-# SupportedStylesAlignWith: keyword, variable, start_of_line
-Layout/EndAlignment:
-  Exclude:
-    - 'lib/zxcvbn/entropy.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'lib/zxcvbn/scorer.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: IndentationWidth.
-# SupportedStyles: special_inside_parentheses, consistent, align_brackets
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'lib/zxcvbn/data.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/zxcvbn/entropy.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
-# URISchemes: http, https
-Layout/LineLength:
-  Exclude:
-    - 'Rakefile'
-    - 'lib/zxcvbn/scorer.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator, EnforcedStyleForRationalLiterals.
-# SupportedStylesForExponentOperator: space, no_space
-# SupportedStylesForRationalLiterals: space, no_space
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'lib/zxcvbn/crack_time.rb'
-    - 'lib/zxcvbn/entropy.rb'
-    - 'lib/zxcvbn/matchers/repeat.rb'
-    - 'lib/zxcvbn/matchers/sequences.rb'
-    - 'lib/zxcvbn/matchers/spatial.rb'
-    - 'lib/zxcvbn/scorer.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
-# SupportedStyles: space, no_space
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceBeforeBlockBraces:
-  Exclude:
-    - 'lib/zxcvbn/entropy.rb'
-    - 'lib/zxcvbn/matchers/l33t.rb'
-    - 'lib/zxcvbn/matchers/new_l33t.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-# SupportedStyles: space, no_space
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideBlockBraces:
-  Exclude:
-    - 'lib/zxcvbn/entropy.rb'
-    - 'lib/zxcvbn/matchers/l33t.rb'
-    - 'spec/spec_helper.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
-# SupportedStyles: space, no_space, compact
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideHashLiteralBraces:
-  Exclude:
-    - 'lib/zxcvbn/matchers/new_l33t.rb'
-    - 'spec/dictionary_ranker_spec.rb'
-    - 'spec/matchers/l33t_spec.rb'
-    - 'spec/scoring/entropy_spec.rb'
-    - 'spec/zxcvbn_spec.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-Layout/SpaceInsidePercentLiteralDelimiters:
-  Exclude:
-    - 'lib/zxcvbn/matchers/date.rb'
-    - 'spec/matchers/date_spec.rb'
-
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: final_newline, final_blank_line
-Layout/TrailingEmptyLines:
-  Exclude:
-    - 'lib/zxcvbn/clock.rb'
-    - 'lib/zxcvbn/crack_time.rb'
-    - 'lib/zxcvbn/matchers/dictionary.rb'
-    - 'lib/zxcvbn/matchers/l33t.rb'
-    - 'lib/zxcvbn/matchers/new_l33t.rb'
-    - 'lib/zxcvbn/matchers/spatial.rb'
-    - 'lib/zxcvbn/matchers/year.rb'
-    - 'lib/zxcvbn/score.rb'
-    - 'spec/support/js_helpers.rb'
-    - 'spec/support/matcher.rb'
-
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
@@ -416,59 +252,6 @@ Style/For:
     - 'lib/zxcvbn/feedback_giver.rb'
     - 'lib/zxcvbn/matchers/date.rb'
 
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - '**/*.arb'
-    - 'Gemfile'
-    - 'Guardfile'
-    - 'Rakefile'
-    - 'lib/zxcvbn.rb'
-    - 'lib/zxcvbn/clock.rb'
-    - 'lib/zxcvbn/crack_time.rb'
-    - 'lib/zxcvbn/data.rb'
-    - 'lib/zxcvbn/dictionary_ranker.rb'
-    - 'lib/zxcvbn/entropy.rb'
-    - 'lib/zxcvbn/feedback.rb'
-    - 'lib/zxcvbn/feedback_giver.rb'
-    - 'lib/zxcvbn/match.rb'
-    - 'lib/zxcvbn/matchers/date.rb'
-    - 'lib/zxcvbn/matchers/dictionary.rb'
-    - 'lib/zxcvbn/matchers/digits.rb'
-    - 'lib/zxcvbn/matchers/l33t.rb'
-    - 'lib/zxcvbn/matchers/new_l33t.rb'
-    - 'lib/zxcvbn/matchers/regex_helpers.rb'
-    - 'lib/zxcvbn/matchers/repeat.rb'
-    - 'lib/zxcvbn/matchers/sequences.rb'
-    - 'lib/zxcvbn/matchers/spatial.rb'
-    - 'lib/zxcvbn/matchers/year.rb'
-    - 'lib/zxcvbn/math.rb'
-    - 'lib/zxcvbn/omnimatch.rb'
-    - 'lib/zxcvbn/password_strength.rb'
-    - 'lib/zxcvbn/score.rb'
-    - 'lib/zxcvbn/scorer.rb'
-    - 'spec/dictionary_ranker_spec.rb'
-    - 'spec/feedback_giver_spec.rb'
-    - 'spec/matchers/date_spec.rb'
-    - 'spec/matchers/digits_spec.rb'
-    - 'spec/matchers/l33t_spec.rb'
-    - 'spec/matchers/repeat_spec.rb'
-    - 'spec/matchers/sequences_spec.rb'
-    - 'spec/matchers/spatial_spec.rb'
-    - 'spec/matchers/year_spec.rb'
-    - 'spec/omnimatch_spec.rb'
-    - 'spec/scorer_spec.rb'
-    - 'spec/scoring/crack_time_spec.rb'
-    - 'spec/scoring/entropy_spec.rb'
-    - 'spec/scoring/math_spec.rb'
-    - 'spec/spec_helper.rb'
-    - 'spec/support/js_helpers.rb'
-    - 'spec/support/matcher.rb'
-    - 'spec/zxcvbn_spec.rb'
-    - 'zxcvbn-ruby.gemspec'
-
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:

CHANGELOG.md

@@ -6,7 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.1...HEAD
+[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.2...HEAD
+
+## [1.2.2] - 2025-12-06
+
+### Changed
+ - Address layout and frozen string literal issues ([#49])
+
+[1.2.2]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.1...v.1.2.2
+[#49]: https://github.com/envato/zxcvbn-ruby/pull/49
 
 ## [1.2.1] - 2025-12-05
 

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 guard :bundler do
   require 'guard/bundler'
   require 'guard/bundler/verify'

Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "bundler/setup"
 require 'rspec/core/rake_task'
@@ -20,6 +22,8 @@ task :console do
 end
 
 task :compile_coffeescript do
-  `coffee --compile --bare spec/support/js_source/{matching,scoring,init}.coffee`
-  `cat spec/support/js_source/{matching,scoring,adjacency_graphs,frequency_lists,init}.js > spec/support/js_source/compiled.js`
+  system('coffee --compile --bare spec/support/js_source/{matching,scoring,init}.coffee', exception: true)
+  system(<<~COMMAND.strip, exception: true)
+    cat spec/support/js_source/{matching,scoring,adjacency_graphs,frequency_lists,init}.js > spec/support/js_source/compiled.js
+  COMMAND
 end

lib/zxcvbn.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'zxcvbn/version'
 require 'zxcvbn/tester'

lib/zxcvbn/clock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module Clock
     def self.realtime
@@ -7,4 +9,3 @@ def self.realtime
     end
   end
 end
-

lib/zxcvbn/crack_time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module CrackTime
     SINGLE_GUESS = 0.010
@@ -6,7 +8,7 @@ module CrackTime
     SECONDS_PER_GUESS = SINGLE_GUESS / NUM_ATTACKERS
 
     def entropy_to_crack_time(entropy)
-      0.5 * (2 ** entropy) * SECONDS_PER_GUESS
+      0.5 * (2**entropy) * SECONDS_PER_GUESS
     end
 
     def crack_time_to_score(seconds)
@@ -50,4 +52,4 @@ def display_time(seconds)
       end
     end
   end
-end
+end

lib/zxcvbn/data.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'zxcvbn/dictionary_ranker'
 
 module Zxcvbn
   class Data
     def initialize
       @ranked_dictionaries = DictionaryRanker.rank_dictionaries(
-        "english" =>      read_word_list("english.txt"),
+        "english" => read_word_list("english.txt"),
         "female_names" => read_word_list("female_names.txt"),
-        "male_names" =>   read_word_list("male_names.txt"),
-        "passwords" =>    read_word_list("passwords.txt"),
-        "surnames" =>     read_word_list("surnames.txt")
+        "male_names" => read_word_list("male_names.txt"),
+        "passwords" => read_word_list("passwords.txt"),
+        "surnames" => read_word_list("surnames.txt")
       )
       @adjacency_graphs = JSON.load(DATA_PATH.join('adjacency_graphs.json').read)
     end

lib/zxcvbn/dictionary_ranker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   class DictionaryRanker
     def self.rank_dictionaries(lists)