oro 1.0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0380ef86c093d775e831662d68f3704eefef9c8
+  data.tar.gz: 6045e214724254cfc7909ade545dea77bda2e2d4
+SHA512:
+  metadata.gz: 62361ea62f0e5664aec526025ac35bb20bf4e904958d2a923c1400bf27f55b04eeea7c3c426195c8dd182c92bf45a25afc26177c5a7f4c1ee652ce3d203cb281
+  data.tar.gz: 7cf0c7bb8cd3377235b86d5912878bb3c0d2643fa149fcf05ff9306ca04e135fbcf4e312af47c29b18ec43c9bcc6cee98c0c384a5287cfb50e29f6d338e99458

data/LICENSE.textile

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joel Wagener
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Oro
+
+_**"The enemy knows the system"** ([Claude Shannon](http://en.wikipedia.org/wiki/Claude_Shannon) / [Auguste Kerckhoffs](http://en.wikipedia.org/wiki/Auguste_Kerckhoffs))_
+
+A flexible, command-line utility which generates memorable passwords.
+
+## Usage
+
+    Usage: oro [settings]
+
+    Part settings (all lengths optional)
+        p[n] Punctuation part
+        n[n] Number part
+        l[n] Linnaeus part
+        a[n] Latin part
+        g[n] German part
+        e[n] English part
+        m[n] Emoticon part
+        b[n] Braille part
+
+    Config settings
+        -i, --iterations=MANDATORY       The number of passwords to generate
+        -c, --[no-]capitalize            Capitalize every word part
+        -r, --[no-]capitalize-random     Randomly capitalize one letter in every word part
+        -l, --[no-]l33t                  Make one l33t-style replacement per word part
+        -s, --[no-]shuffle               Randomize map parts
+        -f, --format=MANDATORY           Results format: string, json, yaml
+        -e, --separator[=OPTIONAL]       Separator characters
+
+    Action settings
+            --lists                      Show all available lists
+            --prefs, --preferences       Show your current preferences
+            --defaults                   Show system defaults
+            --set                        Set passed settings as your preferences
+            --reset                      Reset your preferences to system defaults
+        -v, --verbose                    Provide verbose feedback, dictionary metadata, and statistics when run
+        -h, --help                       Print this dialog
+            --version                    Show version
+
+    Examples
+        oro e9 p1 n3 -s --set
+        oro n4 -e"-" -i4
+        oro n99 -i10
+        oro e10 n5 -fjson
+
+    See dictionary source files for associated license attributions.
+
+## License
+
+http://opensource.org/licenses/mit-license.php
+
+    The MIT License (MIT)
+
+    Copyright (c) 2015 Joel Wagener
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake/testtask'
+
+namespace :oro do
+
+  Rake::TestTask.new do |task|
+    Dir.glob(File.dirname(File.absolute_path(__FILE__)) + 'lib/oro/*.rb') {|file| require file} # FIXME Seemingly fails to load shit.
+    task.libs << 'lib/oro/*.rb' # FIXME Have no idea if this is doing anything.
+    task.test_files = FileList['test/*_test.rb']
+    task.verbose = true
+  end
+
+  desc 'Say Hola!'
+  task :hola do
+    puts 'Hola, Señora!'
+  end
+
+end
+
+task :default => 'oro:test'

data/bin/oro

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/oro'

data/lib/oro.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'benchmark'
+require 'yaml'
+require 'json'
+# require 'byebug'
+require_relative 'oro/settings'
+require_relative 'oro/password'
+
+# LET'S make passwords
+
+time = Benchmark.measure do
+  begin
+
+    # Create ~/.oro preferences file if missing
+    Preferences.instance
+
+    # Set settings, parse clio
+    password = Password.new(ARGV)
+
+    # Manage actions here (and retain single responsibility principle for SettingsParser)
+    password.actions.each_pair do |action, val|
+      case action
+      when :lists
+        puts Password.installed_parts_summary
+        exit
+      when :preferences
+        puts Preferences.instance.clio
+        exit
+      when :defaults
+        puts Defaults.instance.clio
+        exit
+      when :set
+        Preferences.instance.settings = password.virgin_settings
+        puts "Saved preferences\n#{Preferences.instance.clio}"
+      when :reset
+        Preferences.instance.reset_defaults
+        puts "Reset preferences to defaults\n#{Preferences.instance.clio}"
+        exit
+      when :verbose
+        $VERBOSE = true
+      when :help
+        puts val
+        exit
+      when :version
+        puts val
+        exit
+      end
+    end
+
+    # Be verbose if requested
+    warn(Preferences.instance.to_s, "Merged settings: #{ClioHelper.clioize(password.settings)}", "Password lengths will be: #{password.length}") if $VERBOSE
+
+    @passwords = []
+    time_passwords = Benchmark.measure do
+      (1..password.config[:iterations]).each { @passwords << password.result }
+    end
+
+    warn("Time to generate #{password.config[:iterations]} passwords: #{time_passwords.real}, #{time_passwords.real / password.config[:iterations]} per password") if $VERBOSE
+
+    # We are done
+    case password.config[:format]
+    when 'json'
+      @passwords = @passwords.to_json
+    when 'yaml', 'yml'
+      @passwords = @passwords.to_yaml
+    when 'string'
+      @passwords = @passwords.join(password.config[:separator]).strip
+    end
+
+  rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption, OptionParser::MissingArgument, OptionParser::InvalidArgument => e
+    puts "Error: #{e.message}"
+  rescue NoMatchingListError, ListIsNonContiguousError, MatchlessLengthWordError => e
+    puts e.message
+  end
+end # end Benchmark
+
+# Return results
+warn("Time to run: #{time.real}") if $VERBOSE
+puts @passwords

data/lib/oro/defaults.yml

@@ -0,0 +1,19 @@
+--- !ruby/object:OpenStruct
+table:
+  :plan:
+  - - English
+    - 8
+  - - Punctuation
+    - 1
+  - - Number
+    - 3
+  :config:
+    :iterations: 5
+    :capitalize: true
+    :capitalize_random: false
+    :l33t: false
+    :shuffle: false
+    :format: 'string'
+    :separator: "\n" # Requires double quotes
+
+modifiable: true

data/lib/oro/errors.rb

@@ -0,0 +1,18 @@
+# Oro error classes
+class OroError < Exception
+  def initialize(msg)
+    @msg = msg
+  end
+
+  def message
+    "Error: #{@msg}"
+  end
+end
+
+class PartInstantiationError < OroError; end
+
+class MatchlessLengthWordError < OroError; end
+
+class NoMatchingListError < OroError; end
+
+class ListIsNonContiguousError < OroError; end

data/lib/oro/helpers.rb

@@ -0,0 +1,62 @@
+# Rails-style string helpers
+module Helpers
+  refine String do
+    def camelize
+      dup.split(/_/).map(&:capitalize).join('') # Modified from: http://yehudakatz.com/2010/11/30/ruby-2-0-refinements-in-practice/
+    end
+
+    # Not presently used
+    def underscore
+      gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2').tr('-', '_').downcase
+    end
+  end
+end
+
+# Mixed in to the singleton Defaults and Preference classes, and the Password class
+module SettingsAccessors
+  def plan
+    settings.plan
+  end
+
+  def plan=(val)
+    @settings.plan = val
+  end
+
+  def config
+    settings.config
+  end
+
+  def config=(val)
+    @settings.config = val
+  end
+
+  def actions
+    settings.actions
+  end
+
+  def actions=(val)
+    @settings.actions = val
+  end
+end
+
+# Helper methods for turning settings back into clio
+# FIXME: This *helper* method requires knowledge of the Password class
+module ClioHelper
+  def self.clioize(settings)
+    clio = []
+    settings.plan.each { |part| Password.installed_part_switches.include?(part[0]) ? clio << "w#{part[1]}" : clio << "#{part[0][0].downcase}#{part[1]}" }
+    settings.config.each { |part| clio << "--#{part[0].to_s.gsub('_', '-')}=#{part[1].to_s.gsub(/\n|\t|\r/, "\n" => '"\n"', "\t" => '"\t"', "\r" => '"\r"')}" }
+    clio.join(' ')
+  end
+
+  def clio
+    ClioHelper.clioize(settings)
+  end
+end
+
+# Custom inspection
+module SettingsInspector
+  def to_s
+    "#{self.class.name}: #{self.clio} (#{self.class::FILE})"
+  end
+end

data/lib/oro/parts.rb

@@ -0,0 +1,128 @@
+# Class representing a password plan part, which map to installed psrt lists
+class Part
+  LEET = { 'a' => ['@'], 'b' => ['|3'], 'd' => ['|)'], 'e' => ['3'], 'f' => ['ph'], 'i' => ['|'], 'k' => ['|<'],
+           'l' => ['|_'], 'o' => ['0'], 'p' => ['|*'], 's' => ['$', '5'], 'w' => ["'//"] }
+
+  def self.list_location
+    @list_location
+  end
+
+  def self.list_location=(location)
+    @list_location = location
+  end
+
+  # instance_exec (vs. instance_eval) to pass params, define_singleton_method to add the class method
+  def self.listify
+    list = YAML.load_file(@list_location)
+    instance_exec(list) { |l| define_singleton_method('list') { @list ||= l } }
+    self.respond_to?(:list) ? true : false
+  end
+
+  def self.single_character_list?
+    (shortest == 1 && longest == 1) ? true : false
+  end
+
+  def self.count
+    list.size
+  end
+
+  def self.shortest
+    @shortest ||= list.empty? ? 0 : list.min { |a, b| a.length <=> b.length }.length
+  end
+
+  def self.longest
+    @longest ||= list.empty? ? 0 : list.max { |a, b| a.length <=> b.length }.length
+  end
+
+  def self.middle
+    (shortest + longest) / 2
+  end
+
+  def self.distinct?
+    list.size == list.uniq.size ? true : false
+  end
+
+  def self.descendants
+    ObjectSpace.each_object(Class).select { |klass| klass < self }
+  end
+
+  def self.contiguous?
+    absences.empty?
+  end
+
+  def self.absences
+    length_exists = proc { |length| list.select { |w| w.length == length }.empty? ? false : true }
+    lengths = []
+    (shortest..longest).each do |len|
+      lengths << len if !length_exists.call(len)
+    end
+    lengths
+  end
+
+  def self.get_one
+    list.sample
+  end
+
+  def self.get(size, config = {})
+    single_character_list? ? get_for_single_character_part(size) : get_for_word_part(size, config)
+  end
+
+  def self.get_for_single_character_part(size)
+    result = []
+    size.times { result << get_one }
+    result.join
+  end
+
+  def self.get_for_word_part(size, config = {})
+    fail MatchlessLengthWordError, "Matchless length of #{size} requested from:\n#{self}" if size < shortest || size > longest
+
+    # FIXME: The performance benefit of refactoring to use Array#reject, or possibly reject!, should be tested.
+    get_proc, attempt = proc { get_one }, ''
+
+    until attempt.length == size do attempt = get_proc.call end
+
+    attempt.capitalize! if config[:capitalize]
+
+    if config[:capitalize_random]
+      temp = attempt.chars
+      temp[rand(temp.length)].upcase!
+      attempt = temp.join
+    end
+
+    # An index histogram of matching leetables; ex: {"a"=>[9], "e"=>[0, 6], "i"=>[8]}
+    if config[:l33t]
+      leetables = {}
+      LEET.keys.each do |l|
+        matches = (0...attempt.length).find_all { |i| attempt[i, 1] == l }
+        leetables[l] = matches unless matches.empty?
+      end
+
+      unless leetables.empty?
+        leeted = leetables.to_a.sample(1).flatten.first # Get a random key from the histogram
+        attempt.sub!(leeted, LEET[leeted][rand(LEET[leeted].length)]) # Change to gsub to replace all matches
+      end
+    end
+    attempt
+  end
+
+  def self.to_s
+    "List #{name} > count:#{count}, shortest:#{shortest}, longest:#{longest}, middle:#{middle}, distinct:#{distinct?}, get one:'#{get_one}', contiguous:#{contiguous?}" + (absences.empty? ? '' : ", absences:#{absences}")
+  end
+end
+
+# Initialize list-less parts classes from all installed <list>.yml files, * at load time *
+begin
+  require_relative 'helpers'
+  using Helpers
+
+  PARTS_DIRECTORY = 'parts'
+
+  Dir.glob(File.join(File.dirname(__FILE__), PARTS_DIRECTORY, '**', '*.yml')) do |list|
+    klass_name = File.basename(list, '.yml').camelize
+    instantiated = Object.const_set(klass_name, Class.new(Part)) # Creates subclasses of Part
+    instantiated.list_location = list
+  end
+
+rescue PartInstantiationError => e
+  puts e.message
+end # End part class initilization

data/lib/oro/parts/braille.yml

@@ -0,0 +1,259 @@
+# http://unicodeemoticons.com/symbols_all.htm ; Unknown license ; Formatting.
+
+---
+- ⠁
+- ⠂
+- ⠃
+- ⠄
+- ⠅
+- ⠆
+- ⠇
+- ⠈
+- ⠉
+- ⠊
+- ⠋
+- ⠌
+- ⠍
+- ⠎
+- ⠏
+- ⠐
+- ⠑
+- ⠒
+- ⠓
+- ⠔
+- ⠕
+- ⠖
+- ⠗
+- ⠘
+- ⠙
+- ⠚
+- ⠛
+- ⠜
+- ⠝
+- ⠞
+- ⠟
+- ⠠
+- ⠡
+- ⠢
+- ⠣
+- ⠤
+- ⠥
+- ⠦
+- ⠧
+- ⠨
+- ⠩
+- ⠪
+- ⠫
+- ⠬
+- ⠭
+- ⠮
+- ⠯
+- ⠰
+- ⠱
+- ⠲
+- ⠳
+- ⠴
+- ⠵
+- ⠶
+- ⠷
+- ⠸
+- ⠹
+- ⠺
+- ⠻
+- ⠼
+- ⠽
+- ⠾
+- ⠿
+- ⡀
+- ⡁
+- ⡂
+- ⡃
+- ⡄
+- ⡅
+- ⡆
+- ⡇
+- ⡈
+- ⡉
+- ⡊
+- ⡋
+- ⡌
+- ⡍
+- ⡎
+- ⡏
+- ⡐
+- ⡑
+- ⡒
+- ⡓
+- ⡔
+- ⡕
+- ⡖
+- ⡗
+- ⡘
+- ⡙
+- ⡚
+- ⡛
+- ⡜
+- ⡝
+- ⡞
+- ⡟
+- ⡠
+- ⡡
+- ⡢
+- ⡣
+- ⡤
+- ⡥
+- ⡦
+- ⡧
+- ⡨
+- ⡩
+- ⡪
+- ⡫
+- ⡬
+- ⡭
+- ⡮
+- ⡯
+- ⡰
+- ⡱
+- ⡲
+- ⡳
+- ⡴
+- ⡵
+- ⡶
+- ⡷
+- ⡸
+- ⡹
+- ⡺
+- ⡻
+- ⡼
+- ⡽
+- ⡾
+- ⡿
+- ⢀
+- ⢁
+- ⢂
+- ⢃
+- ⢄
+- ⢅
+- ⢆
+- ⢇
+- ⢈
+- ⢉
+- ⢊
+- ⢋
+- ⢌
+- ⢍
+- ⢎
+- ⢏
+- ⢐
+- ⢑
+- ⢒
+- ⢓
+- ⢔
+- ⢕
+- ⢖
+- ⢗
+- ⢘
+- ⢙
+- ⢚
+- ⢛
+- ⢜
+- ⢝
+- ⢞
+- ⢟
+- ⢠
+- ⢡
+- ⢢
+- ⢣
+- ⢤
+- ⢥
+- ⢦
+- ⢧
+- ⢨
+- ⢩
+- ⢪
+- ⢫
+- ⢬
+- ⢭
+- ⢮
+- ⢯
+- ⢰
+- ⢱
+- ⢲
+- ⢳
+- ⢴
+- ⢵
+- ⢶
+- ⢷
+- ⢸
+- ⢹
+- ⢺
+- ⢻
+- ⢼
+- ⢽
+- ⢾
+- ⢿
+- ⣀
+- ⣁
+- ⣂
+- ⣃
+- ⣄
+- ⣅
+- ⣆
+- ⣇
+- ⣈
+- ⣉
+- ⣊
+- ⣋
+- ⣌
+- ⣍
+- ⣎
+- ⣏
+- ⣐
+- ⣑
+- ⣒
+- ⣓
+- ⣔
+- ⣕
+- ⣖
+- ⣗
+- ⣘
+- ⣙
+- ⣚
+- ⣛
+- ⣜
+- ⣝
+- ⣞
+- ⣟
+- ⣠
+- ⣡
+- ⣢
+- ⣣
+- ⣤
+- ⣥
+- ⣦
+- ⣧
+- ⣨
+- ⣩
+- ⣪
+- ⣫
+- ⣬
+- ⣭
+- ⣮
+- ⣯
+- ⣰
+- ⣱
+- ⣲
+- ⣳
+- ⣴
+- ⣵
+- ⣶
+- ⣷
+- ⣸
+- ⣹
+- ⣺
+- ⣻
+- ⣼
+- ⣽
+- ⣾
+- ⣿
+