funny_yubikey_generator 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce4a0835f9bf5d97819283adf58333005e5ef819fa25aeab2c361435906c7f4
-  data.tar.gz: a92c688a139531971bebcc3862e2b12d471deffd7f9d9a42619b9b9947d93596
+  metadata.gz: aa628988e7878d56e67bdb26d912dc7d21f419f9f0e75fb6ccc845a8937c1a56
+  data.tar.gz: 7dbeea9dc0759e3f894fa2893530cf79a041dbc29de99087b9ccbd7ddceb27bc
 SHA512:
-  metadata.gz: 8ba31a110fd97278d7ba0e6bf53f69ce30ec883e879db9ba991f085cdb0ece991fa1196731b4eccdb7abffb762e7f7575405a4db2b3ba3a8ccef4cd3427c69f3
-  data.tar.gz: c9ae9bdd76e6af8979c466d98c43f3d9b60de330793241a517c309ee28e4500ac5ebbfa9f42f32680077249d6f39d8a500e80ba517677522d29ab39dd922583e
+  metadata.gz: f91e58a6fc9d03de37625515a93918f33e7e3fc41334f4e1dd0ac982ae2a740cbcd67bff7cb2e422fd4eb21c29c9c3217e5af19084967abda92775f6d12a040e
+  data.tar.gz: 1d225d62b4b474bbdaad7edff6ee078194b7ea6a72146f9bc07844666048336c0d0eef4a9d07b9ead94799da7f822babd13ce44a2cd7ab274bd8d57a4f0a7a21

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in yubikey_generator.gemspec
+# Specify your gem's dependencies in funny_yubikey_generator.gemspec
 gemspec
 
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    funny_yubikey_generator (0.2.0)
+    funny_yubikey_generator (0.4.0)
       colorize (~> 0.8.1)
 
 GEM

data/README.md

@@ -1,5 +1,7 @@
 # FunnyYubikeyGenerator
 
+[![Gem Version](https://badge.fury.io/rb/funny_yubikey_generator.svg)](https://badge.fury.io/rb/funny_yubikey_generator)
+
 Generate funny looking [yubikey OTP](https://developers.yubico.com/OTP/OTPs_Explained.html) containing words based on a dictionary.
 
 ## Installation
@@ -16,33 +18,37 @@ If bundler is not being used to manage dependencies, install the gem by executin
     
 As CLI:
 ```bash
-    gem install funny_yubikey_generator
-    generate_funny_yubikey -c
+gem install funny_yubikey_generator
+generate_funny_yubikey -c
 ```
 
+![preview.png](preview.png)
+
 In Ruby:
 ```ruby
-    require "funny_yubikey_generator"
-    puts FunnyYubikeyGenerator.generate(colorize: true)
-
-    dictionary = <<~DICO
-          crude
-          blubber
-          futile
-          lutrin
-          interbelligerent
-          reinterference
-    DICO
-    generator = FunnyYubikeyGenerator.new(dictionary: dictionary.split("\n"))
-    puts generator.generate(colorize: true)
-
+require "funny_yubikey_generator"
+puts FunnyYubikeyGenerator.generate(colorize: true)
+
+dictionary = <<~DICO
+      crude
+      blubber
+      futile
+      lutrin
+      interbelligerent
+      reinterference
+DICO
+generator = FunnyYubikeyGenerator.from_dictionary(dictionary)
+puts generator.generate(colorize: true)
+
+generator = FunnyYubikeyGenerator.from_dictionary(File.open("/usr/share/dict/words"))
+puts generator.generate(colorize: false)
 ```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the `spec.version` in [funny_yubikey_generator.gemspec](funny_yubikey_generator.gemspec), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -54,4 +60,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the YubikeyGenerator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/x4d3/funny_yubikey_generator/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the FunnyYubikeyGenerator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/x4d3/funny_yubikey_generator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "yaml"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,6 +10,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+task :generate_index_words do
+  puts FunnyYubikeyGenerator.filter_and_index_words(File.open("/usr/share/dict/words")).to_yaml
+end
+
 require "standard/rake"
 
 task default: %i[test standard]

data/exe/generate_funny_yubikey

@@ -27,7 +27,7 @@ end.parse!
 
 generator = if dictionary
   raise "Could not find file #{dictionary}" unless File.exist?(dictionary)
-  FunnyYubikeyGenerator.new(dictionary: File.open(dictionary))
+  FunnyYubikeyGenerator.from_dictionary(File.open(dictionary))
 else
   FunnyYubikeyGenerator.instance
 end

data/funny_yubikey_generator.gemspec

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "lib/funny_yubikey_generator"
-
 Gem::Specification.new do |spec|
   spec.name = "funny_yubikey_generator"
-  spec.version = FunnyYubikeyGenerator::VERSION
+  spec.version = "0.4.0"
   spec.authors = ["Xavier Delamotte"]
   spec.email = ["git@xade.eu"]
 
-  spec.summary = "Generates fun yubikeys"
-  spec.description = "Generates fun yubikeys"
+  spec.summary = "Generate funny looking yubikey OTP containing words based on a dictionary."
+  spec.description = "Generate funny looking yubikey OTP containing words based on a dictionary."
   spec.homepage = "https://github.com/x4d3/funny_yubikey_generator"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

data/lib/funny_yubikey_generator.rb

@@ -3,24 +3,24 @@
 require "singleton"
 require "colorize"
 require "set"
+require "yaml"
 
 class FunnyYubikeyGenerator
-  VERSION = "0.2.0"
+  include Singleton
   COLORS = %i[red green yellow blue magenta cyan]
+  LETTERS = "cbdefghijklnrtuv"
+  WORD_REGEX = /^[#{Regexp.quote(LETTERS)}]+{4,}$/
   private_constant :COLORS
+  private_constant :LETTERS
+
   class << self
-    def initialize_singleton
-      @singleton__instance__ = nil
-      @singleton__mutex__ = Thread::Mutex.new
+    def from_dictionary(dictionary)
+      indexed_words = filter_and_index_words(dictionary)
+      new(indexed_words: indexed_words)
     end
 
-    def instance # :nodoc:
-      return @singleton__instance__ if @singleton__instance__
-      @singleton__mutex__.synchronize {
-        return @singleton__instance__ if @singleton__instance__
-        @singleton__instance__ = new
-      }
-      @singleton__instance__
+    def filter_and_index_words(dictionary)
+      dictionary.scan(WORD_REGEX).group_by(&:length)
     end
 
     def generate(colorize: false)
@@ -28,20 +28,13 @@ class FunnyYubikeyGenerator
     end
   end
 
-  initialize_singleton
-
-  def initialize(dictionary: default_dictionary, letters: "cbdefghijklnrtuv".chars.to_set)
-    @dictionary = dictionary.map(&:strip).select { |line|
-      line.chars.all? do |c|
-        letters.include?(c)
-      end
-    }.group_by(&:length)
+  def initialize(indexed_words: load_default_indexed_words)
+    @indexed_words = indexed_words
   end
 
   def generate(colorize: false)
-    words_lengths = @dictionary.keys - [1, 2, 3]
-    words = random_partition(40, words_lengths).map do |s|
-      @dictionary[s].sample
+    words = random_partition(40, @indexed_words.keys).map do |s|
+      @indexed_words[s].sample
     end
     if colorize
       words.map!.with_index { |w, i| w.colorize(COLORS[i % COLORS.length]) }
@@ -51,14 +44,8 @@ class FunnyYubikeyGenerator
 
   private
 
-  def default_dictionary
-    [
-      "/usr/share/dict/words",
-      "/usr/dict/word",
-      File.join(__dir__, "words.txt")
-    ].each do |path|
-      return File.open(path) if File.exist?(path)
-    end
+  def load_default_indexed_words
+    YAML.load_file(File.join(__dir__, "indexed_words.yaml"))
   end
 
   def random_partition(target, word_lengths)