rails_layout 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8e711b4ae92d424e6f9bb42f34e6e4bbf54561e
-  data.tar.gz: 28bd30053cf83abfff3d74dbb510e40e9dfeb25c
+  metadata.gz: 1735089b69e5bdbbbf6974b0ecfa1083a1bf3399
+  data.tar.gz: 5cd3a05e8202482fffc9a982e60ae5a405ae5ddf
 SHA512:
-  metadata.gz: b48c07291a144559e6e660f030932300cf5f9f65dc28f2ca1a9b76f0233e19e4eb5847914e335c2eea2e72c8d2dbfec134d93e744cb9cc3b4e6fbc5b6bd46800
-  data.tar.gz: c950ba8a30ec3f48ec89477ac481cb75368ffef59a6b79d0532868d48112ab2c17f5889021311214a918c4b461421524247d37b44395cb5358810ca5f949da67
+  metadata.gz: 1a837969224dbc9911ab502808c85100c685642b5040ba7eef83c4300fa1500e95bb29e803d422b6c5346eec14080ca1d0f584ffb57cc959a1c4f800b5d49e1d
+  data.tar.gz: 98e2c65d8087cbf928d63dd3025b1e303f54150f62c11d70dcd14039135de9572384b88b0824db58ede3406e05b1a59fc30289ee8d7bb04d0dbac8a0f276de8b

data/CHANGELOG.textile

@@ -1,5 +1,9 @@
 h1. CHANGELOG
 
+h2. 0.2.0 October 31, 2013
+
+* installs a framework by setting up files in the assets folder
+
 h2. 0.1.9 October 20, 2013
 
 * use class instead of id for simple CSS flash messages

data/README.textile

@@ -1,6 +1,35 @@
 h1. !http://railsapps.github.io/images/rails-36x36.jpg(RailsLayout Gem)! RailsLayout Gem
 
-RailsLayout is a utility gem to use during development to set up a default application layout with partials for Rails flash messages and navigation links. It is a Rails generator that you add to your Rails application Gemfile.
+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:
+
+* Twitter Bootstrap 2.3
+* Twitter Bootstrap 3.0
+* Zurb Foundation 4.0
+
+It will rename *application.css.css* to *application.css.scss*.
+
+And modify the necessary asset files:
+
+* application.js
+
+and add either:
+
+* bootstrap_and_overrides.css.scss
+
+or:
+
+* foundation_and_overrides.css.scss
+
+It will set up a default application layout.
+
+You also get partials for
+
+* Rails flash messages
+* navigation links
 
 h4. Supported Frameworks
 
@@ -10,6 +39,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
+* @none@ - removes all changes
 
 h4. Generated Files
 
@@ -25,7 +55,7 @@ Additionally, when the @simple@ option is selected:
 
 h4. Support for ERB or Haml
 
-If you are using ERB for Rails views, the RailsLayout gem will generate ERB files (as shown above).
+If you are using ERB for Rails views, the RailsLayout gem will generate ERB files.
 
 If you are using Haml, the RailsLayout gem will generate Haml files instead.
 
@@ -41,11 +71,38 @@ To see how the generated files from the RailsLayout gem are used, see the "Learn
 
 h2. Installing a Front-End Framework
 
-Follow the "instructions for Twitter Bootstrap":http://railsapps.github.io/twitter-bootstrap-rails.html or "Zurb Foundation":http://foundation.zurb.com/docs/rails.html to install a front-end framework.
+Instead of following the "instructions for Twitter Bootstrap":http://railsapps.github.io/twitter-bootstrap-rails.html or "Zurb Foundation":http://foundation.zurb.com/docs/rails.html to install a front-end framework, add the gems you need. Then use the RailsLayout gem. It will set up your assets files.
+
+h3. Install Gems for a Front-End Framework
+
+Add the gems you need to your Rails application Gemfile:
 
-Then install the RailsLayout gem and generate layout files.
+h4. Twitter Bootstrap 2.3
 
-h2. Installation
+<pre>
+gem 'bootstrap-sass', '~> 2.3.2.2'
+</pre>
+
+h4. Twitter Bootstrap 3.0
+
+<pre>
+gem 'bootstrap-sass'
+</pre>
+
+h4. Zurb Foundation 4.0
+
+<pre>
+gem 'compass-rails', '~> 2.0.alpha.0'
+gem 'zurb-foundation'
+</pre>
+
+Use Bundler to install the gems:
+
+<pre>
+$ bundle install
+</pre>
+
+h2. Install the RailsLayout Gem
 
 Add it to your Rails application Gemfile:
 
@@ -92,6 +149,10 @@ See the files that are generated:
 * "app/views/layouts/_navigation.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/simple-navigation.html.erb
 * "app/assets/stylesheets/simple.css":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/simple.css
 
+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
 
 To create layout files for use with Twitter Bootstrap 2.3:
@@ -112,6 +173,14 @@ See the files that are generated:
 * "app/views/layouts/_messages.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/bootstrap2-messages.html.erb
 * "app/views/layouts/_navigation.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/bootstrap2-navigation.html.erb
 
+The RailsLayout gem will create the file:
+
+* "app/assets/stylesheets/bootstrap_and_overrides.css.scss":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/bootstrap2_and_overrides.css.scss
+
+and modify the file:
+
+* "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/bootstrap-application.js
+
 h2. Twitter Bootstrap 3.0 Layout
 
 To create layout files for use with Twitter Bootstrap 3.0:
@@ -132,6 +201,14 @@ See the files that are generated:
 * "app/views/layouts/_messages.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/bootstrap3-messages.html.erb
 * "app/views/layouts/_navigation.html.erb":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/templates/bootstrap3-navigation.html.erb
 
+The RailsLayout gem will create the file:
+
+* "app/assets/stylesheets/bootstrap_and_overrides.css.scss":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/bootstrap3_and_overrides.css.scss
+
+and modify the file:
+
+* "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/bootstrap-application.js
+
 h2. Zurb Foundation 4.0 Layout
 
 To create layout files for use with Zurb Foundation 4.0:
@@ -152,6 +229,37 @@ See the files that are generated:
 * "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/foundation4-navigation.html.erb
 
+The RailsLayout gem will create the file:
+
+* "app/assets/stylesheets/foundation_and_overrides.css.scss":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/foundation_and_overrides.css.scss
+
+and modify the file:
+
+* "app/assets/javascripts/application.js":https://github.com/RailsApps/rails_layout/blob/master/lib/generators/layout/foundation4-application.js
+
+h2. Reverting to None
+
+To revert your application to a default application layout:
+
+<pre>
+$ rails generate layout none
+</pre>
+
+The RailsLayout gem will remove files it may have added:
+
+* app/views/layouts/_messages.html.erb
+* app/views/layouts/_navigation.html.erb
+* app/assets/stylesheets/simple.css
+* app/assets/stylesheets/bootstrap_and_overrides.css.scss
+* app/assets/stylesheets/foundation_and_overrides.css.scss
+
+Additionally, it will restore these files to the default versions:
+
+* app/views/layouts/application.html.erb
+* app/assets/javascripts/application.js
+
+The file *app/assets/stylesheets/application.css.scss* will contain a CSS rule but you can ignore it or remove it.
+
 h2. Help
 
 To see help messages:

data/lib/generators/layout/layout_generator.rb

@@ -8,40 +8,70 @@ module Layout
 
       attr_reader :app_name
 
+      # Install the desired framework
+      def install_framework
+        remove_file 'app/assets/stylesheets/application.css'
+        copy_file 'application.css.scss', 'app/assets/stylesheets/application.css.scss'
+        case framework_name
+          when 'none'
+            copy_file 'application.js', 'app/assets/javascripts/application.js'
+            remove_file 'app/assets/stylesheets/simple.css'
+            remove_file 'app/assets/stylesheets/bootstrap_and_overrides.css.scss'
+            remove_file 'app/assets/stylesheets/foundation_and_overrides.css.scss'
+          when 'simple'
+            copy_file 'simple.css', 'app/assets/stylesheets/simple.css'
+            copy_file 'application.js', 'app/assets/javascripts/application.js'
+            remove_file 'app/assets/stylesheets/bootstrap_and_overrides.css.scss'
+            remove_file 'app/assets/stylesheets/foundation_and_overrides.css.scss'
+          when 'bootstrap2'
+            copy_file 'bootstrap2_and_overrides.css.scss', 'app/assets/stylesheets/bootstrap_and_overrides.css.scss'
+            copy_file 'bootstrap-application.js', 'app/assets/javascripts/application.js'
+            remove_file 'app/assets/stylesheets/simple.css'
+            remove_file 'app/assets/stylesheets/foundation_and_overrides.css.scss'
+          when 'bootstrap3'
+            copy_file 'bootstrap3_and_overrides.css.scss', 'app/assets/stylesheets/bootstrap_and_overrides.css.scss'
+            copy_file 'bootstrap-application.js', 'app/assets/javascripts/application.js'
+            remove_file 'app/assets/stylesheets/simple.css'
+            remove_file 'app/assets/stylesheets/foundation_and_overrides.css.scss'
+          when 'foundation4'
+            copy_file 'foundation_and_overrides.css.scss', 'app/assets/stylesheets/foundation_and_overrides.css.scss'
+            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'
+        end
+      end
+
       # Create an application layout file with partials for messages and navigation
       def generate_layout
         app = ::Rails.application
         @app_name = app.class.to_s.split("::").first
         ext = app.config.generators.options[:rails][:template_engine] || :erb
-        # I've got templates for ERB and Haml (but not Slim)
         template "#{framework_name}-application.html.#{ext}", "app/views/layouts/application.html.#{ext}"
-        copy_file "#{framework_name}-messages.html.#{ext}", "app/views/layouts/_messages.html.#{ext}"
-        copy_file "#{framework_name}-navigation.html.#{ext}", "app/views/layouts/_navigation.html.#{ext}"
-      end
-
-      # Add a simple stylesheet if there is no front-end framework
-      def simple_css
-        if framework_name == 'simple'
-          copy_file 'simple.css', 'app/assets/stylesheets/simple.css'
+        if framework_name == 'none'
+          remove_file "app/views/layouts/_messages.html.#{ext}"
+          remove_file "app/views/layouts/_navigation.html.#{ext}"
         else
-          remove_file 'app/assets/stylesheets/simple.css'
+          copy_file "#{framework_name}-messages.html.#{ext}", "app/views/layouts/_messages.html.#{ext}"
+          copy_file "#{framework_name}-navigation.html.#{ext}", "app/views/layouts/_navigation.html.#{ext}"
         end
       end
 
       # If 'About' or 'Contact' views exist in known locations, add navigation links
       def add_navigation_links
-        # not yet accommodating Slim (we'll need different substitutions)
-        if File.exists?('app/views/pages/about.html.erb')
-          insert_into_file 'app/views/layouts/_navigation.html.erb', "\n  <li><%= link_to 'About', page_path('about') %></li>", :before => "\n</ul>"
-        end
-        if File.exists?('app/views/contacts/new.html.erb')
-          insert_into_file 'app/views/layouts/_navigation.html.erb', "\n  <li><%= link_to 'Contact', new_contact_path %></li>", :before => "\n</ul>"
-        end
-        if File.exists?('app/views/contacts/new.html.haml')
-          insert_into_file 'app/views/layouts/_navigation.html.haml', "\n  %li= link_to 'Contact', new_contact_path", :after => "root_path"
-        end
-        if File.exists?('app/views/pages/about.html.haml')
-          insert_into_file 'app/views/layouts/_navigation.html.haml', "\n  %li= link_to 'About', page_path('about')", :after => "root_path"
+        unless framework_name == 'none'
+          # not yet accommodating Slim (we'll need different substitutions)
+          if File.exists?('app/views/pages/about.html.erb')
+            insert_into_file 'app/views/layouts/_navigation.html.erb', "\n  <li><%= link_to 'About', page_path('about') %></li>", :before => "\n</ul>"
+          end
+          if File.exists?('app/views/contacts/new.html.erb')
+            insert_into_file 'app/views/layouts/_navigation.html.erb', "\n  <li><%= link_to 'Contact', new_contact_path %></li>", :before => "\n</ul>"
+          end
+          if File.exists?('app/views/contacts/new.html.haml')
+            insert_into_file 'app/views/layouts/_navigation.html.haml', "\n  %li= link_to 'Contact', new_contact_path", :after => "root_path"
+          end
+          if File.exists?('app/views/pages/about.html.haml')
+            insert_into_file 'app/views/layouts/_navigation.html.haml', "\n  %li= link_to 'About', page_path('about')", :after => "root_path"
+          end
         end
       end
 

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

@@ -0,0 +1,24 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */
+.content {
+  background-color: #eee;
+  padding: 20px;
+  margin: 0 -20px;
+  -webkit-border-radius: 0 0 6px 6px;
+  -moz-border-radius: 0 0 6px 6px;
+  border-radius: 0 0 6px 6px;
+  -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
+  -moz-box-shadow: 0 1px 2px rgba(0,0,0,.15);
+  box-shadow: 0 1px 2px rgba(0,0,0,.15);
+}

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

@@ -0,0 +1,16 @@
+// 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_tree .

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

@@ -0,0 +1,17 @@
+// 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 bootstrap
+//= require_tree .

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

@@ -0,0 +1,3 @@
+@import "bootstrap";
+body { padding-top: 60px; }
+@import "bootstrap-responsive";

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

@@ -0,0 +1,2 @@
+@import "bootstrap";
+body { padding-top: 60px; }

data/lib/generators/layout/templates/foundation4-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/foundation_and_overrides.css.scss

@@ -0,0 +1,2 @@
+// Required global settings and mixins for Foundation
+@import "foundation";

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= app_name.underscore.titleize %></title>
+  <%%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%%= csrf_meta_tags %>
+</head>
+<body>
+
+<%%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,9 @@
+!!!
+%html
+  %head
+    %title= <%= app_name.underscore.titleize %>
+    = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
+    = javascript_include_tag "application", "data-turbolinks-track" => true
+    = csrf_meta_tags
+  %body
+    = yield

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

@@ -14,8 +14,10 @@
         <%%= render 'layouts/navigation' %>
       </header>
       <main role="main">
-        <%%= render 'layouts/messages' %>
-        <%%= yield %>
+        <div class="content">
+          <%%= render 'layouts/messages' %>
+          <%%= yield %>
+        </div>
       </main>
       <footer>
       </footer>

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

@@ -12,6 +12,7 @@
       %header
         = render 'layouts/navigation'
       %main{:role => "main"}
-        = render 'layouts/messages'
-        = yield
+        .content
+          = render 'layouts/messages'
+          = yield
       %footer

data/lib/rails_layout/version.rb

@@ -1,3 +1,3 @@
 module RailsLayout
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_layout
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Kehoe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-20 00:00:00.000000000 Z
+date: 2013-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,24 +54,33 @@ files:
 - Rakefile
 - lib/generators/layout/USAGE
 - lib/generators/layout/layout_generator.rb
+- lib/generators/layout/templates/application.css.scss
+- lib/generators/layout/templates/application.js
+- lib/generators/layout/templates/bootstrap-application.js
 - lib/generators/layout/templates/bootstrap2-application.html.erb
 - lib/generators/layout/templates/bootstrap2-application.html.haml
 - lib/generators/layout/templates/bootstrap2-messages.html.erb
 - lib/generators/layout/templates/bootstrap2-messages.html.haml
 - lib/generators/layout/templates/bootstrap2-navigation.html.erb
 - lib/generators/layout/templates/bootstrap2-navigation.html.haml
+- lib/generators/layout/templates/bootstrap2_and_overrides.css.scss
 - lib/generators/layout/templates/bootstrap3-application.html.erb
 - lib/generators/layout/templates/bootstrap3-application.html.haml
 - lib/generators/layout/templates/bootstrap3-messages.html.erb
 - lib/generators/layout/templates/bootstrap3-messages.html.haml
 - lib/generators/layout/templates/bootstrap3-navigation.html.erb
 - lib/generators/layout/templates/bootstrap3-navigation.html.haml
+- lib/generators/layout/templates/bootstrap3_and_overrides.css.scss
 - lib/generators/layout/templates/foundation4-application.html.erb
 - lib/generators/layout/templates/foundation4-application.html.haml
+- lib/generators/layout/templates/foundation4-application.js
 - lib/generators/layout/templates/foundation4-messages.html.erb
 - lib/generators/layout/templates/foundation4-messages.html.haml
 - lib/generators/layout/templates/foundation4-navigation.html.erb
 - lib/generators/layout/templates/foundation4-navigation.html.haml
+- lib/generators/layout/templates/foundation_and_overrides.css.scss
+- lib/generators/layout/templates/none-application.html.erb
+- lib/generators/layout/templates/none-application.html.haml
 - lib/generators/layout/templates/simple-application.html.erb
 - lib/generators/layout/templates/simple-application.html.haml
 - lib/generators/layout/templates/simple-messages.html.erb
@@ -102,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Rails generator creates application layout files for Twitter Bootstrap and