sproutcore 0.9.0

data/frameworks/sproutcore/views/workspace.js

@@ -0,0 +1,170 @@
+// ========================================================================
+// SproutCore
+// copyright 2006-2007 Sprout Systems, Inc.
+// ========================================================================
+
+require('views/tab') ;
+require('foundation/routes') ;
+require('views/button') ;
+
+// A WorkspaceView is a type of tab view that looks for certain elements
+// inside the content object and then places those into similarly named
+// elements inside the receiver view.  (You can extend this with more
+// element areas by overriding the areas property.)
+SC.WorkspaceView = SC.TabView.extend({
+  
+  // override this if you need with the areas you want it to look for.  You
+  // must have elements with the class '.detail.NAME' inside the receiver
+  // view to match.
+  areas: ['head','master','detail','dialog','tail'],
+  
+  // override this with the names of your standard workspaces.  Any names
+  // found here will be converted into code that looks like this:
+  //
+  // fooTab: NAMESPACE.fooWorkspace.outletFor('#foo-workspace'),
+  // fooButton: SC.ButtonView.outletFor('#foo')
+  //
+  workspaces: [],
+  namespace: null,
+  
+  // used internally to configure the workspace view when you create it. 
+  // be sure to add any tabs/buttons you want.
+  elements: function() {
+    var view = this ;
+    var ret = [] ;
+    this.areas.each(function(area) {
+      var el = view.$C(area) ;
+      if (el) { 
+        view[area + 'Element'] = SC.ContainerView.viewFor(el); 
+        ret.push(el) ;
+      }
+    }) ;
+    return ret ;    
+  },
+  
+  replaceContent: function(newContent) {
+    var view = this ;
+    this.areas.each(function(area) {
+      var key = area + 'Element' ;
+      var newElement = newContent.get(key) ;      
+      var viewArea = view[key] ;
+      
+      // remove existing children
+      if (viewArea) {
+        viewArea.set('content',newElement) ;
+      } else {
+        console.log('WARNING: could not find view area: ' + key) ;
+      }
+    }) ;
+    
+    // if there was a prior content object, notify it that nowShowing has
+    // changed.
+    if (this._nowShowingContent) {
+      this._nowShowingContent.set('nowShowing',null) ;
+    }
+    newContent.set('nowShowing',this.get('nowShowing')) ;
+    this._nowShowingContent = newContent ;
+  },
+  
+  init: function() {
+    // before calling super, setup the automatically named workspaces.
+    if (this.namespace && this.workspaces && this.workspaces.length > 0) {
+      var view = this ; var ns = this.namespace ;
+      this.workspaces.each(function(key) {
+        key = key.toLowerCase() ;
+        var tab = window[ns][key.capitalize() + 'Workspace'] ;
+        if (tab && !(view[key + 'Tab'])) {
+          tab = tab.viewFor(key + '-workspace') ;
+          view[key + 'Tab'] = tab ;
+        }
+        
+        var button = $(key) ;
+        if (button) view[key + 'Button'] = SC._WorkspaceButton.viewFor(key,{
+          workspace: view, workspaceId: key
+        }) ;
+      }) ;
+    }
+    
+    // go ahead with the rest of this.
+    arguments.callee.base.call(this) ;
+    
+    this.elements = this.elements() ;
+    
+    // register workspace route. 
+    SC.Routes.addRoute(':workspace',this._showWorkspace.bind(this)) ; 
+  },
+  
+  _showWorkspace: function(params) { 
+    if (this._tabs[params.workspace]) {
+      this.beginPropertyChanges() ;
+      this.set('nowShowing',params.workspace) ;
+      this.set('options',params) ;
+      this.endPropertyChanges() ;
+    } else console.log('workspace not found: ' + params.workspace) ;
+  }
+  
+}) ;
+
+SC._WorkspaceButton = SC.ButtonView.extend({
+  workspace: null, workspaceId: null,
+  action: function() { SC.Routes.set('location',this.workspaceId); },
+  isSelectedObserver: function() {
+    var parent = this.parentNode ;
+    if (parent) Element.setClassName($(parent),'sel',this.get('isSelected'));
+  }.observes('isSelected') 
+}),
+
+// Elements that you want to have swapped in and out can be subclassed from
+// this.  Or, you can create your own object.  Any elements you want swapped
+// in and out need to be configured as a property named 'somethingElement'.
+SC.WorkspaceTab = SC.View.extend({
+
+  // ...................................
+  // PROPERTIES
+  // Override these with your own settings.
+  
+  // modify to include the areas you want loaded in this element.
+  areas: ['head','master','detail','dialog','tail'],
+
+  // the type of view you want your found elements converted into.  If you
+  // set this to null, the elements will not be converted.
+  viewType: SC.View,
+
+  // Set this to something non-null to show the title in the window.
+  title: null,
+  
+  // this should be the portion of the location the user needs to put after
+  // the hash to get this workspace to show again in this configuration.
+  location: null,
+  
+  // this property will be set by the UI when the user types into the search
+  // field.  You can observe this property to update your content accordingly.
+  filterString: null,
+
+  // if this workspace is visible, then this property will be set to the
+  // id used to show this workspace.  It will be set back to null when 
+  // the workspace is hidden.
+  nowShowing: null,
+
+  // ...................................
+  // PRIVATE
+  //
+  elements: function() {
+    var view = this ;
+    var ret = [] ;
+    this.areas.each(function(area) {
+      var el = view.$C(area,1) ;
+      if (el) {
+        if (this.viewType) el = this.viewType.viewFor(el) ;
+        view[area + 'Element'] = el ; ret.push(el) ;
+      }
+    }) ;
+    return ret ;
+  },
+  
+  init: function() {
+    arguments.callee.base.apply(this,arguments) ;
+    this.elements = this.elements() ;
+  }
+  
+}) ;

data/generators/client/README

@@ -0,0 +1,3 @@
+Your new SproutCore client application has been created.  To access your application, just start sc_sever and visit your client name in the web browser.
+
+If you want to change the deployment settings for the application, add a section for your client in your environment.yaml.

data/generators/client/USAGE

@@ -0,0 +1,12 @@
+client - Generates a new SproutCore client
+
+USAGE: 
+
+  ./script/generate sc_client client_name
+
+DISCUSSION:
+
+This generator will create a new SproutCore-based JavaScript application.  After the generator completes, you will be able to begin work immediately.
+
+The code created by this generator will appear in a /clients directory.  To add models, views, and controllers, you can use the additional generators sc_model, sc_controller, sc_object_controller, sc_collection_controller, and sc_view.
+

data/generators/client/client_generator.rb

@@ -0,0 +1,53 @@
+require 'sproutcore/generator_helper'
+
+class ClientGenerator < RubiGen::Base
+
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'clients'
+      apply_template(m,"clients/#{@name}")
+      m.readme '../README'
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/client/templates/core.js

@@ -0,0 +1,19 @@
+// ==========================================================================
+// <%= class_name %>
+// ==========================================================================
+
+<%= class_name %> = SC.Object.create({
+
+  // This will create the server for your application.  Add any namespaces
+  // your model objects are defined in to the prefix array.
+  server: SC.Server.create({ prefix: ['<%= class_name %>'] }),
+
+  // When you are in development mode, this array will be populated with 
+  // any fixtures you create for testing and loaded automatically in your
+  // main method.  When in production, this will be an empty array.
+  FIXTURES: [],
+
+  // Any keys in this array will be instantiated automatically from main.
+  controllers: [],
+  
+}) ;

data/generators/client/templates/english.lproj/body.rhtml

@@ -0,0 +1,3 @@
+<% content_for('body') do %>
+<h1>Welcome to SproutCore</h1>
+<% end %>

data/generators/client/templates/english.lproj/strings.js

@@ -0,0 +1,14 @@
+// ==========================================================================
+// <%= class_name %> English Strings
+// ==========================================================================
+
+// Place strings you want to localize here.  In your app, use the key and 
+// localize it using "key string".loc().  HINT: For your key names, use the
+// english string with an underscore in front.  This way you can still see
+// how your UI will look and you'll notice right away when something needs a
+// localized string added to this file!
+//
+Object.extend(String.English,{
+  // "_String Key": "Localized String"
+}) ;
+

data/generators/client/templates/main.js

@@ -0,0 +1,37 @@
+// ==========================================================================
+// <%= class_name %>
+// ==========================================================================
+
+// This is the function that will start your app running.  The default 
+// implementation will load any fixtures you have created then instantiate
+// your controllers and awake the elements on your page.
+//
+// As you develop your application you will probably want to override this.
+// See comments for some pointers on what to do next.
+//
+function main() {
+  
+  // Step 1: Load Your Model Data
+  // The default code here will load the fixtures you have defined.
+  // Comment out the preload line and add something to refresh from the server
+  // when you are ready to pull data from your server.
+  <%= class_name %>.server.preload(<%= class_name %>.FIXTURES) ;
+
+  // TODO: refresh() any collections you have created to get their records.
+  // ex: <%= class_name %>.contacts.refresh() ;
+  
+  // Step 2: Instantiate Your Views
+  // The default code just activates all the views you have on the page. If
+  // your app gets any level of complexity, you should just get the views you
+  // need to show the app in the first place, to speed things up.
+  SC.page.awake() ;
+
+  // Step 3. Set the content property on your primary controller.  
+  // This will make your app come alive!
+  
+  // TODO: Set the content property on your primary controller
+  // ex: <%= class_name %>.contactsController.set('content',<%= class_name %>.contacts);
+  
+} ;
+
+

data/generators/controller/USAGE

@@ -0,0 +1,16 @@
+sc_controller - Create a new controller object in your SproutCore client.
+
+USAGE:
+
+  ./script/generate controller client_name/controller_name [CLASS]
+  
+DISCUSSION:
+
+This generator will create a new SproutCore object in your client for us as a controller.  You should pass as the first parameter your client directory name/the controller you want to create.  For example:
+
+./script/generate controller todos/task
+
+defines a new object called Todos.taskController in the file clients/todos/controllers/task.js.
+
+This generator creates objects that inherit from SC.Object. You can override this by passing a classname as the second parameter.  You can also use the specialize sc_object_controller and sc_collection_controller generators to create those specific types of controllers.
+

data/generators/controller/controller_generator.rb

@@ -0,0 +1,51 @@
+require 'sproutcore/generator_helper'
+
+class ControllerGenerator < RubiGen::Base
+  
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name, :client_location
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      fp = client_file_path('controllers','js','controller')
+      build_client_directories(m, fp)
+      m.template 'controller.js', fp
+      
+      fp = client_file_path('tests/controllers', 'rhtml')
+      build_client_directories(m, fp)
+      m.template 'test.rhtml', fp
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a SproutCore controller objects
+
+USAGE: #{$0} #{spec.name} client_name/controller_name [ClassName]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.on("-l", '--loc="Location"', String, "Location of build. If not passed, search clients and frameworks dirs", "Default: none") { |options[:loc]| }
+    end
+    
+    def extract_options
+      @client_location = options[:loc]
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/controller/templates/controller.js

@@ -0,0 +1,21 @@
+// ==========================================================================
+// <%= controller_class_name %>
+// ==========================================================================
+
+require('core');
+
+/** @class
+
+  (Document Your View Here)
+
+  @extends <%= base_class_name 'SC.Object' %>
+  @author    AuthorName  
+  @version 0.1
+  @static
+*/
+<%= controller_instance_name %> = <%= base_class_name 'SC.Object' %>.create(
+/** @scope <%= controller_instance_name %> */ {
+  
+  // TODO: Add your own code here.
+  
+}) ;

data/generators/controller/templates/test.rhtml

@@ -0,0 +1,21 @@
+<%% # ========================================================================
+   # <%= controller_class_name %> Unit Test
+   # ========================================================================
+%>
+<%% content_for('final') do %>
+
+<script>
+
+Test.context("<%= controller_class_name %>",{
+
+  "TODO: Add your own tests here": function() {
+    true.shouldEqual(true) ;
+  }
+
+}) ;
+
+appMain = main; main = null ; // Cancel main() so app does not start
+
+</script>
+
+<%% end %>

data/generators/framework/README

@@ -0,0 +1,7 @@
+Your new framework has been created.  To include it in your clients, be sure to edit your environments.yml file, adding someting like this:
+
+all:
+  requires: [<%= name %>]
+
+Then restart your sc_server and you should be ready to go.
+

data/generators/framework/USAGE

@@ -0,0 +1,12 @@
+framework - Generates a new SproutCore framework
+
+USAGE: 
+
+  ./script/generate framework framework_name
+
+DISCUSSION:
+
+This generator will create a new SproutCore-based JavaScript framework for use by other SproutCore clients.  After the generator completes, you will need to add it as a requirement to your configuration.yml.
+
+The code created by this generator will appear in a /frameworks directory.  To add models, views, and controllers, you can use the additional generators model, controller, object_controller, collection_controller, and view.
+

data/generators/framework/framework_generator.rb

@@ -0,0 +1,53 @@
+require 'sproutcore/generator_helper'
+
+class FrameworkGenerator < RubiGen::Base
+
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'frameworks'
+      apply_template(m,"frameworks/#{@name}")
+      m.readme '../README'
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a SproutCore framework
+
+USAGE: #{$0} #{spec.name} framework_name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/framework/templates/core.js

@@ -0,0 +1,20 @@
+// ==========================================================================
+// <%= class_name %> Framework
+// ==========================================================================
+
+<%= class_name %> = SC.Object.create({
+  
+  // When you are in development mode, this array will be populated with 
+  // any fixtures you create for testing and loaded automatically in your
+  // main method.  When in production, this will be an empty array.
+  //
+  // You will use this most often when running unit tests in dev mode.
+  //
+  FIXTURES: [],
+  
+  // Add any global constants or other properties used by the entire
+  // framework:
+  // CONSTANT_NAME:  'some-value'
+
+
+}) ;

data/generators/framework/templates/english.lproj/body.rhtml

@@ -0,0 +1,3 @@
+<% content_for('body') do %>
+<h1>Welcome to SproutCore</h1>
+<% end %>

data/generators/framework/templates/english.lproj/strings.js

@@ -0,0 +1,14 @@
+// ==========================================================================
+// <%= class_name %> English Strings
+// ==========================================================================
+
+// Place strings you want to localize here.  In your app, use the key and 
+// localize it using "key string".loc().  HINT: For your key names, use the
+// english string with an underscore in front.  This way you can still see
+// how your UI will look and you'll notice right away when something needs a
+// localized string added to this file!
+//
+Object.extend(String.English,{
+  // "_String Key": "Localized String"
+}) ;
+

data/generators/language/USAGE

@@ -0,0 +1,16 @@
+sc_view - Create a new view class in your SproutCore client.
+
+USAGE:
+
+  ./script/generate view client_name/view_name [CLASS]
+  
+DISCUSSION:
+
+This generator will create a new SproutCore view class in your client.  You should pass as the first parameter your client directory name/the view you want to create.  For example:
+
+./script/generate view todos/task
+
+defines a new class called Todos.TaskView in the file clients/todos/views/task.js.
+
+This generator creates view that inherit from SC.View but you can override this by passing the name of the view class you want as the second argument.
+

data/generators/language/language_generator.rb

@@ -0,0 +1,47 @@
+require 'sproutcore/generator_helper'
+
+class LanguageGenerator < RubiGen::Base
+  
+  include SproutCore::GeneratorHelper
+  
+  default_options :author => nil
+  
+  attr_reader :name, :client_location
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    assign_names!(@name)
+  end
+
+  def manifest
+    record do |m|
+      fp = client_file_path("#{file_path}.lproj",'js', nil, "#{file_path}/strings")
+      build_client_directories(m, fp)
+      m.template 'strings.js', fp
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Adds a language to a SproutCore project
+
+USAGE: #{$0} #{spec.name} client_name/language_name [ClassName]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.on("-l", '--loc="Location"', String, "Location of build. If not passed, search clients and frameworks dirs", "Default: none") { |options[:loc]| }
+    end
+    
+    def extract_options
+      @client_location = options[:loc]
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/language/templates/strings.js

@@ -0,0 +1,10 @@
+// ==========================================================================
+// <%= client_namespace %> <%= file_name.capitalize %> Strings
+// ==========================================================================
+
+// HINT: For your key names, use the english string with an underscore in 
+// front.
+Object.extend(String.<%= file_name.capitalize %>,{
+  // "_String Key": "Localized String"
+}) ;
+

data/generators/model/USAGE

@@ -0,0 +1,24 @@
+model - Create a new model class in your SproutCore client.
+
+USAGE:
+
+  ./script/generate model client_name/model_name [MODEL_CLASS]
+  
+DISCUSSION:
+
+This generator will create a new SproutCore model file in your client or framework.  You should pass as the first parameter your client or framework directory name/the model you want to create.  For example:
+
+./script/generate model todos/task
+
+defines a new class called Todos.Task in the file clients/todos/models/task.js.
+
+Likewise:
+
+./script/generate model frameworks/shared/task
+
+defines a new class called Shared.Task in the file frameworks/shared/models/task.js
+
+This generator creates classes that inherit from SC.Record but you can override this by passing the name of the view class you want as the second argument.
+
+In addition to creating a model class, this will also create a stub for you to add Fixture data.  This is a convenient way to preload your application with data while you develop the client but have not yet connected to your server.
+