h4oflashsdk 1.0.0

data/lib/flashsdk/fcsh.rb

@@ -0,0 +1,173 @@
+
+module FlashSDK
+
+  class FCSH < Sprout::Executable::Session
+
+    ##
+    # The the Ruby file that will load the expected
+    # Sprout::Specification.
+    #
+    # Default value is 'flex4'
+    set :pkg_name, 'flex4'
+
+    ##
+    # The default pkg version
+    #
+    set :pkg_version, ">= #{FlashSDK::VERSION}"
+
+    ##
+    # The default executable target.
+    #
+    set :executable, :fcsh
+
+    ##
+    # Set the default prompt that should be presented
+    #  on stdout when fcsh is ready for input.
+    set :prompt, /^\(fcsh\) /
+
+    ##
+    # Clear the saved compilation target
+    # from memory.
+    #
+    # @param id [Integer]
+    #
+    add_action :clear
+
+    ##
+    # Perform compilation using COMPC and the
+    # provided arguments.
+    #
+    # @param options [String]
+    #
+    add_action :compc
+
+    ##
+    # Execute a saved compilation from the provided
+    # id number.
+    #
+    # @param id [Integer]
+    #
+    add_action :compile
+
+    ##
+    # Perform compilation using MXMLC and the
+    # provided arguments.
+    #
+    # @param options [String]
+    #
+    add_action :mxmlc
+
+    ##
+    # Exit FCSH
+    add_action :quit
+
+
+    def system_execute binary, params
+      params ||= ''
+      ##
+      # Combine stdout and stderr for FCSH
+      # so that they both arrive on stdout
+      params << ' 2<&1'
+      super binary, params
+    end
+
+  end
+end
+
+##
+# Rake task that will make any subsequent
+# mxmlc or compc tasks use the FCSH compiler.
+#
+# You can use this task by inserting it
+# before the task you're calling on the 
+# command line like:
+#
+#   rake fcsh test
+#
+# or:
+#
+#   rake fcsh debug
+#
+# Or you can add this task as a prerequisite
+# to your build tasks directly like:
+#
+#   mxmlc 'bin/SomeProject.swf' => :fcsh do |t|
+#     ...
+#   end
+#
+desc "Make subsequent MXMLC or COMPC tasks use FCSH"
+task :fcsh do
+  ENV['USE_FCSH'] = 'true'
+end
+
+##
+# Rake task that will make any subsequent
+# mxmlc or compc tasks use the FCSH compiler.
+#
+# You can use this task by inserting it
+# before the task you're calling on the 
+# command line like:
+#
+#   rake fcsh test
+#
+# or:
+#
+#   rake fcsh debug
+#
+# Or you can add this task as a prerequisite
+# to your build tasks directly like:
+#
+#   mxmlc 'bin/SomeProject.swf' => :fcsh do |t|
+#     ...
+#   end
+#
+desc "Make subsequent MXMLC or COMPC tasks use FCSH"
+task :fcsh do
+  ENV['USE_FCSH'] = 'true'
+end
+##
+# Rake task that will make any subsequent
+# mxmlc or compc tasks use the FCSH compiler.
+#
+# You can use this task by inserting it
+# before the task you're calling on the 
+# command line like:
+#
+#   rake fcsh test
+#
+# or:
+#
+#   rake fcsh debug
+#
+# Or you can add this task as a prerequisite
+# to your build tasks directly like:
+#
+#   mxmlc 'bin/SomeProject.swf' => :fcsh do |t|
+#     ...
+#   end
+#
+desc "Make subsequent MXMLC or COMPC tasks use FCSH"
+task :fcsh do
+  ENV['USE_FCSH'] = 'true'
+end
+
+namespace :fcsh do
+  desc "Start the FCSH server"
+  task :start do
+    server = FlashSDK::FCSHSocket.new
+    server.listen ENV['FCSH_PKG_NAME'], ENV['FCSH_PKG_VERSION'], ENV['FCSH_PORT']
+  end
+
+  desc "Clear the cached compilation data"
+  task :clear do
+    client = FlashSDK::FCSHSocket.new
+    client.execute "clear", ENV['FCSH_PORT']
+  end
+
+  desc "Quit the fcsh server"
+  task :quit do
+    client = FlashSDK::FCSHSocket.new
+    client.execute "quit", ENV['FCSH_PORT']
+  end
+end
+

data/lib/flashsdk/fcsh_socket.rb

@@ -0,0 +1,167 @@
+require 'socket'
+
+module FlashSDK
+
+  ##
+  # This is a client to the long-running FCSH process.
+  #
+  # The server side of this connection should be
+  # started before starting the client.
+  #
+  # To do this, just open a new terminal, cd into your
+  # project directory, and run:
+  #
+  #   rake fcsh:start
+  # 
+  class FCSHSocket
+
+    ##
+    # The default TCP port that FCSH will use
+    # to connect.
+    DEFAULT_PORT = 12321
+
+    attr_accessor :port
+
+    attr_reader :requests
+
+    ##
+    # Create a new FCSHClient
+    def initialize
+      @port = DEFAULT_PORT
+      @requests = {}
+    end
+
+    def listen pkg_name=nil, pkg_version=nil, port=nil
+      port = port || @port
+      # Instantiate FCSH:
+      fcsh             = FlashSDK::FCSH.new
+      fcsh.pkg_name    = pkg_name unless pkg_name.nil?
+      fcsh.pkg_version = pkg_version unless pkg_version.nil?
+
+      # Notify the outer shell that we're ready:
+      Sprout.stdout.puts "FCSH socket open with: #{fcsh.pkg_name} and #{fcsh.pkg_version}, waiting for connections on port #{port}"
+      Sprout.stdout.puts ""
+
+      # Start up the FCSH Session:
+      fcsh.execute false
+
+      # Create a readable IO pipe:
+      output = Sprout::OutputBuffer.new
+      # Associate the IO pipe with our 
+      # outputs so that FCSH will write
+      # to it.
+      Sprout.stdout = output
+      Sprout.stderr = output
+
+      server = TCPServer.new 'localhost', port
+
+      # Create a thread that will exit
+      # when FCSH exits.
+      t = Thread.new do
+        fcsh.wait
+      end
+
+      while t.alive? do
+        Sprout.stdout.puts ""
+        session  = server.accept
+        rendered = render_request session.gets
+        parts    = rendered.split(" ")
+        method   = parts.shift.strip
+        if parts.size > 0
+          fcsh.send method, parts.join(" ")
+        else
+          fcsh.send method
+        end
+
+        fcsh.wait_for_prompt
+
+        if method == "clear"
+          clear_requests
+        end
+
+        response = "#{rendered}\n"
+        response << output.read.gsub(rendered, '')
+        session.puts response.gsub(fcsh.prompt, "\n")
+        session.flush
+        session.close
+      end
+    end
+
+    def execute command, port=nil
+      duration = Benchmark.measure do
+        port = port || @port
+        begin
+          #Sprout.stdout.puts "[FCSH] #{command}"
+          session = TCPSocket.new 'localhost', port
+          session.puts command
+          response = session.read
+          if response.match /Error/
+            raise Sprout::Errors::UsageError.new "[FCSH] #{response}"
+          else
+            Sprout.stdout.puts "[FCSH] #{response}"
+          end
+          response
+        rescue Errno::ECONNREFUSED => e
+          message = "[ERROR] "
+          message << e.message
+          message << ": Could not connect to an FCSH server on port: #{port} at: #{Dir.pwd}.\n\n"
+          message << "This is probably because one has not been started. To start a new FCSH server, open a new "
+          message << "terminal and run the following:\n\n"
+          message << "cd #{Dir.pwd}\n"
+          message << "rake fcsh:start\n"
+          raise Sprout::Errors::UsageError.new message
+        ensure
+          if !session.nil? && !session.closed?
+            session.flush
+            session.close
+          end
+        end
+      end
+
+      if command.match /^mxmlc|^compc/
+        Sprout.stdout.puts "[FCSH] complete in #{duration} seconds."
+      end
+    end
+
+    private
+
+    def render_request request
+      if request.match /^mxmlc|^compc/
+        hash = Digest::MD5.hexdigest request
+
+        if requests[hash].nil?
+          requests[hash] = next_compiler_index
+          request
+        else
+          "compile #{requests[hash]}"
+        end
+      else
+        request
+      end
+    end
+
+    def next_compiler_index
+      index = 1
+      @requests.each do |key, value|
+        value += 1
+        index = [index, value].max
+      end
+      index
+    end
+
+    def clear_requests
+      # Clear the cached requests,
+      # but leave them in place, the underlying
+      # FCSH implementation continues incrementing
+      # indices.
+
+      new_requests = {}
+      @requests.each do |key, value|
+        new_requests["removed-item"] = value
+      end
+      @requests = new_requests
+    end
+
+  end
+end
+