effective_slugs 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/MIT-LICENSE +20 -0
- data/README.md +128 -0
- data/Rakefile +23 -0
- data/app/models/concerns/acts_as_sluggable.rb +167 -0
- data/lib/effective_slugs/engine.rb +20 -0
- data/lib/effective_slugs/version.rb +3 -0
- data/lib/effective_slugs.rb +23 -0
- data/lib/generators/effective_slugs/install_generator.rb +17 -0
- data/lib/generators/templates/README +1 -0
- data/lib/generators/templates/effective_slugs.rb +3 -0
- data/lib/tasks/effective_slugs_tasks.rake +4 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/assets/javascripts/application.js +15 -0
- data/spec/dummy/app/assets/stylesheets/application.css +13 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/config/application.rb +59 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +25 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +37 -0
- data/spec/dummy/config/environments/production.rb +67 -0
- data/spec/dummy/config/environments/test.rb +37 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/inflections.rb +15 -0
- data/spec/dummy/config/initializers/mime_types.rb +5 -0
- data/spec/dummy/config/initializers/secret_token.rb +7 -0
- data/spec/dummy/config/initializers/session_store.rb +8 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/routes.rb +58 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/db/development.sqlite3 +0 -0
- data/spec/dummy/db/schema.rb +16 -0
- data/spec/dummy/db/test.sqlite3 +0 -0
- data/spec/dummy/log/development.log +6 -0
- data/spec/dummy/log/test.log +2 -0
- data/spec/dummy/public/404.html +26 -0
- data/spec/dummy/public/422.html +26 -0
- data/spec/dummy/public/500.html +25 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/effective_slugs_spec.rb +7 -0
- data/spec/spec_helper.rb +34 -0
- data/spec/support/factories.rb +1 -0
- metadata +211 -0
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2013 Code and Effect Inc.
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
# Effective Slugs
|
2
|
+
|
3
|
+
Generates a URL-appropriate slug, as required, when saving a record.
|
4
|
+
|
5
|
+
Also overrides ActiveRecord .find() methods to accept the slug, or an id as the parameter.
|
6
|
+
|
7
|
+
Rails >= 3.2.x, Ruby >= 1.9.x. Has not been tested/developed for Rails4.
|
8
|
+
|
9
|
+
|
10
|
+
## Getting Started
|
11
|
+
|
12
|
+
Add to Gemfile:
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
gem 'effective_slugs'
|
16
|
+
```
|
17
|
+
|
18
|
+
Run the bundle command to install it:
|
19
|
+
|
20
|
+
```console
|
21
|
+
bundle install
|
22
|
+
```
|
23
|
+
|
24
|
+
(optional) If you want control over any excluded slugs, run the generator:
|
25
|
+
|
26
|
+
```console
|
27
|
+
rails generate effective_slugs:install
|
28
|
+
```
|
29
|
+
|
30
|
+
The generator will install an initializer which describes all configuration options.
|
31
|
+
|
32
|
+
|
33
|
+
## Usage
|
34
|
+
|
35
|
+
Add the mixin to an existing model:
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
class Post
|
39
|
+
acts_as_sluggable
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
Then create a migration to add the :slug column to the model.
|
44
|
+
As we're doing lookups on this column, a database index makes a lot of sense too:
|
45
|
+
|
46
|
+
```console
|
47
|
+
rails generate migration add_slug_to_post slug:string:index
|
48
|
+
```
|
49
|
+
|
50
|
+
which will create a migration something like
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
class AddSlugToPost < ActiveRecord::Migration
|
54
|
+
def change
|
55
|
+
add_column :posts, :slug, :string
|
56
|
+
add_index :posts, :slug
|
57
|
+
end
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
## Behavior
|
62
|
+
|
63
|
+
### Slug Generation
|
64
|
+
|
65
|
+
When saving a record that does not have a slug, a slug will be automatically generated and assigned.
|
66
|
+
|
67
|
+
Tweak the behavior by adding the following instance method to the model:
|
68
|
+
|
69
|
+
```ruby
|
70
|
+
def should_generate_new_slug?
|
71
|
+
slug.blank?
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
The slug is generated based on the slug_source instance method, which can also be overridden by adding the following instance method to the model:
|
76
|
+
|
77
|
+
```ruby
|
78
|
+
def slug_source
|
79
|
+
return title if self.respond_to?(:title)
|
80
|
+
return name if self.respond_to?(:name)
|
81
|
+
to_s
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
There is also the idea of excluded slugs. Every model in a rails application has its default route automatically excluded.
|
86
|
+
So if you have a model called Event, with its corresponding 'events' table, the /events slug will be unavailable.
|
87
|
+
|
88
|
+
You can add additional excluded slugs in the generated config file.
|
89
|
+
|
90
|
+
Any slug conflicts will be resolved by appending a -1, -2, etc to the slug.
|
91
|
+
|
92
|
+
### Finder Methods
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
post = Post.create(:title => 'My First Post')
|
96
|
+
post.id
|
97
|
+
=> 1
|
98
|
+
post.slug
|
99
|
+
=> 'my-first-post'
|
100
|
+
```
|
101
|
+
|
102
|
+
The .find() ActiveRecord method is overridden so the following are equivelant:
|
103
|
+
|
104
|
+
```ruby
|
105
|
+
Post.find('my-first-post')
|
106
|
+
Post.find(1)
|
107
|
+
Post.where(:slug => 'my-first-post').first
|
108
|
+
```
|
109
|
+
|
110
|
+
## License
|
111
|
+
|
112
|
+
MIT License. Copyright Code and Effect Inc. http://www.codeandeffect.com
|
113
|
+
|
114
|
+
You are not granted rights or licenses to the trademarks of Code and Effect
|
115
|
+
|
116
|
+
## Credits
|
117
|
+
|
118
|
+
Some of the code in this gem was inspired by an old version of FriendlyId (https://github.com/FriendlyId/friendly_id)
|
119
|
+
|
120
|
+
### Testing
|
121
|
+
|
122
|
+
The test suite for this gem is unfortunately not yet complete.
|
123
|
+
|
124
|
+
Run tests by:
|
125
|
+
|
126
|
+
```ruby
|
127
|
+
rake spec
|
128
|
+
```
|
data/Rakefile
ADDED
@@ -0,0 +1,23 @@
|
|
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
|
+
|
8
|
+
# Our tasks
|
9
|
+
load 'lib/tasks/effective_slugs_tasks.rake'
|
10
|
+
|
11
|
+
# Testing tasks
|
12
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
13
|
+
load 'rails/tasks/engine.rake'
|
14
|
+
|
15
|
+
Bundler::GemHelper.install_tasks
|
16
|
+
|
17
|
+
require 'rspec/core'
|
18
|
+
require 'rspec/core/rake_task'
|
19
|
+
|
20
|
+
desc "Run all specs in spec directory (excluding plugin specs)"
|
21
|
+
RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
|
22
|
+
|
23
|
+
task :default => :spec
|
@@ -0,0 +1,167 @@
|
|
1
|
+
# ActsAsSluggable
|
2
|
+
#
|
3
|
+
# This module automatically generates slugs based on the :title, :name, or :to_s field
|
4
|
+
# using a before_validation filter
|
5
|
+
#
|
6
|
+
# Mark your model with 'acts_as_sluggable'
|
7
|
+
#
|
8
|
+
# and create the migration
|
9
|
+
#
|
10
|
+
# structure do
|
11
|
+
# slug :string
|
12
|
+
# end
|
13
|
+
#
|
14
|
+
# You can override
|
15
|
+
# ActsAsSluggable
|
16
|
+
#
|
17
|
+
# This module automatically generates slugs based on the :title, :name, or :to_s field
|
18
|
+
# using a before_validation filter
|
19
|
+
#
|
20
|
+
# Mark your model with 'acts_as_sluggable'
|
21
|
+
#
|
22
|
+
# and create the migration
|
23
|
+
#
|
24
|
+
# structure do
|
25
|
+
# slug :string
|
26
|
+
# end
|
27
|
+
#
|
28
|
+
# You can override
|
29
|
+
# def should_generate_new_slug?
|
30
|
+
# new_record?
|
31
|
+
# end
|
32
|
+
#
|
33
|
+
# and
|
34
|
+
# def slug_source
|
35
|
+
# return title if self.respond_to?(:title)
|
36
|
+
# return name if self.respond_to?(:name)
|
37
|
+
# to_s
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# This will work transparently with the ActsAsSiteSpecific, and should "just work"
|
41
|
+
# Please do not put any unique indexes on the slugs column. Or make it unique [:slug, :site_id]
|
42
|
+
|
43
|
+
module ActsAsSluggable
|
44
|
+
extend ActiveSupport::Concern
|
45
|
+
|
46
|
+
module ActiveRecord
|
47
|
+
def acts_as_sluggable(options = {})
|
48
|
+
if self.methods.include?(:is_site_specific) # ActsAsSiteSpecific
|
49
|
+
@acts_as_sluggable_opts = {:validation_scope => :site_id}.merge(options)
|
50
|
+
else
|
51
|
+
@acts_as_sluggable_opts = {}.merge(options)
|
52
|
+
end
|
53
|
+
|
54
|
+
include ::ActsAsSluggable
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
included do
|
59
|
+
before_validation :set_slug, :if => proc { should_generate_new_slug? }
|
60
|
+
|
61
|
+
#attr_accessible :slug
|
62
|
+
validates_presence_of :slug
|
63
|
+
validates_exclusion_of :slug, :in => EffectiveSlugs.all_excluded_slugs
|
64
|
+
validates_format_of :slug, :with => /^[a-zA-Z0-9_\-]*[a-zA-Z][a-zA-Z0-9_\-]*$/, :message => 'only _ and - symbols allowed'
|
65
|
+
|
66
|
+
if @acts_as_sluggable_opts[:validation_scope]
|
67
|
+
validates_uniqueness_of :slug, :scope => @acts_as_sluggable_opts[:validation_scope]
|
68
|
+
else
|
69
|
+
validates_uniqueness_of :slug
|
70
|
+
end
|
71
|
+
|
72
|
+
class_eval do
|
73
|
+
class << self
|
74
|
+
alias relation_without_sluggable relation
|
75
|
+
end
|
76
|
+
|
77
|
+
def self.relation
|
78
|
+
@relation = nil unless @relation.class <= relation_class
|
79
|
+
@relation ||= relation_class.new(self, arel_table)
|
80
|
+
end
|
81
|
+
|
82
|
+
# Gets an anonymous subclass of the model's relation class.
|
83
|
+
# This should increase long term compatibility with any gems that also override finder methods
|
84
|
+
# The other idea would be to just return Class.new(ActiveRecord::Relation)
|
85
|
+
|
86
|
+
def self.relation_class
|
87
|
+
@relation_class ||= Class.new(relation_without_sluggable.class) do
|
88
|
+
alias_method :find_one_without_sluggable, :find_one
|
89
|
+
alias_method :exists_without_sluggable?, :exists?
|
90
|
+
include ActsAsSluggable::FinderMethods
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
|
96
|
+
module ClassMethods
|
97
|
+
end
|
98
|
+
|
99
|
+
# We inject these methods into the ActsAsSluggable.relation class, as below
|
100
|
+
# Allows us to use sluggable id's identically to numeric ids in Finders
|
101
|
+
# And lets all the pages_path() type stuff work
|
102
|
+
#
|
103
|
+
# This makes all these the same:
|
104
|
+
# Post.find(3) == Post.find('post-slug') == Post.find(post)
|
105
|
+
module FinderMethods
|
106
|
+
protected
|
107
|
+
|
108
|
+
# Find one can be passed 4, "my-slug" or <Object>
|
109
|
+
def find_one(id)
|
110
|
+
begin
|
111
|
+
if id.respond_to?(:slug)
|
112
|
+
where(:slug => id.slug).first
|
113
|
+
elsif id.kind_of?(String)
|
114
|
+
where(:slug => id).first
|
115
|
+
end || super
|
116
|
+
rescue => e
|
117
|
+
super
|
118
|
+
end
|
119
|
+
end
|
120
|
+
|
121
|
+
def exists?(id = false)
|
122
|
+
if id.respond_to?(:slug)
|
123
|
+
super :slug => id.slug
|
124
|
+
elsif id.kind_of?(String)
|
125
|
+
super :slug => id
|
126
|
+
else
|
127
|
+
super
|
128
|
+
end
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
def set_slug
|
133
|
+
raise StandardError, "ActsAsSluggable expected a table column :slug to exist" unless self.respond_to?(:slug)
|
134
|
+
|
135
|
+
new_slug = slug_source.to_s.try(:parameterize)
|
136
|
+
|
137
|
+
if new_slug.present?
|
138
|
+
while EffectiveSlugs.excluded_slugs.include?(new_slug) do
|
139
|
+
new_slug << "-" << self.class.name.demodulize.parameterize
|
140
|
+
end
|
141
|
+
|
142
|
+
# TODO: Could make this a bit smarter about conflicts
|
143
|
+
num_slugs = self.class.name.constantize.where(:slug => new_slug).count
|
144
|
+
num_slugs = self.class.name.constantize.where('slug LIKE ?', "#{new_slug}%").count if num_slugs > 0
|
145
|
+
|
146
|
+
num_slugs == 0 ? self.slug = new_slug : self.slug = "#{new_slug}-#{num_slugs}"
|
147
|
+
end
|
148
|
+
|
149
|
+
true
|
150
|
+
end
|
151
|
+
|
152
|
+
def slug_source
|
153
|
+
return title if self.respond_to?(:title)
|
154
|
+
return name if self.respond_to?(:name)
|
155
|
+
to_s
|
156
|
+
end
|
157
|
+
|
158
|
+
def should_generate_new_slug?
|
159
|
+
slug.blank?
|
160
|
+
end
|
161
|
+
|
162
|
+
def to_param
|
163
|
+
slug.present? ? slug_was : id.to_s
|
164
|
+
end
|
165
|
+
|
166
|
+
end
|
167
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
module EffectiveSlugs
|
2
|
+
class Engine < ::Rails::Engine
|
3
|
+
engine_name 'effective_slugs'
|
4
|
+
|
5
|
+
config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
|
6
|
+
|
7
|
+
# Include acts_as_addressable concern and allow any ActiveRecord object to call it
|
8
|
+
initializer 'effective_slugs.active_record' do |app|
|
9
|
+
ActiveSupport.on_load :active_record do
|
10
|
+
ActiveRecord::Base.extend(ActsAsSluggable::ActiveRecord)
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
# Set up our default configuration options.
|
15
|
+
initializer "effective_slugs.defaults", :before => :load_config_initializers do |app|
|
16
|
+
eval File.read("#{config.root}/lib/generators/templates/effective_slugs.rb")
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
require "effective_slugs/engine"
|
2
|
+
require "effective_slugs/version"
|
3
|
+
|
4
|
+
module EffectiveSlugs
|
5
|
+
mattr_accessor :excluded_slugs
|
6
|
+
|
7
|
+
def self.setup
|
8
|
+
yield self
|
9
|
+
end
|
10
|
+
|
11
|
+
# This restricts /events /jobs /posts /pages type slugs, for every model in our application.
|
12
|
+
def self.all_excluded_slugs
|
13
|
+
Rails.env.development? ? get_all_excluded_slugs : (@@excluded_slugs ||= get_all_excluded_slugs)
|
14
|
+
end
|
15
|
+
|
16
|
+
private
|
17
|
+
|
18
|
+
def self.get_all_excluded_slugs
|
19
|
+
(ActiveRecord::Base.connection.tables.map { |x| x }.compact + (EffectiveSlugs.excluded_slugs || []))
|
20
|
+
end
|
21
|
+
|
22
|
+
|
23
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module EffectiveSlugs
|
2
|
+
module Generators
|
3
|
+
class InstallGenerator < Rails::Generators::Base
|
4
|
+
desc "Creates an EffectiveSlugs initializer in your application."
|
5
|
+
|
6
|
+
source_root File.expand_path("../../templates", __FILE__)
|
7
|
+
|
8
|
+
def copy_initializer
|
9
|
+
template "effective_slugs.rb", "config/initializers/effective_slugs.rb"
|
10
|
+
end
|
11
|
+
|
12
|
+
def show_readme
|
13
|
+
readme "README" if behavior == :invoke
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
Thanks for using EffectiveSlugs
|
@@ -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.
|
data/spec/dummy/Rakefile
ADDED
@@ -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
|