uuidify 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- checksums.yaml.gz.asc +12 -0
- data/LICENSE +31 -0
- data/README.md +25 -0
- data/Rakefile +44 -0
- data/app/models/uuidify/uuid.rb +4 -0
- data/db/migrate/20130612143347_create_uuidify_uuids.rb +18 -0
- data/lib/tasks/guidify_tasks.rake +4 -0
- data/lib/uuidify/engine.rb +5 -0
- data/lib/uuidify/uuidify_concern.rb +69 -0
- data/lib/uuidify/uuidify_exception.rb +2 -0
- data/lib/uuidify/version.rb +3 -0
- data/lib/uuidify.rb +22 -0
- data/lib/uuidify.rb~ +46 -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/models/bar.rb +3 -0
- data/spec/dummy/app/models/foo.rb +3 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/config/application.rb +69 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +14 -0
- data/spec/dummy/config/database.yml.sample +14 -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/migrate/20130612135708_create_foos.rb +8 -0
- data/spec/dummy/db/migrate/20130613135222_create_bars.rb +8 -0
- data/spec/dummy/db/schema.rb +21 -0
- data/spec/dummy/db/structure.sql +35 -0
- data/spec/dummy/log/development.log +310 -0
- data/spec/dummy/log/test.log +21700 -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/spec_helper.rb +11 -0
- data/spec/uuidify_spec.rb +128 -0
- data.tar.gz.asc +12 -0
- metadata +204 -0
- metadata.gz.asc +12 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 1a9e959197e4e8a62bcbb16ded7067741fbdab5c
|
4
|
+
data.tar.gz: 1c92ad53e4716ee3a8c23aee7da0cca921f4e196
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d3dd3353d5fd4339fe2b9b427589bd755708bdb804969b7c298d16442741c9e7aa4317832f10fc5c7b0dae6e3aa23656ec2ad379489612132e475a5b635d067d
|
7
|
+
data.tar.gz: 414d085b9e63883137c205c00a994e5d6f62881e937b51e5eb26b916172295cad910bea808e2a210d1b1eb4d326616fd100c6bd071f0bd30273adc810526449c
|
checksums.yaml.gz.asc
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
-----BEGIN PGP SIGNATURE-----
|
2
|
+
Version: GnuPG/MacGPG2 v2.0.19 (Darwin)
|
3
|
+
Comment: GPGTools - http://gpgtools.org
|
4
|
+
|
5
|
+
iQEcBAABCgAGBQJSYAHrAAoJEP5F5V2hilTWVTsH/RvqX1tXbzrismXLpW6+B/Z9
|
6
|
+
Qy6u0z1CpMQrfDYCei0fAcjZgAcoedU9i0k/9CsKk35qGEEr1GM6+9K8Sfyzeos5
|
7
|
+
LQgEcPUcrn+dQWHP+pTh/qU7kVsMI0xiWE4hVXrzgcdndS9CK8r2T9wmGoNqBKtm
|
8
|
+
JR3CXH9W9gqDxc2E3ddX0FqsP7g6QzW5GmaVOo2DcT50UBuCtY88MeLz9Dqg0S1Q
|
9
|
+
HB9w/lUXKb9yq9NxmzVJVC/glFja6MV8arKvtIXGpyfs9aghmBDwyhn9GDwiou4j
|
10
|
+
KuLJpMjW6w7dsK0bbtBHAfUVEWY4Dg7H2xj0Kda+FPcp6za0ewieBwcskZ/vRbw=
|
11
|
+
=3Z04
|
12
|
+
-----END PGP SIGNATURE-----
|
data/LICENSE
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
Copyright (c) 2013 Grant T. Olson
|
2
|
+
All rights reserved.
|
3
|
+
|
4
|
+
Redistribution and use in source and binary forms, with or without
|
5
|
+
modification, are permitted provided that the following conditions are
|
6
|
+
met:
|
7
|
+
|
8
|
+
* Redistributions of source code must retain the above copyright
|
9
|
+
notice, this list of conditions and the following disclaimer.
|
10
|
+
|
11
|
+
* Redistributions in binary form must reproduce the above
|
12
|
+
copyright notice, this list of conditions and the following
|
13
|
+
disclaimer in the documentation and/or other materials provided
|
14
|
+
with the distribution.
|
15
|
+
|
16
|
+
* Neither the name of the Grant T. Olson nor the names of
|
17
|
+
additional contributors may be used to endorse or promote
|
18
|
+
products derived from this software without specific prior
|
19
|
+
written permission.
|
20
|
+
|
21
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
22
|
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
23
|
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
24
|
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
25
|
+
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
26
|
+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
27
|
+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
28
|
+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
29
|
+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
30
|
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
31
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
data/README.md
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
Uuidify
|
2
|
+
=======
|
3
|
+
|
4
|
+
Add UUIDs to existing ActiveRecord models.
|
5
|
+
|
6
|
+
To install:
|
7
|
+
|
8
|
+
rake uuidify:install:migrations
|
9
|
+
rake db:migrate
|
10
|
+
|
11
|
+
To enable on a specific model:
|
12
|
+
|
13
|
+
class Foo < ActiveRecord::Base
|
14
|
+
uuidify
|
15
|
+
end
|
16
|
+
|
17
|
+
To get/set uuids:
|
18
|
+
|
19
|
+
Foo.new.uuid
|
20
|
+
Foo.new.uuid = UUIDTools::UUID.timestamp_create
|
21
|
+
|
22
|
+
To gc orphan records:
|
23
|
+
|
24
|
+
Foo.garbage_collect_uuids # single model
|
25
|
+
Uuidify.garbage_collect_uuids # everything, even if the model doesn't exist in the source
|
data/Rakefile
ADDED
@@ -0,0 +1,44 @@
|
|
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 = 'Uuidify'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
20
|
+
rdoc.rdoc_files.include('app/**/*.rb')
|
21
|
+
rdoc.main = "lib/uuidify.rb"
|
22
|
+
end
|
23
|
+
|
24
|
+
|
25
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
26
|
+
load 'rails/tasks/engine.rake'
|
27
|
+
|
28
|
+
Bundler::GemHelper.install_tasks
|
29
|
+
|
30
|
+
require 'rspec/core'
|
31
|
+
require 'rspec/core/rake_task'
|
32
|
+
|
33
|
+
desc "Copy a usable database.yml file if we don't have one"
|
34
|
+
task :config_database_yml do
|
35
|
+
if !File.exists? "./spec/dummy/config/database.yml"
|
36
|
+
sh "cp ./spec/dummy/config/database.yml.sample ./spec/dummy/config/database.yml"
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
|
41
|
+
desc "Run all specs in spec directory (excluding plugin specs)"
|
42
|
+
RSpec::Core::RakeTask.new(:spec => [:config_database_yml, "app:db:drop", "app:db:create", "app:db:migrate"])
|
43
|
+
|
44
|
+
task :default => :spec
|
@@ -0,0 +1,18 @@
|
|
1
|
+
class CreateUuidifyUuids < ActiveRecord::Migration
|
2
|
+
def up
|
3
|
+
create_table :uuidify_uuids do |t|
|
4
|
+
t.string :model_name
|
5
|
+
t.integer :model_id
|
6
|
+
# t.string :model_uuid, :limit => 36
|
7
|
+
end
|
8
|
+
|
9
|
+
execute "ALTER TABLE uuidify_uuids ADD COLUMN model_uuid BINARY(16)"
|
10
|
+
add_index :uuidify_uuids, [:model_name, :model_id], :unique => true
|
11
|
+
add_index :uuidify_uuids, :model_uuid, :unique => true
|
12
|
+
add_index :uuidify_uuids, [:model_uuid, :model_id], :unique => true
|
13
|
+
end
|
14
|
+
|
15
|
+
def down
|
16
|
+
drop_table :uuidify_uuids
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,69 @@
|
|
1
|
+
require 'uuidtools'
|
2
|
+
require 'active_support/concern'
|
3
|
+
require_relative 'uuidify_exception'
|
4
|
+
|
5
|
+
# Mixin to add uuids to an active record model.
|
6
|
+
module Uuidify::UuidifyConcern
|
7
|
+
extend ActiveSupport::Concern
|
8
|
+
|
9
|
+
included do
|
10
|
+
before_destroy :destroy_uuid
|
11
|
+
end
|
12
|
+
|
13
|
+
module ClassMethods
|
14
|
+
# .find_by_uuid. Used lookup so we know it's not rails magic.
|
15
|
+
def lookup_uuid(uuid)
|
16
|
+
uuid = Uuidify::Uuid.where(:model_uuid => uuid.raw, :model_name => self.to_s).first
|
17
|
+
uuid ? find(uuid.model_id) : nil
|
18
|
+
end
|
19
|
+
|
20
|
+
# Delete entries where we don't have a model that can be instantiated anymore.
|
21
|
+
def garbage_collect_uuids
|
22
|
+
Uuidify::Uuid.where(:model_name => self.to_s).find_each do |uuid|
|
23
|
+
if !where(:id => uuid.model_id).first
|
24
|
+
uuid.destroy
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
# Return a UUID, creating it if needed.
|
31
|
+
def uuid
|
32
|
+
abort_if_unsaved!
|
33
|
+
|
34
|
+
model_name = self.class.to_s
|
35
|
+
model_id = self.id
|
36
|
+
|
37
|
+
uuid = Uuidify::Uuid.where(:model_name => model_name, :model_id => model_id).first
|
38
|
+
|
39
|
+
if uuid.nil?
|
40
|
+
new_uuid = UUIDTools::UUID.timestamp_create.raw
|
41
|
+
uuid = Uuidify::Uuid.create(:model_name => model_name, :model_id => self.id, :model_uuid => new_uuid)
|
42
|
+
uuid.save!
|
43
|
+
end
|
44
|
+
|
45
|
+
UUIDTools::UUID.parse_raw(uuid.model_uuid)
|
46
|
+
end
|
47
|
+
|
48
|
+
# Assign a UUID that came from an external source.
|
49
|
+
def uuid= new_uuid
|
50
|
+
abort_if_unsaved!
|
51
|
+
Uuidify::Uuid.where(:model_name => self.class.to_s, :model_id => self.id).first_or_create!.update_column(:model_uuid, new_uuid.raw)
|
52
|
+
end
|
53
|
+
|
54
|
+
private
|
55
|
+
|
56
|
+
def abort_if_unsaved!
|
57
|
+
if self.id.nil?
|
58
|
+
raise Uuidify::UuidifyException, "This model hasn't been persisted yet and Uuidify doesn't want to implicitly do that. Won't create uuid"
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
def destroy_uuid
|
63
|
+
model_name = self.class.to_s
|
64
|
+
model_id = self.id
|
65
|
+
uuid = Uuidify::Uuid.where(:model_name => model_name, :model_id => model_id).first
|
66
|
+
uuid.destroy if uuid
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
data/lib/uuidify.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
require 'uuidify/engine'
|
2
|
+
require 'uuidify/uuidify_concern'
|
3
|
+
|
4
|
+
# Helper like acts_as_X so we don't deal with the concern mixin directly.
|
5
|
+
def uuidify
|
6
|
+
include Uuidify::UuidifyConcern
|
7
|
+
end
|
8
|
+
|
9
|
+
module Uuidify
|
10
|
+
# Clean up all orphaned and useless UUIDs in the database, whether or not we can
|
11
|
+
# resolve them to a class.
|
12
|
+
def self.garbage_collect_uuids
|
13
|
+
Uuidify::Uuid.select("model_name").group("model_name").each do |m|
|
14
|
+
begin
|
15
|
+
klass = m.model_name.constantize
|
16
|
+
klass.garbage_collect_uuids
|
17
|
+
rescue NameError => ex # Class that doesn't exist in current project
|
18
|
+
Uuidify::Uuid.where(:model_name => m.model_name).delete_all
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
data/lib/uuidify.rb~
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# = Uuidify
|
2
|
+
#
|
3
|
+
# Add UUIDs to existing ActiveRecord models.
|
4
|
+
#
|
5
|
+
# To install:
|
6
|
+
#
|
7
|
+
# rake uuidify:install:migrations
|
8
|
+
# rake db:migrate
|
9
|
+
#
|
10
|
+
# To enable on a specific model:
|
11
|
+
#
|
12
|
+
# class Foo < ActiveRecord::Base
|
13
|
+
# uuidify
|
14
|
+
# end
|
15
|
+
#
|
16
|
+
# To get/set uuids:
|
17
|
+
#
|
18
|
+
# Foo.new.uuid
|
19
|
+
# Foo.new.uuid = UUIDTools::UUID.timestamp_create
|
20
|
+
#
|
21
|
+
# To gc orphan records:
|
22
|
+
#
|
23
|
+
# Foo.garbage_collect_uuids # single model
|
24
|
+
# Uuidify.garbage_collect_uuids # everything, even if the model doesn't exist in the source
|
25
|
+
require 'uuidify/engine'
|
26
|
+
require 'uuidify/uuidify_concern'
|
27
|
+
|
28
|
+
# Helper like acts_as_X so we don't deal with the concern mixin directly.
|
29
|
+
def uuidify
|
30
|
+
include Uuidify::UuidifyConcern
|
31
|
+
end
|
32
|
+
|
33
|
+
module Uuidify
|
34
|
+
# Clean up all orphaned and useless UUIDs in the database, whether or not we can
|
35
|
+
# resolve them to a class.
|
36
|
+
def self.garbage_collect_uuids
|
37
|
+
Uuidify::Uuid.select("model_name").group("model_name").each do |m|
|
38
|
+
begin
|
39
|
+
klass = m.model_name.constantize
|
40
|
+
klass.garbage_collect_uuids
|
41
|
+
rescue NameError => ex # Class that doesn't exist in current project
|
42
|
+
Uuidify::Uuid.where(:model_name => m.model_name).delete_all
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
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.
|
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
|
@@ -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 .
|
@@ -0,0 +1,13 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the top of the
|
9
|
+
* compiled file, but it's generally better to create a new file per style scope.
|
10
|
+
*
|
11
|
+
*= require_self
|
12
|
+
*= require_tree .
|
13
|
+
*/
|