dionysus 1.0.1 → 1.0.2

data/README.md

@@ -21,7 +21,7 @@ Installation
 Usage
 -----
 
-First, add "dionysus" to your Gemfile or whatever other dependency system you're using.  Then, you'll need to require each file as you need them.  Dionysus is setup *à la carte* since parts are bound to conflict with something you're using at some point.
+First, add "dionysus" to your Gemfile or whatever other dependency system you're using.  Then, you'll need to require each file/module as you need them.  Dionysus is setup *à la carte* since parts are bound to conflict with something you're using at some point.
 
 Resources
 ---------

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/dionysus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dionysus}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis D. Warlick, Jr."]
-  s.date = %q{2010-09-19}
+  s.date = %q{2010-10-03}
   s.email = %q{warlickt@operissystems.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -35,13 +35,15 @@ Gem::Specification.new do |s|
     "lib/dionysus/security/password_salt.rb",
     "lib/dionysus/security/string.rb",
     "lib/dionysus/string.rb",
+    "lib/dionysus/version_string.rb",
     "spec/configuration_spec.rb",
     "spec/digest_spec.rb",
     "spec/dionysus_spec.rb",
     "spec/password_salt_spec.rb",
     "spec/spec_helper.rb",
     "spec/string_security_spec.rb",
-    "spec/string_spec.rb"
+    "spec/string_spec.rb",
+    "spec/version_string_spec.rb"
   ]
   s.homepage = %q{http://github.com/tekwiz/dionysus}
   s.require_paths = ["lib"]
@@ -54,7 +56,8 @@ Gem::Specification.new do |s|
     "spec/password_salt_spec.rb",
     "spec/spec_helper.rb",
     "spec/string_security_spec.rb",
-    "spec/string_spec.rb"
+    "spec/string_spec.rb",
+    "spec/version_string_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/dionysus.rb

@@ -18,7 +18,12 @@ Bundler.setup
 %w(hash class module).each { |v| require 'active_support/core_ext/'+v }
 
 ##
-# The top-level for Dionysus
+# The top-level for Dionysus.
+#
+# Dionysus is setup *à la carte* since parts are bound to conflict with 
+# something you're using at some point.  This means that if you need something,
+# you *must* require it.  See the documentation for instructions on what you 
+# should require (this is always within the first few lines).
 module Dionysus
   # The current version
   VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip

data/lib/dionysus/configuration.rb

@@ -1,4 +1,5 @@
 require 'dionysus'
+require 'dionysus/version_string'
 
 ##
 # = Configuration
@@ -117,7 +118,11 @@ class Configuration
   def valid_key?( key )
     return false if key.blank?
     key = _normalize_key(key).to_s
-    key =~ /^#{VALID_KEY}$/ and !self.methods.include?(key.to_sym)
+    if RUBY_VERSION.satisfies?('>= 1.9.2')
+      key =~ /^#{VALID_KEY}$/ and !self.methods.include?(key.to_sym)
+    else
+      key =~ /^#{VALID_KEY}$/ and !self.methods.include?(key)
+    end
   end
   
   ##

data/lib/dionysus/security/password_salt.rb

@@ -2,7 +2,14 @@ require 'dionysus'
 require 'active_support/secure_random'
 
 ##
-# Encapsulates a password salt.
+# Encapsulates a password salt.  This is usually not required specifically, 
+# instead it's required as a part of the security module:
+#
+#     require 'dionysus/security'
+#
+# However, you may require it specifically:
+#
+#     require 'dionysus/security/password_salt'
 #
 # Examples
 #

data/lib/dionysus/security/string.rb

@@ -2,6 +2,7 @@ require 'dionysus'
 require 'dionysus/digest'
 require 'dionysus/string'
 require 'dionysus/security/password_salt'
+require 'dionysus/version_string'
 
 ##
 # Adds String hashing and salting convenience methods.
@@ -26,12 +27,23 @@ class String
   # Sanitize the String from memory.  This is non-reversible.  Runs 7 passes 
   # by default.
   #
+  # NOTE: In Ruby 1.9, this uses the String#setbyte(index, int) method.  In Ruby < 1.9, this 
+  # uses String#[]=(int)
+  #
   def sanitize( passes = 7 )
-    passes.times do
-      (0...self.length).each { |i| self[i] = rand(256).chr }
+    if RUBY_VERSION.satisfies?('< 1.9')
+      passes.times do
+        (0...self.length).each { |i| self[i] = rand(256) }
+      end
+      (0...self.length).each { |i| self[i] = 0 }
+      self.delete!("\000")
+    elsif RUBY_VERSION.satisfies?('>= 1.9')
+      passes.times do
+        (0...self.length).each { |i| self.setbyte(i, rand(256)) }
+      end
+      (0...self.length).each { |i| self.setbyte(i, 0) }
+      self.clear
     end
-    (0...self.length).each { |i| self[i] = 0.chr }
-    self.delete!("\000")
   end
   
   ##

data/lib/dionysus/version_string.rb

@@ -0,0 +1,96 @@
+require 'dionysus'
+require 'active_support/core_ext/kernel/reporting'
+require 'active_support/core_ext/module/delegation'
+
+module Dionysus
+  ##
+  # = VersonString
+  #
+  #     require 'dionysus/version_string'
+  #
+  # VersionString is a proxy to Gem::Version that modifies the comparable 
+  # interface on String to compare based on the Gem::Version comparator.  
+  # It also adds a +satisfies?+ method to check for a Gem::Requirement.
+  #
+  # In addition, requiring VersionString changes the +RUBY_VERSION+ constant 
+  # into a VersionString. Because VersionString "is a" String, there should be
+  # no ill-effects with this change since only the Comparable interface is 
+  # overriden and this does not change the original operation of the == method.
+  #
+  # The comparator works by converting strings into Gem::Version objects, so 
+  # this still works as you would expect:
+  #
+  #     RUBY_VERSION < '1.9'
+  class VersionString < String
+    include Comparable
+
+    ##
+    # Initializes a VersionString and freezes itself.
+    def initialize(*args)
+      super(*args)
+      to_rubygem_version
+      freeze
+    end
+
+    ##
+    # Compares this VersionString to another String, VersionString, or 
+    # Gem::Version.
+    #
+    # Examples:
+    #
+    #     Dionysus::VersionString.new('1.0') > '1.0' => false
+    #     Dionysus::VersionString.new('1.0') == Gem::Version('1.0') => true
+    #     Dionysus::VersionString.new('1.0') <=> Dionysus::VersionString.new('1.0') => 0
+    #
+    # See http://rubygems.rubyforge.org/rubygems-update/Gem/Version.html
+    def <=>( obj )
+      obj = obj.dup
+      if obj.is_a?(String) or obj.is_a?(Gem::Version)
+        obj = Gem::Version.create(obj)
+      else
+        raise ArgumentError, "Can only compare to a Dionysus::VersionString/String or Gem::Version"
+      end
+
+      self.to_rubygem_version <=> obj
+    end
+    alias_method :"eql?", :"=="
+
+    ##
+    # Determines if the given requirement String or Gem::Requirement is 
+    # satisfied by this version.
+    #
+    # Examples:
+    #
+    #   Dionysus::VersionString.new('1.6.7').satisfies? '~> 1.6.0' => true
+    #   Dionysus::VersionString.new('1.6.7').satisfies? Gem::Requirement('< 1.6') => false
+    #
+    # See http://rubygems.rubyforge.org/rubygems-update/Gem/Requirement.html
+    def satisfies?( requirement )
+      requirement = requirement.dup
+      if requirement.is_a?(String) or requirement.is_a?(Gem::Requirement)
+        requirement = Gem::Requirement.create(requirement)
+      else
+        raise ArgumentError, "Can only compare to a String or Gem::Requirement"
+      end
+
+      requirement.satisfied_by?(to_rubygem_version)
+    end
+
+    ##
+    # Converts this VersionString into a Gem::Version
+    def to_rubygem_version
+      @rubygem_version ||= Gem::Version.create(self)
+    end
+    alias_method :to_gem_version, :to_rubygem_version
+
+    ##
+    # Indicates whether this VersionString is a prerelease.
+    #
+    # See http://rubygems.rubyforge.org/rubygems-update/Gem/Version.html#method-i-prerelease%3F
+    def prerelease?() to_rubygem_version.prerelease?; end
+  end
+end
+
+silence_warnings do
+  RUBY_VERSION = Dionysus::VersionString.new(RUBY_VERSION)
+end

data/spec/version_string_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'dionysus/version_string'
+describe Dionysus::VersionString do
+  before(:each) do
+    @version_string = Dionysus::VersionString.new('1.5.7')
+  end
+
+  it 'should be frozen' do
+    @version_string.should be_frozen
+  end
+
+  it 'should have to_rubygem_version' do
+    @version_string.to_rubygem_version.should be_a(Gem::Version)
+    gem_version = @version_string.to_gem_version
+    @version_string.to_rubygem_version.should eq(gem_version)
+  end
+
+  it 'should have prerelease? that delegates to Gem::Version' do
+    @version_string.should_not be_prerelease
+    version = Dionysus::VersionString.new('1.5.alpha')
+    version.should be_prerelease
+  end
+
+  it 'should have eql?' do
+    (@version_string.eql?('1.5.7')).should be_true
+  end
+
+  describe 'comparable' do
+    before(:all) do
+      @values = {'1.5.7' => 0, '1.5' => 1, '1.6' => -1}
+    end
+
+    it 'should work with VersionStrings' do
+      @values.each do |ver, c|
+        (@version_string <=> Dionysus::VersionString.new(ver)).should == c
+      end
+    end
+
+    it 'should work with Strings' do
+      @values.each do |ver, c|
+        (@version_string <=> ver).should == c
+      end
+    end
+
+    it 'should work with Gem::Versions' do
+      @values.each do |ver, c|
+        (@version_string <=> Gem::Version.new(ver.dup)) == c
+      end
+    end
+
+    it 'should not work with anything else' do
+      lambda {
+        @version_string <=> Object.new
+      }.should raise_error(ArgumentError, "Can only compare to a Dionysus::VersionString/String or Gem::Version")
+    end
+  end
+
+  describe 'satisfies?' do
+    before(:all) do
+      @values = {'~> 1.5.0' => true, '~> 2' => false}
+    end
+
+    it 'should work with Strings' do
+      @values.each do |req, v|
+        @version_string.satisfies?(req).should == v
+      end
+    end
+
+    it 'should work with Gem::Requirements' do
+      @values.each do |req, v|
+        @version_string.satisfies?(Gem::Requirement.new(req)).should == v
+      end
+    end
+
+    it 'should not work with anything else' do
+      lambda {
+        @version_string.satisfies?(Object.new)
+      }.should raise_error(ArgumentError, "Can only compare to a String or Gem::Requirement")
+    end
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Travis D. Warlick, Jr.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-19 00:00:00 -05:00
+date: 2010-10-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -284,6 +284,7 @@ files:
 - lib/dionysus/security/password_salt.rb
 - lib/dionysus/security/string.rb
 - lib/dionysus/string.rb
+- lib/dionysus/version_string.rb
 - spec/configuration_spec.rb
 - spec/digest_spec.rb
 - spec/dionysus_spec.rb
@@ -291,6 +292,7 @@ files:
 - spec/spec_helper.rb
 - spec/string_security_spec.rb
 - spec/string_spec.rb
+- spec/version_string_spec.rb
 has_rdoc: true
 homepage: http://github.com/tekwiz/dionysus
 licenses: []
@@ -305,7 +307,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 300643251
+      hash: -737655002021028068
       segments: 
       - 0
       version: "0"
@@ -332,3 +334,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/string_security_spec.rb
 - spec/string_spec.rb
+- spec/version_string_spec.rb