otaku 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/HISTORY.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 2010-07-18
+
+first gem release! [#ngty]
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 NgTzeYang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,96 @@
+= OTAKU
+
+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 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.
+
+== Getting Started
+
+It's hosted on rubygems.org:
+
+  $ sudo gem install otaku
+
+== Using It
+
+=== 1. Starting service & defining handler
+
+  require 'otaku'
+
+  Otaku.start do |data|
+    result = '~ %s ~' % data
+  end
+
+=== 2. Sending processing request
+
+  require 'otaku'
+
+  Otaku.process('hello')
+  # >> '~ hello ~'
+
+=== Unfortunately ...
+
+Most of the times, we won't have anything as simple as above, the following illustrates the problem of contextual reference:
+
+  mark = '*'
+  Otaku.start do |data|
+    '%s %s %s' % [mark, data, mark]
+  end
+
+  Otaku.process('hello') # failure !!
+
+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:
+
+  Otaku.start(:mark => '*') do |data|
+    '%s %s %s' % [mark, data, mark]
+  end
+
+  Otaku.process('hello') # >> '* hello *'
+
+== Configuraing It
+
+Otaku ships with the following defaults:
+
+  Otaku.address         # >> '127.0.0.1'
+  Otaku.port            # >> 10999
+  Otaku.init_wait_time  # >> 2
+  Otaku.log_file        # >> '/tmp/otaku.log'
+
+Configuring can be done via:
+
+=== 1. Configuration Proc
+
+  Otaku.configure do |config|
+    config.init_wait_time = 10
+    # (more typing, more customizing)
+  end
+
+=== 2. Configuration Hash
+
+  Otaku.configure({
+    :init_wait_time => 10
+    # (more typing, more customizing)
+  })
+
+=== 3. Writer Method
+
+  Otaku.init_wait_time = 10
+
+== TODO
+
+1. Currently, only integration testing is done ...
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) since 2010 NgTzeYang. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "otaku"
+    gem.summary = %Q{Dead simple server/client service built using eventmachine}
+    gem.description = %Q{}
+    gem.email = "ngty77@gmail.com"
+    gem.homepage = "http://github.com/ngty/otaku"
+    gem.authors = ["NgTzeYang"]
+    gem.add_development_dependency "bacon", ">= 0"
+    gem.add_dependency "eventmachine", ">= 0.12.10"
+    gem.add_dependency "ruby2ruby", ">= 1.2.4"
+    # TODO: Should eventually remove requirement for ParseTree !!
+    gem.add_dependency "ParseTree", ">= 3.0.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |spec|
+    spec.libs << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "otaku #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/otaku.rb

@@ -0,0 +1,235 @@
+require 'rubygems'
+require 'eventmachine'
+require 'logger'
+require 'base64'
+require 'ruby2ruby'
+
+# TODO: Preliminary try, should be removed eventually !! Should use RubyParser instead.
+require 'parse_tree'
+require 'parse_tree_extensions'
+
+module Otaku
+
+  class HandlerNotDefinedError < Exception ; end
+  class DataProcessError < Exception ; end
+
+  # //////////////////////////////////////////////////////////////////////////////////////////
+  # Otaku
+  # //////////////////////////////////////////////////////////////////////////////////////////
+
+  DEFAULTS = {
+    :address => '127.0.0.1',
+    :port => 10999,
+    :log_file => '/tmp/otaku.log',
+    :init_wait_time => 2
+  }
+
+  class << self
+
+    attr_accessor *DEFAULTS.keys
+
+    def configure(config = {}, &block)
+      block_given? ? yield(self) :
+        config.each{|name, val| send(:"#{name}=", val) }
+    end
+
+    def config
+      DEFAULTS.keys.inject({}) do |memo, name|
+        memo.merge(name => send(name))
+      end
+    end
+
+    def start(context = {}, &handler)
+      raise HandlerNotDefinedError unless block_given?
+      Server.handler = Handler.new(context, handler)
+      Server.start
+    end
+
+    def stop
+      Server.stop
+    end
+
+    def process(data)
+      Client.get(data)
+    end
+
+    Otaku.configure(DEFAULTS)
+
+  end
+
+  # //////////////////////////////////////////////////////////////////////////////////////////
+  # Otaku::Encoder
+  # //////////////////////////////////////////////////////////////////////////////////////////
+
+  module Encoder
+    class << self
+
+      def encode(thing)
+        Base64.encode64(Marshal.dump(thing))
+      end
+
+      def decode(thing)
+        Marshal.load(Base64.decode64(thing))
+      end
+
+    end
+  end
+
+  # //////////////////////////////////////////////////////////////////////////////////////////
+  # Otaku::Handler
+  # //////////////////////////////////////////////////////////////////////////////////////////
+
+  class Handler
+
+    def initialize(context, handler)
+      @context = __context_as_code__(context)
+      @proc = __proc_as_code__(handler)
+    end
+
+    def [](data)
+      eval(@context).instance_exec(data, &eval(@proc))
+    end
+
+    private
+
+      def __proc_as_code__(block)
+        Ruby2Ruby.new.process(block.to_sexp)
+      end
+
+      def __context_as_code__(methods_hash)
+        'Class.new{ %s }.new' %
+          methods_hash.map do |method, val|
+            "def #{method}; Encoder.decode(%|#{Encoder.encode(val).gsub('|','\|')}|); end"
+          end.join('; ')
+      end
+
+  end
+
+  # //////////////////////////////////////////////////////////////////////////////////////////
+  # Otaku::Server
+  # //////////////////////////////////////////////////////////////////////////////////////////
+
+  module Server
+
+    class << self
+
+      attr_accessor :handler
+
+      def start(other_process=false)
+        other_process ? run_evented_server : (
+          # print '[Otaku] initializing at %s:%s ... ' % [Otaku.address, Otaku.port] # DBUG
+          run_server_script
+          # puts 'done [pid#%s]' % @process.pid # DEBUG
+        )
+      end
+
+      def run_evented_server
+        log 'started with pid #%s' % Process.pid,
+          'listening at %s:%s' % [Otaku.address, Otaku.port]
+        EventMachine::run { EventMachine::start_server(Otaku.address, Otaku.port, EM) }
+      end
+
+      def run_server_script
+        args = Encoder.encode({
+          :config => Otaku.config,
+          :handler => @handler
+        })
+        @process = IO.popen(%|ruby #{__FILE__} "#{args.gsub('"','\"')}"|,'r')
+        sleep Otaku.init_wait_time
+      end
+
+      def stop
+        Process.kill('SIGHUP', @process.pid) if @process
+      end
+
+      def log(*msgs)
+        @logger ||= Logger.new(Otaku.log_file)
+        msgs.each{|msg| @logger << "[Otaku] %s\n" % msg }
+      end
+
+      def cleanup
+        @logger.close
+      end
+
+    end
+
+    private
+
+      module EM #:nodoc:
+
+        def receive_data(data)
+          log 'receives data: %s' % data.inspect
+          result = process_data(data)
+          log 'returning result: %s' % result.inspect
+          send_data(Encoder.encode(result))
+        end
+
+        def process_data(data)
+          begin
+            Server.handler[data]
+          rescue
+            error = DataProcessError.new($!.inspect)
+            log(error.inspect)
+            error
+          end
+        end
+
+        def log(*msg)
+          Server.log(*msg)
+        end
+
+      end
+
+  end
+
+  # //////////////////////////////////////////////////////////////////////////////////////////
+  # Otaku::Client
+  # //////////////////////////////////////////////////////////////////////////////////////////
+
+  module Client
+
+    class << self
+      def get(data)
+        EventMachine::run do
+          EventMachine::connect(Otaku.address, Otaku.port, EM).
+            execute(data) do |data|
+              @result = Encoder.decode(data)
+            end
+        end
+        @result
+      end
+    end
+
+    private
+
+      module EM #:nodoc:
+
+        def receive_data(data)
+          result = @callback.call(data)
+          result.is_a?(DataProcessError) ? raise(result) : result
+          EventMachine::stop_event_loop # ends loop & resumes program flow
+        end
+
+        def execute(method, &callback)
+          @callback = callback
+          send_data(method)
+        end
+
+      end
+
+  end
+end
+
+if $0 == __FILE__ && (encoded_data = ARGV[0])
+  begin
+    include Otaku
+    data = Encoder.decode(encoded_data)
+    Otaku.configure(data[:config])
+    Server.handler = data[:handler]
+    Server.start(true)
+  rescue
+    Server.log($!.inspect)
+  ensure
+    Server.cleanup
+  end
+end

data/spec/processing_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Otaku doing processing" do
+
+  after do
+    Otaku.stop
+  end
+
+  should 'succeed when using proc that has no contextual reference' do
+    Otaku.start{|data| '~ %s ~' % data }
+    Otaku.process('hello').should.equal '~ hello ~'
+  end
+
+  should 'fail when using proc that has contextual reference yet has no specified context' 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 when using proc that has contextual reference & has context specified' do
+    Otaku.start(:mark => '*') {|data| '%s %s %s' % [mark, data, mark] }
+    Otaku.process('hello').should.equal('* hello *')
+  end
+
+  should 'raise Otaku::HandlerNotDefinedError when processing wo specified proc' do
+    lambda { Otaku.start }.should.raise(Otaku::HandlerNotDefinedError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bacon'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'otaku'
+
+Bacon.summary_on_exit

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: otaku
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- NgTzeYang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-18 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 12
+        - 10
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 3
+        - 0
+        - 5
+        version: 3.0.5
+  type: :runtime
+  version_requirements: *id004
+description: ""
+email: ngty77@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- HISTORY.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/otaku.rb
+- spec/processing_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ngty/otaku
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Dead simple server/client service built using eventmachine
+test_files: 
+- spec/processing_spec.rb
+- spec/spec_helper.rb