acts_as_previous_next 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (59) hide show
  1. data/.gitignore +7 -0
  2. data/.rspec +1 -0
  3. data/Gemfile +25 -0
  4. data/Gemfile.lock +145 -0
  5. data/Guardfile +19 -0
  6. data/MIT-LICENSE +20 -0
  7. data/README.rdoc +50 -0
  8. data/Rakefile +27 -0
  9. data/acts_as_previous_next.gemspec +31 -0
  10. data/lib/acts_as_previous_next/version.rb +3 -0
  11. data/lib/acts_as_previous_next.rb +46 -0
  12. data/lib/tasks/acts_as_previous_next_tasks.rake +4 -0
  13. data/spec/dummy/README.rdoc +261 -0
  14. data/spec/dummy/Rakefile +7 -0
  15. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  16. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  17. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  18. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  19. data/spec/dummy/app/mailers/.gitkeep +0 -0
  20. data/spec/dummy/app/models/.gitkeep +0 -0
  21. data/spec/dummy/app/models/ability.rb +12 -0
  22. data/spec/dummy/app/models/post.rb +3 -0
  23. data/spec/dummy/app/models/user.rb +2 -0
  24. data/spec/dummy/app/models/without_cancan.rb +3 -0
  25. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  26. data/spec/dummy/config/application.rb +62 -0
  27. data/spec/dummy/config/boot.rb +10 -0
  28. data/spec/dummy/config/database.yml +42 -0
  29. data/spec/dummy/config/environment.rb +5 -0
  30. data/spec/dummy/config/environments/development.rb +37 -0
  31. data/spec/dummy/config/environments/production.rb +67 -0
  32. data/spec/dummy/config/environments/test.rb +37 -0
  33. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  34. data/spec/dummy/config/initializers/inflections.rb +15 -0
  35. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  36. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  37. data/spec/dummy/config/initializers/session_store.rb +8 -0
  38. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  39. data/spec/dummy/config/locales/en.yml +5 -0
  40. data/spec/dummy/config/routes.rb +58 -0
  41. data/spec/dummy/config.ru +4 -0
  42. data/spec/dummy/db/migrate/20120104174603_create_posts.rb +9 -0
  43. data/spec/dummy/db/migrate/20120105104935_create_users.rb +9 -0
  44. data/spec/dummy/db/migrate/20120105110842_create_without_cancans.rb +9 -0
  45. data/spec/dummy/db/schema.rb +37 -0
  46. data/spec/dummy/lib/assets/.gitkeep +0 -0
  47. data/spec/dummy/log/.gitkeep +0 -0
  48. data/spec/dummy/public/404.html +26 -0
  49. data/spec/dummy/public/422.html +26 -0
  50. data/spec/dummy/public/500.html +25 -0
  51. data/spec/dummy/public/favicon.ico +0 -0
  52. data/spec/dummy/script/rails +6 -0
  53. data/spec/factories/post.rb +13 -0
  54. data/spec/factories/user.rb +11 -0
  55. data/spec/factories/without_cancan.rb +11 -0
  56. data/spec/models/post_spec.rb +97 -0
  57. data/spec/models/without_cancan_spec.rb +50 -0
  58. data/spec/spec_helper.rb +80 -0
  59. metadata +166 -0
data/.gitignore ADDED
@@ -0,0 +1,7 @@
1
+ .bundle/
2
+ log/*.log
3
+ pkg/
4
+ spec/dummy/db/*.sqlite3
5
+ spec/dummy/log/*.log
6
+ spec/dummy/tmp/
7
+ spec/dummy/.sass-cache
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color
data/Gemfile ADDED
@@ -0,0 +1,25 @@
1
+ source "http://rubygems.org"
2
+
3
+ # Declare your gem's dependencies in acts_as_previous_next.gemspec.
4
+ # Bundler will treat runtime dependencies like base dependencies, and
5
+ # development dependencies will be added by default to the :development group.
6
+ gemspec
7
+
8
+ # jquery-rails is used by the dummy application
9
+ gem "jquery-rails"
10
+
11
+ # Declare any dependencies that are still in development here instead of in
12
+ # your gemspec. These might include edge Rails or gems from your path or
13
+ # Git. Remember to move these dependencies to your gemspec before releasing
14
+ # your gem to rubygems.org.
15
+
16
+ # To use debugger
17
+ # gem 'ruby-debug19', :require => 'ruby-debug'
18
+ gem 'rspec-rails', :git => "git://github.com/rspec/rspec-rails.git"
19
+ gem 'database_cleaner', :git => "git://github.com/asanghi/database_cleaner.git"
20
+ gem 'cancan'
21
+ #gem 'factory_girl_rails'
22
+ #gem 'spork', '0.9.0.rc9'
23
+ gem 'rb-fsevent'
24
+ #gem 'guard-rspec'
25
+ gem 'libnotify'
data/Gemfile.lock ADDED
@@ -0,0 +1,145 @@
1
+ GIT
2
+ remote: git://github.com/asanghi/database_cleaner.git
3
+ revision: b2d2ce7ff782542b23c2f45e6c0ea9ef0c25c0cd
4
+ specs:
5
+ database_cleaner (0.7.0)
6
+
7
+ GIT
8
+ remote: git://github.com/rspec/rspec-rails.git
9
+ revision: 8ed140d5238fef0cd37e7f58fd8e038ea932146d
10
+ specs:
11
+ rspec-rails (2.8.1)
12
+ actionpack (>= 3.0)
13
+ activesupport (>= 3.0)
14
+ railties (>= 3.0)
15
+ rspec (~> 2.8.0)
16
+
17
+ PATH
18
+ remote: .
19
+ specs:
20
+ acts_as_previous_next (0.0.1)
21
+ rails (~> 3.2.0.rc2)
22
+
23
+ GEM
24
+ remote: http://rubygems.org/
25
+ specs:
26
+ actionmailer (3.2.0.rc2)
27
+ actionpack (= 3.2.0.rc2)
28
+ mail (~> 2.3.0)
29
+ actionpack (3.2.0.rc2)
30
+ activemodel (= 3.2.0.rc2)
31
+ activesupport (= 3.2.0.rc2)
32
+ builder (~> 3.0.0)
33
+ erubis (~> 2.7.0)
34
+ journey (~> 1.0.0.rc1)
35
+ rack (~> 1.4.0)
36
+ rack-cache (~> 1.1)
37
+ rack-test (~> 0.6.1)
38
+ sprockets (~> 2.1.2)
39
+ activemodel (3.2.0.rc2)
40
+ activesupport (= 3.2.0.rc2)
41
+ builder (~> 3.0.0)
42
+ activerecord (3.2.0.rc2)
43
+ activemodel (= 3.2.0.rc2)
44
+ activesupport (= 3.2.0.rc2)
45
+ arel (~> 3.0.0.rc1)
46
+ tzinfo (~> 0.3.29)
47
+ activeresource (3.2.0.rc2)
48
+ activemodel (= 3.2.0.rc2)
49
+ activesupport (= 3.2.0.rc2)
50
+ activesupport (3.2.0.rc2)
51
+ i18n (~> 0.6)
52
+ multi_json (~> 1.0)
53
+ arel (3.0.0.rc1)
54
+ builder (3.0.0)
55
+ cancan (1.6.7)
56
+ diff-lcs (1.1.3)
57
+ erubis (2.7.0)
58
+ factory_girl (2.3.2)
59
+ activesupport
60
+ factory_girl_rails (1.4.0)
61
+ factory_girl (~> 2.3.0)
62
+ railties (>= 3.0.0)
63
+ ffi (1.0.11)
64
+ guard (0.10.0)
65
+ ffi (>= 0.5.0)
66
+ thor (~> 0.14.6)
67
+ guard-rspec (0.6.0)
68
+ guard (>= 0.10.0)
69
+ hike (1.2.1)
70
+ i18n (0.6.0)
71
+ journey (1.0.0.rc4)
72
+ jquery-rails (2.0.0)
73
+ railties (>= 3.2.0.beta, < 5.0)
74
+ thor (~> 0.14)
75
+ json (1.6.4)
76
+ libnotify (0.7.1)
77
+ mail (2.3.0)
78
+ i18n (>= 0.4.0)
79
+ mime-types (~> 1.16)
80
+ treetop (~> 1.4.8)
81
+ mime-types (1.17.2)
82
+ multi_json (1.0.4)
83
+ mysql2 (0.3.11)
84
+ polyglot (0.3.3)
85
+ rack (1.4.0)
86
+ rack-cache (1.1)
87
+ rack (>= 0.4)
88
+ rack-ssl (1.3.2)
89
+ rack
90
+ rack-test (0.6.1)
91
+ rack (>= 1.0)
92
+ rails (3.2.0.rc2)
93
+ actionmailer (= 3.2.0.rc2)
94
+ actionpack (= 3.2.0.rc2)
95
+ activerecord (= 3.2.0.rc2)
96
+ activeresource (= 3.2.0.rc2)
97
+ activesupport (= 3.2.0.rc2)
98
+ bundler (~> 1.0)
99
+ railties (= 3.2.0.rc2)
100
+ railties (3.2.0.rc2)
101
+ actionpack (= 3.2.0.rc2)
102
+ activesupport (= 3.2.0.rc2)
103
+ rack-ssl (~> 1.3.2)
104
+ rake (>= 0.8.7)
105
+ rdoc (~> 3.4)
106
+ thor (~> 0.14.6)
107
+ rake (0.9.2.2)
108
+ rb-fsevent (0.4.3.1)
109
+ rdoc (3.12)
110
+ json (~> 1.4)
111
+ rspec (2.8.0)
112
+ rspec-core (~> 2.8.0)
113
+ rspec-expectations (~> 2.8.0)
114
+ rspec-mocks (~> 2.8.0)
115
+ rspec-core (2.8.0)
116
+ rspec-expectations (2.8.0)
117
+ diff-lcs (~> 1.1.2)
118
+ rspec-mocks (2.8.0)
119
+ spork (0.9.0.rc9)
120
+ sprockets (2.1.2)
121
+ hike (~> 1.2)
122
+ rack (~> 1.0)
123
+ tilt (~> 1.1, != 1.3.0)
124
+ thor (0.14.6)
125
+ tilt (1.3.3)
126
+ treetop (1.4.10)
127
+ polyglot
128
+ polyglot (>= 0.3.1)
129
+ tzinfo (0.3.31)
130
+
131
+ PLATFORMS
132
+ ruby
133
+
134
+ DEPENDENCIES
135
+ acts_as_previous_next!
136
+ cancan
137
+ database_cleaner!
138
+ factory_girl_rails
139
+ guard-rspec
140
+ jquery-rails
141
+ libnotify
142
+ mysql2
143
+ rb-fsevent
144
+ rspec-rails!
145
+ spork (= 0.9.0.rc9)
data/Guardfile ADDED
@@ -0,0 +1,19 @@
1
+ # A sample Guardfile
2
+ # More info at https://github.com/guard/guard#readme
3
+
4
+ guard 'rspec', :version => 2 do
5
+ watch(%r{^spec/.+_spec\.rb})
6
+ watch(%r{^lib/(.+)\.rb}) { |m| "spec/lib/#{m[1]}_spec.rb" }
7
+ watch('spec/spec_helper.rb') { "spec" }
8
+
9
+ # Rails example
10
+ watch('spec/spec_helper.rb') { "spec" }
11
+ watch('config/routes.rb') { "spec/routing" }
12
+ watch('app/controllers/application_controller.rb') { "spec/controllers" }
13
+ watch(%r{^spec/.+_spec\.rb})
14
+ watch(%r{^app/(.+)\.rb}) { |m| "spec/#{m[1]}_spec.rb" }
15
+ watch(%r{^lib/(.+)\.rb}) { |m| "spec/lib/#{m[1]}_spec.rb" }
16
+ watch(%r{^app/controllers/(.+)_(controller)\.rb}) { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/requests/#{m[1]}_spec.rb"] }
17
+ watch(%r{^app/views/(.+)/}) { |m| "spec/requests/#{m[1]}_spec.rb" }
18
+ end
19
+
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2012 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,50 @@
1
+ = ActsAsPreviousNext
2
+
3
+ == Description
4
+
5
+ This 'acts_as' extension provides the capability for having previous & next methods for an object.
6
+ Previous & next are based on a specified column (default is id).
7
+
8
+ == Install
9
+
10
+ In your Gemfile
11
+
12
+ gem 'acts_as_previous_next'
13
+
14
+ Currently is tested on rails3.2.0.rc2, ruby 1.9.3 and mysql
15
+
16
+ == Example
17
+
18
+ class Post < ActiveRecord::Base
19
+ acts_as_previous_next
20
+ # acts_as_previous_next column: :id
21
+ # or
22
+ # acts_as_previous_next :id
23
+ end
24
+
25
+ post = Post.new
26
+ post.next # => nil
27
+ post.save
28
+ post.next # => post
29
+ post.previous # => post
30
+ another_post = Post.new
31
+ another_post.save
32
+ another_post.next # => post
33
+ another_post.previous # => post
34
+
35
+ Currently CanCan authorization is supported as option (+false+ by default). If cancan authorization is
36
+ enabled then +current_ability+ must be passed to next, previous methods. So the previous example
37
+ with cancan will be:
38
+
39
+ class Post < ActiveRecord::Base
40
+ acts_as_previous_next with_cancan: true
41
+
42
+ belongs_to :user
43
+ end
44
+
45
+ And in your view:
46
+
47
+ link_to 'Next', @post.next(current_ability)
48
+ link_to 'Previous', @post.previous(current_ability)
49
+
50
+
data/Rakefile ADDED
@@ -0,0 +1,27 @@
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 = 'ActsAsPreviousNext'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+
24
+
25
+
26
+ Bundler::GemHelper.install_tasks
27
+
@@ -0,0 +1,31 @@
1
+ $:.push File.expand_path("../lib", __FILE__)
2
+
3
+ # Maintain your gem's version:
4
+ require "acts_as_previous_next/version"
5
+
6
+ # Describe your gem and declare its dependencies:
7
+ Gem::Specification.new do |s|
8
+ s.name = "acts_as_previous_next"
9
+ s.version = ActsAsPreviousNext::VERSION
10
+ s.authors = ["Giorgos Tsiftsis"]
11
+ s.email = ["giorgos.tsiftsis@gmail.com"]
12
+ s.homepage = ""
13
+ s.summary = "A gem allowing an actire_record model to have previous, next based on a column."
14
+ s.description = "This 'acts_as' extension provides the capability for having previous next methods for object.
15
+ Previous & next are based on a specified column (default is id)."
16
+
17
+ s.files = `git ls-files`.split("\n")
18
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
19
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
20
+ s.require_paths = ['lib']
21
+ #s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
22
+
23
+ s.add_dependency 'rails', '~> 3.2.0.rc2'
24
+
25
+ s.add_development_dependency 'mysql2'
26
+ s.add_development_dependency 'factory_girl_rails'
27
+ s.add_development_dependency 'spork', '0.9.0.rc9'
28
+ #s.add_development_dependency 'rb-fsevent'
29
+ s.add_development_dependency 'guard-rspec'
30
+ #s.add_development_dependency 'libnotify'
31
+ end
@@ -0,0 +1,3 @@
1
+ module ActsAsPreviousNext
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,46 @@
1
+ require 'active_support/concern'
2
+
3
+ module ActsAsPreviousNext
4
+ extend ActiveSupport::Concern
5
+
6
+ included do
7
+ def self.acts_as_previous_next(options = {})
8
+ configuration = { column: 'id', with_cancan: false }
9
+ configuration.update(options) if options.is_a?(Hash)
10
+
11
+ if options.is_a? Symbol
12
+ column = options.to_s
13
+ with_cancan = false
14
+ elsif options.is_a? Hash
15
+ column = options[:column] || "id"
16
+ with_cancan = options[:with_cancan]
17
+ end
18
+
19
+ class_eval <<-EOF
20
+ if with_cancan
21
+ def next(ability)
22
+ self.class.accessible_by(ability).where("#{column} > ?", self.send('#{column}')).order("#{column}").first ||
23
+ self.class.accessible_by(ability).order("#{column}").first
24
+ end
25
+
26
+ def previous(ability)
27
+ self.class.accessible_by(ability).where("#{column} < ?", self.send('#{column}')).order("#{column} DESC").first ||
28
+ self.class.accessible_by(ability).order("#{column} DESC").first
29
+ end
30
+ else
31
+ def next
32
+ self.class.where("#{column} > ?", self.send('#{column}')).order("#{column}").first ||
33
+ self.class.order("#{column}").first
34
+ end
35
+
36
+ def previous
37
+ self.class.where("#{column} < ?", self.send('#{column}')).order("#{column} DESC").first ||
38
+ self.class.order("#{column} DESC").first
39
+ end
40
+ end
41
+ EOF
42
+ end
43
+ end
44
+ end
45
+
46
+ ActiveRecord::Base.send :include, ActsAsPreviousNext
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :acts_as_previous_next do
3
+ # # Task goes here
4
+ # 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
+ | `-- 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.
@@ -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 .