netzke-communitypack 0.1.1.beta → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (59) hide show
  1. data/.gitignore +1 -0
  2. data/CHANGELOG.rdoc +3 -0
  3. data/README.rdoc +6 -1
  4. data/lib/netzke-communitypack/version.rb +2 -3
  5. data/lib/netzke/communitypack/google_map_panel.rb +30 -0
  6. data/lib/netzke/communitypack/google_map_panel/javascript/GMapPanel.js +215 -0
  7. data/{app/components → lib}/netzke/communitypack/live_search_grid_panel.rb +0 -0
  8. data/lib/netzke/communitypack/viewport.rb +4 -0
  9. data/test/rails_app/.gitignore +4 -0
  10. data/test/rails_app/Gemfile +34 -0
  11. data/test/rails_app/Gemfile.lock +89 -0
  12. data/test/rails_app/README +256 -0
  13. data/test/rails_app/Rakefile +7 -0
  14. data/test/rails_app/app/components/test_panel.rb +3 -0
  15. data/test/rails_app/app/controllers/application_controller.rb +3 -0
  16. data/test/rails_app/app/controllers/components_controller.rb +5 -0
  17. data/test/rails_app/app/helpers/application_helper.rb +2 -0
  18. data/test/rails_app/app/helpers/components_helper.rb +2 -0
  19. data/test/rails_app/app/views/components/show.html.erb +13 -0
  20. data/test/rails_app/app/views/layouts/application.html.erb +17 -0
  21. data/test/rails_app/config.ru +4 -0
  22. data/test/rails_app/config/application.rb +45 -0
  23. data/test/rails_app/config/boot.rb +13 -0
  24. data/test/rails_app/config/database.yml +22 -0
  25. data/test/rails_app/config/environment.rb +5 -0
  26. data/test/rails_app/config/environments/development.rb +26 -0
  27. data/test/rails_app/config/environments/production.rb +49 -0
  28. data/test/rails_app/config/environments/test.rb +35 -0
  29. data/test/rails_app/config/initializers/backtrace_silencers.rb +7 -0
  30. data/test/rails_app/config/initializers/inflections.rb +10 -0
  31. data/test/rails_app/config/initializers/mime_types.rb +5 -0
  32. data/test/rails_app/config/initializers/secret_token.rb +7 -0
  33. data/test/rails_app/config/initializers/session_store.rb +8 -0
  34. data/test/rails_app/config/locales/en.yml +5 -0
  35. data/test/rails_app/config/routes.rb +61 -0
  36. data/test/rails_app/db/seeds.rb +7 -0
  37. data/test/rails_app/doc/README_FOR_APP +2 -0
  38. data/test/rails_app/lib/tasks/.gitkeep +0 -0
  39. data/test/rails_app/public/404.html +26 -0
  40. data/test/rails_app/public/422.html +26 -0
  41. data/test/rails_app/public/500.html +26 -0
  42. data/test/rails_app/public/favicon.ico +0 -0
  43. data/test/rails_app/public/images/rails.png +0 -0
  44. data/test/rails_app/public/index.html +239 -0
  45. data/test/rails_app/public/javascripts/application.js +2 -0
  46. data/test/rails_app/public/javascripts/controls.js +965 -0
  47. data/test/rails_app/public/javascripts/dragdrop.js +974 -0
  48. data/test/rails_app/public/javascripts/effects.js +1123 -0
  49. data/test/rails_app/public/javascripts/prototype.js +6001 -0
  50. data/test/rails_app/public/javascripts/rails.js +175 -0
  51. data/test/rails_app/public/robots.txt +5 -0
  52. data/test/rails_app/public/stylesheets/.gitkeep +0 -0
  53. data/test/rails_app/script/rails +6 -0
  54. data/test/rails_app/test/functional/components_controller_test.rb +8 -0
  55. data/test/rails_app/test/performance/browsing_test.rb +9 -0
  56. data/test/rails_app/test/test_helper.rb +13 -0
  57. data/test/rails_app/test/unit/helpers/components_helper_test.rb +4 -0
  58. data/test/rails_app/vendor/plugins/.gitkeep +0 -0
  59. metadata +59 -6
data/.gitignore CHANGED
@@ -1,3 +1,4 @@
1
1
  pkg/*
2
2
  *.gem
3
3
  .bundle
4
+ /test/rails_app/public/extjs
@@ -0,0 +1,3 @@
1
+ = v0.1.1 - 2010-10-25
2
+
3
+ = v0.1.0 - 2010-10-21
@@ -1 +1,6 @@
1
- Requires the "rails3" branch of netzke-core and netzke-basepack.
1
+ = Netzke components submitted by the community
2
+
3
+ Includes the following components:
4
+
5
+ * LiveSearchGridPanel - GridPanel extension with a configurable live-search textfield
6
+ * GoogleMapPanel - Panel showing a Google map
@@ -2,10 +2,9 @@ module Netzke
2
2
  module Communitypack
3
3
  MAJOR = 0
4
4
  MINOR = 1
5
- PATCH = 1
6
- BUILD = 'beta'
5
+ PATCH = 3
7
6
 
8
- STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
7
+ STRING = [MAJOR, MINOR, PATCH].compact.join('.')
9
8
  VERSION = STRING
10
9
  end
11
10
  end
@@ -0,0 +1,30 @@
1
+ # Creates a google map panel. The panel additionaly has the options of google maps, i.e.:
2
+ # * +zoom_level+ - The initial zoom level
3
+ # * +gmap_type+ -
4
+ # * +map_conf_opts+ -
5
+ # * +map_controlls+ -
6
+ # * +set_center+ - The initial map position
7
+ # * +markers+ - Initial markers on the page
8
+ # ...
9
+ class Netzke::Communitypack::GoogleMapPanel < ::Netzke::Base
10
+ js_include "#{File.dirname(__FILE__)}/google_map_panel/javascript/GMapPanel.js"
11
+
12
+ # default configuration
13
+ config do
14
+ {
15
+ :zoom_level => 14,
16
+ :gmap_type => 'map',
17
+ :layout => :fit,
18
+ :map_conf_opts => ['enableScrollWheelZoom','enableDoubleClickZoom','enableDragging'],
19
+ :map_controls => ['GSmallMapControl','GMapTypeControl','NonExistantControl'],
20
+ :set_center => {
21
+ :geo_code_addr => 'Flottwellstr. 4-5, 10785 Berlin, Germany',
22
+ :marker => {
23
+ :title => 'pme Familienservice GmbH'
24
+ }
25
+ }
26
+ }
27
+ end
28
+
29
+ js_base_class 'Ext.ux.GMapPanel'
30
+ end
@@ -0,0 +1,215 @@
1
+ /*!
2
+ * Ext JS Library 3.3.0
3
+ * Copyright(c) 2006-2010 Ext JS, Inc.
4
+ * licensing@extjs.com
5
+ * http://www.extjs.com/license
6
+ */
7
+ /**
8
+ * @class Ext.ux.GMapPanel
9
+ * @extends Ext.Panel
10
+ * @author Shea Frederick
11
+ */
12
+ Ext.ux.GMapPanel = Ext.extend(Ext.Panel, {
13
+ initComponent : function(){
14
+
15
+ var defConfig = {
16
+ plain: true,
17
+ zoomLevel: 3,
18
+ yaw: 180,
19
+ pitch: 0,
20
+ zoom: 0,
21
+ gmapType: 'map',
22
+ border: false
23
+ };
24
+
25
+ Ext.applyIf(this,defConfig);
26
+
27
+ Ext.ux.GMapPanel.superclass.initComponent.call(this);
28
+
29
+ },
30
+ afterRender : function(){
31
+
32
+ var wh = this.ownerCt.getSize();
33
+ Ext.applyIf(this, wh);
34
+
35
+ Ext.ux.GMapPanel.superclass.afterRender.call(this);
36
+
37
+ if (this.gmapType === 'map'){
38
+ this.gmap = new GMap2(this.body.dom);
39
+ }
40
+
41
+ if (this.gmapType === 'panorama'){
42
+ this.gmap = new GStreetviewPanorama(this.body.dom);
43
+ }
44
+
45
+ if (typeof this.addControl == 'object' && this.gmapType === 'map') {
46
+ this.gmap.addControl(this.addControl);
47
+ }
48
+
49
+ if (typeof this.setCenter === 'object') {
50
+ if (typeof this.setCenter.geoCodeAddr === 'string'){
51
+ this.geoCodeLookup(this.setCenter.geoCodeAddr);
52
+ }else{
53
+ if (this.gmapType === 'map'){
54
+ var point = new GLatLng(this.setCenter.lat,this.setCenter.lng);
55
+ this.gmap.setCenter(point, this.zoomLevel);
56
+ }
57
+ if (typeof this.setCenter.marker === 'object' && typeof point === 'object'){
58
+ this.addMarker(point,this.setCenter.marker,this.setCenter.marker.clear);
59
+ }
60
+ }
61
+ if (this.gmapType === 'panorama'){
62
+ this.gmap.setLocationAndPOV(new GLatLng(this.setCenter.lat,this.setCenter.lng), {yaw: this.yaw, pitch: this.pitch, zoom: this.zoom});
63
+ }
64
+ }
65
+
66
+ GEvent.bind(this.gmap, 'load', this, function(){
67
+ this.onMapReady();
68
+ });
69
+
70
+ },
71
+ onMapReady : function(){
72
+ this.addMarkers(this.markers);
73
+ this.addMapControls();
74
+ this.addOptions();
75
+ },
76
+ onResize : function(w, h){
77
+
78
+ if (typeof this.getMap() == 'object') {
79
+ this.gmap.checkResize();
80
+ }
81
+
82
+ Ext.ux.GMapPanel.superclass.onResize.call(this, w, h);
83
+
84
+ },
85
+ setSize : function(width, height, animate){
86
+
87
+ if (typeof this.getMap() == 'object') {
88
+ this.gmap.checkResize();
89
+ }
90
+
91
+ Ext.ux.GMapPanel.superclass.setSize.call(this, width, height, animate);
92
+
93
+ },
94
+ getMap : function(){
95
+
96
+ return this.gmap;
97
+
98
+ },
99
+ getCenter : function(){
100
+
101
+ return this.getMap().getCenter();
102
+
103
+ },
104
+ getCenterLatLng : function(){
105
+
106
+ var ll = this.getCenter();
107
+ return {lat: ll.lat(), lng: ll.lng()};
108
+
109
+ },
110
+ addMarkers : function(markers) {
111
+
112
+ if (Ext.isArray(markers)){
113
+ for (var i = 0; i < markers.length; i++) {
114
+ var mkr_point = new GLatLng(markers[i].lat,markers[i].lng);
115
+ this.addMarker(mkr_point,markers[i].marker,false,markers[i].setCenter, markers[i].listeners);
116
+ }
117
+ }
118
+
119
+ },
120
+ addMarker : function(point, marker, clear, center, listeners){
121
+
122
+ Ext.applyIf(marker,G_DEFAULT_ICON);
123
+
124
+ if (clear === true){
125
+ this.getMap().clearOverlays();
126
+ }
127
+ if (center === true) {
128
+ this.getMap().setCenter(point, this.zoomLevel);
129
+ }
130
+
131
+ var mark = new GMarker(point,marker);
132
+ if (typeof listeners === 'object'){
133
+ for (evt in listeners) {
134
+ GEvent.bind(mark, evt, this, listeners[evt]);
135
+ }
136
+ }
137
+ this.getMap().addOverlay(mark);
138
+
139
+ },
140
+ addMapControls : function(){
141
+
142
+ if (this.gmapType === 'map') {
143
+ if (Ext.isArray(this.mapControls)) {
144
+ for(i=0;i<this.mapControls.length;i++){
145
+ this.addMapControl(this.mapControls[i]);
146
+ }
147
+ }else if(typeof this.mapControls === 'string'){
148
+ this.addMapControl(this.mapControls);
149
+ }else if(typeof this.mapControls === 'object'){
150
+ this.getMap().addControl(this.mapControls);
151
+ }
152
+ }
153
+
154
+ },
155
+ addMapControl : function(mc){
156
+
157
+ var mcf = window[mc];
158
+ if (typeof mcf === 'function') {
159
+ this.getMap().addControl(new mcf());
160
+ }
161
+
162
+ },
163
+ addOptions : function(){
164
+
165
+ if (Ext.isArray(this.mapConfOpts)) {
166
+ var mc;
167
+ for(i=0;i<this.mapConfOpts.length;i++){
168
+ this.addOption(this.mapConfOpts[i]);
169
+ }
170
+ }else if(typeof this.mapConfOpts === 'string'){
171
+ this.addOption(this.mapConfOpts);
172
+ }
173
+
174
+ },
175
+ addOption : function(mc){
176
+
177
+ var mcf = this.getMap()[mc];
178
+ if (typeof mcf === 'function') {
179
+ this.getMap()[mc]();
180
+ }
181
+
182
+ },
183
+ geoCodeLookup : function(addr) {
184
+
185
+ this.geocoder = new GClientGeocoder();
186
+ this.geocoder.getLocations(addr, this.addAddressToMap.createDelegate(this));
187
+
188
+ },
189
+ addAddressToMap : function(response) {
190
+
191
+ if (!response || response.Status.code != 200) {
192
+ Ext.MessageBox.alert('Error', 'Code '+response.Status.code+' Error Returned');
193
+ }else{
194
+ place = response.Placemark[0];
195
+ addressinfo = place.AddressDetails;
196
+ accuracy = addressinfo.Accuracy;
197
+ if (accuracy === 0) {
198
+ Ext.MessageBox.alert('Unable to Locate Address', 'Unable to Locate the Address you provided');
199
+ }else{
200
+ if (accuracy < 7) {
201
+ Ext.MessageBox.alert('Address Accuracy', 'The address provided has a low accuracy.<br><br>Level '+accuracy+' Accuracy (8 = Exact Match, 1 = Vague Match)');
202
+ }else{
203
+ point = new GLatLng(place.Point.coordinates[1], place.Point.coordinates[0]);
204
+ if (typeof this.setCenter.marker === 'object' && typeof point === 'object'){
205
+ this.addMarker(point,this.setCenter.marker,this.setCenter.marker.clear,true, this.setCenter.listeners);
206
+ }
207
+ }
208
+ }
209
+ }
210
+
211
+ }
212
+
213
+ });
214
+
215
+ Ext.reg('gmappanel', Ext.ux.GMapPanel);
@@ -0,0 +1,4 @@
1
+ # A simple Ext.Viewport
2
+ class Netzke::Communitypack::Viewport < ::Netzke::Base
3
+ js_base_class 'Ext.Viewport'
4
+ end
@@ -0,0 +1,4 @@
1
+ .bundle
2
+ db/*.sqlite3
3
+ log/*.log
4
+ tmp/**/*
@@ -0,0 +1,34 @@
1
+ source 'http://rubygems.org'
2
+
3
+ gem 'rails', '3.0.1'
4
+
5
+ # Bundle edge Rails instead:
6
+ # gem 'rails', :git => 'git://github.com/rails/rails.git'
7
+
8
+ gem 'sqlite3-ruby', :require => 'sqlite3'
9
+
10
+ # Use unicorn as the web server
11
+ # gem 'unicorn'
12
+
13
+ # Deploy with Capistrano
14
+ # gem 'capistrano'
15
+
16
+ # To use debugger
17
+ # gem 'ruby-debug'
18
+
19
+ # Bundle the extra gems:
20
+ # gem 'bj'
21
+ # gem 'nokogiri'
22
+ # gem 'sqlite3-ruby', :require => 'sqlite3'
23
+ # gem 'aws-s3', :require => 'aws/s3'
24
+ gem 'netzke-basepack', '>= 0.6.0'
25
+
26
+ gem 'will_paginate', '3.0.pre2'
27
+ gem 'meta_where'
28
+
29
+ # Bundle gems for the local environment. Make sure to
30
+ # put test-only gems in this group so their generators
31
+ # and rake tasks are available in development mode:
32
+ # group :development, :test do
33
+ # gem 'webrat'
34
+ # end
@@ -0,0 +1,89 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ abstract (1.0.0)
5
+ actionmailer (3.0.1)
6
+ actionpack (= 3.0.1)
7
+ mail (~> 2.2.5)
8
+ actionpack (3.0.1)
9
+ activemodel (= 3.0.1)
10
+ activesupport (= 3.0.1)
11
+ builder (~> 2.1.2)
12
+ erubis (~> 2.6.6)
13
+ i18n (~> 0.4.1)
14
+ rack (~> 1.2.1)
15
+ rack-mount (~> 0.6.12)
16
+ rack-test (~> 0.5.4)
17
+ tzinfo (~> 0.3.23)
18
+ activemodel (3.0.1)
19
+ activesupport (= 3.0.1)
20
+ builder (~> 2.1.2)
21
+ i18n (~> 0.4.1)
22
+ activerecord (3.0.1)
23
+ activemodel (= 3.0.1)
24
+ activesupport (= 3.0.1)
25
+ arel (~> 1.0.0)
26
+ tzinfo (~> 0.3.23)
27
+ activeresource (3.0.1)
28
+ activemodel (= 3.0.1)
29
+ activesupport (= 3.0.1)
30
+ activesupport (3.0.1)
31
+ acts_as_list (0.1.2)
32
+ arel (1.0.1)
33
+ activesupport (~> 3.0.0)
34
+ builder (2.1.2)
35
+ erubis (2.6.6)
36
+ abstract (>= 1.0.0)
37
+ i18n (0.4.1)
38
+ mail (2.2.7)
39
+ activesupport (>= 2.3.6)
40
+ mime-types
41
+ treetop (>= 1.4.5)
42
+ meta_where (0.9.6)
43
+ activerecord (~> 3.0.0)
44
+ activesupport (~> 3.0.0)
45
+ arel (~> 1.0.1)
46
+ mime-types (1.16)
47
+ netzke-basepack (0.6.0)
48
+ acts_as_list
49
+ meta_where (>= 0.9.3)
50
+ netzke-core (~> 0.6.0)
51
+ will_paginate (~> 3.0.pre2)
52
+ netzke-core (0.6.0)
53
+ activesupport (>= 3.0.1)
54
+ polyglot (0.3.1)
55
+ rack (1.2.1)
56
+ rack-mount (0.6.13)
57
+ rack (>= 1.0.0)
58
+ rack-test (0.5.6)
59
+ rack (>= 1.0)
60
+ rails (3.0.1)
61
+ actionmailer (= 3.0.1)
62
+ actionpack (= 3.0.1)
63
+ activerecord (= 3.0.1)
64
+ activeresource (= 3.0.1)
65
+ activesupport (= 3.0.1)
66
+ bundler (~> 1.0.0)
67
+ railties (= 3.0.1)
68
+ railties (3.0.1)
69
+ actionpack (= 3.0.1)
70
+ activesupport (= 3.0.1)
71
+ rake (>= 0.8.4)
72
+ thor (~> 0.14.0)
73
+ rake (0.8.7)
74
+ sqlite3-ruby (1.3.1)
75
+ thor (0.14.3)
76
+ treetop (1.4.8)
77
+ polyglot (>= 0.3.1)
78
+ tzinfo (0.3.23)
79
+ will_paginate (3.0.pre2)
80
+
81
+ PLATFORMS
82
+ ruby
83
+
84
+ DEPENDENCIES
85
+ meta_where
86
+ netzke-basepack (>= 0.6.0)
87
+ rails (= 3.0.1)
88
+ sqlite3-ruby
89
+ will_paginate (= 3.0.pre2)
@@ -0,0 +1,256 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.find(:all)
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.com/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- controllers
160
+ | |-- helpers
161
+ | |-- models
162
+ | `-- views
163
+ | `-- layouts
164
+ |-- config
165
+ | |-- environments
166
+ | |-- initializers
167
+ | `-- locales
168
+ |-- db
169
+ |-- doc
170
+ |-- lib
171
+ | `-- tasks
172
+ |-- log
173
+ |-- public
174
+ | |-- images
175
+ | |-- javascripts
176
+ | `-- stylesheets
177
+ |-- script
178
+ | `-- performance
179
+ |-- test
180
+ | |-- fixtures
181
+ | |-- functional
182
+ | |-- integration
183
+ | |-- performance
184
+ | `-- unit
185
+ |-- tmp
186
+ | |-- cache
187
+ | |-- pids
188
+ | |-- sessions
189
+ | `-- sockets
190
+ `-- vendor
191
+ `-- plugins
192
+
193
+ app
194
+ Holds all the code that's specific to this particular application.
195
+
196
+ app/controllers
197
+ Holds controllers that should be named like weblogs_controller.rb for
198
+ automated URL mapping. All controllers should descend from
199
+ ApplicationController which itself descends from ActionController::Base.
200
+
201
+ app/models
202
+ Holds models that should be named like post.rb. Models descend from
203
+ ActiveRecord::Base by default.
204
+
205
+ app/views
206
+ Holds the template files for the view that should be named like
207
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
208
+ eRuby syntax by default.
209
+
210
+ app/views/layouts
211
+ Holds the template files for layouts to be used with views. This models the
212
+ common header/footer method of wrapping views. In your views, define a layout
213
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
214
+ Inside default.html.erb, call <% yield %> to render the view using this
215
+ layout.
216
+
217
+ app/helpers
218
+ Holds view helpers that should be named like weblogs_helper.rb. These are
219
+ generated for you automatically when using generators for controllers.
220
+ Helpers can be used to wrap functionality for your views into methods.
221
+
222
+ config
223
+ Configuration files for the Rails environment, the routing map, the database,
224
+ and other dependencies.
225
+
226
+ db
227
+ Contains the database schema in schema.rb. db/migrate contains all the
228
+ sequence of Migrations for your schema.
229
+
230
+ doc
231
+ This directory is where your application documentation will be stored when
232
+ generated using <tt>rake doc:app</tt>
233
+
234
+ lib
235
+ Application specific libraries. Basically, any kind of custom code that
236
+ doesn't belong under controllers, models, or helpers. This directory is in
237
+ the load path.
238
+
239
+ public
240
+ The directory available for the web server. Contains subdirectories for
241
+ images, stylesheets, and javascripts. Also contains the dispatchers and the
242
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
243
+ server.
244
+
245
+ script
246
+ Helper scripts for automation and generation.
247
+
248
+ test
249
+ Unit and functional tests along with fixtures. When using the rails generate
250
+ command, template test files will be generated for you and placed in this
251
+ directory.
252
+
253
+ vendor
254
+ External libraries that the application depends on. Also includes the plugins
255
+ subdirectory. If the app has frozen rails, those gems also go here, under
256
+ vendor/rails/. This directory is in the load path.