brazilian-documents-validations 0.0.3 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.md +29 -0
- data/lib/brazilian-documents-validations.rb +6 -11
- data/lib/brazilian-documents-validations/cpf.rb +9 -5
- data/lib/brazilian-documents-validations/version.rb +3 -7
- metadata +61 -129
- data/.gitignore +0 -4
- data/Gemfile +0 -5
- data/Rakefile +0 -2
- data/brazilian-documents-validations.gemspec +0 -23
- data/test-app/.gitignore +0 -4
- data/test-app/Gemfile +0 -9
- data/test-app/README +0 -256
- data/test-app/Rakefile +0 -7
- data/test-app/app/controllers/application_controller.rb +0 -3
- data/test-app/app/helpers/application_helper.rb +0 -2
- data/test-app/app/models/company.rb +0 -3
- data/test-app/app/models/person.rb +0 -3
- data/test-app/app/views/layouts/application.html.erb +0 -14
- data/test-app/config.ru +0 -4
- data/test-app/config/application.rb +0 -42
- data/test-app/config/boot.rb +0 -6
- data/test-app/config/database.yml +0 -22
- data/test-app/config/environment.rb +0 -5
- data/test-app/config/environments/development.rb +0 -26
- data/test-app/config/environments/production.rb +0 -49
- data/test-app/config/environments/test.rb +0 -35
- data/test-app/config/initializers/backtrace_silencers.rb +0 -7
- data/test-app/config/initializers/inflections.rb +0 -10
- data/test-app/config/initializers/mime_types.rb +0 -5
- data/test-app/config/initializers/secret_token.rb +0 -7
- data/test-app/config/initializers/session_store.rb +0 -8
- data/test-app/config/locales/en.yml +0 -5
- data/test-app/config/routes.rb +0 -58
- data/test-app/db/migrate/20110622120743_create_people.rb +0 -13
- data/test-app/db/migrate/20110622120752_create_companies.rb +0 -13
- data/test-app/db/schema.rb +0 -27
- data/test-app/db/seeds.rb +0 -7
- data/test-app/doc/README_FOR_APP +0 -2
- data/test-app/lib/tasks/.gitkeep +0 -0
- data/test-app/public/404.html +0 -26
- data/test-app/public/422.html +0 -26
- data/test-app/public/500.html +0 -26
- data/test-app/public/favicon.ico +0 -0
- data/test-app/public/images/rails.png +0 -0
- data/test-app/public/index.html +0 -239
- data/test-app/public/javascripts/application.js +0 -2
- data/test-app/public/javascripts/controls.js +0 -965
- data/test-app/public/javascripts/dragdrop.js +0 -974
- data/test-app/public/javascripts/effects.js +0 -1123
- data/test-app/public/javascripts/prototype.js +0 -6001
- data/test-app/public/javascripts/rails.js +0 -191
- data/test-app/public/robots.txt +0 -5
- data/test-app/public/stylesheets/.gitkeep +0 -0
- data/test-app/script/rails +0 -6
- data/test-app/test/fixtures/companies.yml +0 -7
- data/test-app/test/fixtures/people.yml +0 -7
- data/test-app/test/performance/browsing_test.rb +0 -9
- data/test-app/test/test_helper.rb +0 -13
- data/test-app/test/unit/company_test.rb +0 -16
- data/test-app/test/unit/person_test.rb +0 -16
- data/test-app/vendor/plugins/.gitkeep +0 -0
- data/test/cnpj_test.rb +0 -15
- data/test/cpf_test.rb +0 -37
- data/test/test_helper.rb +0 -13
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 101c8de41a43cb7c4fb6fa53cef7eeb9e9fa30da
|
4
|
+
data.tar.gz: e5307e4a9573dde8e6d15047c8822e17ba8b9eb6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 98e6b869e1059079bb2c19c5ea2a13b621efa5f60a17261748eb0a57275322c2cdfbbd4a4858ac28808d8019d506f069084fb9673e01e217091b161c2b1881d6
|
7
|
+
data.tar.gz: 3cab40a2ffe748d362317bb12c703ffdbc7d904e49a9c0e712b42561aab9be3b0ae2218a4f1a7b3ca295a80838bef4238d19cae02eb2cefcebcd7e8f4dcd3ff4
|
data/README.md
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
[![Build Status](https://travis-ci.org/joaomilho/brazilian-documents-validations.png?branch=master)](https://travis-ci.org/joaomilho/brazilian-documents-validations.)
|
2
|
+
|
3
|
+
[![Code climate](https://codeclimate.com/github/joaomilho/brazilian-documents-validations..png)](https://codeclimate.com/github/joaomilho/brazilian-documents-validations.)
|
4
|
+
|
5
|
+
## Brazilian Documents Validations
|
6
|
+
|
7
|
+
Validates brazilian documents (CPF and CNPJ).
|
8
|
+
|
9
|
+
## Usage
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
|
13
|
+
class Company < ActiveRecord::Base
|
14
|
+
validates :cnpj, cnpj: true
|
15
|
+
end
|
16
|
+
|
17
|
+
class Person < ActiveRecord::Base
|
18
|
+
validates :cpf, cpf: true
|
19
|
+
end
|
20
|
+
|
21
|
+
```
|
22
|
+
|
23
|
+
## License
|
24
|
+
|
25
|
+
This project is released under the MIT license.
|
26
|
+
|
27
|
+
## Author
|
28
|
+
|
29
|
+
[Maiz Lulkin] (https://github.com/joaomilho)
|
@@ -1,11 +1,6 @@
|
|
1
|
-
require '
|
2
|
-
|
3
|
-
require
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
require "brazilian-documents-validations/cpf_validator"
|
8
|
-
require "brazilian-documents-validations/cnpj_validator"
|
9
|
-
end
|
10
|
-
end
|
11
|
-
end
|
1
|
+
require 'active_model'
|
2
|
+
|
3
|
+
require 'brazilian-documents-validations/cpf'
|
4
|
+
require 'brazilian-documents-validations/cnpj'
|
5
|
+
require 'brazilian-documents-validations/cpf_validator'
|
6
|
+
require 'brazilian-documents-validations/cnpj_validator'
|
@@ -1,9 +1,13 @@
|
|
1
1
|
module CPF
|
2
2
|
|
3
|
-
BLACK_LIST = (0..9).map{|i| i.to_s * 11 } << '12345678909'
|
3
|
+
BLACK_LIST = (0..9).map{|i| i.to_s * 11 } << '12345678909'
|
4
4
|
|
5
|
-
def self.mock
|
6
|
-
|
5
|
+
def self.mock size=1
|
6
|
+
size == 1 ? generate : size.times.map{ generate }
|
7
|
+
end
|
8
|
+
|
9
|
+
def self.generate
|
10
|
+
ns = Array.new(9){ rand(9) }
|
7
11
|
rec = 10
|
8
12
|
d1 = ns.inject(0){|s,i| s = s + i*rec; rec -= 1; s }
|
9
13
|
|
@@ -14,7 +18,7 @@ module CPF
|
|
14
18
|
d2 = 11 - ( d2 % 11 )
|
15
19
|
d2 = 0 if d2 >= 10
|
16
20
|
ns << d1 << d2
|
17
|
-
ns.join
|
21
|
+
ns.join
|
18
22
|
end
|
19
23
|
|
20
24
|
def self.valid?(cpf)
|
@@ -55,4 +59,4 @@ module CPF
|
|
55
59
|
def self.invalid?(cpf)
|
56
60
|
!valid?(cpf)
|
57
61
|
end
|
58
|
-
end
|
62
|
+
end
|
metadata
CHANGED
@@ -1,149 +1,81 @@
|
|
1
|
-
--- !ruby/object:Gem::Specification
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
2
|
name: brazilian-documents-validations
|
3
|
-
version: !ruby/object:Gem::Version
|
4
|
-
|
5
|
-
prerelease: false
|
6
|
-
segments:
|
7
|
-
- 0
|
8
|
-
- 0
|
9
|
-
- 3
|
10
|
-
version: 0.0.3
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
11
5
|
platform: ruby
|
12
|
-
authors:
|
13
|
-
-
|
6
|
+
authors:
|
7
|
+
- Maiz Lulkin
|
14
8
|
autorequire:
|
15
9
|
bindir: bin
|
16
10
|
cert_chain: []
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
requirements:
|
27
|
-
- - "="
|
28
|
-
- !ruby/object:Gem::Version
|
29
|
-
hash: 9
|
30
|
-
segments:
|
31
|
-
- 3
|
32
|
-
- 0
|
33
|
-
- 7
|
34
|
-
version: 3.0.7
|
11
|
+
date: 2013-09-25 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activemodel
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '>='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
35
20
|
type: :runtime
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
-
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '>='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
description: Validations for CPF and CNPJ
|
42
|
+
email:
|
43
|
+
- maiz@lulk.in
|
40
44
|
executables: []
|
41
|
-
|
42
45
|
extensions: []
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
- .gitignore
|
48
|
-
- Gemfile
|
49
|
-
- Rakefile
|
50
|
-
- brazilian-documents-validations.gemspec
|
46
|
+
extra_rdoc_files:
|
47
|
+
- README.md
|
48
|
+
files:
|
49
|
+
- README.md
|
51
50
|
- lib/brazilian-documents-validations.rb
|
52
51
|
- lib/brazilian-documents-validations/cnpj.rb
|
53
52
|
- lib/brazilian-documents-validations/cnpj_validator.rb
|
54
53
|
- lib/brazilian-documents-validations/cpf.rb
|
55
54
|
- lib/brazilian-documents-validations/cpf_validator.rb
|
56
55
|
- lib/brazilian-documents-validations/version.rb
|
57
|
-
|
58
|
-
- test-app/Gemfile
|
59
|
-
- test-app/README
|
60
|
-
- test-app/Rakefile
|
61
|
-
- test-app/app/controllers/application_controller.rb
|
62
|
-
- test-app/app/helpers/application_helper.rb
|
63
|
-
- test-app/app/models/company.rb
|
64
|
-
- test-app/app/models/person.rb
|
65
|
-
- test-app/app/views/layouts/application.html.erb
|
66
|
-
- test-app/config.ru
|
67
|
-
- test-app/config/application.rb
|
68
|
-
- test-app/config/boot.rb
|
69
|
-
- test-app/config/database.yml
|
70
|
-
- test-app/config/environment.rb
|
71
|
-
- test-app/config/environments/development.rb
|
72
|
-
- test-app/config/environments/production.rb
|
73
|
-
- test-app/config/environments/test.rb
|
74
|
-
- test-app/config/initializers/backtrace_silencers.rb
|
75
|
-
- test-app/config/initializers/inflections.rb
|
76
|
-
- test-app/config/initializers/mime_types.rb
|
77
|
-
- test-app/config/initializers/secret_token.rb
|
78
|
-
- test-app/config/initializers/session_store.rb
|
79
|
-
- test-app/config/locales/en.yml
|
80
|
-
- test-app/config/routes.rb
|
81
|
-
- test-app/db/migrate/20110622120743_create_people.rb
|
82
|
-
- test-app/db/migrate/20110622120752_create_companies.rb
|
83
|
-
- test-app/db/schema.rb
|
84
|
-
- test-app/db/seeds.rb
|
85
|
-
- test-app/doc/README_FOR_APP
|
86
|
-
- test-app/lib/tasks/.gitkeep
|
87
|
-
- test-app/public/404.html
|
88
|
-
- test-app/public/422.html
|
89
|
-
- test-app/public/500.html
|
90
|
-
- test-app/public/favicon.ico
|
91
|
-
- test-app/public/images/rails.png
|
92
|
-
- test-app/public/index.html
|
93
|
-
- test-app/public/javascripts/application.js
|
94
|
-
- test-app/public/javascripts/controls.js
|
95
|
-
- test-app/public/javascripts/dragdrop.js
|
96
|
-
- test-app/public/javascripts/effects.js
|
97
|
-
- test-app/public/javascripts/prototype.js
|
98
|
-
- test-app/public/javascripts/rails.js
|
99
|
-
- test-app/public/robots.txt
|
100
|
-
- test-app/public/stylesheets/.gitkeep
|
101
|
-
- test-app/script/rails
|
102
|
-
- test-app/test/fixtures/companies.yml
|
103
|
-
- test-app/test/fixtures/people.yml
|
104
|
-
- test-app/test/performance/browsing_test.rb
|
105
|
-
- test-app/test/test_helper.rb
|
106
|
-
- test-app/test/unit/company_test.rb
|
107
|
-
- test-app/test/unit/person_test.rb
|
108
|
-
- test-app/vendor/plugins/.gitkeep
|
109
|
-
- test/cnpj_test.rb
|
110
|
-
- test/cpf_test.rb
|
111
|
-
- test/test_helper.rb
|
112
|
-
has_rdoc: true
|
113
|
-
homepage: ""
|
56
|
+
homepage: https://github.com/joaomilho/brazilian-documents-validations
|
114
57
|
licenses: []
|
115
|
-
|
58
|
+
metadata: {}
|
116
59
|
post_install_message:
|
117
|
-
rdoc_options:
|
118
|
-
|
119
|
-
require_paths:
|
60
|
+
rdoc_options:
|
61
|
+
- --charset=UTF-8
|
62
|
+
require_paths:
|
120
63
|
- lib
|
121
|
-
required_ruby_version: !ruby/object:Gem::Requirement
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
none: false
|
132
|
-
requirements:
|
133
|
-
- - ">="
|
134
|
-
- !ruby/object:Gem::Version
|
135
|
-
hash: 3
|
136
|
-
segments:
|
137
|
-
- 0
|
138
|
-
version: "0"
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - '>='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
70
|
+
requirements:
|
71
|
+
- - '>='
|
72
|
+
- !ruby/object:Gem::Version
|
73
|
+
version: '0'
|
139
74
|
requirements: []
|
140
|
-
|
141
|
-
|
142
|
-
rubygems_version: 1.3.7
|
75
|
+
rubyforge_project:
|
76
|
+
rubygems_version: 2.0.6
|
143
77
|
signing_key:
|
144
|
-
specification_version:
|
78
|
+
specification_version: 4
|
145
79
|
summary: Brazilian Documents Validations
|
146
|
-
test_files:
|
147
|
-
|
148
|
-
- test/cpf_test.rb
|
149
|
-
- test/test_helper.rb
|
80
|
+
test_files: []
|
81
|
+
has_rdoc:
|
data/.gitignore
DELETED
data/Gemfile
DELETED
data/Rakefile
DELETED
@@ -1,23 +0,0 @@
|
|
1
|
-
# -*- encoding: utf-8 -*-
|
2
|
-
$:.push File.expand_path("../lib", __FILE__)
|
3
|
-
require "brazilian-documents-validations/version"
|
4
|
-
|
5
|
-
Gem::Specification.new do |s|
|
6
|
-
s.name = "brazilian-documents-validations"
|
7
|
-
s.version = Brazilian::Documents::Validations::VERSION
|
8
|
-
s.platform = Gem::Platform::RUBY
|
9
|
-
s.authors = ["Juan Maiz @joaomilho"]
|
10
|
-
s.email = ["juanmaiz@gmail.com"]
|
11
|
-
s.homepage = ""
|
12
|
-
s.summary = %q{Brazilian Documents Validations}
|
13
|
-
s.description = %q{CPF & CNPJ...}
|
14
|
-
s.add_dependency('rails','3.0.7')
|
15
|
-
# s.add_dependency('rails','3.0.7')
|
16
|
-
|
17
|
-
s.rubyforge_project = "brazilian-documents-validations"
|
18
|
-
|
19
|
-
s.files = `git ls-files`.split("\n")
|
20
|
-
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
21
|
-
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
22
|
-
s.require_paths = ["lib"]
|
23
|
-
end
|
data/test-app/.gitignore
DELETED
data/test-app/Gemfile
DELETED
data/test-app/README
DELETED
@@ -1,256 +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.find(: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.com/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
|
-
| |-- controllers
|
160
|
-
| |-- helpers
|
161
|
-
| |-- mailers
|
162
|
-
| |-- models
|
163
|
-
| `-- views
|
164
|
-
| `-- layouts
|
165
|
-
|-- config
|
166
|
-
| |-- environments
|
167
|
-
| |-- initializers
|
168
|
-
| `-- locales
|
169
|
-
|-- db
|
170
|
-
|-- doc
|
171
|
-
|-- lib
|
172
|
-
| `-- tasks
|
173
|
-
|-- log
|
174
|
-
|-- public
|
175
|
-
| |-- images
|
176
|
-
| |-- javascripts
|
177
|
-
| `-- stylesheets
|
178
|
-
|-- script
|
179
|
-
|-- test
|
180
|
-
| |-- fixtures
|
181
|
-
| |-- functional
|
182
|
-
| |-- integration
|
183
|
-
| |-- performance
|
184
|
-
| `-- unit
|
185
|
-
|-- tmp
|
186
|
-
| |-- cache
|
187
|
-
| |-- pids
|
188
|
-
| |-- sessions
|
189
|
-
| `-- sockets
|
190
|
-
`-- vendor
|
191
|
-
`-- plugins
|
192
|
-
|
193
|
-
app
|
194
|
-
Holds all the code that's specific to this particular application.
|
195
|
-
|
196
|
-
app/controllers
|
197
|
-
Holds controllers that should be named like weblogs_controller.rb for
|
198
|
-
automated URL mapping. All controllers should descend from
|
199
|
-
ApplicationController which itself descends from ActionController::Base.
|
200
|
-
|
201
|
-
app/models
|
202
|
-
Holds models that should be named like post.rb. Models descend from
|
203
|
-
ActiveRecord::Base by default.
|
204
|
-
|
205
|
-
app/views
|
206
|
-
Holds the template files for the view that should be named like
|
207
|
-
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
208
|
-
eRuby syntax by default.
|
209
|
-
|
210
|
-
app/views/layouts
|
211
|
-
Holds the template files for layouts to be used with views. This models the
|
212
|
-
common header/footer method of wrapping views. In your views, define a layout
|
213
|
-
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
214
|
-
Inside default.html.erb, call <% yield %> to render the view using this
|
215
|
-
layout.
|
216
|
-
|
217
|
-
app/helpers
|
218
|
-
Holds view helpers that should be named like weblogs_helper.rb. These are
|
219
|
-
generated for you automatically when using generators for controllers.
|
220
|
-
Helpers can be used to wrap functionality for your views into methods.
|
221
|
-
|
222
|
-
config
|
223
|
-
Configuration files for the Rails environment, the routing map, the database,
|
224
|
-
and other dependencies.
|
225
|
-
|
226
|
-
db
|
227
|
-
Contains the database schema in schema.rb. db/migrate contains all the
|
228
|
-
sequence of Migrations for your schema.
|
229
|
-
|
230
|
-
doc
|
231
|
-
This directory is where your application documentation will be stored when
|
232
|
-
generated using <tt>rake doc:app</tt>
|
233
|
-
|
234
|
-
lib
|
235
|
-
Application specific libraries. Basically, any kind of custom code that
|
236
|
-
doesn't belong under controllers, models, or helpers. This directory is in
|
237
|
-
the load path.
|
238
|
-
|
239
|
-
public
|
240
|
-
The directory available for the web server. Contains subdirectories for
|
241
|
-
images, stylesheets, and javascripts. Also contains the dispatchers and the
|
242
|
-
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
243
|
-
server.
|
244
|
-
|
245
|
-
script
|
246
|
-
Helper scripts for automation and generation.
|
247
|
-
|
248
|
-
test
|
249
|
-
Unit and functional tests along with fixtures. When using the rails generate
|
250
|
-
command, template test files will be generated for you and placed in this
|
251
|
-
directory.
|
252
|
-
|
253
|
-
vendor
|
254
|
-
External libraries that the application depends on. Also includes the plugins
|
255
|
-
subdirectory. If the app has frozen rails, those gems also go here, under
|
256
|
-
vendor/rails/. This directory is in the load path.
|