tft_rails 0.5.1 → 0.6.0

data/lib/generators/chapter08_09/begin/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Begins Test-First Teaching exercises adapted from Chapter 08 of the RailsTutorial by Michael Hartl.
+    Begins Test-First Teaching exercises adapted from Chapters 08, 09 of the RailsTutorial by Michael Hartl.
 
     It is assumed that this generator is run after the exercises for Chapter 07 have been completed, and the solutions are implemented.
 
@@ -8,15 +8,15 @@ Description:
     If all tests pass, the "finish" phase is optional.
 
 Example:
-    rails generate chapter08:begin
+    rails generate chapter08_09: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 08 of the RailsTutorial, however adapted for Devise as authentication solution.
+    with Chapters 08, 09 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 chapter08:solutions
+    rails generate chapter08_09: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/chapter08_09/begin/begin_generator.rb

@@ -17,7 +17,7 @@ module Chapter08_09
         require 'rdiscount'
         
         instr_md = File.expand_path('../instructions.md',self.class.source_root)
-        dest = File.join(Rails.root,'doc','chapter08.html')
+        dest = File.join(Rails.root,'doc','chapter08_09.html')
         copy_file(instr_md, dest, :force => true) do |content|
           RDiscount.new(content).to_html
         end

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

@@ -1,4 +1,4 @@
-RailsTutorial Chapter 08 Test-First Teaching Instructions
+RailsTutorial Chapters 08, 09 Test-First Teaching Instructions
 =========================================================
 
 Sign up

data/lib/generators/chapter08_09/begin/templates/spec/requests/users_signup_08_spec.rb

@@ -7,7 +7,7 @@ describe "Users" do
     describe "success" do
 
       it "should make a new user" do
-        lambda do
+        expect {
           visit signup_path
           fill_in "Name",         :with => "Example User"
           fill_in "Email",        :with => "user@example.com"
@@ -15,7 +15,7 @@ describe "Users" do
           fill_in "Confirmation", :with => "foobar"
           click_button
           response.should render_template('users/show')
-        end.should change(User, :count).by(1)
+        }.to change(User, :count).by(1)
       end
 
       it "should print a welcome message" do

data/lib/generators/chapter08_09/solutions/USAGE

@@ -1,12 +1,12 @@
 Description:
-    Wraps up Test-First Teaching exercises adapted from Chapter 08 of the RailsTutorial by Michael Hartl.
+    Wraps up Test-First Teaching exercises adapted from Chapters 08, 09 of the RailsTutorial by Michael Hartl.
 
 Example:
-    rails generate chapter08:solutions
+    rails generate chapter08_09:solutions
 
     This copies the solutions and other necessary files (e.g. images, assets, helpers, etc.) into the project
-    to conclude chapter 08. This should make all tests pass and bring you in sync to the application at
-    the end of chapter 08.
+    to conclude Chapters 08, 09. This should make all tests pass and bring you in sync to the application at
+    the end of Chapters 08, 09.
 
     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/chapter10/begin/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Begins Test-First Teaching exercises adapted from Chapter 10 of the RailsTutorial by Michael Hartl.
+
+    It is assumed that this generator is run after the exercises for Chapter 08, 09 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 chapter10: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 10 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 chapter10: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/chapter10/begin/begin_generator.rb

@@ -0,0 +1,41 @@
+module Chapter10
+  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 augment_gemfile
+        gem 'faker',         '~> 0.9.5'
+        gem 'will_paginate', '~> 3.0.pre2'
+      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 insert_factories
+        src  = File.expand_path("../snippets/factories.rb", __FILE__)
+        dest = File.join(Rails.root,'spec','factories.rb')
+        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','chapter10.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/chapter10/begin/instructions.md

@@ -0,0 +1,37 @@
+RailsTutorial Chapter 10 Test-First Teaching Instructions
+=========================================================
+
+These exercises are based on RailsTutorial but have been adapted
+to the user of [Devise](devise) as authentication solution. Among
+other things, Devise also provides controllers and views to edit
+the user, so that Chapter 10.1 of RailsTutorial (editing users) is being
+already taken care of. Similarly for 10.2 (access protecting of the edit
+page).
+
+Showing Users
+-------------
+
+Chapter 10.3 covers implementing an index view of users with
+pagination and using partials.
+
+It also covers restricting access to the index page to signed-in users.
+
+Devise offers a facility similar to what RailsTutorials implements.
+
+RailsTutorial implements an `authenticate` method, while Devise's
+version is `authenticate_user!`.  Either method redirects to the sign-in
+page if a given user isn't logged in.
+
+Destroying users with admin privilege
+-------------------------------------
+
+Chapter 10.4 covers adding an admin flag to the users table, to
+identify privileged administrative users.
+
+Having such admin privileges, we go on to implement a `destroy` action
+for users which, however, is only available to admin users.
+
+What are the two things we have to protect?
+
+
+[devise]: https://github.com/plataformatec/devise "Devise on github"

data/lib/generators/chapter10/begin/snippets/custom.css

@@ -0,0 +1,12 @@
+
+/**********************/
+/* Through Chapter 10 */
+/**********************/
+
+ul.users {
+  margin-top: 1em;
+}
+
+.users li {
+  list-style: none;
+}

data/lib/generators/chapter10/begin/snippets/factories.rb

@@ -0,0 +1,8 @@
+
+#--------------------
+# Added in Chapter 10
+#--------------------
+
+Factory.sequence :email do |n|
+  "person-#{n}@example.com"
+end

data/lib/generators/chapter10/begin/templates/app/views/layouts/application.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <%= csrf_meta_tag %>
+    <%= render 'layouts/stylesheets' %>
+    <%= javascript_include_tag :defaults %>
+  </head>
+  <body>
+    <div class="container">
+      <%= render 'layouts/header' %>
+      <section class="round">
+        <% flash.each do |key, value| %>
+          <div class="flash <%= key %>"><%= value %></div>
+        <% end %>
+        <%= yield %>
+      </section>
+      <%= render 'layouts/footer' %>
+    </div>
+  </body>
+</html>

data/lib/generators/chapter10/begin/templates/lib/tasks/same_data.rake

@@ -0,0 +1,24 @@
+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
+end

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

@@ -0,0 +1,101 @@
+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
+      it "should protect the page" do
+        sign_in(@user)
+        delete :destroy, :id => @user
+        response.should redirect_to(root_path)
+      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
+  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/begin/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Begins Test-First Teaching exercises adapted from Chapter 11 of the RailsTutorial by Michael Hartl.
+
+    It is assumed that this generator is run after the exercises for Chapter 10 and all prior ones 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: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 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 chapter10: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/begin/begin_generator.rb

@@ -0,0 +1,20 @@
+module Chapter11
+  module Generators
+    class BeginGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      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','chapter10.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/begin/instructions.md

@@ -0,0 +1,2 @@
+RailsTutorial Chapter 11 Test-First Teaching Instructions
+=========================================================

data/lib/generators/chapter11/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 chapter11:solutions
+
+    This copies the solutions and other necessary files (e.g. images, assets, helpers, etc.) into the project
+    to conclude Chapter 11. This should make all tests pass and bring you in sync to the application at
+    the end of Chapter 11.
+
+    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/solutions/solutions_generator.rb

@@ -0,0 +1,6 @@
+module Chapter11
+  module Generators
+    class SolutionsGenerator < Rails::Generators::Base
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: tft_rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Wolfram Arnold
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 Z
+date: 2011-07-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdiscount
@@ -104,6 +104,21 @@ files:
 - lib/generators/chapter07/solutions/templates/app/views/layouts/_header.html.erb
 - lib/generators/chapter07/solutions/templates/app/views/layouts/_footer.html.erb
 - lib/generators/chapter07/solutions/templates/app/views/users/show.html.erb
+- lib/generators/chapter10/begin/USAGE
+- lib/generators/chapter10/begin/begin_generator.rb
+- lib/generators/chapter10/begin/instructions.md
+- lib/generators/chapter10/begin/snippets/custom.css
+- lib/generators/chapter10/begin/snippets/factories.rb
+- lib/generators/chapter10/begin/templates/lib/tasks/same_data.rake
+- lib/generators/chapter10/begin/templates/spec/controllers/users_controller_10_spec.rb
+- lib/generators/chapter10/begin/templates/spec/models/user_10_spec.rb
+- lib/generators/chapter10/begin/templates/app/views/layouts/application.html.erb
+- lib/generators/chapter10/solutions/USAGE
+- lib/generators/chapter10/solutions/solutions_generator.rb
+- lib/generators/chapter10/solutions/snippets/migration_add_admin_to_users.rb
+- lib/generators/chapter10/solutions/templates/app/controllers/users_controller.rb
+- lib/generators/chapter10/solutions/templates/app/views/users/_user.html.erb
+- lib/generators/chapter10/solutions/templates/app/views/users/index.html.erb
 - lib/generators/chapter08_09/begin/USAGE
 - lib/generators/chapter08_09/begin/begin_generator.rb
 - lib/generators/chapter08_09/begin/instructions.md
@@ -123,6 +138,11 @@ files:
 - lib/generators/chapter08_09/solutions/templates/app/views/devise/passwords/new.html.erb
 - lib/generators/chapter08_09/solutions/templates/app/views/devise/passwords/edit.html.erb
 - lib/generators/chapter08_09/solutions/templates/app/views/devise/sessions/new.html.erb
+- lib/generators/chapter11/begin/USAGE
+- lib/generators/chapter11/begin/begin_generator.rb
+- lib/generators/chapter11/begin/instructions.md
+- lib/generators/chapter11/solutions/USAGE
+- lib/generators/chapter11/solutions/solutions_generator.rb
 - LICENSE
 - Rakefile
 - Gemfile