mischacks 0.2.0 → 0.2.1

data/History.txt

@@ -1,3 +1,9 @@
+=== UNRELEASED / UNRELEASED
+
+* When generating the gem, grab description from README.
+* Update README.
+* Password: Switch from match? to =~; implement ==.
+
 === 0.2.0 / 2010-08-29
 
 * Add Random.

data/README.txt

@@ -6,7 +6,8 @@
 
 Miscellaneous methods that may or may not be useful.
 
-sh:: Safely pass untrusted parameters to sh scripts.
+sh:: Safely pass untrusted parameters to sh scripts. Raise an exception if the
+script returns a non-zero value.
 
 fork_and_check:: Run a block in a forked process and raise an exception if the
 process returns a non-zero value.
@@ -48,16 +49,23 @@ ever use an untrusted variable as a command.
 
 == SYNOPSIS:
 
-  # sh
+sh::
+
+Note that the scripts are run with set -e.
+
+  MiscHacks.sh 'exec ls'
 
   MiscHacks.sh %q{
     diff -u "$1" "$2" | tr a-z A-Z >"$output"
   }, '/dev/null', '/etc/motd', :output => 'foo'
 
   unsafe_str = %q{" 'foo' $(bar) `baz` "}
-  MiscHacks.sh 'printf "%s\n" "$1"', unsafe_str
+  MiscHacks.sh 'exec printf "%s\n" "$1"', unsafe_str
 
-  # fork_and_check
+  # Raises MiscHacks::ChildError.
+  MiscHacks.sh 'exec false'
+
+fork_and_check::
 
   # These examples raise MiscHacks::ChildError.
   MiscHacks.fork_and_check do exit! 42 end
@@ -67,7 +75,7 @@ ever use an untrusted variable as a command.
   # Does not raise an error.
   MiscHacks.fork_and_check do exit! 0 end
 
-  # do_and_exit
+do_and_exit::
 
   # Prints foo if there are no failures. If anything fails, raises an
   # exception.
@@ -77,23 +85,23 @@ ever use an untrusted variable as a command.
     end
   end
 
-  # overwrite
+overwrite::
 
   MiscHacks.overwrite 'myconfig' do |io|
-    io << config.to_yaml
+    config.to_yaml io
   end
 
-  # tempname_for
+tempname_for::
 
   MiscHacks.tempname_for '/foo/bar/baz'  # => '/foo/bar/.baz.klyce3f517qkh9l'
 
-  # try_n_times
+try_n_times::
 
   io = MiscHacks.try_n_times do
     File.open path, File::RDWR|File::CREAT|File::EXCL
   end
 
-  # Exception#to_formatted_string
+Exception#to_formatted_string::
 
   begin
     # Do something
@@ -101,14 +109,31 @@ ever use an untrusted variable as a command.
     warn e.to_formatted_string
   end
 
+Random::
+
+  n = MiscHacks::RANDOM.exp 4    # 0   ≤ n < 2⁴
+  n = MiscHacks::RANDOM.float    # 0.0 ≤ n < 1.0
+  n = MiscHacks::RANDOM.float 4  # 0.0 ≤ n < 4.0
+  n = MiscHacks::RANDOM.int 4    # 0   ≤ n < 4
+
+Password::
+
+  # New password
+  password = MiscHacks::Password.new_from_password cleartext_from_user
+  store_in_database password.to_s  # encrypted
+
+  # Verify password
+  password = MiscHacks::Password.new password_from_database
+  password =~ cleartext_from_user  # ⇒ true/false
+
 == REQUIREMENTS:
 
-* POSIX sh
-* A system that implements fork
+* POSIX sh for the sh method
+* A system that implements fork for some methods
 
 == INSTALL:
 
-* sudo gem install ion1-mischacks --source http://gems.github.com/
+* sudo gem install mischacks
 
 == LICENSE:
 

data/Rakefile

@@ -28,12 +28,9 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "mischacks"
     gemspec.summary = "Miscellaneous methods that may or may not be useful"
-    gemspec.description = \
-      "sh: Safely pass untrusted parameters to sh scripts.  " \
-      "overwrite: Safely replace a file.  " \
-      "Exception#to_formatted_string: Return a string that looks like how Ruby would dump an uncaught exception.  " \
-      "Random: Generate various types of random numbers using SecureRandom.  " \
-      "Password: A small wrapper for String#crypt that does secure salt generation and easy password verification."
+    gemspec.description = File.read(File.dirname(__FILE__)+'/README.txt').
+                          sub(/.*^=+ DESCRIPTION[^\n]*\n*/m, '').
+                          sub(/\n*^=.*/m, '')
     gemspec.email = "devel@johan.kiviniemi.name"
     gemspec.homepage = "http://johan.kiviniemi.name/software/mischacks/"
     gemspec.authors = ["Johan Kiviniemi"]

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/mischacks.rb

@@ -34,7 +34,7 @@ module MiscHacks
     fork_and_check do
       do_and_exit! do
         env.each_pair do |k, v| ENV[k.to_s] = v.to_s end
-        exec *(%W{sh -e -c #{cmd} sh} + args.map {|a| a.to_s })
+        exec *(%W{sh -e -c #{cmd} sh} + args.map(&:to_s))
       end
     end
 

data/lib/mischacks/password.rb

@@ -39,10 +39,14 @@ module MiscHacks
       end
     end
 
-    def match? password
+    def =~ password
       to_s == password.crypt(@salt)
     end
 
+    def == other
+      to_s == other.to_s
+    end
+
     def to_s
       [@salt, @encrypted].join
     end

data/spec/mischacks/password_spec.rb

@@ -19,14 +19,6 @@ require 'mischacks/password'
 require 'set'
 
 describe MiscHacks::Password do
-  def match expected
-    simple_matcher("match #{expected.inspect}") do |given, matcher|
-      matcher.failure_message = "expected #{given.inspect} to match #{expected.inspect}"
-      matcher.negative_failure_message = "expected #{given.inspect} not to match #{expected.inspect}"
-      given.match? expected
-    end
-  end
-
   before :all do
     @many = 1000
 
@@ -117,17 +109,29 @@ describe MiscHacks::Password do
     end
   end
 
-  describe 'match?' do
+  describe '=~' do
     it 'should verify whether the cleartext parameter matches the encrypted password' do
       %w{foo bar baz}.each do |password|
         pw = MiscHacks::Password.new_from_password password
-        pw.should match password
-        pw.should_not match "#{password}x"
-        pw.should_not match ''
+        pw.should =~ password
+        pw.should_not =~ "#{password}x"
+        pw.should_not =~ ''
       end
     end
   end
 
+  describe '==' do
+    it 'should verify whether the encrypted parameter matches the encrypted password' do
+      pw = MiscHacks::Password.new @encrypted
+
+      pw.should == @encrypted
+      pw.should == MiscHacks::Password.new(@encrypted)
+
+      pw.should_not == 'foo'
+      pw.should_not == MiscHacks::Password.new_from_password("#{@password}x")
+    end
+  end
+
   describe 'to_s' do
     it 'should return the encrypted password' do
       MiscHacks::Password.new(@encrypted).to_s.should == @encrypted

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mischacks
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Johan Kiviniemi
@@ -13,7 +13,29 @@ date: 2010-08-29 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
-description: "sh: Safely pass untrusted parameters to sh scripts.  overwrite: Safely replace a file.  Exception#to_formatted_string: Return a string that looks like how Ruby would dump an uncaught exception.  Random: Generate various types of random numbers using SecureRandom.  Password: A small wrapper for String#crypt that does secure salt generation and easy password verification."
+description: "Miscellaneous methods that may or may not be useful.\n\n\
+  sh:: Safely pass untrusted parameters to sh scripts. Raise an exception if the\n\
+  script returns a non-zero value.\n\n\
+  fork_and_check:: Run a block in a forked process and raise an exception if the\n\
+  process returns a non-zero value.\n\n\
+  do_and_exit, do_and_exit!:: Run a block. If the block does not run exit!, a\n\
+  successful exec or equivalent, run exit(1) or exit!(1) ourselves. Useful to\n\
+  make sure a forked block either runs a successful exec or dies.\n\n\
+  Any exceptions from the block are printed to standard error.\n\n\
+  overwrite:: Safely replace a file. Writes to a temporary file and then moves it\n\
+  over the old file.\n\n\
+  tempname_for:: Generates an unique temporary path based on a filename. The\n\
+  generated filename resides in the same directory as the original one.\n\n\
+  try_n_times:: Retries a block of code until it succeeds or a maximum number of\n\
+  attempts (default 10) is exceeded.\n\n\
+  Exception#to_formatted_string:: Return a string that looks like how Ruby would\n\
+  dump an uncaught exception.\n\n\
+  IO#best_datasync:: Try fdatasync, falling back to fsync, falling back to flush.\n\n\
+  Random#exp:: Return a random integer 0 \xE2\x89\xA4 n < 2^argument (using SecureRandom).\n\n\
+  Random#float:: Return a random float 0.0 \xE2\x89\xA4 n < argument (using SecureRandom).\n\n\
+  Random#int:: Return a random integer 0 \xE2\x89\xA4 n < argument (using SecureRandom).\n\n\
+  Password:: A small wrapper for String#crypt that does secure salt generation\n\
+  and easy password verification."
 email: devel@johan.kiviniemi.name
 executables: []
 
@@ -25,7 +47,6 @@ files:
 - .gitignore
 - COPYING
 - History.txt
-- Manifest.txt
 - README.txt
 - Rakefile
 - VERSION

data/Manifest.txt

@@ -1,9 +0,0 @@
-COPYING
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/mischacks.rb
-mischacks.gemspec
-spec/mischacks_spec.rb
-spec/spec_helper.rb