datashift 0.11.1 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (110) hide show
  1. data/Rakefile +3 -2
  2. data/VERSION +1 -1
  3. data/datashift.gemspec +11 -174
  4. data/lib/datashift/column_packer.rb +64 -0
  5. data/lib/datashift/delimiters.rb +17 -1
  6. data/lib/datashift/exceptions.rb +7 -0
  7. data/lib/datashift/querying.rb +10 -4
  8. data/lib/loaders/csv_loader.rb +69 -32
  9. data/lib/loaders/excel_loader.rb +86 -53
  10. data/lib/loaders/loader_base.rb +32 -18
  11. data/lib/loaders/paperclip/attachment_loader.rb +11 -8
  12. data/lib/loaders/paperclip/datashift_paperclip.rb +21 -18
  13. data/lib/loaders/reporter.rb +48 -0
  14. data/spec/Gemfile.lock +129 -0
  15. data/spec/csv_exporter_spec.rb +1 -1
  16. metadata +121 -191
  17. data/.document +0 -5
  18. data/lib/java/poi-3.7/._poi-3.7-20101029.jar5645100390082102460.tmp +0 -0
  19. data/spec/MissingAttachmentRecords/DEMO_001_ror_bag.jpeg +0 -0
  20. data/spec/MissingAttachmentRecords/DEMO_002_Powerstation.jpeg +0 -0
  21. data/spec/MissingAttachmentRecords/DEMO_002_Powerstation.jpg +0 -0
  22. data/spec/MissingAttachmentRecords/DEMO_003_ror_mug.jpeg +0 -0
  23. data/spec/MissingAttachmentRecords/DEMO_004_ror_ringer.jpeg +0 -0
  24. data/spec/fixtures/BadAssociationName.xls +0 -0
  25. data/spec/fixtures/DemoNegativeTesting.xls +0 -0
  26. data/spec/fixtures/ProjectsDefaults.yml +0 -29
  27. data/spec/fixtures/ProjectsMultiCategories.xls +0 -0
  28. data/spec/fixtures/ProjectsMultiCategoriesHeaderLookup.xls +0 -0
  29. data/spec/fixtures/ProjectsSingleCategories.xls +0 -0
  30. data/spec/fixtures/SimpleProjects.xls +0 -0
  31. data/spec/fixtures/config/database.yml +0 -28
  32. data/spec/fixtures/db/datashift_test_models_db.sqlite +0 -0
  33. data/spec/fixtures/db/migrate/20110803201325_create_test_bed.rb +0 -96
  34. data/spec/fixtures/db/migrate/20121009161700_add_digitals.rb +0 -24
  35. data/spec/fixtures/images/DEMO_001_ror_bag.jpeg +0 -0
  36. data/spec/fixtures/images/DEMO_002_Powerstation.jpeg +0 -0
  37. data/spec/fixtures/images/DEMO_003_ror_mug.jpeg +0 -0
  38. data/spec/fixtures/images/DEMO_004_ror_ringer.jpeg +0 -0
  39. data/spec/fixtures/load_datashift.thor +0 -3
  40. data/spec/fixtures/models/category.rb +0 -7
  41. data/spec/fixtures/models/digital.rb +0 -14
  42. data/spec/fixtures/models/empty.rb +0 -2
  43. data/spec/fixtures/models/loader_release.rb +0 -10
  44. data/spec/fixtures/models/long_and_complex_table_linked_to_version.rb +0 -6
  45. data/spec/fixtures/models/milestone.rb +0 -8
  46. data/spec/fixtures/models/owner.rb +0 -7
  47. data/spec/fixtures/models/project.rb +0 -26
  48. data/spec/fixtures/models/version.rb +0 -7
  49. data/spec/fixtures/simple_export_spec.xls +0 -0
  50. data/spec/fixtures/simple_template_spec.xls +0 -0
  51. data/spec/fixtures/test_model_defs.rb +0 -9
  52. data/spec/rails_sandbox/.gitignore +0 -15
  53. data/spec/rails_sandbox/Gemfile +0 -40
  54. data/spec/rails_sandbox/README.rdoc +0 -261
  55. data/spec/rails_sandbox/Rakefile +0 -7
  56. data/spec/rails_sandbox/app/assets/images/rails.png +0 -0
  57. data/spec/rails_sandbox/app/assets/javascripts/application.js +0 -15
  58. data/spec/rails_sandbox/app/assets/stylesheets/application.css +0 -13
  59. data/spec/rails_sandbox/app/controllers/application_controller.rb +0 -3
  60. data/spec/rails_sandbox/app/helpers/application_helper.rb +0 -2
  61. data/spec/rails_sandbox/app/mailers/.gitkeep +0 -0
  62. data/spec/rails_sandbox/app/models/.gitkeep +0 -0
  63. data/spec/rails_sandbox/app/models/category.rb +0 -7
  64. data/spec/rails_sandbox/app/models/empty.rb +0 -2
  65. data/spec/rails_sandbox/app/models/loader_release.rb +0 -10
  66. data/spec/rails_sandbox/app/models/long_and_complex_table_linked_to_version.rb +0 -6
  67. data/spec/rails_sandbox/app/models/milestone.rb +0 -8
  68. data/spec/rails_sandbox/app/models/owner.rb +0 -5
  69. data/spec/rails_sandbox/app/models/project.rb +0 -26
  70. data/spec/rails_sandbox/app/models/test_model_defs.rb +0 -67
  71. data/spec/rails_sandbox/app/models/version.rb +0 -7
  72. data/spec/rails_sandbox/app/views/layouts/application.html.erb +0 -14
  73. data/spec/rails_sandbox/config.ru +0 -4
  74. data/spec/rails_sandbox/config/application.rb +0 -62
  75. data/spec/rails_sandbox/config/boot.rb +0 -6
  76. data/spec/rails_sandbox/config/database.yml +0 -20
  77. data/spec/rails_sandbox/config/environment.rb +0 -5
  78. data/spec/rails_sandbox/config/environments/development.rb +0 -37
  79. data/spec/rails_sandbox/config/environments/production.rb +0 -67
  80. data/spec/rails_sandbox/config/environments/test.rb +0 -37
  81. data/spec/rails_sandbox/config/initializers/backtrace_silencers.rb +0 -7
  82. data/spec/rails_sandbox/config/initializers/inflections.rb +0 -15
  83. data/spec/rails_sandbox/config/initializers/mime_types.rb +0 -5
  84. data/spec/rails_sandbox/config/initializers/secret_token.rb +0 -7
  85. data/spec/rails_sandbox/config/initializers/session_store.rb +0 -8
  86. data/spec/rails_sandbox/config/initializers/wrap_parameters.rb +0 -14
  87. data/spec/rails_sandbox/config/locales/en.yml +0 -5
  88. data/spec/rails_sandbox/config/routes.rb +0 -58
  89. data/spec/rails_sandbox/db/migrate/20110803201325_create_test_bed.rb +0 -96
  90. data/spec/rails_sandbox/db/schema.rb +0 -81
  91. data/spec/rails_sandbox/db/seeds.rb +0 -7
  92. data/spec/rails_sandbox/lib/assets/.gitkeep +0 -0
  93. data/spec/rails_sandbox/lib/tasks/.gitkeep +0 -0
  94. data/spec/rails_sandbox/log/.gitkeep +0 -0
  95. data/spec/rails_sandbox/public/404.html +0 -26
  96. data/spec/rails_sandbox/public/422.html +0 -26
  97. data/spec/rails_sandbox/public/500.html +0 -25
  98. data/spec/rails_sandbox/public/favicon.ico +0 -0
  99. data/spec/rails_sandbox/public/index.html +0 -241
  100. data/spec/rails_sandbox/public/robots.txt +0 -5
  101. data/spec/rails_sandbox/script/rails +0 -6
  102. data/spec/rails_sandbox/test/fixtures/.gitkeep +0 -0
  103. data/spec/rails_sandbox/test/functional/.gitkeep +0 -0
  104. data/spec/rails_sandbox/test/integration/.gitkeep +0 -0
  105. data/spec/rails_sandbox/test/performance/browsing_test.rb +0 -12
  106. data/spec/rails_sandbox/test/test_helper.rb +0 -13
  107. data/spec/rails_sandbox/test/unit/.gitkeep +0 -0
  108. data/spec/rails_sandbox/vendor/assets/javascripts/.gitkeep +0 -0
  109. data/spec/rails_sandbox/vendor/assets/stylesheets/.gitkeep +0 -0
  110. data/spec/rails_sandbox/vendor/plugins/.gitkeep +0 -0
data/.document DELETED
@@ -1,5 +0,0 @@
1
- lib/**/*.rb
2
- bin/*
3
- -
4
- features/**/*.feature
5
- LICENSE.txt
Binary file
Binary file
@@ -1,29 +0,0 @@
1
- ## YAML Template.
2
-
3
- # Format is :
4
- # --- !ruby/object:ActiveRecordModel
5
- # :datashift_defaults
6
- # :key value
7
- #
8
-
9
- Project:
10
- datashift_defaults:
11
- value_as_string: "Default Project Value"
12
- category: reference:category_002
13
-
14
- datashift_overrides:
15
- value_as_double: 99.23546
16
-
17
- --- !ruby/object:Project
18
- attributes:
19
- id:
20
- title:
21
- value_as_string: ""
22
- value_as_text: "object has value text"
23
- value_as_boolean:
24
- value_as_datetime:
25
- value_as_integer: 23
26
- value_as_double: 45.82
27
- created_at:
28
- updated_at:
29
-
Binary file
@@ -1,28 +0,0 @@
1
- # Used by spec helper to build test databases
2
- # These entires can be used in call to db_connect ( see spec_helper )
3
-
4
- <% adapter = 'sqlite3' %>
5
- <% adapter = 'jdbcsqlite3' if(DataShift::Guards::jruby? ) %>
6
-
7
- test_mysql:
8
- adapter: jdbcmysql
9
- database: datashift_test_models_db
10
- username: test
11
- password: test
12
- host: localhost
13
-
14
- test_memory:
15
- adapter: <%= adapter %>
16
- database: :memory
17
-
18
- test_file:
19
- adapter: <%= adapter %>
20
- database: <%= File.join(fixtures_path(), 'db', 'datashift_test_models_db.sqlite') %>
21
- encoding: utf8
22
- host: localhost
23
-
24
- test_spree_standalone:
25
- adapter: <%= adapter %>
26
- database: <%= File.join(fixtures_path(), 'db', 'datashift_Spree_db.sqlite') %>
27
- encoding: utf8
28
- host: localhost
@@ -1,96 +0,0 @@
1
- # Author :: Tom Statter
2
- # Date :: Aug 2011
3
- # License:: MIT
4
- #
5
- # Details:: Migration to create a test database that exercises all aspects of Active Record models
6
- #
7
-
8
- class CreateTestBed < ActiveRecord::Migration
9
-
10
- def self.up
11
-
12
- create_table :users do |t|
13
- t.string :title
14
- t.string :first_name
15
- end
16
-
17
- # belongs_to :user
18
- # has many :milestones
19
- #
20
- create_table :projects do |t|
21
- t.string :title
22
- t.string :value_as_string
23
- t.text :value_as_text
24
- t.boolean :value_as_boolean, :default => false
25
- t.datetime :value_as_datetime, :default => nil
26
- t.integer :value_as_integer, :default => 0
27
- t.decimal :value_as_double, :precision => 8, :scale => 2, :default => 0.0
28
- t.references :user
29
- t.timestamps
30
- end
31
-
32
- # belongs_to :project
33
- # @project => has_many :milestones
34
-
35
- create_table :milestones do |t|
36
- t.string :name
37
- t.datetime :datetime, :default => nil
38
- t.decimal :cost, :precision => 8, :scale => 2, :default => 0.0
39
- t.references :project
40
- t.timestamps
41
- end
42
-
43
- # belongs_to :project, project => has_one
44
- create_table :owners do |t|
45
- t.string :name
46
- t.references :project
47
- t.timestamps
48
- end
49
-
50
- # has_belongs_to_many :project
51
- create_table :categories do |t|
52
- t.string :reference
53
- t.timestamps
54
- end
55
-
56
- # testing has_belongs_to_many (hence no id)
57
- create_table :categories_projects, :id => false do |t|
58
- t.references :category
59
- t.references :project
60
- end
61
-
62
- create_table :versions do |t|
63
- t.string :name
64
- t.timestamps
65
- end
66
-
67
- # testing project has_many release + versions :through
68
- create_table :loader_releases do |t|
69
- t.string :name
70
- t.references :project
71
- t.references :version
72
- t.timestamps
73
- end
74
-
75
-
76
- create_table :long_and_complex_table_linked_to_versions do |t|
77
- t.references :version
78
- end
79
-
80
- create_table :empties do |t|
81
- end
82
-
83
- end
84
-
85
- def self.down
86
- drop_table :users
87
- drop_table :projects
88
- drop_table :categories
89
- drop_table :loader_releases
90
- drop_table :versions
91
- drop_table :categories_projectss
92
- drop_table :milestones
93
- drop_table :long_and_complex_table_linked_to_versions
94
- drop_table :empties
95
- end
96
- end
@@ -1,24 +0,0 @@
1
- # Author :: Tom Statter
2
- # Date :: Oct 2012
3
- # License:: MIT
4
- #
5
- # Details:: Migration for paperclip specs
6
-
7
- class AddDigitals < ActiveRecord::Migration
8
-
9
- def self.up
10
-
11
- create_table :digitals do |t|
12
- t.integer :owner_id
13
- t.string :attachment_file_name
14
- t.string :attachment_content_type
15
- t.integer :attachment_file_size
16
- t.timestamps
17
- end
18
-
19
- end
20
-
21
- def self.down
22
- drop_table :digitals
23
- end
24
- end
@@ -1,3 +0,0 @@
1
- require 'datashift'
2
-
3
- DataShift::load_commands
@@ -1,7 +0,0 @@
1
-
2
-
3
- # had_and_belongs to join table
4
- class Category < ActiveRecord::Base
5
- has_and_belongs_to_many :projects
6
- end
7
-
@@ -1,14 +0,0 @@
1
- # To change this template, choose Tools | Templates
2
- # and open the template in the editor.
3
-
4
- require 'paperclip'
5
-
6
- class Digital < ActiveRecord::Base
7
-
8
- include Paperclip::Glue
9
-
10
- attr_accessible :attachment
11
-
12
- has_attached_file :attachment, :styles => { :medium => "300x300>", :thumb => "100x100>" }, :path => ":rails_root/private/digitals/:id/:basename.:extension"
13
-
14
- end
@@ -1,2 +0,0 @@
1
- class Empty < ActiveRecord::Base
2
- end
@@ -1,10 +0,0 @@
1
-
2
-
3
- # Join Table with additional columns
4
- class LoaderRelease < ActiveRecord::Base
5
-
6
- belongs_to :project
7
- belongs_to :version
8
-
9
- #validate the name
10
- end
@@ -1,6 +0,0 @@
1
-
2
- # Join Table with additional columns
3
- class LongAndComplexTableLinkedToVersion < ActiveRecord::Base
4
-
5
- belongs_to :version
6
- end
@@ -1,8 +0,0 @@
1
-
2
-
3
- class Milestone < ActiveRecord::Base
4
- belongs_to :project
5
- #validate the name, cost
6
-
7
- delegate :title, :title=, :to => :project
8
- end
@@ -1,7 +0,0 @@
1
- class Owner < ActiveRecord::Base
2
-
3
- belongs_to :project, :dependent => :destroy
4
-
5
- has_many :digitals, :dependent => :destroy
6
-
7
- end
@@ -1,26 +0,0 @@
1
- # A set of models and associations we can use in our specs to test
2
- # basic database columns and also relationships
3
-
4
- # See Companion migration spec/db/migrate
5
-
6
- class Project < ActiveRecord::Base
7
-
8
- has_one :owner
9
-
10
- has_many :milestones
11
-
12
- has_many :loader_releases
13
- has_many :versions, :through => :loader_releases
14
-
15
-
16
- #has_many :release_versions, :through => :loader_releases, :source => :versions
17
-
18
- has_and_belongs_to_many :categories
19
-
20
- attr_accessible :value_as_string, :value_as_boolean, :value_as_double
21
-
22
- def multiply
23
- 10 * value_as_double
24
- end
25
-
26
- end
@@ -1,7 +0,0 @@
1
-
2
-
3
- class Version < ActiveRecord::Base
4
- has_many :releases
5
-
6
- has_one :long_and_complex_table_linked_to_version
7
- end
Binary file
Binary file
@@ -1,9 +0,0 @@
1
-
2
-
3
- # TODO investigate potential gem that might this require_all
4
-
5
- base = File.join(File.dirname(__FILE__), 'models')
6
-
7
- Dir[ File.join(base, '*.rb') ].each do |file|
8
- require File.join(base, File.basename(file, File.extname(file) ))
9
- end
@@ -1,15 +0,0 @@
1
- # See http://help.github.com/ignore-files/ for more about ignoring files.
2
- #
3
- # If you find yourself ignoring temporary files generated by your text editor
4
- # or operating system, you probably want to add a global ignore instead:
5
- # git config --global core.excludesfile ~/.gitignore_global
6
-
7
- # Ignore bundler config
8
- /.bundle
9
-
10
- # Ignore the default SQLite database.
11
- /db/*.sqlite3
12
-
13
- # Ignore all logfiles and tempfiles.
14
- /log/*.log
15
- /tmp
@@ -1,40 +0,0 @@
1
- source 'https://rubygems.org'
2
-
3
- gem 'rails', '3.2.8'
4
-
5
- # Bundle edge Rails instead:
6
- # gem 'rails', :git => 'git://github.com/rails/rails.git'
7
-
8
- gem 'activerecord-jdbcsqlite3-adapter'
9
-
10
- gem 'jruby-openssl'
11
- gem 'json'
12
-
13
- # Gems used only for assets and not required
14
- # in production environments by default.
15
- group :assets do
16
- gem 'sass-rails', '~> 3.2.3'
17
- gem 'coffee-rails', '~> 3.2.1'
18
-
19
- # See https://github.com/sstephenson/execjs#readme for more supported runtimes
20
- gem 'therubyrhino'
21
-
22
- gem 'uglifier', '>= 1.0.3'
23
- end
24
-
25
- gem 'jquery-rails'
26
-
27
- # To use ActiveModel has_secure_password
28
- # gem 'bcrypt-ruby', '~> 3.0.0'
29
-
30
- # To use Jbuilder templates for JSON
31
- # gem 'jbuilder'
32
-
33
- # Use unicorn as the app server
34
- # gem 'unicorn'
35
-
36
- # Deploy with Capistrano
37
- # gem 'capistrano'
38
-
39
- # To use debugger
40
- # gem 'ruby-debug'
@@ -1,261 +0,0 @@
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
- | `-- tasks
177
- |-- log
178
- |-- public
179
- |-- script
180
- |-- test
181
- | |-- fixtures
182
- | |-- functional
183
- | |-- integration
184
- | |-- performance
185
- | `-- unit
186
- |-- tmp
187
- | |-- cache
188
- | |-- pids
189
- | |-- sessions
190
- | `-- sockets
191
- `-- vendor
192
- |-- assets
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.