lspace 0.1 → 0.2

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -19,7 +19,7 @@ class DatabaseConnection
   end
 
   def self.use_master(&block)
-    LSpace.update(:preferred_connection => master_connection) do
+    LSpace.with(:preferred_connection => master_connection) do
       block.call
     end
   end
@@ -69,11 +69,11 @@ class Fetcher
 end
 
 EM::run do
-  LSpace.update(:log_prefix => rand(50000)) do
+  LSpace.with(:log_prefix => rand(50000)) do
     Fetcher.new.fetch("http://www.google.com")
     Fetcher.new.fetch("http://www.yahoo.com")
   end
-  LSpace.update(:log_prefix => rand(50000)) do
+  LSpace.with(:log_prefix => rand(50000)) do
     Fetcher.new.fetch("http://www.microsoft.com")
   end
 end

data/lib/lspace/class_methods.rb

@@ -19,13 +19,14 @@ class LSpace
     enter new({}, nil), &block
   end
 
-  # Create a new LSpace with the given keys set to the given values.
+  # Create a new LSpace with the given keys set to the given values, and run the
+  # given block in that new LSpace.
   #
   # The LSpace will inherit any unspecified keys from the currently active LSpace.
   #
   # @example
-  #   LSpace.update :user_id => 6 do
-  #     LSpace.update :job_id => 7 do
+  #   LSpace.with :user_id => 6 do
+  #     LSpace.with :job_id => 7 do
   #       LSpace[:user_id] == 6
   #       LSpace[:job_id] == 7
   #     end
@@ -34,7 +35,7 @@ class LSpace
   # @param [Hash] hash  The keys to update
   # @param [Proc] block  The logical block to run with the updated LSpace
   # @see LSpace.enter
-  def self.update(hash={}, &block)
+  def self.with(hash={}, &block)
     enter new(hash, current), &block
   end
 
@@ -66,7 +67,7 @@ class LSpace
     previous = current
     self.current = lspace
 
-    filters = lspace.hierarchy.take_while{ |lspace| lspace != previous }.map(&:around_filters).flatten
+    filters = lspace.hierarchy.take_while{ |lspace| lspace != previous }.flat_map(&:around_filters)
 
     filters.inject(block) do |blk, filter|
       lambda{ filter.call(&blk) }

data/lib/lspace/core_ext.rb

@@ -15,7 +15,7 @@ class Module
   #   LSpace[:user_id] = 6
   #   Job.new.user == #<User:6>
   #
-  # @param [Symbol] *attrs The accessors to create
+  # @param [Symbol] attrs The accessors to create
   def lspace_reader(*attrs)
     attrs.each do |attr|
       define_method(attr) do
@@ -29,7 +29,7 @@ class Module
   # This wraps both the &block parameter, and also any Procs
   # that are passed into the function directly.
   #
-  # If you need more complicated logic (i.e. wrapping Procs
+  # If you need more complicated logic (e.g. wrapping Procs
   # that are passed to a function in a dictionary) you're
   # on your own.
   #
@@ -42,17 +42,20 @@ class Module
   #     Thread.new{ LSpace[:user_id] == 2 }
   #   end
   #
-  # @param [Symbol] *methods  The methods to wrap
+  # @param [Symbol] methods  The methods to wrap
   def in_lspace(*methods)
     methods.each do |method|
       method_without_lspace = "#{method}_without_lspace"
+
+      # Idempotence: do nothing if the _without_lspace method already exists.
+      # method_defined? matches public and protected methods; private methods need a separate check.
       next if method_defined?(method_without_lspace) || private_method_defined?(method_without_lspace)
 
       alias_method method_without_lspace, method
 
       define_method(method) do |*args, &block|
         args.map!{ |a| Proc === a ? a.in_lspace : a }
-        block = block && block.in_lspace
+        block = block.in_lspace if block
         __send__(method_without_lspace, *args, &block)
       end
 
@@ -63,7 +66,8 @@ class Module
 end
 
 class Proc
-  # Preserve LSpace when this Proc is run.
+  # Preserve LSpace when this Proc is run. Returns a new Proc, a closure that
+  # re-enters the current LSpace when it is called.
   #
   # @example
   #   todo = LSpace.new :user_id => 2 do

data/lib/lspace/eventmachine.rb

@@ -1,5 +1,8 @@
 require 'eventmachine'
 require 'lspace'
+
+# Optional module to make EventMachine preserve LSpaces in its event callbacks. Not loaded by
+# default; you must +require 'lspace/eventmachine'+ to use it.
 module EventMachine
 
   # Most of the low-level EventMachine stuff goes through singleton methods on the
@@ -20,7 +23,7 @@ module EventMachine
   class Connection
 
     class << self
-      # As EM uses a custom implementation of {new}, the only sane way to
+      # As EM uses a custom implementation of new, the only sane way to
       # set up the LSpace in advance is to override allocate.
       alias_method :allocate_without_lspace, :allocate
     end
@@ -28,11 +31,11 @@ module EventMachine
     # Overridden allocate which sets up a new LSpace.
     #
     # Each connection object is run in its own LSpace, which can be
-    # configured by implementing the {setup_lspace} method.
+    # configured by implementing the {Connection#setup_lspace} method.
     def self.allocate
       allocate_without_lspace.instance_eval do
         extend EventMachine::LSpacePreserver
-        LSpace.update do
+        LSpace.with do
           setup_lspace
           @lspace = LSpace.current
         end

data/lib/lspace.rb

@@ -5,7 +5,7 @@ require File.expand_path('../lspace/class_methods', __FILE__)
 # application's purpose, but still necessary.
 #
 # In many ways they are the successor to the Thread-local namespace, but they are designed
-# to be active during a logical segment of code no-matter how you slice that code amoungst
+# to be active during a logical segment of code, no matter how you slice that code amongst
 # different Threads or Fibers.
 #
 # The API for LSpace encourages creating a new sub-LSpace whenever you want to mutate the
@@ -15,7 +15,7 @@ require File.expand_path('../lspace/class_methods', __FILE__)
 #
 # @example
 #   require 'lspace/thread'
-#   LSpace.update(:job_id => 1) do
+#   LSpace.with(:job_id => 1) do
 #     Thread.new do
 #       puts "processing #{LSpace[:job_id]}"
 #     end.join
@@ -47,8 +47,8 @@ class LSpace
   # of parent LSpaces. If the key is not found anywhere, nil is returned.
   #
   # @example
-  #   LSpace.update :user_id => 5 do
-  #     LSpace.update :user_id => 6 do
+  #   LSpace.with :user_id => 5 do
+  #     LSpace.with :user_id => 6 do
   #       LSpace[:user_id] == 6
   #     end
   #   end
@@ -65,7 +65,7 @@ class LSpace
   # Update the LSpace-variable with the given name.
   #
   # Bear in mind that any code using this LSpace will see this change, and consider
-  # using {LSpace.update} instead to localize your changes.
+  # using {LSpace.with} instead to localize your changes.
   #
   # This method is mostly useful for setting up a new LSpace before any code is
   # using it, and has no effect on parent LSpaces.
@@ -116,7 +116,7 @@ class LSpace
     LSpace.enter(self, &block)
   end
 
-  # Ensure that the Proc runs in this LSpace
+  # Wraps a block/proc such that it runs in this LSpace when it is called.
   #
   # @see Proc#in_lspace
   # @see LSpace.preserve

data/lspace.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "lspace"
-  s.version = "0.1"
+  s.version = "0.2"
   s.platform = Gem::Platform::RUBY
   s.author = "Conrad Irwin"
   s.email = "conrad.irwin@gmail.com"
@@ -12,5 +12,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'pry-rescue'
+  s.add_development_dependency 'pry-stack_explorer'
   s.add_development_dependency 'eventmachine'
 end

data/spec/class_method_spec.rb

@@ -18,16 +18,16 @@ describe LSpace do
     end
   end
 
-  describe ".update" do
+  describe ".with" do
     it "should enter a new LSpace with the new variables set" do
-      LSpace.update(:foo => 5) do
+      LSpace.with(:foo => 5) do
         LSpace[:foo].should == 5
       end
     end
 
     it "should enter a new LSpace which delegates to the current parent" do
-      LSpace.update(:foo => 5) do
-        LSpace.update(:bar => 4) do
+      LSpace.with(:foo => 5) do
+        LSpace.with(:bar => 4) do
           LSpace[:foo].should == 5
         end
       end
@@ -36,7 +36,7 @@ describe LSpace do
 
   describe ".clean" do
     it "should enter a new LSpace with no parent" do
-      LSpace.update(:foo => 5) do
+      LSpace.with(:foo => 5) do
         LSpace.clean do
           LSpace[:foo].should == nil
         end
@@ -45,7 +45,7 @@ describe LSpace do
   end
 
   describe ".enter" do
-    it "should update LSpace.current" do
+    it "should with LSpace.current" do
       LSpace.enter(@lspace) do
         LSpace.current.should == @lspace
       end

data/spec/core_ext_spec.rb

@@ -5,7 +5,7 @@ describe Module do
     it "should define a reader for LSpace" do
       klass = Class.new{ lspace_reader :user_id }
 
-      LSpace.update(:user_id => 8) do
+      LSpace.with(:user_id => 8) do
         klass.new.user_id.should == 8
       end
     end
@@ -40,7 +40,7 @@ describe Module do
     end
 
     it "should automatically preserve LSpace for blocks that are passed in" do
-      @task = LSpace.update :user_id => 6 do
+      @task = LSpace.with :user_id => 6 do
                 @klass.new{ LSpace[:user_id] }
               end
 
@@ -48,7 +48,7 @@ describe Module do
     end
 
     it "should automatically preserve LSpace for procs that are passed in" do
-      @task = LSpace.update :user_id => 6 do
+      @task = LSpace.with :user_id => 6 do
                 @klass.new proc{ LSpace[:user_id] }
               end
 
@@ -59,13 +59,22 @@ describe Module do
       @klass.private_method_defined?(:private_test).should == true
       @klass.protected_method_defined?(:protected_test).should == true
     end
+
+    it "should be idempotent" do
+      @klass.in_lspace :initialize
+
+      LSpace.with :user_id => 9 do
+        @task = @klass.new{ LSpace[:user_id] }
+      end
+      @task.call.should == 9
+    end
   end
 end
 
 describe Proc do
   describe "#in_lspace" do
     it "should create a wrapper which preserves the LSpace" do
-      p = LSpace.update(:job_id => 19) do
+      p = LSpace.with(:job_id => 19) do
            lambda{ LSpace[:job_id] }.in_lspace
           end
 

data/spec/eventmachine_spec.rb

@@ -8,7 +8,7 @@ describe LSpace do
 
     it "should preserve LSpace in deferrable callbacks" do
       d = Class.new{ include EM::Deferrable }.new
-      LSpace.update(:foo => 2) do
+      LSpace.with(:foo => 2) do
         d.callback do
           $foo = LSpace[:foo]
         end
@@ -19,7 +19,7 @@ describe LSpace do
 
     it "should preserve LSpace in deferrable errbacks" do
       d = Class.new{ include EM::Deferrable }.new
-      LSpace.update(:foo => 2) do
+      LSpace.with(:foo => 2) do
         d.errback do
           $foo = LSpace[:foo]
         end
@@ -30,7 +30,7 @@ describe LSpace do
 
     it "should preserve LSpace in EM::defer operation" do
       EM::run do
-        LSpace.update(:foo => 4) do
+        LSpace.with(:foo => 4) do
           EM::defer(lambda{
             $foo = LSpace[:foo]
           }, proc{
@@ -43,7 +43,7 @@ describe LSpace do
 
     it "should preserve LSpace in EM::defer callback" do
       EM::run do
-        LSpace.update(:foo => 4) do
+        LSpace.with(:foo => 4) do
           EM::defer(lambda{
             nil
           }, proc{
@@ -58,7 +58,7 @@ describe LSpace do
     it "should preserve LSpace in EM.next_tick" do
       EM::run do
         EM::next_tick do
-          LSpace.update :foo => 5 do
+          LSpace.with :foo => 5 do
             EM::next_tick do
               $foo = LSpace[:foo]
               EM::stop
@@ -117,7 +117,7 @@ describe LSpace do
         end
       end
 
-      LSpace.update(:bar => :baz) do
+      LSpace.with(:bar => :baz) do
         EM::run do
           EM::start_server '0.0.0.0', 9345, server
           EM::connect '127.0.0.1', 9345, client

data/spec/lspace_spec.rb

@@ -124,6 +124,7 @@ describe LSpace do
     end
 
     it "should revert the changed LSpace at the end of the block" do
+      LSpace.current.should_not == @lspace
       lspace = LSpace.current
       @lspace.wrap{ LSpace.current.should == @lspace }.call
       LSpace.current.should == lspace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lspace
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +81,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
 - LICENSE.MIT
 - README.md
 - lib/lspace.rb