mario 0.0.6 → 0.1.0

data/README.md

@@ -0,0 +1,47 @@
+mario
+=====
+
+Mario is super small library with only two standard library dependencies to help you figure out what platform you're on. 
+
+
+platform
+--------
+Mario's main function is providing simple methods to match your current operating system or a group of operating systems. For example if you wanted to know if your code was excuting on some version of Windows
+
+    Mario::Platform.windows?
+    
+Or a Unix-like operating system
+
+    Mario::Platform.nix?
+    
+If you want to be more specific you can do that too
+
+    Mario::Platform.bsd? # or linux? or windows7? or darwin?
+
+If for some reason you opperating system isn't represented please alert me and/or see the setup for hacking on Mario below, but in the meantime you can force which operating system you would like Mario to report
+
+    Mario::Platform.forced = Mario::Platform::Linux
+
+hats
+----
+Mario has different abilities with different hats, each hat is tied to the current operating system. To start Mario can only escape file paths properly for nix operating systems and there's still testing to be done on the windows version, but there will be more to come. To make use of Mario's version of his abilities on your platform you might do the following:
+
+    Mario::Platform.current.shell_escape_path('C:\Some Path\With Some Spaces.filext')
+
+Its important to note that shell_escape_path is an actual method and not what Mario would do when confronted with an oncoming koopa shell.
+
+hacking
+-------
+
+If you want to hack on mario, and I would grateful for any patches to for all those dark little corners that need light shone on them, just do the following from your project directory after forking and cloning:
+
+    $ bundle install
+    $ bundle lock
+    $ rake test
+    
+If all is well you're ready to roll.
+
+license
+-------
+
+See the license file for more information.

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

data/lib/mario.rb

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

data/lib/mario/platform.rb

@@ -10,7 +10,7 @@ module Mario
       #
       # @return [Array[Class]]
       def nix_group
-        [Cygwin, Linux, BSD, Solaris, Darwin]
+        [Cygwin, Linux, BSD, Solaris] + darwin_group
       end
       
       # A list of windows operating system classes
@@ -20,74 +20,42 @@ module Mario
         [Windows7, WindowsNT]
       end
 
-      # The union of the {nix_group} and {windows_group} operating system class sets
-      # 
+      # A list of the different Darwin Versions
+      #
       # @return [Array[Class]]
-      def targets
-        nix_group | windows_group
-      end
-
-      # Checks if the current platform is linux
-      # 
-      # @return [true, false]
-      def linux? 
-        check Linux
-      end
-      
-      # Checks if the current platform is osx
-      # 
-      # @return [true, false]
-      def darwin?
-        check Darwin
+      def darwin_group
+        # NOTE ordering required, but removal of Darwin class constant
+        # procludes forcing os as Darwin
+        [Tiger, Leopard, SnowLeopard, Darwin]
       end
 
-      # Checks if the current platform is solaris
+      # The union of the {nix_group} and {windows_group} operating system class sets, each operating system
+      # test method ( ie linux? ) is built from this set of class constants
       # 
-      # @return [true, false]
-      def solaris?
-        check Solaris
-      end
-
-      # Checks if the current platform is bsd
-      #
-      # @return [true, false]
-      def bsd?
-        check BSD
-      end
-      
-      # Checks if the current platform is cygwin
-      #
-      # @return [true, false]
-      def cygwin?
-        check Cygwin
-      end
-
-      # Checks if the current platform is windows 7
-      #
-      # @return [true, false]
-      def windows7?
-        check Windows7
-      end
-      
-      # Checks if the current platform is windows nt
-      #
-      # @return [true, false]
-      def windowsnt?
-        check WindowsNT
+      # @return [Array[Class]]
+      def targets
+        nix_group | windows_group
       end
 
       # Checks if the current platform is part of the {nix_group} and returns that class
       #
       # @return [Class]
       def nix?
-        check_group nix_group
+        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
+        check_group(windows_group)
+      end
+
+      # Checks if the current platform is part of the {darwin_group} and returns that class
+      # 
+      # @return [Class]
+      def darwin?
+        check_group(darwin_group)
       end
 
       # Checks a list of possible operating system classes to see if their target os strings match the {target_os} value
@@ -95,16 +63,14 @@ module Mario
       # @return [Class]
       def check_group(group)
         group.each do |klass|
-          return klass if check klass
+          return klass if check(klass)
         end
         false
       end
 
-      alias_method :osx?, :darwin?
-
       # Uses the forced class target os string if provided otherwise uses the target_os rbconfig hash element
       #
-      # @return [String]
+        # @return [String]
       def target_os
         @@forced ? @@forced.target : Config::CONFIG['target_os']
       end
@@ -122,7 +88,7 @@ module Mario
         @@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)
+Mario::Platform.target_os will now report as '#{target_os}' and #{klass} will be used for all functionality including operating system checks, platform blocks, and hat based functionality
 msg
       end
       
@@ -148,19 +114,33 @@ msg
       def current
         # Search for the current target os
         current_target_klass = check_group(targets)
+        unless current_target_klass
+          raise OperatingSystemNotRecognized.new(<<-msg)
+
+The current target os #{target_os}, is not recognized by Mario, please use/change Mario::Platform.forced to emulate a supported operating system."
+
+msg
+        end
         @@current ||= current_target_klass.new
         @@current
       end
+
+      def klass_to_method(klass)
+        klass.to_s.downcase.split('::').last
+      end
+      
+      def check_symbol(name)
+        send(name.to_s + '?')
+      end
     end
 
-    # Any additional fucniontality and they should be moved to a lib/platforms/<OS>.rb
+    # NOTE Any additional functionality and they should be moved to a lib/platforms/<OS>.rb
     class Cygwin
       include Hats::Nix
       
       def self.target
         'cygwin'
       end
-    
     end
 
     class Darwin    
@@ -171,6 +151,24 @@ msg
       end
     end
 
+    class Leopard < Darwin
+      def self.target
+        super + "9"
+      end
+    end
+
+    class Tiger < Darwin
+      def self.target
+        super + "8"
+      end
+    end
+
+    class SnowLeopard < Darwin
+      def self.target
+        super + "10"
+      end
+    end
+
     class Linux
       include Hats::Nix
 
@@ -195,7 +193,6 @@ msg
       end
     end
 
-
     class Windows7
       include Hats::Windows
 
@@ -211,5 +208,13 @@ msg
         'mswin'
       end
     end
+
+    targets.each do |klass|
+      define_class_method(klass_to_method(klass) + '?') do
+        check(klass)
+      end
+    end
+
+    class OperatingSystemNotRecognized < Exception; end
   end
 end

data/lib/mario/tools.rb

@@ -0,0 +1,43 @@
+module Mario
+  module Tools
+    @@method_blocks = {}
+    @@defer_method_definition = false
+        
+    def defer_method_definition
+      @@defer_method_definition
+    end    
+    
+    def defer_method_definition=(val)
+      @@defer_method_definition=val
+    end
+    
+    def defer_method_definition!
+      @@defer_method_definition=true
+    end
+
+    module_function :defer_method_definition, :defer_method_definition=, :defer_method_definition!
+  
+    def platform(name, method=nil, &block)
+      @@method_blocks[name] = method ? [ method , block ] : block
+      define_platform_methods! if !defer_method_definition
+    end
+    
+    def platform_value_map(map={})
+      map.each do |key, value|
+        return value if Platform.check_symbol(key)
+      end
+    end
+    
+    def define_platform_methods!
+      @@method_blocks.each do |name, value|
+        if Platform.check_symbol(name)
+          if value.is_a?(Proc)
+            self.class_eval &value 
+          else
+            define_method value.first, &value.last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mario/util/object.rb

@@ -0,0 +1,7 @@
+# Courtesy of Jay Fields and
+# http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
+class Object # :nodoc
+  def define_class_method(name, &blk)
+    (class << self; self; end).instance_eval { define_method name, &blk }
+  end
+end

data/mario.gemspec

@@ -5,33 +5,36 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mario}
-  s.version = "0.0.6"
+  s.version = "0.1.0"
 
   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.date = %q{2010-04-15}
   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"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "lib/mario.rb",
      "lib/mario/hats/nix.rb",
      "lib/mario/hats/windows.rb",
      "lib/mario/platform.rb",
+     "lib/mario/tools.rb",
+     "lib/mario/util/object.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_plaform.rb",
+     "test/mario/test_tools.rb"
   ]
   s.homepage = %q{http://github.com/johnbender/mario}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -42,7 +45,8 @@ Gem::Specification.new do |s|
     "test/helper.rb",
      "test/mario/hats/test_nix.rb",
      "test/mario/hats/test_windows.rb",
-     "test/mario/test_plaform.rb"
+     "test/mario/test_plaform.rb",
+     "test/mario/test_tools.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/helper.rb

@@ -22,5 +22,3 @@ class Test::Unit::TestCase
     logger.stubs(:warn)
   end
 end
-
-    

data/test/mario/test_plaform.rb

@@ -1,3 +1,4 @@
+
 require 'helper'
 
 class TestPlatform < Test::Unit::TestCase
@@ -100,6 +101,40 @@ class TestPlatform < Test::Unit::TestCase
         assert !Mario::Platform.check_group([mock_os_klass, mock_os_klass])
       end
     end
+    
+    context "darwin versions" do
+      should "return true for a given darwin version when the os target string is darwin plus a number" do
+        target_postfix_darwin(10.0)
+        assert Mario::Platform.snowleopard?
+        target_postfix_darwin(9.0)
+        assert Mario::Platform.leopard?
+        target_postfix_darwin(8.0)
+        assert Mario::Platform.tiger?
+      end
+
+      should "return true for darwin if any of the darwin group classes are the current platform" do
+        Mario::Platform.darwin_group.each do |klass|
+          Mario::Platform.forced = klass
+          assert Mario::Platform.darwin?
+        end
+      end
+    end
+
+    context "checking via symbols" do
+      should "call the symbol with a question mark prefix method" do
+        Mario::Platform.expects(:windows?)
+        Mario::Platform.check_symbol(:windows)
+      end
+    end
+
+    context "operating system is not reconized" do
+      should "raise an exception" do
+        Mario::Platform.expects(:check_group).returns(false)
+        assert_raise Mario::Platform::OperatingSystemNotRecognized do
+          Mario::Platform.current
+        end
+      end
+    end
   end
 
   def check_nix(force)
@@ -121,4 +156,8 @@ class TestPlatform < Test::Unit::TestCase
     mock.stubs(:target).returns(str)
     mock
   end
+  
+  def target_postfix_darwin(with)
+    Mario::Platform.expects(:target_os).returns("darwin#{with}")
+  end
 end

data/test/mario/test_tools.rb

@@ -0,0 +1,103 @@
+require 'helper'
+
+class MockClass
+  extend Mario::Tools
+end
+
+class AlternateMockClass
+  extend Mario::Tools
+end
+
+class TestTools < Test::Unit::TestCase
+  context "Mario tools" do
+    setup do
+      Mario::Platform.forced = Mario::Platform::Windows7
+      Mario::Tools.defer_method_definition = false
+    end
+
+    context "platform specific instance methods" do
+      setup do
+        MockClass.platform :windows do
+          def foo
+            true
+          end
+        end
+
+        MockClass.platform :nix do
+          def bar
+            true
+          end
+        end
+      end
+
+      should "be defined correctly for the platform" do
+        assert_method :foo
+      end
+
+      should "not be defined for other platforms" do
+        assert_no_method :bar
+      end
+    end
+
+    context "platform specific instance methods from blocks" do
+      setup do
+        MockClass.platform(:windows, :baz) { true }
+        MockClass.platform(:nix, :bak) {}
+      end
+
+      should "be defined correctly for the platform" do
+        assert_method :baz
+      end
+
+      should "not be defined for other platforms" do
+        assert_no_method :bak
+      end
+      
+      should "not define methods on seperate classes" do
+        MockClass.platform(:windows, :fik) { true }
+        assert_raise NoMethodError do
+          AlternateMockClass.new.fik
+        end
+      end
+    end
+
+    context "deferred addition of methods" do
+      setup do
+        Mario::Tools.defer_method_definition!
+      end
+
+      should "prevent addition of methods until explicitly requested" do
+        MockClass.platform(:windows, :fiz) {}
+        assert_no_method :fiz
+      end
+
+      should "add methods when called explicitly" do
+        MockClass.platform(:windows, :faz) { true }
+        assert_no_method :faz
+        MockClass.define_platform_methods!
+        assert_method :faz
+      end
+
+    end
+
+    context "platform value maps" do
+      should "return the value associated with the given platform" do
+        map = { :windows => true, :nix => false }
+        Mario::Platform.forced = Mario::Platform::Windows7
+        assert MockClass.platform_value_map(map)
+        Mario::Platform.forced = Mario::Platform::Darwin
+        assert !MockClass.platform_value_map(map)
+      end
+    end
+  end
+
+  def assert_method(method)
+    assert MockClass.new.send(method)
+  end
+
+  def assert_no_method(method)
+    assert_raise NoMethodError do
+      MockClass.new.send(method)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mario
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - John Bender
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-20 00:00:00 -07:00
+date: 2010-04-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,23 +40,26 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/mario.rb
 - lib/mario/hats/nix.rb
 - lib/mario/hats/windows.rb
 - lib/mario/platform.rb
+- lib/mario/tools.rb
+- lib/mario/util/object.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_tools.rb
 has_rdoc: true
 homepage: http://github.com/johnbender/mario
 licenses: []
@@ -90,3 +93,4 @@ test_files:
 - test/mario/hats/test_nix.rb
 - test/mario/hats/test_windows.rb
 - test/mario/test_plaform.rb
+- test/mario/test_tools.rb

data/README.rdoc

@@ -1,15 +0,0 @@
-= mario
-
-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.
-
-== Copyright
-
-Copyright (c) 2010 John Bender. See LICENSE for details.