lfd 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ce85aaaba42163a9852ae64239f5e093d8aade
-  data.tar.gz: 3068d2725b514cc53ca3aa5141da23135a4f84bd
+  metadata.gz: c4507a5267e60427b4efafdb750fac6ecdfd3c3f
+  data.tar.gz: eebef4eab558051b2baf347be392bbe61fb0b171
 SHA512:
-  metadata.gz: 5399aa29fb4eb399c600ecdbc6bfad668bad6c988bcc30ca8d6abd74ad7c075447aedc3355ede10606b96ad5eeb5713bcdef8db78fafda295e07992e97d9c4b0
-  data.tar.gz: 09ff11b23084fa6f6cc1d1729a7cf49f731fcc870acc841576b3e5b6649dfd009c77d37b1d1094dcc217e482d1ce223db85455f5f92b55e075d6001232ca43a5
+  metadata.gz: 263e5003781e9b077611eb6edbe96b93d32d290c3bbf95c4d3bad4aacdd941e4c7a797c47b1734022a2a60fdb7675d725a8e6962765df86fb3a65f3358492f8b
+  data.tar.gz: c524903561fd09e2650976d7933c55e68fd4d5e0bdc53e45e70186298e508b3c23a35ac33a316d9883e0140df3ed55c83fbe692c006cb54c9d8a0171a6cbd090

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    lfd (0.0.1)
+      gli
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gli (1.6.0)
+    json (1.6.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lfd!
+  rake
+  rdoc

data/README.md

@@ -0,0 +1,43 @@
+# Linux Flash Develp
+LFD,  which stands for "Linux Flash Develop", will help you develop Flash and Flex applications on Linux, especially Ubuntu.
+
+## Pain of Flash Developing On Linux
+1. you must write many lines of command to compile your code into a swf file
+2. 'trace' do not output in standard output (such as terminal) in new version of standalone flash player
+
+LFD is your firend if you are suffering from the pain as well as me.
+
+## Usage
+
+    lfd init    # init your project home, creating file: asproj.info, making dirs: bin/ src/ lib/ etc.
+    lfd build   # compile your appliation (configed in asproj.info) with a binary swf file output
+    lfd run     # open swf file with standalone Adobe flash player.
+    lfd test    # equals "lfd build && lfd run"
+    lfd clean   # delete project info file and folders created by LFD. will not delete non-empty folder
+
+##  Installation
+###  System Requirements
+1. ruby 1.9.2+ 
+
+    you can install ruby1.9.2 with this commands on unbuntu:
+
+        sudo apt-get install ruby1.9.1
+
+2. Flex SDK
+
+    you can [download](http://sourceforge.net/adobe/flexsdk/wiki/Downloads/) Flex SDK from Adobe, version 4.5+ is suggested because I havn't test many versions of SDK.
+
+3. Standalone Flash Player
+
+    you can [download](http://www.adobe.com/support/flashplayer/downloads.html) it from Adobe. Make sure to use the latest debugger version.
+
+### Install LFD
+
+    gem install lfd
+
+## Configuration
+
+LFD depends on Flex SDK and Flash Player heavily. Please config them in your bash config (~/.bashrc commonly)
+
+    export MXMLC="/path/to/flex_sdk/bin/mxmlc"
+    export FLASH_PLAYER="/path/to/flashplayer_standalone"

data/README.zhCN.md

@@ -0,0 +1,43 @@
+# Linux Flash Develp
+LFD 可以帮助你在Linux下开发和调试Flash(ActionScript3和Flex)项目
+
+## 解决的问题
+1. 在Linux下没有方便的flash编译工具，手动写命令比较繁琐
+2. 新的播放器默认不会将trace输出到终端，查看程序日志比较麻烦
+
+## 使用方法
+
+    lfd         #显示帮助
+    lfd init    #在当前目录初始化项目
+    lfd build   #编译项目
+    lfd run     #以flashplayer打开编译出来的swf文件
+    lfd test    #编译并打开,  等同于 lfd build && lfd run
+    lfd clean   #删除项目，会删除lfd创建出来的 asproj.info 文件
+
+##  安装
+###  系统要求
+1. ruby 1.9.2+ 运行环境
+
+    unbuntu 下可以通过命令安装
+
+        sudo apt-get install ruby1.9.1
+
+2. flex sdk
+
+    可以从Adobe官方网站[下载](http://opensource.adobe.com/wiki/display/flexsdk/Flex+SDK)，建议使用4.5以上的SDK
+
+3. 独立Flash播放器
+
+    可以从Adobe官方网站[下载](http://www.adobe.com/support/flashplayer/downloads.html)，建议使用最新的Debugger版
+
+### 安装LFD
+
+    gem install lfd
+
+## 配置
+
+lfd 运行时会调用flex sdk和flash播放器，请将他们所在的路径添加到$PATH中.
+在$HOME/.bashrc中指定以下配置：
+
+    export MXMLC="/path/to/flex_sdk/bin/mxmlc"
+    export FLASH_PLAYER="/path/to/flashplayer_standalone"

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('lfd.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/tc_*.rb']
+end
+
+task :default => :test

data/lfd.gemspec

@@ -0,0 +1,27 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','lfd_version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'lfd'
+  s.description = <<-EOF
+    LFD,  which stands for "Linux Flash Develop", will help you develop Flash and Flex applications on Linux.
+  EOF
+  s.version = Lfd::VERSION
+  s.author = 'qhwa'
+  s.email = 'qhwa@163.com'
+  s.homepage = 'https://github.com/qhwa/LFD'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Flash develop tool on Linux'
+# Add your other files here if you make them
+  s.files = `git ls-files`.split("
+")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','lfd.rdoc']
+  s.rdoc_options << '--title' << 'lfd' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'lfd'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_runtime_dependency('gli')
+  s.add_runtime_dependency('colored')
+end

data/lib/lfd/app.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+require 'lfd/env'
+require 'lfd/setup'
+require 'lfd/init'
+require 'lfd/build'
+require 'lfd/run'
+
+module LFD
+
+  CONFIG_FILE = 'asproj.info'
+
+  class App
+
+    include FileUtils
+
+    ################################################
+    # subcommand: env
+    # 'env' also contains other helper methods
+    include Env
+
+    ###############################################
+    # subcommand: setup
+    include Setup
+
+    ###############################################
+    # subcommand: init
+    include Init
+
+    ###############################################
+    # subcommand: build & release
+    include Build
+
+    ###############################################
+    # subcommand: run
+    include Run
+
+    ###############################################
+    # subcommand: test
+    def test
+      build
+      run
+    end
+
+    ###############################################
+    # subcommand: clean
+    def clean(opt={})
+      rm_f CONFIG_FILE
+      rmdir %w(bin lib src tmp)
+    end
+
+  end
+
+end

data/lib/lfd/build.rb

@@ -0,0 +1,188 @@
+module LFD
+
+  module Build
+
+    # TODO: support building swc
+    attr_reader :info
+
+    def build(opt={})
+      @options = opt
+      if File.exist?(CONFIG_FILE)
+        if mxmlc_ready?
+          @info = YAML.load_file(CONFIG_FILE)
+          if compile_to_swc?
+            cmd = compc_path << " " << swc_build_arg.join( ' ' )
+            puts cmd
+            system cmd
+          else
+            system mxmlc_path, info["main"], *swf_build_arg
+          end
+        else
+          fail "mxmlc not found!"
+        end
+      else
+        fail "#{CONFIG_FILE} not found, exiting"
+        exit 
+      end
+    end
+
+    def release(opt={})
+      build( opt.merge :debug => false )
+    end
+
+    private
+
+      def compile_to_swc?
+        output_path =~ /\.swc$/i
+      end
+
+      def output_path
+        info["output"] && info["output"]["file"]
+      end
+
+      # swc compile options:
+      #
+      # -benchmark
+      # -compiler.accessible
+      # -compiler.actionscript-file-encoding <string>
+      # -compiler.compress
+      # -compiler.context-root <context-path>
+      # -compiler.debug
+      # -compiler.enable-runtime-design-layers
+      # -compiler.extensions.extension [extension] [parameters] [...]
+      # -compiler.external-library-path [path-element] [...]
+      # -compiler.fonts.advanced-anti-aliasing
+      # -compiler.fonts.flash-type
+      # -compiler.fonts.max-glyphs-per-face <string>
+      # -compiler.include-libraries [library] [...]
+      # -compiler.incremental
+      # -compiler.library-path [path-element] [...]
+      # -compiler.locale [locale-element] [...]
+      # -compiler.minimum-supported-version <string>
+      # -compiler.mobile
+      # -compiler.mxml.compatibility-version <version>
+      # -compiler.mxml.minimum-supported-version <string>
+      # -compiler.namespaces.namespace [uri] [manifest] [...]
+      # -compiler.omit-trace-statements
+      # -compiler.optimize
+      # -compiler.preloader <string>
+      # -compiler.report-invalid-styles-as-warnings
+      # -compiler.services <filename>
+      # -compiler.show-actionscript-warnings
+      # -compiler.show-binding-warnings
+      # -compiler.show-invalid-css-property-warnings
+      # -compiler.show-shadowed-device-font-warnings
+      # -compiler.show-unused-type-selector-warnings
+      # -compiler.source-path [path-element] [...]
+      # -compiler.strict
+      # -compiler.theme [filename] [...]
+      # -compiler.use-resource-bundle-metadata
+      # -compiler.verbose-stacktraces
+      # -compute-digest
+      # -directory
+      # -framework <string>
+      # -help [keyword] [...]
+      # -include-classes [class] [...]
+      # -include-file <name> <path>
+      # -include-namespaces [uri] [...]
+      # -include-resource-bundles [bundle] [...]
+      # -include-sources [path-element] [...]
+      # -include-stylesheet <name> <path>
+      # -licenses.license <product> <serial-number>
+      # -load-config <filename>
+      # -metadata.contributor <name>
+      # -metadata.creator <name>
+      # -metadata.date <text>
+      # -metadata.description <text>
+      # -metadata.language <code>
+      # -metadata.localized-description <text> <lang>
+      # -metadata.localized-title <title> <lang>
+      # -metadata.publisher <name>
+      # -metadata.title <text>
+      # -output <filename>
+      # -runtime-shared-libraries [url] [...]
+      # -runtime-shared-library-path [path-element] [rsl-url] [policy-file-url] [rsl-url] [policy-file-url]
+      # -static-link-runtime-shared-libraries
+      # -swf-version <int>
+      # -target-player <version>
+      # -tools-locale <string>
+      # -use-direct-blit
+      # -use-gpu
+      # -use-network
+      # -version
+      # -warnings
+      def swc_build_arg
+        [
+          "-target-player #{info["target"]}",
+          "-output #{output_path}",
+          "-compiler.source-path #{array_opt_to_s info["source"], ' '}"
+          # TODO: 加上更多的编译选项
+        ].tap do |args|
+
+          info["library"].tap do |libs|
+            if libs
+              args << "-compiler.library-path #{array_opt_to_s libs, ' '}"
+            end
+          end
+
+          info["include_classes"].tap do |classes|
+            if classes && !classes.empty?
+              args << "-include-classes #{array_opt_to_s classes, ' '}"
+            end
+          end
+
+        end
+        
+      end
+
+      def debug?
+        @options[:debug] != false
+      end
+
+      def swf_build_arg
+        [
+          "--target-player=#{info["target"]}",
+          "--output=#{output_path}",
+          "--source-path=#{array_opt_to_s info["source"]}",
+          "--debug=#{@options[:debug] != false}",
+          "-static-link-runtime-shared-libraries=true" 
+          # TODO: 加上更多的编译选项
+        ].tap do |args|
+
+          info["library"].each do |lib|
+            args << "--library-path+=#{lib}"
+          end
+
+          w, h = output["width"], output["height"]
+          args << "--default-size=#{w},#{h}" if w and h
+
+          # conditional compilation, set in asproj.info:
+          #
+          # compile_condition:
+          #  CONFIG::debugging: true
+          #
+          cc = info["compile_condition"]
+          cc && cc.each do |k, v|
+            args << "-define+=#{k},#{v}"
+          end
+
+        end
+      end
+
+      def output
+        info["output"]
+      end
+
+      def array_opt_to_s(src, sep = ',')
+        case src
+        when Array
+          src.join sep
+        else
+          src.to_s
+        end
+      end
+
+
+  end
+
+end

data/lib/lfd/env.rb

@@ -0,0 +1,92 @@
+module LFD
+
+  module Env
+    
+    # Public: Check the flash developing environment
+    def env(opt={})
+      check_flex_sdk
+      check_flash_player
+    end
+
+    def check_flex_sdk
+      check_cmd( "flex sdk - mxmlc", mxmlc_path )
+      check_cmd( "flex sdk - compc", compc_path )
+    end
+
+    def check_cmd title, cmd_path
+      print "#{title}: ".capitalize.rjust(20)
+      if cmd_path
+        puts cmd_path.chomp.green
+      else
+        puts "✗".red
+      end
+    end
+
+    def check_flash_player
+      check_cmd 'Flash Player', fp_path
+    end
+
+    def flex_sdk_ready?
+      mxmlc_ready? && compc_ready?
+    end
+
+    def mxmlc_ready?
+      executable? mxmlc
+    end
+
+    def executable? cmd
+      !!executable_path( cmd )
+    end
+
+    def executable_path cmd
+      path = `which #{Shellwords.escape(cmd)}`
+      path.empty? ? nil : path.chomp
+    end
+
+    def compc_ready?
+      executable? compc
+    end
+
+    def mxmlc
+      ENV['MXMLC'] || 'mxmlc'
+    end
+
+    def mxmlc_path
+      @mxmlc_path ||= executable_path( mxmlc )
+    end
+
+    def compc
+      ENV['COMPC'] || 'compc'
+    end
+
+    def compc_path
+      @compc_path ||= executable_path( compc )
+    end
+
+    def flash_player_ready?
+      executable? flash_player
+    end
+
+    alias_method :fp_ready?, :flash_player_ready?
+
+    def flash_player
+      ENV['FLASH_PLAYER'] || 'flashplayer'
+    end
+
+    def flash_player_path
+      @fp_path ||= executable_path( flash_player )
+    end
+
+    alias_method :fp_path, :flash_player_path
+
+    def trace_log_file
+      File.join ENV['HOME'], '.macromedia/Flash_Player/Logs/flashlog.txt'
+    end
+
+    def mm_cfg
+      File.join ENV['HOME'], 'mm.cfg'
+    end
+
+  end
+
+end