remix 0.4.7-i386-mingw32 → 0.4.8-i386-mingw32

data/CHANGELOG

@@ -1,3 +1,7 @@
+15/11/2010 version 0.4.8
+* all extend-based methods now return self
+* added documentation on blocks (@yield)
+* threadsafe temp_* methods now return value of block
 12/11/2010 version 0.4.6
 * fixed segfault in replace_module when trying to replace root module
 12/11/2010 version 0.4.5

data/lib/remix.rb

@@ -20,6 +20,7 @@ rescue LoadError => e
 end
 
 module Kernel
+
   # Define a `singleton_class` method for the 1.8 kids
   # @return [Class] The singleton class of the receiver
   def singleton_class
@@ -32,6 +33,7 @@ module Remix
   # Wraps a block of code so that `before` and `after` lambdas are invoked
   # prior to and after the block.
   # @return [Object] The return value of the block
+  # @yield the block to wrap
   def self.wrap_with_hooks(before, after, &block)
     before.call if before
     yield
@@ -44,6 +46,8 @@ module Remix
     # Temporarily extends a module for the duration of a block.
     # Module will be unextended at end of block.
     # @param [Module] mod Module to be temporarily extended
+    # @return [Object] The value of the block
+    # @yield The block that will acquire the functionality.
     # @example
     #   module M
     #     def hello
@@ -53,7 +57,7 @@ module Remix
     #   
     #   o = Object.new
     #   o.temp_extend(M) do
-    #     puts hello #=> "hello"
+    #     puts o.hello #=> "hello"
     #   end
     #   
     #   o.hello #=> NoMethodError
@@ -71,7 +75,11 @@ module Remix
     # Temporarily extends a module for the duration of a block in a
     # thread-safe manner.
     # Module will be unextended at end of block.
+    # **DO NOT** wait on other threads in this block as it will result
+    # in deadlock. `Thread.exclusive` is used.
     # @param [Module] mod Module to be temporarily extended
+    # @return [Object] The value of the block
+    # @yield The block that will acquire the functionality.
     def temp_extend_safe(mod, options={}, &block)
       safe_code = proc do
         Remix.wrap_with_hooks(options[:before], options[:after]) do
@@ -85,74 +93,101 @@ module Remix
       end
       
       if !Thread.current[:__exclusive__]
-        Thread.exclusive { Thread.current[:__exclusive__] = true; safe_code.call }
-        Thread.current[:__exclusive__] = false
+        value = nil
+        
+        Thread.exclusive do
+          Thread.current[:__exclusive__] = true
+          value = safe_code.call
+          Thread.current[:__exclusive__] = false
+        end
+
+        value
       else
         safe_code.call
       end
     end
 
     # Like `include_at()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#include_at
     def extend_at(index, mod)
       singleton_class.include_at(index, mod)
+      self
     end
 
     # Like `include_below()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#include_below
     def extend_below(mod1, mod2)
       singleton_class.include_below(mod1, mod2)
+      self
     end
     alias_method :extend_before, :extend_below
 
     # Like `include_above()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#include_above
     def extend_above(mod1, mod2)
       singleton_class.include_above(mod1, mod2)
+      self
     end
     alias_method :extend_after, :extend_above
 
     # Like `uninclude()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#uninclude
     def unextend(mod, recurse = false)
       singleton_class.uninclude(mod, recurse)
+      self
     end
     alias_method :remove_extended_module, :unextend
 
     # Like `include_at_top()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#include_at_top
     def extend_at_top(mod)
       singleton_class.include_at_top(mod)
+      self
     end
 
     # Like `swap_modules()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#swap_modules
     def swap_extended_modules(mod1, mod2)
       singleton_class.swap_modules(mod1, mod2)
+      self
     end
 
     # Like `module_move_up()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#module_move_up
     def extended_module_move_up(mod)
       singleton_class.module_move_up(mod)
+      self
     end
     
     # Like `module_move_down()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#module_move_down
     def extended_module_move_down(mod)
       singleton_class.module_move_down(mod)
+      self
     end
 
     # Like `replace_module()` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#replace_module
     def replace_extended_module(mod1, mod2)
       singleton_class.replace_module(mod1, mod2)
+      self
     end
 
     # Like `ready_remix()` on `Module` but for the singleton class
+    # @return [Object] The receiver
     # @see Remix::ModuleExtensions#ready_remix
     def ready_remix()
       singleton_class.ready_remix
+      self
     end
   end
 
@@ -161,6 +196,8 @@ module Remix
     # Temporarily includes a module for the duration of a block.
     # Module will be unincluded at end of block.
     # @param [Module] mod Module to be temporarily included
+    # @return [Object] The value of the block
+    # @yield The block that will acquire the functionality.
     # @example
     #   module M
     #     def hello
@@ -187,7 +224,11 @@ module Remix
     # Temporarily includes a module for the duration of a block in a
     # thread-safe manner.
     # Module will be unincluded at end of block.
+    # *DO NOT* wait on other threads in this block as it will result
+    # in deadlock. `Thread.exclusive` is used.
     # @param [Module] mod Module to be temporarily included
+    # @return [Object] The value of the block
+    # @yield The block that will acquire the functionality.
     def temp_include_safe(mod, options={}, &block)
       safe_code = proc do
         Remix.wrap_with_hooks(options[:before], options[:after]) do
@@ -201,8 +242,15 @@ module Remix
       end
       
       if !Thread.current[:__exclusive__]
-        Thread.exclusive { Thread.current[:__exclusive__] = true; safe_code.call }
-        Thread.current[:__exclusive__] = false
+        value = nil
+        
+        Thread.exclusive do
+          Thread.current[:__exclusive__] = true
+          value = safe_code.call 
+          Thread.current[:__exclusive__] = false
+        end
+        
+        value
       else
         safe_code.call
       end

data/lib/remix/version.rb

@@ -1,4 +1,4 @@
 module Remix
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: remix
 version: !ruby/object:Gem::Version 
-  hash: 1
   prerelease: false
   segments: 
   - 0
   - 4
-  - 7
-  version: 0.4.7
+  - 8
+  version: 0.4.8
 platform: i386-mingw32
 authors: 
 - John Mair (banisterfiend)
@@ -55,7 +54,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -64,7 +62,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"