to_pass 0.7.0 → 0.8.0

data/TODO

@@ -1,26 +1,36 @@
 CURRENT
 ============================================================================
-- test on multiple rubies (1.8.7, 1.9.2, Rubinius, REE)
-- have some RELEASE-NOTES or CHANGELOG
-  - GemSpec#post_install_message = filename
-  - maybe http://github.com/proutils/vclog is useful...
-
-
-UP NEXT
-============================================================================
+✔ let tests run separated
 - Improve CLI-Code
-  - rescue OptionParser::InvalidOption with help screen
-  - add option '-c, --config PATH - Configuration Path (default is ~/.to_pass)'
+  ✔ 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 option '-c, --config PATH - Configuration Path (default is ~/.to_pass)'
+
+
+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
 
 
 SOMEDAY
 ============================================================================
-- test on windows
-- move decision wether a string is a word or a sentence into algorithm definition.
-- add task to validate user supplied algorithms and converters
-- ?? replace Rake with Thor
+  test on windows
+  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
+  ?? replace Rake with Thor
+
+
+LEGEND
+================================
+Planned   = -
+Done      = ✔
+Cancelled = ✘

data/bin/password_of

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
-# vim:ft=ruby:enc=utf-8
+# vim:ft=ruby:fileencoding=utf-8
 
-base_path = ( File.expand_path(File.dirname(__FILE__)+'/..') )
+base_path = File.expand_path('../../', __FILE__)
 $LOAD_PATH << base_path unless $LOAD_PATH.include?(base_path)
+$LOAD_PATH << "#{base_path}/lib" unless $LOAD_PATH.include?("#{base_path}/lib")
 
-require 'lib/to_pass'
+require 'to_pass'
 
 ToPass::Cli.new({
   :algorithm => 'basic_de',

data/bin/to_pass

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
-# vim:ft=ruby:enc=utf-8
+# vim:ft=ruby:fileencoding=utf-8
 
-base_path = ( File.expand_path(File.dirname(__FILE__)+'/..') )
+base_path = File.expand_path('../../', __FILE__)
 $LOAD_PATH << base_path unless $LOAD_PATH.include?(base_path)
+$LOAD_PATH << "#{base_path}/lib" unless $LOAD_PATH.include?("#{base_path}/lib")
 
-require 'lib/to_pass'
+require 'to_pass'
 
 ToPass::Cli.new({
   :algorithm => 'basic_de',

data/doc/CHANGELOG

@@ -1,5 +1,43 @@
 RELEASE HISTORY
 
+v0.7.0 / 2010-10-13
+
+tag v0.7.0 (Matthias Viehweger <kronn@kronn.de>)
+
+Changes:
+
+* 28 General Enhancements
+
+    * setup the $LOAD_PATH better
+    * added ability to include RELEASE_NOTES (which are then also displayed after installing...)
+    * made gem-release an optional development dependency
+    * properly namespace documentation tasks in Rakefile
+    * add the ability to Benchmark tests
+    * added truly optional gems to Gemfile to have some means to install them
+    * fixed typos
+    * moved list of extra_rdoc_files into version.rb
+    * added doc/CHANGELOG
+    * moved LICENSE into doc directory
+    * declare the constants defensively
+    * move meta-information into version.rb-file
+    * updated idea/todo list
+    * include LICENSE again in Documentation
+    * move tests to [test/all, test/helper]-pattern
+    * the gem has all the files which are under version control
+    * ruby 1.9.2 compatibility
+    * don't rely on . being in $LOAD_PATH anymore (1.9.2 compat)
+    * fix vim-modeline (works as ruby 1.9 encoding-hint also)
+    * removed redundant require
+    * fixed manpage locations and links
+    * Version 0.6.0 brings mostly "debian compatiblity" as far as i can test it for now.
+    * added note on redgreen, which is purely optional
+    * documentation update
+    * include all methods in RDoc to make it actually useful
+    * added data-dir to gemspec
+    * extracted ToPass::DIRECTORIES into a real class
+    * assume Debian compatibility for now
+
+
 v0.6.0 / 2010-08-18
 
 tag v0.6.0 (Matthias Viehweger <kronn@kronn.de>)
@@ -189,14 +227,14 @@ Version bump to 0.2.1 (Matthias Viehweger kronn@kronn.de)
 
 Changes:
 
-* 1 Cleanup Enhancements
-
-    * redgreen is only needed and wanted for tests
-
 * 1 General Enhancements
 
     * Version bump to 0.2.0
 
+* 1 Cleanup Enhancements
+
+    * redgreen is only needed and wanted for tests
+
 
 v0.2.0 / 2010-05-30
 
@@ -242,20 +280,15 @@ Changes:
     * Initial commit
 
 
-HEAD / 2010-09-03
+HEAD / 2010-10-25
 
-Version 0.7.0 is mostly a cleanup and compatibility release.
+Current Development (Matthias Viehweger)
 
-ToPass now runs seamlessly with Ruby 1.8.7, 1.9.2, REE 2010-02. Rubinius works
-mostly, but has some issues.
+Changes:
 
-The Metainformation like version, summary, description and the likes are now
-all in the version.rb-file. This way, they can be queried easier.
+* 3 General Enhancements
 
-The test can now be run through the test/all.rb-script. In fact, this is the
-standard way and internally used by `rake test`. The Manpages are now in the
-right location for setup.rb and RDocs now include the LICENSE and this
-CHANGELOG.
+    * started development after 0.7.0
+    * version bump to 0.7.0
+    * corrected path to lib-directory
 
-The gemspec has the filelist now directly from git instead from the
-filesystem.

data/lib/to_pass/cli.rb

@@ -44,7 +44,7 @@ module ToPass
         :pipe_in   => false
       }.merge(options)
 
-      OptionParser.new do |opts|
+      cli_options = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename($0)} [options] passphrase"
         opts.separator ""
 
@@ -62,13 +62,18 @@ module ToPass
           puts opts
           exit
         end
-      end.parse!
+      end
+      cli_options.parse!
 
       if ARGV[0].nil?
         options[:pipe_in] = options[:pipe_out] = true
       end
 
       options
+
+    rescue OptionParser::InvalidOption
+      puts cli_options
+      exit 0
     end
 
     # get the input string

data/lib/to_pass/directories.rb

@@ -25,11 +25,15 @@ module ToPass
       def all
         {
           :user => "~/.#{APP_NAME}",
-          :data => "#{RbConfig::CONFIG['data-dir']}/#{APP_NAME}",
+          :data => "#{ruby_data_dir}/#{APP_NAME}",
           :base => File.expand_path("#{File.dirname(__FILE__)}/../.."),
           :source_data => File.expand_path("#{File.dirname(__FILE__)}/../../data/#{APP_NAME}"),
         }
       end
+
+      def ruby_data_dir
+        RbConfig::CONFIG['data-dir'] || RbConfig::CONFIG['datadir']
+      end
     end
   end
 end

data/lib/to_pass/version.rb

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

data/test/helper.rb

@@ -3,6 +3,7 @@
 require 'test/unit'
 require 'mocha'
 require 'rbconfig'
+require 'pathname'
 
 # optional libraries
 begin
@@ -38,12 +39,18 @@ Test::Unit::TestCase.class_eval do
     end
   end
 
+  def assert_include(needle, haystack, msg = nil)
+    msg ||= "#{haystack.inspect} should include #{needle.inspect}"
+    assert haystack.include?(needle), msg
+  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]
-    ]
+    dirs = []
+    dirs << Pathname.new('~/.to_pass').expand_path # user
+    dirs << "#{ruby_data_dir}/#{ToPass::APP_NAME}" # installed
+    dirs << "#{File.dirname(__FILE__)}/../data/#{ToPass::APP_NAME}" if in_to_pass_soure_tree? # source [in github]
+
+    dirs
   end
 
   def with_algorithm_in_user_dir
@@ -57,6 +64,18 @@ Test::Unit::TestCase.class_eval do
     yield
     `rm ~/.to_pass/converters/userize.rb`
   end
+
+  def in_to_pass_soure_tree?
+    Pathname.new("#{File.dirname(__FILE__)}/../to_pass.gemspec").expand_path.exist?
+  end
+
+  def ruby_data_dir
+    RbConfig::CONFIG['data-dir'] || RbConfig::CONFIG['datadir']
+  end
+end
+
+unless Pathname.new("#{File.dirname(__FILE__)}/../to_pass.gemspec").expand_path.exist?
+  $stderr << "Skipping some assertion as the tests run separated from the source-directory\n"
 end
 
 require 'to_pass'

data/test/test_algorithm_reader.rb

@@ -29,11 +29,11 @@ class TestAlgorithmReader < Test::Unit::TestCase
   def test_load_path_contains_standard_dirs
     dirs = standard_directories.map { |path| "#{path}/algorithms"}
 
-    Pathname.any_instance.expects(:exist?).times(dirs.size).returns(true)
+    Pathname.any_instance.expects(:exist?).at_least(dirs.size).returns(true)
 
     dirs.each do |reldir|
       dir = Pathname.new(reldir).expand_path
-      assert( reader.load_path.include?(dir), "#{reader.load_path.inspect} should include #{dir.inspect}" )
+      assert_include dir, reader.load_path
     end
   end
 

data/test/test_base.rb

@@ -17,7 +17,11 @@ class TestBase < Test::Unit::TestCase
   end
 
   def test_date
-    assert_equal Pathname.new("#{File.dirname(__FILE__)}/../lib/to_pass/version.rb").expand_path.mtime, ToPass::DATE
+    if in_to_pass_soure_tree?
+      assert_equal Pathname.new("#{File.dirname(__FILE__)}/../lib/to_pass/version.rb").expand_path.mtime, ToPass::DATE
+    else
+      assert_not_nil ToPass::DATE
+    end
   end
 
   def test_appname
@@ -25,8 +29,10 @@ class TestBase < Test::Unit::TestCase
   end
 
   def test_gemspec_is_valid
-    assert_nothing_raised do
-      assert eval(Pathname.new("#{File.dirname(__FILE__)}/../to_pass.gemspec").expand_path.read).validate
+    if in_to_pass_soure_tree?
+      assert_nothing_raised do
+        assert eval(File.read(File.expand_path('../../to_pass.gemspec', __FILE__))).validate
+      end
     end
   end
 
@@ -37,9 +43,12 @@ class TestBase < Test::Unit::TestCase
     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 "#{ruby_data_dir}/#{ToPass::APP_NAME}", dirs[:data]
+
+    if in_to_pass_soure_tree?
+      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]
+    end
 
     assert_equal [ dirs[:user], dirs[:data], dirs[:source_data] ], dirs[:standard]
   end

data/test/test_cli.rb

@@ -7,52 +7,80 @@ class TestCli < Test::Unit::TestCase
 
   def test_cli_usage_without_algorithm
     assert_nothing_raised do
-      assert_equal "t35t", `bin/to_pass test`.chomp
+      assert_equal "t35t", `#{binpath}to_pass test`.chomp
     end
   end
 
   def test_cli_usage_with_password_of
     assert_nothing_raised do
-      assert_equal "t35t", `bin/password_of test`.chomp
+      assert_equal "t35t", `#{binpath}password_of test`.chomp
     end
   end
 
   def test_cli_usage_with_algorithm
     assert_nothing_raised do
-      assert_equal "ti1p4u2", `bin/to_pass 'there is one problem for us, too' -a basic_en`.chomp
+      assert_equal "ti1p4u2", `#{binpath}to_pass 'there is one problem for us, too' -a basic_en`.chomp
     end
   end
 
   def test_cli_usage_with_pipes
     assert_nothing_raised do
-      assert_equal 't35t', `echo "test" | bin/to_pass`
+      assert_equal 't35t', `echo "test" | #{binpath}to_pass`
     end
   end
 
   def test_cli_usage_with_pipe_input
     assert_nothing_raised do
-      assert_equal 't35t', `echo "test" | bin/to_pass --no-pipe`.chomp
+      assert_equal 't35t', `echo "test" | #{binpath}to_pass --no-pipe`.chomp
     end
   end
 
   def test_cli_usage_with_pipe_output
     assert_nothing_raised do
-      assert_equal 't35t', `bin/to_pass test --pipe`
+      assert_equal 't35t', `#{binpath}to_pass test --pipe`
     end
   end
 
 
   def test_cli_usage_with_user_algorithm
     with_algorithm_in_user_dir do
-      assert_equal "le1/2%z", `bin/to_pass 'leasbpc' -a user_alg`.chomp
-      assert_equal "le1/2%z", `bin/to_pass 'luke eats all sausagages because peter cries' -a user_alg`.chomp
+      assert_equal "le1/2%z", `#{binpath}to_pass 'leasbpc' -a user_alg`.chomp
+      assert_equal "le1/2%z", `#{binpath}to_pass 'luke eats all sausagages because peter cries' -a user_alg`.chomp
     end
   end
 
   def test_cli_usage_with_pipes_and_user_algorithm
     with_algorithm_in_user_dir do
-      assert_equal "le1/2%z", `echo 'leasbpc' | bin/to_pass -a user_alg`.chomp
-      assert_equal "le1/2%z", `echo 'luke eats all sausagages because peter cries' | bin/to_pass -a user_alg`.chomp
+      assert_equal "le1/2%z", `echo 'leasbpc' | #{binpath}to_pass -a user_alg`.chomp
+      assert_equal "le1/2%z", `echo 'luke eats all sausagages because peter cries' | #{binpath}to_pass -a user_alg`.chomp
     end
   end
+
+  def test_cli_handles_wrong_arguments
+    # i only want to check the return value here
+    system("#{binpath}to_pass 'test' --schnulli >/dev/null 2>/dev/null")
+    to_pass = $?
+
+    assert to_pass.exited?
+    assert_equal 0, to_pass.exitstatus, 'should have exit code 0 (success)'
+  end
+
+  def test_cli_presents_help_on_error
+    # combine everything into result-string
+    result = `#{binpath}to_pass "test" --schnulli 2>&1`
+
+    assert_match /Usage/, result, 'should print usage information'
+    assert_match /Show this message/, result, 'should contain hint for help'
+  end
+
+  protected
+
+  def binpath
+    bin_to_pass = File.expand_path('../../bin/to_pass', __FILE__)
+    if File.exist?(bin_to_pass)
+      File.dirname(bin_to_pass)
+    else
+      File.dirname(`which -a to_pass`.split.uniq.reject { |p| p =~ /gems/ }.first)
+    end + '/'
+  end
 end

data/test/test_converter_reader.rb

@@ -35,11 +35,11 @@ class TestConverterReader < Test::Unit::TestCase
   def test_load_path_contains_standard_dirs
     dirs = standard_directories.map { |path| "#{path}/converters"}
 
-    Pathname.any_instance.expects(:exist?).times(dirs.size).returns(true)
+    Pathname.any_instance.expects(:exist?).at_least(dirs.size).returns(true)
 
     dirs.each do |reldir|
       dir = Pathname.new(reldir).expand_path
-      assert( reader.load_path.include?(dir), "#{reader.load_path.inspect} should include #{dir.inspect}" )
+      assert_include dir, reader.load_path
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: to_pass
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Matthias Viehweger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 +02:00
+date: 2010-12-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency