tft_rails 0.5.1

data/lib/generators/chapter07/solutions/USAGE

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

@@ -0,0 +1,23 @@
+module Chapter07
+  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_help_route
+
+        dest = File.join(Rails.root,'config','routes.rb')
+        insert_into_file(dest, :after => %r{/about.*:to.*pages#about.*$}) do
+          "\n  match '/help',    :to => 'pages#help'"
+        end
+      end
+
+      def remove_static_index_html_file
+        remove_file(File.join(Rails.root, 'public', 'index.html'))
+      end
+    end
+  end
+end

data/lib/generators/chapter07/solutions/templates/app/controllers/pages_controller.rb

@@ -0,0 +1,18 @@
+class PagesController < ApplicationController
+  def home
+    @title = 'Home'
+  end
+
+  def contact
+    @title = 'Contact'
+  end
+
+  def about
+    @title = 'About'
+  end
+
+  def help
+    @title = 'Help'
+  end
+
+end

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

@@ -0,0 +1,8 @@
+class UsersController < ApplicationController
+
+  def show
+    @user = User.find(params[:id])
+    @title = @user.name
+  end
+
+end

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

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

data/lib/generators/chapter07/solutions/templates/app/views/layouts/_footer.html.erb

@@ -0,0 +1,10 @@
+<footer>
+  <nav class="round">
+    <ul>
+      <li><%= link_to "About", about_path %></li>
+      <li><%= link_to "Contact", contact_path %></li>
+      <li><a href="http://news.railstutorial.org/">News</a></li>
+      <li><a href="http://www.railstutorial.org/">Rails Tutorial</a></li>
+    </ul>
+  </nav>
+</footer>

data/lib/generators/chapter07/solutions/templates/app/views/layouts/_header.html.erb

@@ -0,0 +1,11 @@
+<header>
+  <% logo = image_tag("logo.png", :alt => "Sample App", :class => "round") %>
+  <%= link_to logo, root_path %>
+  <nav class="round">
+    <ul>
+      <li><%= link_to "Home", root_path %></li>
+      <li><%= link_to "Help", help_path %></li>
+      <li><%= link_to "Sign in", '#' %></li>
+    </ul>
+  </nav>
+</header>

data/lib/generators/chapter07/solutions/templates/app/views/pages/help.html.erb

@@ -0,0 +1,4 @@
+<h1>Help Page</h1>
+<p>
+  Welcome here. Hope you find some answers...
+</p>

data/lib/generators/chapter07/solutions/templates/app/views/pages/home.html.erb

@@ -0,0 +1,7 @@
+<h1>Sample App</h1>
+<p>
+This is the home page for the
+<a href="http://railstutorial.org/">Ruby on Rails Tutorial</a>
+sample application.
+</p>
+<%= link_to "Sign up now!", signup_path, :class => "signup_button round" %>

data/lib/generators/chapter07/solutions/templates/app/views/users/show.html.erb

@@ -0,0 +1,15 @@
+<table class="profile" summary="Profile information">
+  <tr>
+    <td class="main">
+      <h1>
+        <%= gravatar_for @user %>
+        <%= @user.name %>
+      </h1>
+    </td>
+    <td class="sidebar round">
+      <strong>Name</strong> <%= @user.name %>
+      <br/>
+      <strong>URL</strong> <%= link_to user_path(@user.id), @user %>
+    </td>
+  </tr>
+</table>

data/lib/generators/chapter08_09/begin/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Begins Test-First Teaching exercises adapted from Chapter 08 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.
+
+    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 chapter08: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.
+
+    When you're done, and all tests pass, or you just want to skip ahead, run:
+
+    rails generate chapter08: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

@@ -0,0 +1,29 @@
+module Chapter08_09
+  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)
+        dest = File.join(Rails.root,'doc','chapter08.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/chapter08_09/begin/instructions.md

@@ -0,0 +1,54 @@
+RailsTutorial Chapter 08 Test-First Teaching Instructions
+=========================================================
+
+Sign up
+-------
+
+In the adapted version of RailsTutorial that we're using
+here, the user registration and user authentication tasks
+are not implemented in the application itself, but
+instead handled by a gem called [Devise](devise) that is an
+industry-standard Rails authentication solution.
+
+Devise provides its own controllers, models and views that
+are seamlessly loaded into the running appliction.
+
+Devise's native views, however, do not quite conform to our needs.
+Many tests pass out of the box, but the few that aren't give
+important clues as to how we need to customize Devise's default
+view templates.
+
+Run the server:
+
+    rails server
+
+and then browse to <http://localhost:3000/signup>. Try signing
+up. What problem do you see? What is going wrong here?
+
+This issue is replicated in the new test file for Chapter 08,
+`specs/controllers/devise/registrations_controller_08_spec.rb`.
+
+Notice how the test refers to `Devise::RegistrationsController`
+which is the controller handling registration provided by
+Devise in the gem.
+
+Even though the controller sits in Devise, we can still run
+our own test against it. This was done here.
+
+Take a look at the [Devise instructions on github](devise)
+to learn about how to customize views. That what we'll
+need to do. Hint: You'll need to run a Devise generator.
+
+Sign in
+-------
+
+Chapter 09 of RailsTutorial covers sign-in, but we cover it together with sign-up,
+because Devise provides both in one fell swoop.
+
+The Devise sign-in page meets our needs and doesn't need customizing.
+
+However, we need to work on the layout to make sure that it shows a "Sign out" link
+if a user is logged in, and a "Sign in" link only if a user is not logged in.
+
+
+[devise]: https://github.com/plataformatec/devise "Devise on github"

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

@@ -0,0 +1,49 @@
+
+/**********************/
+/* Through Chapter 08 */
+/**********************/
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+.field_with_errors {
+  margin-top: 10px;
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+.field_with_errors label {
+  color: #fff;
+}
+
+#error_explanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/lib/generators/chapter08_09/begin/templates/spec/controllers/devise/registrations_controller_08_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Devise::RegistrationsController do
+  render_views
+
+  before do
+    # The following request parameter is necessary for testing, according to:
+    # https://github.com/plataformatec/devise/wiki/How-To:-Controllers-and-Views-tests-with-Rails-3-(and-rspec)
+    request.env["devise.mapping"] = Devise.mappings[:user]
+  end
+
+  describe "GET 'new'" do
+
+    it "should be successful" do
+      get :new
+      response.should be_success
+    end
+
+    it "should have h1 tag with Sign up" do
+      get :new
+      response.should have_selector("h1", :content => "Sign up")
+    end
+
+    %w(name email password password_confirmation).each do |attr|
+      it "should have a #{attr} field" do
+        get :new
+        response.should have_selector("input[name='user[#{attr}]']")
+      end
+    end
+  end
+
+
+  describe "POST 'create'" do
+
+    describe "failure" do
+
+      before(:each) do
+        @attr = { :name => "", :email => "", :password => "",
+                  :password_confirmation => "" }
+      end
+
+      it "should not create a user" do
+        expect {
+          post :create, :user => @attr
+        }.to_not change(User, :count)
+      end
+
+      it "should render the 'new' page" do
+        post :create, :user => @attr
+        response.should render_template('new')
+      end
+
+      it "should show errors" do
+        post :create, :user => @attr
+        response.should have_selector("div#error_explanation")
+      end
+    end
+
+    describe "success" do
+
+      before(:each) do
+        @attr = { :name => "New User", :email => "user@example.com",
+                  :password => "foobar", :password_confirmation => "foobar" }
+      end
+
+      it "should create a user" do
+        expect {
+          post :create, :user => @attr
+        }.to change(User, :count).by(1)
+      end
+
+      it "should redirect to the user show page" do
+        post :create, :user => @attr
+        response.should redirect_to(user_path(assigns(:user)))
+      end
+
+      it "should have a welcome message" do
+        post :create, :user => @attr
+        flash[:notice].should == "Welcome! You have signed up successfully."
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "Layout links" do
+
+  describe "when not signed in" do
+    it "should have a signin link" do
+      visit root_path
+      response.should have_selector("a", :href => signin_path,
+                                         :content => "Sign in")
+    end
+  end
+
+  describe "when signed in" do
+
+    before(:each) do
+      @user = Factory(:user)
+      visit signin_path
+      fill_in :email,    :with => @user.email
+      fill_in :password, :with => @user.password
+      click_button
+    end
+
+    it "should have a signout link" do
+      visit root_path
+      response.should have_selector("a", :href => signout_path,
+                                         :content => "Sign out")
+    end
+
+    it "should have a profile link" do
+      visit root_path
+      response.should have_selector("a", :href => user_path(@user),
+                                         :content => "Profile")
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "Users" do
+
+  describe "signup" do
+
+    describe "success" do
+
+      it "should make a new user" do
+        lambda do
+          visit signup_path
+          fill_in "Name",         :with => "Example User"
+          fill_in "Email",        :with => "user@example.com"
+          fill_in "Password",     :with => "foobar"
+          fill_in "Confirmation", :with => "foobar"
+          click_button
+          response.should render_template('users/show')
+        end.should change(User, :count).by(1)
+      end
+
+      it "should print a welcome message" do
+        visit signup_path
+        fill_in "Name",         :with => "Example User"
+        fill_in "Email",        :with => "user@example.com"
+        fill_in "Password",     :with => "foobar"
+        fill_in "Confirmation", :with => "foobar"
+        click_button
+        response.should have_selector("div.flash.notice",
+                                      :content => "Welcome! You have signed up successfully.")
+      end
+
+    end
+
+
+  end
+end

data/lib/generators/chapter08_09/solutions/USAGE

@@ -0,0 +1,18 @@
+Description:
+    Wraps up Test-First Teaching exercises adapted from Chapter 08 of the RailsTutorial by Michael Hartl.
+
+Example:
+    rails generate chapter08: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.
+
+    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/chapter08_09/solutions/solutions_generator.rb

@@ -0,0 +1,12 @@
+module Chapter08_09
+  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
+
+    end
+  end
+end

data/lib/generators/chapter08_09/solutions/templates/app/helpers/application_helper.rb

@@ -0,0 +1,16 @@
+module ApplicationHelper
+
+  def title
+    base_title = "Ruby on Rails Tutorial Sample App"
+    if @title.nil?
+      base_title
+    else
+      "#{base_title} | #{@title}"
+    end
+  end
+
+  def logo
+    image_tag("logo.png", :alt => "Sample App", :class => "round")
+  end
+  
+end

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/passwords/edit.html.erb

@@ -0,0 +1,16 @@
+<h2>Change your password</h2>
+
+<%= form_for(resource, :as => resource_name, :url => password_path(resource_name), :html => { :method => :put }) do |f| %>
+  <%= devise_error_messages! %>
+  <%= f.hidden_field :reset_password_token %>
+
+  <p><%= f.label :password, "New password" %><br />
+  <%= f.password_field :password %></p>
+
+  <p><%= f.label :password_confirmation, "Confirm new password" %><br />
+  <%= f.password_field :password_confirmation %></p>
+
+  <p><%= f.submit "Change my password" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/passwords/new.html.erb

@@ -0,0 +1,12 @@
+<h2>Forgot your password?</h2>
+
+<%= form_for(resource, :as => resource_name, :url => password_path(resource_name), :html => { :method => :post }) do |f| %>
+  <%= devise_error_messages! %>
+
+  <p><%= f.label :email %><br />
+  <%= f.email_field :email %></p>
+
+  <p><%= f.submit "Send me reset password instructions" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/registrations/_fields.html.erb

@@ -0,0 +1,16 @@
+<div class="field">
+  <%= f.label :name %><br />
+  <%= f.text_field :name %>
+</div>
+<div class="field">
+  <%= f.label :email %><br />
+  <%= f.text_field :email %>
+</div>
+<div class="field">
+  <%= f.label :password %><br />
+  <%= f.password_field :password %>
+</div>
+<div class="field">
+  <%= f.label :password_confirmation, "Confirmation" %><br />
+  <%= f.password_field :password_confirmation %>
+</div>

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/registrations/edit.html.erb

@@ -0,0 +1,28 @@
+<h1>Edit user</h1>
+
+<%= form_for(resource, :as => resource_name, :url => registration_path(resource_name)) do |f| %>
+
+  <%= devise_error_messages! %>
+  <%= render 'fields', :f => f %>
+
+  <div class="field">
+    <%= f.label :current_password %> <i>(we need your current password to confirm your changes)</i><br />
+    <%= f.password_field :current_password %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Update" %>
+  </div>
+
+<% end %>
+
+<div>
+  <%= gravatar_for @user %>
+  <a href="http://gravatar.com/emails">change</a>
+</div>
+
+<h3>Cancel my account</h3>
+
+<p>Unhappy? <%= link_to "Cancel my account", registration_path(resource_name), :confirm => "Are you sure?", :method => :delete %>.</p>
+
+<%= link_to "Back", :back %>

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/registrations/new.html.erb

@@ -0,0 +1,13 @@
+<h1>Sign up</h1>
+
+<%= form_for(resource, :as => resource_name, :url => registration_path(resource_name)) do |f| %>
+
+  <%= devise_error_messages! %>
+  <%= render 'fields', :f => f %>
+  <div class="actions">
+    <%= f.submit "Sign up" %>
+  </div>
+
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/sessions/new.html.erb

@@ -0,0 +1,17 @@
+<h2>Sign in</h2>
+
+<%= form_for(resource, :as => resource_name, :url => session_path(resource_name)) do |f| %>
+  <p><%= f.label :email %><br />
+  <%= f.email_field :email %></p>
+
+  <p><%= f.label :password %><br />
+  <%= f.password_field :password %></p>
+
+  <% if devise_mapping.rememberable? -%>
+    <p><%= f.check_box :remember_me %> <%= f.label :remember_me %></p>
+  <% end -%>
+
+  <p><%= f.submit "Sign in" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>

data/lib/generators/chapter08_09/solutions/templates/app/views/devise/shared/_links.erb

@@ -0,0 +1,25 @@
+<%- if controller_name != 'sessions' %>
+  <%= link_to "Sign in", new_session_path(resource_name) %><br />
+<% end -%>
+
+<%- if devise_mapping.registerable? && controller_name != 'registrations' %>
+  New User? <%= link_to "Sign up", new_registration_path(resource_name) %><br />
+<% end -%>
+
+<%- if devise_mapping.recoverable? && controller_name != 'passwords' %>
+  <%= link_to "Forgot your password?", new_password_path(resource_name) %><br />
+<% end -%>
+
+<%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
+  <%= link_to "Didn't receive confirmation instructions?", new_confirmation_path(resource_name) %><br />
+<% end -%>
+
+<%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
+  <%= link_to "Didn't receive unlock instructions?", new_unlock_path(resource_name) %><br />
+<% end -%>
+
+<%- if devise_mapping.omniauthable? %>
+  <%- resource_class.omniauth_providers.each do |provider| %>
+    <%= link_to "Sign in with #{provider.to_s.titleize}", omniauth_authorize_path(resource_name, provider) %><br />
+  <% end -%>
+<% end -%>

data/lib/generators/chapter08_09/solutions/templates/app/views/layouts/_header.html.erb

@@ -0,0 +1,19 @@
+<header>
+  <%= link_to logo, root_path %>
+  <nav class="round">
+    <ul>
+      <li><%= link_to "Home", root_path %></li>
+      <% if signed_in? %>
+        <li><%= link_to "Profile", user_path(current_user) %></li>
+        <li><%= link_to "Users", users_path %></li>
+        <li><%= link_to "Settings", edit_user_registration_path(current_user.id) %></li>
+      <% end %>
+      <li><%= link_to "Help", help_path %></li>
+      <% if signed_in? %>
+        <li><%= link_to "Sign out", signout_path %></li>
+      <% else %>
+        <li><%= link_to "Sign in", signin_path %></li>
+      <% end %>
+    </ul>
+  </nav>
+</header>