mario 0.0.5 → 0.0.6

data/.gitignore

@@ -22,4 +22,7 @@ pkg
 vendor
 Gemfile
 Gemfile.lock
-.bundle
+.bundle
+*.gem
+doc
+.yardoc

data/README.rdoc

@@ -1,16 +1,14 @@
 = mario
 
-Description goes here.
+Mario provides some very simple tools for figuring out which platform you're on and, depending on your needs, some for helping you adapt.
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
+* `bundle install`
+* `bundle lock`
+* `rake test`
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
 
 == Copyright
 

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/lib/mario.rb

@@ -2,5 +2,5 @@
 require 'rbconfig'
 require 'logger'
 lib = File.dirname(__FILE__)
-%w{ mario/platform mario/toolbelt }.each { |file| require File.expand_path(file, lib) }
+%w{  mario/hats/nix mario/hats/windows mario/platform }.each { |file| require File.expand_path(file, lib) }
 

data/lib/mario/hats/nix.rb

@@ -0,0 +1,18 @@
+# Posix?
+module Mario
+  module Hats
+    module Nix
+      
+      # Escapes paths for use in execute statements
+      # 
+      # @param [String]
+      # @return [String]
+      def shell_escape_path(str)
+        # Taken from ruby mailing list, seems to work, probably needs lots of testing :(
+        str.to_s.gsub(/(?=[^a-zA-Z0-9_.\/\-\x7F-\xFF\n])/n, '\\').
+          gsub(/\n/, "'\n'").
+        sub(/^$/, "''")
+      end
+    end
+  end
+end

data/lib/mario/hats/windows.rb

@@ -0,0 +1,13 @@
+module Mario
+  module Hats
+    module Windows
+      # Escapes a file paths for use in system calls and execute statements
+      # @param [String]
+      # @return [String]
+      def shell_escape_path(str)
+        #Wrap windows paths with white space in quotes
+        str =~ /\s/ ? "\"#{str}\"" : str
+      end
+    end
+  end
+end

data/lib/mario/platform.rb

@@ -1,91 +1,215 @@
 module Mario
   class Platform
     @@forced = nil
+    @@logger = nil
+    @@current = nil
 
     class << self
+      
+      # A list of unix like operating system classes
+      #
+      # @return [Array[Class]]
       def nix_group
-        { :cygwin => 'cygwin', 
-          :linux => 'linux',
-          :osx => 'darwin',
-          :solaris => 'solaris',
-          :bsd => 'bsd'}
+        [Cygwin, Linux, BSD, Solaris, Darwin]
       end
       
+      # A list of windows operating system classes
+      #
+      # @return [Array[Class]]
       def windows_group
-        { :winnt => 'mswin',
-          :win7 => 'mingw' }
+        [Windows7, WindowsNT]
       end
 
+      # The union of the {nix_group} and {windows_group} operating system class sets
+      # 
+      # @return [Array[Class]]
       def targets
-        nix_group.merge(windows_group)
+        nix_group | windows_group
       end
 
+      # Checks if the current platform is linux
+      # 
+      # @return [true, false]
       def linux? 
-        check_os :linux
+        check Linux
       end
       
-      def osx?
-        check_os :osx 
+      # Checks if the current platform is osx
+      # 
+      # @return [true, false]
+      def darwin?
+        check Darwin
       end
 
+      # Checks if the current platform is solaris
+      # 
+      # @return [true, false]
       def solaris?
-        check_os :solaris
+        check Solaris
       end
-      
+
+      # Checks if the current platform is bsd
+      #
+      # @return [true, false]
       def bsd?
-        check_os :bsd
+        check BSD
       end
       
+      # Checks if the current platform is cygwin
+      #
+      # @return [true, false]
       def cygwin?
-        check_os :cygwin
+        check Cygwin
       end
 
-      def win7?
-        check_os :win7
+      # Checks if the current platform is windows 7
+      #
+      # @return [true, false]
+      def windows7?
+        check Windows7
       end
       
-      def winnt?
-        check_os :winnt
+      # Checks if the current platform is windows nt
+      #
+      # @return [true, false]
+      def windowsnt?
+        check WindowsNT
       end
 
+      # Checks if the current platform is part of the {nix_group} and returns that class
+      #
+      # @return [Class]
       def nix?
         check_group nix_group
       end
 
+      # Checks if the current platform is part of the {windows_group} and returns that class
+      #
+      # @return [Class]
       def windows?
         check_group windows_group
       end
 
+      # Checks a list of possible operating system classes to see if their target os strings match the {target_os} value
+      #
+      # @return [Class]
       def check_group(group)
-        group.each do |key, value|
-          return true if check_os key
+        group.each do |klass|
+          return klass if check klass
         end
         false
       end
 
-      alias_method :darwin?, :osx?
+      alias_method :osx?, :darwin?
 
-      def os
-        @@forced || Config::CONFIG['target_os']
+      # Uses the forced class target os string if provided otherwise uses the target_os rbconfig hash element
+      #
+      # @return [String]
+      def target_os
+        @@forced ? @@forced.target : Config::CONFIG['target_os']
       end
 
-      def check_os(key)
-        os.downcase.include?(targets[key])
+      # Checks an os class against {target_os}
+      #
+      # @return [true, false]
+      def check(klass)
+        target_os.downcase.include?(klass.target)
       end
 
-      def forced=(val)
-        logger.warn("Mario::Platform.os will now report as #{val}")
-        @@forced=val
+      # Allows the user to force Mario to report the operating system as one of the provided operatin system classes
+      #
+      def forced=(klass)
+        @@current=nil
+        @@forced=klass
+        logger.warn(<<-msg)
+Mario::Platform.target_os will now report as '#{target_os}' and #{klass} will be used for all functionality including operating system checks and hat based functionality (See Mario::Hats for more information)
+msg
       end
       
+      # Returns the value of the currently forced operating system class if any
+      #
+      # @return [Class]
       def forced
         @@forced
       end
 
+      # Allows the setting of a logging mechanism, defaults to STDOUT
+      #
+      # @return [Logger]
       def logger(out=STDOUT)
-        @@logger ||= Logger.new(STDOUT)
+        @@logger ||= Logger.new(out)
         @@logger
       end
+
+      # Returns an instance of the current operating system class as determined by {check_group} against all operating
+      # system classes provided by {targets}
+      #
+      # @return [OperatingSystem]
+      def current
+        # Search for the current target os
+        current_target_klass = check_group(targets)
+        @@current ||= current_target_klass.new
+        @@current
+      end
+    end
+
+    # Any additional fucniontality and they should be moved to a lib/platforms/<OS>.rb
+    class Cygwin
+      include Hats::Nix
+      
+      def self.target
+        'cygwin'
+      end
+    
+    end
+
+    class Darwin    
+      include Hats::Nix
+
+      def self.target 
+        'darwin'
+      end
+    end
+
+    class Linux
+      include Hats::Nix
+
+      def self.target
+        'linux'
+      end
+    end
+
+    class BSD
+      include Hats::Nix
+  
+      def self.target
+        'bsd'
+      end
+    end
+
+    class Solaris
+      include Hats::Nix
+
+      def self.target
+        'solaris'
+      end
+    end
+
+
+    class Windows7
+      include Hats::Windows
+
+      def self.target
+        'mingw'
+      end
+    end
+
+    class WindowsNT
+      include Hats::Windows
+
+      def self.target
+        'mswin'
+      end
     end
   end
 end

data/mario.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mario}
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Bender"]
+  s.date = %q{2010-03-20}
+  s.description = %q{Mario is a collection of utilities for dealing with platform specific issues}
+  s.email = %q{john.m.bender@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mario.rb",
+     "lib/mario/hats/nix.rb",
+     "lib/mario/hats/windows.rb",
+     "lib/mario/platform.rb",
+     "mario.gemspec",
+     "test/helper.rb",
+     "test/mario/hats/test_nix.rb",
+     "test/mario/hats/test_windows.rb",
+     "test/mario/test_plaform.rb"
+  ]
+  s.homepage = %q{http://github.com/johnbender/mario}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Mario is a collection of utilities for dealing with platform specific issues}
+  s.test_files = [
+    "test/helper.rb",
+     "test/mario/hats/test_nix.rb",
+     "test/mario/hats/test_windows.rb",
+     "test/mario/test_plaform.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/test/mario/hats/test_nix.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestNixHat < Test::Unit::TestCase
+  context "Mario's Nix Hat" do
+    setup do
+      Mario::Platform.forced = Mario::Platform::Linux
+    end
+    
+    should "escape weird characters in paths meant for a shell command " do
+      %w( $ @ % ^ & * ).each do |char|
+        assert Mario::Platform.current.shell_escape_path(char).include?('\\')
+      end      
+    end
+  end
+end

data/test/mario/hats/test_windows.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+class TestWindowsHat < Test::Unit::TestCase
+  context "Mario's windows hat" do 
+    setup do
+      Mario::Platform.forced = Mario::Platform::Windows7
+    end
+
+    should "wrap file paths with white space in double quotes" do
+      result = Mario::Platform.current.shell_escape_path(' something serious ')
+      assert result =~ /^".+"$/
+    end
+
+    should "not have spaces escaped" do
+      assert !Mario::Platform.current.shell_escape_path( 'a b' ).include?('\\')
+    end
+  end
+end

data/test/mario/test_plaform.rb

@@ -1,53 +1,64 @@
 require 'helper'
 
 class TestPlatform < Test::Unit::TestCase
-  context "Mario's jumping platforms" do
-  
+  context "Mario platforms" do
+    context 'on any platform' do
+      setup do
+        Mario::Platform.forced = nil
+      end
+
+      should "find at least one os representing a class" do
+        assert Mario::Platform.check_group(Mario::Platform.targets)
+      end
+    end
+
     context 'when testing for *nix' do
       should 'return true for all known variants' do
-        Mario::Platform::nix_group.each do |key, value|
-          assert check_nix(key) 
+        Mario::Platform::nix_group.each do |klass|
+          assert check_nix(klass) 
         end
       end
       
       should 'return false for all other' do
         # TODO use relative complement of nix_group in targets
-        Mario::Platform::windows_group.each do |key, value|
-          assert !check_nix(key)
+        Mario::Platform::windows_group.each do |klass|
+          assert !check_nix(klass)
         end
       end
     end  
 
     context 'when testing for windows' do
-      should 'only return true for all known variants' do
-        Mario::Platform.windows_group.each do |key, value|
-          assert check_win(key)
+      should 'return true for all known variants' do
+        Mario::Platform.windows_group.each do |klass|
+          assert check_win(klass)
         end
       end
 
       should 'return false for others' do 
         # TODO use relative complement of windows_group in targets
-        Mario::Platform.nix_group.each do |key, value|
-          assert !check_win(key)
+        Mario::Platform.nix_group.each do |klass|
+          assert !check_win(klass)
         end
       end
     end
 
     context 'when checking any os with abnormal target strings' do
       should 'handle extranious characters' do
-        assert check_nix('12%&linux%#$')
+        Mario::Platform.expects(:target_os).twice.returns("12%#{first_os_klass.target}&%$")
+        assert check_nix first_os_klass
       end
 
       should 'handle capitals' do
-        assert check_nix('LINUX')
+        Mario::Platform.expects(:target_os).twice.returns(first_os_klass.target.upcase)
+        assert check_nix first_os_klass
       end
     end  
 
     context 'when checking an os' do
       should 'respond positively to each os listed in targets' do
-        Mario::Platform.targets.each do |key, value|
-          Mario::Platform.forced = value
-          assert Mario::Platform.send(key.to_s + '?')
+        Mario::Platform.targets.each do |klass|
+          Mario::Platform.forced = klass
+          assert Mario::Platform.send(klass.to_s.split('::').last.downcase + '?')
         end
       end
     end
@@ -56,19 +67,58 @@ class TestPlatform < Test::Unit::TestCase
       should 'log at a warning level' do
         logger = mock('logger')
         Mario::Platform.expects(:logger).returns(logger)
-        logger.expects(:warn).with { |string| string =~ /foo/ }
-        Mario::Platform.forced = 'foo'
+        logger.expects(:warn).with do |string| 
+          string =~ /#{first_os_klass.target}/ &&  string =~ /#{first_os_klass}/ 
+        end
+        Mario::Platform.forced = first_os_klass
+      end
+      
+      should 'reset the current os' do
+        mock_klass = mock('platform klass')
+        Mario::Platform.forced = first_os_klass
+        Mario::Platform.expects(:check_group).with(Mario::Platform.targets).returns(mock_klass)
+        mock_klass.expects(:new).returns(nil)
+        assert !Mario::Platform.current
+      end
+    end
+
+    context 'checking a group' do
+      setup do
+        @forced = mock_os_klass('force')
+        Mario::Platform.forced = @forced
+      end
+
+      should "return the os class itself when found" do
+        assert Mario::Platform.check_group([mock_os_klass, @forced, mock_os_klass]) == @forced
+      end
+      
+      should "return once if one is found in a group of classes that respond to target" do
+        assert Mario::Platform.check_group([mock_os_klass, @forced, mock_os_klass])
+      end
+
+      should "return not return one if non are found" do
+        assert !Mario::Platform.check_group([mock_os_klass, mock_os_klass])
       end
     end
   end
 
   def check_nix(force)
-    Mario::Platform.forced = Mario::Platform.targets[force]
+    Mario::Platform.forced = force
     Mario::Platform.nix?
   end
 
   def check_win(force)
-    Mario::Platform.forced = Mario::Platform::targets[force]
+    Mario::Platform.forced = force
     Mario::Platform.windows?
   end
+
+  def first_os_klass
+    Mario::Platform.targets.first
+  end
+
+  def mock_os_klass(str='foo')
+    mock = mock('os klass')
+    mock.stubs(:target).returns(str)
+    mock
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mario
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - John Bender
@@ -47,12 +47,16 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- VERSION
 - lib/mario.rb
+- lib/mario/hats/nix.rb
+- lib/mario/hats/windows.rb
 - lib/mario/platform.rb
-- lib/mario/toolbelt.rb
+- mario.gemspec
 - test/helper.rb
+- test/mario/hats/test_nix.rb
+- test/mario/hats/test_windows.rb
 - test/mario/test_plaform.rb
-- test/mario/test_toolbelt.rb
 has_rdoc: true
 homepage: http://github.com/johnbender/mario
 licenses: []
@@ -83,5 +87,6 @@ specification_version: 3
 summary: Mario is a collection of utilities for dealing with platform specific issues
 test_files: 
 - test/helper.rb
+- test/mario/hats/test_nix.rb
+- test/mario/hats/test_windows.rb
 - test/mario/test_plaform.rb
-- test/mario/test_toolbelt.rb

data/lib/mario/toolbelt.rb

@@ -1,24 +0,0 @@
-module Mario
-  class Toolbelt
-    class << self
-
-      # Stolen shamelessly from Mitchell Hashimoto's Virtualbox gem!
-      # TODO more research
-      def shell_escape_path(str)
-        if Platform.windows?
-          #Wrap windows paths with white space in quotes
-          str = "\"#{str}\"" if str =~ /\s/
-          return str
-        end
-        
-        str.to_s.gsub(/(?=[^a-zA-Z0-9_.\/\-\x7F-\xFF\n])/n, '\\').
-          gsub(/\n/, "'\n'").
-          sub(/^$/, "''")
-      end
-      
-      # Mario would just jumpt to escape a shell's path
-      alias_method :jump, :shell_escape_path
-      
-    end
-  end
-end

data/test/mario/test_toolbelt.rb

@@ -1,25 +0,0 @@
-require 'helper'
-
-class TestPlatform < Test::Unit::TestCase
-  context "Mario's toolbelt" do
-    context "on all platforms" do
-      should "escape weird characters in paths meant for a shell command " do
-        %w( $ @ % ^ & * ).each do |char|
-          assert Mario::Toolbelt.shell_escape_path(char).include?('\\')
-        end      
-      end
-    end
-
-    context "on windows" do 
-      setup do
-        Mario::Platform.forced = Mario::Platform.targets[:win7]
-      end
-
-      should "wrap file paths with white space in double quotes" do
-        result = Mario::Toolbelt.shell_escape_path(' something serious ')
-        assert result =~ /^"/
-        assert result =~ /"$/
-      end
-    end
-  end
-end