acts_as_nested_interval 0.1.1 → 0.2.0.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/lib/acts_as_nested_interval.rb +42 -41
  3. data/lib/acts_as_nested_interval/callbacks.rb +42 -0
  4. data/lib/acts_as_nested_interval/class_methods.rb +2 -2
  5. data/lib/acts_as_nested_interval/instance_methods.rb +13 -33
  6. data/lib/acts_as_nested_interval/version.rb +1 -1
  7. data/test/dummy/README.rdoc +15 -248
  8. data/test/dummy/Rakefile +1 -2
  9. data/test/dummy/app/assets/javascripts/application.js +3 -5
  10. data/test/dummy/app/assets/stylesheets/application.css +6 -4
  11. data/test/dummy/app/controllers/application_controller.rb +3 -1
  12. data/test/dummy/app/models/region.rb +2 -0
  13. data/test/dummy/app/views/layouts/application.html.erb +2 -2
  14. data/test/dummy/bin/bundle +3 -0
  15. data/test/dummy/bin/rails +4 -0
  16. data/test/dummy/bin/rake +4 -0
  17. data/test/dummy/config.ru +1 -1
  18. data/test/dummy/config/application.rb +1 -34
  19. data/test/dummy/config/boot.rb +4 -9
  20. data/test/dummy/config/database.yml +1 -1
  21. data/test/dummy/config/environment.rb +3 -3
  22. data/test/dummy/config/environments/development.rb +19 -19
  23. data/test/dummy/config/environments/production.rb +44 -28
  24. data/test/dummy/config/environments/test.rb +17 -15
  25. data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
  26. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  27. data/test/dummy/config/initializers/inflections.rb +6 -5
  28. data/test/dummy/config/initializers/mime_types.rb +0 -1
  29. data/test/dummy/config/initializers/session_store.rb +1 -6
  30. data/test/dummy/config/initializers/wrap_parameters.rb +6 -6
  31. data/test/dummy/config/locales/en.yml +20 -2
  32. data/test/dummy/config/routes.rb +23 -25
  33. data/test/dummy/config/secrets.yml +22 -0
  34. data/test/dummy/db/schema.rb +14 -11
  35. data/test/dummy/log/development.log +17 -0
  36. data/test/dummy/log/test.log +2833 -0
  37. data/test/dummy/public/404.html +54 -13
  38. data/test/dummy/public/422.html +54 -13
  39. data/test/dummy/public/500.html +53 -12
  40. data/test/dummy_bak/Gemfile +4 -0
  41. data/test/dummy_bak/Gemfile.lock +92 -0
  42. data/test/dummy_bak/README.rdoc +261 -0
  43. data/test/dummy_bak/Rakefile +7 -0
  44. data/test/dummy_bak/app/assets/javascripts/application.js +15 -0
  45. data/test/dummy_bak/app/assets/stylesheets/application.css +13 -0
  46. data/test/dummy_bak/app/controllers/application_controller.rb +3 -0
  47. data/test/dummy_bak/app/helpers/application_helper.rb +2 -0
  48. data/test/dummy_bak/app/models/region.rb +5 -0
  49. data/test/dummy_bak/app/views/layouts/application.html.erb +14 -0
  50. data/test/dummy_bak/bin/bundle +3 -0
  51. data/test/dummy_bak/bin/rails +4 -0
  52. data/test/dummy_bak/bin/rake +4 -0
  53. data/test/dummy_bak/config.ru +4 -0
  54. data/test/dummy_bak/config/application.rb +23 -0
  55. data/test/dummy_bak/config/boot.rb +4 -0
  56. data/test/dummy_bak/config/database.yml +31 -0
  57. data/test/dummy_bak/config/environment.rb +5 -0
  58. data/test/dummy_bak/config/environments/development.rb +37 -0
  59. data/test/dummy_bak/config/environments/production.rb +83 -0
  60. data/test/dummy_bak/config/environments/test.rb +39 -0
  61. data/test/dummy_bak/config/initializers/backtrace_silencers.rb +7 -0
  62. data/test/dummy_bak/config/initializers/cookies_serializer.rb +3 -0
  63. data/test/dummy_bak/config/initializers/filter_parameter_logging.rb +4 -0
  64. data/test/dummy_bak/config/initializers/inflections.rb +16 -0
  65. data/test/dummy_bak/config/initializers/mime_types.rb +4 -0
  66. data/test/{dummy → dummy_bak}/config/initializers/secret_token.rb +0 -0
  67. data/test/dummy_bak/config/initializers/session_store.rb +3 -0
  68. data/test/dummy_bak/config/initializers/wrap_parameters.rb +14 -0
  69. data/test/dummy_bak/config/locales/en.yml +23 -0
  70. data/test/dummy_bak/config/routes.rb +56 -0
  71. data/test/dummy_bak/config/secrets.yml +22 -0
  72. data/test/dummy_bak/db/development.sqlite3 +0 -0
  73. data/test/dummy_bak/db/migrate/20120302143528_create_regions.rb +15 -0
  74. data/test/dummy_bak/db/migrate/20121004204252_change_interval_precision.rb +6 -0
  75. data/test/dummy_bak/db/schema.rb +28 -0
  76. data/test/dummy_bak/log/development.log +229 -0
  77. data/test/dummy_bak/log/test.log +0 -0
  78. data/test/dummy_bak/public/404.html +26 -0
  79. data/test/dummy_bak/public/422.html +26 -0
  80. data/test/dummy_bak/public/500.html +25 -0
  81. data/test/dummy_bak/public/favicon.ico +0 -0
  82. data/test/{dummy → dummy_bak}/script/rails +0 -0
  83. data/test/{dummy → dummy_bak}/test/fixtures/regions.yml +0 -0
  84. data/test/{dummy → dummy_bak}/test/unit/region_test.rb +0 -0
  85. data/test/test_helper.rb +5 -0
  86. metadata +112 -55
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 81cfddc984871f10b119eb476a7e8a36a8f7ab33
4
- data.tar.gz: 0a9723da4673631ba6b4fcd1e78fa2b0948c2b8a
3
+ metadata.gz: 7ca996b586ce5012168cde429320be3243c3d709
4
+ data.tar.gz: f8b4566aa2f030c896d1675ec0bad92eb717eeee
5
5
  SHA512:
6
- metadata.gz: 433a11bb304a05b91948bb0f141fd48bd0d4015fb44f2475002f56d4a1effa4e8d7508f4b979eabddd674f859c9fd40ee8c4ac0fd386153b59522380bebb9914
7
- data.tar.gz: 6c9a2a6025120e23f451228eedba0b7b72008d759409b433bbb822d21d7d3490fd275c99afd4f1aee643e626e8c228112697352eb5b6605458cf624604eab653
6
+ metadata.gz: 1bda1e75d4f062d0220336ea18320b826f5b789e5db7f496fa3e9541bf35287919510fd170cfabbd1db4e4910e49d155319329027991699fe697313da078c4cb
7
+ data.tar.gz: 60ddeeecca41bb1f7b549f0d62e23a24e9aa832e8ad3870843b204cccf5bb14e6c6e2919a0393ff8709b0cb49e26c031df4e7bb2575aa6ec77e2a76ebf3c5dc2
@@ -6,6 +6,7 @@
6
6
 
7
7
  require 'acts_as_nested_interval/core_ext/integer'
8
8
  require 'acts_as_nested_interval/version'
9
+ require 'acts_as_nested_interval/callbacks'
9
10
  require 'acts_as_nested_interval/instance_methods'
10
11
  require 'acts_as_nested_interval/class_methods'
11
12
 
@@ -13,50 +14,50 @@ require 'acts_as_nested_interval/class_methods'
13
14
  # or all ancestors with just one select query. You can insert and delete
14
15
  # records without a full table update.
15
16
  module ActsAsNestedInterval
17
+ extend ActiveSupport::Concern
16
18
 
17
- # The +options+ hash can include:
18
- # * <tt>:foreign_key</tt> -- the self-reference foreign key column name (default :parent_id).
19
- # * <tt>:scope_columns</tt> -- an array of columns to scope independent trees.
20
- # * <tt>:lft_index</tt> -- whether to use functional index for lft (default false).
21
- # * <tt>:virtual_root</tt> -- whether to compute root's interval as in an upper root (default false)
22
- # * <tt>:dependent</tt> -- dependency between the parent node and children nodes (default :restrict)
23
- def acts_as_nested_interval(options = {})
24
- cattr_accessor :nested_interval_foreign_key
25
- cattr_accessor :nested_interval_scope_columns
26
- cattr_accessor :nested_interval_lft_index
27
- cattr_accessor :nested_interval_dependent
28
-
29
- cattr_accessor :virtual_root
30
- self.virtual_root = !!options[:virtual_root]
31
-
32
- self.nested_interval_foreign_key = options[:foreign_key] || :parent_id
33
- self.nested_interval_scope_columns = Array(options[:scope_columns])
34
- self.nested_interval_lft_index = options[:lft_index]
35
- self.nested_interval_dependent = options[:dependent] || :restrict
36
-
37
- belongs_to :parent, class_name: name, foreign_key: nested_interval_foreign_key
38
- has_many :children, class_name: name, foreign_key: nested_interval_foreign_key,
39
- dependent: nested_interval_dependent
40
- scope :roots, -> { where(nested_interval_foreign_key => nil) }
41
-
42
- if self.table_exists? # Fix problem with migrating without table
43
- if columns_hash["rgt"]
44
- scope :preorder, -> { order('rgt DESC, lftp ASC') }
45
- elsif columns_hash["rgtp"] && columns_hash["rgtq"]
46
- scope :preorder, -> { order('1.0 * rgtp / rgtq DESC, lftp ASC') }
47
- else
48
- scope :preorder, -> { order('nested_interval_rgt(lftp, lftq) DESC, lftp ASC') }
49
- end
19
+ module ClassMethods
20
+
21
+ # The +options+ hash can include:
22
+ # * <tt>:foreign_key</tt> -- the self-reference foreign key column name (default :parent_id).
23
+ # * <tt>:scope_columns</tt> -- an array of columns to scope independent trees.
24
+ # * <tt>:lft_index</tt> -- whether to use functional index for lft (default false).
25
+ # * <tt>:virtual_root</tt> -- whether to compute root's interval as in an upper root (default false)
26
+ # * <tt>:dependent</tt> -- dependency between the parent node and children nodes (default :restrict)
27
+ def acts_as_nested_interval(options = {})
28
+ cattr_accessor :nested_interval_foreign_key
29
+ cattr_accessor :nested_interval_scope_columns
30
+ cattr_accessor :nested_interval_lft_index
31
+ cattr_accessor :nested_interval_dependent
32
+
33
+ cattr_accessor :virtual_root
34
+ self.virtual_root = !!options[:virtual_root]
35
+
36
+ self.nested_interval_foreign_key = options[:foreign_key] || :parent_id
37
+ self.nested_interval_scope_columns = Array(options[:scope_columns])
38
+ self.nested_interval_lft_index = options[:lft_index]
39
+ self.nested_interval_dependent = options[:dependent] || :restrict_with_exception
50
40
 
51
- before_create :create_nested_interval
52
- before_destroy :destroy_nested_interval
53
- before_update :update_nested_interval
54
-
55
- include ActsAsNestedInterval::InstanceMethods
56
- extend ActsAsNestedInterval::ClassMethods
41
+ belongs_to :parent, class_name: name, foreign_key: nested_interval_foreign_key
42
+ has_many :children, class_name: name, foreign_key: nested_interval_foreign_key,
43
+ dependent: nested_interval_dependent
44
+ scope :roots, -> { where(nested_interval_foreign_key => nil) }
45
+
46
+ if self.table_exists? # Fix problem with migrating without table
47
+ if columns_hash["rgt"]
48
+ scope :preorder, -> { order('rgt DESC, lftp ASC') }
49
+ elsif columns_hash["rgtp"] && columns_hash["rgtq"]
50
+ scope :preorder, -> { order('1.0 * rgtp / rgtq DESC, lftp ASC') }
51
+ else
52
+ scope :preorder, -> { order('nested_interval_rgt(lftp, lftq) DESC, lftp ASC') }
53
+ end
54
+
55
+ include ActsAsNestedInterval::InstanceMethods
56
+ include ActsAsNestedInterval::Callbacks
57
+ extend ActsAsNestedInterval::ClassMethods
58
+ end
57
59
  end
58
60
  end
59
-
60
61
  end
61
62
 
62
- ActiveRecord::Base.send :extend, ActsAsNestedInterval
63
+ #ActiveRecord::Base.send :extend, ActsAsNestedInterval
@@ -0,0 +1,42 @@
1
+ module ActsAsNestedInterval
2
+ module Callbacks
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+
7
+ before_create :create_nested_interval
8
+ before_destroy :destroy_nested_interval
9
+ before_update :update_nested_interval
10
+
11
+ end
12
+
13
+ # Destroys record.
14
+ def destroy_nested_interval
15
+ lock! rescue nil
16
+ end
17
+
18
+ # Creates record.
19
+ def create_nested_interval
20
+ if read_attribute(nested_interval_foreign_key).nil?
21
+ set_nested_interval_for_top
22
+ else
23
+ set_nested_interval *parent.lock!.next_child_lft
24
+ end
25
+ end
26
+
27
+ # Updates record, updating descendants if parent association updated,
28
+ # in which case caller should first acquire table lock.
29
+ def update_nested_interval
30
+ changed = send(:"#{nested_interval_foreign_key}_changed?")
31
+ if !changed
32
+ db_self = self.class.find(id, :lock => true)
33
+ write_attribute(nested_interval_foreign_key, db_self.read_attribute(nested_interval_foreign_key))
34
+ set_nested_interval db_self.lftp, db_self.lftq
35
+ else
36
+ # No locking in this case -- caller should have acquired table lock.
37
+ update_nested_interval_move
38
+ end
39
+ end
40
+
41
+ end
42
+ end
@@ -6,7 +6,7 @@ module ActsAsNestedInterval
6
6
  # temporary changes
7
7
  skip_callback :update, :before, :update_nested_interval
8
8
  old_default_scopes = default_scopes # save to revert later
9
- default_scope where("#{quoted_table_name}.lftq > 0") # use lft1 > 0 as a "migrated?" flag
9
+ default_scope ->{ where("#{quoted_table_name}.lftq > 0") } # use lft1 > 0 as a "migrated?" flag
10
10
 
11
11
  # zero all intervals
12
12
  update_hash = {lftp: 0, lftq: 0}
@@ -31,4 +31,4 @@ module ActsAsNestedInterval
31
31
  end
32
32
 
33
33
  end
34
- end
34
+ end
@@ -5,14 +5,17 @@ module ActsAsNestedInterval
5
5
  # selectively define #descendants according to table features
6
6
  included do
7
7
 
8
+ #alias_method :parent_changed?, :"#{ nested_interval_foreign_key }_changed?"
9
+
8
10
  if columns_hash["lft"]
9
-
11
+
10
12
  def descendants
11
- quoted_table_name = self.class.quoted_table_name
12
- nested_interval_scope.where <<-SQL
13
+ #quoted_table_name = self.class.quoted_table_name
14
+ #nested_interval_scope.where <<-SQL
13
15
  #{lftp} < #{quoted_table_name}.lftp AND
14
16
  #{quoted_table_name}.lft BETWEEN #{1.0 * lftp / lftq} AND #{1.0 * rgtp / rgtq}
15
- SQL
17
+ #SQL
18
+ nested_interval_scope.where( "lftp > :lftp AND lft BETWEEN :lft AND :rgt", lftp: lftp, rgt: rgt, lft: lft )
16
19
  end
17
20
 
18
21
  elsif nested_interval_lft_index
@@ -75,20 +78,6 @@ module ActsAsNestedInterval
75
78
  end
76
79
  end
77
80
 
78
- # Creates record.
79
- def create_nested_interval
80
- if read_attribute(nested_interval_foreign_key).nil?
81
- set_nested_interval_for_top
82
- else
83
- set_nested_interval *parent.lock!.next_child_lft
84
- end
85
- end
86
-
87
- # Destroys record.
88
- def destroy_nested_interval
89
- lock! rescue nil
90
- end
91
-
92
81
  def nested_interval_scope
93
82
  conditions = {}
94
83
  nested_interval_scope_columns.each do |column_name|
@@ -97,20 +86,6 @@ module ActsAsNestedInterval
97
86
  self.class.where conditions
98
87
  end
99
88
 
100
- # Updates record, updating descendants if parent association updated,
101
- # in which case caller should first acquire table lock.
102
- def update_nested_interval
103
- changed = send(:"#{nested_interval_foreign_key}_changed?")
104
- if !changed
105
- db_self = self.class.find(id, :lock => true)
106
- write_attribute(nested_interval_foreign_key, db_self.read_attribute(nested_interval_foreign_key))
107
- set_nested_interval db_self.lftp, db_self.lftq
108
- else
109
- # No locking in this case -- caller should have acquired table lock.
110
- update_nested_interval_move
111
- end
112
- end
113
-
114
89
  # Rewrite method
115
90
  def update_nested_interval_move
116
91
  return if self.class.readonly_attributes.include?(nested_interval_foreign_key.to_sym) # Fix issue #9
@@ -136,7 +111,8 @@ module ActsAsNestedInterval
136
111
 
137
112
  updates = {}
138
113
  vars = Set.new
139
- mysql = ["MySQL", "Mysql2"].include?(connection.adapter_name)
114
+ # TODO
115
+ mysql = false #["MySQL", "Mysql2"].include?(connection.adapter_name)
140
116
  var = ->(v) { mysql ? vars.add?(v) ? "(@#{v} := #{v})" : "@#{v}" : v }
141
117
  multiply = ->(c, b) { "#{c} * #{var.(b)}" }
142
118
  add = ->(a, b) { "#{a} + #{b}" }
@@ -165,6 +141,10 @@ module ActsAsNestedInterval
165
141
  (node.lftp != rgtp || node.lftq != rgtq)
166
142
  end
167
143
 
144
+ def new_ancestors
145
+ nested_interval_scope.where("rgt >= CAST(:rgt AS FLOAT) AND lft < CAST(:lft AS FLOAT)", rgt: rgt, lft: lft)
146
+ end
147
+
168
148
  def ancestors
169
149
  sqls = ['0 = 1']
170
150
  p, q = lftp, lftq
@@ -1,3 +1,3 @@
1
1
  module ActsAsNestedInterval
2
- VERSION = "0.1.1"
2
+ VERSION = "0.2.0.pre"
3
3
  end
@@ -1,261 +1,28 @@
1
- == Welcome to Rails
1
+ == README
2
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.
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
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.
6
+ Things you may want to cover:
13
7
 
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.
8
+ * Ruby version
19
9
 
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.
10
+ * System dependencies
27
11
 
12
+ * Configuration
28
13
 
29
- == Getting Started
14
+ * Database creation
30
15
 
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)
16
+ * Database initialization
33
17
 
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)
18
+ * How to run the test suite
36
19
 
37
- 3. Go to http://localhost:3000/ and you'll see:
38
- "Welcome aboard: You're riding Ruby on Rails!"
20
+ * Services (job queues, cache servers, search engines, etc.)
39
21
 
40
- 4. Follow the guidelines to start developing your application. You can find
41
- the following resources handy:
22
+ * Deployment instructions
42
23
 
43
- * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
- * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
24
+ * ...
45
25
 
46
26
 
47
- == Debugging Rails
48
-
49
- Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
- will help you debug it and get it back on the rails.
51
-
52
- First area to check is the application log files. Have "tail -f" commands
53
- running on the server.log and development.log. Rails will automatically display
54
- debugging and runtime information to these files. Debugging info will also be
55
- shown in the browser on requests from 127.0.0.1.
56
-
57
- You can also log your own messages directly into the log file from your code
58
- using the Ruby logger class from inside your controllers. Example:
59
-
60
- class WeblogController < ActionController::Base
61
- def destroy
62
- @weblog = Weblog.find(params[:id])
63
- @weblog.destroy
64
- logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
- end
66
- end
67
-
68
- The result will be a message in your log file along the lines of:
69
-
70
- Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
-
72
- More information on how to use the logger is at http://www.ruby-doc.org/core/
73
-
74
- Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
- several books available online as well:
76
-
77
- * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
- * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
-
80
- These two books will bring you up to speed on the Ruby language and also on
81
- programming in general.
82
-
83
-
84
- == Debugger
85
-
86
- Debugger support is available through the debugger command when you start your
87
- Mongrel or WEBrick server with --debugger. This means that you can break out of
88
- execution at any point in the code, investigate and change the model, and then,
89
- resume execution! You need to install ruby-debug to run the server in debugging
90
- mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
-
92
- class WeblogController < ActionController::Base
93
- def index
94
- @posts = Post.all
95
- debugger
96
- end
97
- end
98
-
99
- So the controller will accept the action, run the first line, then present you
100
- with a IRB prompt in the server window. Here you can do things like:
101
-
102
- >> @posts.inspect
103
- => "[#<Post:0x14a6be8
104
- @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
- #<Post:0x14a6620
106
- @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
- >> @posts.first.title = "hello from a debugger"
108
- => "hello from a debugger"
109
-
110
- ...and even better, you can examine how your runtime objects actually work:
111
-
112
- >> f = @posts.first
113
- => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
- >> f.
115
- Display all 152 possibilities? (y or n)
116
-
117
- Finally, when you're ready to resume execution, you can enter "cont".
118
-
119
-
120
- == Console
121
-
122
- The console is a Ruby shell, which allows you to interact with your
123
- application's domain model. Here you'll have all parts of the application
124
- configured, just like it is when the application is running. You can inspect
125
- domain models, change values, and save to the database. Starting the script
126
- without arguments will launch it in the development environment.
127
-
128
- To start the console, run <tt>rails console</tt> from the application
129
- directory.
130
-
131
- Options:
132
-
133
- * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
- made to the database.
135
- * Passing an environment name as an argument will load the corresponding
136
- environment. Example: <tt>rails console production</tt>.
137
-
138
- To reload your controllers and models after launching the console run
139
- <tt>reload!</tt>
140
-
141
- More information about irb can be found at:
142
- link:http://www.rubycentral.org/pickaxe/irb.html
143
-
144
-
145
- == dbconsole
146
-
147
- You can go to the command line of your database directly through <tt>rails
148
- dbconsole</tt>. You would be connected to the database with the credentials
149
- defined in database.yml. Starting the script without arguments will connect you
150
- to the development database. Passing an argument will connect you to a different
151
- database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
- PostgreSQL and SQLite 3.
153
-
154
- == Description of Contents
155
-
156
- The default directory structure of a generated Ruby on Rails application:
157
-
158
- |-- app
159
- | |-- assets
160
- | |-- images
161
- | |-- javascripts
162
- | `-- stylesheets
163
- | |-- controllers
164
- | |-- helpers
165
- | |-- mailers
166
- | |-- models
167
- | `-- views
168
- | `-- layouts
169
- |-- config
170
- | |-- environments
171
- | |-- initializers
172
- | `-- locales
173
- |-- db
174
- |-- doc
175
- |-- lib
176
- | `-- tasks
177
- |-- log
178
- |-- public
179
- |-- script
180
- |-- test
181
- | |-- fixtures
182
- | |-- functional
183
- | |-- integration
184
- | |-- performance
185
- | `-- unit
186
- |-- tmp
187
- | |-- cache
188
- | |-- pids
189
- | |-- sessions
190
- | `-- sockets
191
- `-- vendor
192
- |-- assets
193
- `-- stylesheets
194
- `-- plugins
195
-
196
- app
197
- Holds all the code that's specific to this particular application.
198
-
199
- app/assets
200
- Contains subdirectories for images, stylesheets, and JavaScript files.
201
-
202
- app/controllers
203
- Holds controllers that should be named like weblogs_controller.rb for
204
- automated URL mapping. All controllers should descend from
205
- ApplicationController which itself descends from ActionController::Base.
206
-
207
- app/models
208
- Holds models that should be named like post.rb. Models descend from
209
- ActiveRecord::Base by default.
210
-
211
- app/views
212
- Holds the template files for the view that should be named like
213
- weblogs/index.html.erb for the WeblogsController#index action. All views use
214
- eRuby syntax by default.
215
-
216
- app/views/layouts
217
- Holds the template files for layouts to be used with views. This models the
218
- common header/footer method of wrapping views. In your views, define a layout
219
- using the <tt>layout :default</tt> and create a file named default.html.erb.
220
- Inside default.html.erb, call <% yield %> to render the view using this
221
- layout.
222
-
223
- app/helpers
224
- Holds view helpers that should be named like weblogs_helper.rb. These are
225
- generated for you automatically when using generators for controllers.
226
- Helpers can be used to wrap functionality for your views into methods.
227
-
228
- config
229
- Configuration files for the Rails environment, the routing map, the database,
230
- and other dependencies.
231
-
232
- db
233
- Contains the database schema in schema.rb. db/migrate contains all the
234
- sequence of Migrations for your schema.
235
-
236
- doc
237
- This directory is where your application documentation will be stored when
238
- generated using <tt>rake doc:app</tt>
239
-
240
- lib
241
- Application specific libraries. Basically, any kind of custom code that
242
- doesn't belong under controllers, models, or helpers. This directory is in
243
- the load path.
244
-
245
- public
246
- The directory available for the web server. Also contains the dispatchers and the
247
- default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
- server.
249
-
250
- script
251
- Helper scripts for automation and generation.
252
-
253
- test
254
- Unit and functional tests along with fixtures. When using the rails generate
255
- command, template test files will be generated for you and placed in this
256
- directory.
257
-
258
- vendor
259
- External libraries that the application depends on. Also includes the plugins
260
- subdirectory. If the app has frozen rails, those gems also go here, under
261
- vendor/rails/. This directory is in the load path.
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.