maccman-bowline 0.3.9 → 0.4.0

data/README.txt

@@ -12,7 +12,24 @@ Ruby desktop application framework
 * Uses Webkit
 * View in HTML/JavaScript
 * Binding between HTML & Ruby
-* Will be cross platform (though only OSX atm)
+* Cross platform (osx/linux/windows)
+
+= INTRODUCTION
+
+If you've ever wished creating a desktop application was as simple
+as creating a Rails website you'll be interested in Bowline.
+
+Bowline lets you take your existing skills and apply them to the desktop.
+You can write apps in HTML/JavaScript/Ruby without having to worry about
+different platforms or a complex GUI API.
+
+Compared to existing Ruby desktop frameworks, such as Shoes, Bowline's strengths
+are its adherence to MVC and use of HTML/JavaScript. We think that, although Ruby is 
+a great language for the backend, the view should be written in languages designed 
+for that purpose, HTML and JavaScript.
+
+Bowline also takes inspiration from Flex through its binders. Bowline will bind 
+up Ruby and HTML - letting you concentrate on the more interesting things.
 
 = CONTACT
 
@@ -20,34 +37,132 @@ info@eribium.org
 http://eribium.org
 http://twitter.com/maccman
 
-= Usage - Building a basic Twitter client
+= INSTALLATION
 
 Install the Titanium SDK:
-http://www.appcelerator.com/products/download-titanium/download/
+  http://www.appcelerator.com/products/download-titanium/download/
 
 Install the gem:
 >> sudo gem install maccman-bowline --source http://gems.github.com
 
-Run the app/binder generators:
->> bowline-gen app bowline_twitter
->> cd bowline_twitter
->> bowline-gen binder tweets
+= USAGE
+
+See the Twitter example at the end of this document, 
+or browse the completed version here:
+  http://github.com/maccman/bowline-twitter
 
-Copy tweets.rb from examples to app/binders/tweets.rb
-Add your Twitter credentials to tweets.rb - in this simple example they're not dynamic.
+= GENERATING
 
-Copy twitter.html from examples to public/index.html
+Using the bowline-gen binary (installed with Bowline) you can generate the following things:
+  app                              Generates a new application.
+  binder                           Generates a new binder, either a collection one, or a singleton one.
+  helper                           Generates a new helper.
+  migration                        Generates a new database migration.
+  model                            Generates a new model.
+  
+Run 'bowline-gen --help' for more information.
 
-Install the Twitter gem:
->> sudo gem install twitter
+= COMMANDS
 
-Add the Twitter gem to config/environment.rb: 
-   config.gem "twitter"
+App console:
+>> script/console
 
-run:
+Run application:
 >> script/run
 
-That's it
+= BINDERS
+
+Binders are the core of Bowline, they're classes that you can bind HTML to.
+This means, if you can data in the class, the HTML also automatically changes.
+It's a one way relationship though.
+
+You can think of binders as similar to controllers in Rails.
+
+There are two types of binders, singleton and collection.
+Singleton binders are for a single data entity, such as the current logged in user.
+And it goes without saying that collection binders are for an array of data.
+
+You can create a collection binder like this:
+>> bowline-gen binder users --type collection
+
+Which will generate code a bit like this:
+  module Binders
+    class Users < Bowline::Collection
+    end
+  end
+
+Now, in the view you can bind HTML to this collection, by
+using the following javascript:
+  $('#users').bowline('users');
+  
+You should probably become familiar with Chain.js (which bowline uses for binding): http://wiki.github.com/raid-ox/chain.js/
+
+Suffice to say, the HTML looks a bit like this:
+  <div id="users">
+    <div class="item">
+      <span class="name"></span>
+      <span class="email"></span>
+      <a href="#" class="destroy">Delete</a>
+    </div>
+  </div>
+
+Now, were you to have a user object, you could do something like
+this to update the HTML.
+
+Binders::Users.items = [User.first]
+
+= METHODS IN BINDERS
+
+You can call both class and instance methods of the binders.
+Following on from the above example with 'users', you could call a class
+method called 'admins' on the users binder like so:
+
+$('#users').invoke('admins')
+
+It's the same syntax for invoking instance methods, just called
+on one of the individual users:
+
+$('#users div:first').invoke('instance_method', 'arg1')
+
+= HELPERS
+
+Helpers are similar to helpers in Rails - they're helper methods for the view which
+don't need a full blown binder to cater for.
+
+You can call helpers with JavaScript like so:
+$.bowline.helper('name', 'arg1', ['arg2'])
+
+= MODELS
+
+Bowline plans to fully support ActiveRecord and the Sqlite3 database.
+This is still in development though.
+
+= THEMES
+
+The Cappuccino Aristo theme has been specially customized for Bowline, you can see
+examples of it in the Twitter client, and find it here:
+  http://github.com/maccman/aristo
+  
+= TITANIUM
+
+Bowline is built on top of Titanium, an open source cross platform framework for desktop apps.
+You can use any of the Titanium api methods in Ruby and JavaScript, like this:
+  Titanium.UI.currentWindow.close
+
+Site: http://www.appcelerator.com/products/titanium-desktop/
+API Docs: http://www.codestrong.com/titanium/api/
+
+= BUILDING
+
+Once your app is complete, you should run the following command
+to make sure all the gems required (including Bowline) have been vendorised:
+  rake gems:sync
+
+Then, run:
+  rake app
+
+You can only build distributions for your local platform, but
+using the Titanium Developer app you can build on all three platforms.
 
 = EXAMPLES
 
@@ -137,3 +252,33 @@ Usage for a collection (of users):
     <a href="#" id="showAdmins">Show admins</a>
   </body>
   </html>
+
+= Building a basic Twitter client
+
+  Install the Titanium SDK:
+  http://www.appcelerator.com/products/download-titanium/download/
+
+  Install the gem:
+  >> sudo gem install maccman-bowline --source http://gems.github.com
+
+  Run the app/binder generators:
+  >> bowline-gen app bowline_twitter
+  >> cd bowline_twitter
+  >> bowline-gen binder tweets
+
+  Copy tweets.rb from examples to app/binders/tweets.rb
+  Add your Twitter credentials to tweets.rb - in this simple example they're not dynamic.
+
+  Copy twitter.html from examples to public/index.html
+
+  Install the Twitter gem:
+  >> sudo gem install twitter
+
+  Add the Twitter gem to config/environment.rb: 
+     config.gem "twitter"
+
+  run:
+  >> script/run
+
+  That's it. You can see a snazzed up version here:
+  http://github.com/maccman/bowline-twitter

data/VERSION

@@ -1 +1 @@
-0.3.9
+0.4.0

data/assets/jquery.bowline.js

@@ -1,21 +1,24 @@
 (function($){
   var init = false;
+  var TI = Titanium;
+  var UI = TI.UI;
+  var mainWin = UI.mainWindow.window;
   
   $.bowline = {
     setup: function(name, el){
-      var rb = eval("bowline_" + name + "_setup");
+      var rb = mainWin.eval("bowline_" + name + "_setup");
       if(!rb) throw 'Unknown class';
       rb(el);
     },
     
     klass: function(name){
-      var rb = eval("bowline_" + name);
+      var rb = mainWin.eval("bowline_" + name);
       if(!rb) throw 'Unknown class';
       return rb;
     },
     
     instance: function(name, el){
-      var rb = eval("bowline_" + name + "_instance");
+      var rb = mainWin.eval("bowline_" + name + "_instance");
       if(!rb) throw 'Unknown class';
       return rb(el);
     },
@@ -28,12 +31,43 @@
         )
       );
     },
+
+    load: function(){
+      $(function(){
+    	  setTimeout(function(){
+      	  $(document.body).trigger('loading.bowline');
+          var script = $("<script />");
+          script.attr('type', 'text/ruby');
+          script.attr('src',  '../script/init');
+          $('head').append(script);
+        }, 100);
+    	});
+    },
     
     ready: function(func){
       if(init) return func();
       $(document).bind('loaded.bowline', func);
     },
     
+    dialog: function(name, options, callback){
+      if(!callback && typeof(options) == 'function') {
+        callback = options;
+        options  = {};
+      }
+      $.extend(options, {
+        'url': 'app://public/' + name + '.html',
+        'height': 200,
+        'width': 350,
+        'transparency': 0.9,
+        'resizable': false,
+        'usingChrome': false,
+        'onclose': function(res){
+          if(callback) callback(res);
+        }
+      });
+      return Titanium.UI.showDialog(options);
+    },
+    
     setupForms: function(){
       // $('form').bind('submit', function(e){
       //   var src = $(this).attr('src').split('.');
@@ -86,7 +120,16 @@
         var name = $(this).item('root').data('bowline');
         var func = $.bowline.instance(name, $(this));
       }
-      return func.apply(func, arguments);
+      var args = $.makeArray(arguments);
+      var opts = args.pop();
+      if(typeof(opts) == "object" && opts.async){
+        setTimeout(function(){
+          func.apply(func, args);
+        }, 100);
+      } else {
+        args.push(opts);
+        func.apply(func, args);
+      }
     } else {
       throw 'Chain not active';
     }
@@ -106,13 +149,8 @@
     $(this).trigger('update.bowline');
 	};
 	
-	$(function(){
-	  setTimeout(function(){
-  	  $(document.body).trigger('loading.bowline');
-      var script = $("<script />");
-      script.attr('type', 'text/ruby');
-      script.attr('src',  '../script/init');
-      $('head').append(script);
-    }, 100);
-	})
+  // main window
+	if(UI.getCurrentWindow().isTopMost()){
+	  $.bowline.load();
+	}
 })(jQuery)

data/bowline.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bowline}
-  s.version = "0.3.9"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex MacCaw"]
-  s.date = %q{2009-07-15}
+  s.date = %q{2009-07-18}
   s.default_executable = %q{bowline-gen}
   s.description = %q{Ruby/JS GUI framework}
   s.email = %q{alex@leadthinking.com}

data/lib/bowline/binders.rb

@@ -30,8 +30,8 @@ module Bowline
         def params
           @params
         end
-      
-        def params=(p)
+        
+        def params=(p) #:nodoc:
           case p
           when String
             # Params comes in a string (since it's a
@@ -46,18 +46,35 @@ module Bowline
             @params = p
           end
         end
-      
-        def setup(d)
+        
+        def elements
+          @elements
+        end
+        
+        def setup(d) #:nodoc:
           @elements ||= []
           @elements << d
           self.item_sync!
         end
+        
+        def trigger(event, data = nil)
+          @elements ||= []
+          @elements.map {|e| 
+            e.trigger(format_event(event), data) 
+          }
+        end
+        
+        def loading(&block)
+          trigger(:loading, true)
+          yield
+          trigger(:loading, false)
+        end
       
-        def instance(el)
+        def instance(el) #:nodoc:
           self.new(el).method(:send)
         end
 
-        def inherited(child)
+        def inherited(child) #:nodoc:
           return if self == Bowline::Binders::Base
           return if child == Bowline::Binders::Singleton
           return if child == Bowline::Binders::Collection
@@ -66,7 +83,13 @@ module Bowline
           js.send("bowline_#{name}_setup=",    child.method(:setup))
           js.send("bowline_#{name}_instance=", child.method(:instance))
           js.send("bowline_#{name}=",          child.method(:send))
-        end    
+        end
+        
+        def format_event(name) #:nodoc:
+          name.is_a?(Array) ? 
+            name.join('.') : 
+              name.to_s
+        end
       end
     
       attr_reader :element
@@ -93,7 +116,10 @@ module Bowline
 
       # Trigger jQuery events on this element
       def trigger(event, data = nil)
-        self.element.trigger(event, data)
+        self.element.trigger(
+          self.class.format_event(event), 
+          data
+        )
       end
     
       # Raw DOM element

data/lib/bowline/generators/application.rb

@@ -57,6 +57,8 @@ module Bowline::Generators
     }
     
     empty_directory :initializers, "config/initializers"
+    
+    file :readme, "../README.txt", "README"
   end
   
   add :app, ApplicationGenerator

data/lib/bowline/tasks/app.rake

@@ -1,8 +1,7 @@
 require 'fileutils'
 namespace :app do  
   task :configure => :environment do
-    build_path    = File.join(APP_ROOT, 'build')
-        
+    config_path = File.join(APP_ROOT, 'config')
     conf = Bowline.configuration
     
     # Titanium complains about whitespace
@@ -66,8 +65,7 @@ tiprocess:0.4.4
 </ti:app>
     EOF
     
-    FileUtils.makedirs(build_path)
-    FileUtils.cd(build_path) do
+    FileUtils.cd(config_path) do
       File.open('manifest', 'w+') {|f| f.write manifest }
       File.open('tiapp.xml', 'w+') {|f| f.write tiapp }
     end
@@ -75,14 +73,19 @@ tiprocess:0.4.4
   
   desc "Bundles up app into executables"  
   task :bundle do
-    build_path    = File.join(APP_ROOT, 'build')
-    app_path      = File.join(build_path, 'app')
-    
-    tiapp    = File.join(build_path, 'tiapp.xml')
-    manifest = File.join(build_path, 'manifest')
+    build_path  = File.join(APP_ROOT, 'build')
+    app_path    = File.join(build_path, 'app')
+    config_path = File.join(APP_ROOT, 'config')
     
-    if !File.exists?(tiapp) || !File.exists?(manifest)
+    tiapp    = File.join(config_path, 'tiapp.xml')
+    manifest = File.join(config_path, 'manifest')
+    env      = File.join(config_path, 'environment.rb')
+        
+    if !File.exists?(tiapp) || 
+        !File.exists?(manifest)
       Rake::Task['app:configure'].invoke
+    elsif File.mtime(tiapp) < File.mtime(env)
+      puts "You may need to run 'rake app:configure'"
     end
     
     FileUtils.rm_rf(app_path)

data/lib/bowline/version.rb

@@ -1,8 +1,8 @@
 module Bowline  
   module Version #:nodoc:
     MAJOR    = 0
-    MINOR    = 3
-    TINY     = 9
+    MINOR    = 4
+    TINY     = 0
     
     STRING   = [MAJOR, MINOR, TINY].join('.')
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: maccman-bowline
 version: !ruby/object:Gem::Version 
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors: 
 - Alex MacCaw
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-15 00:00:00 -07:00
+date: 2009-07-18 00:00:00 -07:00
 default_executable: bowline-gen
 dependencies: 
 - !ruby/object:Gem::Dependency