smarter_dates 0.2.9 → 0.2.13

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.
Files changed (45) hide show
  1. data/.rspec +2 -0
  2. data/Gemfile +12 -1
  3. data/config/locales/en.yml +32 -0
  4. data/lib/generators/smarter_dates/install_generator.rb +2 -0
  5. data/lib/smarter_dates.rb +6 -1
  6. data/lib/smarter_dates/chronic_parsable_validator.rb +2 -6
  7. data/lib/smarter_dates/chronic_strings.rb +63 -0
  8. data/lib/smarter_dates/engine.rb +5 -0
  9. data/lib/smarter_dates/parser.rb +93 -34
  10. data/lib/smarter_dates/version.rb +1 -1
  11. data/smarter_dates.gemspec +38 -16
  12. data/spec/dummy/.gitignore +2 -0
  13. data/spec/dummy/.rspec +1 -0
  14. data/spec/dummy/README.rdoc +261 -0
  15. data/spec/dummy/Rakefile +7 -0
  16. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  17. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  18. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  19. data/spec/dummy/app/models/.gitkeep +0 -0
  20. data/spec/dummy/config.ru +4 -0
  21. data/spec/dummy/config/application.rb +64 -0
  22. data/spec/dummy/config/boot.rb +10 -0
  23. data/spec/dummy/config/database.yml +20 -0
  24. data/spec/dummy/config/environment.rb +5 -0
  25. data/spec/dummy/config/environments/development.rb +37 -0
  26. data/spec/dummy/config/environments/test.rb +37 -0
  27. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  28. data/spec/dummy/config/initializers/inflections.rb +15 -0
  29. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  30. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  31. data/spec/dummy/config/initializers/session_store.rb +8 -0
  32. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  33. data/spec/dummy/config/locales/en.yml +5 -0
  34. data/spec/dummy/config/routes.rb +3 -0
  35. data/spec/dummy/db/migrate/1_create_activities.rb +10 -0
  36. data/spec/dummy/db/schema.rb +23 -0
  37. data/spec/dummy/log/.gitkeep +0 -0
  38. data/spec/dummy/script/rails +6 -0
  39. data/spec/dummy/spec/support/.gitkeep +0 -0
  40. data/spec/models/smarter_dates/activity_spec.rb +71 -0
  41. data/spec/spec.opts +5 -0
  42. data/spec/spec_helper.rb +17 -0
  43. data/test/chronic_parsable_validator_test.rb +5 -7
  44. data/test/smarter_dates_test.rb +2 -2
  45. metadata +215 -23
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --format progress
data/Gemfile CHANGED
@@ -1,4 +1,15 @@
1
- source 'http://rubygems.org'
1
+ #source 'https://rubygems.org'
2
+ source 'http://bundler-api.herokuapp.com'
3
+
4
+ group :development, :test, :cucumber do
5
+ if RbConfig::CONFIG['RUBY_PROGRAM_VERSION'] == '1.9.3'
6
+ gem 'debugger'
7
+ elsif %w(1.9.0 1.9.1 1.9.2).include?(RbConfig::CONFIG['RUBY_PROGRAM_VERSION'])
8
+ gem 'ruby-debug19', require: 'ruby-debug'
9
+ else
10
+ gem 'ruby-debug'
11
+ end
12
+ end
2
13
 
3
14
  # Specify your gem's dependencies in smarter_dates.gemspec
4
15
  gemspec
@@ -0,0 +1,32 @@
1
+ # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
2
+
3
+ en:
4
+ date:
5
+ formats:
6
+ default: "%d %b %Y"
7
+ filesystem: "%Y%m%d"
8
+ humanized_date: "%d %b %Y"
9
+ mon_year: "%b %Y"
10
+ humanized_date: "%d %b %Y"
11
+ humanized_datetime12: "%d %b %Y"
12
+ humanized_datetime24: "%d %b %Y"
13
+
14
+ time:
15
+ formats:
16
+ default: "%a %d %b %Y %H:%M:%S %z"
17
+ filesystem: "%Y%m%d%H%M%S"
18
+ long: "%d %b %Y %H:%M"
19
+ mon_year: "%b %Y"
20
+ humanized_date: "%d %b %Y"
21
+ humanized_datetime12: "%d %b %Y %I:%M:%S%p"
22
+ humanized_datetime24: "%d %b %Y %H:%M:%S"
23
+
24
+ datetime:
25
+ formats:
26
+ default: "%d %b %Y %H:%M:%S"
27
+ filesystem: "%d%m%Y%H%M%S"
28
+ mon_year: "%b %Y"
29
+ humanized_date: "%d %b %Y"
30
+ humanized_datetime12: "%d %b %Y %I:%M:%S%p"
31
+ humanized_datetime24: "%d %b %Y %H:%M:%S"
32
+
@@ -1,4 +1,6 @@
1
+ # :nodoc:
1
2
  module SmarterDates
3
+ # copies configuration file for configuration.gem
2
4
  class InstallGenerator < Rails::Generators::Base
3
5
  source_root File.expand_path('../templates', __FILE__)
4
6
 
data/lib/smarter_dates.rb CHANGED
@@ -1,6 +1,11 @@
1
1
  require File.join('smarter_dates', 'version')
2
2
  require File.join('smarter_dates', 'parser')
3
+ require File.join('smarter_dates', 'chronic_strings')
3
4
  if defined? ActiveModel
4
5
  require File.join('smarter_dates', 'chronic_parsable_validator')
5
6
  end
6
-
7
+ if defined? ::Rails
8
+ if defined? ::Rails::Engine
9
+ require File.join('smarter_dates', 'engine')
10
+ end
11
+ end
@@ -22,9 +22,7 @@ class ChronicParsableValidator < ActiveModel::EachValidator
22
22
 
23
23
  def validate_each(record, attribute, value = "") #:nodoc:
24
24
  @value = value
25
- unless is_valid?
26
- record.errors[attribute] << 'not a valid Date or DateTime'
27
- end
25
+ record.errors[attribute] << 'not a valid Date or DateTime' unless is_valid?
28
26
  end
29
27
 
30
28
  # :call-seq:
@@ -42,9 +40,7 @@ class ChronicParsableValidator < ActiveModel::EachValidator
42
40
  # returns true if the string is parsable by chronic
43
41
 
44
42
  def is_valid_datetime?
45
- obj = Chronic.parse(@value.respond_to?(:to_date) ?
46
- @value.to_date : @value.to_s)
47
- !obj.nil?
43
+ Chronic.parse(@value.respond_to?(:to_date) ? @value.to_date : @value.to_s)
48
44
  end
49
45
 
50
46
  end
@@ -0,0 +1,63 @@
1
+ # provide natural-language date / datetime parsing to strings
2
+ class String
3
+ # :call-seq:
4
+ # to_chronic_datetime
5
+ #
6
+ # Parses a string into a DateTime object using the Chronic gem if available.
7
+ # If not, try parsing the string using :parse_with_builtins
8
+ # raise an error if the string fails to parse
9
+
10
+ def to_chronic_datetime
11
+ dt = defined?(Chronic) ? parse_with_chronic : parse_with_builtins
12
+ #raise RuntimeError, "#{dt.inspect} unparsable Date/DateTime" unless dt
13
+ return unless dt
14
+ dt.to_datetime
15
+ end
16
+
17
+ # :call-seq:
18
+ # to_chronic_date
19
+ #
20
+ # Parses a string into a Date object using the same methods as .to_chronic_datetime
21
+
22
+ def to_chronic_date
23
+ obj = to_chronic_datetime
24
+ obj && obj.to_date
25
+ end
26
+
27
+ # :call-seq:
28
+ # to_chronic_time
29
+ #
30
+ # Parses a string into a Time object using the same methods as .to_chronic_datetime
31
+
32
+ def to_chronic_time
33
+ obj = to_chronic_datetime
34
+ obj && obj.to_time
35
+ end
36
+
37
+ protected
38
+
39
+ # :call-seq:
40
+ # parse_with_chronic
41
+ #
42
+ # attempt to parse a string with Chronic
43
+
44
+ def parse_with_chronic
45
+ Chronic.time_class = Time.zone
46
+ Chronic.parse(self)
47
+ end
48
+
49
+ # :call-seq:
50
+ # parse_with_builtins
51
+ #
52
+ # attempt to parse a string with DateTime
53
+ # failing that, attempt to parse a string with Date
54
+
55
+ def parse_with_builtins
56
+ begin
57
+ return DateTime.parse(self)
58
+ rescue
59
+ return Date.parse(self)
60
+ end
61
+ end
62
+ end
63
+
@@ -0,0 +1,5 @@
1
+ module SmarterDates
2
+ # integrate smarter_dates with rails
3
+ class Engine < ::Rails::Engine
4
+ end
5
+ end
@@ -2,37 +2,22 @@ require 'smarter_dates/version'
2
2
  require 'chronic'
3
3
 
4
4
  module SmarterDates
5
- def self.included(klass) # :nodoc:
6
- attr_accessor :dt_attributes
5
+ def self.included(klass) # :nodoc:
6
+ bootstrap_smarter_dates(klass)
7
7
 
8
- @dt_attributes = []
9
- db_migrated = true
10
- if defined?(Rails)
11
- begin
12
- @dt_attributes.concat(klass.column_names.select { |k| k.match(/_(?:at|on|dt|d)$/) })
13
- Rails.logger.debug(RuntimeError, "unused include - #{klass.class.to_s} does not have any attributes ending in _at, _on, _dt, or _d") if db_migrated && @dt_attributes.empty?
14
- rescue ActiveRecord::StatementInvalid => _
15
- rescue => err
16
- Rails.logger.debug(err.inspect)
8
+ @dt_attributes.each do |meth|
9
+ klass.send(:define_method, "#{meth}=".to_sym, convert_to_dt(meth))
17
10
  end
18
- else
19
- @dt_attributes.concat(klass.instance_methods.select { |k| k.match(/_(?:at|on|dt|d)$/) })
20
11
  end
21
12
 
22
13
  # :call-seq:
23
- # _on(string)
24
- # _at(string)
25
- # _dt(string)
26
- # _d(string)
14
+ # Module.convert_to_dt method
27
15
  #
28
- # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
29
- # (for flexibility). Values are passed as is to Chronic.parse()
30
- #
31
- # == Arguments
32
- # <tt>string</tt>:: A string
16
+ # attempts to convert using Chronic, DateTime and-or Date, whichever works first
17
+ # else simply yield the value
33
18
 
34
- @dt_attributes.each do |k|
35
- parse = Proc.new do |val|
19
+ def self.convert_to_dt(convert_me)
20
+ Proc.new do |val|
36
21
  begin
37
22
  dt = Chronic.parse(val.to_s)
38
23
  rescue
@@ -43,19 +28,93 @@ def self.included(klass) # :nodoc:
43
28
  dt = val
44
29
  end
45
30
  if defined?(Rails)
46
- if dt && k.match(/_(?:on|d)$/)
47
- self[k] = dt.to_date
48
- elsif dt
49
- self[k] = dt.to_datetime
50
- else
51
- self[k] = dt
52
- end
31
+ set_rails_dt_attributes!(convert_me, dt)
53
32
  else
54
- instance_variable_set(:"@#{k}", dt)
33
+ instance_variable_set(:"@#{convert_me}", dt)
55
34
  end
56
35
  end
57
- klass.send(:define_method, "#{k}=".to_sym, &parse)
58
36
  end
59
- end
37
+
38
+ private
39
+
40
+ # :call-seq:
41
+ # Module.dt_attributes Klass
42
+ #
43
+ # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
44
+ # (for flexibility). Values are passed as is to Chronic.parse()
45
+ #
46
+ # == Arguments
47
+ # <tt>string</tt>:: A string
48
+
49
+ def self.dt_attributes(klass)
50
+ klass.instance_methods.select { |meth| meth.match(/_(?:at|on|dt|d)$/) }
51
+ end
52
+
53
+ def self.connected? # :nodoc:
54
+ ActiveRecord::Base.connected?
55
+ end
56
+
57
+ def self.migrated? # :nodoc:
58
+ return unless connected?
59
+ ActiveRecord::Base.connection.table_exists? 'schema'
60
+ end
61
+
62
+ # :call-seq:
63
+ # Module.rails_dt_attributes Klass
64
+ #
65
+ # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
66
+ # (for flexibility). Values are passed as is to Chronic.parse()
67
+ #
68
+ # == Arguments
69
+ # <tt>string</tt>:: A string
70
+
71
+ def self.rails_dt_attributes(klass)
72
+ dt_attrs = nil
73
+ logger = Rails.logger
74
+ begin
75
+ dt_attrs = klass.column_names.select { |meth| meth.match(/_(?:at|on|dt|d)$/) }
76
+ logger.debug(RuntimeError, "unused include - #{self.class.to_s} does not have any attributes ending in _at, _on, _dt, or _d") if migrated? && dt_attrs.empty?
77
+ rescue ActiveRecord::StatementInvalid => _
78
+ end
79
+ dt_attrs.uniq || []
80
+ end
81
+
82
+ # :call-seq:
83
+ # Module.set_rails_dt_attributes! attribute, value
84
+ #
85
+ # set attribute ending in _at, _on, _dt, or _d to date datetime
86
+ #
87
+ # == Arguments
88
+ # <tt>attribute</tt>:: attribute to set
89
+ # <tt>value</tt>:: a value
90
+
91
+ def set_rails_dt_attributes!(meth,dt)
92
+ if dt && meth.match(/_(?:on|d)$/)
93
+ write_attribute meth, dt.to_date
94
+ elsif dt && meth.match(/_(?:at|dt)$/)
95
+ write_attribute meth, dt.to_datetime
96
+ else
97
+ write_attribute meth, dt
98
+ end
99
+ end
100
+
101
+ # :call-seq:
102
+ # Module.bootstrap_smarter_dates class
103
+ #
104
+ # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
105
+ # (for flexibility). Values are passed as is to Chronic.parse()
106
+ #
107
+ # == Arguments
108
+ # <tt>class</tt>:: A class to have chronically-parsed dates
109
+
110
+ def self.bootstrap_smarter_dates(klass)
111
+ @dt_attributes = []
112
+ if defined?(Rails)
113
+ @dt_attributes.concat(rails_dt_attributes(klass))
114
+ else
115
+ @dt_attributes.concat(dt_attributes(klass))
116
+ end
117
+ end
118
+
60
119
  end
61
120
 
@@ -1,4 +1,4 @@
1
1
  module SmarterDates
2
- VERSION = '0.2.9'
2
+ VERSION = '0.2.13'
3
3
  end
4
4
 
@@ -2,11 +2,28 @@
2
2
  $:.push File.expand_path('../lib', __FILE__)
3
3
  require 'smarter_dates/version'
4
4
 
5
+ REQUIREMENTS = {
6
+ runtime: {
7
+ chronic: ['>= 0'] },
8
+ development: {
9
+ bundler: ['~> 1.3'],
10
+ rake: ['>= 0'],
11
+ sqlite3: ['>= 1.3.7'],
12
+ debugger: ['>= 1.5.0'],
13
+ rspec: ['>= 2.13.0'],
14
+ mocha: ['>= 0.13.0'],
15
+ database_cleaner: ['>= 0.9.1'],
16
+ machinist: ['>= 2.0.0'],
17
+ activerecord: ['~> 3.2.13'],
18
+ :'rspec-rails' => ['>= 2.12.0'] }
19
+ }
20
+
5
21
  Gem::Specification.new do |spec|
6
22
  spec.name = 'smarter_dates'
7
23
  spec.version = SmarterDates::VERSION
8
24
  spec.authors = ['Paul Belt']
9
25
  spec.email = %w(paul.belt@gmail.com)
26
+ spec.license = 'MIT'
10
27
  spec.homepage = 'http://github.com/belt/smarter_dates'
11
28
  spec.summary = %q{Natural language date processing}
12
29
  spec.description = %q{Humans want to think of date and datetime attributes in a natural manner. Standard ruby Date and DateTime objects do not support this well.}
@@ -14,25 +31,30 @@ Gem::Specification.new do |spec|
14
31
  spec.rubyforge_project = 'smarter_dates'
15
32
 
16
33
  spec.files = `git ls-files`.split("\n")
17
- spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
18
- spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
34
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
35
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
36
  spec.require_paths = %w(lib)
20
- spec.required_ruby_version = Gem::Requirement.new('>= 1.8.7')
37
+
38
+ spec.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
21
39
  spec.required_rubygems_version = Gem::Requirement.new('>= 0') if spec.respond_to? :required_rubygems_version=
22
40
 
23
- if spec.respond_to? :specification_version
24
- spec.specification_version = 3
25
- if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
26
- spec.add_runtime_dependency 'chronic', ['>= 0']
27
- spec.add_development_dependency 'bundler', ['~> 1.3']
28
- spec.add_development_dependency 'rake', ['>= 0']
29
- spec.add_development_dependency 'rails', ['>= 3.0']
30
- spec.add_development_dependency 'sqlite3', ['~> 1.3.5']
31
- else
32
- spec.add_dependency('chronic')
41
+ [:runtime, :development].each do |mode|
42
+ REQUIREMENTS[mode].each do |req,ver|
43
+ if spec.respond_to? :specification_version
44
+ spec.specification_version = 3
45
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
46
+ if mode == :runtime
47
+ spec.add_runtime_dependency req.to_s, ver
48
+ else
49
+ spec.add_development_dependency req.to_s, ver
50
+ end
51
+ else
52
+ spec.add_dependency req.to_s, ver
53
+ end
54
+ else
55
+ spec.add_dependency req.to_s, ver
56
+ end
33
57
  end
34
- else
35
- spec.add_dependency('chronic')
36
58
  end
37
- end
38
59
 
60
+ end
@@ -0,0 +1,2 @@
1
+ db/*.sqlite3
2
+ log/*.log
data/spec/dummy/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -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.