mirahd 0.0.0

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - jruby-18mode
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gem 'mirah'
+
+group :test do
+  gem 'rspec'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bitescript (0.1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3-java)
+    mirah (0.0.11-java)
+      bitescript (>= 0.0.8)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  jeweler
+  mirah
+  rspec

data/README.md

@@ -0,0 +1,94 @@
+mirahd
+======
+
+**mirahd** is a Mirah Daemon listening for your requests to compile something.
+When it receives one it does the job quickly. _Really quickly_.
+
+[![Build Status](https://secure.travis-ci.org/jstepien/mirahd.png?branch=master)](http://travis-ci.org/jstepien/mirahd)
+
+Usage
+-----
+
+We'll need:
+
+  * Bundler,
+  * Mirah, and as a result
+  * JRuby 1.6.
+
+For your own comfort and sanity it is also advisable to install a Ruby
+implementation with a reasonably short start up time. MRI or Rubinius
+are good candidates.
+
+    jruby -S bundle install
+    jruby -S rspec test
+    jruby -rubygems -I lib -S bin/mirahd --daemon
+    ruby -I lib bin/mirahd test/hello.mirah
+
+Rationale
+---------
+
+Mirah is a lovely language but its low compilation speed might be discouraging.
+Using it in development based on a lot of small _code, test, refactor_ cycles
+might be problematic. JVM's start up time and a lag introduced by compilation
+of Mirah's sources by JRuby add up to the sum we see below¹.
+
+    $ time mirahc test/hello.mirah > /dev/null # with disk's cache warmed up
+    18.60user 0.45system 0:11.85elapsed
+
+After the initial warm up JVM and JRuby are pretty fast. The goal of this
+project is to make the JVM start once only and then reuse the existing process
+for all subsequent compilation tasks.
+
+Run the daemon.
+
+    $ jruby -rubygems -I lib -S bin/mirahd --daemon
+
+The first compilation is already quite quick.
+
+    $ time ruby -I lib -S bin/mirahd test/hello.mirah
+    0.05user 0.00system 0:00.89elapsed
+
+Then JVM's JIT comes into play. Here's the tenth compilation.
+
+    $ time ruby -I lib -S bin/mirahd test/hello.mirah
+    0.04user 0.00system 0:00.30elapsed
+
+Todo
+----
+
+  * Security. By being able to access the port DRb is listening on you
+    can `eval` whatever you want to. `$SAFE` won't work as it's unsupported
+    by JRuby.
+  * Enable users to specify the port number.
+  * Write tests covering a server running in a different directory then the
+    client. It won't be possible without spawning 2 separate processes.
+  * Support `--help` et al. command line arguments.
+  * Concurrency. Two compilation requests might interfere with each other,
+    especially due to changing the current working directory.
+
+Copyrights
+----------
+
+Copyright (c) 2012 Jan Stępień
+
+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.
+
+___
+¹ That's a 64-bit OpenJDK 6 on Intel Core 2 Duo with GNU/Linux 3.2.8.

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mirahd"
+  gem.homepage = "https://github.com/jstepien/mirahd"
+  gem.license = "MIT"
+  gem.summary = %Q{Mirah compilation daemon (in dire need of Javanese name)}
+  gem.description = File.read "README.md"
+  gem.email = "jstepien@users.sourceforge.net"
+  gem.authors = ["Jan Stępień"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['test/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/mirahd

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+if ARGV.include? '--daemon'
+  require 'mirahd/server'
+  server = MirahD::Server.new
+  server.start
+  puts 'Ready.' unless ARGV.include? '--quiet'
+  server.wait
+else
+  require 'mirahd/client'
+  begin
+    puts MirahD::Client.new.compile ARGV
+  rescue => ex
+    $stderr.puts ex.message
+    exit 1
+  end
+end

data/lib/mirahd/client.rb

@@ -0,0 +1,12 @@
+require 'drb/drb'
+require 'fileutils'
+
+module MirahD
+  class Client
+    URI = 'druby://localhost:8787'
+
+    def compile args
+      DRbObject.new_with_uri(URI).compile args, FileUtils.pwd
+    end
+  end
+end

data/lib/mirahd/server.rb

@@ -0,0 +1,55 @@
+require 'drb/drb'
+require 'stringio'
+require 'mirah'
+
+module MirahD
+  class Server
+    class Compiler
+      def compile args, dir = FileUtils.pwd
+        intercepting_stdout do
+          FileUtils.cd dir do
+            Mirah::Commands::Compile.new(args).execute
+          end
+        end
+      end
+
+      private
+
+      def intercepting_stdout
+        orig_stdout = $stdout
+        $stdout = StringIO.new 'w'
+        yield
+      rescue Exception => ex
+        new_ex = StandardError.new $stdout.string
+        new_ex.set_backtrace ex.backtrace
+        raise new_ex
+      else
+        $stdout.string
+      ensure
+        $stdout = orig_stdout
+      end
+    end
+
+    URI = 'druby://localhost:8787'
+
+    def start
+      DRb.start_service URI, Compiler.new
+      true
+    end
+
+    def stop
+      raise 'The server has not been started yet' unless running?
+      DRb.stop_service
+      true
+    end
+
+    def wait
+      DRb.thread.join if running?
+      true
+    end
+
+    def running?
+      not DRb.thread.nil? and DRb.thread.alive?
+    end
+  end
+end

data/test/client_spec.rb

@@ -0,0 +1,51 @@
+require 'test/common'
+require 'mirahd/server'
+require 'mirahd/client'
+
+describe MirahD::Client do
+  before :all do
+    wait_for_the_port_to_become_free 8787
+    @server = MirahD::Server.new
+    @server.start
+  end
+
+  after :all do
+    @server.stop
+  end
+
+  before do
+    @client = MirahD::Client.new
+  end
+
+  after do
+    rm_f_temp_files
+  end
+
+  it 'can compile to Java source code' do
+    @client.compile(['--java', Source]).should_not be_nil
+    File.file?(JavaFile).should == true
+  end
+
+  it 'can compile a JVM class' do
+    @client.compile([Source]).should_not be_nil
+    File.file?(ClassFile).should == true
+  end
+
+  it 'receives compiler\'s standard output' do
+    @client.compile([Source]).should =~ /^Parsing.*Inferring.*Done!$/m
+  end
+
+  describe 'after failed compilation' do
+    it 'receives an exception' do
+      lambda { @client.compile([BadSource]) } .should raise_error StandardError
+    end
+
+    it 'receives error messages' do
+      begin
+        @client.compile([BadSource])
+      rescue => ex
+        ex.message.should =~ /^Parsing.*expected statement.*at line/m
+      end
+    end
+  end
+end

data/test/common.rb

@@ -0,0 +1,32 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rspec'
+require 'fileutils'
+require 'socket'
+
+Source = 'test/hello.mirah'
+BadSource = 'Gemfile.lock'
+JavaFile = 'test/Hello.java'
+ClassFile = 'test/Hello.class'
+
+def rm_f_temp_files
+  [JavaFile, ClassFile].each { |file| FileUtils.rm_f file }
+end
+
+# This function tries to connect to a given TCP port and close the socket
+# immediately after getting connected. If TCPSocket#new raises an error it
+# means that the port is free and we can begin testing.
+#
+# This function prevents spurious Errno::EADDRINUSE errors which happened from
+# time to time when the port didn't get completely freed before proceeding to
+# a next test.
+def wait_for_the_port_to_become_free port
+  while true
+    begin
+      TCPSocket.new('localhost', port).close
+    rescue
+      return
+    end
+    sleep 0.1
+  end
+end

data/test/hello.mirah

@@ -0,0 +1,7 @@
+class Hello
+  def hi
+    puts "Witaj, Świecie!"
+  end
+end
+
+Hello.new.hi

data/test/server_spec.rb

@@ -0,0 +1,93 @@
+require 'test/common'
+require 'drb/drb'
+require 'mirahd/server'
+
+describe MirahD::Server do
+  before do
+    wait_for_the_port_to_become_free 8787
+    @server = MirahD::Server.new
+  end
+
+  it 'can be started and stopped' do
+    @server.start.should == true
+    @server.stop.should == true
+  end
+
+  it 'is not running by default' do
+    @server.running?.should == false
+  end
+
+  it 'knows when it is stopped' do
+    @server.start
+    @server.stop
+    @server.running?.should == false
+  end
+
+  it 'cannot be stopped before being started' do
+    lambda { @server.stop } .should raise_error
+  end
+
+  describe 'when online' do
+    before do
+      @server.start
+      @remote = DRbObject.new_with_uri 'druby://localhost:8787'
+    end
+
+    after do
+      @server.stop if @server.running?
+      rm_f_temp_files
+    end
+
+    it 'knows that it is running' do
+      @server.running?.should == true
+    end
+
+    it 'cannot be started once again' do
+      lambda { @server.start } .should raise_error
+    end
+
+    it 'listens on port 8787' do
+      @remote.should respond_to :object_id
+    end
+
+    it 'responds to compile' do
+      @remote.should respond_to :compile
+    end
+
+    it 'the #wait method should keep it running' do
+      # FIXME: busy waiting is considered evil.
+      failed = false
+      thr = Thread.start do
+        @server.wait
+        failed = @server.running?
+      end
+      sleep 0.1 until @server.running?
+      @server.stop
+      thr.join
+      failed.should == false
+    end
+
+    describe 'and given a valid input file' do
+      it 'should compile it to Java' do
+        @remote.compile(['--java', Source]).should_not be_nil
+        File.file?(JavaFile).should == true
+      end
+
+      it 'should compile it to a JVM class' do
+        @remote.compile([Source]).should_not be_nil
+        File.file?(ClassFile).should == true
+      end
+    end
+
+    describe 'and given an invalid input file' do
+      it 'should fail' do
+        lambda { @remote.compile [BadSource] } .should raise_error
+      end
+
+      it 'should not be killed after handling it' do
+        lambda { @remote.compile [BadSource] } .should raise_error
+        @remote.should respond_to :compile
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: mirahd
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+  - "Jan St\xC4\x99pie\xC5\x84"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-10 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: mirah
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    requirement: *id001
+    prerelease: false
+    type: :runtime
+description: "mirahd\n\
+  ======\n\n\
+  **mirahd** is a Mirah Daemon listening for your requests to compile something.\n\
+  When it receives one it does the job quickly. _Really quickly_.\n\n\
+  [![Build Status](https://secure.travis-ci.org/jstepien/mirahd.png?branch=master)](http://travis-ci.org/jstepien/mirahd)\n\n\
+  Usage\n\
+  -----\n\n\
+  We'll need:\n\n  * Bundler,\n  * Mirah, and as a result\n  * JRuby 1.6.\n\n\
+  For your own comfort and sanity it is also advisable to install a Ruby\n\
+  implementation with a reasonably short start up time. MRI or Rubinius\n\
+  are good candidates.\n\n    jruby -S bundle install\n    jruby -S rspec test\n    jruby -rubygems -I lib -S bin/mirahd --daemon\n    ruby -I lib bin/mirahd test/hello.mirah\n\n\
+  Rationale\n\
+  ---------\n\n\
+  Mirah is a lovely language but its low compilation speed might be discouraging.\n\
+  Using it in development based on a lot of small _code, test, refactor_ cycles\n\
+  might be problematic. JVM's start up time and a lag introduced by compilation\n\
+  of Mirah's sources by JRuby add up to the sum we see below\xC2\xB9.\n\n    $ time mirahc test/hello.mirah > /dev/null # with disk's cache warmed up\n    18.60user 0.45system 0:11.85elapsed\n\n\
+  After the initial warm up JVM and JRuby are pretty fast. The goal of this\n\
+  project is to make the JVM start once only and then reuse the existing process\n\
+  for all subsequent compilation tasks.\n\n\
+  Run the daemon.\n\n    $ jruby -rubygems -I lib -S bin/mirahd --daemon\n\n\
+  The first compilation is already quite quick.\n\n    $ time ruby -I lib -S bin/mirahd test/hello.mirah\n    0.05user 0.00system 0:00.89elapsed\n\n\
+  Then JVM's JIT comes into play. Here's the tenth compilation.\n\n    $ time ruby -I lib -S bin/mirahd test/hello.mirah\n    0.04user 0.00system 0:00.30elapsed\n\n\
+  Todo\n\
+  ----\n\n  * Security. By being able to access the port DRb is listening on you\n    can `eval` whatever you want to. `$SAFE` won't work as it's unsupported\n    by JRuby.\n  * Enable users to specify the port number.\n  * Write tests covering a server running in a different directory then the\n    client. It won't be possible without spawning 2 separate processes.\n  * Support `--help` et al. command line arguments.\n  * Concurrency. Two compilation requests might interfere with each other,\n    especially due to changing the current working directory.\n\n\
+  Copyrights\n\
+  ----------\n\n\
+  Copyright (c) 2012 Jan St\xC4\x99pie\xC5\x84\n\n\
+  Permission is hereby granted, free of charge, to any person obtaining\n\
+  a copy of this software and associated documentation files (the\n\
+  \"Software\"), to deal in the Software without restriction, including\n\
+  without limitation the rights to use, copy, modify, merge, publish,\n\
+  distribute, sublicense, and/or sell copies of the Software, and to\n\
+  permit persons to whom the Software is furnished to do so, subject to\n\
+  the following conditions:\n\n\
+  The above copyright notice and this permission notice shall be\n\
+  included in all copies or substantial portions of the Software.\n\n\
+  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n\
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n\
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n\
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n\
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n\
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n\
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n\
+  ___\n\
+  \xC2\xB9 That's a 64-bit OpenJDK 6 on Intel Core 2 Duo with GNU/Linux 3.2.8.\n"
+email: jstepien@users.sourceforge.net
+executables: 
+  - mirahd
+extensions: []
+
+extra_rdoc_files: 
+  - README.md
+files: 
+  - .rspec
+  - .travis.yml
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+  - Rakefile
+  - VERSION
+  - bin/mirahd
+  - lib/mirahd/client.rb
+  - lib/mirahd/server.rb
+  - test/client_spec.rb
+  - test/common.rb
+  - test/hello.mirah
+  - test/server_spec.rb
+homepage: https://github.com/jstepien/mirahd
+licenses: 
+  - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Mirah compilation daemon (in dire need of Javanese name)
+test_files: []
+