meta_reports 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +7 -0
  2. data/Guardfile +15 -0
  3. data/LICENSE +20 -0
  4. data/README.md +146 -0
  5. data/Rakefile +29 -0
  6. data/app/assets/images/meta_reports/print.png +0 -0
  7. data/app/assets/images/meta_reports/spreadsheet.png +0 -0
  8. data/app/assets/javascripts/meta_reports/reports.js +2 -0
  9. data/app/controllers/meta_reports/application_controller.rb +4 -0
  10. data/app/controllers/meta_reports/reports_controller.rb +91 -0
  11. data/app/helpers/meta_reports/reports_helper.rb +140 -0
  12. data/app/models/meta_reports/base.rb +90 -0
  13. data/app/models/meta_reports/data.rb +34 -0
  14. data/app/models/meta_reports/table.rb +80 -0
  15. data/config/routes.rb +9 -0
  16. data/db/migrate/20130801071213_create_meta_reports_reports.rb +17 -0
  17. data/lib/generators/meta_reports/install_generator.rb +40 -0
  18. data/lib/generators/meta_reports/templates/models/report.rb +30 -0
  19. data/lib/generators/meta_reports/templates/views/_form.html.erb +45 -0
  20. data/lib/generators/meta_reports/templates/views/edit.html.erb +6 -0
  21. data/lib/generators/meta_reports/templates/views/forms/_form_example.html.erb +1 -0
  22. data/lib/generators/meta_reports/templates/views/forms/form.html.erb +17 -0
  23. data/lib/generators/meta_reports/templates/views/index.html.erb +36 -0
  24. data/lib/generators/meta_reports/templates/views/new.html.erb +5 -0
  25. data/lib/generators/meta_reports/templates/views/templates/_default.html.erb +26 -0
  26. data/lib/generators/meta_reports/templates/views/templates/_default_footer.pdf.prawn +12 -0
  27. data/lib/generators/meta_reports/templates/views/templates/_default_header.pdf.prawn +14 -0
  28. data/lib/generators/meta_reports/templates/views/templates/_default_header.xlsx.axlsx +20 -0
  29. data/lib/generators/meta_reports/templates/views/templates/_default_table.html.erb +24 -0
  30. data/lib/generators/meta_reports/templates/views/templates/_default_table.pdf.prawn +29 -0
  31. data/lib/generators/meta_reports/templates/views/templates/default.html.erb +1 -0
  32. data/lib/generators/meta_reports/templates/views/templates/default.pdf.prawn +26 -0
  33. data/lib/generators/meta_reports/templates/views/templates/default.xlsx.axlsx +43 -0
  34. data/lib/meta_reports.rb +4 -0
  35. data/lib/meta_reports/engine.rb +15 -0
  36. data/lib/meta_reports/version.rb +3 -0
  37. data/lib/tasks/meta_reports_tasks.rake +4 -0
  38. data/spec/dummy/README.rdoc +261 -0
  39. data/spec/dummy/Rakefile +7 -0
  40. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  41. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  42. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  43. data/spec/dummy/app/controllers/home_controller.rb +4 -0
  44. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  45. data/spec/dummy/app/models/meta_reports/report.rb +30 -0
  46. data/spec/dummy/app/views/home/index.html.erb +4 -0
  47. data/spec/dummy/app/views/layouts/application.html.erb +16 -0
  48. data/spec/dummy/app/views/meta_reports/reports/_form.html.erb +45 -0
  49. data/spec/dummy/app/views/meta_reports/reports/edit.html.erb +6 -0
  50. data/spec/dummy/app/views/meta_reports/reports/forms/_form_moo.html.erb +1 -0
  51. data/spec/dummy/app/views/meta_reports/reports/forms/form.html.erb +17 -0
  52. data/spec/dummy/app/views/meta_reports/reports/index.html.erb +36 -0
  53. data/spec/dummy/app/views/meta_reports/reports/new.html.erb +5 -0
  54. data/spec/dummy/app/views/meta_reports/reports/templates/_default.html.erb +26 -0
  55. data/spec/dummy/app/views/meta_reports/reports/templates/_default_footer.pdf.prawn +12 -0
  56. data/spec/dummy/app/views/meta_reports/reports/templates/_default_header.pdf.prawn +14 -0
  57. data/spec/dummy/app/views/meta_reports/reports/templates/_default_header.xlsx.axlsx +20 -0
  58. data/spec/dummy/app/views/meta_reports/reports/templates/_default_table.html.erb +24 -0
  59. data/spec/dummy/app/views/meta_reports/reports/templates/_default_table.pdf.prawn +29 -0
  60. data/spec/dummy/app/views/meta_reports/reports/templates/default.html.erb +1 -0
  61. data/spec/dummy/app/views/meta_reports/reports/templates/default.pdf.prawn +26 -0
  62. data/spec/dummy/app/views/meta_reports/reports/templates/default.xlsx.axlsx +43 -0
  63. data/spec/dummy/config.ru +4 -0
  64. data/spec/dummy/config/application.rb +65 -0
  65. data/spec/dummy/config/boot.rb +10 -0
  66. data/spec/dummy/config/database.yml +25 -0
  67. data/spec/dummy/config/environment.rb +5 -0
  68. data/spec/dummy/config/environments/development.rb +37 -0
  69. data/spec/dummy/config/environments/production.rb +67 -0
  70. data/spec/dummy/config/environments/test.rb +37 -0
  71. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  72. data/spec/dummy/config/initializers/inflections.rb +15 -0
  73. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  74. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  75. data/spec/dummy/config/initializers/session_store.rb +8 -0
  76. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  77. data/spec/dummy/config/locales/en.yml +5 -0
  78. data/spec/dummy/config/routes.rb +4 -0
  79. data/spec/dummy/config/routes_empty.rb +3 -0
  80. data/spec/dummy/config/routes_original.rb +4 -0
  81. data/spec/dummy/db/development.sqlite3 +0 -0
  82. data/spec/dummy/db/schema.rb +31 -0
  83. data/spec/dummy/log/development.log +22317 -0
  84. data/spec/dummy/public/404.html +26 -0
  85. data/spec/dummy/public/422.html +26 -0
  86. data/spec/dummy/public/500.html +25 -0
  87. data/spec/dummy/public/favicon.ico +0 -0
  88. data/spec/dummy/script/rails +6 -0
  89. data/spec/dummy/tmp/cache/assets/C9B/140/sprockets%2F805babf865ce32228222420a522c7b36 +0 -0
  90. data/spec/dummy/tmp/cache/assets/CBD/2B0/sprockets%2F9e22e937dd267c81a146665f15471b8e +0 -0
  91. data/spec/dummy/tmp/cache/assets/CD0/810/sprockets%2Fe858c95fa595e319dac0065d49982967 +0 -0
  92. data/spec/dummy/tmp/cache/assets/CD0/AC0/sprockets%2F1d341d7a2fc1328567d4b23e0809b2e2 +0 -0
  93. data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  94. data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  95. data/spec/dummy/tmp/cache/assets/D3D/EB0/sprockets%2F2d47bd3108d9abbb12c0497e36d9674d +0 -0
  96. data/spec/dummy/tmp/cache/assets/D40/8F0/sprockets%2F290aea2004dfecfc76f42e48970f1484 +0 -0
  97. data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  98. data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  99. data/spec/dummy/tmp/cache/assets/D61/310/sprockets%2Fc168b1c9be3e38ac1c8403a3074b5b8c +0 -0
  100. data/spec/dummy/tmp/cache/assets/D74/AE0/sprockets%2F9ad0425db5cfa16a9426f7b1a7958d7d +0 -0
  101. data/spec/dummy/tmp/cache/assets/D98/270/sprockets%2F0b7ba158ff62bbbb378d6bea80680c63 +0 -0
  102. data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  103. data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  104. data/spec/dummy/tmp/cache/assets/E5A/EF0/sprockets%2Fb0d5af721ea37c98fd4bccd8e1e5c6ab +0 -0
  105. data/spec/dummy/tmp/pids/server.pid +1 -0
  106. data/spec/features/dummy_spec.rb +42 -0
  107. data/spec/generators/install_spec.rb +51 -0
  108. data/spec/models/data_spec.rb +45 -0
  109. data/spec/models/table_spec.rb +78 -0
  110. data/spec/spec_helper.rb +41 -0
  111. metadata +454 -0
@@ -0,0 +1,12 @@
1
+ pdf.font_size = 8
2
+
3
+ time_string = Time.now.strftime("Generated on %-m/%-d/%y at %l:%M %p")
4
+ absolute_bottom = pdf.bounds.absolute_bottom
5
+ time_y = 14 - absolute_bottom
6
+ pdf.repeat :all do
7
+ pdf.draw_text time_string, at: [0,time_y]
8
+ end
9
+
10
+ string = "Page <page> of <total>"
11
+ options = { :at => [pdf.bounds.right - 150, 20-absolute_bottom], :width => 150, :align => :right }
12
+ pdf.number_pages string, options
@@ -0,0 +1,14 @@
1
+ pdf.text 'Company Name', :style => :bold, :size => 9
2
+ pdf.text '1234 Address', :size => 7
3
+ pdf.text 'City, ST 12345', :size => 7
4
+ pdf.text '(123) 456-7890', :size => 8
5
+ # pdf.image 'image_file', width: 60, position: :right, vposition: 0
6
+
7
+
8
+ pdf.move_up 35
9
+ pdf.pad_bottom(10) do
10
+ logger.info "title: #{title.inspect}"
11
+ pdf.text title, :size => 18, :align => :center if title
12
+ pdf.text subtitle, :size => 12, :align => :center if subtitle
13
+ end
14
+ pdf.move_down 7
@@ -0,0 +1,20 @@
1
+ wb = sheet.workbook
2
+ styles = {} unless defined?(styles)
3
+ unless styles[:bold]
4
+ styles[:bold] = wb.styles.add_style :b => true
5
+ end
6
+ unless styles[:title]
7
+ styles[:title] = wb.styles.add_style :sz => 14, :alignment => { :horizontal => :center}, :b => true
8
+ end
9
+ unless styles[:subtitle]
10
+ styles[:subtitle] = wb.styles.add_style :sz => 12, :alignment => { :horizontal => :center}, :b => true
11
+ end
12
+
13
+ columns = columns || 8
14
+ subtitle = subtitle || ''
15
+ sheet.add_row ["Company Name, Address"] + ['']*(columns-3) + [Date.today().to_s, Time.now().strftime("%I:%M")], :style => styles[:bold]
16
+ sheet.add_row [' '] * columns
17
+ sheet.add_row [title], :style => styles[:title]
18
+ sheet.add_row [subtitle], :style => styles[:subtitle]
19
+ sheet.merge_cells("A1:#{to_xls_col(columns-3)}1")
20
+ (2..4).each {|i| sheet.merge_cells("A#{i}:#{to_xls_col(columns-1)}#{i}") }
@@ -0,0 +1,24 @@
1
+ <%
2
+ row_classes = table.row_classes if !defined?(row_classes) || row_classes.nil?
3
+ table_class = table.options[:table_class].to_s if !defined?(table_class) || table_class.nil?
4
+ %>
5
+ <%= content_tag(:h4, table_name) %>
6
+ <div class='list_container'>
7
+ <%= content_tag(:table, :class => "table #{table_class}") do %>
8
+ <% unless @report[:table_header] == false %>
9
+ <%= content_tag(:thead, content_tag(:tr, table.to_a.shift.map { |h| html_cell(h, :th)}.join.html_safe ) ) %>
10
+ <% end %>
11
+ <tbody>
12
+ <% table.to_a.each_with_index do |row, i| %>
13
+ <%
14
+ row_class = "#{cycle('odd','even')} #{row_classes[i]}".strip
15
+ %>
16
+ <%= content_tag(:tr, :class => row_class) do
17
+ row.each do |cell|
18
+ %><%= html_cell(cell) %><%
19
+ end
20
+ end %>
21
+ <% end %>
22
+ </tbody>
23
+ <% end %>
24
+ </div>
@@ -0,0 +1,29 @@
1
+ if defined?(title)
2
+ pdf.text title.to_s, :align => :center, :style => :bold, :size => 13
3
+ end
4
+ styling = {}
5
+ column_widths = {} if !defined?(column_widths) || column_widths.blank?
6
+ font_size = table[:font_size] || 8
7
+ table_header = table[:table_header] != false
8
+ pdf.table prep_pdf_table(table, styling), :header => table_header, :row_colors => ["EEEEEE", "FFFFFF"], :width => pdf.bounds.width, :cell_style => {:padding => 2, :size => font_size, :align => :center} do |t|
9
+ t.cells.borders = []
10
+ t.style t.row(0), :borders => [:bottom], :background_color => "DDDDDD", :font_style => :bold
11
+ [:left, :center, :right].each do |style|
12
+ styling[style].to_a.each do |cell|
13
+ t.row(cell[0]).column(cell[1]).align = style
14
+ end
15
+ end
16
+ styling[:bold].to_a.each do |cell|
17
+ t.style t.row(cell[0]).column(cell[1]), :font_style => :bold
18
+ end
19
+ styling[:row_colors].each do |row, color|
20
+ t.style t.row(row), :background_color => color
21
+ end
22
+ if styling[:column_widths]
23
+ t.column_widths = styling[:column_widths]
24
+ else
25
+ t.column_widths = column_widths
26
+ end
27
+ # if totals row? how specify or check?
28
+ # t.style t.row(-1), :font_style => :bold
29
+ end
@@ -0,0 +1 @@
1
+ <%= render 'meta_reports/reports/templates/default', report: (defined?(report).nil? ? @report : report) %>
@@ -0,0 +1,26 @@
1
+ margin = @report[:page_margin] && [*@report[:page_margin]][0,4] || nil
2
+ prawn_document(page_orientation: @report[:page_orientation] || :portrait, page_size: @report[:page_size] || 'LETTER', margin: margin) do |pdf|
3
+
4
+ render :partial => "meta_reports/reports/templates/default_header", :locals => { :pdf => pdf, :title => @report[:title], :subtitle => @report[:subtitle] }
5
+ pdf.font_size = @report[:font_size] || 8
6
+ if @report[:description]
7
+ pdf.move_up 5
8
+ pdf.text strip_tags(@report[:description]), align: :center
9
+ pdf.move_down 15
10
+ end
11
+
12
+ table_names = @report[:table_order] || @report[:tables].keys.sort_by {|k| k.to_s}
13
+ table_names.each do |table_name|
14
+ table = @report[:tables][table_name]
15
+ pdf.pad_bottom(25) do
16
+ # TODO: provide option to 'group' all or one table
17
+ # this forces a table to stay together on one page. throws an error if a table is larger than a page.
18
+ # pdf.group do
19
+ render :partial => 'meta_reports/reports/templates/default_table', :locals => {:pdf => pdf, :title => table_name, :table => table}
20
+ # end
21
+ end
22
+ end
23
+
24
+ render partial: "meta_reports/reports/templates/default_footer", locals: { pdf: pdf }
25
+
26
+ end #prawn document
@@ -0,0 +1,43 @@
1
+ wb = xlsx_package.workbook
2
+
3
+ #styles
4
+ styles = {}
5
+ styles[:table_header] = wb.styles.add_style :style => :thick, :bg_color => "EEEEEE"
6
+ styles[:bold] = wb.styles.add_style :style => :thick
7
+ styles[:title] = wb.styles.add_style :sz => 14, :alignment => { :horizontal => :center}, :style => :thick
8
+ styles[:subtitle] = wb.styles.add_style :sz => 12, :alignment => { :horizontal => :center}, :style => :thick
9
+
10
+ wb.add_worksheet(name: @report[:title][0,31].gsub(/[:\/]/,'-'), page_margins: convert_margins_to_xlsx(@report[:page_margin])) do |sheet|
11
+ first_table = @report[:tables].values.first
12
+ columns = first_table.blank? ? 12 : first_table.first.length
13
+ last_column = to_xls_col(columns)
14
+
15
+ render :partial => "meta_reports/reports/templates/default_header", :locals => { :sheet => sheet, :title => @report[:title], :subtitle => @report[:subtitle], :columns => columns, :styles => styles }
16
+ if @report[:description]
17
+ sheet.add_row [@report[:description]]
18
+ this_rows = sheet.rows.length
19
+ sheet.merge_cells("A#{this_rows}:#{last_column}#{this_rows}")
20
+ end
21
+
22
+ table_names = @report[:table_order] || @report[:tables].keys.sort_by {|k| k.to_s}
23
+ table_names.each do |table_name|
24
+ table = @report[:tables][table_name]
25
+ opts = table.last.is_a?(Hash) ? table.pop : {}
26
+ row_classes = opts[:row_classes] || {}
27
+ sheet.add_row [' '] * columns
28
+ this_rows = sheet.rows.length
29
+ sheet.add_row [table_name] + [' ']*(columns-1)
30
+ sheet.merge_cells("A#{this_rows}:#{last_column}#{this_rows}")
31
+ styling = {}
32
+ unless @report[:table_header] == false
33
+ prep_xlsx_table([table.shift], styling).each do |row|
34
+ sheet.add_row row, :style => styles[:table_header]
35
+ end
36
+ end
37
+ prep_xlsx_table(table, styling).each do |row|
38
+ sheet.add_row row
39
+ #TODO: handle styling
40
+ end
41
+ end
42
+
43
+ end
@@ -0,0 +1,4 @@
1
+ require "meta_reports/engine"
2
+
3
+ module MetaReports
4
+ end
@@ -0,0 +1,15 @@
1
+ module MetaReports
2
+ class Engine < ::Rails::Engine
3
+ engine_name "meta_reports"
4
+ isolate_namespace MetaReports
5
+
6
+ require 'axlsx_rails'
7
+ require 'prawn_rails'
8
+
9
+ # config.to_prepare do
10
+ # Dir.glob(Rails.root + "app/decorators/**/*_decorator*.rb").each do |c|
11
+ # require_dependency(c)
12
+ # end
13
+ # end
14
+ end
15
+ end
@@ -0,0 +1,3 @@
1
+ module MetaReports
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :meta_reports do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,261 @@
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.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.org/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
+ | |-- assets
160
+ | | |-- images
161
+ | | |-- javascripts
162
+ | | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
193
+ | `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.