to_pass 0.8.0 → 0.9.0

data/README.rdoc

@@ -19,7 +19,7 @@ to_pass is distributed as rubygem
 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.7.0 -o to_pass.tar.gz
+  $ curl -L https://github.com/kronn/to_pass/tarball/v0.9.0 -o to_pass.tar.gz
   $ tar -xzf to_pass.tar.gz
   $ cd kronn-to_pass-HASHVALUE
   $ ./setup.rb install
@@ -50,6 +50,8 @@ 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'
+  irb> ToPass::Base.new('test', :basic_de).password
+  # => 't35t'
 
 === CLI
 
@@ -62,6 +64,27 @@ This example is a bit Mac OSX-centric, but you should get the point.
 
   $ echo "test" | to_pass | pbcopy
 
+=== Customizing
+
+In order to fully utilize to_pass, you need to make your own algorithm.
+
+You can get a list of existing algorithms through the CLI:
+
+  $ to_pass --algorithms       # or: to_pass -A
+
+Likewise, you can get a list of existing converters:
+
+  $ to_pass --converters       # or: to_pass -C
+
+=== Configuration
+
+You can customize the default behaviour by adding a configuration file like this
+
+  $ mkdir ~/.to_pass
+  $ echo 'algorithm: basic_de' >> ~/.to_pass/config
+  $ echo 'pipe_out: false' >> ~/.to_pass/config
+  $ echo 'pipe_in: false' >> ~/.to_pass/config
+
 == Development
 
 If you want to develop it further, patch something or are just plain curious:
@@ -110,4 +133,4 @@ And of course, there is a README, but I think you have found it already...
 
 == Copyright
 
-Copyright (c) 2009-2010 Matthias Viehweger. See doc/LICENSE for details.
+Copyright (c) 2009-2011 Matthias Viehweger. See doc/LICENSE for details.

data/TODO

@@ -3,21 +3,23 @@ CURRENT
 ✔ let tests run separated
 - Improve CLI-Code
   ✔ rescue OptionParser::InvalidOption with help screen
-  - add ability to execute commands == handle CLI with Thor ?
-  - add command to generate configuration path
-  - add command to output available converters
-  - add command to output available algorithms
+  ✔ add ability to execute commands == handle CLI with Thor ?
+    => done with switches to avoid having a transform command
+  ✔ add command to output available converters
+  ✔ add command to output available algorithms
   - add option '-c, --config PATH - Configuration Path (default is ~/.to_pass)'
+  - add command to generate configuration path
+✔ make default algorithm configurable in .to_passrc [kronn/to_pass GH-1]
 
 
 UP NEXT
 ============================================================================
 - make secure algorithm default
-- make default algorithm configurable in .to_passrc [kronn/to_pass GH-1]
 - make tests faster
 - integrate better with YARD
   - add the TODO file, the doc/ directory
   - also show protected and private methods because I want to have a complete documentation
+- make ConverterReader a better child of FileReader
 
 
 SOMEDAY
@@ -26,6 +28,7 @@ SOMEDAY
   move decision wether a string is a word or a sentence into algorithm definition.
   add task to validate user supplied algorithms and converters
   check out and maybe integrate https://github.com/stephencelis/rdoctest
+  i18n && l10n of messages
   ?? replace Rake with Thor
 
 

data/data/to_pass/config

@@ -0,0 +1,5 @@
+algorithm: basic_de
+pipe_out: false
+pipe_in: false
+
+# vim:ft=yaml

data/lib/to_pass.rb

@@ -14,6 +14,8 @@ module ToPass
   autoload :DATE,              'to_pass/version'
   autoload :APP_NAME,          'to_pass/version'
 
+  autoload :FileReader,        'to_pass/file_reader'
+  autoload :ConfigReader,      'to_pass/config_reader'
   autoload :AlgorithmReader,   'to_pass/algorithm_reader'
   autoload :Base,              'to_pass/base'
   autoload :Cli,               'to_pass/cli.rb'

data/lib/to_pass/algorithm_reader.rb

@@ -1,6 +1,5 @@
 # vim:ft=ruby:fileencoding=utf-8
 
-require 'pathname'
 require 'yaml'
 
 module ToPass
@@ -11,50 +10,23 @@ module ToPass
   # and managed in ToPass::Directories
   #
   # see ToPass::Converter for usage of the loaded algorithm
-  class AlgorithmReader
-    attr_reader :load_path
-
+  class AlgorithmReader < FileReader
     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
+      super(algorithm, 'algorithms')
     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', '')
-        end
+      def extension # :nodoc:
+        'yml'
       end
     end
 
     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
-
-      raise LoadError, "algorithm #{@algorithm} could not be found in #{load_path}" if fn.nil?
+      fn = super
 
       YAML.load_file(fn.expand_path)
+    rescue LoadError
+      raise LoadError, "algorithm #{@file} could not be found in #{load_path}" if fn.nil?
     end
   end
 end

data/lib/to_pass/base.rb

@@ -5,20 +5,23 @@ 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. The password is also readable
+  # directly through ToPass::Base#password.
   #
   # see ToPass::AlgorithmReader and ToPass::Converter for details
   class Base
+    attr_reader :password
+
     # transform a string according to a certain algorithm
-    def initialize( string, algorithm )
+    def initialize(string, algorithm)
       rules = AlgorithmReader.load(algorithm)
-      converter = Converter.new( rules )
+      converter = Converter.new(rules)
       @password = converter.convert(string)
     end
 
     # return the generated password
     def to_s
-      @password
+      password
     end
   end
 end

data/lib/to_pass/cli.rb

@@ -19,6 +19,13 @@ module ToPass
     #     :pipe_in   => false
     #   }
     #
+    # If you want to override always, you can create a config file with the
+    # following name:
+    #
+    #   ~/.to_pass/config
+    #
+    # The file is expected to be a YAML-File. Keys and values are transformed
+    # symbols automatically. See ToPass::ConfigReader for details.
     def initialize(options = {})
       @options =  parse_options(options)
       @string =   get_input_string
@@ -34,6 +41,32 @@ module ToPass
       end
     end
 
+    class << self
+      # output list of algorithms
+      def algorithms
+        puts ""
+        puts "  available password algorithms"
+        puts "  ============================================"
+        AlgorithmReader.discover.each do |algorithm|
+          puts "  - #{algorithm}"
+        end
+        puts "  ============================================"
+        puts ""
+      end
+
+      # output list of converters
+      def converters
+        puts ""
+        puts "  available converters for password algorithms"
+        puts "  ============================================"
+        ConverterReader.new.discover.each do |converter|
+          puts "  - #{converter}"
+        end
+        puts "  ============================================"
+        puts ""
+      end
+    end
+
     protected
 
     # parse the options
@@ -42,7 +75,9 @@ module ToPass
         :algorithm => 'basic_de',
         :pipe_out  => false,
         :pipe_in   => false
-      }.merge(options)
+      }.merge(
+        ConfigReader.load
+      ).merge(options)
 
       cli_options = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename($0)} [options] passphrase"
@@ -56,6 +91,34 @@ module ToPass
           options[:pipe_out] = value
         end
 
+        ## ACTIONS
+
+        # not used at the moment
+        #
+        # opts.on('-c', '--config [PATH]', "look in PATH for configurations (instead of ~/.to_pass)") do |value|
+        #   if File.exist?(value)
+        #     options[:path] = value
+        #   else
+        #     puts 'configuration path not found'
+        #     puts "run '#{File.basename($0)} --setup --config #{value}' to set it up"
+        #     exit 1
+        #   end
+        # end
+        #
+        # opts.on('--setup', "create a configuration directory") do |value|
+        #   options[:setup] == true
+        # end
+
+        opts.on('-A', '--algorithms', "list available algorithms") do |value|
+          Cli.algorithms
+          exit
+        end
+
+        opts.on('-C', '--converters', "list available converters for password algorithms") do |value|
+          Cli.converters
+          exit
+        end
+
         opts.separator ""
 
         opts.on_tail("-h", "--help", "Show this message") do

data/lib/to_pass/config_reader.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module ToPass
+  # The ConfigReader reads the given file from a YAML-file
+  # into a Hash. All Strings in the Hash are converted into
+  # symbols.
+  #
+  # Search locations are managed in ToPass::Directories
+  class ConfigReader < FileReader
+    def initialize(fn='config',dir=nil) # :nodoc:
+      super
+    end
+
+    # as the ConfigReader is only intended to read the configuration
+    # file, the name is fixed here.
+    def self.load(fn = 'config')
+      super
+    end
+
+    def load_from_file
+      fn = super
+      config = {}
+
+      YAML.load_file(fn).each_pair do |key, value|
+        config[key.to_sym] =  value.kind_of?(String) ? value.to_sym : value
+      end
+
+      config
+    end
+  end
+end

data/lib/to_pass/converter_reader.rb

@@ -1,7 +1,5 @@
 # vim:ft=ruby:fileencoding=utf-8
 
-require 'pathname'
-
 module ToPass
   # The ConverterReader's primary API is to load the converters from right
   # directories into an Array
@@ -13,19 +11,13 @@ module ToPass
   # User-provided converters are always required (for now).
   #
   # see ToPass::Converter
-  class ConverterReader
-    attr_reader :load_path, :loaded
+  class ConverterReader < FileReader
+    attr_reader :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
+      super(nil, 'converters')
     end
 
     # loads the converters

data/lib/to_pass/file_reader.rb

@@ -0,0 +1,80 @@
+# vim:fileencoding=utf-8
+# require 'pathname'
+# require 'yaml'
+
+require 'pathname'
+
+module ToPass
+  # a generic Filereader, abstracting (among others) ToPass::AlgorithmReader
+  # and ToPass::ConverterReader.
+  #
+  # Files are searched in a list of standard directories. Those are defined
+  # and managed in ToPass::Directories
+  class FileReader
+    attr_reader :load_path
+
+    def initialize(file = nil, dir_suffix = nil) # :nodoc:
+      @file = file
+      @load_path = []
+
+      @load_path.concat(standard_directories(dir_suffix))
+    end
+
+    class << self
+      # load a file with a given identifier
+      def load(fn)
+        new(fn).load_from_file
+      end
+
+      # searches for available algorithms
+      def discover
+        extension = ".#{extension}" if extension
+
+        new(nil).load_path.collect do |dir|
+          Dir["#{dir}/#{search_pattern}#{extension}"]
+        end.flatten.compact.map do |fn|
+          File.basename(fn).gsub('#{extension}', '')
+        end
+      end
+
+      def search_pattern
+        '*'
+      end
+
+      def extension
+        nil
+      end
+    end
+
+    def load_from_file # :nodoc:
+      fn = load_path.map do |dir|
+        extension = ".#{self.class.extension}" if self.class.extension
+        file = Pathname.new("#{dir}/#{@file}#{extension}")
+
+        if file.exist?
+          file
+        else
+          next
+        end
+      end.compact.first
+
+      raise LoadError, "file #{@file} could not be found in #{load_path}" if fn.nil?
+
+      fn
+    end
+
+    private
+
+    def standard_directories(suffix = nil)
+      suffix = suffix.to_s
+      suffix = "/#{suffix}" unless suffix =~ /^\//
+
+      ToPass::Directories[:standard].map do |dir|
+        dir + suffix
+      end.map do |dir|
+        dir = Pathname.new(dir).expand_path
+        dir if dir.exist?
+      end.compact
+    end
+  end
+end

data/lib/to_pass/version.rb

@@ -3,7 +3,7 @@
 unless defined?(ToPass::VERSION)
   module ToPass
     # version of gem
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
 
     # name of gem
     APP_NAME = 'to_pass'

data/man/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" "August 2010" "" ""
+.TH "TO_PASS" "1" "December 2010" "" ""
 .
 .SH "NAME"
 \fBto_pass\fR \- transform a string to a password
@@ -10,28 +10,31 @@
 \fBto_pass\fR [\-a ALG | \-\-algorithm ALG] [\-\-pipe | \-\-no\-pipe] string
 .
 .br
-\fBto_pass\fR [\-a ALG | \-\-algorithm ALG] [\-\-pipe | \-\-no\-pipe] < <file>
+\fBto_pass\fR [\-a ALG | \-\-algorithm ALG] [\-\-pipe | \-\-no\-pipe] < FILE
 .
 .br
-\fBpassword_of\fR [\-a ALG | \-\-algorithm ALG] [\-\-pipe | \-\-no\-pipe] string
+\fBto_pass\fR [\-A|\-\-algorithms]
 .
 .br
-\fBpassword_of\fR [\-a ALG | \-\-algorithm ALG] [\-\-pipe | \-\-no\-pipe] < <file>
+\fBto_pass\fR [\-C|\-\-converters]
+.
+.P
+\fBpassword_of\fR is an alias of \fBto_pass\fR
 .
 .SH "DESCRIPTION"
 \fBto_pass\fR converts a string (be it a word, a sentence or a whole book) into a password\. The transformation is done according to a algorithm which basically is a list of conversion steps\.
 .
 .P
-Some algorithms and conversions are supplied, but you can easily add your own\. User supplied Algorithms are searched in \fB~/\.to_pass/algorithms/\fR, converter classes are searched in \fB~/\.to_pass/converters/\fR\.
+Some algorithms and conversions are supplied, but you can easily add your own\. User supplied algorithms are searched in \fB~/\.to_pass/algorithms/\fR, converter classes are searched in \fB~/\.to_pass/converters/\fR\.
 .
 .P
 to_pass\-algorithm(5) files are written in yaml(3pm), to_pass\-converter(5) classes are ruby(1) classes\.
 .
 .SH "FILES"
-The \fBto_pass\fR command can reads both algorithms and converters\.
+The \fBto_pass\fR command can read both algorithms and converters\.
 .
 .P
-Algorithm names should match the filenames so that the library can find and load them\. Search locations are the user\-directory ~/\.to_pass/algorithm/ and the bundled algorithms\. The file is expected to have a "\.yml"\-extension
+Algorithm names should match the filenames so that the library can find and load them\. Search locations are the user\-directory ~/\.to_pass/algorithm/ and the bundled algorithms\. The file is expected to have a "\.yml"\-extension\. Details can be found in to_pass\-algorithm(5)\.
 .
 .P
 Converters should be named like the method they provide\. Details about the expected class can be found in to_pass\-converter(5)\.
@@ -47,6 +50,21 @@ Use the named algorithm\.
 \fB\-\-pipe\fR
 Output just the resulting string, without a line\-ending\.
 .
+.SS "ACTIONS"
+Further, the following switches trigger an action other than converting a string to a password
+.
+.TP
+\fB\-A\fR, \fB\-\-algorithms\fR
+list all available algorithms
+.
+.TP
+\fB\-C\fR, \fB\-\-converters\fR
+list all converters which can be used for algorithms
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show usage information
+.
 .SH "EXAMPLES"
 Transform the word "test" into a password:
 .
@@ -76,10 +94,10 @@ ti1pwtsi2ltti@pf
 .IP "" 0
 .
 .SH "BUGS"
-So far, no bugs are known\.
+So far, no bugs are known\. If you encounter any, please file a bugreport under https://github\.com/kronn/to_pass/issues
 .
 .SH "COPYRIGHT"
-ToPass is Copyright (C) 2010 Matthias Viehweger
+ToPass is Copyright (C) 2010 Matthias Viehweger\. It is open sourced under a MIT\-license\.
 .
 .SH "SEE ALSO"
 to_pass\-converter(5), to_pass\-algorithm(5)

data/man/man1/to_pass.1.html

@@ -68,7 +68,7 @@
     <a href="#BUGS">BUGS</a>
     <a href="#COPYRIGHT">COPYRIGHT</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>to_pass(1)</li>
@@ -84,9 +84,11 @@
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 
 <p><code>to_pass</code> [-a ALG | --algorithm ALG] [--pipe | --no-pipe] string<br />
-<code>to_pass</code> [-a ALG | --algorithm ALG] [--pipe | --no-pipe] &lt; &lt;file&gt;<br />
-<code>password_of</code> [-a ALG | --algorithm ALG] [--pipe | --no-pipe] string<br />
-<code>password_of</code> [-a ALG | --algorithm ALG] [--pipe | --no-pipe] &lt; &lt;file&gt;</p>
+<code>to_pass</code> [-a ALG | --algorithm ALG] [--pipe | --no-pipe] &lt; FILE<br />
+<code>to_pass</code> [-A|--algorithms]<br />
+<code>to_pass</code> [-C|--converters]</p>
+
+<p><code>password_of</code> is an alias of <code>to_pass</code></p>
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
@@ -95,7 +97,7 @@ password. The transformation is done according to a algorithm which basically is
 a list of conversion steps.</p>
 
 <p>Some algorithms and conversions are supplied, but you can easily add your own.
-User supplied Algorithms are searched in <code>~/.to_pass/algorithms/</code>, converter
+User supplied algorithms are searched in <code>~/.to_pass/algorithms/</code>, converter
 classes are searched in <code>~/.to_pass/converters/</code>.</p>
 
 <p><a href="../man5/to_pass-algorithm.5.html" class="man-ref">to_pass-algorithm<span class="s">(5)</span></a> files are written in <a href="http://man.cx/yaml(3pm)" class="man-ref">yaml<span class="s">(3pm)</span></a>, <a href="../man5/to_pass-converter.5.html" class="man-ref">to_pass-converter<span class="s">(5)</span></a> classes are
@@ -103,11 +105,12 @@ classes are searched in <code>~/.to_pass/converters/</code>.</p>
 
 <h2 id="FILES">FILES</h2>
 
-<p>The <code>to_pass</code> command can reads both algorithms and converters.</p>
+<p>The <code>to_pass</code> command can read both algorithms and converters.</p>
 
 <p>Algorithm names should match the filenames so that the library can find and
 load them.  Search locations are the user-directory ~/.to_pass/algorithm/ and
-the bundled algorithms. The file is expected to have a ".yml"-extension</p>
+the bundled algorithms. The file is expected to have a ".yml"-extension.
+Details can be found in <a href="../man5/to_pass-algorithm.5.html" class="man-ref">to_pass-algorithm<span class="s">(5)</span></a>.</p>
 
 <p>Converters should be named like the method they provide. Details about the
 expected class can be found in <a href="../man5/to_pass-converter.5.html" class="man-ref">to_pass-converter<span class="s">(5)</span></a>.</p>
@@ -122,6 +125,18 @@ expected class can be found in <a href="../man5/to_pass-converter.5.html" class=
 </dl>
 
 
+<h3 id="ACTIONS">ACTIONS</h3>
+
+<p>Further, the following switches trigger an action other than converting a
+string to a password</p>
+
+<dl>
+<dt><code>-A</code>, <code>--algorithms</code></dt><dd><p>list all available algorithms</p></dd>
+<dt><code>-C</code>, <code>--converters</code></dt><dd><p>list all converters which can be used for algorithms</p></dd>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>show usage information</p></dd>
+</dl>
+
+
 <h2 id="EXAMPLES">EXAMPLES</h2>
 
 <p>Transform the word "test" into a password:</p>
@@ -138,11 +153,12 @@ ti1pwtsi2ltti@pf
 
 <h2 id="BUGS">BUGS</h2>
 
-<p>So far, no bugs are known.</p>
+<p>So far, no bugs are known. If you encounter any, please file a bugreport under
+https://github.com/kronn/to_pass/issues</p>
 
 <h2 id="COPYRIGHT">COPYRIGHT</h2>
 
-<p>ToPass is Copyright (C) 2010 Matthias Viehweger</p>
+<p>ToPass is Copyright (C) 2010 Matthias Viehweger. It is open sourced under a MIT-license.</p>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
@@ -151,7 +167,7 @@ ti1pwtsi2ltti@pf
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>August 2010</li>
+    <li class='tc'>December 2010</li>
     <li class='tr'>to_pass(1)</li>
   </ol>
 

data/man/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" "August 2010" "" ""
+.TH "TO_PASS\-ALGORITHM" "5" "November 2010" "" ""
 .
 .SH "NAME"
 \fBto_pass\-algorithm\fR \- algorithm\-description for to_pass(1)

data/man/man5/to_pass-algorithm.5.html

@@ -65,7 +65,7 @@
     <a href="#CAVEATS">CAVEATS</a>
     <a href="#AUTHOR">AUTHOR</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>to_pass-algorithm(5)</li>
@@ -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'>August 2010</li>
+    <li class='tc'>November 2010</li>
     <li class='tr'>to_pass-algorithm(5)</li>
   </ol>
 

data/man/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" "August 2010" "" ""
+.TH "TO_PASS\-CONVERTER" "5" "November 2010" "" ""
 .
 .SH "NAME"
 \fBto_pass\-converter\fR \- converter\-class for to_pass(1)

data/man/man5/to_pass-converter.5.html

@@ -65,7 +65,7 @@
     <a href="#CAVEATS">CAVEATS</a>
     <a href="#AUTHOR">AUTHOR</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>to_pass-converter(5)</li>
@@ -155,7 +155,7 @@ end
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>August 2010</li>
+    <li class='tc'>November 2010</li>
     <li class='tr'>to_pass-converter(5)</li>
   </ol>
 

data/man/to_pass.1.ronn

@@ -4,9 +4,11 @@ to_pass(1) -- transform a string to a password
 ## SYNOPSIS
 
 `to_pass` [-a ALG | --algorithm ALG] [--pipe | --no-pipe] string<br>
-`to_pass` [-a ALG | --algorithm ALG] [--pipe | --no-pipe] &lt; &lt;file&gt;<br>
-`password_of` [-a ALG | --algorithm ALG] [--pipe | --no-pipe] string<br>
-`password_of` [-a ALG | --algorithm ALG] [--pipe | --no-pipe] &lt; &lt;file&gt;
+`to_pass` [-a ALG | --algorithm ALG] [--pipe | --no-pipe] &lt; FILE<br>
+`to_pass` [-A|--algorithms]<br>
+`to_pass` [-C|--converters]
+
+`password_of` is an alias of `to_pass`
 
 ## DESCRIPTION
 
@@ -15,7 +17,7 @@ password. The transformation is done according to a algorithm which basically is
 a list of conversion steps.
 
 Some algorithms and conversions are supplied, but you can easily add your own.
-User supplied Algorithms are searched in `~/.to_pass/algorithms/`, converter
+User supplied algorithms are searched in `~/.to_pass/algorithms/`, converter
 classes are searched in `~/.to_pass/converters/`.
 
 to_pass-algorithm(5) files are written in yaml(3pm), to_pass-converter(5) classes are
@@ -23,11 +25,12 @@ ruby(1) classes.
 
 ## FILES
 
-The `to_pass` command can reads both algorithms and converters.
+The `to_pass` command can read both algorithms and converters.
 
 Algorithm names should match the filenames so that the library can find and
 load them.  Search locations are the user-directory ~/.to_pass/algorithm/ and
-the bundled algorithms. The file is expected to have a ".yml"-extension
+the bundled algorithms. The file is expected to have a ".yml"-extension.
+Details can be found in to_pass-algorithm(5).
 
 Converters should be named like the method they provide. Details about the
 expected class can be found in to_pass-converter(5).
@@ -44,6 +47,21 @@ The following options are supported:
     Output just the resulting string, without a line-ending.
 
 
+### ACTIONS
+
+Further, the following switches trigger an action other than converting a
+string to a password
+
+  * `-A`, `--algorithms`:
+    list all available algorithms
+
+  * `-C`, `--converters`:
+    list all converters which can be used for algorithms
+
+  * `-h`, `--help`:
+    show usage information
+
+
 ## EXAMPLES
 
 Transform the word "test" into a password:
@@ -58,11 +76,12 @@ Transform a phrase into a password using a different algorithm:
 
 ## BUGS
 
-So far, no bugs are known.
+So far, no bugs are known. If you encounter any, please file a bugreport under
+https://github.com/kronn/to_pass/issues
 
 ## COPYRIGHT
 
-ToPass is Copyright (C) 2010 Matthias Viehweger
+ToPass is Copyright (C) 2010 Matthias Viehweger. It is open sourced under a MIT-license.
 
 ## SEE ALSO
 

data/test/test_base.rb

@@ -62,4 +62,11 @@ class TestBase < Test::Unit::TestCase
       assert_nil ToPass::RELEASE_NOTES
     end
   end
+
+  # def test_uses_to_passrc_for_configuration
+  #   assert_nothing_raised  do
+  #     # make default algorithm configurable in .to_passrc [kronn/to_pass GH-1]
+  #     fail 'this needs to be implemeted'
+  #   end
+  # end
 end

data/test/test_cli.rb

@@ -73,6 +73,51 @@ class TestCli < Test::Unit::TestCase
     assert_match /Show this message/, result, 'should contain hint for help'
   end
 
+
+  # def test_configuration_path_is_configurable
+  #   [
+  #     `#{binpath}to_pass test -c /tmp/my_to_pass`,
+  #     `#{binpath}to_pass test --config /tmp/my_to_pass`
+  #   ].each do |result|
+  #     assert_match /configuration path not found/, result, 'should output an errormessage'
+  #     assert_match %r!to_pass --setup --config /tmp/my_to_pass!, result, 'should provide a hint how to fix it'
+  #   end
+  # end
+
+  # def test_cli_has_setup_command
+  #   result = `#{binpath}to_pass --setup 2>&1`
+  #
+  #   assert path_not_present
+  #   assert_match /successfully created configuration paths/i, result, 'should print success message'
+  #   assert path_present
+  # end
+
+  def test_cli_can_output_algorithms
+    algorithms = %w(basic_de basic_en secure)
+    [
+      `#{binpath}to_pass -A`,
+      `#{binpath}to_pass --algorithms`
+    ].each do |result|
+      assert_match /available password algorithms/, result
+      algorithms.each do |algorithm|
+        assert_match /#{algorithm}/, result
+      end
+    end
+  end
+
+  def test_cli_can_output_converters
+    converters = %w(collapse_chars downcase expand_below first_chars remove_repetition replace reverse swapcase)
+    [
+      `#{binpath}to_pass -C`,
+      `#{binpath}to_pass --converters`
+    ].each do |result|
+      assert_match /available converters for password algorithms/, result
+      converters.each do |converter|
+        assert_match /#{converter}/, result
+      end
+    end
+  end
+
   protected
 
   def binpath

data/test/test_config_reader.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestConfigReader < Test::Unit::TestCase
+  test_presence ToPass::ConfigReader
+
+  def test_config_reader_is_a_file_reader
+    assert_kind_of ToPass::FileReader, instance
+  end
+
+  def test_can_load_config_file
+    assert_not_nil klass.load
+    assert_kind_of Hash, klass.load
+  end
+
+  protected
+
+  def klass
+    ToPass::ConfigReader
+  end
+  def instance
+    klass.new
+  end
+end

data/test/test_configs.rb

@@ -0,0 +1,29 @@
+# vim:ft=ruby:fileencoding=utf-8
+
+require File.expand_path('../helper', __FILE__)
+
+class TestConfigs < Test::Unit::TestCase
+  def config
+    ToPass::ConfigReader.load('config')
+  end
+
+  def test_default_algorithm_is_basic_de
+    result = config[:algorithm]
+
+    assert_not_nil result, 'the algorithm should be configured by default'
+    assert_equal :basic_de, result
+  end
+  def test_default_pipe_out_behaviour_is_false
+    result = config[:pipe_out]
+
+    assert_not_nil result
+    assert_equal false, result
+  end
+  def test_default_pipe_in_behaviour_is_false
+    result = config[:pipe_in]
+
+    assert_not_nil result
+    assert_equal false, result
+  end
+
+end

data/test/test_converter.rb

@@ -22,6 +22,7 @@ class TestConverter < Test::Unit::TestCase
   end
 
   # mock-tests to ensure presence and calling of protected methods
+  # the result-testing is done in test/test_converters.rb
   def test_replace
     assert_respond_to converter, :replace
     converter.expects(:apply_rule).with("test", {'replace'=>'special'}).once
@@ -47,7 +48,6 @@ class TestConverter < Test::Unit::TestCase
     converter.convert("test test")
   end
 
-
   # more complex/real-life setups
   def test_multiple_rules
     converter(basic_rules.merge({
@@ -67,34 +67,6 @@ class TestConverter < Test::Unit::TestCase
 Pferd	auf	dem	Flur"))
   end
 
-
-  # actual result-testing
-  def test_replacement
-    rules = {
-      'replacements' => {
-        'numbers' => {
-          :e => 3,
-          :s => 5
-        }
-      }
-    }
-    result = converter(rules).send(:apply_rule, "test", {'replace'=>'numbers'})
-    assert_equal "t35t", result
-  end
-  def test_case_swapping
-    assert_equal "tEsT", converter.send(:apply_rule, "test", 'swapcase')
-  end
-  def test_case_swapping_ignores_numbers
-    assert_equal "tEsT4fUn", converter.send(:apply_rule, "test4fun", 'swapcase')
-    assert_equal "fUn4TeSt", converter.send(:apply_rule, "fun4test", 'swapcase')
-  end
-  def test_char_collapsing
-    assert_equal "abc", converter.send(:apply_rule, "a b c", 'collapse_chars')
-  end
-  def test_select_first_chars
-    assert_equal "t a t f t", converter.send(:apply_rule, "test all the fucking time", 'first_chars')
-  end
-
   protected
 
   def converter(rules = basic_rules)

data/test/test_converters.rb

@@ -26,16 +26,41 @@ class TestConverters < Test::Unit::TestCase
     assert_converter 'tset', 'reverse', 'test'
   end
 
+  def test_replacement
+    rules = {
+      'replacements' => {
+        'numbers' => {
+          :e => 3,
+          :s => 5
+        }
+      }
+    }
+    assert_converter 't35t', {'replace'=>'numbers'}, 'test', rules
+  end
+
+  def test_case_swapping
+    assert_converter 'tEsT', 'swapcase', 'test'
+  end
+
+  def test_case_swapping_ignores_numbers
+    assert_converter "tEsT4fUn", 'swapcase', "test4fun"
+    assert_converter "fUn4TeSt", 'swapcase', "fun4test"
+  end
+
+  def test_char_collapsing
+    assert_converter "abc", 'collapse_chars', "a b c"
+  end
+
+  def test_select_first_chars
+    assert_converter "t a t f t", 'first_chars', "test all the fucking time"
+  end
+
   protected
 
-  def assert_converter(expected, rule, string = 'test')
+  def assert_converter(expected, rule, string = 'test', rules = {})
     assert_nothing_raised LoadError do
-      result = converter.send(:apply_rule, string, rule)
+      result = ToPass::Converter.new(rules).send(:apply_rule, string, rule)
       assert_equal expected, result, "Converter '#{rule.inspect}' should convert #{string} to #{expected}."
     end
   end
-
-  def converter
-    ToPass::Converter.new({})
-  end
 end

data/test/test_file_reader.rb

@@ -0,0 +1,51 @@
+# vim:ft=ruby:fileencoding=utf-8
+
+require File.expand_path('../helper', __FILE__)
+
+class TestFileReader < Test::Unit::TestCase
+  test_presence ToPass::FileReader
+
+  def test_initialize
+    assert_nothing_raised do
+      klass.new
+    end
+  end
+
+  def test_load
+    assert_respond_to klass, :load
+    assert_not_nil klass.load('config')
+  end
+
+  def test_discover
+    assert_respond_to klass, :discover
+    assert_kind_of Array, klass.discover
+  end
+
+  def test_has_load_path
+    assert_respond_to reader, :load_path
+    assert_kind_of Array, reader.load_path
+  end
+
+  def test_load_path_contains_standard_dirs
+    dirs = standard_directories.map { |path| "#{path}#{concern}"}
+
+    Pathname.any_instance.expects(:exist?).at_least(dirs.size).returns(true)
+
+    dirs.each do |reldir|
+      dir = Pathname.new(reldir).expand_path
+      assert_include dir, reader.load_path
+    end
+  end
+
+  protected
+
+  def concern
+    ''
+  end
+  def klass
+    ToPass::FileReader
+  end
+  def reader
+    @reader ||= klass.new
+  end
+end

data/test/tests.watchr

@@ -0,0 +1,45 @@
+# vim:ft=ruby
+require 'rubygems'
+require 'watchr'
+
+# helper methods
+def run_all
+  puts "\rrunning all tests. Hit CTRL-\\ to quit."
+  sleep(1)
+  system "ruby test/all.rb"
+end
+def single_or_all(fn)
+  clear_screen
+  if File.exist?(File.expand_path(fn))
+    system "ruby -Ilib -Itest #{fn}"
+  else
+    run_all
+  end
+end
+def clear_screen
+  system "clear"
+end
+
+# test_runner-lambda
+single_test = lambda { |m|
+  single_or_all("test/test_#{m[1]}.rb")
+}
+
+# specific mappings
+watch '^data/to_pass/(algorithms|converters)/*.rb' do |m|
+  single_or_all("test/test_#{m[1]}.rb")
+end
+watch '^data/config' do |m|
+  single_or_all("test/test_configs.rb")
+end
+
+# simple mappings
+watch '^lib/to_pass/(.*).rb',  &single_test
+watch '^test/test_(.*).rb', &single_test
+
+Signal.trap 'QUIT' do
+  abort("\n")
+end
+Signal.trap 'INT' do
+  run_all
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: to_pass
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 59
   prerelease: false
   segments: 
   - 0
-  - 8
+  - 9
   - 0
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Matthias Viehweger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-15 00:00:00 +01:00
+date: 2011-02-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,6 +78,7 @@ files:
 - data/to_pass/algorithms/basic_de.yml
 - data/to_pass/algorithms/basic_en.yml
 - data/to_pass/algorithms/secure.yml
+- data/to_pass/config
 - data/to_pass/converters/collapse_chars.rb
 - data/to_pass/converters/downcase.rb
 - data/to_pass/converters/expand_below.rb
@@ -92,10 +93,12 @@ files:
 - lib/to_pass/algorithm_reader.rb
 - lib/to_pass/base.rb
 - lib/to_pass/cli.rb
+- lib/to_pass/config_reader.rb
 - lib/to_pass/converter.rb
 - lib/to_pass/converter_reader.rb
 - lib/to_pass/converters.rb
 - lib/to_pass/directories.rb
+- lib/to_pass/file_reader.rb
 - lib/to_pass/integration.rb
 - lib/to_pass/version.rb
 - man/index.txt
@@ -116,10 +119,14 @@ files:
 - test/test_algorithms.rb
 - test/test_base.rb
 - test/test_cli.rb
+- test/test_config_reader.rb
+- test/test_configs.rb
 - test/test_converter.rb
 - test/test_converter_reader.rb
 - test/test_converters.rb
+- test/test_file_reader.rb
 - test/test_integration.rb
+- test/tests.watchr
 - README.rdoc
 - TODO
 has_rdoc: true
@@ -168,7 +175,11 @@ test_files:
 - test/test_algorithms.rb
 - test/test_base.rb
 - test/test_cli.rb
+- test/test_config_reader.rb
+- test/test_configs.rb
 - test/test_converter.rb
 - test/test_converter_reader.rb
 - test/test_converters.rb
+- test/test_file_reader.rb
 - test/test_integration.rb
+- test/tests.watchr