to_pass 0.5.2 → 0.6.0

data/README.rdoc

@@ -9,6 +9,30 @@ This library encapsulates that and satisfies different usage scenarios.
 Currently, only two algorithms are provided. But they are YAML-Files, so it's
 extensible.
 
+
+== Installation
+
+to_pass is distributed as rubygem
+
+  $ gem install to_pass
+
+If you want to install from source, you can download a tarball or zipfile from
+github.
+
+  $ curl -L http://github.com/kronn/to_pass/tarball/v0.5.2 -o to_pass.tar.gz
+  $ tar -xzf to_pass.tar.gz
+  $ cd kronn-to_pass-HASHVALUE
+  $ ./setup.rb install
+
+The tarball contains a directory which has a part of the commit hash in its
+name. I leave it up to the user to change into the right directory. Shouldn't
+be too hard ;-)
+
+The same installation procedure works for git-checkouts, of course.
+
+The setup.rb installation has the additional benefit of installing the manpages
+for the gem and the file-formats.
+
 == Usage
 
 === IRB
@@ -16,11 +40,17 @@ extensible.
 ToPass::Integration provides a to_pass Method which transforms a sentence to a
 password.
 
-  irb> require 'lib/to_pass'
+  irb> require 'to_pass'
   irb> String.send(:include, ToPass::Integration)
   irb> "Da steht ein Pferd auf dem Flur".to_pass
   # => "Ds1P@dF"
 
+A more direct approach is the facade provided by ToPass::Base
+
+  irb> require 'to_pass'
+  irb> ToPass::Base.new('test', :basic_de).to_s
+  # => 't35t'
+
 === CLI
 
   $ to_pass "test"   # => t35t
@@ -28,11 +58,23 @@ password.
 
 === CLI with Pipes
 
-This example is Mac OSX-centric, but you should get the point.
+This example is a bit Mac OSX-centric, but you should get the point.
 
   $ echo "test" | to_pass | pbcopy
 
-== Note on Patches/Pull Requests
+== Development
+
+If you want to develop it further, patch something or are just plain curious:
+you're welcome.  This should get you started:
+
+  $ git clone git://github.com/kronn/to_pass.git
+  $ bundle install
+  $ rake
+
+Bundler is only used for installing dependencies. ToPass does not have any
+runtime dependencies, so Bundler does not make sense there.
+
+The usual pattern for github-projects applies:
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -41,8 +83,11 @@ This example is Mac OSX-centric, but you should get the point.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a
   commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Send me a pull request.
+
+I'll take a look at it and try to integrate it. If I cannot apply your changes
+or don't want to, I'll let you know.
 
 == Copyright
 
-Copyright (c) 2010 Matthias Viehweger. See LICENSE for details.
+Copyright (c) 2009-2010 Matthias Viehweger. See LICENSE for details.

data/Rakefile

@@ -12,20 +12,28 @@ begin
 
     rdoc.rdoc_dir = 'doc/rdoc'
     rdoc.title = "to_pass #{version}"
-    rdoc.options << '--fmt' << 'shtml'
+    rdoc.options << '--fmt=shtml'
+    rdoc.options << '--all'
+    rdoc.options << '--charset=utf-8'
     rdoc.template = 'direct'
     rdoc.rdoc_files.include('README*')
+    # rdoc.rdoc_files.include('LICENSE')
+    rdoc.rdoc_files.include('TODO')
     rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_files.include('data/**/*.rb')
   end
 rescue LoadError
 end
 begin
   desc 'generate manpages for project'
   task :man do
-    files = Dir['./man/*.ronn'].join(' ')
-    command = "ronn --html --roff --style=toc #{files}"
-
-    `#{command}`
+    [1,5].each do |section|
+      files = Dir["./man/*#{section}.ronn"]
+      `ronn --html --roff --style=toc #{files.join(' ')}`
+      FileUtils.mkdir "./man/man#{section}/"
+      FileUtils.mv Dir["./man/*.#{section}.html"], "./man/man#{section}/"
+      FileUtils.mv Dir["./man/*.#{section}"], "./man/man#{section}/"
+    end
   end
 end
 

data/TODO

@@ -1,22 +1,8 @@
 CURRENT
 ============================================================================
-- make it debian compatible (most of which is common sense anyway)
-  http://pkg-ruby-extras.alioth.debian.org/upstream-devs.html
-  ✓ Distribute your software as a source code archive
-    github allows that
-
-  - Use setup.rb
-    http://github.com/proutils/setup
-
-  ✓ Remove all references to rubygems in the software you ship
-  ✓ Don’t make your Rakefile depend on RubyGems
-
-  - Make your tests and examples usable outside of your directory tree
-    this might be achieved by using setup.rb anyway...
-
-  ✓ Use a shebang that works everywhere
-  ✓ Provide man pages for your binaries
-  ✓ If possible, maintain a backward-compatible API
+- have some RELEASE-NOTES or CHANGELOG
+  - GemSpec#post_install_message = filename
+    maybe http://github.com/proutils/vclog is useful...
 
 
 UP NEXT
@@ -29,8 +15,6 @@ UP NEXT
   - add command to output available converters
   - add command to output available algorithms
   - handle CLI with Thor
-- have some RELEASE-NOTES or CHANGELOG
-  - GemSpec#post_install_message = filename
 
 
 SOMEDAY

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.6.0

data/{lib → data}/to_pass/converters/expand_below.rb

@@ -3,6 +3,10 @@ require 'md5'
 module ToPass::Converters
   class ExpandBelow
     class << self
+      # Strings below the threshold are expanded with a md5-hash of them.
+      #
+      # The md5 is used to generate extra characters which are then added
+      # before and after the string.
       def expand_below(string, rules, threshold)
         if string.length < threshold.to_i
           digest = "#{MD5.hexdigest(string)}#{MD5.hexdigest(string).reverse}"

data/{lib → data}/to_pass/converters/reverse.rb

@@ -1,5 +1,6 @@
 module ToPass::Converters
   class Reverse
+    # The given string is reversed
     def self.reverse(string)
       string.reverse
     end

data/lib/to_pass/algorithm_reader.rb

@@ -4,58 +4,58 @@
 require 'pathname'
 require 'yaml'
 
-# The AlgorithmReader's primary API is to load the rules from a YAML-file
-# into a Hash.
-#
-# Algorithms are searched in the following locations
-#
-# 1. ~/.to_pass/algorithms
-# 2. bundled algorithms of gem
-#
-class ToPass::AlgorithmReader
-  attr_reader :load_path
-
-  def initialize(algorithm) # :nodoc:
-    @algorithm = algorithm
-    @load_path = []
-    [
-      '~/.to_pass/algorithms',
-      "#{File.dirname(__FILE__)}/algorithms"
-    ].each do |dir|
-      dir = Pathname.new(dir).expand_path
-      @load_path << dir if dir.exist?
+module ToPass
+  # The AlgorithmReader's primary API is to load the rules from a YAML-file
+  # into a Hash.
+  #
+  # Algorithms are searched in a list of standard directories. Those are defined
+  # and managed in ToPass::Directories
+  #
+  # see ToPass::Converter for usage of the loaded algorithm
+  class AlgorithmReader
+    attr_reader :load_path
+
+    def initialize(algorithm) # :nodoc:
+      @algorithm = algorithm
+      @load_path = []
+      ToPass::Directories[:standard].map do |dir|
+        dir + '/algorithms'
+      end.each do |dir|
+        dir = Pathname.new(dir).expand_path
+        @load_path << dir if dir.exist?
+      end
     end
-  end
 
-  class << self
-    # load an algorithm with a given identifier
-    def load(algorithm)
-      new(algorithm).load_from_file
-    end
+    class << self
+      # load an algorithm with a given identifier
+      def load(algorithm)
+        new(algorithm).load_from_file
+      end
 
-    # searches for available algorithms
-    def discover
-      new(nil).load_path.collect do |dir|
-        Dir["#{dir}/*.yml"]
-      end.flatten.compact.map do |fn|
-        File.basename(fn).gsub('.yml', '')
+      # searches for available algorithms
+      def discover
+        new(nil).load_path.collect do |dir|
+          Dir["#{dir}/*.yml"]
+        end.flatten.compact.map do |fn|
+          File.basename(fn).gsub('.yml', '')
+        end
       end
     end
-  end
 
-  def load_from_file # :nodoc:
-    fn = load_path.map do |dir|
-      file = Pathname.new("#{dir}/#{@algorithm}.yml")
+    def load_from_file # :nodoc:
+      fn = load_path.map do |dir|
+        file = Pathname.new("#{dir}/#{@algorithm}.yml")
 
-      if file.exist?
-        file
-      else
-        next
-      end
-    end.compact.first
+        if file.exist?
+          file
+        else
+          next
+        end
+      end.compact.first
 
-    raise LoadError, "algorithm #{@algorithm} could not be found in #{load_path}" if fn.nil?
+      raise LoadError, "algorithm #{@algorithm} could not be found in #{load_path}" if fn.nil?
 
-    YAML.load_file(fn.expand_path)
+      YAML.load_file(fn.expand_path)
+    end
   end
 end

data/lib/to_pass/base.rb

@@ -6,7 +6,9 @@ module ToPass
   #
   # Given a string and a algorithm identifier, the right rules
   # are loaded and applied to the string. With a simple "to_s",
-  # you can get the final password
+  # you can get the final password.
+  #
+  # see ToPass::AlgorithmReader and ToPass::Converter for details
   class Base
     # transform a string according to a certain algorithm
     def initialize( string, algorithm )

data/lib/to_pass/cli.rb

@@ -4,13 +4,29 @@
 require 'optparse'
 
 module ToPass
+  # ToPass::Cli wraps the ugly code needed for option-parsing an such
+  #
+  # The default values for the options can be passed in to make different
+  # executables behave differently.
   class Cli
+    # creates a new Cli-wrapper for option-parsing and such. Almost everthing
+    # needed is done inside the initalizer.
+    #
+    # The default options can be overriden. Defaults are:
+    #
+    #   options = {
+    #     :algorithm => 'basic_de',
+    #     :pipe_out  => false,
+    #     :pipe_in   => false
+    #   }
+    #
     def initialize(options = {})
       @options =  parse_options(options)
       @string =   get_input_string
       @password = transform
     end
 
+    # output the result of the string transformation
     def output
       if @options[:pipe_out]
         $stdout << @password

data/lib/to_pass/converter.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim:ft=ruby:enc=utf-8
 
-module ToPass
+module ToPass # :nodoc:
   # converts a given string into a password-like word
   #
   # the string can be a word or a sentence. everthing which
@@ -9,6 +9,8 @@ module ToPass
   #
   # a more complete description of the algorithm capabilities
   # is still pending.
+  #
+  # see ToPass::ConverterReader and ToPass::AlgorithmReader
   class Converter
     attr_accessor :converters, :rules
     # create a new converter, based on a set of conversion-rules

data/lib/to_pass/converter_reader.rb

@@ -3,105 +3,105 @@
 
 require 'pathname'
 
-# The ConverterReader's primary API is to load the converters from right
-# directories into an Array
-#
-# Converters are searched in the following locations
-#
-# 1. ~/.to_pass/converters
-# 2. bundled converters of gem
-#
-# The bundled converter are, however, lazily loaded with autoload.
-# User-provided converters are always required (for now).
-#
-class ToPass::ConverterReader
-  attr_reader :load_path, :loaded
-
-  def initialize # :nodoc:
-    @load_path  = []
-    @loaded     = []
-    @discovered = []
-    [
-      '~/.to_pass/converters',
-      "#{File.dirname(__FILE__)}/converters"
-    ].each do |dir|
-      dir = Pathname.new(dir).expand_path
-      @load_path << dir if dir.exist?
+module ToPass
+  # The ConverterReader's primary API is to load the converters from right
+  # directories into an Array
+  #
+  # Converters are searched in a list of standard directories. Those are defined
+  # and managed in ToPass::Directories
+  #
+  # The bundled converter are, however, lazily loaded with autoload.
+  # User-provided converters are always required (for now).
+  #
+  # see ToPass::Converter
+  class ConverterReader
+    attr_reader :load_path, :loaded
+
+    def initialize # :nodoc:
+      @load_path  = []
+      @loaded     = []
+      @discovered = []
+      ToPass::Directories[:standard].map do |dir|
+        dir + '/converters'
+      end.each do |dir|
+        dir = Pathname.new(dir).expand_path
+        @load_path << dir if dir.exist?
+      end
     end
-  end
 
-  # loads the converters
-  def load(converter)
-    unless @loaded.include?(converter.to_sym)
-      load_from_file(converter)
-      @loaded << converter
-    end
+    # loads the converters
+    def load(converter)
+      unless @loaded.include?(converter.to_sym)
+        load_from_file(converter)
+        @loaded << converter
+      end
 
-    classname(converter)
-  end
+      classname(converter)
+    end
 
-  # discover a list of available converters
-  def discover
-    search_for_converters
-  end
+    # discover a list of available converters
+    def discover
+      search_for_converters
+    end
 
-  private
-
-  def search_for_converters # :nodoc:
-    files = load_path.collect do |directory|
-      dir = Pathname.new(directory)
-      if dir.exist?
-        Dir["#{dir}/*.rb"].collect do |converter|
-          fn_re = %r!/([^/]*)\.rb$!i
-          name  = converter.match(fn_re)
-          if name
-            name[1].to_sym
+    private
+
+    def search_for_converters # :nodoc:
+      files = load_path.collect do |directory|
+        dir = Pathname.new(directory)
+        if dir.exist?
+          Dir["#{dir}/*.rb"].collect do |converter|
+            fn_re = %r!/([^/]*)\.rb$!i
+            name  = converter.match(fn_re)
+            if name
+              name[1].to_sym
+            end
           end
         end
-      end
-    end.flatten.compact
+      end.flatten.compact
 
-    raise LoadError, "converters could not be found in #{load_path}" if files.nil?
+      raise LoadError, "converters could not be found in #{load_path}" if files.nil?
 
-    @discovered = files
-  end
+      @discovered = files
+    end
 
-  def load_from_file(converter) # :nodoc:
-    fn = load_path.collect do |dir|
-      path = Pathname.new("#{dir}/#{converter}.rb").expand_path
+    def load_from_file(converter) # :nodoc:
+      fn = load_path.collect do |dir|
+        path = Pathname.new("#{dir}/#{converter}.rb").expand_path
 
-      if path.exist?
-        path
-      else
-        next
-      end
-    end.compact.first
+        if path.exist?
+          path
+        else
+          next
+        end
+      end.compact.first
 
-    raise LoadError, "converter '#{converter}' could not be found in #{load_path.join(' ')}" if fn.nil?
+      raise LoadError, "converter '#{converter}' could not be found in #{load_path.join(' ')}" if fn.nil?
 
-    if require fn
-      classname converter
+      if require fn
+        classname converter
+      end
     end
-  end
 
-  def classname(converter) # :nodoc:
-    constantize("ToPass::Converters::#{camel_case(converter)}")
-  end
+    def classname(converter) # :nodoc:
+      constantize("ToPass::Converters::#{camel_case(converter)}")
+    end
 
-  def constantize(camel_cased_word) # :nodoc:
-    names = camel_cased_word.split('::')
-    names.shift if names.empty? || names.first.empty?
+    def constantize(camel_cased_word) # :nodoc:
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
 
-    constant = Object
-    names.each do |name|
-      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
     end
-    constant
-  end
 
-  def camel_case(underscored_word) # :nodoc:
-    camel_cased_word = underscored_word.to_s.split('_').map do |part|
-      part.capitalize
-    end.join('')
+    def camel_case(underscored_word) # :nodoc:
+      camel_cased_word = underscored_word.to_s.split('_').map do |part|
+        part.capitalize
+      end.join('')
+    end
   end
 end

data/lib/to_pass/converters.rb

@@ -2,12 +2,17 @@
 # vim:ft=ruby:enc=utf-8
 
 module ToPass
-  # The Converters-class is a collection of available
-  # Transformations. Every method is given a string as single argument
-  # and is expected to return a transformed string. The only exception
-  # from this is general rule is the replace method which also takes a
-  # replacement table.
+  # The Converters-module is a collection of available
+  # Transformations.
   #
+  # Each Transformation is wrapped in a class which has one class-method. This
+  # method is given a string as single argument.
+  # If the method can take arguments, then three parameters are passed:
+  # the string, the full rule-set (algorithm definition hash) and the parameter
+  # from the algorithm.
+  # see ToPass::Converter#apply_rule for details
+  #
+  # All transformations are expected to return only the transformed string.
   # This enables chaining and eases extending the capabilities.
   module Converters
   end

data/lib/to_pass/directories.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# vim:ft=ruby:enc=utf-8
+
+require 'rbconfig'
+
+module ToPass
+  # Wrapper for the search directories. Primary purpose is to keep the dirty
+  # part in one place instead of scattered throughout the project.
+  #
+  # Used by ToPass::AlgorithmReader and ToPass::ConverterReader
+  class Directories
+    class << self
+      # get a directory or a list of directories
+      def [](key)
+        case key
+        when :user, :data, :base, :source_data
+          all[key]
+        when :standard
+          [ all[:user], all[:data], all[:source_data] ]
+        end
+      end
+
+      private
+
+      # list of all direcotries used by this project
+      def all
+        {
+          :user => "~/.#{APP_NAME}",
+          :data => "#{RbConfig::CONFIG['data-dir']}/#{APP_NAME}",
+          :base => File.expand_path("#{File.dirname(__FILE__)}/../.."),
+          :source_data => File.expand_path("#{File.dirname(__FILE__)}/../../data/#{APP_NAME}"),
+        }
+      end
+    end
+  end
+end

data/lib/to_pass/integration.rb

@@ -8,6 +8,7 @@
 #   String.send(:include, ToPass::Integration)
 #   puts "Da steht ein Pferd auf dem Flur".to_pass => 'Ds1P@dF'
 #
+# See ToPass::Base for more details
 module ToPass::Integration
   # simplified password-creation
   def to_pass( algorithm = 'basic_de' )

data/lib/to_pass/version.rb

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 # vim:ft=ruby:enc=utf-8
 
-# Library to convert a String into a Password
 module ToPass
   # version of gem, read directly from the VERSION-File
   VERSION = File.read(File.join(File.dirname(__FILE__), '../../VERSION')).strip

data/lib/to_pass.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
-# vim:ft=ruby:enc=utf-8
 
 # Library to convert a String into a Password
+#
+# see README.rdoc for details
 module ToPass
   autoload :VERSION,           'lib/to_pass/version'
   autoload :DATE,              'lib/to_pass/version'
@@ -13,5 +14,8 @@ module ToPass
   autoload :Converter,         'lib/to_pass/converter'
   autoload :ConverterReader,   'lib/to_pass/converter_reader'
   autoload :Converters,        'lib/to_pass/converters'
+  autoload :Directories,       'lib/to_pass/directories'
   autoload :Integration,       'lib/to_pass/integration'
 end
+
+# vim:ft=ruby:enc=utf-8

data/man/{to_pass.1 → man1/to_pass.1}

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TO_PASS" "1" "July 2010" "" ""
+.TH "TO_PASS" "1" "August 2010" "" ""
 .
 .SH "NAME"
 \fBto_pass\fR \- transform a string to a password

data/man/{to_pass.1.html → man1/to_pass.1.html}

@@ -151,7 +151,7 @@ ti1pwtsi2ltti@pf
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>July 2010</li>
+    <li class='tc'>August 2010</li>
     <li class='tr'>to_pass(1)</li>
   </ol>
 

data/man/{to_pass-algorithm.5 → man5/to_pass-algorithm.5}

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TO_PASS\-ALGORITHM" "5" "July 2010" "" ""
+.TH "TO_PASS\-ALGORITHM" "5" "August 2010" "" ""
 .
 .SH "NAME"
 \fBto_pass\-algorithm\fR \- algorithm\-description for to_pass(1)

data/man/{to_pass-algorithm.5.html → man5/to_pass-algorithm.5.html}

@@ -81,7 +81,7 @@
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
 <p>An algorithms is a simple list of conversions which are applied to the input
-string. The algorithm file is a <a href="http://man.cx/yaml(3pm)" class="man-ref">yaml<span class="s">(3pm)</span></a> file.  <code>yaml</code> looks like a list of
+string. The algorithm file is a <a href="http://man.cx/yaml(3pm)" class="man-ref">yaml<span class="s">(3pm)</span></a> file. <code>yaml</code> looks like a list of
 key-value pairs. Nesting is done by indentation (2 spaces). Consecutive lines
 which begin with a <code>-</code> are considered an array.</p>
 
@@ -176,7 +176,7 @@ design however is intentionally simple and constrained.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>July 2010</li>
+    <li class='tc'>August 2010</li>
     <li class='tr'>to_pass-algorithm(5)</li>
   </ol>
 

data/man/{to_pass-converter.5 → man5/to_pass-converter.5}

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TO_PASS\-CONVERTER" "5" "July 2010" "" ""
+.TH "TO_PASS\-CONVERTER" "5" "August 2010" "" ""
 .
 .SH "NAME"
 \fBto_pass\-converter\fR \- converter\-class for to_pass(1)

data/man/{to_pass-converter.5.html → man5/to_pass-converter.5.html}

@@ -155,7 +155,7 @@ end
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>July 2010</li>
+    <li class='tc'>August 2010</li>
     <li class='tr'>to_pass-converter(5)</li>
   </ol>
 

data/test/helper.rb

@@ -4,9 +4,12 @@
 require 'test/unit/testcase'
 require 'test/unit' unless defined?(Test::Unit)
 require 'mocha'
+require 'rbconfig'
 
 base_path = ( File.expand_path(File.dirname(__FILE__)+'/..') )
-$LOAD_PATH << base_path unless $LOAD_PATH.include?(base_path)
+if File.exist?(base_path + '/lib/to_pass')
+  $LOAD_PATH << base_path unless $LOAD_PATH.include?(base_path)
+end
 
 Test::Unit::TestCase.class_eval do
   def assert_class_defined(klass)
@@ -25,6 +28,13 @@ Test::Unit::TestCase.class_eval do
     end
   end
 
+  def standard_directories
+    [
+      '~/.to_pass' , # user
+      "#{RbConfig::CONFIG['data-dir']}/#{ToPass::APP_NAME}", # installed
+      "#{File.dirname(__FILE__)}/../data/#{ToPass::APP_NAME}", # source [in github]
+    ]
+  end
 
   def with_algorithm_in_user_dir
     `mkdir -p ~/.to_pass/algorithms; cp -f #{File.dirname(__FILE__)}/fixtures/user_alg.yml ~/.to_pass/algorithms/user_alg.yml`

data/test/test_algorithm_reader.rb

@@ -28,10 +28,7 @@ class TestAlgorithmReader < Test::Unit::TestCase
   end
 
   def test_load_path_contains_standard_dirs
-    dirs = [
-      '~/.to_pass/algorithms' ,
-      "#{File.dirname(__FILE__)}/../lib/to_pass/algorithms"
-    ]
+    dirs = standard_directories.map { |path| "#{path}/algorithms"}
 
     Pathname.any_instance.expects(:exist?).times(dirs.size).returns(true)
 

data/test/test_base.rb

@@ -30,4 +30,18 @@ class TestBase < Test::Unit::TestCase
       assert eval(Pathname.new("#{File.dirname(__FILE__)}/../to_pass.gemspec").expand_path.read).validate
     end
   end
+
+  def test_directories
+    dirs = ToPass::Directories
+
+    assert defined?(dirs)
+    assert_respond_to dirs, :[]
+
+    assert_equal '~/.to_pass', dirs[:user]
+    assert_equal "#{RbConfig::CONFIG['data-dir']}/#{ToPass::APP_NAME}", dirs[:data]
+    assert_equal Pathname.new("#{File.dirname(__FILE__)}/../").expand_path.to_s, dirs[:base]
+    assert_equal Pathname.new("#{File.dirname(__FILE__)}/../data/#{ToPass::APP_NAME}").expand_path.to_s, dirs[:source_data]
+
+    assert_equal [ dirs[:user], dirs[:data], dirs[:source_data] ], dirs[:standard]
+  end
 end

data/test/test_converter_reader.rb

@@ -34,10 +34,7 @@ class TestConverterReader < Test::Unit::TestCase
   end
 
   def test_load_path_contains_standard_dirs
-    dirs = [
-      '~/.to_pass/converters',
-      "#{File.dirname(__FILE__)}/../lib/to_pass/converters"
-    ]
+    dirs = standard_directories.map { |path| "#{path}/converters"}
 
     Pathname.any_instance.expects(:exist?).times(dirs.size).returns(true)
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: to_pass
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 2
-  version: 0.5.2
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Matthias Viehweger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 +02:00
+date: 2010-08-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sdoc
+  name: ronn
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -60,6 +60,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: "    Passwords should be easy to remember and hard to guess.\n    One technique is to have a sentence which can be easily remembered transformed to a password.\n\n    Pluggable algorithms and converters allow customization of the transformation process.\n"
 email: kronn@kronn.de
 executables: 
@@ -68,7 +82,6 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
 - TODO
 files: 
@@ -81,34 +94,35 @@ files:
 - bin/password_of
 - bin/to_pass
 - lib/to_pass/algorithm_reader.rb
-- lib/to_pass/algorithms/basic_de.yml
-- lib/to_pass/algorithms/basic_en.yml
-- lib/to_pass/algorithms/secure.yml
 - lib/to_pass/base.rb
 - lib/to_pass/cli.rb
 - lib/to_pass/converter.rb
 - lib/to_pass/converter_reader.rb
-- lib/to_pass/converters/collapse_chars.rb
-- lib/to_pass/converters/downcase.rb
-- lib/to_pass/converters/expand_below.rb
-- lib/to_pass/converters/first_chars.rb
-- lib/to_pass/converters/remove_repetition.rb
-- lib/to_pass/converters/replace.rb
-- lib/to_pass/converters/reverse.rb
-- lib/to_pass/converters/swapcase.rb
 - lib/to_pass/converters.rb
+- lib/to_pass/directories.rb
 - lib/to_pass/integration.rb
 - lib/to_pass/version.rb
 - lib/to_pass.rb
+- data/to_pass/algorithms/basic_de.yml
+- data/to_pass/algorithms/basic_en.yml
+- data/to_pass/algorithms/secure.yml
+- data/to_pass/converters/collapse_chars.rb
+- data/to_pass/converters/downcase.rb
+- data/to_pass/converters/expand_below.rb
+- data/to_pass/converters/first_chars.rb
+- data/to_pass/converters/remove_repetition.rb
+- data/to_pass/converters/replace.rb
+- data/to_pass/converters/reverse.rb
+- data/to_pass/converters/swapcase.rb
 - man/index.txt
-- man/to_pass-algorithm.5
-- man/to_pass-algorithm.5.html
+- man/man1/to_pass.1
+- man/man1/to_pass.1.html
+- man/man5/to_pass-algorithm.5
+- man/man5/to_pass-algorithm.5.html
+- man/man5/to_pass-converter.5
+- man/man5/to_pass-converter.5.html
 - man/to_pass-algorithm.5.ronn
-- man/to_pass-converter.5
-- man/to_pass-converter.5.html
 - man/to_pass-converter.5.ronn
-- man/to_pass.1
-- man/to_pass.1.html
 - man/to_pass.1.ronn
 - test/fixtures/user_alg.yml
 - test/fixtures/user_converter.rb
@@ -127,7 +141,10 @@ licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+- --charset=utf-8
+- --fmt=shtml
+- --all
+- --include=data/to_pass/converters/
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement