tft_rails_dbc 0.1

data/lib/generators/chapter10/begin/templates/spec/controllers/users_controller_10_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe UsersController do
+  render_views
+
+  describe "GET 'index'" do
+
+    describe "for non-signed-in users" do
+      it "should deny access" do
+        get :index
+        response.should redirect_to(new_user_session_path)
+        flash[:alert].should =~ /sign in/i
+      end
+    end
+
+    describe "for signed-in users" do
+
+      before(:each) do
+        @user = Factory(:user)
+        sign_in(@user)
+
+        second = Factory(:user, :name => "Bob", :email => "another@example.com")
+        third = Factory(:user, :name => "Ben", :email => "another@example.net")
+
+        @users = [@user, second, third]
+        @users = [@user, second, third]
+        30.times do
+          @users << Factory(:user, :email => Factory.next(:email))
+        end
+      end
+
+      it "should be successful" do
+        get :index
+        response.should be_success
+      end
+
+      it "should have the right title" do
+        get :index
+        response.should render_template('index')
+      end
+
+      it "should have an element for each user" do
+        get :index
+        @users[0..2].each do |user|
+          response.should have_selector("li", :content => user.name)
+        end
+      end
+
+      it "should paginate users" do
+        get :index
+        response.should have_selector("div.pagination")
+        response.should have_selector("span.disabled", :content => "Previous")
+        response.should have_selector("a", :href => "/users?page=2",
+                                      :content => "2")
+        response.should have_selector("a", :href => "/users?page=2",
+                                      :content => "Next")
+      end
+    end
+  end
+
+  describe "DELETE 'destroy'" do
+
+    before(:each) do
+      @user = Factory(:user)
+    end
+
+    describe "as a non-signed-in user" do
+      it "should deny access" do
+        delete :destroy, :id => @user
+        response.should redirect_to(new_user_session_path)
+      end
+    end
+
+    describe "as a non-admin user" do
+      before do
+        sign_in(@user)
+      end
+
+      it "should protect the page" do
+        delete :destroy, :id => @user
+        response.should redirect_to(root_path)
+      end
+
+      it 'should not destroy the user' do
+        expect {
+          delete :destroy, :id => @user
+        }.to_not change(User,:count)
+      end
+    end
+
+    describe "as an admin user" do
+
+      before(:each) do
+        admin = Factory(:user, :email => "admin@example.com", :admin => true)
+        sign_in(admin)
+      end
+
+      it "should destroy the user" do
+        expect {
+          delete :destroy, :id => @user
+        }.to change(User, :count).by(-1)
+      end
+
+      it "should redirect to the users page" do
+        delete :destroy, :id => @user
+        response.should redirect_to(users_path)
+      end
+    end
+  end
+end

data/lib/generators/chapter10/begin/templates/spec/models/user_10_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe User do
+
+  describe "admin attribute" do
+
+    before(:each) do
+      @user = Factory(:user)
+    end
+
+    it "should respond to admin" do
+      @user.should respond_to(:admin)
+    end
+
+    it "should not be an admin by default" do
+      @user.should_not be_admin
+    end
+
+    it "should be convertible to an admin" do
+      @user.toggle!(:admin)
+      @user.should be_admin
+    end
+  end
+end

data/lib/generators/chapter10/solutions/USAGE

@@ -0,0 +1,18 @@
+Description:
+    Wraps up Test-First Teaching exercises adapted from Chapter 10 of the RailsTutorial by Michael Hartl.
+
+Example:
+    rails generate chapter10:solutions
+
+    This copies the solutions and other necessary files (e.g. images, assets, helpers, etc.) into the project
+    to conclude Chapter 10. This should make all tests pass and bring you in sync to the application at
+    the end of Chapter 10.
+
+    If you already have a solution file, you'll be prompted whether you want to overwrite your file,
+    see the difference, or keep your file.
+
+    It's a good idea to commit your changes to git, prior to running finish, in case you accidentally choose to
+    overwrite files you wanted to keep. Assuming your project is already git-controlled, you can commit changes with:
+
+    git add .
+    git commit -m "comment here explaining WHY you made the changes"

data/lib/generators/chapter10/solutions/snippets/migration_add_admin_to_users.rb

@@ -0,0 +1,9 @@
+class AddAdminToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :admin, :boolean, :default => false, :null => false
+  end
+
+  def self.down
+    remove_column :users, :admin
+  end
+end

data/lib/generators/chapter10/solutions/solutions_generator.rb

@@ -0,0 +1,32 @@
+module Chapter10
+  module Generators
+    class SolutionsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_app_tree
+        directory(self.class.source_root, Rails.root)
+      end
+
+      def add_destroy_action_to_users_resource
+        dest = File.join(Rails.root,'config','routes.rb')
+        insert_into_file(dest, :after => %r{:index,\s*:show}) do
+          ", :destroy"
+        end
+      end
+
+      def add_migration
+        found_candidate = Dir.glob(File.join(Rails.root,'db','migrate','*_admin_*')).present?
+
+        if (found_candidate &&
+            yes?("We found a migration file containing the word '_admin_'. We think you have the correct migration. Do you still way to copy the solution anyway? (yes/no)", :yellow)) \
+            or !found_candidate
+
+          src  = File.expand_path("../snippets/migration_add_admin_to_users.rb", __FILE__)
+          dest = File.join(Rails.root,'db','migrate',Time.now.strftime("%Y%m%d%H%M%S")+'_add_admin_to_users.rb')
+          copy_file(src,dest)
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/chapter10/solutions/templates/app/controllers/users_controller.rb

@@ -0,0 +1,28 @@
+class UsersController < ApplicationController
+
+  before_filter :authenticate_user!, :only => [:index, :destroy]
+  before_filter :admin_user,         :only => :destroy
+
+  def show
+    @user = User.find(params[:id])
+    @title = @user.name
+  end
+
+  def index
+    @title = "All users"
+    @users = User.paginate(:page => params[:page])
+  end
+
+  def destroy
+    User.find(params[:id]).destroy
+    flash[:notice] = "User destroyed."
+    redirect_to users_path
+  end
+
+  private
+
+  def admin_user
+    redirect_to(root_path) unless current_user.admin?
+  end
+
+end

data/lib/generators/chapter10/solutions/templates/app/views/users/_user.html.erb

@@ -0,0 +1,8 @@
+<li>
+  <%= gravatar_for user, :size => 30 %>
+  <%= link_to user.name, user %>
+  <% if current_user.admin? %>
+  | <%= link_to "delete", user, :method => :delete, :confirm => "You sure?",
+                                :title => "Delete #{user.name}" %>
+  <% end %>
+</li>

data/lib/generators/chapter10/solutions/templates/app/views/users/index.html.erb

@@ -0,0 +1,9 @@
+<h1>All users</h1>
+
+<%= will_paginate %>
+
+<ul class="users">
+  <%= render @users %>
+</ul>
+
+<%= will_paginate %>

data/lib/generators/chapter11_1/begin/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Begins Test-First Teaching exercises adapted from Chapter 11.1 of the RailsTutorial by Michael Hartl.
+
+    It is assumed that this generator is run after the exercises for all prior chapters have been completed, and the solutions are implemented.
+
+    Successive chapters are expected to be run sequentially. Each chapter's generators comes with a delta
+    to the next chapter, in two phase, the "begin" one will create tests, the "finish" one includes the solution files.
+    If all tests pass, the "finish" phase is optional.
+
+Example:
+    rails generate chapter11_1:begin
+
+    This copies new tests into the project, which are failing.
+    The student's task is to write code to make the test pass. The material covered by the tests is consistent
+    with Chapter 11.1 of the RailsTutorial, however adapted for Devise as authentication solution.
+
+    When you're done, and all tests pass, or you just want to skip ahead, run:
+
+    rails generate chapter11_1:solutions
+
+    This will copy solutions files into the application tree. If you already have a solution file,
+    you'll be prompted whether you want to overwrite your file, see the difference, or keep your file.
+
+

data/lib/generators/chapter11_1/begin/begin_generator.rb

@@ -0,0 +1,24 @@
+module Chapter11_1
+  module Generators
+    class BeginGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_app_tree
+        directory(self.class.source_root, Rails.root)
+      end
+
+      def generate_instructions
+        require 'rdiscount'
+        
+        instr_md = File.expand_path('../instructions.md',self.class.source_root)
+        return unless File.exists?(instr_md)
+        dest = File.join(Rails.root,'doc','chapter11_1.html')
+        copy_file(instr_md, dest, :force => true) do |content|
+          RDiscount.new(content).to_html
+        end
+        say_status('Note',"Now open file://#{dest} in your web browser for instructions", :cyan)
+      end
+
+    end
+  end
+end

data/lib/generators/chapter11_1/begin/instructions.md

@@ -0,0 +1,39 @@
+RailsTutorial Chapter 11.1 Test-First Teaching Instructions
+=========================================================
+
+Chapter 11.1 covers adding a Micropost model and setting up an association between
+User and Micropost.
+
+When you first run `rake spec`, you'll get an error like below and no specs will execute.
+
+    uninitialized constant Micropost (NameError)
+
+This is because we don't have this class defined yet. So, go ahead and create it using the rails generators:
+
+    rails generate model Micropost content:string user_id:integer
+
+This will generate a migration file, a model file and a spec file for Micropost. Note that for the TFT
+exercises, a spec file is already provided, and we don't need the generated spec file. So, go ahead
+and _remove:_ `spec/models/micropost_spec.rb`
+
+Add indexes to the migration file, see [Chapter 11.1.1][chapter_11_1_1]. Indices should be added for each
+column that will be used for record lookup or ordering. For instance, if we want to sort Microposts by
+creation date, then there should be an index on the `created_at` column. (Note that the `timestamps` migration
+methods created two columns, `created_at` and `updated_at`.)
+
+Then migrate the database:
+
+    rake db:migrate
+
+
+Rails Concepts Covered
+======================
+
+* Using the model generator (for Microposts)
+* Adding indexes to the database
+* Associations, has_many (dep't destroy) and belongs_to
+* Validations for format
+* Factories with associations
+* Scopes (simple, default scope), order
+
+[chapter_11_1_1]: http://ruby.railstutorial.org/chapters/user-microposts#sec:the_basic_model "RailsTutorial Chapter 11.1.1"

data/lib/generators/chapter11_1/begin/templates/lib/tasks/sample_data.rake

@@ -0,0 +1,29 @@
+namespace :db do
+  desc "Fill database with sample data"
+  task :populate => :environment do
+    Rake::Task['db:reset'].invoke
+    make_users
+  end
+end
+
+def make_users
+  admin = User.create!(:name => "Example User",
+                       :email => "example@railstutorial.org",
+                       :password => "password",
+                       :password_confirmation => "password")
+  admin.toggle!(:admin)
+  99.times do |n|
+    name = Faker::Name.name
+    email = "example-#{n+1}@railstutorial.org"
+    password = "password"
+    User.create!(:name => name,
+                 :email => email,
+                 :password => password,
+                 :password_confirmation => password)
+  end
+  User.all(:limit => 6).each do |user|
+    50.times do
+      user.microposts.create!(:content => Faker::Lorem.sentence(5))
+    end
+  end
+end

data/lib/generators/chapter11_1/begin/templates/spec/models/microposts_11_1_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Micropost do
+
+  before(:each) do
+    @user = Factory(:user)
+    @attr = { :content => "value for content" }
+  end
+
+  it "should create a new instance given valid attributes" do
+    @user.microposts.create!(@attr)
+  end
+
+  describe "user associations" do
+    
+    before(:each) do
+      @micropost = @user.microposts.create(@attr)
+    end
+
+    it "should have a user attribute" do
+      @micropost.should respond_to(:user)
+    end
+    
+    it "should have the right associated user" do
+      @micropost.user_id.should == @user.id
+      @micropost.user.should == @user
+    end
+  end
+
+  describe "validations" do
+
+    it "should require a user id" do
+      Micropost.new(@attr).should_not be_valid
+    end
+
+    it "should require nonblank content" do
+      @user.microposts.build(:content => "  ").should_not be_valid
+    end
+
+    it "should reject long content" do
+      @user.microposts.build(:content => "a" * 141).should_not be_valid
+    end
+  end
+
+end

data/lib/generators/chapter11_1/begin/templates/spec/models/user_11_1_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe User do
+
+  describe "micropost associations" do
+
+    before(:each) do
+      @user = Factory(:user)
+      @mp1 = Factory(:micropost, :user => @user, :created_at => 1.day.ago)
+      @mp2 = Factory(:micropost, :user => @user, :created_at => 1.hour.ago)
+    end
+
+    it "should have a microposts attribute" do
+      @user.should respond_to(:microposts)
+    end
+
+    it "should have the right microposts in the right order" do
+      @user.microposts.should == [@mp2, @mp1]
+    end
+
+    it "should destroy associated microposts" do
+      @user.destroy
+      [@mp1, @mp2].each do |micropost|
+        Micropost.find_by_id(micropost.id).should be_nil
+      end
+    end
+
+  end
+
+end

data/lib/generators/chapter11_1/solutions/USAGE

@@ -0,0 +1,18 @@
+Description:
+    Wraps up Test-First Teaching exercises adapted from Chapter 11.1 of the RailsTutorial by Michael Hartl.
+
+Example:
+    rails generate chapter11:solutions
+
+    This copies the solutions and other necessary files (e.g. images, assets, helpers, etc.) into the project
+    to conclude Chapter 11.1. This should make all tests pass and bring you in sync to the application at
+    the end of Chapter 11.1.
+
+    If you already have a solution file, you'll be prompted whether you want to overwrite your file,
+    see the difference, or keep your file.
+
+    It's a good idea to commit your changes to git, prior to running finish, in case you accidentally choose to
+    overwrite files you wanted to keep. Assuming your project is already git-controlled, you can commit changes with:
+
+    git add .
+    git commit -m "comment here explaining WHY you made the changes"

data/lib/generators/chapter11_1/solutions/snippets/migration_create_microposts.rb

@@ -0,0 +1,17 @@
+class CreateMicroposts < ActiveRecord::Migration
+  def self.up
+    create_table :microposts do |t|
+      t.string :content
+      t.integer :user_id
+
+      t.timestamps
+    end
+
+    add_index :microposts, :user_id
+    add_index :microposts, :created_at
+  end
+
+  def self.down
+    drop_table :microposts
+  end
+end

data/lib/generators/chapter11_1/solutions/solutions_generator.rb

@@ -0,0 +1,25 @@
+module Chapter11_1
+  module Generators
+    class SolutionsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_app_tree
+        directory(self.class.source_root, Rails.root)
+      end
+
+      def add_migration
+        found_candidate = Dir.glob(File.join(Rails.root,'db','migrate','*create_micropost*')).present?
+
+        if (found_candidate &&
+            yes?("We found a migration file containing the word '_admin_'. We think you have the correct migration. Do you still way to copy the solution anyway? (yes/no)", :yellow)) \
+            or !found_candidate
+
+          src  = File.expand_path("../snippets/migration_create_microposts.rb", __FILE__)
+          dest = File.join(Rails.root,'db','migrate',Time.now.strftime("%Y%m%d%H%M%S")+'_create_microposts.rb')
+          copy_file(src,dest)
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/chapter11_1/solutions/templates/app/models/micropost.rb

@@ -0,0 +1,10 @@
+class Micropost < ActiveRecord::Base
+
+  belongs_to :user
+
+  default_scope order('microposts.created_at DESC')
+
+  validates :user_id, :presence => true
+  validates :content, :presence => true, :length => {:maximum => 140}
+
+end

data/lib/generators/chapter11_1/solutions/templates/app/models/user.rb

@@ -0,0 +1,14 @@
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :token_authenticatable, :encryptable, :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+
+  validates :name, :presence => true, :length => { :maximum => 50 }
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :name, :email, :password, :password_confirmation, :remember_me
+
+  has_many :microposts, :dependent => :destroy
+
+end

data/lib/generators/chapter11_1/solutions/templates/spec/factories.rb

@@ -0,0 +1,16 @@
+# By using the symbol ':user', we get Factory Girl to simulate the User model.
+Factory.define :user do |user|
+  user.name                  "Michael Hartl"
+  user.email                 "mhartl@example.com"
+  user.password              "foobar"
+  user.password_confirmation "foobar"
+end
+
+Factory.sequence :email do |n|
+  "person-#{n}@example.com"
+end
+
+Factory.define :micropost do |mp|
+  mp.content "This is a new post"
+  mp.association :user
+end

data/lib/generators/chapter11_2/begin/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Begins Test-First Teaching exercises adapted from Chapter 11.2 of the RailsTutorial by Michael Hartl.
+
+    It is assumed that this generator is run after the exercises for all prior chapters have been completed, and the solutions are implemented.
+
+    Successive chapters are expected to be run sequentially. Each chapter's generators comes with a delta
+    to the next chapter, in two phase, the "begin" one will create tests, the "finish" one includes the solution files.
+    If all tests pass, the "finish" phase is optional.
+
+Example:
+    rails generate chapter11_2:begin
+
+    This copies new tests into the project, which are failing.
+    The student's task is to write code to make the test pass. The material covered by the tests is consistent
+    with Chapter 11.2 of the RailsTutorial, however adapted for Devise as authentication solution.
+
+    When you're done, and all tests pass, or you just want to skip ahead, run:
+
+    rails generate chapter11_2:solutions
+
+    This will copy solutions files into the application tree. If you already have a solution file,
+    you'll be prompted whether you want to overwrite your file, see the difference, or keep your file.
+
+

data/lib/generators/chapter11_2/begin/begin_generator.rb

@@ -0,0 +1,30 @@
+module Chapter11_2
+  module Generators
+    class BeginGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_app_tree
+        directory(self.class.source_root, Rails.root)
+      end
+
+      def insert_css
+        src  = File.expand_path("../snippets/custom.css", __FILE__)
+        dest = File.join(Rails.root,'public','stylesheets','custom.css')
+        insert_into_file(dest, File.binread(src), :before => /\Z/) # insert before end
+      end
+
+      def generate_instructions
+        require 'rdiscount'
+        
+        instr_md = File.expand_path('../instructions.md',self.class.source_root)
+        return unless File.exists?(instr_md)
+        dest = File.join(Rails.root,'doc','chapter11_2.html')
+        copy_file(instr_md, dest, :force => true) do |content|
+          RDiscount.new(content).to_html
+        end
+        say_status('Note',"Now open file://#{dest} in your web browser for instructions", :cyan)
+      end
+
+    end
+  end
+end

data/lib/generators/chapter11_2/begin/instructions.md

@@ -0,0 +1,35 @@
+RailsTutorial Chapter 11.2 Test-First Teaching Instructions
+===========================================================
+
+When you first run `rake spec`, you'll get an error like below and no specs will execute.
+
+    uninitialized constant MicropostsController (NameError)
+
+This is because we don't have this class defined yet. So, go ahead and create it using the rails generators:
+
+_Note_: **Microposts is in plural here** (Rails convention for controllers).
+
+    rails g controller Microposts --controller-specs=false --view-specs=false --helper-specs=false
+
+Note: The controller generatore (unlike the model generator), we can instruct to suppress
+the spec files.
+
+For the particular markup to make the micropost display look pretty,
+refer to Rails Tutorial [Chapter 11.2.1][chapter_11_2_1]
+
+Extra Credit
+------------
+
+Review how pagination for the users index page was done in Chapter 10.
+Apply the same technique to the microposts displayed on the user show page.
+
+Rails Concepts Covered
+======================
+
+* Using controller generator
+* Testing for instance variables in the controller
+* More association methods, :empty?, :count
+* Rendering partials by object collection
+* Time helper
+
+[chapter_11_2_1]: http://ruby.railstutorial.org/chapters/user-microposts#sec:augmenting_the_user_show_page "Chapter 11.2.1"