rsence-pre 2.1.0.1.pre

data/README.rdoc

@@ -0,0 +1,98 @@
+
+= RSence-2.0.0[http://rsence.org/]
+
+== 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. 
+
+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 Ruby knowledge is needed if you want to create stand-alone Javascript applitations. 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 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.
+
+
+== Installing
+Just run this command in the shell, if you have ruby installed. Otherwise, read the {file:INSTALL Install Guide} for full installation instructions.
+ gem install rsence
+
+
+== Initializing a new project
+
+The +initenv+ command will cretate 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 initenv /home/me/rsence_projects/env_dir
+
+
+== Project environment structure
+
+==== The basic structure of a project environment (where `env_dir` is the directory of your project) is:
+
+*dir* :: +env_dir/+ :: The environment directory of your project.
+*file* :: +env_dir/conf/config.yaml+ :: The configuration file to load by default. It extends the {file:default_conf default configuration}.
+*dir* :: +env_dir/run/+ :: This default directory for runtime files, like the PID file of the running rsence instance.
+*dir* :: +env_dir/log/+ :: The default directory for log files. +rsence.stderr+ contains error output of the RSence server daemon and installed plugins, including warnings. +rsence.stdout+ contains the standard output of the RSence server daemon and installed plugins.
+*dir* :: +env_dir/db/+ :: The default directory for database files. +ses.db+ is the standard SQLite session database, if enabled.
+*dir* :: +env_dir/plugins/+ :: The default directory for installed plugin bundles. A newly initialized environment includes the +welcome+ plugin. Feel free to remove it.
+*file* :: +env_dir/VERSION+ :: The version of RSence used to initialize the environment. Reserved for future upgrade usage.
+*file* :: +env_dir/README+ :: A README file template. Describes what the `env_dir` is about. Edit it to match your project.
+
+=== Configuration file loading order
+The configuration files are loaded and applied in this order:
+1.  *rsence_gem_path*/conf/default_conf.yaml
+2.  *rsence_gem_path*/conf/local_conf.yaml
+3.  /etc/rsence/config.yaml
+4.  ~/.rsence/config.yaml
+5.  *env_dir*/conf/config.yaml
+6.  Any files given using +--conf+ arguments, in order of occurrence.
+
+Use the additional configuration files to match system- or user-specific configurations that are common for all projects.
+
+== Running a project
+
+Each command-line tool command takes a number of options, the +env_dir+ argument defaults to the current working directory, otherwise specify the relative or full path to your project environment.
+
+==== Some common options are:
++-a+:: Automatic updates. RSence reloads automatically changed plugin bundles and client libraries.
++-f+:: Doesn't redirect the standard output into a log file. Useful for development when combined with the +run+ command.
++-d+:: Debug mode. Like +-a+ but much more verbose and doesn't obfuscate client data.
+
+=== Running RSence in foreground
+  rsence run [options] [env_dir]
+
+=== Starting the RSence daemon
+  rsence start [options] [env_dir]
+
+=== Stopping the RSence daemon
+  rsence stop [options] [env_dir]
+
+=== Restarting the RSence daemon
+  rsence restart [options] [env_dir]
+
+=== Checking if project is running
+  rsence status [options] [env_dir]
+
+=== Example:
+  rsence run -af /home/me/projects/hello_world
+
+== RSence command-line tool help
+
+=== Lists all available commands
+  rsence help
+
+=== Getting detailed help of a command
+  rsence help <command>
+
+=== Example:
+
+  rsence help run
+
+
+For more detailed installation and usage instructions, read the {file:INSTALL Install Guide} document.
+
+=== 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
+
+

data/VERSION

@@ -0,0 +1 @@
+2.1.0.1.pre

data/bin/rsence

@@ -0,0 +1,25 @@
+#!/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?
+

data/bin/rsence-pre

@@ -0,0 +1,25 @@
+#!/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?
+

data/conf/default_conf.yaml

@@ -0,0 +1,346 @@
+  #### Server configuration
+  #
+  # The :base_url specifies the prefix for all default http responders.
+  :base_url: '/'
+  #
+  # This setting defines if requests should be gzip-compressed or not.
+  # This is a trade-off between cpu cycles used and network bandwidth used.
+  # It's generally a good idea to leave it as false (gzipping enabled).
+  :no_gzip: false
+  #
+  # Enabling this appends all msg.reply call output to stdout
+  :trace: false
+  #
+  # The settings for the index_html plugin
+  :index_html:
+    #
+    # HTML template file path relative to the plugin dir
+    :index_tmpl: 'tmpl/index.html'
+    #
+    # The index.html page <title>
+    :title: 'RSence'
+    #  
+    :noscript: '<h1>Sorry!</h1><p>This site requires a Javascript -capable web browser.</p><p>Please enable Javascript or upgrade your browser.</p>'
+    #
+    :instance: null
+    #
+    # A list of javascript dependencies to include in the html
+    :deps: [ ]
+  #
+  # The settings for the main plugin
+  :main_plugin:
+    #
+    # The background color of the web page when loading is done
+    :bg_color:            '#ffffff'
+    #
+    # how many milliseconds to wait before doing an idle poll
+    :server_poll_interval: 2000 # 2 seconds
+  #
+  # Switches on debug-mode:
+  #  - Generates more output
+  #  - Each time /hello is post-requested:
+  #    - Plugins are reloaded from source 
+  #    - GZFiles are reloaded (if more recent than in memory)
+  :debug_mode: false
+  #
+  # Web server-related settings:
+  :http_server:
+    #
+    # Simulate network latency. Good for testing how your
+    # app behaves with laggy connections.
+    :latency: 0
+    #
+    # HTTP Port number to listen to.
+    :port:  8001
+    #
+    # Bind this ip address ('0.0.0.0' means all)
+    :bind_address:  '0.0.0.0'
+    #
+    # Rack handler to use, defaults to thin
+    :rack_require: mongrel
+  #
+  # When enabled, sets http cache headers
+  # to cache content as long as possible.
+  :cache_maximize: true
+  #
+  # When :cache_maximize is enabled,
+  # this is the time (in seconds) the cached
+  # content will expire in
+  :cache_expire: 14515200 # 6 months
+  #
+  # Paths to scan for available plugins
+  :plugin_paths: [ ]
+  #
+  # List of files that include strings
+  :string_files: [
+    "conf/default_strings.yaml"
+  ]
+  #
+  # Transporter settings:
+  :transporter_conf:
+    #
+    # The HApplication priority of the client, when actively polling.
+    :client_poll_priority: 60
+  #
+  #
+  # Session-related settings
+  :session_conf:
+    #
+    # Enable cookie-based sessions
+    :session_cookies: true
+    #
+    # Trusting the cookies means ignoring the client protocol session key exchange.
+    # Enabled by default, because in most cases, extreme security measures aren't necessary
+    # and the drawback of having an invalid session because a tcp packet got lost isn't
+    # tolerable as a default setting.
+    :trust_cookies: true
+    #
+    # The comment string in the session cookie
+    :ses_cookie_comment: "RSence Session Key"
+    #
+    # Disposable keys. When enabled, runs in a more secure way and changes the session key on each xhr.
+    :disposable_keys:    true
+    #
+    # Timeout controls how long a session is valid
+    :timeout_secs:       900 # 15 minutes
+    #
+    # Key length controls the length of the random-part of the key.
+    :key_length:   12
+    #
+    # Cookie keys are this many times longer than xhr keys
+    :cookie_key_multiplier: 2
+    #
+    #
+    # When enabled, deletes all old sessions upon server startup.
+    # If the --reset-sessions command-line switch is provided,
+    # switches this one to true.
+    :reset_sessions: false
+    #
+    # When this is enabled, multiple sessions are allowed for each client
+    # When it's enabled, the old session is left intact and a new one is
+    # created by making a clone of the last session.
+    # If enabled, also check the maximum number of clones allowed in
+    # :session_cookie_max_clones
+    # Defaults to false, will be the default in a future version.
+    :clone_cookie_sessions: true
+    #
+    # This limits the amount of cloned targets of a source session.
+    # NOTE: This has no effect yet, the code is not implemented.
+    :max_cloned_sessions: 10
+    #
+    # This option overrides the default session timeout.
+    # Don't set this to less than the expected poll interval,
+    # otherwise the session might expire before the previous
+    # (cloned) session re-connects the next time.
+    # A safe value for a 60 second poll interval is 120 (default).
+    :cloned_session_expires_in: 120
+    #
+    # Message strings
+    :messages:
+      #
+      # if the session is invalid for one reason or another, display this:
+      :invalid_session:
+        :title: 'Invalid Session'
+        :descr: 'Your session is invalid. Please reload the page to continue.'
+        :uri:    '/'
+  #
+  # Database configuration
+  :database:
+    # Session database storage string. Leave empty here to enable the wizard for storage.
+    :ses_db: 'sqlite://db/ses.db'
+
+  #
+  # ValueManager settings
+  :values_conf:
+    # Key length controls the length of the random-part of the key.
+    :key_length:    8
+    #
+    # Disposable keys, when enabled, changes the value id on each session restoration
+    :disposable_keys:   true
+  #
+  # Daemon helper files, leave empty for defaults.
+  :daemon: {
+    #:pid_fn: /var/run/rsence.pid
+    #:log_fn: /var/log/rsence.log
+  }
+  #
+  # Entered by code, empty container
+  :broker_urls: { }
+
+
+  #### Client package build configuration
+  #
+  #
+  :client_pkg:
+
+    # Source directories to scan
+    :src_dirs: []
+
+      # RSence Client Framework
+      #- js
+
+      # How to include your own custom js package directory:
+      # - /home/me/code/extra_components
+
+    # List of theme names to include and pack
+    :theme_names:
+      - default  # Makes default_theme.js containing css and html templates
+      - bright   # Makes bright_theme.js containing css and html templates
+
+    # List of packages to build
+    :packages:
+
+      # The core package, loaded by default using a script tag in index_html
+      core:
+  
+        # RSence.*
+        - rsence_ns
+  
+        # RSence.Core
+        - class             # HClass
+        - elem              # ELEM
+        - event             # Event
+  
+        # RSence.Util
+        - sha               # SHA
+  
+        # RSence.Foundation
+        - system            # HSystem
+        - valueresponder    # HValueResponder
+        - application       # HApplication
+  
+        # COMM
+        - comm              # COMM
+        - queue             # COMM.Queue
+        - session           # COMM.Session
+        - transporter       # COMM.Transporter
+        - sessionwatcher    # COMM.SessionWatcher
+        - urlresponder      # COMM.URLResponder
+        - autosync          # ( automatic sync setup )
+        - values            # COMM.Values
+        - value             # HValue
+        - jsloader          # COMM.JSLoader
+        - json_renderer     # COMM.JSONRenderer
+        - valuematrix       # HValueMatrixInterface & HValueMatrix
+        - point             # HPoint
+        - rect              # HRect
+        - thememanager      # HThemeManager
+        - markupview        # HMarkupView
+        - morphanimation    # HMorphAnimation
+        - viewdefaults      # HViewDefaults
+        - view              # HView
+        - eventresponder    # HEventResponder
+        - dummyvalue        # HDummyValue
+        - eventmanager      # EVENT
+        - controldefaults   # HControlDefaults
+        - control           # HControl
+        - dyncontrol        # HDynControl
+        - centerview        # HCenterView
+        - scrollview        # HScrollView
+        - inlineview        # HInlineView
+
+      # The default collection of simple control widgets (components)
+      controls:
+        - button            # HButton & HClickValueButton
+        - checkbox          # HCheckbox
+        - radiobutton       # HRadioButton
+        - stringview        # HStringView
+        - textcontrol       # HTextControl
+        - passwordcontrol   # HPasswordControl
+        - textarea          # HTextArea
+        - uploader          # HUploader
+        - slider            # HSlider
+        - vslider           # HVSlider
+        - progressbar       # HProgressBar
+        - progressindicator # HProgressIndicator
+        - imageview         # HImageView
+        - stepper           # HStepper
+        - validatorview     # HValidatorView
+        - window            # HWindow
+        - tab               # HTab & HTabView & HTabItem
+        - sheet             # HSheet
+        - alert_sheet       # HAlertSheet
+        - confirm_sheet     # HConfirmSheet
+
+      # Server error message application ( the Reload / Reset Session dialog )
+      servermessage:
+        - reloadapp # ReloadApp
+
+      # Special package for Internet Explorer 6.0
+      iefix:
+        - iefix
+
+      # Date and time -related control widgets (components)
+      # These are not complete; they are still under development
+      # and will be included in the controls package when finalized.
+      datetime:
+        - datetimevalue       # HDateTime
+        - calendar            # HCalendar
+        - timesheet           # HTimeSheet
+        - timesheet_item      # HTimeSheetItem
+        - timesheet_item_edit # HTimeSheetItemEditor
+
+      # List related control widgets (components)
+      # These are not complete; they are still under development
+      # and will be included in the controls package when finalized.
+      lists:
+        - listitems           # HListItems
+        - checkboxlist        # HCheckboxList
+        - radiobuttonlist     # HRadiobuttonList
+        - propertylist        # HPropertyList
+
+    # Special packages that include other packages (not used currently)
+    :compound_packages:
+      allinone:
+        - core
+        - default_theme
+        - controls
+        - lists
+        - datetime
+
+    # List of variables and other names beginning
+    # with a underscore that should not be obfuscated
+    :reserved_names:
+      - _ID
+      - _WIDTH
+      - _width
+      - _HEIGHT
+      - _height
+      - _
+
+    # List of file extensions considered graphics image types.
+    # Used for theme graphics inclusion.
+    :gfx_formats:
+      - .jpg
+      - .gif
+      - .png
+      - .swf
+      - .svg
+      - .pdf
+
+    # The name of the include file
+    :js_inc: js.inc
+
+    # If disabled, makes packages out of single source bundles automatically
+    :dont_pack_undefined: true
+
+    # Replacement prefix for obfuscated names
+    :repl_prefix: _
+
+    # If enabled, doesn't obfuscate code (useful for debugging)
+    :no_obfuscation: false
+
+    # If enabled, doesn't remove whitespace (useful for debugging)
+    :no_whitespace_removal: false
+
+    # If enabled, doesn't make gzipped packages
+    :no_gzip: false
+
+    # The strategy for gzip, a number between 0 and 9
+    #  - 0 means largest size, but fast compression
+    #  - 9 means smallest size, but slow compression
+    #  - any number in between is a compromise
+    :gz_strategy: 9
+
+
+

data/conf/default_strings.yaml

@@ -0,0 +1,76 @@
+
+  # Default string configuration file
+
+  # System message strings
+  :messages:
+
+    :transporter:
+      #
+      # If the client fails on javascript, display this:
+      :client_error:
+        :title: 'ClientError'
+        :descr: 'Javascript execution error:'
+        :uri:   '/'
+      #
+      # If the filecache fails, display this:
+      :filecache_error:
+        :title: 'FileCacheError'
+        :descr: 'FileCache failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins rescan fails, display this:
+      :plugins_rescan_error:
+        :title: 'PluginsRescanError'
+        :descr: 'The initialization of a plugin failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins rescan fails, display this:
+      :valuemanager_xhr_error:
+        :title: 'ValueSyncError'
+        :descr: 'Data value synchronization failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins rescan fails, display this:
+      :valuemanager_validate_error:
+        :title: 'ValueValidationError'
+        :descr: 'The value validation failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins rescan fails, display this:
+      :valuemanager_sync_client_error:
+        :title:  'SyncClientError'
+        :descr:  'The value synchronization to the client failed with error:'
+        :uri:    '/'
+      #
+      # If the plugins rescan fails, display this:
+      :plugin_delegate_restore_ses_error:
+        :title: 'RestoreSesError'
+        :descr: 'The plugin delegation process for restore_ses failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins rescan fails, display this:
+      :plugin_delegate_init_ses_error:
+        :title: 'InitSesError'
+        :descr: 'The plugin delegation process for init_ses failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins delegation of the cloned_target event fails, display this:
+      :plugin_delegate_cloned_target_error:
+        :title: 'ClonedTargetError'
+        :descr: 'The plugin delegation process for cloned_target failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins delegation of the cloned_source event fails, display this:
+      :plugin_delegate_cloned_source_error:
+        :title: 'ClonedSourceError'
+        :descr: 'The plugin delegation process for cloned_source failed with error:'
+        :uri:   '/'
+      #
+      # If the plugins rescan fails, display this:
+      :plugin_idle_error:
+        :title: 'PluginIdleError'
+        :descr: 'The idle event failed for a plugin with error:'
+        :uri:   '/'
+
+
+