arvo-font-rails 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +14 -0
- data/Gemfile +17 -0
- data/Gemfile.lock +129 -0
- data/LICENSE +91 -0
- data/README.markdown +45 -0
- data/Rakefile +38 -0
- data/arvo-font-rails.gemspec +25 -0
- data/lib/arvo-font-rails.rb +1 -0
- data/lib/arvo-font-rails/engine.rb +7 -0
- data/lib/arvo-font-rails/version.rb +3 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/mailers/.gitkeep +0 -0
- data/test/dummy/app/models/.gitkeep +0 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +56 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +58 -0
- data/test/dummy/lib/assets/.gitkeep +0 -0
- data/test/dummy/log/.gitkeep +0 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/integration/css_test.rb +46 -0
- data/test/integration/font_files_test.rb +81 -0
- data/test/test_helper.rb +13 -0
- data/vendor/assets/fonts/Arvo-Bold-webfont.eot +0 -0
- data/vendor/assets/fonts/Arvo-Bold-webfont.svg +146 -0
- data/vendor/assets/fonts/Arvo-Bold-webfont.ttf +0 -0
- data/vendor/assets/fonts/Arvo-Bold-webfont.woff +0 -0
- data/vendor/assets/fonts/Arvo-BoldItalic-webfont.eot +0 -0
- data/vendor/assets/fonts/Arvo-BoldItalic-webfont.svg +146 -0
- data/vendor/assets/fonts/Arvo-BoldItalic-webfont.ttf +0 -0
- data/vendor/assets/fonts/Arvo-BoldItalic-webfont.woff +0 -0
- data/vendor/assets/fonts/Arvo-Italic-webfont.eot +0 -0
- data/vendor/assets/fonts/Arvo-Italic-webfont.svg +146 -0
- data/vendor/assets/fonts/Arvo-Italic-webfont.ttf +0 -0
- data/vendor/assets/fonts/Arvo-Italic-webfont.woff +0 -0
- data/vendor/assets/fonts/Arvo-Regular-webfont.eot +0 -0
- data/vendor/assets/fonts/Arvo-Regular-webfont.svg +145 -0
- data/vendor/assets/fonts/Arvo-Regular-webfont.ttf +0 -0
- data/vendor/assets/fonts/Arvo-Regular-webfont.woff +0 -0
- data/vendor/assets/stylesheets/arvo-font/bold-italic.scss +10 -0
- data/vendor/assets/stylesheets/arvo-font/bold.css.scss +10 -0
- data/vendor/assets/stylesheets/arvo-font/index.css +4 -0
- data/vendor/assets/stylesheets/arvo-font/italic.css.scss +10 -0
- data/vendor/assets/stylesheets/arvo-font/regular.css.scss +10 -0
- metadata +299 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
source "http://rubygems.org"
|
2
|
+
|
3
|
+
# Declare your gem's dependencies in arvo-font-rails.gemspec.
|
4
|
+
# Bundler will treat runtime dependencies like base dependencies, and
|
5
|
+
# development dependencies will be added by default to the :development group.
|
6
|
+
gemspec
|
7
|
+
|
8
|
+
# jquery-rails is used by the dummy application
|
9
|
+
gem "jquery-rails"
|
10
|
+
|
11
|
+
# Declare any dependencies that are still in development here instead of in
|
12
|
+
# your gemspec. These might include edge Rails or gems from your path or
|
13
|
+
# Git. Remember to move these dependencies to your gemspec before releasing
|
14
|
+
# your gem to rubygems.org.
|
15
|
+
|
16
|
+
# To use debugger
|
17
|
+
# gem 'ruby-debug19', :require => 'ruby-debug'
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,129 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
arvo-font-rails (0.0.1)
|
5
|
+
rails (> 3.1)
|
6
|
+
sass-rails
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: http://rubygems.org/
|
10
|
+
specs:
|
11
|
+
actionmailer (3.2.3)
|
12
|
+
actionpack (= 3.2.3)
|
13
|
+
mail (~> 2.4.4)
|
14
|
+
actionpack (3.2.3)
|
15
|
+
activemodel (= 3.2.3)
|
16
|
+
activesupport (= 3.2.3)
|
17
|
+
builder (~> 3.0.0)
|
18
|
+
erubis (~> 2.7.0)
|
19
|
+
journey (~> 1.0.1)
|
20
|
+
rack (~> 1.4.0)
|
21
|
+
rack-cache (~> 1.2)
|
22
|
+
rack-test (~> 0.6.1)
|
23
|
+
sprockets (~> 2.1.2)
|
24
|
+
activemodel (3.2.3)
|
25
|
+
activesupport (= 3.2.3)
|
26
|
+
builder (~> 3.0.0)
|
27
|
+
activerecord (3.2.3)
|
28
|
+
activemodel (= 3.2.3)
|
29
|
+
activesupport (= 3.2.3)
|
30
|
+
arel (~> 3.0.2)
|
31
|
+
tzinfo (~> 0.3.29)
|
32
|
+
activeresource (3.2.3)
|
33
|
+
activemodel (= 3.2.3)
|
34
|
+
activesupport (= 3.2.3)
|
35
|
+
activesupport (3.2.3)
|
36
|
+
i18n (~> 0.6)
|
37
|
+
multi_json (~> 1.0)
|
38
|
+
addressable (2.2.7)
|
39
|
+
arel (3.0.2)
|
40
|
+
builder (3.0.0)
|
41
|
+
capybara (1.1.2)
|
42
|
+
mime-types (>= 1.16)
|
43
|
+
nokogiri (>= 1.3.3)
|
44
|
+
rack (>= 1.0.0)
|
45
|
+
rack-test (>= 0.5.4)
|
46
|
+
selenium-webdriver (~> 2.0)
|
47
|
+
xpath (~> 0.1.4)
|
48
|
+
childprocess (0.3.2)
|
49
|
+
ffi (~> 1.0.6)
|
50
|
+
erubis (2.7.0)
|
51
|
+
ffi (1.0.11)
|
52
|
+
hike (1.2.1)
|
53
|
+
i18n (0.6.0)
|
54
|
+
journey (1.0.3)
|
55
|
+
jquery-rails (2.0.2)
|
56
|
+
railties (>= 3.2.0, < 5.0)
|
57
|
+
thor (~> 0.14)
|
58
|
+
json (1.6.6)
|
59
|
+
libwebsocket (0.1.3)
|
60
|
+
addressable
|
61
|
+
mail (2.4.4)
|
62
|
+
i18n (>= 0.4.0)
|
63
|
+
mime-types (~> 1.16)
|
64
|
+
treetop (~> 1.4.8)
|
65
|
+
mime-types (1.18)
|
66
|
+
minitest (2.12.1)
|
67
|
+
multi_json (1.3.2)
|
68
|
+
nokogiri (1.5.2)
|
69
|
+
polyglot (0.3.3)
|
70
|
+
rack (1.4.1)
|
71
|
+
rack-cache (1.2)
|
72
|
+
rack (>= 0.4)
|
73
|
+
rack-ssl (1.3.2)
|
74
|
+
rack
|
75
|
+
rack-test (0.6.1)
|
76
|
+
rack (>= 1.0)
|
77
|
+
rails (3.2.3)
|
78
|
+
actionmailer (= 3.2.3)
|
79
|
+
actionpack (= 3.2.3)
|
80
|
+
activerecord (= 3.2.3)
|
81
|
+
activeresource (= 3.2.3)
|
82
|
+
activesupport (= 3.2.3)
|
83
|
+
bundler (~> 1.0)
|
84
|
+
railties (= 3.2.3)
|
85
|
+
railties (3.2.3)
|
86
|
+
actionpack (= 3.2.3)
|
87
|
+
activesupport (= 3.2.3)
|
88
|
+
rack-ssl (~> 1.3.2)
|
89
|
+
rake (>= 0.8.7)
|
90
|
+
rdoc (~> 3.4)
|
91
|
+
thor (~> 0.14.6)
|
92
|
+
rake (0.9.2.2)
|
93
|
+
rdoc (3.12)
|
94
|
+
json (~> 1.4)
|
95
|
+
rubyzip (0.9.7)
|
96
|
+
sass (3.1.16)
|
97
|
+
sass-rails (3.2.5)
|
98
|
+
railties (~> 3.2.0)
|
99
|
+
sass (>= 3.1.10)
|
100
|
+
tilt (~> 1.3)
|
101
|
+
selenium-webdriver (2.21.2)
|
102
|
+
childprocess (>= 0.2.5)
|
103
|
+
ffi (~> 1.0)
|
104
|
+
libwebsocket (~> 0.1.3)
|
105
|
+
multi_json (~> 1.0)
|
106
|
+
rubyzip
|
107
|
+
sprockets (2.1.2)
|
108
|
+
hike (~> 1.2)
|
109
|
+
rack (~> 1.0)
|
110
|
+
tilt (~> 1.1, != 1.3.0)
|
111
|
+
sqlite3 (1.3.6)
|
112
|
+
thor (0.14.6)
|
113
|
+
tilt (1.3.3)
|
114
|
+
treetop (1.4.10)
|
115
|
+
polyglot
|
116
|
+
polyglot (>= 0.3.1)
|
117
|
+
tzinfo (0.3.33)
|
118
|
+
xpath (0.1.4)
|
119
|
+
nokogiri (~> 1.3)
|
120
|
+
|
121
|
+
PLATFORMS
|
122
|
+
ruby
|
123
|
+
|
124
|
+
DEPENDENCIES
|
125
|
+
arvo-font-rails!
|
126
|
+
capybara
|
127
|
+
jquery-rails
|
128
|
+
minitest
|
129
|
+
sqlite3
|
data/LICENSE
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
2
|
+
This license is copied below, and is also available with a FAQ at:
|
3
|
+
http://scripts.sil.org/OFL
|
4
|
+
|
5
|
+
|
6
|
+
-----------------------------------------------------------
|
7
|
+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
8
|
+
-----------------------------------------------------------
|
9
|
+
|
10
|
+
PREAMBLE
|
11
|
+
The goals of the Open Font License (OFL) are to stimulate worldwide
|
12
|
+
development of collaborative font projects, to support the font creation
|
13
|
+
efforts of academic and linguistic communities, and to provide a free and
|
14
|
+
open framework in which fonts may be shared and improved in partnership
|
15
|
+
with others.
|
16
|
+
|
17
|
+
The OFL allows the licensed fonts to be used, studied, modified and
|
18
|
+
redistributed freely as long as they are not sold by themselves. The
|
19
|
+
fonts, including any derivative works, can be bundled, embedded,
|
20
|
+
redistributed and/or sold with any software provided that any reserved
|
21
|
+
names are not used by derivative works. The fonts and derivatives,
|
22
|
+
however, cannot be released under any other type of license. The
|
23
|
+
requirement for fonts to remain under this license does not apply
|
24
|
+
to any document created using the fonts or their derivatives.
|
25
|
+
|
26
|
+
DEFINITIONS
|
27
|
+
"Font Software" refers to the set of files released by the Copyright
|
28
|
+
Holder(s) under this license and clearly marked as such. This may
|
29
|
+
include source files, build scripts and documentation.
|
30
|
+
|
31
|
+
"Reserved Font Name" refers to any names specified as such after the
|
32
|
+
copyright statement(s).
|
33
|
+
|
34
|
+
"Original Version" refers to the collection of Font Software components as
|
35
|
+
distributed by the Copyright Holder(s).
|
36
|
+
|
37
|
+
"Modified Version" refers to any derivative made by adding to, deleting,
|
38
|
+
or substituting -- in part or in whole -- any of the components of the
|
39
|
+
Original Version, by changing formats or by porting the Font Software to a
|
40
|
+
new environment.
|
41
|
+
|
42
|
+
"Author" refers to any designer, engineer, programmer, technical
|
43
|
+
writer or other person who contributed to the Font Software.
|
44
|
+
|
45
|
+
PERMISSION & CONDITIONS
|
46
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
47
|
+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
48
|
+
redistribute, and sell modified and unmodified copies of the Font
|
49
|
+
Software, subject to the following conditions:
|
50
|
+
|
51
|
+
1) Neither the Font Software nor any of its individual components,
|
52
|
+
in Original or Modified Versions, may be sold by itself.
|
53
|
+
|
54
|
+
2) Original or Modified Versions of the Font Software may be bundled,
|
55
|
+
redistributed and/or sold with any software, provided that each copy
|
56
|
+
contains the above copyright notice and this license. These can be
|
57
|
+
included either as stand-alone text files, human-readable headers or
|
58
|
+
in the appropriate machine-readable metadata fields within text or
|
59
|
+
binary files as long as those fields can be easily viewed by the user.
|
60
|
+
|
61
|
+
3) No Modified Version of the Font Software may use the Reserved Font
|
62
|
+
Name(s) unless explicit written permission is granted by the corresponding
|
63
|
+
Copyright Holder. This restriction only applies to the primary font name as
|
64
|
+
presented to the users.
|
65
|
+
|
66
|
+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
67
|
+
Software shall not be used to promote, endorse or advertise any
|
68
|
+
Modified Version, except to acknowledge the contribution(s) of the
|
69
|
+
Copyright Holder(s) and the Author(s) or with their explicit written
|
70
|
+
permission.
|
71
|
+
|
72
|
+
5) The Font Software, modified or unmodified, in part or in whole,
|
73
|
+
must be distributed entirely under this license, and must not be
|
74
|
+
distributed under any other license. The requirement for fonts to
|
75
|
+
remain under this license does not apply to any document created
|
76
|
+
using the Font Software.
|
77
|
+
|
78
|
+
TERMINATION
|
79
|
+
This license becomes null and void if any of the above conditions are
|
80
|
+
not met.
|
81
|
+
|
82
|
+
DISCLAIMER
|
83
|
+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
84
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
85
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
86
|
+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
87
|
+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
88
|
+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
89
|
+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
90
|
+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
91
|
+
OTHER DEALINGS IN THE FONT SOFTWARE.
|
data/README.markdown
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
# arvo-font-rails
|
2
|
+
|
3
|
+
Adds the [Arvo font](http://www.fontsquirrel.com/fonts/arvo) by Anton Koovit to the Rails 3.1+ asset pipeline.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'arvo-font-rails'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
## Usage
|
16
|
+
|
17
|
+
In your application.css you can choose to include all 4 variations or include them individually
|
18
|
+
|
19
|
+
# Include all
|
20
|
+
*= require 'arvo-font'
|
21
|
+
|
22
|
+
# Include only bold
|
23
|
+
*= require 'arvo-font/bold'
|
24
|
+
|
25
|
+
You can choose 'arvo-font/regular' 'arvo-font/bold' 'arvo-font/italic' and 'arvo-font/bold-italic'
|
26
|
+
|
27
|
+
Then you can assign these using standard css font-family
|
28
|
+
|
29
|
+
body {
|
30
|
+
font-family: 'ArvoRegular', sans-serif;
|
31
|
+
}
|
32
|
+
|
33
|
+
header#masthead h1 {
|
34
|
+
font-family: 'ArvoBold', sans-serif;
|
35
|
+
}
|
36
|
+
|
37
|
+
Available font-familys are 'ArvoRegular', 'ArvoItalic', 'ArvoBold' and 'ArvoBoldItalic'
|
38
|
+
|
39
|
+
## Contributing
|
40
|
+
|
41
|
+
1. Fork it
|
42
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
43
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
44
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
45
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,38 @@
|
|
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 = 'ArvoFontRails'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('README.rdoc')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
Bundler::GemHelper.install_tasks
|
27
|
+
|
28
|
+
require 'rake/testtask'
|
29
|
+
|
30
|
+
Rake::TestTask.new(:test) do |t|
|
31
|
+
t.libs << 'lib'
|
32
|
+
t.libs << 'test'
|
33
|
+
t.pattern = 'test/**/*_test.rb'
|
34
|
+
t.verbose = false
|
35
|
+
end
|
36
|
+
|
37
|
+
|
38
|
+
task :default => :test
|
@@ -0,0 +1,25 @@
|
|
1
|
+
$:.push File.expand_path("../lib", __FILE__)
|
2
|
+
|
3
|
+
# Maintain your gem's version:
|
4
|
+
require "arvo-font-rails/version"
|
5
|
+
|
6
|
+
# Describe your gem and declare its dependencies:
|
7
|
+
Gem::Specification.new do |s|
|
8
|
+
s.name = "arvo-font-rails"
|
9
|
+
s.version = ArvoFontRails::VERSION
|
10
|
+
s.authors = ["Mark McConachie"]
|
11
|
+
s.email = ["mark@proofloop.com"]
|
12
|
+
s.homepage = "http://markmcconachie.com"
|
13
|
+
s.summary = "Arvo font by Anton Koovit for rails asset pipeline"
|
14
|
+
s.description = "Arvo font by Anton Koovit for rails asset pipeline"
|
15
|
+
|
16
|
+
s.files = `git ls-files`.split($\)
|
17
|
+
s.test_files = Dir["test/**/*"]
|
18
|
+
|
19
|
+
s.add_dependency "rails", "> 3.1"
|
20
|
+
s.add_dependency 'sass-rails'
|
21
|
+
|
22
|
+
s.add_development_dependency "sqlite3"
|
23
|
+
s.add_development_dependency 'minitest'
|
24
|
+
s.add_development_dependency 'capybara'
|
25
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require "arvo-font-rails/engine"
|
@@ -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
|
+
| `-- 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.
|