contour 0.9.2 → 0.9.3

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 0.9.3
+
+* Enhancements
+  * Dependency for Rails updated to 3.2.0 and OmniAuth 1.0.2
+  * Updated to use Devise 2.0.0.rc
+    * Important! Update Devise Migrations to new format! https://github.com/plataformatec/devise/wiki/How-To:-Upgrade-to-Devise-2.0-migration-schema-style
+
+* Refactoring
+  * Removed debug logging information
+
 == 0.9.2
 
 * Bug Fix
@@ -45,7 +55,7 @@
 * Enhancements
   * Added icons from gentleface.com (see LICENSE in /app/assets/images/gentleface/LICENSE)
     * You can reference icons using
-      <%= image_tag('gentleface/[16|32|48]/checkmark.png')
+      <%= image_tag('gentleface/[16|32|48]/checkmark.png') %>
     * Note: in 0.9.0 the images/contour/gentleface icons will be removed and be moved to images/gentleface
 
 == 0.8.2
@@ -66,7 +76,7 @@
       # Replace
         provider :google_apps, OpenID::Store::Filesystem.new('/tmp')
       # With
-        provider :open_id, OpenID::Store::Filesystem.new('/tmp'), :name => 'google_apps', :identifier => 'https://www.google.com/accounts/o8/id'
+        provider :open_id, OpenID::Store::Filesystem.new('/tmp'), name: 'google_apps', identifier: 'https://www.google.com/accounts/o8/id'
   * Added icons from gentleface.com (see LICENSE in /app/assets/images/contour/gentleface/LICENSE)
   * Added qTip2, http://craigsworks.com/projects/qtip2/, distributed under http://creativecommons.org/licenses/by/3.0/
 
@@ -146,7 +156,7 @@
 
 * Enhancements
   * Added warning.png image asset
-  
+
 == 0.5.2
 
 * Bug Fix
@@ -177,10 +187,10 @@
 
 * Enhancements
   * Added new image assets
-  * :target allowed as a parameter for a link in the menu, ex: :target => '_blank'
+  * :target allowed as a parameter for a link in the menu, ex: target: '_blank'
   * Added application_name_html configuration so that users can specify the html for the application name
   * :image and :image_options can now be passed to links to specify an image that appears to the right of the link
-  
+
 == 0.3.2
 
 * Bug Fix
@@ -197,7 +207,7 @@
   * Update dependencies to Devise 1.4.4, (needed for Rails 3.1.0)
   * Menu items are now rendered using html_safe
   * Links and menu items can now have a :condition parameter passed to it which is a string that can be evaluated to true or false
-    * ex: :condition => 'current_user.admin?'
+    * ex: condition: 'current_user.admin?'
 
 * Testing
   * Created limited tests for authentications controller and registrations

data/README.rdoc

@@ -7,7 +7,7 @@ Basic Rails framework files and assets for layout and authentication
 Contour can be installed from rubygems.org using:
 
   gem install contour
-  
+
 Or update your Gemfile to include:
 
   gem 'contour'
@@ -21,11 +21,11 @@ Contour depends on a config initializer. The config initializer is used to set v
 Contour uses a template to generate your application layout. You can add the following in your application_controller.rb:
 
   layout "contour/layouts/application"
-  
+
 Contour also provides a custom jquery-ui and BlueTrip CSS Framework.  To include these, add the following to your application.css manifest (after "*= require_self" and before "*= require_tree ."):
 
   *= require contour
-  
+
 Contour provides custom JavaScript.  In order to make the application layout function properly include the following at the beginning of your application.js (before "//= require_tree ." replacing "//= require jquery" and "//= require jquery_ujs"):
 
   //= require contour
@@ -39,11 +39,11 @@ In order to get registration working, you can use the modified Contour Authentic
 Make sure you have Rails 3.2.0
 
   rails -v
-  
+
   rails new blank_rails_project
-  
+
   cd blank_rails_project
-  
+
 Modify Gemfile and add
 
   gem 'contour', '~> 0.9.0'          # Basic Layout and Assets
@@ -51,56 +51,58 @@ Modify Gemfile and add
 Run Bundle install
 
   bundle install
-  
+
 Install contour files
 
   rails generate contour:install
 
-Add the following line to your app/controllers/application_controller.rb
-
-  layout "contour/layouts/application"
-
-Edit your app/assets/javascripts/application.js manifest to use Contour JavaScript (Replace jquery and jquery_ujs)
-
-  //= require contour
-
-Edit your app/assets/stylesheets/application.css manifest to use Contour CSS (after self, before tree)
-
-  *= require contour
-
-Remove any scaffold.css files that exist in your application
-
 Add the authentication model
 
   rails generate model Authentication user_id:integer provider:string uid:string
 
-Add first_name and last_name to user model  
+Add first_name and last_name to user model
 
   rails generate migration AddFirstNameAndLastNameToUsers first_name:string last_name:string
 
 Migrate your database
 
   bundle exec rake db:create
-  
+
   bundle exec rake db:migrate
 
+Create a sample controller
+
+  rails generate controller welcome index
+
+Remove any scaffold.css files that may exist in your application
+
+  rm app/assets/stylesheets/scaffold.css*
+
 Remove the public/index.html
 
   rm public/index.html
-  
-Create a sample controller
 
-  rails generate controller welcome index
-  
-Create a root in your config/routes.rb
+Add the following line to your app/controllers/application_controller.rb
 
-  root to: 'welcome#index'
+  layout "contour/layouts/application"
+
+Edit your app/assets/javascripts/application.js manifest to use Contour JavaScript (Replace jquery and jquery_ujs)
+
+  //= require contour
+
+Edit your app/assets/stylesheets/application.css manifest to use Contour CSS (after self, before tree)
+
+  *= require contour
 
 Make sure the devise line in config/routes.rb looks as follows
 
   devise_for :users, controllers: { registrations: 'contour/registrations', sessions: 'contour/sessions', passwords: 'contour/passwords' }, path_names: { sign_up: 'register', sign_in: 'login' }
 
-If there is a line that just says 'devise_for :users' or a duplicate, remove it
+<b>If there is a line that just says 'devise_for :users' or a duplicate, <i>REMOVE IT!</i></b>
+
+Create a root in your config/routes.rb
+
+  root to: 'welcome#index'
 
 Add the following to your app/models/user.rb
 
@@ -123,7 +125,7 @@ Add the following to your app/models/user.rb
       self.first_name = omniauth['info']['first_name'] if first_name.blank?
       self.last_name = omniauth['info']['last_name'] if last_name.blank?
     end
-    authentications.build(:provider => omniauth['provider'], :uid => omniauth['uid'])
+    authentications.build( provider: omniauth['provider'], uid: omniauth['uid'] )
   end
 
   def password_required?
@@ -143,15 +145,15 @@ Edit config/initializers/devise.rb to use :get for devise sign_out_via
   # The default HTTP method used to sign out a resource. Default is :delete.
   config.sign_out_via = :get
 
-Start your server and navigate to localhost:3000/users/login
+Start your server and navigate to http://localhost:3000/users/login
 
   rails s
-  
-You can then sign in using your google account (click on the google link), or by registering for an account at localhost:3000/users/register
+
+You can then sign in using your {Google Account}[http://localhost:3000/auth/google_apps?domain=gmail.com] or by registering for an account at http://localhost:3000/users/register
 
 
 == Contributing to contour
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -162,5 +164,5 @@ You can then sign in using your google account (click on the google link), or by
 
 == Copyright
 
-Copyright (c) 2012 Remo Mueller. See LICENSE for further details.
+Copyright (c) 2012 Remo Mueller. See {LICENSE}[https://github.com/remomueller/contour/blob/master/LICENSE] for further details.
 

data/Rakefile

@@ -38,4 +38,4 @@ Rake::TestTask.new(:test) do |t|
 end
 
 
-task :default => :test
+task default: :test

data/app/controllers/contour/authentications_controller.rb

@@ -12,15 +12,10 @@ class Contour::AuthenticationsController < ApplicationController
   end
 
   def create
-    logger.info "request #{request.env["omniauth.auth"].inspect}"
     omniauth = request.env["omniauth.auth"]
-    logger.info "omniauth: #{omniauth.inspect}"
-    
     if omniauth
-    
       omniauth['uid'] = omniauth['info']['email'] if omniauth['provider'] == 'google_apps' and omniauth['info']
       authentication = Authentication.find_by_provider_and_uid(omniauth['provider'], omniauth['uid'])
-      logger.info "OMNI AUTH INFO: #{omniauth.inspect}"
       omniauth['info']['email'] = omniauth['extra']['raw_info']['email'] if omniauth['info'] and omniauth['info']['email'].blank? and omniauth['extra'] and omniauth['extra']['raw_info']
       if authentication
         logger.info "Existing authentication found."
@@ -44,14 +39,9 @@ class Contour::AuthenticationsController < ApplicationController
           redirect_to new_user_registration_path
         end
       end
-
     else
-      request.env.keys.each do |key|
-        logger.info "request.env[#{key}]: #{request.env[key]}"
-      end
       redirect_to authentications_path, alert: "Authentication not successful."
     end
-    
   end
 
   def destroy

data/app/controllers/contour/registrations_controller.rb

@@ -1,6 +1,6 @@
 class Contour::RegistrationsController < Devise::RegistrationsController
-  prepend_before_filter :require_no_authentication, :only => [ :new ]
-  
+  prepend_before_filter :require_no_authentication, only: [ :new ]
+
   def create
     if user_signed_in?
       params[:user][:password] = params[:user][:password_confirmation] = Digest::SHA1.hexdigest(Time.now.usec.to_s)[0..19]
@@ -9,18 +9,18 @@ class Contour::RegistrationsController < Devise::RegistrationsController
         [:pp_committee, :pp_committee_secretary, :steering_committee, :steering_committee_secretary, :system_admin, :status].each do |attribute|
           @user.update_attribute attribute, params[:user][attribute]
         end
-        redirect_to(@user, :notice => 'User was successfully created.')
+        redirect_to @user, notice: 'User was successfully created.'
       else
-        render :action => "/users/new"
+        render action: "/users/new"
       end
     else
       super
       session[:omniauth] = nil unless @user.new_record?
     end
   end
-    
+
   private
-  
+
   def build_resource(*args)
     super
     if session[:omniauth]
@@ -28,9 +28,9 @@ class Contour::RegistrationsController < Devise::RegistrationsController
       @user.valid?
     end
   end
-  
+
   def after_inactive_sign_up_path_for(resource)
     new_session_path(resource) # root_path
   end
-  
+
 end

data/app/controllers/contour/sessions_controller.rb

@@ -2,12 +2,12 @@ require 'rss/2.0'
 require 'open-uri'
 
 class Contour::SessionsController < Devise::SessionsController
-  
+
   def new
     @news_feed = ''
     unless Contour.news_feed.blank?
       begin
-        open(Contour.news_feed, :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+        open(Contour.news_feed, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
           response = http.read
           @news_feed = RSS::Parser.parse(response, false)
         end
@@ -15,8 +15,8 @@ class Contour::SessionsController < Devise::SessionsController
         logger.info "\n\nRSS Feed #{Contour.news_feed}\nRSS Feed Error: #{e}\n\n"
       end
     end
-    
+
     super
   end
-  
+
 end

data/app/models/authentication.rb

@@ -1,6 +1,6 @@
 class Authentication < ActiveRecord::Base
   belongs_to :user
-  
+
   def provider_name
     OmniAuth.config.camelizations[provider.to_s.downcase] || provider.to_s.titleize
   end

data/app/views/contour/authentications/index.html.erb

@@ -8,10 +8,10 @@
     <div class="authentications">
       <% for authentication in @authentications %>
         <div class="authentication">
-          <%= image_tag "contour/#{authentication.provider}_32.png", :height => "32px" %>
+          <%= image_tag "contour/#{authentication.provider}_32.png", height: "32px" %>
           <div class="provider"><%= authentication.provider.titleize %></div>
           <div class="uid"><%= authentication.uid %></div>
-          <%= link_to "X", authentication, :confirm => 'Are you sure you want to remove this authentication option?', :method => :delete, :class => "remove" %>
+          <%= link_to "X", authentication, confirm: 'Are you sure you want to remove this authentication option?', method: :delete, class: "remove" %>
         </div>
       <% end %>
       <div style="clear:both"></div>
@@ -23,4 +23,4 @@
 <% end %>
 
 
-<%= render :partial => 'contour/authentications/index' %>
+<%= render partial: 'contour/authentications/index' %>

data/app/views/contour/layouts/_latest_news.html.erb

@@ -1,14 +1,14 @@
 <% unless @news_feed.blank? %>
   <fieldset>
     <legend>Latest News</legend>
-    
-    <h4><%= link_to @news_feed.channel.title, @news_feed.channel.link, :target => '_blank' %></h4>
+
+    <h4><%= link_to @news_feed.channel.title, @news_feed.channel.link, target: '_blank' %></h4>
     <br />
     <% @news_feed.items.each_with_index do |item, i| %>
       <% if i < Contour.news_feed_items.to_i %>
         <div class="field">
-          <label><%= link_to item.title, item.link, :target => '_blank' %></label><br />
-          <ul style="list-style: none"><li><%= item.description.gsub("[...]", link_to('[read more]', item.link, :target => '_blank')).html_safe %></li></ul>
+          <label><%= link_to item.title, item.link, target: '_blank' %></label><br />
+          <ul style="list-style: none"><li><%= item.description.gsub("[...]", link_to('[read more]', item.link, target: '_blank')).html_safe %></li></ul>
         </div>
       <% end %>
     <% end %>

data/app/views/contour/layouts/_menu.html.erb

@@ -7,13 +7,13 @@
   <% Contour.menu_items.each do |menu_item| %>
     <% if display.include?(menu_item[:display]) and (menu_item[:condition].blank? or eval(menu_item[:condition])) %>
       <li class="parent li_<%= menu_item[:position] %>">
-        <%= link_to_if (not menu_item[:path].blank?), (menu_item[:eval] ? eval(menu_item[:name]) : menu_item[:name].html_safe + (menu_item[:image].blank? ? '' : image_tag(menu_item[:image], menu_item[:image_options]))), eval(menu_item[:path].to_s), :class => 'noicon', :target => menu_item[:target] %>
+        <%= link_to_if (not menu_item[:path].blank?), (menu_item[:eval] ? eval(menu_item[:name]) : menu_item[:name].html_safe + (menu_item[:image].blank? ? '' : image_tag(menu_item[:image], menu_item[:image_options]))), eval(menu_item[:path].to_s), class: 'noicon', target: menu_item[:target] %>
         <% if menu_item[:links].size > 0 %>
           <ul>
           <% menu_item[:links].each do |link| %>
             <% if link[:condition].blank? or eval(link[:condition]) %>
               <% if link[:html].blank? %>
-                <li><%= link_to_if (not link[:path].blank?), (link[:eval] ? eval(link[:name]) : link[:name].html_safe + (link[:image].blank? ? '' : image_tag(link[:image], link[:image_options]))), eval(link[:path].to_s), :class => 'noicon', :target => link[:target] %></li>
+                <li><%= link_to_if (not link[:path].blank?), (link[:eval] ? eval(link[:name]) : link[:name].html_safe + (link[:image].blank? ? '' : image_tag(link[:image], link[:image_options]))), eval(link[:path].to_s), class: 'noicon', target: link[:target] %></li>
               <% else %>
                 <li><%= link[:eval] ? eval(link[:html]).html_safe : link[:html].html_safe %></li>
               <% end %>
@@ -24,5 +24,5 @@
       </li>
     <% end %>
   <% end %>
-  <%= render :partial => 'contour/authentications/menu' unless user_signed_in? %>
+  <%= render partial: 'contour/authentications/menu' unless user_signed_in? %>
 </ul>

data/app/views/contour/layouts/application.html.erb

@@ -3,7 +3,7 @@
 <head>
   <title><%= [Contour.application_name, @title].compact.join(' - ').html_safe %></title>
   <%= favicon_link_tag %>
-  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= stylesheet_link_tag    "application", media: "all" %>
   <%= javascript_include_tag "application" %>
   <%= csrf_meta_tags %>
 </head>
@@ -14,33 +14,33 @@
     <div id="version" style="position:relative;display:none">
       <span style="position:absolute;top:-15px;left:82px;font-size:0.5em;font-variant:normal" class="quiet"><%= Contour.application_version %></span>
     </div>
-    <%= image_tag(Contour.header_title_image, :alt => '', :style => 'vertical-align:middle') unless Contour.header_title_image.blank? %>
-    <%= link_to (Contour.application_name_html.blank? ? Contour.application_name : Contour.application_name_html.html_safe), root_path, :style => 'text-decoration:none;color:#404040;', :onmouseover => "$('#version').show();", :onmouseout => "$('#version').hide();" %>
+    <%= image_tag(Contour.header_title_image, alt: '', style: 'vertical-align:middle') unless Contour.header_title_image.blank? %>
+    <%= link_to (Contour.application_name_html.blank? ? Contour.application_name : Contour.application_name_html.html_safe), root_path, style: 'text-decoration:none;color:#404040;', onmouseover: "$('#version').show();", onmouseout: "$('#version').hide();" %>
   </div>
 
   <div class="container" style="position:relative">
     <div id="message">
-      <%= render :partial => 'contour/layouts/message' %>
+      <%= render partial: 'contour/layouts/message' %>
     </div>
   </div>
 
   <div id="menu" class="container shadow">
-    <%= render :partial => 'contour/layouts/menu' %>
+    <%= render partial: 'contour/layouts/menu' %>
   </div>
 
   <div id="content" class="container">
     <%= yield %>
   </div>
-  
+
   <div id="popup" style="overflow-y: hidden;">
     <div id="popup_header" style="padding: 12px;">
-      <div style="float:right;margin-right:10px; margin-top:-4px"><%= image_tag(Contour.header_title_image, :alt => '') unless Contour.header_title_image.blank?  %></div>
+      <div style="float:right;margin-right:10px; margin-top:-4px"><%= image_tag(Contour.header_title_image, alt: '') unless Contour.header_title_image.blank?  %></div>
       <a id="popup_close">x</a>
       <h1 id="popup_title"></h1>
     </div>
     <div id="popup_content"></div>
   </div>
-  
+
   <div id="background_popup"></div>
 </body>
 </html>

data/app/views/contour/passwords/edit.html.erb

@@ -1,6 +1,6 @@
 <h2>Change your password</h2>
 
-<%= form_for(resource, :as => resource_name, :url => password_path(resource_name), :html => { :method => :put }) do |f| %>
+<%= 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 %>
 
@@ -13,4 +13,4 @@
   <p><%= f.submit "Change my password" %></p>
 <% end %>
 
-<%= render :partial => "devise/shared/links" %>
+<%= render partial: "devise/shared/links" %>