├── log └── .gitkeep ├── lib ├── tasks │ └── .gitkeep └── assets │ └── .gitkeep ├── public ├── favicon.ico ├── robots.txt ├── 500.html ├── 422.html └── 404.html ├── app ├── mailers │ └── .gitkeep ├── models │ ├── .gitkeep │ ├── article.rb │ └── user.rb ├── helpers │ ├── users_helper.rb │ ├── articles_helper.rb │ ├── sessions_helper.rb │ ├── admin │ │ ├── users_helper.rb │ │ └── dashboard_helper.rb │ └── application_helper.rb ├── assets │ ├── images │ │ └── rails.png │ ├── stylesheets │ │ ├── users.css.scss │ │ ├── articles.css.scss │ │ ├── sessions.css.scss │ │ ├── admin │ │ │ ├── users.css.scss │ │ │ └── dashboard.css.scss │ │ ├── application.css │ │ └── scaffolds.css.scss │ └── javascripts │ │ ├── articles.js.coffee │ │ ├── sessions.js.coffee │ │ ├── users.js.coffee │ │ ├── admin │ │ ├── users.js.coffee │ │ └── dashboard.js.coffee │ │ └── application.js ├── views │ ├── admin │ │ ├── articles │ │ │ ├── new.html.erb │ │ │ ├── edit.html.erb │ │ │ ├── show.html.erb │ │ │ ├── index.html.erb │ │ │ └── _form.html.erb │ │ ├── dashboard │ │ │ └── index.html.erb │ │ └── users │ │ │ ├── index.html.erb │ │ │ └── new.html.erb │ ├── articles │ │ └── index.html.erb │ ├── sessions │ │ └── new.html.erb │ └── layouts │ │ └── application.html.erb └── controllers │ ├── articles_controller.rb │ ├── admin │ ├── dashboard_controller.rb │ ├── users_controller.rb │ └── articles_controller.rb │ ├── application_controller.rb │ └── sessions_controller.rb ├── vendor ├── plugins │ └── .gitkeep └── assets │ ├── javascripts │ └── .gitkeep │ └── stylesheets │ └── .gitkeep ├── .rspec ├── spec ├── factories │ ├── articles.rb │ └── users.rb ├── controllers │ ├── articles_controller_spec.rb │ └── admin │ │ ├── dashboard_controller_spec.rb │ │ ├── users_controller_spec.rb │ │ └── articles_controller_spec.rb ├── support │ └── login_macros.rb ├── models │ └── user_spec.rb ├── spec_helper.rb └── requests │ └── admin_spec.rb ├── config.ru ├── config ├── environment.rb ├── boot.rb ├── initializers │ ├── mime_types.rb │ ├── backtrace_silencers.rb │ ├── session_store.rb │ ├── secret_token.rb │ ├── wrap_parameters.rb │ └── inflections.rb ├── locales │ └── en.yml ├── database.yml ├── environments │ ├── development.rb │ ├── test.rb │ └── production.rb ├── routes.rb └── application.rb ├── doc └── README_FOR_APP ├── db ├── migrate │ ├── 20120731005603_create_articles.rb │ └── 20120731003347_create_users.rb ├── seeds.rb └── schema.rb ├── Rakefile ├── script └── rails ├── .gitignore ├── LICENSE ├── Gemfile ├── README.md ├── Guardfile ├── Gemfile.lock └── README.rdoc /log/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/tasks/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/mailers/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/models/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/assets/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /vendor/plugins/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /vendor/assets/javascripts/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /vendor/assets/stylesheets/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | --format documentation 3 | 4 | -------------------------------------------------------------------------------- /app/helpers/users_helper.rb: -------------------------------------------------------------------------------- 1 | module UsersHelper 2 | end 3 | -------------------------------------------------------------------------------- /app/helpers/articles_helper.rb: -------------------------------------------------------------------------------- 1 | module ArticlesHelper 2 | end 3 | -------------------------------------------------------------------------------- /app/helpers/sessions_helper.rb: -------------------------------------------------------------------------------- 1 | module SessionsHelper 2 | end 3 | -------------------------------------------------------------------------------- /app/helpers/admin/users_helper.rb: -------------------------------------------------------------------------------- 1 | module Admin::UsersHelper 2 | end 3 | -------------------------------------------------------------------------------- /app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | module ApplicationHelper 2 | end 3 | -------------------------------------------------------------------------------- /app/helpers/admin/dashboard_helper.rb: -------------------------------------------------------------------------------- 1 | module Admin::DashboardHelper 2 | end 3 | -------------------------------------------------------------------------------- /app/models/article.rb: -------------------------------------------------------------------------------- 1 | class Article < ActiveRecord::Base 2 | attr_accessible :body, :name 3 | end 4 | -------------------------------------------------------------------------------- /app/assets/images/rails.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/everydayrails/admin_demo/HEAD/app/assets/images/rails.png -------------------------------------------------------------------------------- /app/views/admin/articles/new.html.erb: -------------------------------------------------------------------------------- 1 |

New article

2 | 3 | <%= render 'form' %> 4 | 5 | <%= link_to 'Back', articles_path %> 6 | -------------------------------------------------------------------------------- /app/controllers/articles_controller.rb: -------------------------------------------------------------------------------- 1 | class ArticlesController < ApplicationController 2 | def index 3 | @articles = Article.all 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /spec/factories/articles.rb: -------------------------------------------------------------------------------- 1 | FactoryGirl.define do 2 | factory :article do 3 | name "My article" 4 | body "A very interesting article." 5 | end 6 | end -------------------------------------------------------------------------------- /spec/factories/users.rb: -------------------------------------------------------------------------------- 1 | FactoryGirl.define do 2 | factory :user do 3 | sequence(:email) { |n| "johndoe#{n}@example.com"} 4 | password 'secret' 5 | end 6 | end -------------------------------------------------------------------------------- /app/controllers/admin/dashboard_controller.rb: -------------------------------------------------------------------------------- 1 | class Admin::DashboardController < ApplicationController 2 | 3 | before_filter :authorize 4 | 5 | def index 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | 3 | require ::File.expand_path('../config/environment', __FILE__) 4 | run AdminDemo::Application 5 | -------------------------------------------------------------------------------- /config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the rails application 2 | require File.expand_path('../application', __FILE__) 3 | 4 | # Initialize the rails application 5 | AdminDemo::Application.initialize! 6 | -------------------------------------------------------------------------------- /app/views/admin/articles/edit.html.erb: -------------------------------------------------------------------------------- 1 |

Editing article

2 | 3 | <%= render 'form' %> 4 | 5 | <%= link_to 'Show', admin_article_path(@article) %> | 6 | <%= link_to 'Back', admin_articles_path %> 7 | -------------------------------------------------------------------------------- /app/views/articles/index.html.erb: -------------------------------------------------------------------------------- 1 |

Articles

2 | 3 | <% @articles.each do |article| %> 4 |
5 |

<%= article.name %>

6 | <%= simple_format article.body %> 7 |
8 | <% end %> -------------------------------------------------------------------------------- /app/views/admin/dashboard/index.html.erb: -------------------------------------------------------------------------------- 1 |

Administration

2 | 3 | -------------------------------------------------------------------------------- /app/assets/stylesheets/users.css.scss: -------------------------------------------------------------------------------- 1 | // Place all the styles related to the users controller here. 2 | // They will automatically be included in application.css. 3 | // You can use Sass (SCSS) here: http://sass-lang.com/ 4 | -------------------------------------------------------------------------------- /app/assets/stylesheets/articles.css.scss: -------------------------------------------------------------------------------- 1 | // Place all the styles related to the articles controller here. 2 | // They will automatically be included in application.css. 3 | // You can use Sass (SCSS) here: http://sass-lang.com/ 4 | -------------------------------------------------------------------------------- /app/assets/stylesheets/sessions.css.scss: -------------------------------------------------------------------------------- 1 | // Place all the styles related to the sessions controller here. 2 | // They will automatically be included in application.css. 3 | // You can use Sass (SCSS) here: http://sass-lang.com/ 4 | -------------------------------------------------------------------------------- /config/boot.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | 3 | # Set up gems listed in the Gemfile. 4 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__) 5 | 6 | require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE']) 7 | -------------------------------------------------------------------------------- /app/assets/stylesheets/admin/users.css.scss: -------------------------------------------------------------------------------- 1 | // Place all the styles related to the admin/users controller here. 2 | // They will automatically be included in application.css. 3 | // You can use Sass (SCSS) here: http://sass-lang.com/ 4 | -------------------------------------------------------------------------------- /doc/README_FOR_APP: -------------------------------------------------------------------------------- 1 | Use this README file to introduce your application and point to useful places in the API for learning more. 2 | Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries. 3 | -------------------------------------------------------------------------------- /public/robots.txt: -------------------------------------------------------------------------------- 1 | # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file 2 | # 3 | # To ban all spiders from the entire site uncomment the next two lines: 4 | # User-Agent: * 5 | # Disallow: / 6 | -------------------------------------------------------------------------------- /app/assets/stylesheets/admin/dashboard.css.scss: -------------------------------------------------------------------------------- 1 | // Place all the styles related to the admin/dashboard controller here. 2 | // They will automatically be included in application.css. 3 | // You can use Sass (SCSS) here: http://sass-lang.com/ 4 | -------------------------------------------------------------------------------- /config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | # Mime::Type.register_alias "text/html", :iphone 6 | -------------------------------------------------------------------------------- /config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Sample localization file for English. Add more files in this directory for other locales. 2 | # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points. 3 | 4 | en: 5 | hello: "Hello world" 6 | -------------------------------------------------------------------------------- /db/migrate/20120731005603_create_articles.rb: -------------------------------------------------------------------------------- 1 | class CreateArticles < ActiveRecord::Migration 2 | def change 3 | create_table :articles do |t| 4 | t.string :name 5 | t.text :body 6 | 7 | t.timestamps 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /db/migrate/20120731003347_create_users.rb: -------------------------------------------------------------------------------- 1 | class CreateUsers < ActiveRecord::Migration 2 | def change 3 | create_table :users do |t| 4 | t.string :email 5 | t.string :password_digest 6 | 7 | t.timestamps 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /app/assets/javascripts/articles.js.coffee: -------------------------------------------------------------------------------- 1 | # Place all the behaviors and hooks related to the matching controller here. 2 | # All this logic will automatically be available in application.js. 3 | # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/ 4 | -------------------------------------------------------------------------------- /app/assets/javascripts/sessions.js.coffee: -------------------------------------------------------------------------------- 1 | # Place all the behaviors and hooks related to the matching controller here. 2 | # All this logic will automatically be available in application.js. 3 | # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/ 4 | -------------------------------------------------------------------------------- /app/assets/javascripts/users.js.coffee: -------------------------------------------------------------------------------- 1 | # Place all the behaviors and hooks related to the matching controller here. 2 | # All this logic will automatically be available in application.js. 3 | # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/ 4 | -------------------------------------------------------------------------------- /app/assets/javascripts/admin/users.js.coffee: -------------------------------------------------------------------------------- 1 | # Place all the behaviors and hooks related to the matching controller here. 2 | # All this logic will automatically be available in application.js. 3 | # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/ 4 | -------------------------------------------------------------------------------- /app/assets/javascripts/admin/dashboard.js.coffee: -------------------------------------------------------------------------------- 1 | # Place all the behaviors and hooks related to the matching controller here. 2 | # All this logic will automatically be available in application.js. 3 | # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/ 4 | -------------------------------------------------------------------------------- /spec/controllers/articles_controller_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe ArticlesController do 4 | 5 | describe "GET 'index'" do 6 | it "returns http success" do 7 | get 'index' 8 | response.should be_success 9 | end 10 | end 11 | 12 | end 13 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 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 | AdminDemo::Application.load_tasks 8 | -------------------------------------------------------------------------------- /app/models/user.rb: -------------------------------------------------------------------------------- 1 | class User < ActiveRecord::Base 2 | has_secure_password 3 | 4 | attr_accessible :email, :password, :password_confirmation 5 | 6 | validates :email, 7 | presence: true, 8 | uniqueness: true, 9 | format: { :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i } 10 | end 11 | -------------------------------------------------------------------------------- /script/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application. 3 | 4 | APP_PATH = File.expand_path('../../config/application', __FILE__) 5 | require File.expand_path('../../config/boot', __FILE__) 6 | require 'rails/commands' 7 | -------------------------------------------------------------------------------- /app/views/admin/users/index.html.erb: -------------------------------------------------------------------------------- 1 |

Listing users

2 | 3 | 4 | 5 | 6 | 7 | 8 | <% @users.each do |user| %> 9 | 10 | 11 | 12 | <% end %> 13 |
Email
<%= user.email %>
14 | 15 |
16 | 17 | <%= link_to 'New User', new_admin_user_path %> 18 | -------------------------------------------------------------------------------- /app/views/admin/articles/show.html.erb: -------------------------------------------------------------------------------- 1 |

<%= notice %>

2 | 3 |

4 | Name: 5 | <%= @article.name %> 6 |

7 | 8 |

9 | Body: 10 | <%= @article.body %> 11 |

12 | 13 | 14 | <%= link_to 'Edit', edit_admin_article_path(@article) %> | 15 | <%= link_to 'Back', admin_articles_path %> 16 | -------------------------------------------------------------------------------- /spec/support/login_macros.rb: -------------------------------------------------------------------------------- 1 | module LoginMacros 2 | def set_user_session(user) 3 | session[:user_id] = user.id 4 | end 5 | 6 | def sign_in(user) 7 | visit root_path 8 | click_link 'Log In' 9 | fill_in 'Email', with: user.email 10 | fill_in 'Password', with: user.password 11 | click_button 'Log In' 12 | end 13 | end -------------------------------------------------------------------------------- /spec/models/user_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe User do 4 | it "accepts a correctly-formatted email address" do 5 | FactoryGirl.build(:user, email: 'correct@gmail.com').should be_valid 6 | end 7 | 8 | it "rejects an incorrectly-formatted email address" do 9 | FactoryGirl.build(:user, email: 'correct@gmail').should_not be_valid 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::Base 2 | protect_from_forgery 3 | 4 | private 5 | 6 | def current_user 7 | @current_user ||= User.find(session[:user_id]) if session[:user_id] 8 | end 9 | helper_method :current_user 10 | 11 | def authorize 12 | redirect_to login_url, alert: "Not authorized" if current_user.nil? 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /app/views/sessions/new.html.erb: -------------------------------------------------------------------------------- 1 |

Please Log In

2 | 3 | <%= form_tag sessions_path do %> 4 |
5 | <%= label_tag :email %>
6 | <%= text_field_tag :email, params[:email] %> 7 |
8 |
9 | <%= label_tag :password %>
10 | <%= password_field_tag :password %> 11 |
12 |
<%= submit_tag "Log In" %>
13 | <% end %> -------------------------------------------------------------------------------- /config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 5 | 6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 7 | # Rails.backtrace_cleaner.remove_silencers! 8 | -------------------------------------------------------------------------------- /config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | AdminDemo::Application.config.session_store :cookie_store, key: '_admin_demo_session' 4 | 5 | # Use the database for sessions instead of the cookie-based default, 6 | # which shouldn't be used to store highly confidential information 7 | # (create the session table with "rails generate session_migration") 8 | # AdminDemo::Application.config.session_store :active_record_store 9 | -------------------------------------------------------------------------------- /db/seeds.rb: -------------------------------------------------------------------------------- 1 | # This file should contain all the record creation needed to seed the database with its default values. 2 | # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup). 3 | # 4 | # Examples: 5 | # 6 | # cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }]) 7 | # Mayor.create(name: 'Emanuel', city: cities.first) 8 | 9 | User.find_or_create_by_email( 10 | email: 'admin@example.com', 11 | password: 'secret', 12 | password_confirmation: 'secret' 13 | ) -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See http://help.github.com/ignore-files/ for more about ignoring files. 2 | # 3 | # If you find yourself ignoring temporary files generated by your text editor 4 | # or operating system, you probably want to add a global ignore instead: 5 | # git config --global core.excludesfile ~/.gitignore_global 6 | 7 | # Ignore bundler config 8 | /.bundle 9 | 10 | # Ignore the default SQLite database. 11 | /db/*.sqlite3 12 | 13 | # Ignore all logfiles and tempfiles. 14 | /log/*.log 15 | /tmp 16 | 17 | # Ignore .rvrmc file 18 | .rvmrc -------------------------------------------------------------------------------- /app/views/layouts/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | AdminDemo 5 | <%= stylesheet_link_tag "application", :media => "all" %> 6 | <%= javascript_include_tag "application" %> 7 | <%= csrf_meta_tags %> 8 | 9 | 10 | 11 | <% if current_user %> 12 | Logged in as <%= current_user.email %>. 13 | <%= link_to "Log Out", logout_path %> 14 | <% else %> 15 | <%= link_to "Log In", login_path %> 16 | <% end %> 17 | 18 | <%= yield %> 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /config/initializers/secret_token.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your secret key for verifying the integrity of signed cookies. 4 | # If you change this key, all old signed cookies will become invalid! 5 | # Make sure the secret is at least 30 characters and all random, 6 | # no regular words or you'll be exposed to dictionary attacks. 7 | AdminDemo::Application.config.secret_token = '51022d3a17d95e3e3f2cc7b811d363f3a813fefbc1ccf860d27e71671f751260be05da90281b4fbd95ca830a1faf136e8e5a91e61d648155c4f2f43678b0d835' 8 | -------------------------------------------------------------------------------- /config/initializers/wrap_parameters.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | # 3 | # This file contains settings for ActionController::ParamsWrapper which 4 | # is enabled by default. 5 | 6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. 7 | ActiveSupport.on_load(:action_controller) do 8 | wrap_parameters format: [:json] 9 | end 10 | 11 | # Disable root element in JSON by default. 12 | ActiveSupport.on_load(:active_record) do 13 | self.include_root_in_json = false 14 | end 15 | -------------------------------------------------------------------------------- /app/controllers/sessions_controller.rb: -------------------------------------------------------------------------------- 1 | class SessionsController < ApplicationController 2 | def new 3 | end 4 | 5 | def create 6 | user = User.find_by_email(params[:email]) 7 | if user && user.authenticate(params[:password]) 8 | session[:user_id] = user.id 9 | redirect_to admin_url, notice: "Logged in!" 10 | else 11 | flash.now.alert = "Email or password is invalid" 12 | render "new" 13 | end 14 | end 15 | 16 | def destroy 17 | session[:user_id] = nil 18 | redirect_to root_url, notice: "Logged out!" 19 | end 20 | end 21 | -------------------------------------------------------------------------------- /config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new inflection rules using the following format 4 | # (all these examples are active by default): 5 | # ActiveSupport::Inflector.inflections do |inflect| 6 | # inflect.plural /^(ox)$/i, '\1en' 7 | # inflect.singular /^(ox)en/i, '\1' 8 | # inflect.irregular 'person', 'people' 9 | # inflect.uncountable %w( fish sheep ) 10 | # end 11 | # 12 | # These inflection rules are supported but not enabled by default: 13 | # ActiveSupport::Inflector.inflections do |inflect| 14 | # inflect.acronym 'RESTful' 15 | # end 16 | -------------------------------------------------------------------------------- /app/assets/stylesheets/application.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This is a manifest file that'll be compiled into application.css, which will include all the files 3 | * listed below. 4 | * 5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, 6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path. 7 | * 8 | * You're free to add application-wide styles to this file and they'll appear at the top of the 9 | * compiled file, but it's generally better to create a new file per style scope. 10 | * 11 | *= require_self 12 | *= require_tree . 13 | */ 14 | -------------------------------------------------------------------------------- /config/database.yml: -------------------------------------------------------------------------------- 1 | # SQLite version 3.x 2 | # gem install sqlite3 3 | # 4 | # Ensure the SQLite 3 gem is defined in your Gemfile 5 | # gem 'sqlite3' 6 | development: 7 | adapter: sqlite3 8 | database: db/development.sqlite3 9 | pool: 5 10 | timeout: 5000 11 | 12 | # Warning: The database defined as "test" will be erased and 13 | # re-generated from your development database when you run "rake". 14 | # Do not set this db to the same as development or production. 15 | test: 16 | adapter: sqlite3 17 | database: db/test.sqlite3 18 | pool: 5 19 | timeout: 5000 20 | 21 | production: 22 | adapter: sqlite3 23 | database: db/production.sqlite3 24 | pool: 5 25 | timeout: 5000 26 | -------------------------------------------------------------------------------- /app/views/admin/articles/index.html.erb: -------------------------------------------------------------------------------- 1 |

Listing articles

2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | <% @articles.each do |article| %> 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | <% end %> 21 |
NameBody
<%= article.name %><%= article.body %><%= link_to 'Show', admin_article_path(article) %><%= link_to 'Edit', edit_admin_article_path(article) %><%= link_to 'Destroy', admin_article_path(article), method: :delete, data: { confirm: 'Are you sure?' } %>
22 | 23 |
24 | 25 | <%= link_to 'New Article', new_admin_article_path %> 26 | -------------------------------------------------------------------------------- /app/assets/javascripts/application.js: -------------------------------------------------------------------------------- 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 . 16 | -------------------------------------------------------------------------------- /app/views/admin/articles/_form.html.erb: -------------------------------------------------------------------------------- 1 | <%= form_for([:admin,@article]) do |f| %> 2 | <% if @article.errors.any? %> 3 |
4 |

<%= pluralize(@article.errors.count, "error") %> prohibited this article from being saved:

5 | 6 | 11 |
12 | <% end %> 13 | 14 |
15 | <%= f.label :name %>
16 | <%= f.text_field :name %> 17 |
18 |
19 | <%= f.label :body %>
20 | <%= f.text_area :body %> 21 |
22 |
23 | <%= f.submit %> 24 |
25 | <% end %> 26 | -------------------------------------------------------------------------------- /app/controllers/admin/users_controller.rb: -------------------------------------------------------------------------------- 1 | class Admin::UsersController < ApplicationController 2 | 3 | before_filter :authorize 4 | 5 | def index 6 | @users = User.all 7 | end 8 | 9 | def new 10 | @user = User.new 11 | end 12 | 13 | def create 14 | @user = User.new(params[:user]) 15 | 16 | respond_to do |format| 17 | if @user.save 18 | format.html { redirect_to admin_users_url, notice: 'User was successfully created.' } 19 | format.json { render json: @user, status: :created, location: [:admin,@user] } 20 | else 21 | format.html { render action: "new" } 22 | format.json { render json: @user.errors, status: :unprocessable_entity } 23 | end 24 | end 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

We're sorry, but something went wrong.

23 |
24 | 25 | 26 | -------------------------------------------------------------------------------- /spec/controllers/admin/dashboard_controller_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe Admin::DashboardController do 4 | 5 | describe 'user access' do 6 | 7 | describe "GET 'index'" do 8 | it "returns http success" do 9 | user = User.create( 10 | email: 'admin@example.com', 11 | password: 'secret', 12 | password_confirmation: 'secret' 13 | ) 14 | session[:user_id] = user 15 | 16 | get 'index' 17 | response.should be_success 18 | end 19 | end 20 | end 21 | 22 | describe 'non-user access' do 23 | describe "GET 'index'" do 24 | it "redirects to the login form" do 25 | get 'index' 26 | response.should redirect_to login_url 27 | end 28 | end 29 | end 30 | end 31 | -------------------------------------------------------------------------------- /public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The change you wanted was rejected.

23 |

Maybe you tried to change something you didn't have access to.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The page you were looking for doesn't exist.

23 |

You may have mistyped the address or the page may have moved.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /app/views/admin/users/new.html.erb: -------------------------------------------------------------------------------- 1 |

New user

2 | 3 | <%= form_for([:admin,@user]) do |f| %> 4 | <% if @user.errors.any? %> 5 |
6 |

<%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:

7 | 8 | 13 |
14 | <% end %> 15 | 16 |
17 | <%= f.label :email %>
18 | <%= f.text_field :email %> 19 |
20 |
21 | <%= f.label :password %>
22 | <%= f.password_field :password %> 23 |
24 |
25 | <%= f.label :password_confirmation %>
26 | <%= f.password_field :password_confirmation %> 27 |
28 |
29 | <%= f.submit %> 30 |
31 | <% end %> 32 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2012 Aaron Sumner 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. -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'rails', '3.2.6' 4 | 5 | # Bundle edge Rails instead: 6 | # gem 'rails', :git => 'git://github.com/rails/rails.git' 7 | 8 | gem 'sqlite3' 9 | 10 | 11 | # Gems used only for assets and not required 12 | # in production environments by default. 13 | group :assets do 14 | gem 'sass-rails', '~> 3.2.3' 15 | gem 'coffee-rails', '~> 3.2.1' 16 | 17 | # See https://github.com/sstephenson/execjs#readme for more supported runtimes 18 | # gem 'therubyracer', :platforms => :ruby 19 | 20 | gem 'uglifier', '>= 1.0.3' 21 | end 22 | 23 | gem 'jquery-rails' 24 | 25 | group :development, :test do 26 | gem 'rspec-rails', '~> 2.11.0' 27 | gem 'factory_girl_rails', '~> 3.5.0' 28 | gem 'capybara', '~> 1.1.2' 29 | gem 'guard-rspec', '~> 1.2.0' 30 | end 31 | 32 | # To use ActiveModel has_secure_password 33 | gem 'bcrypt-ruby', '~> 3.0.0' 34 | 35 | # To use Jbuilder templates for JSON 36 | # gem 'jbuilder' 37 | 38 | # Use unicorn as the app server 39 | # gem 'unicorn' 40 | 41 | # Deploy with Capistrano 42 | # gem 'capistrano' 43 | 44 | # To use debugger 45 | # gem 'debugger' 46 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rails administration dashboard example 2 | 3 | A roll-your-own alternative to admin gems for Rails applications, using RSpec request specs for some basic BDD goodness. 4 | 5 | The source is best viewed successively by branch: 6 | 7 | * the `dashboard` branch shows how to make a basic, namespaced administration dashboard (see http://everydayrails.com/2012/07/31/rails-admin-panel-from-scratch.html) 8 | * the `scaffold` branch builds off of `dashboard`, taking source that was generated by a Rails scaffold and moving it into the `admin` namespace (see http://everydayrails.com/2012/08/07/rails-admin-panel-from-scratch-2.html) 9 | * the `resource` branch shows how to add non-scaffolded code directly to the namespace to manage an ActiveRecord resource (see http://everydayrails.com/2012/08/19/rails-admin-panel-from-scratch-3.html) 10 | * `master` contains the completed project (basically the same as `resource` except this `README`) 11 | 12 | ## To get started 13 | 14 | Written with Ruby 1.9.3. 15 | 16 | Clone the repository, then 17 | 18 | cd admin_demo 19 | bundle 20 | rake db:create 21 | rake db:migrate 22 | rake db:setup 23 | rake db:test:prepare 24 | guard (or however you want to run the specs) -------------------------------------------------------------------------------- /Guardfile: -------------------------------------------------------------------------------- 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(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" } 11 | watch(%r{^app/(.*)(\.erb|\.haml)$}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" } 12 | 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/acceptance/#{m[1]}_spec.rb"] } 13 | watch(%r{^spec/support/(.+)\.rb$}) { "spec" } 14 | # watch('config/routes.rb') { "spec/routing" } 15 | watch('app/controllers/application_controller.rb') { "spec/controllers" } 16 | 17 | # Capybara request specs 18 | watch(%r{^app/views/(.+)/.*\.(erb|haml)$}) { |m| "spec/requests/#{m[1]}_spec.rb" } 19 | 20 | # Turnip features and steps 21 | # watch(%r{^spec/acceptance/(.+)\.feature$}) 22 | # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' } 23 | end 24 | 25 | -------------------------------------------------------------------------------- /app/assets/stylesheets/scaffolds.css.scss: -------------------------------------------------------------------------------- 1 | body { 2 | background-color: #fff; 3 | color: #333; 4 | font-family: verdana, arial, helvetica, sans-serif; 5 | font-size: 13px; 6 | line-height: 18px; } 7 | 8 | p, ol, ul, td { 9 | font-family: verdana, arial, helvetica, sans-serif; 10 | font-size: 13px; 11 | line-height: 18px; } 12 | 13 | pre { 14 | background-color: #eee; 15 | padding: 10px; 16 | font-size: 11px; } 17 | 18 | a { 19 | color: #000; 20 | &:visited { 21 | color: #666; } 22 | &:hover { 23 | color: #fff; 24 | background-color: #000; } } 25 | 26 | div { 27 | &.field, &.actions { 28 | margin-bottom: 10px; } } 29 | 30 | #notice { 31 | color: green; } 32 | 33 | .field_with_errors { 34 | padding: 2px; 35 | background-color: red; 36 | display: table; } 37 | 38 | #error_explanation { 39 | width: 450px; 40 | border: 2px solid red; 41 | padding: 7px; 42 | padding-bottom: 0; 43 | margin-bottom: 20px; 44 | background-color: #f0f0f0; 45 | h2 { 46 | text-align: left; 47 | font-weight: bold; 48 | padding: 5px 5px 5px 15px; 49 | font-size: 12px; 50 | margin: -7px; 51 | margin-bottom: 0px; 52 | background-color: #c00; 53 | color: #fff; } 54 | ul li { 55 | font-size: 12px; 56 | list-style: square; } } 57 | -------------------------------------------------------------------------------- /db/schema.rb: -------------------------------------------------------------------------------- 1 | # encoding: UTF-8 2 | # This file is auto-generated from the current state of the database. Instead 3 | # of editing this file, please use the migrations feature of Active Record to 4 | # incrementally modify your database, and then regenerate this schema definition. 5 | # 6 | # Note that this schema.rb definition is the authoritative source for your 7 | # database schema. If you need to create the application database on another 8 | # system, you should be using db:schema:load, not running all the migrations 9 | # from scratch. The latter is a flawed and unsustainable approach (the more migrations 10 | # you'll amass, the slower it'll run and the greater likelihood for issues). 11 | # 12 | # It's strongly recommended to check this file into your version control system. 13 | 14 | ActiveRecord::Schema.define(:version => 20120731005603) do 15 | 16 | create_table "articles", :force => true do |t| 17 | t.string "name" 18 | t.text "body" 19 | t.datetime "created_at", :null => false 20 | t.datetime "updated_at", :null => false 21 | end 22 | 23 | create_table "users", :force => true do |t| 24 | t.string "email" 25 | t.string "password_digest" 26 | t.datetime "created_at", :null => false 27 | t.datetime "updated_at", :null => false 28 | end 29 | 30 | end 31 | -------------------------------------------------------------------------------- /config/environments/development.rb: -------------------------------------------------------------------------------- 1 | AdminDemo::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # In the development environment your application's code is reloaded on 5 | # every request. This slows down response time but is perfect for development 6 | # since you don't have to restart the web server when you make code changes. 7 | config.cache_classes = false 8 | 9 | # Log error messages when you accidentally call methods on nil. 10 | config.whiny_nils = true 11 | 12 | # Show full error reports and disable caching 13 | config.consider_all_requests_local = true 14 | config.action_controller.perform_caching = false 15 | 16 | # Don't care if the mailer can't send 17 | config.action_mailer.raise_delivery_errors = false 18 | 19 | # Print deprecation notices to the Rails logger 20 | config.active_support.deprecation = :log 21 | 22 | # Only use best-standards-support built into browsers 23 | config.action_dispatch.best_standards_support = :builtin 24 | 25 | # Raise exception on mass assignment protection for Active Record models 26 | config.active_record.mass_assignment_sanitizer = :strict 27 | 28 | # Log the query plan for queries taking more than this (works 29 | # with SQLite, MySQL, and PostgreSQL) 30 | config.active_record.auto_explain_threshold_in_seconds = 0.5 31 | 32 | # Do not compress assets 33 | config.assets.compress = false 34 | 35 | # Expands the lines which load the assets 36 | config.assets.debug = true 37 | end 38 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | # This file is copied to spec/ when you run 'rails generate rspec:install' 2 | ENV["RAILS_ENV"] ||= 'test' 3 | require File.expand_path("../../config/environment", __FILE__) 4 | require 'rspec/rails' 5 | require 'rspec/autorun' 6 | 7 | # Requires supporting ruby files with custom matchers and macros, etc, 8 | # in spec/support/ and its subdirectories. 9 | Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f} 10 | 11 | RSpec.configure do |config| 12 | # ## Mock Framework 13 | # 14 | # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line: 15 | # 16 | # config.mock_with :mocha 17 | # config.mock_with :flexmock 18 | # config.mock_with :rr 19 | 20 | # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures 21 | config.fixture_path = "#{::Rails.root}/spec/fixtures" 22 | 23 | # If you're not using ActiveRecord, or you'd prefer not to run each of your 24 | # examples within a transaction, remove the following line or assign false 25 | # instead of true. 26 | config.use_transactional_fixtures = true 27 | 28 | # If true, the base class of anonymous controllers will be inferred 29 | # automatically. This will be the default behavior in future versions of 30 | # rspec-rails. 31 | config.infer_base_class_for_anonymous_controllers = false 32 | 33 | # Run specs in random order to surface order dependencies. If you find an 34 | # order dependency and want to debug it, you can fix the order by providing 35 | # the seed, which is printed after each run. 36 | # --seed 1234 37 | config.order = "random" 38 | 39 | config.include LoginMacros 40 | end 41 | -------------------------------------------------------------------------------- /config/environments/test.rb: -------------------------------------------------------------------------------- 1 | AdminDemo::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # The test environment is used exclusively to run your application's 5 | # test suite. You never need to work with it otherwise. Remember that 6 | # your test database is "scratch space" for the test suite and is wiped 7 | # and recreated between test runs. Don't rely on the data there! 8 | config.cache_classes = true 9 | 10 | # Configure static asset server for tests with Cache-Control for performance 11 | config.serve_static_assets = true 12 | config.static_cache_control = "public, max-age=3600" 13 | 14 | # Log error messages when you accidentally call methods on nil 15 | config.whiny_nils = true 16 | 17 | # Show full error reports and disable caching 18 | config.consider_all_requests_local = true 19 | config.action_controller.perform_caching = false 20 | 21 | # Raise exceptions instead of rendering exception templates 22 | config.action_dispatch.show_exceptions = false 23 | 24 | # Disable request forgery protection in test environment 25 | config.action_controller.allow_forgery_protection = false 26 | 27 | # Tell Action Mailer not to deliver emails to the real world. 28 | # The :test delivery method accumulates sent emails in the 29 | # ActionMailer::Base.deliveries array. 30 | config.action_mailer.delivery_method = :test 31 | 32 | # Raise exception on mass assignment protection for Active Record models 33 | config.active_record.mass_assignment_sanitizer = :strict 34 | 35 | # Print deprecation notices to the stderr 36 | config.active_support.deprecation = :stderr 37 | end 38 | -------------------------------------------------------------------------------- /spec/controllers/admin/users_controller_spec.rb: -------------------------------------------------------------------------------- 1 | # This is a simplified controller spec, mainly illustrating how one might 2 | # ensure that the controller's methods are properly locked down from 3 | # unauthorized access. 4 | 5 | require 'spec_helper' 6 | 7 | describe Admin::UsersController do 8 | describe 'user access' do 9 | 10 | before :each do 11 | user = User.create( 12 | email: 'admin@example.com', 13 | password: 'secret', 14 | password_confirmation: 'secret' 15 | ) 16 | set_user_session user 17 | end 18 | 19 | describe "GET :index" do 20 | it "returns http success" do 21 | get :index 22 | response.should be_success 23 | end 24 | end 25 | 26 | describe "GET 'new" do 27 | it "returns http success" do 28 | get :new 29 | response.should be_success 30 | end 31 | end 32 | 33 | describe "POST :create" do 34 | it "adds the article" do 35 | expect{ 36 | post :create, user: FactoryGirl.attributes_for(:user) 37 | }.to change(User, :count).by(1) 38 | end 39 | end 40 | end 41 | 42 | describe 'non-user access' do 43 | describe "GET :index" do 44 | it "redirects to the login form" do 45 | get :index 46 | response.should redirect_to login_url 47 | end 48 | end 49 | 50 | describe "GET :new" do 51 | it "redirects to the login form" do 52 | get :new 53 | response.should redirect_to login_url 54 | end 55 | end 56 | 57 | describe "POST :create" do 58 | it "redirects to the login form" do 59 | post :create, article: FactoryGirl.attributes_for(:user) 60 | response.should redirect_to login_url 61 | end 62 | end 63 | end 64 | end 65 | -------------------------------------------------------------------------------- /app/controllers/admin/articles_controller.rb: -------------------------------------------------------------------------------- 1 | class Admin::ArticlesController < ApplicationController 2 | 3 | before_filter :authorize 4 | 5 | # GET /articles 6 | # GET /articles.json 7 | def index 8 | @articles = Article.all 9 | 10 | respond_to do |format| 11 | format.html # index.html.erb 12 | format.json { render json: @articles } 13 | end 14 | end 15 | 16 | # GET /articles/1 17 | # GET /articles/1.json 18 | def show 19 | @article = Article.find(params[:id]) 20 | 21 | respond_to do |format| 22 | format.html # show.html.erb 23 | format.json { render json: @article } 24 | end 25 | end 26 | 27 | # GET /articles/new 28 | # GET /articles/new.json 29 | def new 30 | @article = Article.new 31 | 32 | respond_to do |format| 33 | format.html # new.html.erb 34 | format.json { render json: @article } 35 | end 36 | end 37 | 38 | # GET /articles/1/edit 39 | def edit 40 | @article = Article.find(params[:id]) 41 | end 42 | 43 | # POST /articles 44 | # POST /articles.json 45 | def create 46 | @article = Article.new(params[:article]) 47 | 48 | respond_to do |format| 49 | if @article.save 50 | format.html { redirect_to admin_articles_url, notice: 'Article was successfully created.' } 51 | format.json { render json: @article, status: :created, location: [:admin,@article] } 52 | else 53 | format.html { render action: "new" } 54 | format.json { render json: @article.errors, status: :unprocessable_entity } 55 | end 56 | end 57 | end 58 | 59 | # PUT /articles/1 60 | # PUT /articles/1.json 61 | def update 62 | @article = Article.find(params[:id]) 63 | 64 | respond_to do |format| 65 | if @article.update_attributes(params[:article]) 66 | format.html { redirect_to admin_articles_url, notice: 'Article was successfully updated.' } 67 | format.json { head :no_content } 68 | else 69 | format.html { render action: "edit" } 70 | format.json { render json: @article.errors, status: :unprocessable_entity } 71 | end 72 | end 73 | end 74 | 75 | # DELETE /articles/1 76 | # DELETE /articles/1.json 77 | def destroy 78 | @article = Article.find(params[:id]) 79 | @article.destroy 80 | 81 | respond_to do |format| 82 | format.html { redirect_to admin_articles_url } 83 | format.json { head :no_content } 84 | end 85 | end 86 | end 87 | -------------------------------------------------------------------------------- /config/routes.rb: -------------------------------------------------------------------------------- 1 | AdminDemo::Application.routes.draw do 2 | resources :articles, only: [:index] 3 | 4 | get 'signup', to: 'users#new', as: 'signup' 5 | get 'login', to: 'sessions#new', as: 'login' 6 | get 'logout', to: 'sessions#destroy', as: 'logout' 7 | 8 | resources :users 9 | resources :sessions 10 | 11 | namespace :admin do 12 | get '', to: 'dashboard#index', as: '/' 13 | resources :articles 14 | resources :users 15 | end 16 | 17 | root to: 'articles#index' 18 | 19 | # The priority is based upon order of creation: 20 | # first created -> highest priority. 21 | 22 | # Sample of regular route: 23 | # match 'products/:id' => 'catalog#view' 24 | # Keep in mind you can assign values other than :controller and :action 25 | 26 | # Sample of named route: 27 | # match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase 28 | # This route can be invoked with purchase_url(:id => product.id) 29 | 30 | # Sample resource route (maps HTTP verbs to controller actions automatically): 31 | # resources :products 32 | 33 | # Sample resource route with options: 34 | # resources :products do 35 | # member do 36 | # get 'short' 37 | # post 'toggle' 38 | # end 39 | # 40 | # collection do 41 | # get 'sold' 42 | # end 43 | # end 44 | 45 | # Sample resource route with sub-resources: 46 | # resources :products do 47 | # resources :comments, :sales 48 | # resource :seller 49 | # end 50 | 51 | # Sample resource route with more complex sub-resources 52 | # resources :products do 53 | # resources :comments 54 | # resources :sales do 55 | # get 'recent', :on => :collection 56 | # end 57 | # end 58 | 59 | # Sample resource route within a namespace: 60 | # namespace :admin do 61 | # # Directs /admin/products/* to Admin::ProductsController 62 | # # (app/controllers/admin/products_controller.rb) 63 | # resources :products 64 | # end 65 | 66 | # You can have the root of your site routed with "root" 67 | # just remember to delete public/index.html. 68 | # root :to => 'welcome#index' 69 | 70 | # See how all your routes lay out with "rake routes" 71 | 72 | # This is a legacy wild controller route that's not recommended for RESTful applications. 73 | # Note: This route will make all actions in every controller accessible via GET requests. 74 | # match ':controller(/:action(/:id))(.:format)' 75 | end 76 | -------------------------------------------------------------------------------- /config/environments/production.rb: -------------------------------------------------------------------------------- 1 | AdminDemo::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # Code is not reloaded between requests 5 | config.cache_classes = true 6 | 7 | # Full error reports are disabled and caching is turned on 8 | config.consider_all_requests_local = false 9 | config.action_controller.perform_caching = true 10 | 11 | # Disable Rails's static asset server (Apache or nginx will already do this) 12 | config.serve_static_assets = false 13 | 14 | # Compress JavaScripts and CSS 15 | config.assets.compress = true 16 | 17 | # Don't fallback to assets pipeline if a precompiled asset is missed 18 | config.assets.compile = false 19 | 20 | # Generate digests for assets URLs 21 | config.assets.digest = true 22 | 23 | # Defaults to nil and saved in location specified by config.assets.prefix 24 | # config.assets.manifest = YOUR_PATH 25 | 26 | # Specifies the header that your server uses for sending files 27 | # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache 28 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx 29 | 30 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 31 | # config.force_ssl = true 32 | 33 | # See everything in the log (default is :info) 34 | # config.log_level = :debug 35 | 36 | # Prepend all log lines with the following tags 37 | # config.log_tags = [ :subdomain, :uuid ] 38 | 39 | # Use a different logger for distributed setups 40 | # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new) 41 | 42 | # Use a different cache store in production 43 | # config.cache_store = :mem_cache_store 44 | 45 | # Enable serving of images, stylesheets, and JavaScripts from an asset server 46 | # config.action_controller.asset_host = "http://assets.example.com" 47 | 48 | # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added) 49 | # config.assets.precompile += %w( search.js ) 50 | 51 | # Disable delivery errors, bad email addresses will be ignored 52 | # config.action_mailer.raise_delivery_errors = false 53 | 54 | # Enable threaded mode 55 | # config.threadsafe! 56 | 57 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 58 | # the I18n.default_locale when a translation can not be found) 59 | config.i18n.fallbacks = true 60 | 61 | # Send deprecation notices to registered listeners 62 | config.active_support.deprecation = :notify 63 | 64 | # Log the query plan for queries taking more than this (works 65 | # with SQLite, MySQL, and PostgreSQL) 66 | # config.active_record.auto_explain_threshold_in_seconds = 0.5 67 | end 68 | -------------------------------------------------------------------------------- /config/application.rb: -------------------------------------------------------------------------------- 1 | require File.expand_path('../boot', __FILE__) 2 | 3 | require 'rails/all' 4 | 5 | if defined?(Bundler) 6 | # If you precompile assets before deploying to production, use this line 7 | Bundler.require(*Rails.groups(:assets => %w(development test))) 8 | # If you want your assets lazily compiled in production, use this line 9 | # Bundler.require(:default, :assets, Rails.env) 10 | end 11 | 12 | module AdminDemo 13 | class Application < Rails::Application 14 | # Settings in config/environments/* take precedence over those specified here. 15 | # Application configuration should go into files in config/initializers 16 | # -- all .rb files in that directory are automatically loaded. 17 | 18 | # Custom directories with classes and modules you want to be autoloadable. 19 | # config.autoload_paths += %W(#{config.root}/extras) 20 | 21 | # Only load the plugins named here, in the order given (default is alphabetical). 22 | # :all can be used as a placeholder for all plugins not explicitly named. 23 | # config.plugins = [ :exception_notification, :ssl_requirement, :all ] 24 | 25 | # Activate observers that should always be running. 26 | # config.active_record.observers = :cacher, :garbage_collector, :forum_observer 27 | 28 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 29 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 30 | # config.time_zone = 'Central Time (US & Canada)' 31 | 32 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 33 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 34 | # config.i18n.default_locale = :de 35 | 36 | # Configure the default encoding used in templates for Ruby 1.9. 37 | config.encoding = "utf-8" 38 | 39 | # Configure sensitive parameters which will be filtered from the log file. 40 | config.filter_parameters += [:password] 41 | 42 | # Enable escaping HTML in JSON. 43 | config.active_support.escape_html_entities_in_json = true 44 | 45 | # Use SQL instead of Active Record's schema dumper when creating the database. 46 | # This is necessary if your schema can't be completely dumped by the schema dumper, 47 | # like if you have constraints or database-specific column types 48 | # config.active_record.schema_format = :sql 49 | 50 | # Enforce whitelist mode for mass assignment. 51 | # This will create an empty whitelist of attributes available for mass-assignment for all models 52 | # in your app. As such, your models will need to explicitly whitelist or blacklist accessible 53 | # parameters by using an attr_accessible or attr_protected declaration. 54 | config.active_record.whitelist_attributes = true 55 | 56 | # Enable the asset pipeline 57 | config.assets.enabled = true 58 | 59 | # Version of your assets, change this if you want to expire all your assets 60 | config.assets.version = '1.0' 61 | end 62 | end 63 | -------------------------------------------------------------------------------- /spec/controllers/admin/articles_controller_spec.rb: -------------------------------------------------------------------------------- 1 | # This is a simplified controller spec, mainly illustrating how one might 2 | # ensure that the controller's methods are properly locked down from 3 | # unauthorized access. 4 | 5 | require 'spec_helper' 6 | 7 | describe Admin::ArticlesController do 8 | describe 'user access' do 9 | 10 | before :each do 11 | user = User.create( 12 | email: 'admin@example.com', 13 | password: 'secret', 14 | password_confirmation: 'secret' 15 | ) 16 | session[:user_id] = user 17 | end 18 | 19 | describe "GET :index" do 20 | it "returns http success" do 21 | get :index 22 | response.should be_success 23 | end 24 | end 25 | 26 | describe "GET 'new" do 27 | it "returns http success" do 28 | get :new 29 | response.should be_success 30 | end 31 | end 32 | 33 | describe "POST :create" do 34 | it "adds the article" do 35 | expect{ 36 | post :create, article: FactoryGirl.attributes_for(:article) 37 | }.to change(Article, :count).by(1) 38 | end 39 | end 40 | 41 | describe "GET :edit" do 42 | it "returns http success" do 43 | get :edit, id: FactoryGirl.create(:article) 44 | response.should be_successful 45 | end 46 | end 47 | 48 | describe "PUT :update" do 49 | it "updates the article" do 50 | article = FactoryGirl.create(:article, name: 'Poor Title') 51 | put :update, id: article, 52 | article: FactoryGirl.attributes_for(:article, name: 'Better Title') 53 | article.reload 54 | article.name.should eq 'Better Title' 55 | end 56 | end 57 | 58 | describe "DELETE :destroy" do 59 | it "deletes the article" do 60 | article = FactoryGirl.create(:article) 61 | expect{ 62 | delete :destroy, id: article 63 | }.to change(Article, :count).by(-1) 64 | end 65 | end 66 | end 67 | 68 | describe 'non-user access' do 69 | describe "GET :index" do 70 | it "redirects to the login form" do 71 | get :index 72 | response.should redirect_to login_url 73 | end 74 | end 75 | 76 | describe "GET :new" do 77 | it "redirects to the login form" do 78 | get :new 79 | response.should redirect_to login_url 80 | end 81 | end 82 | 83 | describe "POST :create" do 84 | it "redirects to the login form" do 85 | post :create, article: FactoryGirl.attributes_for(:article) 86 | response.should redirect_to login_url 87 | end 88 | end 89 | 90 | describe "GET :edit" do 91 | it "redirects to the login form" do 92 | get :edit, id: FactoryGirl.create(:article) 93 | response.should redirect_to login_url 94 | end 95 | end 96 | 97 | describe "PUT :update" do 98 | it "redirects to the login form" do 99 | put :update, id: FactoryGirl.create(:article), 100 | article: FactoryGirl.attributes_for(:article) 101 | response.should redirect_to login_url 102 | end 103 | end 104 | 105 | describe "DELETE :destroy" do 106 | it "redirects to the login form" do 107 | delete :destroy, id: FactoryGirl.create(:article) 108 | response.should redirect_to login_url 109 | end 110 | end 111 | end 112 | end 113 | -------------------------------------------------------------------------------- /spec/requests/admin_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe 'site administration' do 4 | describe 'dashboard access' do 5 | it "accesses the dashboard" do 6 | FactoryGirl.create(:user, 7 | email: 'user@example.com', 8 | password: 'secret' 9 | ) 10 | 11 | visit root_path 12 | click_link 'Log In' 13 | fill_in 'Email', with: 'user@example.com' 14 | fill_in 'Password', with: 'secret' 15 | click_button 'Log In' 16 | 17 | current_path.should eq admin_path 18 | within 'h1' do 19 | page.should have_content 'Administration' 20 | end 21 | page.should have_content 'Manage Users' 22 | page.should have_content 'Manage Articles' 23 | end 24 | 25 | it "is denied access when not logged in" do 26 | visit admin_path 27 | 28 | current_path.should eq login_path 29 | within 'h1' do 30 | page.should have_content 'Please Log In' 31 | end 32 | end 33 | end 34 | 35 | describe 'article management' do 36 | before :each do 37 | user = FactoryGirl.create(:user) 38 | sign_in user 39 | end 40 | 41 | it "adds an article" do 42 | click_link 'Manage Articles' 43 | current_path.should eq admin_articles_path 44 | 45 | expect{ 46 | click_link 'New Article' 47 | fill_in 'Name', with: 'My favorite web framework' 48 | fill_in 'Body', with: 'Rails is great!' 49 | click_button 'Create Article' 50 | }.to change(Article, :count).by(1) 51 | 52 | current_path.should eq admin_articles_path 53 | page.should have_content 'My favorite web framework' 54 | end 55 | 56 | it "edits an article" do 57 | article = FactoryGirl.create(:article, 58 | name: '2 Ruby frameworks', 59 | body: 'Rails and Sinatra') 60 | 61 | click_link 'Manage Articles' 62 | click_link 'Edit' 63 | fill_in 'Name', with: 'A tale of two frameworks' 64 | fill_in 'Body', with: 'Rails and Sinatra are both very useful.' 65 | click_button 'Update Article' 66 | 67 | current_path.should eq admin_articles_path 68 | page.should have_content 'A tale of two frameworks' 69 | 70 | article.reload 71 | article.name.should eq 'A tale of two frameworks' 72 | article.body.should eq 'Rails and Sinatra are both very useful.' 73 | end 74 | 75 | it "shows an article" do 76 | article = FactoryGirl.create(:article, 77 | name: '2 testing frameworks', 78 | body: 'RSpec and MiniTest') 79 | 80 | click_link 'Manage Articles' 81 | click_link 'Show' 82 | 83 | current_path.should eq admin_article_path(article) 84 | page.should have_content '2 testing frameworks' 85 | page.should have_content 'RSpec and MiniTest' 86 | end 87 | 88 | it "deletes an article" do 89 | article = FactoryGirl.create(:article, 90 | name: '2 Ruby frameworks') 91 | 92 | click_link 'Manage Articles' 93 | 94 | expect{ 95 | click_link 'Destroy' 96 | }.to change(Article, :count).by(-1) 97 | 98 | current_path.should eq admin_articles_path 99 | page.should_not have_content '2 Ruby frameworks' 100 | end 101 | end 102 | 103 | describe 'user management' do 104 | before :each do 105 | user = FactoryGirl.create(:user) 106 | sign_in user 107 | end 108 | 109 | it "adds a user" do 110 | click_link 'Manage Users' 111 | current_path.should eq admin_users_path 112 | 113 | expect{ 114 | click_link 'New User' 115 | fill_in 'Email', with: 'aaron@everydayrails.com' 116 | fill_in 'Password', with: 'secret' 117 | fill_in 'Password confirmation', with: 'secret' 118 | click_button 'Create User' 119 | }.to change(User, :count).by(1) 120 | 121 | current_path.should eq admin_users_path 122 | page.should have_content 'aaron@everydayrails.com' 123 | end 124 | end 125 | 126 | end -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | actionmailer (3.2.6) 5 | actionpack (= 3.2.6) 6 | mail (~> 2.4.4) 7 | actionpack (3.2.6) 8 | activemodel (= 3.2.6) 9 | activesupport (= 3.2.6) 10 | builder (~> 3.0.0) 11 | erubis (~> 2.7.0) 12 | journey (~> 1.0.1) 13 | rack (~> 1.4.0) 14 | rack-cache (~> 1.2) 15 | rack-test (~> 0.6.1) 16 | sprockets (~> 2.1.3) 17 | activemodel (3.2.6) 18 | activesupport (= 3.2.6) 19 | builder (~> 3.0.0) 20 | activerecord (3.2.6) 21 | activemodel (= 3.2.6) 22 | activesupport (= 3.2.6) 23 | arel (~> 3.0.2) 24 | tzinfo (~> 0.3.29) 25 | activeresource (3.2.6) 26 | activemodel (= 3.2.6) 27 | activesupport (= 3.2.6) 28 | activesupport (3.2.6) 29 | i18n (~> 0.6) 30 | multi_json (~> 1.0) 31 | addressable (2.3.1) 32 | arel (3.0.2) 33 | bcrypt-ruby (3.0.1) 34 | builder (3.0.0) 35 | capybara (1.1.2) 36 | mime-types (>= 1.16) 37 | nokogiri (>= 1.3.3) 38 | rack (>= 1.0.0) 39 | rack-test (>= 0.5.4) 40 | selenium-webdriver (~> 2.0) 41 | xpath (~> 0.1.4) 42 | childprocess (0.3.4) 43 | ffi (~> 1.0, >= 1.0.6) 44 | coffee-rails (3.2.2) 45 | coffee-script (>= 2.2.0) 46 | railties (~> 3.2.0) 47 | coffee-script (2.2.0) 48 | coffee-script-source 49 | execjs 50 | coffee-script-source (1.3.3) 51 | diff-lcs (1.1.3) 52 | erubis (2.7.0) 53 | execjs (1.4.0) 54 | multi_json (~> 1.0) 55 | factory_girl (3.5.0) 56 | activesupport (>= 3.0.0) 57 | factory_girl_rails (3.5.0) 58 | factory_girl (~> 3.5.0) 59 | railties (>= 3.0.0) 60 | ffi (1.1.0) 61 | guard (1.2.3) 62 | listen (>= 0.4.2) 63 | thor (>= 0.14.6) 64 | guard-rspec (1.2.0) 65 | guard (>= 1.1) 66 | hike (1.2.1) 67 | i18n (0.6.0) 68 | journey (1.0.4) 69 | jquery-rails (2.0.2) 70 | railties (>= 3.2.0, < 5.0) 71 | thor (~> 0.14) 72 | json (1.7.4) 73 | libwebsocket (0.1.4) 74 | addressable 75 | listen (0.4.7) 76 | rb-fchange (~> 0.0.5) 77 | rb-fsevent (~> 0.9.1) 78 | rb-inotify (~> 0.8.8) 79 | mail (2.4.4) 80 | i18n (>= 0.4.0) 81 | mime-types (~> 1.16) 82 | treetop (~> 1.4.8) 83 | mime-types (1.19) 84 | multi_json (1.3.6) 85 | nokogiri (1.5.5) 86 | polyglot (0.3.3) 87 | rack (1.4.1) 88 | rack-cache (1.2) 89 | rack (>= 0.4) 90 | rack-ssl (1.3.2) 91 | rack 92 | rack-test (0.6.1) 93 | rack (>= 1.0) 94 | rails (3.2.6) 95 | actionmailer (= 3.2.6) 96 | actionpack (= 3.2.6) 97 | activerecord (= 3.2.6) 98 | activeresource (= 3.2.6) 99 | activesupport (= 3.2.6) 100 | bundler (~> 1.0) 101 | railties (= 3.2.6) 102 | railties (3.2.6) 103 | actionpack (= 3.2.6) 104 | activesupport (= 3.2.6) 105 | rack-ssl (~> 1.3.2) 106 | rake (>= 0.8.7) 107 | rdoc (~> 3.4) 108 | thor (>= 0.14.6, < 2.0) 109 | rake (0.9.2.2) 110 | rb-fchange (0.0.5) 111 | ffi 112 | rb-fsevent (0.9.1) 113 | rb-inotify (0.8.8) 114 | ffi (>= 0.5.0) 115 | rdoc (3.12) 116 | json (~> 1.4) 117 | rspec (2.11.0) 118 | rspec-core (~> 2.11.0) 119 | rspec-expectations (~> 2.11.0) 120 | rspec-mocks (~> 2.11.0) 121 | rspec-core (2.11.1) 122 | rspec-expectations (2.11.1) 123 | diff-lcs (~> 1.1.3) 124 | rspec-mocks (2.11.1) 125 | rspec-rails (2.11.0) 126 | actionpack (>= 3.0) 127 | activesupport (>= 3.0) 128 | railties (>= 3.0) 129 | rspec (~> 2.11.0) 130 | rubyzip (0.9.9) 131 | sass (3.1.20) 132 | sass-rails (3.2.5) 133 | railties (~> 3.2.0) 134 | sass (>= 3.1.10) 135 | tilt (~> 1.3) 136 | selenium-webdriver (2.25.0) 137 | childprocess (>= 0.2.5) 138 | libwebsocket (~> 0.1.3) 139 | multi_json (~> 1.0) 140 | rubyzip 141 | sprockets (2.1.3) 142 | hike (~> 1.2) 143 | rack (~> 1.0) 144 | tilt (~> 1.1, != 1.3.0) 145 | sqlite3 (1.3.6) 146 | thor (0.15.4) 147 | tilt (1.3.3) 148 | treetop (1.4.10) 149 | polyglot 150 | polyglot (>= 0.3.1) 151 | tzinfo (0.3.33) 152 | uglifier (1.2.6) 153 | execjs (>= 0.3.0) 154 | multi_json (~> 1.3) 155 | xpath (0.1.4) 156 | nokogiri (~> 1.3) 157 | 158 | PLATFORMS 159 | ruby 160 | 161 | DEPENDENCIES 162 | bcrypt-ruby (~> 3.0.0) 163 | capybara (~> 1.1.2) 164 | coffee-rails (~> 3.2.1) 165 | factory_girl_rails (~> 3.5.0) 166 | guard-rspec (~> 1.2.0) 167 | jquery-rails 168 | rails (= 3.2.6) 169 | rspec-rails (~> 2.11.0) 170 | sass-rails (~> 3.2.3) 171 | sqlite3 172 | uglifier (>= 1.0.3) 173 | -------------------------------------------------------------------------------- /README.rdoc: -------------------------------------------------------------------------------- 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 | rails new myapp (where myapp is the application name) 33 | 34 | 2. Change directory to myapp and start the web server: 35 | cd myapp; rails server (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 sudo gem install ruby-debug. 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 | => "[#nil, "body"=>nil, "id"=>"1"}>, 105 | #"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 | => #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 rails console from the application 129 | directory. 130 | 131 | Options: 132 | 133 | * Passing the -s, --sandbox 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: rails console production. 137 | 138 | To reload your controllers and models after launching the console run 139 | reload! 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 rails 148 | dbconsole. 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 rails dbconsole production. 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 layout :default 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 rake doc:app 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. 262 | --------------------------------------------------------------------------------