blacklight_dates2svg 0.0.1.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. data/LICENSE +5 -0
  2. data/README.md +1 -0
  3. data/Rakefile +40 -0
  4. data/app/assets/javascripts/blacklight_dates2svg/blacklight_dates2svg.js +3 -0
  5. data/app/assets/javascripts/blacklight_dates2svg/svgMonthGridSelector.js +135 -0
  6. data/app/assets/stylesheets/blacklight_dates2svg/_date_range_selector.css.scss +45 -0
  7. data/app/views/blacklight_dates2svg/_date_range_form.html.erb +13 -0
  8. data/app/views/blacklight_dates2svg/_date_range_grid.html.erb +3 -0
  9. data/app/views/blacklight_dates2svg/_date_range_selector.html.erb +4 -0
  10. data/app/views/blacklight_dates2svg/_legend.html.erb +9 -0
  11. data/config/routes.rb +2 -0
  12. data/lib/blacklight_dates2svg/engine.rb +4 -0
  13. data/lib/blacklight_dates2svg/version.rb +3 -0
  14. data/lib/blacklight_dates2svg.rb +45 -0
  15. data/lib/generators/blacklight_dates2svg_generator.rb +37 -0
  16. data/lib/tasks/blacklight_dates2svg_tasks.rake +4 -0
  17. data/test/blacklight_dates2svg_test.rb +7 -0
  18. data/test/dummy/README.rdoc +261 -0
  19. data/test/dummy/Rakefile +7 -0
  20. data/test/dummy/app/assets/javascripts/application.js +15 -0
  21. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  22. data/test/dummy/app/controllers/application_controller.rb +3 -0
  23. data/test/dummy/app/helpers/application_helper.rb +2 -0
  24. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  25. data/test/dummy/config/application.rb +59 -0
  26. data/test/dummy/config/boot.rb +10 -0
  27. data/test/dummy/config/database.yml +25 -0
  28. data/test/dummy/config/environment.rb +5 -0
  29. data/test/dummy/config/environments/development.rb +37 -0
  30. data/test/dummy/config/environments/production.rb +67 -0
  31. data/test/dummy/config/environments/test.rb +37 -0
  32. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  33. data/test/dummy/config/initializers/inflections.rb +15 -0
  34. data/test/dummy/config/initializers/mime_types.rb +5 -0
  35. data/test/dummy/config/initializers/secret_token.rb +7 -0
  36. data/test/dummy/config/initializers/session_store.rb +8 -0
  37. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  38. data/test/dummy/config/locales/en.yml +5 -0
  39. data/test/dummy/config/routes.rb +58 -0
  40. data/test/dummy/config.ru +4 -0
  41. data/test/dummy/public/404.html +26 -0
  42. data/test/dummy/public/422.html +26 -0
  43. data/test/dummy/public/500.html +25 -0
  44. data/test/dummy/public/favicon.ico +0 -0
  45. data/test/dummy/script/rails +6 -0
  46. data/test/integration/navigation_test.rb +10 -0
  47. data/test/test_helper.rb +15 -0
  48. metadata +208 -0
data/LICENSE ADDED
@@ -0,0 +1,5 @@
1
+ Copyright (c) 2012-2013. The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
2
+
3
+ Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
4
+
5
+ THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
data/README.md ADDED
@@ -0,0 +1 @@
1
+ # BlacklightDates2SVG
data/Rakefile ADDED
@@ -0,0 +1,40 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ rescue LoadError
10
+ require 'rdoc/rdoc'
11
+ require 'rake/rdoctask'
12
+ RDoc::Task = Rake::RDocTask
13
+ end
14
+
15
+ RDoc::Task.new(:rdoc) do |rdoc|
16
+ rdoc.rdoc_dir = 'rdoc'
17
+ rdoc.title = 'BlacklightDates2svg'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+
27
+
28
+ Bundler::GemHelper.install_tasks
29
+
30
+ require 'rake/testtask'
31
+
32
+ Rake::TestTask.new(:test) do |t|
33
+ t.libs << 'lib'
34
+ t.libs << 'test'
35
+ t.pattern = 'test/**/*_test.rb'
36
+ t.verbose = false
37
+ end
38
+
39
+
40
+ task :default => :test
@@ -0,0 +1,3 @@
1
+ $(document).ready(function(){
2
+ $(".date-range-selector").svgMonthGridSelector();
3
+ });
@@ -0,0 +1,135 @@
1
+ /*
2
+ * jQuery SVG Month Grid Selector Plugin
3
+ *
4
+ * https://github.com/jkeck/svgMonthGridSelector
5
+ *
6
+ * This plugin is explicitly designed for use with the SVG ouput by the dates2svg RubyGem ( https://github.com/jkeck/dates2svg )
7
+ *
8
+ * VERSION 0.0.1.beta1
9
+ *
10
+ **/
11
+ (function( $ ){
12
+ $.fn.svgMonthGridSelector = function(options){
13
+ var settings = $.extend({
14
+ 'begin_input' : '.begin-date',
15
+ 'end_input' : '.end-date',
16
+ 'hits' : '.hits'
17
+ }, options);
18
+
19
+ var selector = this;
20
+ var svg = $("svg", selector);
21
+ var begin_input = $("form input" + settings.begin_input, selector);
22
+ var end_input = $("form input" + settings.end_input, selector);
23
+ var hits_element = $(settings.hits, selector);
24
+
25
+ updateRangesFromInputs();
26
+ updateRangeOnFormChange();
27
+
28
+ $("rect", svg).each(function(){
29
+ $(this).click(function(){
30
+ // clear selected months
31
+ clearSelections();
32
+
33
+ // change data-selected attribute on click
34
+ var selected = $(this).attr("data-selected") == "true" ? "false" : "true";
35
+ $(this).attr("data-selected", selected);
36
+
37
+ // fill in range of selections
38
+ selectRange();
39
+
40
+ // update form controls with selections.
41
+ updateDateSelectorFormControls();
42
+ });
43
+ });
44
+
45
+ function selectRange(){
46
+ if($("rect[data-selected='true']", svg).length > 1){
47
+ var in_range = false;
48
+ $("rect", svg).each(function(){
49
+ // if we're already in_range, but we get to an item w/
50
+ // data-selected=true, then we're at the end of the range
51
+ if(in_range && $(this).attr("data-selected") == "true"){
52
+ return false;
53
+ }
54
+ // set in_range to true now that we're come across a selected item
55
+ if($(this).attr("data-selected") == "true"){
56
+ in_range = true;
57
+ }
58
+ // set data-selected to true for all the boxes in_range
59
+ if(in_range && $(this).attr("data-selected") != "true"){
60
+ $(this).attr("data-selected", "true");
61
+ }
62
+ });
63
+ }
64
+ }
65
+
66
+ function clearSelections(){
67
+ // If a range has already been selected
68
+ if($("rect[data-selected='true']", svg).length >= 2){
69
+ $("rect", svg).each(function(){
70
+ $(this).attr("data-selected", "false");
71
+ });
72
+ begin_input.attr("value", "");
73
+ $(".date-range-selector form input" + settings.end_input, selector).attr("value", "");
74
+ $(settings.hits, selector).text("");
75
+ }
76
+ }
77
+
78
+ function updateDateSelectorFormControls(){
79
+ var begin_element = $("rect[data-selected='true']", svg).first();
80
+ var end_element = $("rect[data-selected='true']", svg).last();
81
+ if(begin_element.length > 0){
82
+ begin_input.attr("value", begin_element.attr("data-year") + "-" + begin_element.attr("data-month"));
83
+ }
84
+ if($("rect[data-selected='true']", svg).length == 1){
85
+ end_input.attr("value", begin_element.attr("data-year") + "-" + begin_element.attr("data-month"));
86
+ }else if($("rect[data-selected='true']", svg).length > 1){
87
+ end_input.attr("value", end_element.attr("data-year") + "-" + end_element.attr("data-month"));
88
+ }else if($("rect[data-selected='true']", svg).length == 0){
89
+ begin_input.attr("value", "");
90
+ end_input.attr("value", "")
91
+ }
92
+ var hits = 0;
93
+ $("rect[data-selected='true']", svg).each(function(){
94
+ hits += parseInt($(this).attr("data-hits"));
95
+ });
96
+ $(settings.hits, selector).text(hits > 0 ? hits : "");
97
+ }
98
+
99
+ function updateRangeOnFormChange(){
100
+ $.each([begin_input, end_input], function(){
101
+ $(this).change(function(){
102
+ if($(this).attr("value") != "" &&
103
+ begin_input.attr("value").match(/^\d{4}-\d{2}/) &&
104
+ end_input.attr("value").match(/^\d{4}-\d{2}/)){
105
+ $("rect", svg).each(function(){
106
+ $(this).attr("data-selected", "false");
107
+ });
108
+ updateRangesFromInputs();
109
+ }
110
+ });
111
+ });
112
+ }
113
+
114
+ function updateRangesFromInputs(){
115
+ var begin_grid_element, end_grid_element;
116
+ if(begin_input.length > 0 && begin_input.attr("value") != "") {
117
+ var match = begin_input.attr("value").match(/^(\d{4})-(\d{2})/)
118
+ var year = match[1]
119
+ var month = match[2]
120
+ begin_grid_element = $("rect[data-year='" + year + "'][data-month='" + month +"']", svg);
121
+ begin_grid_element.attr("data-selected", "true");
122
+ }
123
+ if(end_input.length > 0 && end_input.attr("value") != "") {
124
+ var match = end_input.attr("value").match(/^(\d{4})-(\d{2})/)
125
+ var year = match[1]
126
+ var month = match[2]
127
+ end_grid_element = $("rect[data-year='" + year + "'][data-month='" + month +"']", svg);
128
+ end_grid_element.attr("data-selected", "true");
129
+ }
130
+ selectRange();
131
+ updateDateSelectorFormControls();
132
+ }
133
+
134
+ }
135
+ })( jQuery );
@@ -0,0 +1,45 @@
1
+ .date-range-selector {
2
+ rect {
3
+ &:hover {
4
+ stroke: #555;
5
+ stroke-width: 1px;
6
+ cursor: pointer;
7
+ }
8
+ &[data-selected='true']{
9
+ stroke: black;
10
+ stroke-width: 1px;
11
+ }
12
+ }
13
+ text{
14
+ font-size: 12px;
15
+ }
16
+ .form-controls {
17
+ height: 50px;
18
+ max-width: 463px;
19
+ form {
20
+ float: left;
21
+ margin-left: 32px;
22
+ input {
23
+ &.begin-date, &.end-date {width: 55px}
24
+ &.btn {margin-top: -10px;}
25
+ }
26
+ }
27
+ .legend {
28
+ margin-top: 5px;
29
+ float: right;
30
+ font-size: 12px;
31
+ span {float: left;}
32
+ ul {
33
+ float: left;
34
+ margin: 2px 5px;
35
+ li {
36
+ list-style-type: none;
37
+ margin-left: 1px;
38
+ width: 15px;
39
+ height: 15px;
40
+ float: left;
41
+ }
42
+ }
43
+ }
44
+ }
45
+ }
@@ -0,0 +1,13 @@
1
+ <div class="form-controls">
2
+ <%= form_tag(catalog_index_path, :method => "get") do %>
3
+ <%= search_as_hidden_fields(:omit_keys => date_range_form_omit_keys).html_safe %>
4
+ <%= hidden_field_tag :q, params[:q] %>
5
+ <%= hidden_field_tag :dates, 1 %>
6
+ <%= text_field_tag :"date-start", params["date-start"], :class => "begin-date" %> to
7
+ <%= text_field_tag :"date-end", params["date-end"], :class => "end-date" %>
8
+ <span class='hits'></span>
9
+
10
+ <%= submit_tag "search", :class=>"btn" %>
11
+ <%- end -%>
12
+ <%= render "blacklight_dates2svg/legend" -%>
13
+ </div>
@@ -0,0 +1,3 @@
1
+ <div class='selector-widget'>
2
+ <%= @date_selector.to_svg.html_safe %>
3
+ </div>
@@ -0,0 +1,4 @@
1
+ <div class='date-range-selector'>
2
+ <%= render "blacklight_dates2svg/date_range_grid" -%>
3
+ <%= render "blacklight_dates2svg/date_range_form" -%>
4
+ </div>
@@ -0,0 +1,9 @@
1
+ <div class="legend">
2
+ <span>Less</span>
3
+ <ul>
4
+ <%- @date_selector.color_range.each do |range, color| -%>
5
+ <li title="<%= render_date_range_value(range) %>" style="background-color: <%= color %>"></li>
6
+ <%- end -%>
7
+ </ul>
8
+ <span>More</span>
9
+ </div>
data/config/routes.rb ADDED
@@ -0,0 +1,2 @@
1
+ Rails.application.routes.draw do
2
+ end
@@ -0,0 +1,4 @@
1
+ module BlacklightDates2SVG
2
+ class Engine < ::Rails::Engine
3
+ end
4
+ end
@@ -0,0 +1,3 @@
1
+ module BlacklightDates2SVG
2
+ VERSION = "0.0.1.beta1"
3
+ end
@@ -0,0 +1,45 @@
1
+ require "blacklight_dates2svg/engine"
2
+ require 'dates2svg'
3
+ require 'date_range_solr_query'
4
+
5
+ module BlacklightDates2SVG
6
+ extend ActiveSupport::Concern
7
+ included do
8
+ self.solr_search_params_logic += [:add_dates2svg_range_query]
9
+ helper_method :render_date_range_selector_grid, :render_date_range_value, :date_range_form_omit_keys
10
+ end
11
+
12
+ def add_dates2svg_range_query(solr_params, user_params)
13
+ if user_params["dates"] and !user_params["date-start"].blank?
14
+ range_query = DateRangeSolrQuery.new(:start_date => user_params['date-start'],
15
+ :end_date => user_params['date-end'],
16
+ :field => blacklight_config.search_date_field).range_query
17
+ if solr_params[:fq]
18
+ solr_params[:fq] << range_query
19
+ else
20
+ solr_params[:fq] = [range_query]
21
+ end
22
+ end
23
+ end
24
+
25
+ def render_date_range_selector_grid(options)
26
+ items = (options[:dates] || @response.facets.select do |facet|
27
+ facet.name == blacklight_config.search_date_field
28
+ end.first.items)
29
+ options.delete(:dates)
30
+ unless items.blank?
31
+ @date_selector = Dates2SVG.new(items, options)
32
+ render(:partial => "blacklight_dates2svg/date_range_selector").join(" ").html_safe
33
+ end
34
+ end
35
+
36
+ def render_date_range_value(range)
37
+ [range.first, range.last].uniq.join(" - ")
38
+ end
39
+
40
+ def date_range_form_omit_keys
41
+ [:q, :search_field, :qt, :page]
42
+ end
43
+
44
+ end
45
+
@@ -0,0 +1,37 @@
1
+ # -*- encoding : utf-8 -*-
2
+ require 'rails/generators'
3
+ require 'rails/generators/migration'
4
+ class BlacklightDates2svgGenerator < Rails::Generators::Base
5
+
6
+ desc """
7
+ This generator makes the following changes to your application:
8
+ 1. Requires javascript from the svgMonthGridSelector jQuery plugin
9
+ 2. Requires a css file to style the grid, form, and legend.
10
+ """
11
+
12
+ # insert require statements into application level CSS/JS manifestes.
13
+ def inject_blacklight_dates2svg_assets
14
+ css = "app/assets/stylesheets/application.css"
15
+ if File.exists?("app/assets/stylesheets/application.css.scss")
16
+ css = "app/assets/stylesheets/application.css.scss"
17
+ end
18
+ unless IO.read(css).include?("Required by BlacklightDates2SVG")
19
+ insert_into_file css, :after => "/*" do
20
+ %q{
21
+ * Required by BlacklightDates2SVG:
22
+ *= require blacklight_dates2svg/date_range_selector
23
+ *}
24
+ end
25
+ end
26
+ unless IO.read("app/assets/javascripts/application.js").include?("Required by BlacklightDates2SVG")
27
+ insert_into_file "app/assets/javascripts/application.js", :before => "//= require_tree ." do
28
+ %q{// Required by BlacklightDates2SVG:
29
+ //= require blacklight_dates2svg/svgMonthGridSelector
30
+ //= require blacklight_dates2svg/blacklight_dates2svg
31
+ }
32
+ end
33
+ end
34
+ end
35
+
36
+
37
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :blacklight_dates2svg do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class BlacklightDates2svgTest < ActiveSupport::TestCase
4
+ test "truth" do
5
+ assert_kind_of Module, BlacklightDates2svg
6
+ end
7
+ 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.
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env rake
2
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
3
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
4
+
5
+ require File.expand_path('../config/application', __FILE__)
6
+
7
+ Dummy::Application.load_tasks
@@ -0,0 +1,15 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // the compiled file.
9
+ //
10
+ // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
11
+ // GO AFTER THE REQUIRES BELOW.
12
+ //
13
+ //= require jquery
14
+ //= require jquery_ujs
15
+ //= require_tree .