fluby 0.5.6 → 0.6.1

data/README.mdown

@@ -0,0 +1,134 @@
+# fluby
+
+A simple command to create an empty ActionScript project for MTASC + SWFMILL + Rake
+
+## Installation
+
+    gem install fluby
+
+Fluby requires the 'mtasc' and 'swfmill' executables somewhere on your path.
+
+
+## Usage
+
+### New project
+
+To create a new project:
+
+    fluby ProjectName
+
+
+### Compilation
+
+To compile your brand new project:
+
+    cd ProjectName
+    rake
+
+That should generate a 'ProjectName.swf' file on the 'deploy' folder. The SWF file is debug-enabled (i.e: you can see the trace() output if you have a debug Flash Player). If you want to release your project without debug information, run
+
+    rake release
+
+
+### More Rake tasks
+
+There are other rake tasks available:
+
+    rake package  # Creates a ZIP file containing your SWF file on the 'pkg' folder
+    rake test # Opens a HTML file with your SWF for testing on your default browser (available on Mac only)
+
+
+### script/generate
+
+Starting from version 0.6, fluby installs a 'generate' script in the 'scripts' folder that you can use to speed up the creation of new classes.
+
+Right now there are 3 template types:
+
+#### **class**
+
+Use it to create a generic class by running:
+
+    script/generate class your.class.path.ClassName attribute:Type attribute:Type (...)
+
+For example: if you want to create a "Car" class with attributes "make" and "model" of type String and an attribute "year" of type Number, you'd run:
+
+    script/generate class com.yourdomain.Car make:String model:String year:Number
+
+This will create a file in com/yourdomain/Car.as with this content:
+
+    class com.yourdomain.Car {
+      var make:String;
+      var model:String;
+      var year:Number;
+      function Car(){
+        // Init class
+      }
+    }
+
+
+#### **xml_loader**
+
+Use to create a simple XML loader class by running:
+
+    script/generate xml_loader your.class.path.ClassName
+
+Example: if you run
+
+    script/generate xml_loader com.bomberstudios.xml.Loader
+
+you'll get a com/bomberstudios/xml/Loader.as file containing:
+
+    class com.bomberstudios.xml.Loader {
+      var _path:String;
+      var raw_data:XML;
+      function Loader(path:String,callback:Function){
+        _path = path;
+        raw_data = new XML();
+        raw_data.ignoreWhite = true;
+        raw_data.onLoad = callback;
+      }
+      function give_me(node_name){
+        if (raw_data.firstChild.nodeName == node_name) {
+          return raw_data.firstChild;
+        }
+        for(var i=raw_data.firstChild.childNodes.length; i>=0; i--){
+          if(raw_data.firstChild.childNodes[i].nodeName == node_name){
+            return raw_data.firstChild.childNodes[i];
+          }
+        }
+      }
+      public function load(){
+        raw_data.load(_path);
+      }
+    }
+
+
+#### **delegate**
+
+To generate a MTASC-compatible Delegate class, run
+
+    script/generate delegate your.class.path.Delegate
+
+This will produce a your/class/path/Delegate.as file containing:
+
+    /**
+    *
+    * Delegate Class, MTASC compatible
+    *
+    **/
+    class your.class.path.Delegate {
+      public static function create(scope:Object,method:Function):Function{
+        var params:Array = arguments.splice(2,arguments.length-2);
+        var proxyFunc:Function = function():Void{
+          method.apply(scope,arguments.concat(params));
+        }
+        return proxyFunc;
+      }
+      public static function createR(scope:Object,method:Function):Function{
+        var params:Array = arguments.splice(2,arguments.length-2);
+        var proxyFunc:Function = function():Void{
+          method.apply(scope,params.concat(arguments));
+        }
+        return proxyFunc;
+      }
+    }

data/Rakefile

@@ -28,7 +28,7 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.8.5'
 
   s.has_rdoc              = false
-  s.files                 = FileList.new("README","Rakefile","bin/**/*","lib/**/*").to_a
+  s.files                 = FileList.new("README.mdown","Rakefile","bin/**/*","lib/**/*").to_a
   s.executables           = [ 'fluby' ]
   s.require_path          = 'lib'
   s.bindir                = 'bin'
@@ -56,4 +56,16 @@ Rake::TestTask.new(:test) do |test|
   test.test_files = Dir['test/test_*.rb']
 end
 
-task :default => [ :install ]
+task :github do
+  require 'rubygems/specification'
+  data = File.read('fluby.gemspec')
+  github_spec = nil
+  Thread.new { github_spec = eval("$SAFE = 3\n#{data}") }.join
+  puts github_spec
+end
+
+task :test do
+  %x(ruby test/test_fluby.rb)
+end
+
+task :default => [ :test ]

data/lib/fluby.rb

@@ -1,21 +1,40 @@
+require "erb"
+require "fileutils"
+
 module Fluby
   NAME    = 'fluby'
-  VERSION = '0.5.6'
+  VERSION = '0.6.1'
+
+  COLORS = {
+    :black => "\033[0;30m",
+    :red => "\033[0;31m",
+    :green => "\033[0;32m",
+    :yellow => "\033[0;33m",
+    :blue => "\033[0;34m",
+    :purple => "\033[0;35m",
+    :cyan => "\033[0;36m",
+    :white => "\033[0;37m",
+    :whitebold => "\033[1;37m"
+  }
+  PATH = File.expand_path(__FILE__)
 
   def self.create_project(name)
     require "fileutils"
     require "erb"
 
+    # TODO: Support project creation in subfolders (i.e: fluby test/project)
     @project_name = name
     @project_folder = FileUtils.pwd + "/" + @project_name
 
+    puts "\n#{COLORS[:green]}Creating project #{@project_name}"
+
     # Make folders
     if File.exist? @project_folder
-      puts "Folder #{@project_name} already exists,"
-      puts "please choose a different name for your project"
+      puts "#{COLORS[:red]}Folder #{@project_name} already exists,"
+      puts "#{COLORS[:red]}please choose a different name for your project"
       exit
     end
-    FileUtils.mkdir [@project_folder,"#{@project_folder}/deploy","#{@project_folder}/assets"]
+    FileUtils.mkdir [@project_folder,"#{@project_folder}/deploy","#{@project_folder}/assets","#{@project_folder}/script"]
 
     # Make files
     ["Rakefile","README"].each do |file|
@@ -30,6 +49,13 @@ module Fluby
     # Main Class
     render_template "ASClass.as", "#{@project_name}.as"
 
+    # script/generate
+    render_template "generate", "script/generate"
+    %x(chmod 755 "#{@project_folder}/script/generate")
+
+    if in_textmate?
+      puts "Oh, my, what a nice editor you're using"
+    end
   end
 
   def self.copy_template source, destination=nil
@@ -37,6 +63,7 @@ module Fluby
       destination = source
     end
     FileUtils.cp "#{File.dirname(__FILE__)}/templates/#{source}", "#{@project_folder}/#{destination}"
+    log "create", "#{@project_name}/#{destination}"
   end
 
   def self.render_template source, destination=nil
@@ -46,5 +73,62 @@ module Fluby
     open("#{@project_folder}/#{destination}","w") do |f|
       f << ERB.new(IO.read("#{File.dirname(__FILE__)}/templates/#{source}")).result(binding)
     end
+    log "create", "#{@project_name}/#{destination}"
+  end
+
+  def self.log type, string
+    case type
+    when "alert"
+      puts "\t#{COLORS[:red]}Alert:\t#{string}#{COLORS[:white]}"
+    when "create"
+      puts "\t#{COLORS[:white]}Created:\t#{COLORS[:cyan]}#{string}#{COLORS[:white]}"
+    end
+  end
+
+  def self.in_textmate?
+    begin
+      if TextMate
+        return true
+      end
+    rescue
+      return false
+    end
+  end
+
+  def self.is_mac?
+    return RUBY_PLATFORM =~ /darwin/
+  end
+
+  def self.has_growl?
+    return is_mac? && !`which "growlnotify"`.empty?
+  end
+
+  # these functions are used by script/generate
+  def self.generate(type, name, options={})
+    target_path = File.dirname(name.split(".").join("/").to_s)
+    target_file = name.split(".").join("/") + ".as".to_s
+    if File.exist?(target_file)
+      log "alert", "File #{target_file} already exists!"
+      return
+    end
+    FileUtils.mkdir_p target_path unless File.exist? target_path
+    @classpath = target_path.split("/").join(".")
+    @classname = name.split(".").last
+    options = options.map { |i| i = i.split(":") } unless options == {}
+    @opts = options
+    File.open(target_file,"w") do |file|
+      file << ERB.new(File.read("#{template_path}/generators/#{type}")).result(binding)
+    end
+    log "create", "#{target_path}/#{@classname}.as"
+  end
+
+  def self.path
+    File.dirname(PATH)
+  end
+  def self.template_path
+    path + "/templates"
+  end
+  def self.available_templates
+    return Dir["#{template_path}/generators/**"].map { |i| i = File.basename(i) }
   end
 end

data/lib/templates/README

@@ -48,4 +48,4 @@ Then, in your code, you'd use the fonts like this:
     txtest.text = "This is italics";
 
 --- 
-Created: <%= Time.now %>
+Created: <%= Time.now.strftime("%Y%m%d") %>

data/lib/templates/Rakefile

@@ -1,3 +1,6 @@
+require "erb"
+require 'rake/packagetask'
+
 WIDTH = 725
 HEIGHT = 480
 FPS = 31
@@ -5,8 +8,6 @@ PLAYER = 8
 BGCOLOR = "#ffffff"
 APP = "<%= @project_name %>"
 
-require "erb"
-
 def render_template(file)
   filename = File.basename(file).split(".")[0]
   case File.basename(file).split(".")[1]
@@ -36,18 +37,24 @@ task :compile do
     end
   end
   puts %x(swfmill simple #{APP}.xml #{APP}.swf)
-  rm "#{APP}.xml"
+  rm "#{APP}.xml", {:verbose => false}
   puts %x(mtasc -swf #{APP}.swf -main -mx -version #{PLAYER} #{trace} #{APP}.as)
   @end = Time.now
 
   ["*.html","*.swf"].each do |list|
     Dir[list].each do |file|
-      mv file, "deploy/#{file}"
+      mv file, "deploy/#{file}", {:verbose => false}
     end
   end
 end
 
-<% if RUBY_PLATFORM =~ /darwin/ %>
+Rake::PackageTask.new(APP, :noversion) do |p|
+  p.need_zip = true
+  p.name = Time.now.strftime("%Y%m%d") + "-" + APP
+  p.package_files.include("README",Dir["deploy/*"])
+end
+
+<% if Fluby.has_growl? %>
 task :notify do
   msg = "Finished compiling in #{@end - @start}s."
   if @nodebug
@@ -61,12 +68,14 @@ task :nodebug do
   @nodebug = true
 end
 
+<% if Fluby.is_mac? %>
 desc "Test the SWF file in your default browser"
 task :test => [:compile] do
   %x(open deploy/index.html)
 end
+<% end %>
 
-<% if RUBY_PLATFORM =~ /darwin/ %>
+<% if Fluby.has_growl? %>
 desc "Build a release version of <%= @project_name %> (with trace() disabled)"
 task :release => [:nodebug,:compile,:notify]
 

data/lib/templates/generate

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "fluby"
+
+commandline = ARGV
+if commandline.size < 2
+  puts "Usage: script/generate type classpath [options]"
+  puts "where type is one of"
+  Fluby.available_templates.each do |t|
+    puts "\t#{t}"
+  end
+else
+  type = commandline.shift
+  name = commandline.shift
+  options = commandline
+  Fluby.generate(type,name,options)
+end

data/lib/templates/generators/class

@@ -0,0 +1,7 @@
+class <%= @classpath %>.<%= @classname %> {
+<% @opts.each do |option| %>  var <%= option[0] %>:<%= option[1] %>;
+<% end %>
+  function <%= @classname %>(){
+    // Init class
+  }
+}

data/lib/templates/generators/delegate

@@ -0,0 +1,22 @@
+/**
+* 
+* Delegate Class, MTASC compatible
+* 
+**/
+
+class <%= @classpath %>.<%= @classname %> {
+  public static function create(scope:Object,method:Function):Function{
+    var params:Array = arguments.splice(2,arguments.length-2);
+    var proxyFunc:Function = function():Void{
+      method.apply(scope,arguments.concat(params));
+    }
+    return proxyFunc;
+  }
+  public static function createR(scope:Object,method:Function):Function{
+    var params:Array = arguments.splice(2,arguments.length-2);
+    var proxyFunc:Function = function():Void{
+      method.apply(scope,params.concat(arguments));
+    }
+    return proxyFunc;
+  }
+}

data/lib/templates/generators/xml_loader

@@ -0,0 +1,24 @@
+class <%= @classpath %>.<%= @classname %> {
+  var _path:String;
+  var raw_data:XML;
+
+  function <%= @classname %>(path:String,callback:Function){
+    _path = path;
+    raw_data = new XML();
+    raw_data.ignoreWhite = true;
+    raw_data.onLoad = callback;
+  }
+  function give_me(node_name){
+    if (raw_data.firstChild.nodeName == node_name) {
+      return raw_data.firstChild;
+    }
+    for(var i=raw_data.firstChild.childNodes.length; i>=0; i--){
+      if(raw_data.firstChild.childNodes[i].nodeName == node_name){
+        return raw_data.firstChild.childNodes[i];
+      }
+    }
+  }
+  public function load(){
+    raw_data.load(_path);
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fluby
 version: !ruby/object:Gem::Version 
-  version: 0.5.6
+  version: 0.6.1
 platform: ruby
 authors: 
 - "Ale Mu\xC3\xB1oz"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-19 00:00:00 +02:00
+date: 2008-11-04 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -22,12 +22,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.mdown
 - Rakefile
 - bin/fluby
 - lib/fluby.rb
 - lib/templates
 - lib/templates/ASClass.as
+- lib/templates/generate
+- lib/templates/generators
+- lib/templates/generators/class
+- lib/templates/generators/delegate
+- lib/templates/generators/xml_loader
 - lib/templates/index.rhtml
 - lib/templates/project.rxml
 - lib/templates/Rakefile
@@ -55,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fluby
-rubygems_version: 1.0.1
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: A simple command to create an empty project for MTASC + SWFMILL + Rake

data/README

@@ -1,4 +0,0 @@
-fluby
-=====
-
-A simple command to create an empty project for MTASC + SWFMILL + Rake