rsence-pre 2.2.0.14 → 2.2.0.15

data/INSTALL.rdoc

@@ -120,6 +120,8 @@ This not only enables SessionStorage (persistent sessions between RSence restart
 * *rake*[http://rake.rubyforge.org]
   * Ruby build tool
   * Not necessarily required via ruby gems, if installed via a system-level package
+* *coffee-script*[https://github.com/josh/ruby-coffee-script]
+  * Ruby library for .coffee -> .js compliation
 * *rack*[http://rack.rubyforge.org]
   * Abstract ruby web server interface
   * A rack handler is also required. One of the following is suggested:

data/README.rdoc

@@ -3,19 +3,28 @@
 
 == Introduction
 
-RSence is a RIA framework designed for responsive GUI applications on the web; it's implemented as a hybrid Ruby - Javascript system. The server is written in Ruby and C. Applications are installed as plugin bundles. The GUI framework is written in Javascript; it doesn't strictly require the server, but has extensive transport support with automatic data synchronization with the server. User interfaces are usually described in structured view trees represented by YAML data structures, which are automatically converted for rendering in the client. 
+RSence is a different and unique development model and software frameworks designed first-hand for real-time web applications. RSence consists of separate, but tigtly integrated data- and user interface frameworks.
 
-Javascript knowledge is required only when creating custom client-driven functionality; basic understanding of the YAML GUITree structures is enough in most cases. Likewise, no prior Ruby knowledge is needed if you want to create stand-alone Javascript applications. Javascript component themes are easily created with just basic web designer skills. Data API's are easy to link no matter what language is used to create them. Skills in your organization are easily combined for various parts of larger applications.
+RSence could be classified as a thin server - thick client system.
 
-RSence is not primarily targeted as an engine for plain old html web sites, there are plenty of other tools for that purpose and RSence is easily integrated with them in various ways.
+Applications and submobules are installed as indepenent plugin bundles into the plugins folder of a RSence environment, which in itself is a self-contained bundle. A big part of RSence itself is implemented as shared plugin bundles.
 
+The user interface framework of RSence is implemented in high-level user interface widget classes. The widget classes share a common foundation API and access the browser's native API's using an abstracted event- and element layer, which provides exceptional cross-browser compatibility.
 
-== Installing
-Just run this command in the shell, if you have ruby installed. Otherwise, read the {file:INSTALL Install Guide} for full installation instructions.
+The data framework of RSence is a event-driven system, which synchronized shared values between the client and server. It's like a realtime bidirectional form-submission engine that handles data changes intelligently. On the client, changed values trigger events on user interface widgets. On the server, changed values trigger events on value responder methods of server plugin modules. It doesn't matter if the change originates on client or server, it's all synchronized and propagated automatically.
+
+The server framework is implemented as a high-level, modular data-event-driven system, which handles delegation of tasks impossible to implement using a client-only approach.
+Client sessions are selectively connected to other client sessions and legacy back-ends via the server by using the data framework.
+
+The client is written in Javascript and the server is written in Ruby. The client also supports CoffeeScript for custom logic. In many cases, no custom client logic is needed; the user interfaces can be defined in tree-like data models. By default, the models are parsed from YAML files, and other structured data formats are possible, including XML, JSON, databases or any custom logic capable of producing similar objects. The server can connect to custom environments and legacy backends accessible on the server, including software written in other languages.
+
+
+== Installing RSence
+Just run this command in the shell, if you have functioning ruby environment installed. Otherwise, read the {file:INSTALL Install Guide} for full installation instructions.
  gem install rsence
 
 
-== Initializing a new project
+== Initializing a new RSence environment
 
 The +init+ command will create a directory called `env_dir` in this example. It asks a few questions about the environment. Use a path and project name that matches your purposes.
  rsence init /home/me/rsence_projects/env_dir
@@ -89,26 +98,18 @@ For more detailed installation and usage instructions, read the {file:INSTALL In
 
 === The bleeding edge (for developers)
 RSence comes in two varieties:
-1. rsence : The stable (no major new features, just bug fixes) release.
-2. rsence-pre : The active development snapshot released periodically.
-
-Both varieties can be installed simultaneously and it's suggested to use
-the stable "rsence" package for production installations and to use the
-"rsence-pre" package for development purposes, because the RSence crew
-can't possibly test each and every application available. It's your 
-responsibility as a developer to report any RSence issues effecting your
-software. The sooner reported, the better; it ensures better release 
-versions.
+1. rsence : The stable release intended for running in production environments.
+2. rsence-pre : The active development snapshot intended for develoment environments. Runtime-wise, it's nearly as stable as the stable version, but features are constantly added and sometimes changed.
 
-To use "rsence-pre", install the "rsence-pre" gem and use the "rsence-pre" 
-command instead of the "rsence" command.
+To use "rsence-pre", install the "rsence-pre" gem and use the "rsence-pre" instead of "rsence" command-line tool.
 
 === Licensing and commercial support options
 * {file:LICENSE.txt *GPL*} version 3 by default.
 * Riassence[http://riassence.com/] Inc. provides commercial support, custom licensing arrangements and various other services.
 
 === Community support
-* http://rsence.org
-* IRC channel +#rsence+ on the IRCNet and FreeNode networks
-
+* http://rsence.org/
+* IRC channel +#rsence+ on the FreeNode IRC network
 
+=== Keywords:
+HTML5 Javascript CoffeeScript Ruby RIA Server Client Data-Driven Event-Driven Web Framework

data/VERSION

@@ -1 +1 @@
-2.2.0.14.pre
+2.2.0.15.pre

data/js/core/rsence_ns/rsence_ns.coffee

@@ -0,0 +1,19 @@
+
+# The RSence namespace
+RSence =
+  
+  # Call this method from the index page to
+  # setup the environment variables and to
+  # start synchronizing immediately afterwards.
+  serverConf: (_clientPrefix, _helloUrl) ->
+    COMM.ClientPrefix = _clientPrefix
+    COMM.Transporter.HelloUrl = _helloUrl
+    HThemeManager.themePath = _clientPrefix+'/themes'
+    HThemeManager._start()
+    COMM.AutoSyncStarter.start()
+    null
+  
+  # Storage for guiTrees, cantains
+  # JSONRenderer instances by plugin name.
+  guiTrees: {}
+

data/js/core/rsence_ns/rsence_ns.js

@@ -6,12 +6,10 @@
  *   with this software package. If not, contact licensing@riassence.com
  */
 
-// RSence namespace, nothing here yet.
-// However, a future version of client_pkg will pack var's assigned like..
-//   var//RSence
-// ..into this namespace.
-// Additional logic for handling the namespaces will however be required.
-var RSence = {
+// RSence client-side namespace initialization.
+// Current contents are a store for guiTrees and the serverConf method for setting up variables before starting.
+var
+RSence = {
   
   // Configuration method for the html document of the server
   serverConf: function(_clientPrefix,_helloUrl){

data/js/no_pkg/no_pkg.js

@@ -0,0 +1,2 @@
+
+// Empty file for empty packages

data/lib/plugins/guiparser.rb

@@ -112,6 +112,8 @@ module RSence
           return get_params( sym_arr, params )
         elsif data_class == String and gui_data.strip.start_with?('function(')
           return @parent.plugins[:client_pkg].squeeze( "a="+json_fun( gui_data.to_json ) )[2..-1]
+        elsif data_class == String and gui_data.strip.start_with?('coffee:')
+          return @parent.plugins[:client_pkg].coffee( gui_data.strip[7..-1], true )
         end
         return gui_data
       end

data/lib/session/msg.rb

@@ -286,6 +286,12 @@ module RSence
       puts data if @config[:trace]
       @buffer.push( data )
     end
+
+    # Same as #reply, but with CoffeeScript instead of JS
+    def coffee(data)
+      puts data if @config[:trace]
+      @buffer.push( @plugins[:client_pkg].coffee( data ) )
+    end
   
     # @private For value manager; insert changed values BEFORE other js.
     def reply_value( operation_type, value_id, data=nil )

data/plugins/client_pkg/client_pkg.rb

@@ -141,6 +141,10 @@ class ClientPkgPlugin < Servlet
   def squeeze( js )
     return @client_build.squeeze( js )
   end
+
+  def coffee( src )
+    return @client_build.coffee( src )
+  end
   
   def init
     

data/plugins/client_pkg/lib/client_pkg_build.rb

@@ -12,8 +12,10 @@ require 'jscompress'
 require 'html_min'
 begin
   require 'coffee-script'
+  RSence.config[:client_pkg][:coffee_supported] = true
 rescue LoadError
   warn "CoffeeScript not installed. Install the 'coffee-script' gem to enable."
+  RSence.config[:client_pkg][:coffee_supported] = false
 end
 
 
@@ -124,12 +126,11 @@ class ClientPkgBuild
       end
       tgt_hash_gfx = tgt_hash_theme[:gfx]
       gfx_size = read_gfx( src_path_theme, tgt_hash_gfx )
-      puts "gfx size of #{bundle_name}: #{gfx_size.inspect}"
       @theme_sizes[   theme_name ][:gfx] += gfx_size
     end
   end
   
-  def add_bundle( bundle_name, bundle_path, entries, has_coffee=false )
+  def add_bundle( bundle_name, bundle_path, entries, has_js=false, has_coffee=false )
     has_themes = entries.include?( 'themes' ) and File.directory?( File.join( bundle_path, 'themes' ) )
     if @bundles_found.has_key?( bundle_name )
       @logger.log( "JSBuilder ERROR: duplicate bundles with the name #{bundle_name.inspect} found." )
@@ -142,8 +143,21 @@ class ClientPkgBuild
       warn "JSBuilder WARNING: bundle name #{bundle_name.inspect} does not belong to any package, skipping.." if ARGV.include?('-d')
       return true
     end
-    if has_coffee
-      js_data = CoffeeScript.compile( read_file( File.join( bundle_path, bundle_name+'.js' ) ) )
+    if has_coffee and @coffee_supported
+      begin
+        coffee_path = File.join( bundle_path, bundle_name+'.coffee' )
+        coffee_src = read_file( coffee_path )
+        js_data = CoffeeScript.compile( coffee_src, :bare => true )
+      rescue CoffeeScript::CompilationError
+        if has_js
+          js_data = %{console.log( "WARNING: CoffeeScript complilation failed for source file #{coffee_path}, using the js variant instead." );}
+          js_data += read_file( File.join( bundle_path, bundle_name+'.js' ) )
+        else
+          js_data = %{console.log( "WARNING: CoffeeScript complilation failed for source file #{coffee_path}" );}
+        end
+      end
+    elsif not has_js
+      js_data = %{console.log( "ERROR: CoffeeScript not suuported and no JS source available for #{bundle_path}" );}
     else
       js_data = read_file( File.join( bundle_path, bundle_name+'.js' ) )
     end
@@ -168,12 +182,12 @@ class ClientPkgBuild
       dir_name    = File.split( src_dir )[1]
       # bundles are defined as directories with a js file of the same name plus the 'js.inc' tagfile
       not_disabled = ( not dir_entries.include?( 'disabled' ) )
-      has_js = dir_entries.include?( dir_name+'.js' ) #or dir_entries.include?( 'main.js' )
-      has_coffee = dir_entries.include?( dir_name+'.coffee' ) #or dir_entries.include?( 'main.coffee' )
+      has_js = dir_entries.include?( dir_name+'.js' )
+      has_coffee = dir_entries.include?( dir_name+'.coffee' )
       is_bundle   = not_disabled and ( has_js or has_coffee )
       # if src_dir is detected as a bundle, handle it in add_bundle
       if is_bundle
-        add_bundle( dir_name, src_dir, dir_entries, has_coffee )
+        add_bundle( dir_name, src_dir, dir_entries, has_js, has_coffee )
       end
       # descend into the sub-directory:
       dir_entries.each do | dir_entry |
@@ -225,7 +239,7 @@ class ClientPkgBuild
     end
   end
   
-  def squeeze( js )
+  def squeeze( js, is_coffee=false )
     unless @no_whitespace_removal
       begin
         js = @jsmin.minimize( js )#.strip
@@ -240,6 +254,16 @@ class ClientPkgBuild
     return js.strip
   end
 
+  def coffee( src )
+    begin
+      js = CoffeeScript.compile( src, :bare => true )
+    rescue CoffeeScript::CompilationError
+      warn "Invalid CoffeeScript supplied:\n----\n#{src}----\n"
+      js = "function(){console.log('ERROR; invalid CoffeeScript supplied: #{src.to_json}');}"
+    end
+    return squeeze( js )
+  end
+
   def process_js( src_in )
     if @debug
       return src_in
@@ -494,6 +518,8 @@ class ClientPkgBuild
   
   def initialize( config, logger )
     
+    @coffee_supported = config[:coffee_supported]
+
     @logger = logger
     
     # src_dirs is supposed to be an array of js source directories

metadata

@@ -1,22 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: rsence-pre
 version: !ruby/object:Gem::Version 
-  hash: 99
+  hash: 97
   prerelease: 
   segments: 
   - 2
   - 2
   - 0
-  - 14
-  version: 2.2.0.14
+  - 15
+  version: 2.2.0.15
 platform: ruby
 authors: 
 - Riassence Inc.
+- Juha-Jarmo Heinonen
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-07-26 00:00:00 Z
+date: 2011-07-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rsence-deps
@@ -26,23 +27,27 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 1925
+        hash: 1931
         segments: 
-        - 963
-        version: "963"
+        - 964
+        version: "964"
   type: :runtime
   version_requirements: *id001
-description: |
-  RSence is a RIA ("HTML5" or "Ajax" if you like those terms better) framework designed for responsive GUI applications on the web.
+description: |-
+  RSence is a different and unique development model and software frameworks designed first-hand for real-time web applications. RSence consists of separate, but tigtly integrated data- and user interface frameworks.
   
-  RSence is a flexible and high-performance RIA framework aimed on building responsive, scalable and over-all as high-performance GUI Applications as possible with the chosen technologies.
+  RSence could be classified as a thin server - thick client system.
   
-  RSence includes a server for backend tasks and client suppert as well as a Javascript GUI framework to provide responsive user interfaces.
+  Applications and submobules are installed as indepenent plugin bundles into the plugins folder of a RSence environment, which in itself is a self-contained bundle. A big part of RSence itself is implemented as shared plugin bundles.
   
-  The purpose of the server is to provide a highly optimized yet easy to use Ruby framework for writing applications containing all their assets needed as self-contained plugins bundles. The bundles enable easy distribution and maintenance of RSence projects.
+  The user interface framework of RSence is implemented in high-level user interface widget classes. The widget classes share a common foundation API and access the browser's native API's using an abstracted event- and element layer, which provides exceptional cross-browser compatibility.
   
-  RSence is not primarily targeted as an engine for plain old html web sites, there are plenty of other tools for that purpose and some of them are easily integrated into RSence.
-
+  The data framework of RSence is a event-driven system, which synchronized shared values between the client and server. It's like a realtime bidirectional form-submission engine that handles data changes intelligently. On the client, changed values trigger events on user interface widgets. On the server, changed values trigger events on value responder methods of server plugin modules. It doesn't matter if the change originates on client or server, it's all synchronized and propagated automatically.
+  
+  The server framework is implemented as a high-level, modular data-event-driven system, which handles delegation of tasks impossible to implement using a client-only approach.
+  Client sessions are selectively connected to other client sessions and legacy back-ends via the server by using the data framework.
+  
+  The client is written in Javascript and the server is written in Ruby. The client also supports CoffeeScript for custom logic. In many cases, no custom client logic is needed; the user interfaces can be defined in tree-like data models. By default, the models are parsed from YAML files, and other structured data formats are possible, including XML, JSON, databases or any custom logic capable of producing similar objects. The server can connect to custom environments and legacy backends accessible on the server, including software written in other languages.
 email: info@rsence.org
 executables: 
 - rsence-pre
@@ -51,7 +56,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- bin/rsence
 - lib/conf/argv.rb
 - lib/conf/default.rb
 - lib/daemon/daemon.rb
@@ -236,6 +240,7 @@ files:
 - js/core/iefix/ie_css_element.htc
 - js/core/iefix/ie_css_style.htc
 - js/core/iefix/iefix.js
+- js/core/rsence_ns/rsence_ns.coffee
 - js/core/rsence_ns/rsence_ns.js
 - js/datetime/calendar/calendar.js
 - js/datetime/calendar/themes/default/calendar.css
@@ -302,6 +307,7 @@ files:
 - js/menus/popupmenu/themes/default/popupmenu.css
 - js/menus/popupmenu/themes/default/popupmenu.html
 - js/menus/popupmenu/themes/default/popupmenu.png
+- js/no_pkg/no_pkg.js
 - js/util/reloadapp/reloadapp.js
 - js/util/reloadapp/themes/default/reloadapp_warning-ie6.gif
 - js/util/reloadapp/themes/default/reloadapp_warning.png
@@ -321,8 +327,8 @@ files:
 - .yardopts
 - bin/rsence-pre
 homepage: http://www.rsence.org/
-licenses: []
-
+licenses: 
+- GPL-3
 post_install_message: 
 rdoc_options: []
 
@@ -356,6 +362,6 @@ rubyforge_project: rsence-
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Pre-Release 2.2 version of the RSence framework.
+summary: Pre-Release 2.2 version of RSence.
 test_files: []
 

data/bin/rsence

@@ -1,25 +0,0 @@
-#!/usr/bin/env ruby
-##   RSence
- #   Copyright 2010 Riassence Inc.
- #   http://riassence.com/
- #
- #   You should have received a copy of the GNU General Public License along
- #   with this software package. If not, contact licensing@riassence.com
- ##
-
-
-require 'profile' if ARGV.include?('--profile')
-
-# @private  Auto-construct paths using this file as the waypoint
-SERVER_PATH = File.split( File.expand_path(File.dirname(__FILE__)) )[0]
-
-# Include server & lib in the search path
-$LOAD_PATH << SERVER_PATH
-$LOAD_PATH << File.join( SERVER_PATH, 'lib' )
-
-require 'rsence'
-
-# Start RSence, if the command supplied was one of the ones
-# triggering a start and the environment is ok.
-RSence.startup if RSence.startable?
-