adaptation 0.0.2 → 0.0.3

data/lib/breakpoint_client.rb

@@ -0,0 +1,196 @@
+require 'breakpoint'
+require 'optparse'
+require 'timeout'
+
+Options = {
+  :ClientURI  => nil,
+  :ServerURI  => "druby://localhost:42531",
+  :RetryDelay => 2,
+  :Permanent  => true,
+  :Verbose    => false
+}
+
+ARGV.options do |opts|
+  script_name = File.basename($0)
+  opts.banner = [
+    "Usage: ruby #{script_name} [Options] [server uri]",
+    "",
+    "This tool lets you connect to a breakpoint service ",
+    "which was started via Breakpoint.activate_drb.",
+    "",
+    "The server uri defaults to druby://localhost:42531"
+  ].join("\n")
+
+  opts.separator ""
+
+  opts.on("-c", "--client-uri=uri",
+    "Run the client on the specified uri.",
+    "This can be used to specify the port",
+    "that the client uses to allow for back",
+    "connections from the server.",
+    "Default: Find a good URI automatically.",
+    "Example: -c druby://localhost:12345"
+  ) { |v| Options[:ClientURI] = v }
+
+  opts.on("-s", "--server-uri=uri",
+    "Connect to the server specified at the",
+    "specified uri.",
+    "Default: druby://localhost:42531"
+  ) { |v| Options[:ServerURI] = v }
+
+  opts.on("-R", "--retry-delay=delay", Integer,
+    "Automatically try to reconnect to the",
+    "server after delay seconds when the",
+    "connection failed or timed out.",
+    "A value of 0 disables automatical",
+    "reconnecting completely.",
+    "Default: 10"
+  ) { |v| Options[:RetryDelay] = v }
+
+  opts.on("-P", "--[no-]permanent",
+    "Run the breakpoint client in permanent mode.",
+    "This means that the client will keep continue",
+    "running even after the server has closed the",
+    "connection. Useful for example in Rails."
+  ) { |v| Options[:Permanent] = v }
+
+  opts.on("-V", "--[no-]verbose",
+    "Run the breakpoint client in verbose mode.",
+    "Will produce more messages, for example between",
+    "individual breakpoints. This might help in seeing",
+    "that the breakpoint client is still alive, but adds",
+    "quite a bit of clutter."
+  ) { |v| Options[:Verbose] = v }
+
+  opts.separator ""
+
+  opts.on("-h", "--help",
+    "Show this help message."
+  ) { puts opts; exit }
+  opts.on("-v", "--version",
+    "Display the version information."
+  ) do
+    id = %q$Id: breakpoint_client.rb 91 2005-02-04 22:34:08Z flgr $
+    puts id.sub("Id: ", "")
+    puts "(Breakpoint::Version = #{Breakpoint::Version})"
+    exit
+  end
+
+  opts.parse!
+end
+
+Options[:ServerURI] = ARGV[0] if ARGV[0]
+
+module Handlers #:nodoc:
+  extend self
+
+  def breakpoint_handler(workspace, message)
+    puts message
+    IRB.start(nil, nil, workspace)
+
+    puts ""
+    if Options[:Verbose] then
+      puts "Resumed execution. Waiting for next breakpoint...", ""
+    end
+  end
+
+  def eval_handler(code)
+    result = eval(code, TOPLEVEL_BINDING)
+    if result then
+      DRbObject.new(result)
+    else
+      result
+    end
+  end
+
+  def collision_handler()
+    msg = [
+      "  *** Breakpoint service collision ***",
+      "  Another Breakpoint service tried to use the",
+      "  port already occupied by this one. It will",
+      "  keep waiting until this Breakpoint service",
+      "  is shut down.",
+      "  ",
+      "  If you are using the Breakpoint library for",
+      "  debugging a Rails or other CGI application",
+      "  this likely means that this Breakpoint",
+      "  session belongs to an earlier, outdated",
+      "  request and should be shut down via 'exit'."
+    ].join("\n")
+
+    if RUBY_PLATFORM["win"] then
+      # This sucks. Sorry, I'm not doing this because
+      # I like funky message boxes -- I need to do this
+      # because on Windows I have no way of displaying
+      # my notification via puts() when gets() is still
+      # being performed on STDIN. I have not found a
+      # better solution.
+      begin
+        require 'tk'
+        root = TkRoot.new { withdraw }
+        Tk.messageBox('message' => msg, 'type' => 'ok')
+        root.destroy
+      rescue Exception
+        puts "", msg, ""
+      end
+    else
+      puts "", msg, ""
+    end
+  end
+end
+
+# Used for checking whether we are currently in the reconnecting loop.
+reconnecting = false
+
+loop do
+  DRb.start_service(Options[:ClientURI])
+
+  begin
+    service = DRbObject.new(nil, Options[:ServerURI])
+
+    begin
+      ehandler = Handlers.method(:eval_handler)
+      chandler = Handlers.method(:collision_handler)
+      handler = Handlers.method(:breakpoint_handler)
+      service.eval_handler = ehandler
+      service.collision_handler = chandler
+      service.handler = handler
+
+      reconnecting = false
+      if Options[:Verbose] then
+        puts "Connection established. Waiting for breakpoint...", ""
+      end
+
+      loop do
+        begin
+          service.ping
+        rescue DRb::DRbConnError => error
+          puts "Server exited. Closing connection...", ""
+          exit! unless Options[:Permanent]
+          break
+        end
+
+        sleep(0.5)
+      end
+    ensure
+      service.eval_handler = nil
+      service.collision_handler = nil
+      service.handler = nil
+    end
+  rescue Exception => error
+    if Options[:RetryDelay] > 0 then
+      if not reconnecting then
+        reconnecting = true
+        puts "No connection to breakpoint service at #{Options[:ServerURI]} " +
+           "(#{error.class})"
+        puts error.backtrace if $DEBUG
+        puts "Tries to connect will be made every #{Options[:RetryDelay]} seconds..."
+      end
+
+      sleep Options[:RetryDelay]
+      retry
+    else
+      raise
+    end
+  end
+end

data/lib/commands/breakpointer.rb

@@ -0,0 +1 @@
+require 'breakpoint_client'

data/lib/commands/subscribe.rb

@@ -1,11 +1,25 @@
 require 'adaptation'
-require 'adaptation/oapdaemon'
 
-config = YAML::load(File.open("config/mom.yml"))
-mom_uri = "druby://#{config["mom"]["host"]}:#{config["mom"]["port"]}"
-subscriber_uri = "druby://#{config["subscriber"]["host"]}:#{config["subscriber"]["port"]}"
-topics = config["subscriber"]["topics"].split(' ')
+environment = "development" # TODO: "un-hardcode" this
+config = YAML::load(File.open("config/mom.yml"))["development"]
 
-oapdaemon = Adaptation::Oapdaemon.new subscriber_uri, mom_uri, topics
-oapdaemon.start
+case config["mom"]["type"]
+  when "druby"
+    require 'adaptation/druby_subscriber'
+
+    mom_uri = "druby://#{config["mom"]["host"]}:#{config["mom"]["port"]}"
+    subscriber_uri = "druby://#{config["subscriber"]["host"]}:#{config["subscriber"]["port"]}"
+    topics = config["subscriber"]["topics"].split(' ')
+    
+    Signal.trap("INT") { puts "Shutting down subscriber (#{config["mom"]["type"]})"; exit }
+
+    oapdaemon = Adaptation::Mom::DrubySubscriber.new subscriber_uri, mom_uri, topics
+    oapdaemon.start
+
+  #when "xmlblaster"
+    #
+
+  else
+    puts "Unknown MOM server type: #{config["mom"]["type"]}"
+end
 

data/lib/commands/subscribe.rb~

@@ -0,0 +1,25 @@
+require 'adaptation'
+
+environment = "development" # TODO: "un-hardcode" this
+config = YAML::load(File.open("config/mom.yml"))["development"]
+
+case config["mom"]["type"]
+  when "druby"
+    require 'adaptation/druby_subscriber'
+
+    mom_uri = "druby://#{config["mom"]["host"]}:#{config["mom"]["port"]}"
+    subscriber_uri = "druby://#{config["subscriber"]["host"]}:#{config["subscriber"]["port"]}"
+    topics = config["subscriber"]["topics"].split(' ')
+    
+    Signal.trap("INT") { puts "Shutting down subscriber (#{config["mom"]["type"]})"; exit }
+
+    oapdaemon = Adaptation::Mom::DrubySubscriber.new subscriber_uri, mom_uri, topics
+    oapdaemon.start
+
+  #when "xmlblaster"
+    #
+
+  else
+    puts "Unknown MOM server type: #{config["mom"]["type"]}"
+end
+

data/lib/rails_generator/generators/applications/app/app_generator.rb

@@ -43,6 +43,9 @@ class AppGenerator < Rails::Generator::Base
       # mom.yml
       m.template "configs/mom.yml", "config/mom.yml"
 
+      # settings.yml
+      m.template "configs/settings.yml", "config/settings.yml"
+
       # boot.rb, needed by some scripts
       m.file "configs/boot.rb", "config/boot.rb"
 
@@ -54,7 +57,7 @@ class AppGenerator < Rails::Generator::Base
       #m.file "environments/test.rb",        "config/environments/test.rb"
 
       # Scripts
-      %w( mom generate destroy about subscribe ).each do |file|
+      %w( generate destroy about subscribe breakpointer ).each do |file|
         m.file "bin/#{file}", "script/#{file}", script_options
       end
 

data/lib/rails_generator/generators/applications/app/app_generator.rb~

@@ -0,0 +1,136 @@
+require 'rbconfig'
+
+class AppGenerator < Rails::Generator::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  DATABASES = %w(mysql oracle postgresql sqlite2 sqlite3 frontbase)
+
+  default_options   :db => "mysql", :shebang => DEFAULT_SHEBANG, :freeze => false
+  mandatory_options :source => "#{File.dirname(__FILE__)}/../../../../.."
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    usage("Databases supported for preconfiguration are: #{DATABASES.join(", ")}") if (options[:db] && !DATABASES.include?(options[:db]))
+    @destination_root = args.shift
+    @app_name = File.basename(File.expand_path(@destination_root))
+  end
+
+  def manifest
+    # Use /usr/bin/env if no special shebang was specified
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+    dispatcher_options = { :chmod => 0755, :shebang => options[:shebang] }
+
+    record do |m|
+      # Root directory and all subdirectories.
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Root
+      m.file "README", "README"
+
+      # Application
+      m.file "helpers/test_helper.rb", "test/test_helper.rb"
+      m.file "helpers/publish.rb", "test/mocks/test/publish.rb"
+
+      # database.yml 
+      m.template "configs/databases/#{options[:db]}.yml", "config/database.yml", :assigns => {
+        :app_name => @app_name,
+        :socket   => options[:db] == "mysql" ? mysql_socket_location : nil
+      }
+
+      # mom.yml
+      m.template "configs/mom.yml", "config/mom.yml"
+
+      # settings.yml
+      m.template "configs/settings.yml", "config/settings.yml"
+
+      # boot.rb, needed by some scripts
+      m.file "configs/boot.rb", "config/boot.rb"
+
+      # Environments
+      #m.file "environments/boot.rb",    "config/boot.rb"
+      #m.template "environments/environment.rb", "config/environment.rb", :assigns => { :freeze => options[:freeze] }
+      #m.file "environments/production.rb",  "config/environments/production.rb"
+      #m.file "environments/development.rb", "config/environments/development.rb"
+      #m.file "environments/test.rb",        "config/environments/test.rb"
+
+      # Scripts
+      %w( generate destroy about subscribe ).each do |file|
+        m.file "bin/#{file}", "script/#{file}", script_options
+      end
+
+      # Dispatches
+      m.file "dispatches/dispatch.rb", "public/dispatch.rb", script_options
+      m.file "dispatches/publish.rb", "public/publish.rb", script_options
+
+      # Docs
+      m.file "doc/README_FOR_APP", "doc/README_FOR_APP"
+
+      # Logs
+      %w(server production development test).each { |file|
+        m.file "configs/empty.log", "log/#{file}.log", :chmod => 0666
+      }
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} /path/to/your/app [options]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("-r", "--ruby=path", String,
+             "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
+             "Default: #{DEFAULT_SHEBANG}") { |v| options[:shebang] = v }
+
+      opt.on("-d", "--database=name", String,
+            "Preconfigure for selected database (options: mysql/oracle/postgresql/sqlite2/sqlite3).",
+            "Default: mysql") { |v| options[:db] = v }
+
+      #opt.on("-f", "--freeze",
+      #      "Freeze Rails in vendor/rails from the gems generating the skeleton",
+      #      "Default: false") { |v| options[:freeze] = v }
+    end
+
+    def mysql_socket_location
+      MYSQL_SOCKET_LOCATIONS.find { |f| File.exists?(f) } unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
+    end
+
+
+  # Installation skeleton.  Intermediate directories are automatically
+  # created so don't sweat their absence here.
+  BASEDIRS = %w(
+    app/adaptors
+    app/messages
+    app/models
+    config/environments
+    db
+    doc
+    lib
+    lib/tasks
+    log
+    public
+    script
+    test/fixtures
+    test/functional
+    test/mocks/development
+    test/mocks/test
+    test/unit
+  )
+
+  MYSQL_SOCKET_LOCATIONS = [
+    "/tmp/mysql.sock",                        # default
+    "/var/run/mysqld/mysqld.sock",            # debian/gentoo
+    "/var/tmp/mysql.sock",                    # freebsd
+    "/var/lib/mysql/mysql.sock",              # fedora
+    "/opt/local/lib/mysql/mysql.sock",        # fedora
+    "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
+    "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
+    "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
+    "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
+  ]
+end

data/lib/rails_generator/generators/components/adaptor/templates/functional_test.rb

@@ -3,7 +3,7 @@ require '<%= file_path %>_adaptor'
 
 class <%= class_name %>AdaptorTest < Test::Unit::TestCase
 
-  fixtures :<%= table_name %>
+  #fixtures :your_table_name_here
 
   def setup
     @adaptor = <%= class_name %>Adaptor.new

data/lib/rails_generator/generators/components/message/templates/unit_test.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
 
 class <%= class_name %>Test < Test::Unit::TestCase
-  fixtures :<%= file_name %>
 
   # Replace this with your real tests.
   def test_truth

metadata

@@ -1,9 +1,9 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
+rubygems_version: 0.9.2
 specification_version: 1
 name: adaptation
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 date: 2007-04-30 00:00:00 +02:00
 summary: Framework to facilitate web-application interaction.
 require_paths: 
@@ -15,7 +15,7 @@ description: Adaptation is a framework for building "adaptors" for web-applicati
 autorequire: adaptation
 default_executable: adaptation
 bindir: bin
-has_rdoc: true
+has_rdoc: false
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -29,76 +29,88 @@ post_install_message:
 authors: 
 - Xavi Vila Morell
 files: 
+- bin/generate
 - bin/destroy
 - bin/adaptation
 - bin/about
-- bin/subscribe
+- bin/breakpointer
+- bin/mom~
 - bin/mom
-- bin/generate
-- lib/commands
-- lib/adaptation
+- bin/subscribe
 - lib/rails_generator.rb
+- lib/adaptation
+- lib/binding_of_caller.rb
+- lib/breakpoint_client.rb
+- lib/adaptation.rb
 - lib/commands.rb
+- lib/breakpoint.rb
+- lib/commands
 - lib/ruby_version_check.rb
-- lib/adaptation.rb
 - lib/rails_generator
-- lib/commands/about.rb
-- lib/commands/mom.rb
-- lib/commands/destroy.rb
-- lib/commands/generate.rb
-- lib/commands/subscribe.rb
 - lib/adaptation/version.rb
-- lib/adaptation/base.rb
+- lib/adaptation/mom.rb~
 - lib/adaptation/message.rb
-- lib/adaptation/mom.rb
 - lib/adaptation/adaptor.rb
-- lib/adaptation/oapdaemon.rb
+- lib/adaptation/druby_subscriber.rb
+- lib/adaptation/druby_subscriber.rb~
+- lib/adaptation/mom.rb
 - lib/adaptation/test
+- lib/adaptation/oapdaemon.rb~
+- lib/adaptation/base.rb
 - lib/adaptation/test/test_help.rb
-- lib/rails_generator/scripts
-- lib/rails_generator/base.rb
+- lib/commands/mom.rb.descartat
+- lib/commands/subscribe.rb~
+- lib/commands/destroy.rb
+- lib/commands/subscribe.rb
+- lib/commands/about.rb
+- lib/commands/breakpointer.rb
+- lib/commands/generate.rb
 - lib/rails_generator/lookup.rb
+- lib/rails_generator/generators
 - lib/rails_generator/commands.rb
-- lib/rails_generator/simple_logger.rb
 - lib/rails_generator/scripts.rb
-- lib/rails_generator/manifest.rb
-- lib/rails_generator/generated_attribute.rb
+- lib/rails_generator/simple_logger.rb
 - lib/rails_generator/options.rb
-- lib/rails_generator/generators
 - lib/rails_generator/spec.rb
-- lib/rails_generator/scripts/destroy.rb
-- lib/rails_generator/scripts/generate.rb
-- lib/rails_generator/scripts/update.rb
+- lib/rails_generator/manifest.rb
+- lib/rails_generator/scripts
+- lib/rails_generator/generated_attribute.rb
+- lib/rails_generator/base.rb
 - lib/rails_generator/generators/components
 - lib/rails_generator/generators/applications
 - lib/rails_generator/generators/components/model
-- lib/rails_generator/generators/components/message
 - lib/rails_generator/generators/components/adaptor
+- lib/rails_generator/generators/components/message
 - lib/rails_generator/generators/components/model/USAGE
 - lib/rails_generator/generators/components/model/model_generator.rb
 - lib/rails_generator/generators/components/model/templates
 - lib/rails_generator/generators/components/model/templates/unit_test.rb
-- lib/rails_generator/generators/components/model/templates/migration.rb
-- lib/rails_generator/generators/components/model/templates/model.rb
 - lib/rails_generator/generators/components/model/templates/fixtures.yml
-- lib/rails_generator/generators/components/message/message_generator.rb
-- lib/rails_generator/generators/components/message/USAGE
-- lib/rails_generator/generators/components/message/templates
-- lib/rails_generator/generators/components/message/templates/unit_test.rb
-- lib/rails_generator/generators/components/message/templates/message.rb
-- lib/rails_generator/generators/components/message/templates/fixtures.xml
+- lib/rails_generator/generators/components/model/templates/model.rb
+- lib/rails_generator/generators/components/model/templates/migration.rb
 - lib/rails_generator/generators/components/adaptor/USAGE
 - lib/rails_generator/generators/components/adaptor/adaptor_generator.rb
 - lib/rails_generator/generators/components/adaptor/templates
-- lib/rails_generator/generators/components/adaptor/templates/functional_test.rb
 - lib/rails_generator/generators/components/adaptor/templates/adaptor.rb
+- lib/rails_generator/generators/components/adaptor/templates/functional_test.rb
+- lib/rails_generator/generators/components/message/USAGE
+- lib/rails_generator/generators/components/message/message_generator.rb
+- lib/rails_generator/generators/components/message/templates
+- lib/rails_generator/generators/components/message/templates/message.rb
+- lib/rails_generator/generators/components/message/templates/unit_test.rb
+- lib/rails_generator/generators/components/message/templates/fixtures.xml
 - lib/rails_generator/generators/applications/app
 - lib/rails_generator/generators/applications/app/USAGE
+- lib/rails_generator/generators/applications/app/app_generator.rb~
 - lib/rails_generator/generators/applications/app/app_generator.rb
-- helpers/test_helper.rb
+- lib/rails_generator/scripts/destroy.rb
+- lib/rails_generator/scripts/update.rb
+- lib/rails_generator/scripts/generate.rb
 - helpers/publish.rb
+- helpers/test_helper.rb
 - doc/README_FOR_APP
 - configs/databases
+- configs/settings.yml
 - configs/empty.log
 - configs/boot.rb
 - configs/mom.yml
@@ -117,6 +129,7 @@ extra_rdoc_files:
 - README
 executables: 
 - adaptation
+- mom
 extensions: []
 
 requirements: []

data/lib/adaptation/oapdaemon.rb

@@ -1,38 +0,0 @@
-require 'drb'
-require 'yaml'
-
-module Adaptation
-
-  class Oapdaemon
-
-    def initialize subscriber_uri, mom_uri, topics
-      @subscriber_uri = subscriber_uri
-      @mom_uri = mom_uri
-      @topics = topics
-    end
-
-    def call_adaptor message, topic
-      if ( (@topics.include?(topic)) or (@topics == "all") )
-        system("ruby public/dispatch.rb #{message}") 
-      end
-      puts "#{topic} => #{message}"
-    end
-
-    def subscription_result subscribed
-      if subscribed
-        puts "Subscribed to mom (#{@mom_uri}). Listening at #{@subscriber_uri}"
-      end
-    end
-
-    def start
-      DRb.start_service(@subscriber_uri, self)
-
-      mom = DRbObject.new(nil, @mom_uri)
-      mom.subscribe @subscriber_uri
-
-      DRb.thread.join # Don't exit just yet!
-    end
-
-  end
-
-end