mario 0.1.0 → 0.1.1

data/README.md

@@ -1,8 +1,7 @@
 mario
 =====
 
-Mario is super small library with only two standard library dependencies to help you figure out what platform you're on. 
-
+Mario is super small library to help you with getting from platform to platform with ease!
 
 platform
 --------
@@ -22,6 +21,99 @@ If for some reason you opperating system isn't represented please alert me and/o
 
     Mario::Platform.forced = Mario::Platform::Linux
 
+
+targeted methods
+----------------
+In version 0.1 of Mario, the ability to define platform specific instance method implementations has been added via the class method `platform`. All you have to do is extend your class with `Mario::Tools`. 
+
+    class MyClass
+      extend Mario::Tools
+  
+      platform :windows do
+        def foo
+          "I will only work for Windows!"
+        end
+      end
+
+      platform :linux do
+        def foo
+          "I will only work for Linux!"
+        end
+      end
+    end
+
+    Mario::Platform.forced = Mario::Platform::Windows7
+    MyClass.new.foo # => "I will only work for Windows!"
+
+    Mario::Platform.forced = Mario::Platform::Linux
+    MyClass.new.foo # => "I will only work for Linux!"
+    
+Alternatively, if you don't need the flexibility of actual method definitions or multiple methods, you can do the following:
+
+    class MyClass
+      extend Mario::Tools
+
+      platform :windows, :foo do |param|
+        "This is my param on Windows: #{param}"
+      end
+      
+      platform :linux, :foo do |param|
+        "This is my param on Linux: #{param}"
+      end
+    end
+    
+
+platform value maps
+-------------------
+Sometimes you don't need an actual method and you just want to define a platform spefic value for something. With Mario you can do the following:
+
+    class MyClass
+      extend Mario::Tools
+      attr_accessor :my_ivar
+
+      def initialize
+        @my_ivar = platform_value_map { :windows => 'Windows!', :linux => 'Linux!' }
+      end
+    end
+
+    Mario::Platform.forced = Mario::Platform::Windows7
+    MyClass.new.my_ivar # => 'Windows!'
+
+    Mario::Platform.forced = Mario::Platform::Linux
+    MyClass.new.my_ivar # => 'Linux!'
+
+platform symbol values
+----------------------
+Any class defined in Mario::Platform.targets can be used as symbol for `platform` and `platform_value_map` to target a given platform. The following are supported as of version 0.1
+
+    >> Mario::Platform.targets.map{ |t| Mario::Platform.klass_to_method(t).to_sym }
+    => [:cygwin, :linux, :bsd, :solaris, :tiger, :leopard, :snowleopard, :darwin, :windows7, :windowsnt]
+
+testing
+-------
+When testing your app you'll want to force the platform that mario reports to test your platform specific methods. In order to accomplish this make sure to defer the method definition done by the `platform` class method in the following manner.
+
+    Mario::Tools.defer_method_definition!
+    require 'my_class'
+
+This will allow you to force the platform and THEN define the methods on your classes manually so that you can test them for various platforms.
+
+    Mario::Platform.forced = Mario::Platform::Windows7
+    MyClass.define_platform_methods!
+    MyClass.new.foo # => "Windows!"
+
+The blocks are stored so that `define_platform_methods!` can be called many times after forcing the platform to provide different results.
+
+    Mario::Platform.forced = Mario::Platform::Windows7
+    MyClass.define_platform_methods!
+    MyClass.new.foo # => "Windows!"
+
+    Mario::Platform.forced = Mario::Platform::Linux
+    MyClass.define_platform_methods!
+    MyClass.new.foo # => "Linux!"
+
+*IMPORTANT* The above does NOT apply to `platform_value_map`, if you want the above functionality its best to assign the values from functions defined in the above manner
+
 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:

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mario/tools.rb

@@ -1,6 +1,6 @@
 module Mario
   module Tools
-    @@method_blocks = {}
+    @@class_method_blocks = {}
     @@defer_method_definition = false
         
     def defer_method_definition
@@ -18,8 +18,9 @@ module Mario
     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
+      @@class_method_blocks[self] ||= {}
+      @@class_method_blocks[self][name] = method ? [ method , block ] : block
+      define_platform_methods! unless defer_method_definition
     end
     
     def platform_value_map(map={})
@@ -29,7 +30,7 @@ module Mario
     end
     
     def define_platform_methods!
-      @@method_blocks.each do |name, value|
+      @@class_method_blocks[self].each do |name, value|
         if Platform.check_symbol(name)
           if value.is_a?(Proc)
             self.class_eval &value 

data/mario.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mario}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Bender"]
-  s.date = %q{2010-04-15}
+  s.date = %q{2010-04-16}
   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 = [

data/test/mario/test_tools.rb

@@ -59,6 +59,27 @@ class TestTools < Test::Unit::TestCase
           AlternateMockClass.new.fik
         end
       end
+
+      should "not define methods on seperate classes from different platforms" do
+        # Note requires new classes for testing this particular case
+        class MyClass
+          extend Mario::Tools
+          platform :windows, :foo do
+            puts "foo"
+          end
+        end
+        
+        class MyClass2
+          extend Mario::Tools
+          platform :darwin, :foo do
+            puts "foo"
+          end
+        end
+
+        assert_raise NoMethodError do
+          MyClass2.new.foo
+        end
+      end
     end
 
     context "deferred addition of methods" do
@@ -78,6 +99,17 @@ class TestTools < Test::Unit::TestCase
         assert_method :faz
       end
 
+      should "overwrite previous methods via blocks" do
+        MockClass.platform(:windows, :fink) { true }
+        MockClass.platform(:linux, :fink) { false }
+        assert_overwritten(:fink)
+      end
+      
+      should "overwrite previous methods" do
+        MockClass.platform(:windows) { def fizzle; true; end }
+        MockClass.platform(:linux) { def fizzle; false; end }
+        assert_overwritten(:fizzle)
+      end
     end
 
     context "platform value maps" do
@@ -100,4 +132,13 @@ class TestTools < Test::Unit::TestCase
       MockClass.new.send(method)
     end
   end
+
+  def assert_overwritten(method)
+    Mario::Platform.forced = Mario::Platform::Windows7
+    MockClass.define_platform_methods!
+    assert MockClass.new.send(method)
+    Mario::Platform.forced = Mario::Platform::Linux
+    MockClass.define_platform_methods!
+    assert !MockClass.new.send(method)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mario
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - John Bender
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-15 00:00:00 -07:00
+date: 2010-04-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency