rails_layout 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8336166b138c352157298ba8261163e8ea20af3
-  data.tar.gz: 4f8a9a31cbac1f6723f7cc622f3b1e945e070280
+  metadata.gz: b969f789ec6da69a52b1751b38dd60bf183debe7
+  data.tar.gz: 87ca4674709e15dbf1c0584cc14369f12e143594
 SHA512:
-  metadata.gz: 8e4c4ea4bbf9334ff73f64485ab2aaf1865208a4ef7cd3640b07b27eefaa43c0c18aac61ac8bc77d419b83defeeb05339fa330c93d18e085158502373c936fff
-  data.tar.gz: d10ac335334a5c54169f0a8d647aa6d6b5cfcff81b0d6134ebd57ca51736225c8525d8e029bfbc8f5499f5a6f2c8ad814b5b3d409f979ebdd99e54242e279896
+  metadata.gz: b3ba2b5a7ffe88116926d04388dcf7b9b45f6aacc8a61f3c5d9286ab6bdd9d468a597e0b72b6f9963f13f757b1a4b0853213f9d2bdb04bf1d9208b879678fa96
+  data.tar.gz: a5e4e08eb9792dd36a4006250f4740bcdb9c43bdff17c9c3fa42481b7b26d654616911dcf442d935db6ec69b445d6d0973d5ce8865e9589ee287516d56bb2d31

data/CHANGELOG.textile

@@ -1,5 +1,9 @@
 h1. CHANGELOG
 
+h3. 0.5.4 November 22, 2013
+
+* support for Zurb Foundation 5.0
+
 h3. 0.5.3 November 18, 2013
 
 * better comments

data/README.textile

@@ -2,13 +2,14 @@ h1. !http://railsapps.github.io/images/rails-36x36.jpg(RailsLayout Gem)! RailsLa
 
 RailsLayout is a utility gem to use during development.
 
-It is a Rails generator that you add to your Rails application Gemfile.
-
-Use it to set up a front-end framework:
+Use it to set up your choice of front-end framework:
 
 * Twitter Bootstrap 2.3
 * Twitter Bootstrap 3.0
 * Zurb Foundation 4.0
+* Zurb Foundation 4.0
+
+Add it to your Rails application Gemfile, then use the generator.
 
 It will rename *application.css* to *application.css.scss*.
 
@@ -22,12 +23,12 @@ And modify the JavaScript asset file:
 
 It will set up a default application layout.
 
-You also get partials for
+It creates partials for:
 
 * Rails flash messages
 * navigation links
 
-Optionally, you can generate a navigation links file suitable for use with Devise (the authentication gem).
+You can also generate a navigation links file suitable for use with Devise (the authentication gem).
 
 h4. Supported Frameworks
 
@@ -37,6 +38,7 @@ You can generate layout files suitable for use with the following front-end fram
 * @bootstrap2@ - Twitter Bootstrap 2.3
 * @bootstrap3@ - Twitter Bootstrap 3.0
 * @foundation4@ - Zurb Foundation 4.0
+* @foundation5@ - Zurb Foundation 5.0
 * @none@ - removes all changes
 
 h4. Generated Files
@@ -56,12 +58,12 @@ h4. Note About the Navigation Partials
 
 Two navigation partials are created:
 
-* app/views/layouts/_navigation.html.erb
 * app/views/layouts/_navigation_links.html.erb
+* app/views/layouts/_navigation.html.erb
 
-The first file exists to isolate framework-specific styling.
+The first file contains no framework-specific styling. It is only a list of links. You can add additional links to this file as needed.
 
-The second file contains no framework-specific styling. It is only a list of links. You can add additional links to this file as needed.
+The second file contains framework-specific styling.
 
 h4. Support for ERB or Haml
 
@@ -73,9 +75,9 @@ h4. Rails Composer
 
 The "Rails Composer":http://railsapps.github.io/rails-composer/ tool, an application template used to create starter applications, uses the RailsLayout gem to generate the layout files used in various starter applications. You can use Rails Composer to generate entire applications.
 
-h2. Usage Example
+h4. Usage Example
 
-To see how the generated files from the RailsLayout gem are used, see the "Learn Rails":https://github.com/RailsApps/learn-rails example application that is described in the book "Learn Ruby on Rails":http://learn-rails.com/learn-ruby-on-rails.html.
+Look at the "Learn Rails":https://github.com/RailsApps/learn-rails example application to see how the generated files from the RailsLayout gem are used. You'll find details about the example application in the book "Learn Ruby on Rails":http://learn-rails.com/learn-ruby-on-rails.html.
 
 !http://railsapps.github.io/images/learn-rails-cover-130x161.jpg(Learn Ruby on Rails)!:http://learn-rails.com/learn-ruby-on-rails.html
 
@@ -106,7 +108,15 @@ gem 'compass-rails', '~> 2.0.alpha.0'
 gem 'zurb-foundation'
 </pre>
 
-Use Bundler to install the gems:
+h4. Zurb Foundation 5.0
+
+<pre>
+gem 'foundation-rails'
+</pre>
+
+h4. Use Bundler
+
+Use Bundler to install the gem:
 
 <pre>
 $ bundle install
@@ -138,7 +148,11 @@ Use Bundler to install the gem:
 $ bundle install
 </pre>
 
-h2. Generate a Simple Layout
+h2. Generate an Application Layout
+
+Generate application layout files for the framework you will use.
+
+h3. Generate a Simple Layout
 
 To create a set of simple layout files:
 
@@ -163,7 +177,7 @@ The RailsLayout gem will create the file:
 
 * "app/assets/stylesheets/application.css.scss":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/application.css.scss
 
-h2. Twitter Bootstrap 2.3 Layout
+h3. Twitter Bootstrap 2.3 Layout
 
 To create layout files for use with Twitter Bootstrap 2.3:
 
@@ -191,7 +205,7 @@ and modify the file:
 
 * "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/bootstrap-application.js
 
-h2. Twitter Bootstrap 3.0 Layout
+h3. Twitter Bootstrap 3.0 Layout
 
 To create layout files for use with Twitter Bootstrap 3.0:
 
@@ -219,7 +233,7 @@ and modify the file:
 
 * "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/bootstrap-application.js
 
-h2. Zurb Foundation 4.0 Layout
+h3. Zurb Foundation 4.0 Layout
 
 To create layout files for use with Zurb Foundation 4.0:
 
@@ -247,7 +261,35 @@ and modify the file:
 
 * "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/foundation4-application.js
 
-h2. Reverting to None
+h3. Zurb Foundation 5.0 Layout
+
+To create layout files for use with Zurb Foundation 5.0:
+
+<pre>
+$ rails generate layout foundation5
+</pre>
+
+Use @--force@ if you want to overwrite existing files:
+
+<pre>
+$ rails generate layout foundation5 --force
+</pre>
+
+See the files that are generated:
+
+* "app/views/layouts/application.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/foundation5-application.html.erb
+* "app/views/layouts/_messages.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/foundation4-messages.html.erb
+* "app/views/layouts/_navigation.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/foundation5-navigation.html.erb
+
+The RailsLayout gem will create the file:
+
+* "app/assets/stylesheets/framework_and_overrides.css.scss":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/foundation5_and_overrides.css.scss
+
+and modify the file:
+
+* "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/foundation5-application.js
+
+h3. Reverting to None
 
 To revert your application to a default application layout:
 
@@ -255,7 +297,7 @@ To revert your application to a default application layout:
 $ rails generate layout none
 </pre>
 
-The RailsLayout gem will remove files it may have added:
+The RailsLayout gem will remove any files it may have added:
 
 * app/views/layouts/_messages.html.erb
 * app/views/layouts/_navigation.html.erb
@@ -309,7 +351,9 @@ The full set of links will be created if the following files are found in your a
 * app/views/devise/registrations/new.html.erb
 * app/views/users/index.html.erb
 
-The @rails generate navigation@ command is used by the "Rails Composer":http://railsapps.github.io/rails-composer/ tool. It may not be suitable for your application if you haven't created custom view for Devise.
+These files will be present in your application if you have created custom views for Devise.
+
+The @rails generate navigation@ command is used to populate the navigation bar in starter applications created by the "Rails Composer":http://railsapps.github.io/rails-composer/ tool.
 
 h2. Help
 

data/lib/generators/layout/USAGE

@@ -13,6 +13,9 @@ Description:
     Create layout files suitable for Zurb Foundation 4.0:
       rails generate layout foundation4
 
+    Create layout files suitable for Zurb Foundation 5.0:
+      rails generate layout foundation5
+
     Remove layout files:
       rails generate layout none
 

data/lib/generators/layout/layout_generator.rb

@@ -40,6 +40,11 @@ module Layout
             copy_file 'foundation4-application.js', 'app/assets/javascripts/application.js'
             remove_file 'app/assets/stylesheets/simple.css'
             remove_file 'app/assets/stylesheets/bootstrap_and_overrides.css.scss'
+          when 'foundation5'
+            copy_file 'foundation5_and_overrides.css.scss', 'app/assets/stylesheets/framework_and_overrides.css.scss'
+            copy_file 'foundation5-application.js', 'app/assets/javascripts/application.js'
+            remove_file 'app/assets/stylesheets/simple.css'
+            remove_file 'app/assets/stylesheets/bootstrap_and_overrides.css.scss'
         end
         if Rails::VERSION::MAJOR.to_s == "3"
           gsub_file 'app/assets/javascripts/application.js', /\/\/= require turbolinks\n/, ''

data/lib/generators/layout/templates/foundation4-application.html.erb

@@ -5,7 +5,7 @@
     <title><%%= content_for?(:title) ? yield(:title) : "<%= app_name.underscore.titleize %>" %></title>
     <meta name="description" content="<%%= content_for?(:description) ? yield(:description) : "<%= app_name.underscore.titleize %>" %>">
     <%%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true %>
-    <%%# Modernizr is required for Zurb Foundation 4 %>
+    <%%# Modernizr is required for Zurb Foundation %>
     <%%= javascript_include_tag "vendor/custom.modernizr" %>
     <%%= javascript_include_tag "application", "data-turbolinks-track" => true %>
     <%%= csrf_meta_tags %>

data/lib/generators/layout/templates/foundation4-application.html.haml

@@ -5,7 +5,7 @@
     %title= content_for?(:title) ? yield(:title) : '<%= app_name.underscore.titleize %>'
     %meta{:name => "description", :content => "#{content_for?(:description) ? yield(:description) : '<%= app_name.underscore.titleize %>'}"}
     = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
-    -#  Modernizr is required for Zurb Foundation 4
+    -#  Modernizr is required for Zurb Foundation
     = javascript_include_tag "vendor/custom.modernizr"
     = javascript_include_tag "application", "data-turbolinks-track" => true
     = csrf_meta_tags

data/lib/generators/layout/templates/foundation4-messages.html.erb

@@ -1,4 +1,4 @@
-<%# Rails flash messages styled for Zurb Foundation 4 %>
+<%# Rails flash messages styled for Zurb Foundation %>
 <% flash.each do |name, msg| %>
   <% if msg.is_a?(String) %>
     <div data-alert class="alert-box round <%= name == :notice ? "success" : "alert" %>">

data/lib/generators/layout/templates/foundation4-messages.html.haml

@@ -1,4 +1,4 @@
--# Rails flash messages styled for Zurb Foundation 4
+-# Rails flash messages styled for Zurb Foundation
 - flash.each do |name, msg|
   - if msg.is_a?(String)
     %div{:class => "alert-box round #{name == :notice ? "success" : "alert"}", "data-alert" => ""}

data/lib/generators/layout/templates/foundation5-application.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%%= content_for?(:title) ? yield(:title) : "<%= app_name.underscore.titleize %>" %></title>
+    <meta name="description" content="<%%= content_for?(:description) ? yield(:description) : "<%= app_name.underscore.titleize %>" %>">
+    <%%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true %>
+    <%%# Modernizr is required for Zurb Foundation %>
+    <%%= javascript_include_tag "vendor/custom.modernizr" %>
+    <%%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+    <%%= csrf_meta_tags %>
+  </head>
+  <body>
+    <header>
+      <%%= render 'layouts/navigation' %>
+    </header>
+    <main role="main">
+       <%%= render 'layouts/messages' %>
+       <%%= yield %>
+    </main>
+  </body>
+</html>

data/lib/generators/layout/templates/foundation5-application.html.haml

@@ -0,0 +1,17 @@
+!!!
+%html
+  %head
+    %meta{:name => "viewport", :content => "width=device-width, initial-scale=1.0"}
+    %title= content_for?(:title) ? yield(:title) : '<%= app_name.underscore.titleize %>'
+    %meta{:name => "description", :content => "#{content_for?(:description) ? yield(:description) : '<%= app_name.underscore.titleize %>'}"}
+    = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
+    -#  Modernizr is required for Zurb Foundation
+    = javascript_include_tag "vendor/custom.modernizr"
+    = javascript_include_tag "application", "data-turbolinks-track" => true
+    = csrf_meta_tags
+  %body
+    %header
+      = render 'layouts/navigation'
+    %main{:role => "main"}
+      = render 'layouts/messages'
+      = yield

data/lib/generators/layout/templates/foundation5-application.js

@@ -0,0 +1,20 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require foundation
+//= require_tree .
+$(function() {
+  $(document).foundation();
+});

data/lib/generators/layout/templates/foundation5-messages.html.erb

@@ -0,0 +1,9 @@
+<%# Rails flash messages styled for Zurb Foundation %>
+<% flash.each do |name, msg| %>
+  <% if msg.is_a?(String) %>
+    <div data-alert class="alert-box round <%= name == :notice ? "success" : "alert" %>">
+      <%= content_tag :div, msg %>
+      <a href="#" class="close">&times;</a>
+    </div>
+  <% end %>
+<% end %>

data/lib/generators/layout/templates/foundation5-messages.html.haml

@@ -0,0 +1,6 @@
+-# Rails flash messages styled for Zurb Foundation
+- flash.each do |name, msg|
+  - if msg.is_a?(String)
+    %div{:class => "alert-box round #{name == :notice ? "success" : "alert"}", "data-alert" => ""}
+      = content_tag :div, msg
+      %a.close{:href => "#"} ×

data/lib/generators/layout/templates/foundation5-navigation.html.erb

@@ -0,0 +1,12 @@
+<%# navigation styled for Zurb Foundation 5 %>
+<nav class="top-bar" "data-topbar">
+  <ul class="title-area">
+    <li class="name"><%= link_to 'Home', root_path %></li>
+    <li class="toggle-topbar menu-icon"><a href="#"><span>Menu</span></a></li>
+  </ul>
+  <div class="top-bar-section">
+    <ul>
+      <%= render 'layouts/navigation_links' %>
+    </ul>
+  </div>
+</nav>

data/lib/generators/layout/templates/foundation5-navigation.html.haml

@@ -0,0 +1,11 @@
+-# navigation styled for Zurb Foundation 5
+%nav.top-bar{:data-topbar => true}
+  %ul.title-area
+    %li.name
+      = link_to 'Home', root_path
+    %li.toggle-topbar.menu-icon
+      %a{:href => "#"}
+        %span Menu
+  .top-bar-section
+    %ul
+      = render 'layouts/navigation_links'

data/lib/generators/layout/templates/foundation5_and_overrides.css.scss

@@ -0,0 +1,48 @@
+// import the CSS framework
+@import "foundation";
+
+// override for the 'Home' navigation link
+.top-bar .name {
+  font-size: 0.8125em;
+  line-height: 45px; }
+.top-bar .name a {
+  font-weight: bold;
+  color: white;
+  padding: 0 15px; }
+
+// THESE ARE EXAMPLES YOU CAN MODIFY
+// create mixins using Foundation classes
+@mixin twelve-columns {
+  @extend .small-12;
+  @extend .columns;
+  }
+@mixin six-columns-centered {
+  @extend .small-6;
+  @extend .columns;
+  @extend .text-center;
+  }
+// create your own classes
+// to make views framework-neutral
+.column {
+  @include six-columns-centered;
+  }
+.form {
+  @include grid-column(6);
+  }
+.form-centered {
+  @include six-columns-centered;
+  }
+.submit {
+  @extend .button;
+  @extend .radius;
+  }
+// apply styles to HTML elements
+// to make views framework-neutral
+main {
+  @include twelve-columns;
+  background-color: #eee;
+  }
+section {
+  @extend .row;
+  margin-top: 20px;
+  }

data/lib/rails_layout/version.rb

@@ -1,3 +1,3 @@
 module RailsLayout
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_layout
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Daniel Kehoe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,7 @@ files:
 - LICENSE.txt
 - README.textile
 - Rakefile
+- lib/generators/layout/.DS_Store
 - lib/generators/layout/USAGE
 - lib/generators/layout/layout_generator.rb
 - lib/generators/layout/templates/application.css.scss
@@ -79,6 +80,14 @@ files:
 - lib/generators/layout/templates/foundation4-navigation.html.erb
 - lib/generators/layout/templates/foundation4-navigation.html.haml
 - lib/generators/layout/templates/foundation4_and_overrides.css.scss
+- lib/generators/layout/templates/foundation5-application.html.erb
+- lib/generators/layout/templates/foundation5-application.html.haml
+- lib/generators/layout/templates/foundation5-application.js
+- lib/generators/layout/templates/foundation5-messages.html.erb
+- lib/generators/layout/templates/foundation5-messages.html.haml
+- lib/generators/layout/templates/foundation5-navigation.html.erb
+- lib/generators/layout/templates/foundation5-navigation.html.haml
+- lib/generators/layout/templates/foundation5_and_overrides.css.scss
 - lib/generators/layout/templates/navigation_links.html.erb
 - lib/generators/layout/templates/none-application.html.erb
 - lib/generators/layout/templates/none-application.html.haml