oro 1.0.0.2

data/lib/oro/parts/number.yml

@@ -0,0 +1,13 @@
+# ('0'..'9').to_a
+
+---
+- "0"
+- "1"
+- "2"
+- "3"
+- "4"
+- "5"
+- "6"
+- "7"
+- "8"
+- "9"

data/lib/oro/parts/punctuation.yml

@@ -0,0 +1,34 @@
+# %w(~ ` ! @ # $ % ^ & * ( ) _ - + = { } [ ] | / : ; ' < > , . ?)
+# Bad: \ "
+
+---
+- "~"
+- "`"
+- "!"
+- "@"
+- "#"
+- "$"
+- "%"
+- "^"
+- "&"
+- "*"
+- "("
+- ")"
+- "_"
+- "-"
+- "+"
+- "="
+- "{"
+- "}"
+- "["
+- "]"
+- "|"
+- "/"
+- ":"
+- ";"
+- "'"
+- "<"
+- ">"
+- ","
+- "."
+- "?"

data/lib/oro/password.rb

@@ -0,0 +1,114 @@
+require_relative 'parts'
+require_relative 'helpers'
+require_relative 'settings'
+require_relative 'errors'
+require_relative 'settings_parser'
+
+# A class epresenting a complete password
+class Password
+  include SettingsAccessors
+  attr_accessor :settings
+  attr_reader :virgin_settings
+
+  # Class methods
+
+  # Singleton helper returning classes required by password
+  def self.components_for(settings)
+    parts = []
+    settings.plan.each { |part| parts << Object.const_get(part[0]) }
+    parts.uniq
+  end
+
+  # Returns classes for all installed parts
+  def self.installed_part_classes
+    Part.descendants
+  end
+
+  # Returns string names for all installed parts
+  def self.installed_parts
+    Part.descendants.map(&:name)
+  end
+
+  # Returns a hash of "short" => "long" part identifiers
+  def self.installed_part_switches
+    switches = {} # FIXME: This apparently can't be memoized (?)
+    installed_parts.each do |part|
+      part.downcase.chars.each { |char| switches.key?(char) ? next : (switches[char] = part; break) }
+    end
+    switches
+  end
+
+  # Returns a help message for all installed parts
+  def self.installed_parts_help
+    help = []
+    installed_part_switches.each_pair do |s, l|
+      help << "    #{s}[n] #{l} part" # FIXME: There has to be a string format approach for making this match up.
+    end
+    help.join("\n")
+  end
+
+  # Returns a text list of metadata about all installed parts
+  def self.installed_parts_summary
+    count = 0
+    Password.installed_part_classes.each do |klass|
+      klass.listify
+      count += klass.count
+      puts klass.to_s
+    end
+    "Total list members: #{count}"
+  end
+
+  # Instance methods
+
+  def initialize(clio = '')
+    # Parse clio for Config and Actions
+    @settings = SettingsParser.parse(clio)
+
+    # Parse, manually, remaining non-switch plan parts
+    clio.each do |part|
+      match = (/\b([a-zA-Z]{1})([0-9]*)\b/).match(part)
+      if match
+        @settings.plan.push([Password.installed_part_switches[match[1]], match[2] == '' ? nil : match[2].to_i]) # nil behaves better with --prefs
+        raise NoMatchingListError.new("No matching dictionary for '#{match[1]}'") unless Password.installed_part_switches.keys.include?(match[1])
+      end
+    end
+
+    # Add help for installed parts if needed
+    @settings.actions[:help].gsub!(/INSTALLED_PARTS_HELP/, Password.installed_parts_help) if @settings.actions[:help]
+
+    # Save virgin parsed settings
+    @virgin_settings = @settings.dup
+
+    # Use saved preferences plan, then defaults plan, if no plan provided in clio
+    # FIXME: Will require updating to reflect the approach above.
+    @settings.plan = (Preferences.instance.plan.empty? ? Defaults.instance.plan : Preferences.instance.plan) if @settings.plan.empty?
+
+    # Settings merged with Preferences, that merged with Defaults
+    @settings.config = Defaults.instance.config.merge(Preferences.instance.config.merge(@settings.config))
+
+    # Add lists for required part classes only, check for non-contiguous lists
+    Password.components_for(@settings).each do |klass|
+      klass.listify
+      fail ListIsNonContiguousError, "Dictionary #{klass.name} is noncontiguous and requires at least one entry for each range member\n#{klass.to_s}" unless klass.contiguous?
+    end
+  end
+
+  def length
+    length = 0
+    @settings.plan.each { |part| length += part[1].nil? ? Object.const_get(part[0]).middle : part[1] }
+    @settings.config.key?(:l33t) && @settings.config[:l33t] == true ? "#{length}+" : length.to_s # Precision is out the window with l33t; && likely uneeded
+  end
+
+  def result
+    current_password = []
+
+    @settings.plan.each do |plan_part|
+      part_klass = self.class.const_get(plan_part[0]) # The part descriptor from oro settings
+      plan_part[1] = part_klass.middle if plan_part[1].nil?
+      current_password << part_klass.get(plan_part[1], @settings.config) # Passing config, Parts don't currently rely on the Preferences singleton
+    end
+
+    current_password.shuffle! if @settings.config[:shuffle]
+    current_password.join
+  end
+end

data/lib/oro/settings.rb

@@ -0,0 +1,44 @@
+require 'singleton'
+require 'yaml'
+require 'ostruct'
+require_relative 'settings_parser'
+require_relative 'helpers'
+
+# Singleton class representing default settings
+class Defaults
+  include ClioHelper, SettingsAccessors, SettingsInspector, Singleton
+  FILE = File.join(File.dirname(__FILE__), 'defaults.yml')
+
+  def initialize
+    settings
+  end
+
+  def settings
+    @settings ||= YAML.load(File.read(FILE))
+  end
+end
+
+# Singleton class representing preferred settings
+class Preferences
+  include ClioHelper, SettingsAccessors, SettingsInspector, Singleton
+  FILE = File.join(Dir.home, '.oro')
+
+  def initialize
+    reset_defaults unless FileTest.readable?(FILE) # Create preference file if missing
+    settings
+  end
+
+  def settings
+    @settings ||= YAML.load(File.read(FILE))
+  end
+
+  def settings=(settings)
+    settings.delete_field('actions') if settings.actions
+    File.open(FILE, 'w') { |f| f.write YAML.dump(settings) }
+    @settings = settings
+  end
+
+  def reset_defaults
+    self.settings = Defaults.instance.settings
+  end
+end

data/lib/oro/settings_parser.rb

@@ -0,0 +1,105 @@
+require 'ostruct'
+require 'optparse'
+
+# One job, recieves String command line settings, parses them and returns OpenStruct structured settings.
+class SettingsParser
+  def self.parse(argv) # Ie: an ARGV-style array of the clio
+    settings = OpenStruct.new(:plan => [], :config => {}, :actions => {})
+
+    clio_parser = OptionParser.new do |clio_parser_config|
+      clio_parser_config.program_name = 'Oro'
+      clio_parser_config.release = 'Command Line Version'
+      clio_parser_config.version = %w(1 0 0)
+      clio_parser_config.banner = 'Usage: oro [settings]'
+      clio_parser_config.separator ''
+
+      # Parts
+      clio_parser_config.separator 'Part settings (all lengths optional)'
+      clio_parser_config.separator 'INSTALLED_PARTS_HELP'
+
+      # Config
+      clio_parser_config.separator ''
+      clio_parser_config.separator 'Config settings'
+
+      clio_parser_config.on('-iMANDATORY', '--iterations=MANDATORY', Integer, 'The number of passwords to generate') do |val|
+        settings.config[:iterations] = val
+      end
+
+      clio_parser_config.on('-c', '--[no-]capitalize', 'Capitalize every word part') do |val|
+        settings.config[:capitalize] = val
+      end
+
+      clio_parser_config.on('-r', '--[no-]capitalize-random', 'Randomly capitalize one letter in every word part') do |val|
+        settings.config[:capitalize_random] = val
+      end
+
+      clio_parser_config.on('-l', '--[no-]l33t', 'Make one l33t-style replacement per word part') do |val|
+        settings.config[:l33t] = val
+      end
+
+      clio_parser_config.on('-s', '--[no-]shuffle', 'Randomize map parts') do |val|
+        settings.config[:shuffle] = val
+      end
+
+      clio_parser_config.on('-f', '--format=MANDATORY', %w(json yml yaml string), 'Results format: string, json, yaml') do |val|
+        settings.config[:format] = val
+      end
+
+      clio_parser_config.on('-e', '--separator[=OPTIONAL]', 'Separator characters') do |val|
+        settings.config[:separator] = eval("val=\"#{val}\"") # FIXME: The horror, but how else to take \n as an option and retain it's control nature?  The eval should be removed.
+      end
+
+      # Actions
+      clio_parser_config.separator ''
+      clio_parser_config.separator 'Action settings'
+      clio_parser_config.on('--lists', 'Show all available lists') do |val|
+        settings.actions[:lists] = val
+      end
+
+      clio_parser_config.on('--prefs', '--preferences', 'Show your current preferences') do |val|
+        settings.actions[:preferences] = val
+      end
+
+      clio_parser_config.on('--defaults', 'Show system defaults') do |val|
+        settings.actions[:defaults] = val
+      end
+
+      clio_parser_config.on('--set', 'Set passed settings as your preferences') do |val|
+        settings.actions[:set] = val
+      end
+
+      clio_parser_config.on('--reset', 'Reset your preferences to system defaults') do |val|
+        settings.actions[:reset] = val
+      end
+
+      clio_parser_config.on('-v', '--verbose', 'Provide verbose feedback, dictionary metadata, and statistics when run') do |val|
+        settings.actions[:verbose] = val
+      end
+
+      clio_parser_config.on('-h', '--help', 'Print this dialog') do
+        settings.actions[:help] = clio_parser_config.to_s
+      end
+
+      clio_parser_config.on('--version', 'Show version') do
+        settings.actions[:version] = clio_parser_config.ver
+      end
+
+      # Examples
+      clio_parser_config.separator ''
+      clio_parser_config.separator 'Examples'
+      clio_parser_config.separator '    oro e9 p1 n3 -s --set'
+      clio_parser_config.separator '    oro n4 -e"-" -i4'
+      clio_parser_config.separator '    oro n99 -i10'
+      clio_parser_config.separator '    oro e10 n5 -fjson'
+
+      clio_parser_config.separator ''
+      clio_parser_config.separator 'See dictionary source files for associated licence attributions.'
+      clio_parser_config.separator ''
+    end # end clio_parser
+
+    argv = argv.is_a?(Array) ? argv : argv.split
+    clio_parser.parse!(argv)
+
+    settings
+  end # end parse
+end # end class

data/oro.gemspec

@@ -0,0 +1,16 @@
+require 'rake' # Provide FileList class
+
+Gem::Specification.new do |s|
+  s.name        = 'oro'
+  s.version     = '1.0.0.2'
+  s.date        = '2016-03-02'
+  s.summary     = 'Oro for passwords...'
+  s.description = 'A flexible, command-line utility which generates memorable passwords. The enemy knows the system -- Claude Shannon / Auguste Kerckhoffs'
+  s.authors     = ['Joel Wagener']
+  s.email       = 'bayou.marcus@gmail.com'
+  s.executables = ['oro']
+  s.files       = FileList['**/**/*']
+  s.homepage    = 'https://github.com/bayou-marcus/oro'
+  s.license     = 'The MIT License.' # http://choosealicense.com
+  s.required_ruby_version = '~> 2.2'
+end

data/test/preference_test.rb

@@ -0,0 +1,40 @@
+require 'minitest/autorun'
+# require 'yaml'
+# require_relative '../lib/oro/settings' # FIXME Should this even be needed?  See Rakefile for the fail.
+# require_relative '../lib/oro/settings_parser' # FIXME Should this even be needed?  See Rakefile for the fail.
+
+class TestPreference < Minitest::Test
+
+  def setup
+    @clio = '-w7 -p -n3 -i10 -c -dDeutsch'
+    @PREFERENCE_FILE = Preference::PREFERENCE_FILE
+    @prfs = Preference.instance # Creates preference file
+  end
+
+  def test_that_preference_file_exists
+    assert FileTest.readable?(@PREFERENCE_FILE), "#{@PREFERENCE_FILE} is missing"
+  end
+
+  def test_reset_defaults_sets_defaults
+    @prfs.reset_defaults
+    assert_equal @prfs.get, YAML.load(File.read(Preference::DEFAULTS_FILE))
+  end
+
+  def test_get_returns_open_struct_with_format_and_config
+    @prfs.set(@clio)
+    structured_options = @prfs.get
+    assert (structured_options.class.name == 'OpenStruct' and structured_options.to_h.has_key?(:format) and structured_options.to_h.has_key?(:config)), 'get_structured not OpenStruct or missing format or config'
+  end
+
+  def test_get_defaults_equals_defaults
+    assert_equal @prfs.get_defaults, YAML.load(File.read(Preference::DEFAULTS_FILE))
+  end
+
+  def teardown
+    remove_instance_variable(:@clio)
+    remove_instance_variable(:@PREFERENCE_FILE)
+    remove_instance_variable(:@prfs)
+    # File.delete(@PREFERENCE_FILE) # FIXME "setup and teardown runs before/after each test" doesn't manage the preference file accurately so unable to test its creation; perhaps what the filesystem reports is out of sync
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: oro
+version: !ruby/object:Gem::Version
+  version: 1.0.0.2
+platform: ruby
+authors:
+- Joel Wagener
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies: []
+description: A flexible, command-line utility which generates memorable passwords.
+  The enemy knows the system -- Claude Shannon / Auguste Kerckhoffs
+email: bayou.marcus@gmail.com
+executables:
+- oro
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.textile
+- README.md
+- Rakefile
+- bin/oro
+- lib/oro.rb
+- lib/oro/defaults.yml
+- lib/oro/errors.rb
+- lib/oro/helpers.rb
+- lib/oro/parts.rb
+- lib/oro/parts/braille.yml
+- lib/oro/parts/emoticon.yml
+- lib/oro/parts/english.yml
+- lib/oro/parts/german.yml
+- lib/oro/parts/latin.yml
+- lib/oro/parts/linnaeus.yml
+- lib/oro/parts/number.yml
+- lib/oro/parts/punctuation.yml
+- lib/oro/password.rb
+- lib/oro/settings.rb
+- lib/oro/settings_parser.rb
+- oro.gemspec
+- test/preference_test.rb
+homepage: https://github.com/bayou-marcus/oro
+licenses:
+- The MIT License.
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Oro for passwords...
+test_files: []