contour 1.0.0.beta12 → 1.0.0.rc

data/CHANGELOG.rdoc

@@ -9,6 +9,10 @@
     * Ex: <tt>config.sign_up_fields = [ { attribute: 'first_name', type: 'text_field' }, { attribute: 'last_name', type: 'text_field' } ]</tt>
   * An empty <tt>links</tt> array is no longer required when specifying a menu item without a submenu
   * Submenus are properly hidden if none of the submenu link conditions evaluate to true
+  * Added Rails scaffold generator
+    * <tt>rails generate contour:scaffold ModelName</tt>
+    * NOTE: This generator currently assumes you have a scope named current in your model. The conditions can be modified to limit only those records who are not deleted for example.
+      * <tt>scope :current, conditions: { }</tt>
 
 * Breaking Changes
   * CSS updated to use Twitter-Bootstrap

data/README.rdoc

@@ -4,11 +4,11 @@ Basic Rails framework files and assets for layout and authentication
 
 == Installation
 
-Contour can be installed from rubygems.org using:
+Contour can be installed from rubygems.org using
 
   gem install contour
 
-Or update your Gemfile to include:
+Or update your <tt>Gemfile</tt> to include
 
   gem 'contour'
 
@@ -22,7 +22,7 @@ Make sure you have Rails 3.2.3
 
   cd blank_rails_project
 
-Modify Gemfile and add
+Modify <tt>Gemfile</tt> and add
 
   gem 'contour', '~> 1.0.0'
 
@@ -48,33 +48,37 @@ Create a sample controller
 
   rails generate controller welcome index --skip-stylesheets
 
-Remove the public/index.html
+Remove the <tt>public/index.html</tt>
 
   rm public/index.html
 
-Add the following line to your app/controllers/application_controller.rb
+Add the following line to your <tt>app/controllers/application_controller.rb</tt>
 
   layout "contour/layouts/application"
 
-Edit your app/assets/javascripts/application.js manifest to use Contour JavaScript (Replace jquery and jquery_ujs)
+Edit your <tt>app/assets/javascripts/application.js</tt> 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)
+Edit your <tt>app/assets/stylesheets/application.css</tt> manifest to use Contour CSS (after self, before tree)
 
   *= require contour
 
-Make sure the devise line in config/routes.rb looks as follows
+Make sure the devise line in <tt>config/routes.rb</tt> looks as follows
 
   devise_for :users, controllers: { registrations: 'contour/registrations', sessions: 'contour/sessions', passwords: 'contour/passwords', confirmations: 'contour/confirmations', unlocks: 'contour/unlocks' }, path_names: { sign_up: 'register', sign_in: 'login' }
 
-<b>If there is a line that just says 'devise_for :users' or a duplicate, <i>REMOVE IT!</i></b>
+<b>If there is a line that just says <tt>devise_for :users</tt> or a duplicate, <i>REMOVE IT!</i></b>
 
-Create a root in your config/routes.rb
+Create a root in your <tt>config/routes.rb</tt>
 
   root to: 'welcome#index'
 
-Add the following to your app/models/user.rb
+Add the following to the top of your <tt>app/controllers/welcome_controller.rb</tt>
+
+  before_filter :authenticate_user!
+
+Add the following to your <tt>app/models/user.rb</tt>
 
   # Model Relationships
   has_many :authentications
@@ -90,7 +94,7 @@ Add the following to your app/models/user.rb
     (authentications.empty? || !password.blank?) && super
   end
 
-Add the following to your app/models/authentication.rb
+Add the following to your <tt>app/models/authentication.rb</tt>
 
   belongs_to :user
 
@@ -98,7 +102,7 @@ Add the following to your app/models/authentication.rb
     OmniAuth.config.camelizations[provider.to_s.downcase] || provider.to_s.titleize
   end
 
-Edit config/initializers/devise.rb to use :get for devise sign_out_via
+Edit <tt>config/initializers/devise.rb</tt> to use <tt>:get</tt> for devise <tt>sign_out_via</tt>
 
   # The default HTTP method used to sign out a resource. Default is :delete.
   config.sign_out_via = :get
@@ -109,8 +113,73 @@ Start your server and navigate to http://localhost:3000/users/login
 
 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
 
+== Overwrite Default Rails Scaffolding (optional)
+
+Add {Kaminari}[https://github.com/amatsuda/kaminari] gem to your <tt>Gemfile</tt>
+
+  gem 'kaminari', '~> 0.13.0'
+
+Update your gems
+
+  bundle update
+
+Create a new model using the Rails scaffold
+
+  rails g scaffold Item name:string description:text user_id:integer bought_date:date --no-stylesheets
+
+Add a current <tt>scope</tt> and <tt>belongs_to</tt> relationship to <tt>app/models/item.rb</tt>
+
+  scope :current, conditions: { }
+
+  belongs_to :user
+
+Add a current <tt>scope</tt> and <tt>has_many</tt> relationship to <tt>app/models/user.rb</tt> along with name placeholder
+
+  scope :current, conditions: { }
+
+  has_many :items
+
+  def name
+    "User ##{self.id}"
+  end
+
+Add a user resource to your <tt>config/routes.rb</tt> file
+
+  resources :users
+
+NOTE: Adding the User controller is not shown, but could be created using <tt>rails g controller Users index show edit update destroy --no-stylesheets</tt>. Remember that the <tt>new</tt> and <tt>create</tt> actions are already defined and should be left commented out.
+
+Migrate your database
+
+  bundle exec rake db:migrate
+
+Update with the Contour scaffold
+
+  rails g contour:scaffold Item
+
+When prompted to overwrite the existing files, type <tt>a</tt> for ALL.
+
+NOTE: This will overwrite all the files generated by the rails scaffold command!
+
+Go to http://localhost:3000/items to see the changes! Note, that the <tt>user_id</tt> selection now defaults to a drop down box!
+
+== Inspiration and Attribution
+
+Contour is designed to rapidly prototype Rails applications with nice default styling and a solid authentication system. The Contour code base has been influenced by existing Rails Engines architectures that are listed below. Please check them out if you are interested in seeing how Contour is put together!
+
+=== Devise
+
+{Devise}[https://github.com/plataformatec/devise] is the highly configurable authentication gem that Contour utilizes.
+
+Contour has adopted Devise's installation and configuration approach <tt>rails generate devise:install</tt> and <tt>config/intializers/devise.rb</tt>.
+
+=== Twitter Bootstrap Rails
+
+While Contour doesn't have an external dependency on the {Twitter Bootstrap Rails}[https://github.com/seyhunak/twitter-bootstrap-rails] gem, Contour does adopt the templating approach, <tt>rails generate contour:scaffold ModelName</tt>, used to overwrite the default scaffolding provided by Rails.
+
+For those interested in having better control on modifying the Twitter Bootstrap Less file and CSS, I highly recommend taking a look at Twitter Bootstrap Rails!
 
-== Contributing to contour
+== 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

data/app/assets/javascripts/contour/global.js.coffee

@@ -2,6 +2,27 @@
 @showWaiting = (element_id, text, centered) ->
   element = $(element_id)
   if element && centered
-    element.html('<br /><center><img width=\"13\" height=\"13\" src=\"' + root_url + 'assets/ajax-loader.gif\" align=\"absmiddle\" alt=\"...\" />' + text + '</center><br />')
+    element.html('<br /><center><img width=\"13\" height=\"13\" src=\"' + root_url + 'assets/contour/ajax-loader.gif\" align=\"absmiddle\" alt=\"...\" />' + text + '</center><br />')
   else if element
-    element.html('<img width=\"13\" height=\"13\" src=\"' + root_url + 'assets/ajax-loader.gif\" align=\"absmiddle\" alt=\"...\" />' + text)
+    element.html('<img width=\"13\" height=\"13\" src=\"' + root_url + 'assets/contour/ajax-loader.gif\" align=\"absmiddle\" alt=\"...\" />' + text)
+
+jQuery ->
+  $(".datepicker").datepicker
+    showOtherMonths: true
+    selectOtherMonths: true
+    changeMonth: true
+    changeYear: true
+
+  $("#ui-datepicker-div").hide()
+
+  $(document).on('click', ".pagination a, .page a, .next a, .prev a", () ->
+    return false if $(this).parent().is('.active, .disabled, .per_page')
+    $.get(this.href, null, null, "script")
+    false
+  )
+
+  $(document).on("click", ".per_page a", () ->
+    object_class = $(this).data('object')
+    $.get($("#"+object_class+"_search").attr("action"), $("#"+object_class+"_search").serialize() + "&"+object_class+"_per_page="+ $(this).data('count'), null, "script")
+    false
+  )

data/app/helpers/contour_helper.rb

@@ -1,5 +1,20 @@
-# From Twitter-Bootstrap-Rails
 module ContourHelper
+
+  def cancel
+    link_to 'Cancel', URI.parse(request.referer.to_s).path.blank? ? root_path : (URI.parse(request.referer.to_s).path), class: 'btn btn-danger'
+  end
+
+  def sort_field_helper(order, sort_field, display_name, search_form_id  = 'search_form')
+    result = ''
+    if order == sort_field
+      result = "<span class='selected'>#{display_name} #{ link_to_function('&raquo;'.html_safe, "$('#order').val('#{sort_field} DESC');$('##{search_form_id}').submit();", style: 'text-decoration:none')}</span>"
+    elsif order == sort_field + ' DESC' or order.split(' ').first != sort_field
+      result = "<span #{'class="selected"' if order == sort_field + ' DESC'}>#{display_name} #{link_to_function((order == sort_field + ' DESC' ? '&laquo;'.html_safe : '&laquo;&raquo;'.html_safe), "$('#order').val('#{sort_field}');$('##{search_form_id}').submit();", style: 'text-decoration:none')}</span>"
+    end
+    result
+  end
+
+  # From Twitter-Bootstrap-Rails
   def flash_block
     output = ''
     flash.each do |type, message|
@@ -9,6 +24,7 @@ module ContourHelper
     raw(output)
   end
 
+  # From Twitter-Bootstrap-Rails
   def flash_container(type, message)
     type = 'success' if type.to_s == 'notice'
     type = 'error' if type.to_s == 'alert'
@@ -16,4 +32,5 @@ module ContourHelper
       content_tag(:a, raw("&times;"), href: '#', class: 'close', data: { dismiss: 'alert' }) + message
     end.html_safe
   end
+
 end

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

@@ -0,0 +1,7 @@
+<div class="pagination pagination-right">
+  <ul>
+    <li class="disabled"><a href="#">Per Page</a></li>
+    <li class="active per_page"><%= link_to (defined?(per_page) and per_page ? per_page : 20), "#" %></li>
+    <% if defined?(object_count) and object_count %><li class="disabled"><a href="#">out of <%= object_count %></a></li><% end %>
+  </ul>
+</div>

data/config/initializers/devise.rb

@@ -1,32 +1,3 @@
 Devise.setup do |config|
   config.router_name = :main_app
 end
-
-module Devise
-  class FailureApp < ActionController::Metal
-
-  protected
-
-    def scope_path
-      opts  = {}
-      route = :"new_#{scope}_session_path"
-      opts[:format] = request_format unless skip_format?
-      # The 2.1.0.rc of Devise has the following line.  I've commented it out since it
-      # breaks subdomain redirects when failing to login.
-      # Until 2.1.0.rc2 is out, use the following from:
-      # https://github.com/plataformatec/devise/commit/ad0aed3ba5ab58cbe2f54b1a5bd760642c1c689c
-      # Thanks @josevalim !
-      opts[:script_name] = Rails.application.config.relative_url_root
-
-      context = send(Devise.available_router_name)
-
-      if context.respond_to?(route)
-        context.send(route, opts)
-      elsif respond_to?(:root_path)
-        root_path(opts)
-      else
-        "/"
-      end
-    end
-  end
-end

data/contour.gemspec

@@ -25,14 +25,14 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails',                   '~> 3.2.3'
   s.add_dependency 'jquery-rails',            '~> 2.0.2'
-  s.add_dependency 'devise',                  '~> 2.1.0.rc'
+  s.add_dependency 'devise',                  '~> 2.1.0'
   s.add_dependency 'omniauth',                '~> 1.1.0'
-  s.add_dependency 'omniauth-openid',         '~> 1.0.1'
-  s.add_dependency 'omniauth-ldap',           '~> 1.0.2'
-  s.add_dependency 'omniauth-twitter',        '~> 0.0.11'
+  s.add_dependency 'omniauth-cas',            '~> 0.0.7'
   s.add_dependency 'omniauth-facebook',       '~> 1.3.0'
+  s.add_dependency 'omniauth-ldap',           '~> 1.0.2'
   s.add_dependency 'omniauth-linkedin',       '~> 0.0.6'
-  s.add_dependency 'omniauth-cas',            '~> 0.0.7'
+  s.add_dependency 'omniauth-openid',         '~> 1.0.1'
+  s.add_dependency 'omniauth-twitter',        '~> 0.0.11'
 
   s.add_development_dependency "sqlite3"
 end

data/lib/contour/version.rb

@@ -3,7 +3,7 @@ module Contour
     MAJOR = 1
     MINOR = 0
     TINY = 0
-    BUILD = "beta12" # nil, "pre", "rc", "rc2"
+    BUILD = "rc" # nil, "pre", "rc", "rc2"
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

data/lib/generators/contour/install/install_generator.rb

@@ -0,0 +1,30 @@
+class Contour::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "Install default Contour Files"
+  # class_option :orm
+
+  def copy_initializer
+    template "contour.rb", "config/initializers/contour.rb"
+  end
+
+  def copy_omniauth
+    template "omniauth.rb", "config/initializers/omniauth.rb"
+  end
+
+  def install_devise
+    generate("devise:install")
+    model_name = ask("What would you like the user model to be called? [user]")
+    model_name = "user" if model_name.blank?
+    generate("devise", model_name)
+    route "devise_for :#{model_name}s, controllers: { registrations: 'contour/registrations', sessions: 'contour/sessions', passwords: 'contour/passwords', confirmations: 'contour/confirmations', unlocks: 'contour/unlocks' }, path_names: { sign_up: 'register', sign_in: 'login' }"
+  end
+
+  def show_readme
+    readme "README" if behavior == :invoke
+  end
+
+  # def copy_locale
+  #   copy_file "../../../config/locales/en.yml", "config/locales/contour.en.yml"
+  # end
+end

data/lib/generators/{templates → contour/install/templates}/README

@@ -4,25 +4,21 @@
 Contour requires some additional setup:
 
   1. Add the following line to your application_controller.rb
-  
+
        layout "contour/layouts/application"
-  
+
   2. Edit your application.js manifest to use Contour JavaScript
-  
+
        //= require contour
-  
+
   3. Edit your application.css manifest to use Contour CSS
-       
+
        *= require contour
-  
+
   4. Remove any scaffold.css files that exist in your application
-  
+
   5. Make a migration for Authentications
-  
+
        rails generate model Authentication user_id:integer provider:string uid:string
-  
-  6. Add first_name and last_name to User model
-  
-       rails generate migration AddFirstNameAndLastNameToUsers first_name:string last_name:string
-       
+
 ===============================================================================

data/lib/generators/contour/scaffold/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Installs views and controller based on the model name provided
+
+Example:
+    rails generate contour:bootstrap NAME
+
+    This will create:
+        app/controllers/NAMEs_controller.rb
+        app/views/NAMEs/_form.html.erb
+        app/views/NAMEs/_NAMEs.html.erb
+        app/views/NAMEs/edit.html.erb
+        app/views/NAMEs/index.html.erb
+        app/views/NAMEs/index.js.erb
+        app/views/NAMEs/new.html.erb
+        app/views/NAMEs/show.html.erb

data/lib/generators/contour/scaffold/scaffold_generator.rb

@@ -0,0 +1,58 @@
+require 'rails/generators'
+require 'rails/generators/generated_attribute'
+
+class Contour::ScaffoldGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :name
+
+  # "project_user"
+  def resource_name
+    name.underscore
+  end
+
+  # "ProjectUser"
+  def resource_class_name
+    resource_name.camelize
+  end
+
+  # "ProjectUsers"
+  def resource_class_name_plural
+    resource_name.camelize.pluralize
+  end
+
+  # "project_users"
+  def resource_name_plural
+    resource_name.pluralize
+  end
+
+  # "Project User"
+  def resource_title
+    resource_name.titleize
+  end
+
+  # "Project Users"
+  def resource_title_plural
+    resource_title.pluralize
+  end
+
+  def columns
+    begin
+      resource_name.camelize.constantize.columns.reject{|c| ['id', 'created_at', 'updated_at'].include?(c.name)}.collect{|c| ::Rails::Generators::GeneratedAttribute.new(c.name, c.type)}
+    rescue NoMethodError
+      []
+    end
+  end
+
+  def date_columns
+    self.columns.select{|c| c.field_type == :date_select}
+  end
+
+  def generate_views
+    ['_form.html.erb', 'new.html.erb', 'edit.html.erb', 'show.html.erb', 'index.html.erb', 'index.js.erb'].each do |view|
+      template view, "app/views/#{resource_name_plural}/#{view}"
+    end
+    template '_paginate.html.erb', "app/views/#{resource_name_plural}/_#{resource_name_plural}.html.erb"
+    template 'controller.rb', "app/controllers/#{resource_name_plural}_controller.rb"
+  end
+end