rsence 2.0.0.0.pre → 2.0.0.1.pre

data/INSTALL.rdoc

@@ -1,10 +1,11 @@
 
+= NOTE: This installation manual isn't fully accurate at this time.
+
 = Installation
 
 If you already have a working ruby environment and know what to do, the easiest way is just:
 
- gem install rsence-deps
- gem install rsence
+ gem install rsence --pre
 
 Otherwise, follow these instructions:
 
@@ -183,7 +184,7 @@ There are two main options: *release* and *development*. Choose one of these:
 === 3.2. Setting up
 
 ==== 3.2.1. Start RSence in the development mode with logs printed to the standard output:
-  bin/run -d --log-fg
+  rsence run -df
 
 ==== 3.2.2. Configuration
 When starting up RSence for the first time, a configuration wizard is run. Just press return on the questions to use the default configuration. The default option is upper case: pressing return at a "Y/n" prompt will select "Y"
@@ -206,50 +207,49 @@ When starting up RSence for the first time, a configuration wizard is run. Just
 Just press CTRL-C in the terminal.
 
 ==== 3.3.5. Manual configuration
-Edit the conf/local_conf.yaml file. To see all available options at their default state, see conf/default_conf.yaml
+Edit the conf/config.yaml file. To see all available options at their default state, see conf/default_conf.yaml
 
 
 == 4. Controlling the process
 For development purposes (and the only option on Microsoft Windows):
 
 Starting in foreground mode:
-  bin/run
+  rsence run
 
 Starting in foreground mode with debug mode:
-  bin/run -d
+  rsence run -d
 
 Starting in foreground mode with debug and logging in foreground:
-  bin/run -d --log-fg
+  rsence run -df
 
 Stopping in foreground mode: Press CTRL-C
 
 *NOTE: on Microsoft Windows:*
-* Either just double-click the *run.rb* file in the bin directory or prefix all commands in the command prompt with *ruby*
 * No backgrounding is supported, unless *run.rb* is configured as a Service.
 
 === 4.1. Starting the server in background mode
 In the background mode, standard output and standard errors are logged in the var/log directory and the pidfile is written in the var/pid directory.
-  bin/start
+  rsence start
 
 === 4.2. Stopping the server in background mode
-  bin/stop
+  rsence stop
 
 === 4.3. Checking the server status in background mode
-  bin/status
+  rsence status
 
 === 4.4. Restarting the server in background mode
-  bin/restart
+  rsence restart
 
 === 4.5. Re-setting the sessions
 This is needed only, if the session storage becomes corrupt or you just want to start with a clean set of sessions.
 Just apply the --reset-sessions option after the run, start or restart command in the command prompt.
-  bin/restart --reset-sessions
+  rsence restart --reset-sessions
 
 *NOTE: All the sessions currently connected clients are invalidated and need to reload the page*
 
 === 4.6. Running in development mode
 Just apply the -d option after the *run*, *start* or *restart* command in the command prompt.
-  bin/restart -d
+  rsence restart -d
 
 ==== 4.6.1. What does development mode do?
 * Plugins are reloaded automatically in the background, if they are changed, disabled, added or removed.
@@ -258,7 +258,7 @@ Just apply the -d option after the *run*, *start* or *restart* command in the co
 
 === 4.7. Other command-line options
 Just run this command to see the available options:
-  bin/help
+  rsence help
 
 === 4.8. Running RSence using rackup
   rackup conf/config.ru

data/README.rdoc

@@ -1,16 +1,79 @@
 
-= RSence 2.0.pre                                                       2010-??-??
+= RSence 2.0.0.1.pre                                                       2010-??-??
 
 http://rsence.org/
 
-=== Introduction
+== Introduction
 
 RSence is primarily 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 uses the server for backend tasks and the client to provide responsive user interfaces. The server is a highly optimized Ruby framework for writing applications as plugin bundles containing all resources needed per plugin. The client is a highly optimized Javascript framework with an API similar to many object-oriented desktop frameworks. RSence is not primarily targeted for creating html web sites, there are plenty of other tools for that purpose.
 
-=== Installation (pre-release):
+
+== Installation (pre-release):
 
  gem install rsence --pre
 
+== Setting up a project (TODO; needs to be done manually still)
+
+ rsence initenv /path/of/project
+
+== Project anatomy:
+
+The expected structure of a project environment (where 'project_directory'
+is the directory of your project) is:
+
+  [dir]   project_directory   :: The directory of your project.
+    [dir]   conf              :: The directory of config files.
+      [file]  config.yaml     :: The config file to load by defult.
+    [dir]   var               :: Directory containing various runtime files.
+      [dir]  run              :: Directory containing PID files.
+      [dir]  log              :: Directory containing log files.
+      [dir]  db               :: Directory containing database files.
+    [dir]   plugins           :: Directory containing installed plugins.
+
+The 'config.yaml' file contains patches specific to your project.
+
+The configuration files are loaded and applied in this order:
+  1:  [rsence_install_path]/conf/default_conf.yaml
+  2:  [rsence_install_path]/conf/local_conf.yaml
+  3:  /etc/rsence/config.yaml
+  4:  ~/.rsence/config.yaml
+  5:  [project_directory]/conf/config.yaml
+  6:  Any files given using --conf parameters, in order of occurrence.
+ 
+The plugins directory contains the plugins installed in the project.
+
+== Running a project
+
+Each command-line tool command takes a number of options, the path defaults to the current working directory.
+
+=== Running in foregrond
+  rsence run /path/of/project
+
+=== Running in background
+  rsence start /path/of/project
+
+=== Stopiing from background
+  rsence stop /path/of/project
+
+=== Restarting in background
+  rsence restart /path/of/project
+
+=== Checking if project is running
+  rsence status /path/of/project
+
+== RSence command-line tool help
+
+=== Lists all available commands
+  rsence help
+
+=== Getting detailed instructions of a command
+  rsence help <command>
+
+eg:
+
+  rsence help run
+
+
 For more detailed installation and usage instructions, read the INSTALL.rdoc document.
 
 === Licensing:

data/VERSION

@@ -1 +1 @@
-2.0.0.0.pre
+2.0.0.1.pre

data/bin/rsence

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #--
 ##   Riassence Framework
- #   Copyright 2008 Riassence Inc.
+ #   Copyright 2010 Riassence Inc.
  #   http://riassence.com/
  #
  #   You should have received a copy of the GNU General Public License along
@@ -9,112 +9,16 @@
  ##
  #++
 
-if RUBY_VERSION.to_f >= 1.9
-  Encoding.default_external = Encoding::ASCII_8BIT
-end
-
-is_win = ['i386-mingw32','x86-mingw32'].include? RUBY_PLATFORM
-
-if is_win
-  commands = %w[help run]
-else
-  commands = %w[help start stop restart status run]
-end
-
-if ARGV.include?('--help') or ARGV.include?('-h') or
-   ARGV.include?('help') or not (
-    commands.include?(ARGV[0])
-  )
-  
-  if is_win
-    extra_cmd_help = ''
-    extra_cmd_examples = %{
-    #{__FILE__} run --log-fg
-    #{__FILE__} run -d
-    #{__FILE__} run --latency 150
-    #{__FILE__} run --server mongrel --port 8080 --addr 127.0.0.1
-}
-  else
-    extra_cmd_help = %{\
-    status     Tells if Riassence Framework Server is running or not
-    start      Starts Riassence Framework Server
-    stop       Stops Riassence Framework Server
-    restart    Restarts Riassence Framework Server
-    save       Saves Riassence Framework Server session data
-}
-    extra_cmd_examples = %{\
-    #{__FILE__} status
-    #{__FILE__} start
-    #{__FILE__} stop
-    #{__FILE__} save
-    #{__FILE__} restart
-    #{__FILE__} restart -d --reset-sessions
-    #{__FILE__} restart --latency 150
-    #{__FILE__} restart --server mongrel --port 8080 --addr 127.0.0.1
-}
-  end
-  
-  puts %{
-
-  Riassence Framework is RIA client and server. This help message contains
-  hints about how to control the server startup/shutdown.
-
-  Usage:
-    #{__FILE__} command [params]
-
-  Command is one of:
-    run        Run in foreground (exit with ctrl-c)
-#{extra_cmd_help}    help       This message
-  
-  Params:
-    --log-fg                Don't write log into file (writes to foreground)
-    -d                      Debug/Development mode
-    --trace-js              Write content of msg.reply calls to stdout
-    --trace-delegate        Traces plugin method delegation to stdout
-    --root-path <PATH>      Define the PATH to rsence server
-                              Defaults to 'bin'
-    --port PORT             Define the http PORT to use, defaults to '8001'
-    --latency MS            Simulate network latency, value in milliseconds
-    --addr <ADDRESS>        Define the IPv4 ADDRESS to bind to.
-                              Defaults to '0.0.0.0' (any)
-    --server <SERVER>       Choose http SERVER, valid choices:
-                               - webrick
-                               - mongrel
-                               - ebb
-                               - thin
-                               Defaults to thin
-    --reset-sessions        Deletes all old sessions on startup
-    --config <PATH>         Optional config override file
-    --run-config-wizard     Runs configuration wizard
-                              Runs by default, if no local
-                              configuration files were found.
-    --no-rescan             Doesn't rescan the plugins even when in debug mode.
-    --profile               Turns on profiling
-                              - Runs everything considerable slower!
-                              - Shown a table displaying the results on stop.
-    --help                  This message
-    -h                      This message
-  
-  Examples:
-    #{__FILE__} run
-#{extra_cmd_examples}  
-  Further information:
-     http://riassence.org/
-
-}
-  exit
-end
-
 require 'profile' if ARGV.include?('--profile')
 
 ## Auto-construct paths using this file as the waypoint
-SERVER_PATH = ARGV.include?('--root-path')?(ARGV[ARGV.index('--root-path')+1]):File.split(File.expand_path(File.dirname(__FILE__)))[0]
+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' )
 
-## Riassence Daemon controls
-require 'daemon/daemon'
-RSence::HTTPDaemon.daemonize
+require 'conf/argv'
+
+RSence.startup if RSence.startable?
 

data/conf/config.yaml

@@ -0,0 +1,4 @@
+:http_server:
+  :port: 8002
+:index_html:
+  :title: "Hellou"

data/conf/default_conf.yaml

@@ -151,7 +151,7 @@
 # Database configuration
 :database:
   # Session database storage string. Leave empty here to enable the wizard for storage.
-  :ses_db: 'sqlite://var/lib/rsence/db/ses.db'
+  :ses_db: 'sqlite://db/ses.db'
 
 #
 # ValueManager settings
@@ -178,10 +178,10 @@
 :client_pkg:
   
   # Source directories to scan
-  :src_dirs:
+  :src_dirs: []
     
     # RSence Client Framework
-    - js
+    #- js
     
     # How to include your own custom js package directory:
     # - /home/me/code/extra_components
@@ -308,6 +308,8 @@
     - .gif
     - .png
     - .swf
+    - .svg
+    - .pdf
   
   # The name of the include file
   :js_inc: js.inc