otaku 0.3.0 → 0.4.0

data/HISTORY.txt

@@ -1,3 +1,9 @@
+=== 0.4.0 2010-09-15
+
+= Features
+* Use SerializableProc instead of handrolled MagicProc & friends, thus doing away
+  with the awkward need for explicitely passing in contextual references [#ngty]
+
 === 0.3.0 2010-08-05
 
 = Features

data/README.rdoc

@@ -5,7 +5,7 @@ Dead simple server/client service built using eventmachine.
 == Introduction
 
 Otaku's original intent is to support testing of cross-process stubbing in
-cross-stub (http://github.com/ngty/cross-stub). It's usefulness in other
+CrossStub (http://github.com/ngty/cross-stub). It's usefulness in other
 aspects of my hacking life prompts me to extract it out, & package it as a
 generic solution. Its primary intent is to be dead simple to use & easy to
 customize, of course, both criteria subjected to very my own tastes.
@@ -14,7 +14,7 @@ customize, of course, both criteria subjected to very my own tastes.
 
 It's hosted on rubygems.org:
 
-  $ sudo gem install otaku
+  $ gem install otaku
 
 == Using It
 
@@ -33,32 +33,29 @@ It's hosted on rubygems.org:
   Otaku.process('hello')
   # >> '~ hello ~'
 
-=== Unfortunately ...
+=== Wait a minute, how abt contextual references ??
 
-Most of the times, we won't have anything as simple as above, the following
-illustrates the problem of contextual reference:
+Previously, when there is references to local variables outside the proc, we need
+to start Otaku in a very awkward manner:
 
-  mark = '*'
-  Otaku.start do |data|
+  Otaku.start(:mark => '*') do |data|
     '%s %s %s' % [mark, data, mark]
   end
 
-  Otaku.process('hello') # failure !!
+  Otaku.process('hello')
+  # >> '* hello *'
 
-The reason is that the proc that we passed to Otaku.start is being marshalled
-while being passed to the server as a handler, in the process, the contextual
-references are lost. A workaround for this problem is:
+This is no longer needed from release-0.4.0 onwards, thanks to the help with
+SerializableProc (http://github.com/ngty/serializable_proc), contextual references
+to global, class, instance & local variables are automatically taken care of:
 
-  Otaku.start(:mark => '*') do |data|
-    '%s %s %s' % [mark, data, mark]
+  x, @x, @@x, $x = 'lx', 'ix', 'cx', 'gx'
+  Otaku.start do |data|
+    [x, @x, @@x, $x].join(data)
   end
 
-  Otaku.process('hello') # >> '* hello *'
-
-Anything that can be marshalled can be passed as a context. The exception is
-proc, which cannot be marshalled, yet it can still be passed in. However, in
-the process, all contextual references within the proc are lost, so u may
-want to exercise care when playing with proc.
+  Otaku.process(' & ')
+  # >> 'lx & ix & cx & gx'
 
 == Configuraing It
 
@@ -90,10 +87,6 @@ Configuring can be done via:
 
   Otaku.init_wait_time = 10
 
-== TODO
-
-1. Currently, only integration testing is done ...
-
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/Rakefile

@@ -4,6 +4,7 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
     gem.name = "otaku"
     gem.summary = %Q{Dead simple service framework built on eventmachine}
     gem.description = %Q{}
@@ -12,9 +13,7 @@ begin
     gem.authors = ["NgTzeYang"]
     gem.add_development_dependency "bacon", ">= 0"
     gem.add_dependency "eventmachine", ">= 0.12.10"
-    gem.add_dependency "ruby2ruby", ">= 1.2.4"
-    gem.add_dependency "ruby_parser", ">= 2.0.4"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency "serializable_proc", ">= 0.4.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/otaku.rb

@@ -3,8 +3,7 @@ require 'forwardable'
 require 'eventmachine'
 require 'logger'
 require 'base64'
-require 'ruby2ruby'
-require 'ruby_parser'
+require 'serializable_proc'
 
 require 'otaku/encoder'
 require 'otaku/handler'
@@ -21,7 +20,7 @@ module Otaku
     :address => '127.0.0.1',
     :port => 10999,
     :log_file => '/tmp/otaku.log',
-    :init_wait_time => 2 * (RUBY_PLATFORM =~ /java/i ? 3 : 1)
+    :init_wait_time => 2 * (RUBY_PLATFORM =~ /java/i ? 5 : 1)
   }
 
   class << self
@@ -43,9 +42,9 @@ module Otaku
       File.expand_path(File.dirname(__FILE__))
     end
 
-    def start(context = {}, &handler)
+    def start(&handler)
       raise HandlerNotDefinedError unless block_given?
-      Server.handler = Handler.new(context, handler)
+      Server.handler = Handler.new(handler)
       Server.start
     end
 

data/lib/otaku/handler.rb

@@ -1,32 +1,30 @@
-require 'otaku/handler/magic_proc'
-require 'otaku/handler/context'
-require 'otaku/handler/processor'
-
 module Otaku
   class Handler
 
-    attr_reader :context, :processor
-
-    def initialize(context, handler)
-      @context = Context.new(context)
-      @processor = Processor.new(handler)
+    def initialize(handler)
+      @proc = SerializableProc.new(&handler)
     end
 
     def process(data)
-      @context.eval!.instance_exec(data, &@processor.eval!)
+      @proc.call(data)
     end
 
     def root
-      File.dirname(@processor.file)
+      @proc.file
     end
 
     def marshal_dump
-      [@context, @processor]
+      @proc
     end
 
     def marshal_load(data)
-      @context, @processor = data
+      @proc = data
     end
 
   end
+
+  class ::SerializableProc
+    attr_reader :file
+  end
+
 end

data/otaku.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{otaku}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["NgTzeYang"]
-  s.date = %q{2010-08-05}
+  s.date = %q{2010-09-15}
   s.description = %q{}
   s.email = %q{ngty77@gmail.com}
   s.extra_rdoc_files = [
@@ -28,12 +28,8 @@ Gem::Specification.new do |s|
      "lib/otaku/client.rb",
      "lib/otaku/encoder.rb",
      "lib/otaku/handler.rb",
-     "lib/otaku/handler/context.rb",
-     "lib/otaku/handler/magic_proc.rb",
-     "lib/otaku/handler/processor.rb",
      "lib/otaku/server.rb",
      "otaku.gemspec",
-     "spec/handler_spec.rb",
      "spec/integration_spec.rb",
      "spec/spec_helper.rb"
   ]
@@ -44,7 +40,6 @@ Gem::Specification.new do |s|
   s.summary = %q{Dead simple service framework built on eventmachine}
   s.test_files = [
     "spec/integration_spec.rb",
-     "spec/handler_spec.rb",
      "spec/spec_helper.rb",
      "examples/unittest/client.rb",
      "examples/unittest/tests/b_test.rb",
@@ -60,19 +55,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<bacon>, [">= 0"])
       s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
-      s.add_runtime_dependency(%q<ruby2ruby>, [">= 1.2.4"])
-      s.add_runtime_dependency(%q<ruby_parser>, [">= 2.0.4"])
+      s.add_runtime_dependency(%q<serializable_proc>, [">= 0.4.0"])
     else
       s.add_dependency(%q<bacon>, [">= 0"])
       s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
-      s.add_dependency(%q<ruby2ruby>, [">= 1.2.4"])
-      s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
+      s.add_dependency(%q<serializable_proc>, [">= 0.4.0"])
     end
   else
     s.add_dependency(%q<bacon>, [">= 0"])
     s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
-    s.add_dependency(%q<ruby2ruby>, [">= 1.2.4"])
-    s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
+    s.add_dependency(%q<serializable_proc>, [">= 0.4.0"])
   end
 end
 

data/spec/integration_spec.rb

@@ -25,40 +25,35 @@ describe "Otaku Service" do
       Otaku.process('hello').should.equal '~ hello ~'
     end
 
-    should 'raise Otaku::DataProcessError w proc that has contextual reference yet has no specified context' do
+    should 'succeed w proc that has contextual reference' do
       mark = '*'
-      Otaku.start{|data| '%s %s %s' % [mark, data, mark] }
-      lambda { Otaku.process('hello') }.should.raise(Otaku::DataProcessError).
-        message.should.match(/#<NameError: undefined local variable or method `mark' for /)
-    end
-
-    should 'succeed w proc that has non-proc contextual reference & has context specified' do
-      Otaku.start(:mark => '*') {|data| '%s %s %s' % [mark, data, mark] }
-      Otaku.process('hello').should.equal('* hello *')
-    end
-
-    should 'succeed w proc that has proc contextual reference & has context specified' do
-      Otaku.start(:mark => lambda { '*' }) {|data| '%s %s %s' % [mark.call, data, mark.call] }
+      Otaku.start {|data| '%s %s %s' % [mark, data, mark] }
       Otaku.process('hello').should.equal('* hello *')
     end
 
     should 'reflect __FILE__ as captured when declaring proc' do
-      Otaku.start{|data| __FILE__ }
-      Otaku.process(:watever_data).should.equal(File.expand_path(__FILE__))
+      Otaku.start {|data| __FILE__ }
+      Otaku.process(:watever_data).should.equal(__FILE__)
     end
 
     should 'reflect __LINE__ as captured when declaring proc' do
       Otaku.start{|data| __LINE__ }
-      Otaku.process(:watever_data).should.equal(__LINE__.pred)
+      Otaku.process(:watever_data).should.equal(__LINE__ - 1)
     end
 
     should 'have $LOAD_PATH include Otaku.root' do
-      Otaku.start{|data| $LOAD_PATH }
+      Otaku.start do |data|
+        @@_not_isolated_vars = :global
+        $LOAD_PATH
+      end
       Otaku.process(:watever_data).should.include(Otaku.root)
     end
 
     should 'have $LOAD_PATH include Otaku::Server#handler.root' do
-      Otaku.start{|data| $LOAD_PATH }
+      Otaku.start do |data|
+        @@_not_isolated_vars = :global
+        $LOAD_PATH
+      end
       Otaku.process(:watever_data).should.include(Otaku::Server.handler.root)
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: otaku
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - NgTzeYang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-05 00:00:00 +08:00
+date: 2010-09-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,37 +49,21 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: ruby2ruby
+  name: serializable_proc
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 15
         segments: 
-        - 1
-        - 2
-        - 4
-        version: 1.2.4
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ruby_parser
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
         - 0
         - 4
-        version: 2.0.4
+        - 0
+        version: 0.4.0
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id003
 description: ""
 email: ngty77@gmail.com
 executables: []
@@ -101,12 +85,8 @@ files:
 - lib/otaku/client.rb
 - lib/otaku/encoder.rb
 - lib/otaku/handler.rb
-- lib/otaku/handler/context.rb
-- lib/otaku/handler/magic_proc.rb
-- lib/otaku/handler/processor.rb
 - lib/otaku/server.rb
 - otaku.gemspec
-- spec/handler_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - examples/unittest/client.rb
@@ -150,7 +130,6 @@ specification_version: 3
 summary: Dead simple service framework built on eventmachine
 test_files: 
 - spec/integration_spec.rb
-- spec/handler_spec.rb
 - spec/spec_helper.rb
 - examples/unittest/client.rb
 - examples/unittest/tests/b_test.rb

data/lib/otaku/handler/context.rb

@@ -1,43 +0,0 @@
-module Otaku
-  class Handler
-    class Context #:nodoc:
-
-      attr_reader :code
-
-      def initialize(methods_hash)
-        @code = 'Class.new{ %s }.new' %
-          methods_hash.map do |method, val|
-            'def %s; %s; end' % [method, method_body(val)]
-          end.sort.join('; ')
-      end
-
-      def eval!
-        eval(@code, nil, '(generated class)', 1)
-      end
-
-      def marshal_dump
-        [@code]
-      end
-
-      def marshal_load(data)
-        @code, _ = data
-      end
-
-      private
-
-        def method_body(val)
-          if val.is_a?(Proc)
-            "Encoder.decode(%|#{Encoder.encode(magic_proc(val)).gsub('|','\|')}|).eval!"
-          else
-            "Encoder.decode(%|#{Encoder.encode(val).gsub('|','\|')}|)"
-          end
-        end
-
-        def magic_proc(block)
-          MagicProc.new(block)
-        end
-
-    end
-  end
-end
-

data/lib/otaku/handler/magic_proc.rb

@@ -1,116 +0,0 @@
-module Otaku
-  class Handler
-    class MagicProc #:nodoc:
-
-      RUBY_PARSER = RubyParser.new
-      RUBY_2_RUBY = Ruby2Ruby.new
-
-      attr_reader :file, :line, :code
-
-      def initialize(block)
-        @cache = {:block => block}
-        extract_file_and_line_and_code
-        @cache = nil
-      end
-
-      def eval!
-        eval(@code, nil, @file, @line)
-      end
-
-      def marshal_dump
-        [@code, @file, @line]
-      end
-
-      def marshal_load(data)
-        @code, @file, @line = data
-      end
-
-      private
-
-        def extract_file_and_line_and_code
-          code, remaining = code_fragments
-
-          while frag = remaining[frag_regexp,1]
-            begin
-              sexp = RUBY_PARSER.parse(replace_magic_vars(code += frag))
-              if sexp.inspect =~ sexp_regexp
-                @code = revert_magic_vars(RUBY_2_RUBY.process(sexp)).sub('proc {','lambda {')
-                break
-              end
-            rescue SyntaxError, Racc::ParseError, NoMethodError
-              remaining.sub!(frag,'')
-            end
-          end
-        end
-
-        def code_fragments
-          ignore, start_marker, arg =
-            [:ignore, :start_marker, :arg].map{|key| code_match_args[key] }
-          [
-            arg ? "proc #{start_marker} |#{arg}|" : "proc #{start_marker}",
-            source_code.sub(ignore, '')
-          ]
-        end
-
-        def sexp_regexp
-          @cache[:sexp_regexp] ||= (
-            Regexp.new([
-              Regexp.quote("s(:iter, s(:call, nil, :"),
-              "(proc|lambda)",
-              Regexp.quote(", s(:arglist)), "),
-              '(%s|%s|%s)' % [
-                Regexp.quote('s(:masgn, s(:array, s('),
-                Regexp.quote('s(:lasgn, :'),
-                Regexp.quote('nil, s(')
-              ]
-            ].join)
-          )
-        end
-
-        def frag_regexp
-          @cache[:frag_regexp] ||= (
-            end_marker = {'do' => 'end', '{' => '\}'}[code_match_args[:start_marker]]
-            /^(.*?\W#{end_marker})/m
-          )
-        end
-
-        def code_regexp
-          @cache[:code_regexp] ||=
-            /^(.*?(lambda|proc|Proc\.new)?\s*(do|\{)\s*(\|(.*?)\|\s*)?)/m
-        end
-
-        def code_match_args
-          @cache[:code_match_args] ||= (
-            args = source_code.match(code_regexp)
-            {
-              :ignore => args[1],
-              :start_marker => args[3],
-              :arg => args[5]
-            }
-          )
-        end
-
-        def source_code
-          @cache[:source_code] ||= (
-            file, line = /^#<Proc:0x[0-9A-Fa-f]+@(.+):(\d+).*?>$/.match(@cache[:block].inspect)[1..2]
-            @file = File.expand_path(file)
-            @line = line.to_i
-            File.readlines(@file)[@line.pred .. -1].join
-          )
-        end
-
-        def replace_magic_vars(code)
-          %w{__FILE__ __LINE__}.inject(code) do |code, var|
-            code.gsub(var, "%|((#{var}))|")
-          end
-        end
-
-        def revert_magic_vars(code)
-          %w{__FILE__ __LINE__}.inject(code) do |code, var|
-            code.gsub(%|"((#{var}))"|, var)
-          end
-        end
-
-    end
-  end
-end