tft_rails_dbc 0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+*.gem
+Gemfile.lock
+.idea

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@rails3

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.9"
+gem "sqlite3"
+
+gem "rspec-rails", "~> 2.6.0"
+
+gemspec

data/LICENSE

@@ -0,0 +1,57 @@
+Copyright 2011 Wolfram Arnold
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This work was sponsored by Marakana.
+
+
+License and Copyright for the original RailsTutorial sources:
+
+  Copyright (c) 2010 Michael Hartl
+
+   Permission is hereby granted, free of charge, to any person
+   obtaining a copy of this software and associated documentation
+   files (the "Software"), to deal in the Software without
+   restriction, including without limitation the rights to use,
+   copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the
+   Software is furnished to do so, subject to the following
+   conditions:
+
+   The above copyright notice and this permission notice shall be
+   included in all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+   OTHER DEALINGS IN THE SOFTWARE.
+/*
+ * ------------------------------------------------------------
+ * "THE BEERWARE LICENSE" (Revision 42):
+ * Michael Hartl wrote this code. As long as you retain this
+ * notice, you can do whatever you want with this stuff. If we
+ * meet someday, and you think this stuff is worth it, you can
+ * buy me a beer in return.
+ * ------------------------------------------------------------
+ */

data/README.md

@@ -0,0 +1,90 @@
+TFT Rails
+=========
+
+This project is a series of exercises for learning Rails, based on an adaptation of Michael Hartl's [RailsTutorial],
+using the [Test-First Teaching][tft] philosophy that was originally [developed][tft_preso] by [Sarah Allen][sarah] and [Alex Chaffee][alex] and others.
+This project has been sponsored by [Marakana] and was authored by Wolfram Arnold in collaboration with Alex Chaffee.
+
+This project is a gem which provides a series of generators intended to be run on a bare-bones Rails 3 app. Each
+generator provides a new set of tests (specs) corresponding to a given chapter in [RailsTutorial] and a set of
+solutions.
+
+The project was modified by Shereef Bishay for use at [Dev Bootcamp](devbootcamp.com)
+
+Installation and Use
+--------------------
+
+To use, create a fresh Rails 3 project:
+
+    rails new sample_app
+
+Add this gem to `Gemfile`:
+
+    gem 'tft_rails_dbc'
+
+Run the first generator:
+
+    rails generate chapter07:begin
+
+Run the specs
+
+    rake spec
+
+Implement code to make the specs all pass.  To compare to the solution, or to skip ahead, run:
+
+    rails generate chapter07:solutions
+
+If you wrote your own code files that conflict with the solutions, you'll be prompted like so:
+
+        conflict  app/controllers/application_controller.rb
+        Overwrite /home/wolfram/workspace/classes/ruby_rails/iterations/sample_app_tft/app/controllers/application_controller.rb? (enter "h" for help) [Ynaqdh]
+
+Choose 'h' for a list of options, 'Y' for accepting the solution file as is, 'n' for leaving your own file in place, 'd' to view the difference between both.
+
+As a matter of best practice, you should commit your solutions to git, then run the finish generator above, accept all conflicts with 'Y' and use git tools
+to view the differences and change files selectively.
+
+Then continue to the next chapters...
+
+    rails generate chapter08_09:begin
+    rails generate chapter08_09:solutions
+    rails generate chapter10:begin
+    rails generate chapter10:solutions
+    rails generate chapter11-1:begin
+    rails generate chapter11-1:solutions
+    rails generate chapter11-2:begin
+    rails generate chapter11-2:solutions
+    rails generate chapter11-3:begin
+    rails generate chapter11-3:solutions
+    
+Note that chapters are not exactly sequential. This is because some chapters in RailsTutorial have been skipped due to
+the adaptations, see below.
+
+Adapted how?
+------------
+
+The project is based on an adaptation of [RailsTutorial]. The main difference is that the [Devise gem][devise] was used
+instead of the home-grown solution that RailsTutorial builds up. This was done for two reasons: (1) These exercises
+are designed for a 3-day course preceded by a 2-day Ruby course. There is not enough time to cover a building up an
+authentication solution from scratch, and for a general-purpose Rails class, the author views it as more important
+to provide a full sweep through many Rails features than to focus on the specific intricacies of building an
+authentication solution. (2) Authentication is a hard problem that shouldn't be taken lightly. RailsTutorial does
+a wonderful job to illustrate many concepts for teaching, but it is no replacement for an industrial strength solution
+that has been peer-reviewed by many experienced developers and is in use in many commercial applications. Devise is the
+current industry standard solution and was used here.
+
+
+Sponsors
+--------
+
+This project has been underwritten by [Marakana] and developed by Wolfram Arnold in collaboration with Alex Chaffee. It has been upgraded by Shereef Bishay
+
+[RailsTutorial]: http://railstutorial.org "Rails Tutorial"
+[tft]: http://testfirst.org/ "Test-First Teaching"
+[tft_preso]: http://www.slideshare.net/sarah.allen/test-first-teaching "TFT Presentation by Sarah Allen and Alex Chaffee"
+[sarah]: http://blazingcloud.net "Sarah Allen, Founder of Blazing Cloud"
+[alex]: http://alexch.github.com/ "Alex Chaffee"
+[shereef]: http://github.com/shereefb/ "Shereef Bishay"
+[devise]: https://github.com/plataformatec/devise "Devise on Github"
+[Marakana]: http://marakana.com "Marakana.com"
+[DevBootcamp]: http://devbootcamp.com "DevBootcamp.com"

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TftRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/chapter07/begin/USAGE

@@ -0,0 +1,27 @@
+Description:
+    Begins Test-First Teaching exercises adapted from Chapter 07 of the RailsTutorial by Michael Hartl.
+
+    Chapter 07 is the first chapter covered, because the application built herein is an adaptation from
+    RailsTutorial and uses the Devise authentication gem, rather than the home-grown solution from RailsTutorial.
+
+    It is assumed that this generator is run in an freshly-created bare-bones Rails project.
+
+    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 chapter07: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 07 of the RailsTutorial.
+
+    When you're done, and all tests pass, or you just want to skip ahead, run:
+
+    rails generate chapter07: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/chapter07/begin/begin_generator.rb

@@ -0,0 +1,39 @@
+module Chapter07
+  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, :force => true)
+      end
+
+      def insert_gitignore
+        dest = File.join(Rails.root,'.gitignore')
+        insert_into_file(dest, :before => /\Z/) do # insert before end
+          "\n.idea\n"
+        end
+      end
+
+      def augment_gemfile
+        gem 'devise'
+        gem 'gravatar_image_tag', '~> 1.0.0'
+        gem 'rspec-rails', :version => '~> 2.6.0', :group => :development
+        gem 'rspec', :version => '~> 2.6.0', :group => :test
+        gem 'webrat', :version => '~> 0.7.3', :group => :test
+        gem 'factory_girl_rails', :version => '~> 1.0', :group => :test
+      end
+
+      def generate_instructions
+        require 'rdiscount'
+        
+        instr_md = File.expand_path('../instructions.md',self.class.source_root)
+        dest = File.join(Rails.root,'doc','chapter07.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/chapter07/begin/instructions.md

@@ -0,0 +1,74 @@
+RailsTutorial Chapter 07 Test-First Teaching Instructions
+=========================================================
+
+Running Specs
+-------------
+
+See the paragraphs below for more details on each exercise.
+To run all spec files:
+
+    rake spec
+
+To run just one file, you can also run, e.g.
+
+    rspec spec/controllers/pages_controller_spec.rb
+
+Note: Before you run the specs for the very first time,
+most likely you'll need to migrate your database with:
+
+    rake db:migrate
+
+This will migrate the development database only. Your specs,
+however, will use the test database. The `rake spec` command
+automatically takes care of copying the latest schema from
+the development database to the test database, thereby
+migrating the test database as well.
+
+This is not the case for the `rspec` command. You can run
+`rake spec` once, or you can explicitly set up the test
+database with the latest schema via: `rake db:test:prepare`
+
+Static Pages
+------------
+
+The purpose of this section is completing the static pages,
+such as About, Help, Home, etc.
+
+The pages are currently in various stages of completion.
+
+For some, the controller action is present, in
+`PagesController`, for some it is missing. Some have
+view templates in `app/views/pages`, others do not.
+
+Some have route entries in `config/routes`, others do not.
+
+Run the spec, `specs/controllers/pages_controller_spec.rb`
+and watch carefully for the error message and look
+at what each spec is asserting.
+
+User Validation
+---------------
+
+Another purpose of this section are validations of the
+User model. Run `specs/models/user_spec.rb` and
+see what is failing. Review the presentation slides on
+validation of inspiration.
+
+Users Controller
+----------------
+
+This section also has tests on the `UsersController`'s
+show action. It is in charge of displaying a given
+user's info.
+
+Currently, the view template exists, but contains placeholders.
+Your task is to replace them with actual code such
+that the tests pass.
+
+Layouts
+-------
+
+Lastly, this section has tests against the navigation
+links on the layout. This deals with the application
+layout in `views/layouts/application.html.erb` and its
+associated partials.

data/lib/generators/chapter07/begin/templates/app/controllers/application_controller.rb

@@ -0,0 +1,8 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  # This tells Devise where to re-direct to after successful sign up or sign in
+  def after_sign_in_path_for(user)
+    user_path(user.id)
+  end
+end

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

@@ -0,0 +1,11 @@
+class PagesController < ApplicationController
+  def home
+  end
+
+  def contact
+  end
+
+  def about
+  end
+
+end

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

@@ -0,0 +1,3 @@
+class UsersController < ApplicationController
+
+end

data/lib/generators/chapter07/begin/templates/app/helpers/application_helper.rb

@@ -0,0 +1,12 @@
+module ApplicationHelper
+
+  def title
+    base_title = "Ruby on Rails Tutorial Sample App"
+    if @title.nil?
+      base_title
+    else
+      "#{base_title} | #{@title}"
+    end
+  end
+  
+end

data/lib/generators/chapter07/begin/templates/app/helpers/pages_helper.rb

@@ -0,0 +1,2 @@
+module PagesHelper
+end

data/lib/generators/chapter07/begin/templates/app/helpers/users_helper.rb

@@ -0,0 +1,7 @@
+module UsersHelper
+  def gravatar_for(user, options = { :size => 50 })
+    gravatar_image_tag(user.email.downcase, :alt => user.name,
+                                            :class => 'gravatar',
+                                            :gravatar => options)
+  end
+end

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

@@ -0,0 +1,9 @@
+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
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :name, :email, :password, :password_confirmation, :remember_me
+end

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

@@ -0,0 +1,9 @@
+<footer>
+  <nav class="round">
+    <ul>
+      <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/begin/templates/app/views/layouts/_header.html.erb

@@ -0,0 +1,10 @@
+<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 "Sign in", '#' %></li>
+    </ul>
+  </nav>
+</header>

data/lib/generators/chapter07/begin/templates/app/views/layouts/_stylesheets.html.erb

@@ -0,0 +1,7 @@
+<!--[if lt IE 9]>
+<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+<![endif]-->
+<%= stylesheet_link_tag 'blueprint/screen', :media => 'screen' %>
+<%= stylesheet_link_tag 'blueprint/print',  :media => 'print' %>
+<!--[if lt IE 8]><%= stylesheet_link_tag 'blueprint/ie' %><![endif]-->
+<%= stylesheet_link_tag 'custom', :media => 'screen' %>

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <%= csrf_meta_tag %>
+    <%= render 'layouts/stylesheets' %>
+  </head>
+  <body>
+    <div class="container">
+      <%= render 'layouts/header' %>
+      <section class="round">
+        <%= yield %>
+      </section>
+      <%= render 'layouts/footer' %>
+    </div>
+  </body>
+</html>

data/lib/generators/chapter07/begin/templates/app/views/pages/about.html.erb

@@ -0,0 +1,7 @@
+<h1>About Us</h1>
+<p>
+  <a href="http://railstutorial.org/">Ruby on Rails Tutorial</a>
+  is a project to make a book and screencasts to teach web development
+  with <a href="http://rubyonrails.org/">Ruby on Rails</a>. This
+  is the sample application for the tutorial.
+</p>

data/lib/generators/chapter07/begin/templates/app/views/pages/contact.html.erb

@@ -0,0 +1,5 @@
+<h1>Contact</h1>
+<p>
+  Contact Ruby on Rails Tutorial about the sample app at the
+  <a href="http://railstutorial.org/feedback">feedback page</a>.
+</p>

data/lib/generators/chapter07/begin/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!", '#', :class => "signup_button round" %>

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

@@ -0,0 +1,15 @@
+<table class="profile" summary="Profile information">
+  <tr>
+    <td class="main">
+      <h1>
+        User's gravatar image (hint: see users_helper.rb file)
+        and User's name here
+      </h1>
+    </td>
+    <td class="sidebar round">
+      <strong>Name</strong> User's name here
+      <br/>
+      <strong>URL</strong> Link to this page here
+    </td>
+  </tr>
+</table>