rsence 2.0.0.0.pre → 2.0.0.1.pre

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/INSTALL.rdoc CHANGED
@@ -1,10 +1,11 @@
1
1
 
2
+ = NOTE: This installation manual isn't fully accurate at this time.
3
+
2
4
  = Installation
3
5
 
4
6
  If you already have a working ruby environment and know what to do, the easiest way is just:
5
7
 
6
- gem install rsence-deps
7
- gem install rsence
8
+ gem install rsence --pre
8
9
 
9
10
  Otherwise, follow these instructions:
10
11
 
@@ -183,7 +184,7 @@ There are two main options: *release* and *development*. Choose one of these:
183
184
  === 3.2. Setting up
184
185
 
185
186
  ==== 3.2.1. Start RSence in the development mode with logs printed to the standard output:
186
- bin/run -d --log-fg
187
+ rsence run -df
187
188
 
188
189
  ==== 3.2.2. Configuration
189
190
  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
206
207
  Just press CTRL-C in the terminal.
207
208
 
208
209
  ==== 3.3.5. Manual configuration
209
- Edit the conf/local_conf.yaml file. To see all available options at their default state, see conf/default_conf.yaml
210
+ Edit the conf/config.yaml file. To see all available options at their default state, see conf/default_conf.yaml
210
211
 
211
212
 
212
213
  == 4. Controlling the process
213
214
  For development purposes (and the only option on Microsoft Windows):
214
215
 
215
216
  Starting in foreground mode:
216
- bin/run
217
+ rsence run
217
218
 
218
219
  Starting in foreground mode with debug mode:
219
- bin/run -d
220
+ rsence run -d
220
221
 
221
222
  Starting in foreground mode with debug and logging in foreground:
222
- bin/run -d --log-fg
223
+ rsence run -df
223
224
 
224
225
  Stopping in foreground mode: Press CTRL-C
225
226
 
226
227
  *NOTE: on Microsoft Windows:*
227
- * Either just double-click the *run.rb* file in the bin directory or prefix all commands in the command prompt with *ruby*
228
228
  * No backgrounding is supported, unless *run.rb* is configured as a Service.
229
229
 
230
230
  === 4.1. Starting the server in background mode
231
231
  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.
232
- bin/start
232
+ rsence start
233
233
 
234
234
  === 4.2. Stopping the server in background mode
235
- bin/stop
235
+ rsence stop
236
236
 
237
237
  === 4.3. Checking the server status in background mode
238
- bin/status
238
+ rsence status
239
239
 
240
240
  === 4.4. Restarting the server in background mode
241
- bin/restart
241
+ rsence restart
242
242
 
243
243
  === 4.5. Re-setting the sessions
244
244
  This is needed only, if the session storage becomes corrupt or you just want to start with a clean set of sessions.
245
245
  Just apply the --reset-sessions option after the run, start or restart command in the command prompt.
246
- bin/restart --reset-sessions
246
+ rsence restart --reset-sessions
247
247
 
248
248
  *NOTE: All the sessions currently connected clients are invalidated and need to reload the page*
249
249
 
250
250
  === 4.6. Running in development mode
251
251
  Just apply the -d option after the *run*, *start* or *restart* command in the command prompt.
252
- bin/restart -d
252
+ rsence restart -d
253
253
 
254
254
  ==== 4.6.1. What does development mode do?
255
255
  * 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
258
258
 
259
259
  === 4.7. Other command-line options
260
260
  Just run this command to see the available options:
261
- bin/help
261
+ rsence help
262
262
 
263
263
  === 4.8. Running RSence using rackup
264
264
  rackup conf/config.ru
data/README.rdoc CHANGED
@@ -1,16 +1,79 @@
1
1
 
2
- = RSence 2.0.pre 2010-??-??
2
+ = RSence 2.0.0.1.pre 2010-??-??
3
3
 
4
4
  http://rsence.org/
5
5
 
6
- === Introduction
6
+ == Introduction
7
7
 
8
8
  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.
9
9
 
10
- === Installation (pre-release):
10
+
11
+ == Installation (pre-release):
11
12
 
12
13
  gem install rsence --pre
13
14
 
15
+ == Setting up a project (TODO; needs to be done manually still)
16
+
17
+ rsence initenv /path/of/project
18
+
19
+ == Project anatomy:
20
+
21
+ The expected structure of a project environment (where 'project_directory'
22
+ is the directory of your project) is:
23
+
24
+ [dir] project_directory :: The directory of your project.
25
+ [dir] conf :: The directory of config files.
26
+ [file] config.yaml :: The config file to load by defult.
27
+ [dir] var :: Directory containing various runtime files.
28
+ [dir] run :: Directory containing PID files.
29
+ [dir] log :: Directory containing log files.
30
+ [dir] db :: Directory containing database files.
31
+ [dir] plugins :: Directory containing installed plugins.
32
+
33
+ The 'config.yaml' file contains patches specific to your project.
34
+
35
+ The configuration files are loaded and applied in this order:
36
+ 1: [rsence_install_path]/conf/default_conf.yaml
37
+ 2: [rsence_install_path]/conf/local_conf.yaml
38
+ 3: /etc/rsence/config.yaml
39
+ 4: ~/.rsence/config.yaml
40
+ 5: [project_directory]/conf/config.yaml
41
+ 6: Any files given using --conf parameters, in order of occurrence.
42
+
43
+ The plugins directory contains the plugins installed in the project.
44
+
45
+ == Running a project
46
+
47
+ Each command-line tool command takes a number of options, the path defaults to the current working directory.
48
+
49
+ === Running in foregrond
50
+ rsence run /path/of/project
51
+
52
+ === Running in background
53
+ rsence start /path/of/project
54
+
55
+ === Stopiing from background
56
+ rsence stop /path/of/project
57
+
58
+ === Restarting in background
59
+ rsence restart /path/of/project
60
+
61
+ === Checking if project is running
62
+ rsence status /path/of/project
63
+
64
+ == RSence command-line tool help
65
+
66
+ === Lists all available commands
67
+ rsence help
68
+
69
+ === Getting detailed instructions of a command
70
+ rsence help <command>
71
+
72
+ eg:
73
+
74
+ rsence help run
75
+
76
+
14
77
  For more detailed installation and usage instructions, read the INSTALL.rdoc document.
15
78
 
16
79
  === Licensing:
data/VERSION CHANGED
@@ -1 +1 @@
1
- 2.0.0.0.pre
1
+ 2.0.0.1.pre
data/bin/rsence CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  #--
3
3
  ## Riassence Framework
4
- # Copyright 2008 Riassence Inc.
4
+ # Copyright 2010 Riassence Inc.
5
5
  # http://riassence.com/
6
6
  #
7
7
  # You should have received a copy of the GNU General Public License along
@@ -9,112 +9,16 @@
9
9
  ##
10
10
  #++
11
11
 
12
- if RUBY_VERSION.to_f >= 1.9
13
- Encoding.default_external = Encoding::ASCII_8BIT
14
- end
15
-
16
- is_win = ['i386-mingw32','x86-mingw32'].include? RUBY_PLATFORM
17
-
18
- if is_win
19
- commands = %w[help run]
20
- else
21
- commands = %w[help start stop restart status run]
22
- end
23
-
24
- if ARGV.include?('--help') or ARGV.include?('-h') or
25
- ARGV.include?('help') or not (
26
- commands.include?(ARGV[0])
27
- )
28
-
29
- if is_win
30
- extra_cmd_help = ''
31
- extra_cmd_examples = %{
32
- #{__FILE__} run --log-fg
33
- #{__FILE__} run -d
34
- #{__FILE__} run --latency 150
35
- #{__FILE__} run --server mongrel --port 8080 --addr 127.0.0.1
36
- }
37
- else
38
- extra_cmd_help = %{\
39
- status Tells if Riassence Framework Server is running or not
40
- start Starts Riassence Framework Server
41
- stop Stops Riassence Framework Server
42
- restart Restarts Riassence Framework Server
43
- save Saves Riassence Framework Server session data
44
- }
45
- extra_cmd_examples = %{\
46
- #{__FILE__} status
47
- #{__FILE__} start
48
- #{__FILE__} stop
49
- #{__FILE__} save
50
- #{__FILE__} restart
51
- #{__FILE__} restart -d --reset-sessions
52
- #{__FILE__} restart --latency 150
53
- #{__FILE__} restart --server mongrel --port 8080 --addr 127.0.0.1
54
- }
55
- end
56
-
57
- puts %{
58
-
59
- Riassence Framework is RIA client and server. This help message contains
60
- hints about how to control the server startup/shutdown.
61
-
62
- Usage:
63
- #{__FILE__} command [params]
64
-
65
- Command is one of:
66
- run Run in foreground (exit with ctrl-c)
67
- #{extra_cmd_help} help This message
68
-
69
- Params:
70
- --log-fg Don't write log into file (writes to foreground)
71
- -d Debug/Development mode
72
- --trace-js Write content of msg.reply calls to stdout
73
- --trace-delegate Traces plugin method delegation to stdout
74
- --root-path <PATH> Define the PATH to rsence server
75
- Defaults to 'bin'
76
- --port PORT Define the http PORT to use, defaults to '8001'
77
- --latency MS Simulate network latency, value in milliseconds
78
- --addr <ADDRESS> Define the IPv4 ADDRESS to bind to.
79
- Defaults to '0.0.0.0' (any)
80
- --server <SERVER> Choose http SERVER, valid choices:
81
- - webrick
82
- - mongrel
83
- - ebb
84
- - thin
85
- Defaults to thin
86
- --reset-sessions Deletes all old sessions on startup
87
- --config <PATH> Optional config override file
88
- --run-config-wizard Runs configuration wizard
89
- Runs by default, if no local
90
- configuration files were found.
91
- --no-rescan Doesn't rescan the plugins even when in debug mode.
92
- --profile Turns on profiling
93
- - Runs everything considerable slower!
94
- - Shown a table displaying the results on stop.
95
- --help This message
96
- -h This message
97
-
98
- Examples:
99
- #{__FILE__} run
100
- #{extra_cmd_examples}
101
- Further information:
102
- http://riassence.org/
103
-
104
- }
105
- exit
106
- end
107
-
108
12
  require 'profile' if ARGV.include?('--profile')
109
13
 
110
14
  ## Auto-construct paths using this file as the waypoint
111
- SERVER_PATH = ARGV.include?('--root-path')?(ARGV[ARGV.index('--root-path')+1]):File.split(File.expand_path(File.dirname(__FILE__)))[0]
15
+ SERVER_PATH = File.split( File.expand_path(File.dirname(__FILE__)) )[0]
112
16
 
113
17
  ## Include server & lib in the search path
114
18
  $LOAD_PATH << SERVER_PATH
115
19
  $LOAD_PATH << File.join( SERVER_PATH, 'lib' )
116
20
 
117
- ## Riassence Daemon controls
118
- require 'daemon/daemon'
119
- RSence::HTTPDaemon.daemonize
21
+ require 'conf/argv'
22
+
23
+ RSence.startup if RSence.startable?
120
24
 
data/conf/config.yaml ADDED
@@ -0,0 +1,4 @@
1
+ :http_server:
2
+ :port: 8002
3
+ :index_html:
4
+ :title: "Hellou"
@@ -151,7 +151,7 @@
151
151
  # Database configuration
152
152
  :database:
153
153
  # Session database storage string. Leave empty here to enable the wizard for storage.
154
- :ses_db: 'sqlite://var/lib/rsence/db/ses.db'
154
+ :ses_db: 'sqlite://db/ses.db'
155
155
 
156
156
  #
157
157
  # ValueManager settings
@@ -178,10 +178,10 @@
178
178
  :client_pkg:
179
179
 
180
180
  # Source directories to scan
181
- :src_dirs:
181
+ :src_dirs: []
182
182
 
183
183
  # RSence Client Framework
184
- - js
184
+ #- js
185
185
 
186
186
  # How to include your own custom js package directory:
187
187
  # - /home/me/code/extra_components
@@ -308,6 +308,8 @@
308
308
  - .gif
309
309
  - .png
310
310
  - .swf
311
+ - .svg
312
+ - .pdf
311
313
 
312
314
  # The name of the include file
313
315
  :js_inc: js.inc
File without changes