htauth 1.0.3 → 1.1.0

data/spec/passwd_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__),"spec_helper.rb")
+require 'spec_helper'
 require 'htauth/passwd'
 require 'tempfile'
 
@@ -41,8 +41,8 @@ describe HTAuth::Passwd do
         begin
             @htauth.run([ "-h" ])
         rescue SystemExit => se
-            se.status.should == 1
-            @stdout.string.should =~ /passwordfile username/m
+            se.status.must_equal 1
+            @stdout.string.must_match( /passwordfile username/m )
         end
     end
 
@@ -50,8 +50,8 @@ describe HTAuth::Passwd do
         begin
             @htauth.run([ "--version" ])
         rescue SystemExit => se
-            se.status.should == 1
-            @stdout.string.should =~ /version #{HTAuth::VERSION}/
+            se.status.must_equal 1
+            @stdout.string.must_match( /version #{HTAuth::VERSION}/)
         end
     end
     
@@ -62,11 +62,11 @@ describe HTAuth::Passwd do
             @stdin.rewind
             @htauth.run([ "-m", "-c", @new_file, "alice" ])
         rescue SystemExit => se
-            se.status.should == 0
+            se.status.must_equal 0
             l = IO.readlines(@new_file)
             fields = l.first.split(':')
-            fields.first.should == "alice"
-            fields.last.should =~ /^\$apr1\$/
+            fields.first.must_equal "alice"
+            fields.last.must_match( /^\$apr1\$/ )
         end
     end
 
@@ -78,27 +78,26 @@ describe HTAuth::Passwd do
             @stdin.rewind
             @htauth.run([ "-c", @tf.path, "bob"])
         rescue SystemExit => se
-            se.status.should == 0
+            se.status.must_equal 0
             after_lines = IO.readlines(@tf.path)
-            after_lines.size.should == 1
-            before_lines.size.should == 2
+            after_lines.size.must_equal 1
+            before_lines.size.must_equal 2
         end
     end
 
     it "adds an entry to an existing file and force SHA" do
-        before_lines = IO.readlines(@tf.path)
         begin
             @stdin.puts "c secret"
             @stdin.puts "c secret"
             @stdin.rewind
             @htauth.run([ "-s", @tf.path, "charlie" ])
         rescue SystemExit => se
-            se.status.should == 0
+            se.status.must_equal 0
             after_lines = IO.readlines(@tf.path)
-            after_lines.should have(3).lines
+            after_lines.size.must_equal 3
             al = after_lines.last.split(':')
-            al.first.should == "charlie"
-            al.last.should =~ /\{SHA\}/
+            al.first.must_equal "charlie"
+            al.last.must_match( /\{SHA\}/ )
         end
     end
 
@@ -109,8 +108,8 @@ describe HTAuth::Passwd do
             @stdin.rewind
             @htauth.run(["-c", "-p", @tf.path, "bradley"])
         rescue SystemExit => se
-            se.status.should == 0
-            IO.read(@tf.path).strip.should == "bradley:a bad password"
+            se.status.must_equal 0
+            IO.read(@tf.path).strip.must_equal "bradley:a bad password"
         end
     end
 
@@ -118,8 +117,8 @@ describe HTAuth::Passwd do
         begin
             @htauth.run(["-c", "-p", "-b", @tf.path, "bradley", "a bad password"])
         rescue SystemExit => se
-            se.status.should == 0
-            IO.read(@tf.path).strip.should == "bradley:a bad password"
+            se.status.must_equal 0
+            IO.read(@tf.path).strip.must_equal "bradley:a bad password"
         end
     end
 
@@ -131,16 +130,16 @@ describe HTAuth::Passwd do
             @stdin.rewind
             @htauth.run([ "-d", @tf.path, "alice" ])
         rescue SystemExit => se
-            @stderr.string.should == ""
-            se.status.should == 0
+            @stderr.string.must_equal ""
+            se.status.must_equal 0
             after_lines = IO.readlines(@tf.path)
-            after_lines.size.should == before_lines.size
+            after_lines.size.must_equal before_lines.size
            
             a_b = before_lines.first.split(":")
             a_a = after_lines.first.split(":")
 
-            a_b.first.should == a_a.first
-            a_b.last.should_not == a_a.last
+            a_b.first.must_equal a_a.first
+            a_b.last.wont_equal a_a.last
         end
     end
     
@@ -148,9 +147,9 @@ describe HTAuth::Passwd do
         begin
             @htauth.run([ "-D", @tf.path, "bob" ])
         rescue SystemExit => se
-            @stderr.string.should == ""
-            se.status.should == 0
-            IO.read(@tf.path).should == IO.read(PASSWD_DELETE_TEST_FILE)
+            @stderr.string.must_equal ""
+            se.status.must_equal 0
+            IO.read(@tf.path).must_equal IO.read(PASSWD_DELETE_TEST_FILE)
         end
     end
 
@@ -158,8 +157,8 @@ describe HTAuth::Passwd do
         begin
             @htauth.run(["-n", "-p", "-b", "bradley", "a bad password"])
         rescue SystemExit => se
-            se.status.should == 0
-            @stdout.string.strip.should == "bradley:a bad password"
+            se.status.must_equal 0
+            @stdout.string.strip.must_equal "bradley:a bad password"
         end
     end
 
@@ -170,8 +169,8 @@ describe HTAuth::Passwd do
             @stdin.rewind
             @htauth.run([ "-c", "/etc/you-cannot-create-me", "alice"])
         rescue SystemExit => se
-            @stderr.string.should =~ %r{Password file failure \(/etc/you-cannot-create-me\)}m
-            se.status.should == 1
+            @stderr.string.must_match( %r{Password file failure \(/etc/you-cannot-create-me\)}m )
+            se.status.must_equal 1
         end
     end
 
@@ -182,8 +181,8 @@ describe HTAuth::Passwd do
             @stdin.rewind
             @htauth.run([ @tf.path, "alice"])
         rescue SystemExit => se
-            @stderr.string.should =~ /They don't match, sorry./m
-            se.status.should == 1
+            @stderr.string.must_match( /They don't match, sorry./m )
+            se.status.must_equal 1
         end
     end
 
@@ -191,8 +190,8 @@ describe HTAuth::Passwd do
         begin
             @htauth.run(["--blah"])
         rescue SystemExit => se
-            @stderr.string.should =~ /ERROR:/m
-            se.status.should == 1
+            @stderr.string.must_match( /ERROR:/m )
+            se.status.must_equal 1
         end
     end
 
@@ -200,8 +199,8 @@ describe HTAuth::Passwd do
         begin
             @htauth.run(["-c", "-n"])
         rescue SystemExit => se
-            @stderr.string.should =~ /ERROR:/m
-            se.status.should == 1
+            @stderr.string.must_match( /ERROR:/m )
+            se.status.must_equal 1
         end
     end
 end

data/spec/plaintext_spec.rb

@@ -1,18 +1,15 @@
-
-
-require File.join(File.dirname(__FILE__),"spec_helper.rb")
-
-require 'htauth/sha1'
+require 'spec_helper'
+require 'htauth/plaintext'
 
 describe HTAuth::Plaintext do
     it "has a prefix" do
-        HTAuth::Plaintext.new.prefix.should == ""
+        HTAuth::Plaintext.new.prefix.must_equal ""
     end
 
     it "encrypts the same way that apache does" do
         apache_result = "a secret"
         pt = HTAuth::Plaintext.new
-        pt.encode("a secret").should == apache_result
+        pt.encode("a secret").must_equal apache_result
     end
 end
 

data/spec/sha1_spec.rb

@@ -1,17 +1,15 @@
-
-require File.join(File.dirname(__FILE__),"spec_helper.rb")
-
+require 'spec_helper'
 require 'htauth/sha1'
 
 describe HTAuth::Sha1 do
     it "has a prefix" do
-        HTAuth::Sha1.new.prefix.should == "{SHA}"
+        HTAuth::Sha1.new.prefix.must_equal "{SHA}"
     end
 
     it "encrypts the same way that apache does" do
         apache_result = "{SHA}ZrnlrvmM7ZCOV3FAvM7la89NKbk="
         sha1 = HTAuth::Sha1.new
-        sha1.encode("a secret").should == apache_result
+        sha1.encode("a secret").must_equal apache_result
     end
 end
 

data/spec/spec_helper.rb

@@ -1,8 +1,12 @@
-require 'rubygems'
-require 'spec'
+if RUBY_VERSION >= '1.9.2' then
+  require 'simplecov'
+  puts "Using coverage!"
+  SimpleCov.start if ENV['COVERAGE']
+end
 
-$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-require 'htauth'
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
 
 PASSWD_ORIGINAL_TEST_FILE  = File.join(File.dirname(__FILE__), "test.original.passwd")
 PASSWD_ADD_TEST_FILE       = File.join(File.dirname(__FILE__), "test.add.passwd")

data/spec/test.add.digest

@@ -0,0 +1,3 @@
+bob:htauth:fcbeab6821d2ab3b00934c958db0fd1e
+alice:htauth:2f361db93147d84831eb34f19d05bfbb
+charlie:htauth-new:1ec9da72c45d9140949f338dc537c089

data/spec/test.add.passwd

@@ -0,0 +1,3 @@
+alice:$apr1$DghnA...$CsPcgerfsI/Ryy0AOAJtb0
+bob:SFUkhjaJc18KA
+charlie:{SHA}Cqrkk2no+ly0vYClUp49OJQahSE=

data/spec/test.delete.digest

@@ -0,0 +1 @@
+bob:htauth:fcbeab6821d2ab3b00934c958db0fd1e

data/spec/test.delete.passwd

@@ -0,0 +1 @@
+alice:$apr1$DghnA...$CsPcgerfsI/Ryy0AOAJtb0

data/spec/test.original.digest

@@ -0,0 +1,2 @@
+bob:htauth:fcbeab6821d2ab3b00934c958db0fd1e
+alice:htauth:2f361db93147d84831eb34f19d05bfbb

data/spec/test.original.passwd

@@ -0,0 +1,2 @@
+alice:$apr1$DghnA...$CsPcgerfsI/Ryy0AOAJtb0
+bob:SFUkhjaJc18KA

data/spec/test.update.digest

@@ -0,0 +1,2 @@
+bob:htauth:fcbeab6821d2ab3b00934c958db0fd1e
+alice:htauth:c32a4df25c6ecf75f3eaeb96771520de

data/spec/test.update.passwd

@@ -0,0 +1,2 @@
+alice:{SHA}GnoUUjgrLF07/6L9lW2BcaDXxB0=
+bob:SFUkhjaJc18KA

data/tasks/default.rake

@@ -0,0 +1,276 @@
+# vim: syntax=ruby
+require 'rake/clean'
+require 'digest'
+#------------------------------------------------------------------------------
+# If you want to Develop on this project just run 'rake develop' and you'll
+# have all you need to get going. If you want to use bundler for development,
+# then run 'rake develop:using_bundler'
+#------------------------------------------------------------------------------
+namespace :develop do
+
+  # Install all the development and runtime dependencies of this gem using the
+  # gemspec.
+  task :default do
+    require 'rubygems/dependency_installer'
+    installer = ::Gem::DependencyInstaller.new
+
+    This.set_coverage_gem
+
+    puts "Installing gem depedencies needed for development"
+    This.platform_gemspec.dependencies.each do |dep|
+      if dep.matching_specs.empty? then
+        puts "Installing : #{dep}"
+        installer.install dep
+      else
+        puts "Skipping   : #{dep} -> already installed #{dep.matching_specs.first.full_name}"
+      end
+    end
+    puts "\n\nNow run 'rake test'"
+  end
+
+  # Create a Gemfile that just references the gemspec
+  file 'Gemfile' => :gemspec do
+    File.open( "Gemfile", "w+" ) do |f|
+      f.puts "# DO NOT EDIT - This file is automatically generated"
+      f.puts "# Make changes to Manifest.txt and/or Rakefile and regenerate"
+      f.puts 'source "https://rubygems.org/"'
+      f.puts 'gemspec'
+    end
+  end
+
+  desc "Create a bundler Gemfile"
+  task :using_bundler => 'Gemfile' do
+    puts "Now you can 'bundle'"
+  end
+
+  # Gemfiles are build artifacts
+  CLOBBER << FileList['Gemfile*']
+end
+desc "Boostrap development"
+task :develop => "develop:default"
+
+#------------------------------------------------------------------------------
+# Minitest - standard TestTask
+#------------------------------------------------------------------------------
+begin
+  require 'rake/testtask'
+  Rake::TestTask.new( :test ) do |t|
+    t.ruby_opts    = %w[ -w -rubygems ]
+    t.libs         = %w[ lib spec test ]
+    t.pattern      = "{test,spec}/**/{test_*,*_spec}.rb"
+  end
+
+  task :test_requirements
+  task :test => :test_requirements
+  task :default => :test
+rescue LoadError
+  This.task_warning( 'test' )
+end
+
+#------------------------------------------------------------------------------
+# RDoc - standard rdoc rake task, although we must make sure to use a more
+#        recent version of rdoc since it is the one that has 'tomdoc' markup
+#------------------------------------------------------------------------------
+begin
+  gem 'rdoc' # otherwise we get the wrong task from stdlib
+  require 'rdoc/task'
+  RDoc::Task.new do |t|
+    t.markup   = 'tomdoc'
+    t.rdoc_dir = 'doc'
+    t.main     = 'README.md'
+    t.title    = "#{This.name} #{This.version}"
+    t.rdoc_files.include( FileList['*.{rdoc,md,txt}'], FileList['ext/**/*.c'],
+                          FileList['lib/**/*.rb'] )
+  end
+rescue StandardError, LoadError
+  This.task_warning( 'rdoc' )
+end
+
+#------------------------------------------------------------------------------
+# Coverage - optional code coverage, rcov for 1.8 and simplecov for 1.9, so
+#            for the moment only rcov is listed.
+#------------------------------------------------------------------------------
+if RUBY_VERSION < "1.9.0"
+  begin
+   require 'rcov/rcovtask'
+   Rcov::RcovTask.new( 'coverage' ) do |t|
+     t.libs      << 'spec'
+     t.pattern   = 'spec/**/*_spec.rb'
+     t.verbose   = true
+     t.rcov_opts << "-x ^/"           # remove all the global files
+     t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+   end
+  rescue LoadError
+   This.task_warning( 'rcov' )
+  end
+else
+  begin
+    require 'simplecov'
+    desc 'Run tests with code coverage'
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task[:test].execute
+    end
+    CLOBBER << FileList["coverage"]
+  rescue LoadError
+    This.task_warning( 'simplecov' )
+  end
+end
+
+#------------------------------------------------------------------------------
+# Manifest - We want an explicit list of thos files that are to be packaged in
+#            the gem. Most of this is from Hoe.
+#------------------------------------------------------------------------------
+namespace 'manifest' do
+  desc "Check the manifest"
+  task :check => :clean do
+    files = FileList["**/*", ".*"].exclude( This.exclude_from_manifest ).to_a.sort
+    files = files.select{ |f| File.file?( f ) }
+
+    tmp = "Manifest.tmp"
+    File.open( tmp, 'w' ) do |f|
+      f.puts files.join("\n")
+    end
+
+    begin
+      sh "diff -du Manifest.txt #{tmp}"
+    ensure
+      rm tmp
+    end
+    puts "Manifest looks good"
+  end
+
+  desc "Generate the manifest"
+  task :generate => :clean do
+    files = %x[ git ls-files ].split("\n").sort
+    files.reject! { |f| f =~ This.exclude_from_manifest }
+    File.open( "Manifest.txt", "w" ) do |f|
+      f.puts files.join("\n")
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+# Fixme - look for fixmes and report them
+#------------------------------------------------------------------------------
+namespace :fixme do
+  task :default => 'manifest:check' do
+    This.manifest.each do |file|
+      next if file == __FILE__
+      next unless file =~ %r/(txt|rb|md|rdoc|css|html|xml|css)\Z/
+      puts "FIXME: Rename #{file}" if file =~ /fixme/i
+      IO.readlines( file ).each_with_index do |line, idx|
+        prefix = "FIXME: #{file}:#{idx+1}".ljust(42)
+        puts "#{prefix} => #{line.strip}" if line =~ /fixme/i
+      end
+    end
+  end
+
+  def fixme_project_root
+    This.project_path( '../fixme' )
+  end
+
+  def fixme_project_path( subtree )
+    fixme_project_root.join( subtree )
+  end
+
+  def local_fixme_files
+    This.manifest.select { |p| p =~ %r|^tasks/| }
+  end
+
+  def outdated_fixme_files
+    local_fixme_files.reject do |local|
+      upstream     = fixme_project_path( local )
+      Digest::SHA256.file( local ) == Digest::SHA256.file( upstream )
+    end
+  end
+
+  def fixme_up_to_date?
+    outdated_fixme_files.empty?
+  end
+
+  desc "See if the fixme tools are outdated"
+  task :outdated => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are up to date."
+    else
+      outdated_fixme_files.each do |f|
+        puts "#{f} is outdated"
+      end
+    end
+  end
+
+  desc "Update outdated fixme files"
+  task :update => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are already up to date."
+    else
+      puts "Updating fixme files:"
+      outdated_fixme_files.each do |local|
+        upstream = fixme_project_path( local )
+        puts "  * #{local}"
+        FileUtils.cp( upstream, local )
+      end
+      puts "Use your git commands as appropriate."
+    end
+  end
+end
+desc "Look for fixmes and report them"
+task :fixme => "fixme:default"
+
+#------------------------------------------------------------------------------
+# Gem Specification
+#------------------------------------------------------------------------------
+# Really this is only here to support those who use bundler
+desc "Build the #{This.name}.gemspec file"
+task :gemspec do
+  File.open( This.gemspec_file, "wb+" ) do |f|
+    f.puts "# DO NOT EDIT - This file is automatically generated"
+    f.puts "# Make changes to Manifest.txt and/or Rakefile and regenerate"
+    f.write This.platform_gemspec.to_ruby
+  end
+end
+
+# the gemspec is also a dev artifact and should not be kept around.
+CLOBBER << This.gemspec_file.to_s
+
+# .rbc files from ruby 2.0
+CLOBBER << FileList["**/*.rbc"]
+
+# The standard gem packaging task, everyone has it.
+require 'rubygems/package_task'
+::Gem::PackageTask.new( This.platform_gemspec ) do
+  # nothing
+end
+
+#------------------------------------------------------------------------------
+# Release - the steps we go through to do a final release, this is pulled from
+#           a compbination of mojombo's rakegem, hoe and hoe-git
+#
+# 1) make sure we are on the master branch
+# 2) make sure there are no uncommitted items
+# 3) check the manifest and make sure all looks good
+# 4) build the gem
+# 5) do an empty commit to have the commit message of the version
+# 6) tag that commit as the version
+# 7) push master
+# 8) push the tag
+# 7) pus the gem
+#------------------------------------------------------------------------------
+task :release_check do
+  unless `git branch` =~ /^\* master$/
+    abort "You must be on the master branch to release!"
+  end
+  unless `git status` =~ /^nothing to commit/m
+    abort "Nope, sorry, you have unfinished business"
+  end
+end
+
+desc "Create tag v#{This.version}, build and push #{This.platform_gemspec.full_name} to rubygems.org"
+task :release => [ :release_check, 'manifest:check', :gem ] do
+  sh "git commit --allow-empty -a -m 'Release #{This.version}'"
+  sh "git tag -a -m 'v#{This.version}' v#{This.version}"
+  sh "git push origin master"
+  sh "git push origin v#{This.version}"
+  sh "gem push pkg/#{This.platform_gemspec.full_name}.gem"
+end