captproton-restfulx 1.2.3

data/lib/restfulx/rails/schema_to_yaml/settings/config.rb

@@ -0,0 +1,17 @@
+# SchemaToYaml settings
+module SchemaToYaml
+  module Settings
+    class Config
+      class << self
+        def configure
+          yield self
+        end
+
+        def settings_file
+          @settings_file ||= :restfulx
+        end
+        attr_writer :settings_file
+      end
+    end
+  end
+end

data/lib/restfulx/rails/schema_to_yaml/settings/core.rb

@@ -0,0 +1,73 @@
+# Inspired from http://settingslogic.rubyforge.org/
+# Used to read in settings from restfulx.yml for use in code generation
+module SchemaToYaml
+  module Settings
+    # We try to figure out the application root using a number of possible options
+    APP_ROOT = defined?(RAILS_ROOT) ? RAILS_ROOT : defined?(Merb) ? Merb.root : File.expand_path(".")
+    
+    class Core
+      class << self
+        def name
+          instance._settings.key?("name") ? instance.name : super
+        end
+        
+        def reset!
+          @instance = nil
+        end
+        
+      private
+        def instance
+          @instance ||= new
+        end
+        
+        def method_missing(name, *args, &block)
+          instance.send(name, *args, &block)
+        end
+      end
+      
+      attr_accessor :_settings
+      
+      def initialize(name_or_hash = Config.settings_file)
+        case name_or_hash
+        when Hash
+          self._settings = name_or_hash
+        when String, Symbol
+          root_path = defined?(APP_ROOT) ? "#{APP_ROOT}/config/" : ""
+          file_path = name_or_hash.is_a?(Symbol) ? "#{root_path}#{name_or_hash}.yml" : name_or_hash
+          self._settings = YAML.load(ERB.new(File.read(file_path)).result)
+          self._settings = _settings[RAILS_ENV] if defined?(RAILS_ENV)
+        else
+          raise ArgumentError.new("Your settings must be a hash, 
+            a symbol representing the name of the .yml file in your config directory,
+            or a string representing the abosolute path to your settings file.")
+        end
+        define_settings!
+      end
+      
+    private
+      def method_missing(name, *args, &block)
+        raise NoMethodError.new("no configuration was specified for #{name}")
+      end
+      
+      def define_settings!
+        return if _settings.nil?
+        _settings.each do |key, value|
+          case value
+          when Hash
+            instance_eval <<-"end_eval", __FILE__, __LINE__
+              def #{key}
+                @#{key} ||= self.class.new(_settings["#{key}"])
+              end
+            end_eval
+          else
+            instance_eval <<-"end_eval", __FILE__, __LINE__
+              def #{key}
+                @#{key} ||= _settings["#{key}"]
+              end
+            end_eval
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restfulx/rails/swf_helper.rb

@@ -0,0 +1,59 @@
+# Adds a little helper to make it easier empbedding SWFs in ERB templates.
+module SWFHelper
+  # Creates a swfObject Javascript call.  You must include swfobject.js to use this.
+  # See http://code.google.com/p/swfobject/wiki/documentation for full details and documentation
+  # of the swfobject js library.
+  def swfobject(swf_url, params = {})
+    params.reverse_merge!({:width => '100%',
+                           :height => '100%',
+                           :id => 'flashContent',
+                           :version => '9.0.0',
+                           :express_install_swf => '/expressInstall.swf',
+                           :flash_vars => nil,
+                           :params => { },
+                           :attributes => { },
+                           :create_div => false, 
+                           :include_authenticity_token => true,
+                           :include_session_token => true
+                          })                       
+    arg_order = [:id, :width, :height, :version, :express_install_swf]
+    js_params = ["'#{swf_url}'"]
+    js_params += arg_order.collect {|arg| "'#{params[arg]}'" }
+    
+    # Add authenticity_token and the session key to flashVars.  This will only work if flashVars is a Hash or nil
+    # If it's a string representing the name of a Javascript variable, then you need to add them yourself 
+    # like this:
+    # <script>
+    #   ... other code that defines flashVars and sets some of its parameters
+    #   flashVars['authenticity_token'] = <%= form_authenticity_token -%>
+    #   flashVars['session_token'] = <%= session.session_id -%>
+    # </script>
+    params[:flash_vars] ||= {}
+    if params[:flash_vars].is_a?(Hash)
+      if params[:include_authenticity_token] && ActionController::Base.allow_forgery_protection
+        params[:flash_vars].reverse_merge!(:authenticity_token => form_authenticity_token)
+      end
+      if params[:include_session_token]
+        if RAILS_GEM_VERSION =~ /^2.3/
+          params[:flash_vars].reverse_merge!(:session_token => request.session_options[:id])
+        else
+          params[:flash_vars].reverse_merge!(:session_token => session.session_id)
+        end
+      end        
+    end          
+    
+    js_params += [params[:flash_vars], params[:params], params[:attributes]].collect do |hash_or_string|
+      if hash_or_string.is_a?(Hash)
+        hash_or_string.to_json
+      else # If it's not a hash, then it should be a string giving the name of the Javascript variable to use
+        hash_or_string
+      end
+    end.compact
+
+    swf_tag = javascript_tag do 
+      "swfobject.embedSWF(#{js_params.join(',')})"
+    end 
+    swf_tag += content_tag(:div, nil, :id => params[:id]) if params[:create_div]    
+    swf_tag
+  end
+end

data/lib/restfulx/tasks.rb

@@ -0,0 +1,110 @@
+# Rake tasks for building RestfulX-based Flex and AIR applications
+require 'rake'
+require 'rexml/document'
+require 'activesupport'
+require File.join(File.dirname(__FILE__), 'configuration')
+
+include RestfulX::Configuration
+
+namespace :rx do
+  # Compile the given Flex/AIR application
+  # The following options are supported:
+  #     :executable => 'mxmlc'
+  #     :application => nil
+  #     :destination => 'public/bin'
+  #     :opts => nil
+  #     :flex_root => 'app/flex'
+  def compile_application(params = {})
+    project_name, flex_project_name, command_controller_name, base_package, base_folder, 
+      flex_root = extract_names()
+    
+    executable = params[:executable] || 'mxmlc'
+    application = params[:application] || get_main_application
+    destination = params[:destination] || 'public/bin'
+    opts = params[:opts] || ''
+    flex_root = params[:flex_root] || flex_root
+    
+    compiler = get_executable(executable)
+    
+    application = get_main_application unless application
+    project_path = File.join(APP_ROOT, flex_root, application)
+    target_project_path = project_path.sub(/.mxml$/, '.swf')
+    target_project_air_descriptor = project_path.sub(/.mxml$/, '-app.xml')
+      
+    libs = Dir.glob(File.join(APP_ROOT, 'lib', '*.swc')).map {|lib| lib.gsub(' ', '\ ')}
+      
+    additional_compiler_args = get_app_properties().elements["actionScriptProperties"].elements["compiler"].attributes["additionalCompilerArguments"]
+    additional_compiler_args.gsub!("../locale/", "#{APP_ROOT}/app/locale/")
+    
+    cmd = "#{executable} #{opts} -library-path+=#{libs.join(',')} " << additional_compiler_args << " #{project_path.gsub(' ', '\ ')}"
+    puts "Compiling #{project_path}"
+    if system(cmd)
+      FileUtils.makedirs File.join(APP_ROOT, destination)
+      puts "Moving #{target_project_path} to " + File.join(APP_ROOT, destination)
+      FileUtils.mv target_project_path, File.join(APP_ROOT, destination), :force => true
+      if File.exist?(target_project_air_descriptor)
+        descriptor = File.read(target_project_air_descriptor)
+        descriptor_name = target_project_air_descriptor.split("/").last
+        app_swf = target_project_path.split("/").last
+        descriptor.gsub!("[This value will be overwritten by Flex Builder in the output app.xml]", 
+          app_swf)
+
+        File.open("#{APP_ROOT}/#{destination}/#{descriptor_name}", "w") do |file|
+          file.print descriptor
+        end
+        puts "Created #{APP_ROOT}/#{destination}/#{descriptor_name} descriptor."
+      end
+      puts 'Done!'
+    else
+      puts "The application was not compiled. Check console for errors. " <<
+        "It is possible that '(a)mxmlc' executable was not found or there are compilation errors."
+    end
+  end
+  
+  def run_air_application(params = {})
+    application = params[:application] || get_main_application
+    descriptor = params[:descriptor] || application.sub(/.mxml$/, '-app.xml')
+    destination = params[:destination] || 'bin-debug'
+    
+    puts "Running AIR application with descriptor: #{descriptor}"
+    if !system("#{get_executable('adl')} #{destination}/#{descriptor}")
+      puts "Could not run the application with descriptor: #{destination}/#{descriptor}. Check console for errors."
+    end
+  end
+  
+  # Find what the main application is based on .actionScriptProperties file
+  def get_main_application
+    get_app_properties().root.attributes['mainApplicationPath'].split("/").last
+  end
+  
+  def get_app_properties
+    REXML::Document.new(File.open(File.join(APP_ROOT, ".actionScriptProperties")))
+  end
+  
+  # Get appropriate executable based on platform
+  def get_executable(executable)
+    if RUBY_PLATFORM =~ /mswin32/
+      executable << '.exe'
+    end
+    executable
+  end
+  
+  namespace :flex do
+    desc "Build project swf file and move it into public/bin folder"
+    task :build do
+      compile_application()
+    end
+  end
+  
+  namespace :air do
+    desc "Build project swf file as an AIR application and move it into bin-debug folder"
+    task :build do   
+      compile_application(:destination => 'bin-debug', :opts => '+configname=air')
+    end
+    
+    desc "Run the AIR application (if this project is configured as an AIR project)"
+    task :run do
+      run_air_application
+    end
+  end
+end

data/rails_generators/rx_config/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Generates the primary RestfulX directory structure, sets up Flex Builder
+    specific descriptor files and options fetches the latest published 
+    RestfulX Framework SWC file.
+    
+    You can generate Flex Builder configuration for either *pure* Flex
+    project or an AIR project. To generate AIR configuration pass the -a
+    (--air) option to the generator.
+
+Examples:
+    `./script/generate rx_config` # generates project structure and a 
+                                  # default Flex app configuration. Fetches 
+                                  # latest RestfulX framework SWC to "lib" 
+                                  # folder
+    `./script/generate rx_config -a` # as above but generates an AIR app
+                                     # and configuration
+    `./script/generate rx_config --skip-framework` # generates Flex app 
+                                     # but does not fetch
+                                     # the RestfulX framework SWC.

data/rails_generators/rx_config/rx_config_generator.rb

@@ -0,0 +1,151 @@
+require 'open-uri'
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'restfulx') if !defined?(RestfulX)
+
+class RxConfigGenerator < Rails::Generator::Base
+  include RestfulX::Configuration
+    
+  attr_reader :project_name, 
+              :flex_project_name, 
+              :base_package, 
+              :base_folder, 
+              :command_controller_name, 
+              :component_names, 
+              :application_tag,
+              :use_air,
+              :flex_root,
+              :base_flex_package,
+              :distributed
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @project_name, @flex_project_name, @command_controller_name, @base_package, @base_folder, 
+      @flex_root = extract_names
+    
+    @base_package = options[:base_flex_package] if options[:base_flex_package]
+    @base_folder = options[:base_flex_package].gsub('.', '/') if options[:base_flex_package]
+    @flex_root = options[:flex_root] if options[:flex_root]
+    @distributed = options[:distributed]
+    
+    # if we are updating main file only we probably want to maintain the type of project it is
+    if options[:main_only]
+      project_file_name = APP_ROOT + '/.project'
+      if File.exist?(project_file_name)
+        puts "Cannot combine -m (--main-app) and -a (--air) flags at the same time for an existing application.\n" << 
+          'If you want to convert to AIR, remove -m flag.' if options[:air_config]
+        @use_air = true if File.read(project_file_name) =~/com.adobe.flexbuilder.apollo.apollobuilder/m
+      else
+        puts "Flex Builder project file doesn't exist. You should run 'rx_config' with -a (--air) option " <<
+         "or no arguments first to generate primary project structure."
+        exit 0;
+      end
+    else
+      @use_air = options[:air_config]
+    end
+                    
+    if @use_air
+      @application_tag = 'WindowedApplication'
+    else
+      @application_tag = 'Application'
+    end
+        
+    @component_names = []
+    if File.exists?("#{flex_root}/#{base_folder}/views/generated")
+      @component_names = list_mxml_files("#{flex_root}/#{base_folder}/views/generated")
+    end
+  end
+
+  def manifest
+    record do |m|
+      m.file 'restfulx_tasks.rake', 'lib/tasks/restfulx_tasks.rake' if !options[:skip_tasks]
+      m.file 'flex.properties', '.flexProperties'
+      m.template 'restfulx.yml', 'config/restfulx.yml'
+      m.template 'restfulx.erb', 'config/initializers/restfulx.rb'
+      
+      m.template 'session_store_flash.erb', 'config/initializers/session_store_flash.rb' if RAILS_GEM_VERSION =~ /2.3/
+      
+      m.directory "#{flex_root}"
+      
+      if @use_air
+        m.template 'actionscriptair.properties', '.actionScriptProperties'
+        m.template 'projectair.properties', '.project'
+      else
+        m.template 'actionscript.properties', '.actionScriptProperties'
+        m.template 'project.properties', '.project'
+      end
+      
+      m.template 'project-textmate.erb', "#{project_name}.tmproj"
+      m.template 'mainapp.mxml', File.join("#{flex_root}", "#{flex_project_name}.mxml")
+      m.template 'mainapp-config.xml', File.join("#{flex_root}", "#{flex_project_name}-config.xml")
+      m.template 'mainair-app.xml', File.join("#{flex_root}", "#{flex_project_name}-app.xml") if @use_air
+
+      m.directory 'html-template/history'      
+      %w(index.template.html AC_OETags.js playerProductInstall.swf).each do |file|
+        m.file "html-template/#{file}", "html-template/#{file}"
+      end
+      
+      %w(history.css history.js historyFrame.html).each do |file|
+        m.file "html-template/history/#{file}", "html-template/history/#{file}"
+      end
+      
+      %w(views controllers commands models events helpers).each do |dir|
+        m.directory "#{flex_root}/#{base_folder}/#{dir}"
+      end
+      
+      m.directory "#{flex_root}/#{base_folder}/views/generated"
+      
+      framework_release = RestfulX::FRAMEWORK_VERSION
+      framework_distribution_url = "http://restfulx.github.com/releases/restfulx-#{framework_release}.swc"
+      framework_destination_file = "lib/restfulx-#{framework_release}.swc"
+      
+      if !options[:skip_framework] && !File.exist?(framework_destination_file)
+        puts "Fetching #{framework_release} framework binary from: #{framework_distribution_url} ..."
+        begin
+          framework_swc = open(framework_distribution_url).read
+        rescue
+          puts "ERROR: Unable to download and install #{framework_distribution_url}."
+          puts "Please check your internet connectivity and try again."
+          exit
+        end
+        open(framework_destination_file, "wb").write(framework_swc) unless framework_swc.blank?
+        puts "done. saved to #{framework_destination_file}"
+      end
+
+      m.file 'swfobject.js', 'public/javascripts/swfobject.js'
+      m.file 'expressInstall.swf', 'public/expressInstall.swf'
+      
+      m.file 'flex_controller.erb', 'app/controllers/flex_controller.rb'
+      
+      m.directory "app/views/flex"
+      
+      m.template 'index.erb', 'app/views/flex/index.html.erb'
+      
+      m.file 'routes.erb', 'config/routes.rb', :collision => :ask
+      
+      FileUtils.rm 'public/index.html' if File.exist?('public/index.html')
+              
+      m.dependency 'rx_controller', @args
+    end
+  end
+
+  protected
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("-a", "--air", "Configure AIR project instead of Flex. Flex is default.", 
+      "Default: false") { |v| options[:air_config] = v }
+    opt.on("--skip-framework", "Don't fetch the latest framework binary. You'll have to link/build the framework yourself.", 
+      "Default: false") { |v| options[:skip_framework] = v }
+    opt.on("--skip-tasks", "Don't install restfulx gem tasks hook into the project.", 
+      "Default: false") { |v| options[:skip_tasks] = v }
+    opt.on("--flex-root [FOLDER]", "Root folder for generated flex code.", 
+      "Default: app/flex") { |v| options[:flex_root] = v }
+    opt.on("--base-flex-package [PACKAGE]", "Base package for your application.", 
+      "Default: #{flex_project_name}") { |v| options[:base_flex_package] = v }
+    opt.on("--distributed", "Creates migrations, controllers and models that use UUIDs and are distribution ready", 
+      "Default: false") { |v| options[:distributed] = v }
+  end
+
+  def banner
+    "Usage: #{$0} #{spec.name}" 
+  end
+end

data/rails_generators/rx_config/templates/actionscript.properties

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<actionScriptProperties mainApplicationPath="<%= flex_project_name %>.mxml" version="3">
+<compiler additionalCompilerArguments="-locale en_US -keep-as3-metadata+=Resource,HasOne,HasMany,BelongsTo,DateTime,Lazy,Ignored,Nested" copyDependentFiles="true" enableModuleDebug="true" generateAccessible="false" htmlExpressInstall="true" htmlGenerate="true" htmlHistoryManagement="true" htmlPlayerVersion="9.0.28" htmlPlayerVersionCheck="true" outputFolderPath="public/bin" rootURL="http://localhost:3000/bin" sourceFolderPath="<%= flex_root %>" strict="true" useApolloConfig="false" verifyDigests="true" warn="true">
+  <compilerSourcePath/>
+  <libraryPath defaultLinkType="1">
+    <libraryPathEntry kind="4" path=""/>
+    <libraryPathEntry kind="1" linkType="1" path="lib"/>
+  </libraryPath>
+  <sourceAttachmentPath/>
+</compiler>
+<applications>
+  <application path="<%= flex_project_name %>.mxml"/>
+</applications>
+<modules/>
+<buildCSSFiles/>
+</actionScriptProperties>