ruboss4ruby 1.0.5 → 1.1.0

data/app_generators/ruboss_app/templates/project-textmate.erb

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>currentDocument</key>
+	<string>app/flex/<%= project_name %>.mxml</string>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string><%= project_name.underscore %></string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+  <key>fileHierarchyDrawerWidth</key> 
+  <integer>299</integer> 
+  <key>metaData</key> 
+  <dict/> 
+  <key>openDocuments</key>
+  <array>
+    <string>app/flex/<%= project_name %>.mxml</string>
+  </array>
+	<key>shellVariables</key>
+	<array>
+		<dict>
+			<key>enabled</key>
+			<true/>
+			<key>value</key>
+			<string>app/flex/<%= project_name %>.mxml</string>
+			<key>variable</key>
+			<string>TM_FLEX_FILE_SPECS</string>
+		</dict>
+		<dict>
+			<key>enabled</key>
+			<true/>
+			<key>value</key>
+			<string>public/bin/<%= project_name %>.swf</string>
+			<key>variable</key>
+			<string>TM_FLEX_OUTPUT</string>
+		</dict>
+	</array>
+  <key>showFileHierarchyDrawer</key>
+  <false/>
+  <key>windowFrame</key>
+  <string>{{5, 15}, {1073, 860}}</string>
+</dict>
+</plist>

data/bin/ruboss-gen

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+#  Generates the primary Ruboss project directory structure and 
+#  sets up Flex Builder and TextMate specific descriptor files
+#     
+#  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:
+#     `ruboss-gen pomodo` # generates project structure and a 
+#                         # default Flex app configuration.
+#     `ruboss-gen -a pomodo` # as above but generates an AIR app
+#                            # and configuration
+#                            
+# Next Steps:
+#     In your new Ruboss project folder run `ruby script/generate` for
+#     a list of available generators.
+
+require 'rubygems'
+require 'rubigen'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ruboss4ruby')
+
+if %w(-v --version).include? ARGV.first
+  puts "#{File.basename($0)} #{Ruboss4Ruby::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+RubiGen::Base.use_application_sources!
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'ruboss_app')

data/generators/ruboss_config/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Fetches the latest published Ruboss Framework SWC file.
+
+Examples:
+    `./script/generate ruboss_config`

data/generators/ruboss_config/ruboss_config_generator.rb

@@ -0,0 +1,19 @@
+require 'open-uri'
+
+class RubossConfigGenerator < RubiGen::Base
+  include Ruboss4Ruby::Configuration
+
+  def manifest
+    record do |m|        
+      framework_release = Ruboss4Ruby::RUBOSS_FRAMEWORK_VERSION
+      framework_distribution_url = "http://ruboss.com/releases/ruboss-#{framework_release}.swc"
+      framework_destination_file = "lib/ruboss-#{framework_release}.swc"
+      
+      if !options[:skip_framework] && !File.exist?(framework_destination_file)
+        puts "fetching #{framework_release} framework binary from: #{framework_distribution_url} ..."
+        open(framework_destination_file, "wb").write(open(framework_distribution_url).read)
+        puts "done. saved to #{framework_destination_file}"
+      end
+    end
+  end
+end

data/generators/ruboss_controller/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Generates/updates the main Flex application controller, typically
+    app/flex/<yourappname>/controllers/ApplicationController.as
+    
+    It pulls out all available models and commands from respective
+    folders and makes sure they'll be pulled into the Flex application
+    at runtime. Doesn't require any arguments or options.
+
+Examples:
+    `./script/generate ruboss_controller`

data/generators/ruboss_controller/ruboss_controller_generator.rb

@@ -0,0 +1,38 @@
+class RubossControllerGenerator < RubiGen::Base
+  include Ruboss4Ruby::Configuration
+  
+  attr_reader :project_name, 
+              :flex_project_name, 
+              :base_package, 
+              :base_folder, 
+              :command_controller_name,
+              :model_names, 
+              :command_names
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @project_name, @flex_project_name, @command_controller_name, 
+      @base_package, @base_folder = extract_names
+    
+    @model_names = list_as_files("app/flex/#{base_folder}/models")
+    @command_names = list_as_files("app/flex/#{base_folder}/commands")
+  end
+
+  def manifest
+    record do |m|
+      m.template 'controller.as.erb', File.join("app/flex/#{base_folder}/controllers", 
+        "#{command_controller_name}.as")
+      if options[:gae]
+        m.file 'restful.py', 'app/controllers/restful.py' if !File.exist?('app/controllers/restful.py')
+        m.file 'assist.py', 'app/models/assist.py' if !File.exist?('app/models/assist.py')
+      end
+    end
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--gae", "Generate Google App Engine Python classes in addition to Ruboss Flex resources.", 
+      "Default: false") { |v| options[:gae] = v }
+  end
+end

data/generators/ruboss_controller/templates/assist.py

@@ -0,0 +1,65 @@
+# The MIT License
+# 
+# Copyright (c) 2008 Dima Berastau
+# 
+# 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.
+
+__author__ = 'Dima Berastau'
+
+from google.appengine.ext import db
+import datetime
+
+# Some useful module methods
+def all(model):
+  items = "".join(str(item.to_xml()) for item in model.all())
+  if items == "":
+    return '<entities type="array"/>'
+  else:
+    return '<entities kind="%s" type="array">%s</entities>' % (model.kind(), items)
+
+def update_model_from_params(model, params):
+  for k, v in params.items():
+    if k.endswith("_id"):
+      if v == "":
+        setattr(model, k.replace("_id", ""), None)
+      else:
+        setattr(model, k.replace("_id", ""), db.Key(v))
+    elif hasattr(model, k):
+      if isinstance(getattr(model, k), bool):
+        if v == "false" or v == "":
+          setattr(model, k, False)
+        else:
+          setattr(model, k, True)
+      elif isinstance(getattr(model, k), float) and v != "":
+        setattr(model, k, float(v))
+      elif isinstance(getattr(model, k), int) and v != "":
+        setattr(model, k, int(v))
+      elif isinstance(getattr(model, k), datetime.datetime) and v != "":
+        value = datetime.datetime.strptime(v, "%Y-%m-%dT%H:%M:%S")
+        setattr(model, k, value)
+      elif isinstance(getattr(model, k), datetime.date) and v != "":
+        value = datetime.datetime.strptime(v, "%Y-%m-%d")
+        setattr(model, k, datetime.date(value.year, value.month, value.day))
+      elif isinstance(getattr(model, k), datetime.time) and v != "":
+        value = datetime.datetime.strptime(v, "%Y-%m-%dT%H:%M:%S")
+        setattr(model, k, datetime.time(value.hour, value.minute, value.second))
+      else:
+        setattr(model, k, v)
+
+  model.put()

data/{merb_generators/templates/ruboss_controller → generators/ruboss_controller/templates}/controller.as.erb

@@ -1,20 +1,22 @@
 package <%= base_package %>.controllers {
   import <%= base_package %>.models.*;
   import <%= base_package %>.commands.*;
-	
+
+	import mx.core.Application;		
   import org.ruboss.Ruboss;
-  import org.ruboss.controllers.RubossCommandsController;
+  import org.ruboss.controllers.RubossApplicationController;
   import org.ruboss.utils.RubossUtils;
 
-  public class <%= command_controller_name %> extends RubossCommandsController {
+  public class <%= command_controller_name %> extends RubossApplicationController {
     private static var controller:<%= command_controller_name %>;
     
     public static var models:Array = [<%= model_names %>]; /* Models */
     
+    public static var commands:Array = [<%= command_names %>]; /* Commands */
+    
     public function <%= command_controller_name %>(enforcer:SingletonEnforcer, extraServices:Array,
       defaultServiceId:int = -1) {
-      super([<%= command_names %>] /* Commands */, 
-        models, extraServices, defaultServiceId);
+      super(commands, models, extraServices, defaultServiceId);
     }
     
     public static function get instance():<%= command_controller_name %> {
@@ -27,7 +29,6 @@ package <%= base_package %>.controllers {
       if (!RubossUtils.isEmpty(airDatabaseName)) Ruboss.airDatabaseName = airDatabaseName;
       controller = new <%= command_controller_name %>(new SingletonEnforcer, extraServices,
         defaultServiceId);
-      Ruboss.commands = controller;
     }
   }
 }

data/generators/ruboss_controller/templates/restful.py

@@ -0,0 +1,136 @@
+# The MIT License
+# 
+# Copyright (c) 2008 William T. Katz
+# 
+# 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.
+ 
+"""
+RESTful Controller
+ 
+We want our RESTful controllers to simply throw up their hands if they get
+an unhandled HTTP verb.  This is better for rich clients and server load
+than throwing back lots of useless HTML.
+ 
+These inherited methods should be overridden if there's a chance a human
+browser is involved.
+ 
+TODO: Return more information HTTP status codes that won't autotrip 
+browser login forms.  For example, return status 405 (Method not allowed) 
+with an Allow header containing the list of valid methods.
+"""
+__author__ = 'William T. Katz'
+ 
+from google.appengine.ext import webapp
+ 
+import logging
+ 
+# Some useful module methods
+def send_successful_response(handler, response):
+    logging.debug("Sending successful response: %s", response)
+    handler.response.headers["Content-Type"] = "application/xml"
+    handler.response.out.write('<?xml version="1.0" encoding="UTF-8"?>')
+    handler.response.out.write(response)
+    
+def get_model_key(handler):
+  return handler.request.path_info.split("/").pop().replace(".xml", "")
+ 
+def get_sent_properties(request_func, propname_list):
+    """
+    This maps request strings to values in a hash, optionally run through 
+    a function with previous request values as parameters to the func.
+    1) key -> just read in the corresponding request value
+    2) tuple (key, func) -> Read the request value for the string key
+        and pass it through func
+    3) tuple (key, func, additional keys...) -> Get the request
+        values for the additional keys and pass them through func
+        before setting the key's value with the output.
+    If a key is not present in the request, then we do not insert a key
+    with None or empty string.  The key is simply absent, therefore allowing
+    you to use the returned hash to initial a Model instance.
+    """
+    prop_hash = {}
+    for item in propname_list:
+        if isinstance(item, basestring):
+            key = item
+            value = request_func(item)
+        elif isinstance(item, tuple):
+            key = item[0]
+            prop_func = item[1]
+            if len(item) <= 2:
+                value = prop_func(request_func(key))
+            else:
+                try:
+                    addl_keys = map(prop_hash.get, item[2:])
+                    value = prop_func(*addl_keys)
+                except:
+                    return None
+        if value:
+            prop_hash[key] = value
+    return prop_hash
+ 
+def methods_via_query_allowed(handler_method):
+    """
+    A decorator to automatically re-route overloaded POSTs
+    that specify the real HTTP method in a _method query string.
+ 
+    To use it, decorate your post method like this:
+ 
+    import restful
+    ...
+    @restful.methods_via_query_allowed
+    def post(self):
+      pass
+ 
+    The decorator will check for a _method query string or POST argument,
+    and if present, will redirect to delete(), put(), etc.
+    """
+    def redirect_if_needed(self, *args, **kwargs):
+        real_verb = self.request.get('_method', None)
+        if not real_verb and 'X-HTTP-Method-Override' in self.request.environ:
+            real_verb = self.request.environ['X-HTTP-Method-Override']
+        if real_verb:
+            logging.debug("Redirected from POST. Detected method override = %s", real_verb)
+            method = real_verb.upper()
+            if method == 'HEAD':
+                self.head(*args, **kwargs)
+            elif method == 'PUT':
+                self.put(*args, **kwargs)
+            elif method == 'DELETE':
+                self.delete(*args, **kwargs)
+            elif method == 'TRACE':
+                self.trace(*args, **kwargs)
+            elif method == 'OPTIONS':
+                self.head(*args, **kwargs)
+            # POST and GET included for completeness
+            elif method == 'POST':
+                self.post(*args, **kwargs)
+            elif method == 'GET':
+                self.get(*args, **kwargs)
+            else:
+                self.error(405)
+        else:
+            handler_method(self, *args, **kwargs)
+    return redirect_if_needed
+ 
+class Controller(webapp.RequestHandler):
+    def get(self, *params):
+        self.redirect("/403.html")
+ 
+    def head(self, *params):
+        pass

data/generators/ruboss_main_app/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Refreshes main Flex/AIR application file to make sure that
+    any of the generated components are included. Warning,
+    this will wipe your main application file. Used mostly
+    during code generation phase.
+
+Examples:
+    `./script/generate ruboss_main_app`

data/generators/ruboss_main_app/ruboss_main_app_generator.rb

@@ -0,0 +1,60 @@
+class RubossMainAppGenerator < RubiGen::Base
+  include Ruboss4Ruby::Configuration
+  
+  attr_reader :project_name, 
+              :flex_project_name, 
+              :base_package, 
+              :base_folder, 
+              :command_controller_name,
+              :model_names, 
+              :component_names,
+              :controller_names,
+              :use_air,
+              :use_gae,
+              :application_tag
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @project_name, @flex_project_name, @command_controller_name, @base_package, @base_folder = extract_names
+
+    project_file_name = APP_ROOT + '/.project'
+    if File.exist?(project_file_name)
+      @use_air = true if File.read(project_file_name) =~/com.adobe.flexbuilder.apollo.apollobuilder/m
+    end
+
+    if @use_air
+      @application_tag = 'WindowedApplication'
+    else
+      @application_tag = 'Application'
+    end
+
+    @component_names = []
+    if File.exists?("app/flex/#{base_folder}/components/generated")
+      @component_names = list_mxml_files("app/flex/#{base_folder}/components/generated")
+    end
+    
+    @controller_names = []
+    if options[:gae] && File.exists?("app/controllers")
+      @use_gae = true
+      @controller_names = 
+        Dir.entries("app/controllers").grep(/\.py$/).delete_if { |name| name == "__init__.py" || name == "restful.py" }.map { |name| name.sub(/\.py$/, "") }
+    end
+  end
+
+  def manifest
+    record do |m|      
+      m.template 'mainapp.mxml', File.join('app', 'flex', "#{project_name}.mxml")
+      if options[:gae]
+        m.template 'main.py.erb', 'main.py'
+      end
+    end
+  end
+
+  protected
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--gae", "Generate Google App Engine Python classes in addition to Ruboss Flex resources.", 
+      "Default: false") { |v| options[:gae] = v }
+  end
+end

data/generators/ruboss_main_app/templates/main.py.erb

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+
+import logging
+import wsgiref.handlers
+
+from google.appengine.api import users
+from google.appengine.ext import webapp
+from google.appengine.ext.webapp.util import run_wsgi_app
+from app.controllers import <%= controller_names.join(", ") %>
+
+class AppController(webapp.RequestHandler):
+  def get(self):
+    self.redirect("/public/index.html")
+
+def main():
+  application = webapp.WSGIApplication(
+  [('/*$', AppController), 
+<% for component in controller_names -%>
+<% if component == controller_names.last -%>
+  ('/<%= component %>.*', <%= component %>.Controller)
+<% else -%>
+  ('/<%= component %>.*', <%= component %>.Controller),
+<% end -%>
+<% end -%>
+  ], debug=True)
+  wsgiref.handlers.CGIHandler().run(application)
+
+if __name__ == '__main__':
+  main()

data/generators/ruboss_main_app/templates/mainapp.mxml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<mx:<%= application_tag %> xmlns:mx="http://www.adobe.com/2006/mxml"
+  xmlns:generated="<%= base_package %>.components.generated.*"
+  paddingBottom="8" paddingLeft="8" paddingRight="8" paddingTop="8"
+  layout="horizontal" styleName="plain" initialize="init()">
+  <mx:Script>
+    <![CDATA[
+<% if use_air -%>
+      import org.ruboss.services.air.AIRServiceProvider;
+<% end -%>
+<% if use_gae -%>
+      import org.ruboss.services.http.GAEHTTPServiceProvider;
+<% end -%>
+      import <%= base_package %>.controllers.<%= command_controller_name %>;
+
+      private function init():void {
+<% if use_air -%>
+        <%= command_controller_name %>.initialize([AIRServiceProvider], AIRServiceProvider.ID, "<%= base_package %>");
+<% elsif use_gae -%>
+        <%= command_controller_name %>.initialize([GAEHTTPServiceProvider], GAEHTTPServiceProvider.ID);
+<% else -%>
+        <%= command_controller_name %>.initialize();
+<% end -%>
+      }
+    ]]>
+  </mx:Script>
+  <mx:LinkBar dataProvider="{mainViewStack}" direction="vertical" borderStyle="solid" backgroundColor="#EEEEEE"/>
+  <mx:ViewStack id="mainViewStack" width="100%" height="100%">
+    <!-- For a simple demo, put all the components here. -->
+<% for component in component_names -%>
+    <generated:<%= component %>/>
+<% end -%>
+  </mx:ViewStack>
+</mx:<%= application_tag %>>
+

data/generators/ruboss_scaffold/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Scaffolds an entire Ruboss resources. The resource is ready to use as a
+    starting point for your restful, resource-oriented application.
+    
+    ruboss_scaffold :
+      1. Generates all required Flex code.
+      2. You can pass special belongs_to, has_one and has_many attributes
+         to generate appropriate relationships.
+
+    Pass the name of the model, either CamelCased or under_scored, as the first
+    argument, and an optional list of attribute pairs.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+    
+    The syntax for belongs_to, has_one and has_many attributes is as follows:
+      belongs_to:<relationship_name> or
+      belongs_to:<relationship_name>,<another_relationship>,<and_another>
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+    For example, `ruboss_scaffold post title:string body:text published:boolean`
+    gives you a model with those three attributes.
+
+Examples:
+    `./script/generate ruboss_scaffold project name:string has_many:tasks`
+    `./script/generate ruboss_scaffold task name:string belongs_to:project`