web_app_template 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f63260808f395cae094aab455c1d17f7a4f510a
-  data.tar.gz: 1fd9e3f775aa256df53fec693d5d2df35c794302
+  metadata.gz: 18d05517e8ff8b41ab8042d4de1f0cae4a5aa917
+  data.tar.gz: cbe5a10fdc1f5c03bb06505b029212bdd9c58d32
 SHA512:
-  metadata.gz: 3a237318641fef093fbe2bb26d392f215ccaf07f48434a3cb625316042f481cde980dcdc26bb7fdd96ba7eff100a84d4cff8cbf6964385480926ea1ba3da47f5
-  data.tar.gz: dbe907cf4ea9d705f82cd5c75678a92fee0dc2f999482122b8773bce244ddfd1126ea6b818ca04cd268a49bbfe7c8a2b641b3b739ad8d0033594f24227aebbf4
+  metadata.gz: 03f5645d549c14554dc53c93db42cc2c470a77b07f6678d841ff673f8b27058077ded05f05c237715a8adcf465e2420bad213469bb25508ac9605c2e0652269e
+  data.tar.gz: 9f5085284dde3f4709f986d00cf77c3650f7b733118f6c9d19718203c3caef159cebfd847df982c3e6560368c0ef24b39d1c35d98e7954cd3017c08e4e24dbd1

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in web_app_template.gemspec
 gemspec
+
+group :test do
+  gem "generator_spec"
+  gem 'haml'
+  gem 'slim'
+  gem 'html2haml'
+  gem 'haml2slim'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 jurrick
+
+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.

data/README.md

@@ -1,6 +1,7 @@
 # WebAppTemplate
 
-TODO: Write a gem description
+Web App Template is a rails generator that you can use to generate site templates quickly.
+Today some bootstrap v3 templates already available to generate layouts.
 
 ## Installation
 
@@ -18,11 +19,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Layout generator
+
+Used without parameters, it generates the layout inside the application.html.erb file using the bootstrap template "Starter".
+
+    rails g web_app_template:layout
+
+You can specify the layout file name in the first parameter:
+
+    rails g web_app_template:layout admin # it will generate a layout called `admin.html.erb`
+
+If you want to use another bootstrap template layout, instead of the default, you can use the `--template` option:
+
+    rails g web_app_template:layout admin --template="jumbotron"
+
+You can specify the template engine with `--engine=name` option, where name can be erb (default), haml or slim:
+
+    rails g web_app_template:layout --engine=slim # you must specify slim in your Gemfile
+
+You can specify the text used in the header with the `--app-name` option:
+
+    rails g web_app_template:layout --app-name="My New Application"
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/web_app_template/fork )
+1. Fork it ( http://github.com/jurrick/web_app_template/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/generators/web_app_template/layout/layout_generator.rb

@@ -0,0 +1,60 @@
+module WebAppTemplate
+  class Layout < Rails::Generators::Base
+    desc "Installs the application layout"
+    source_root File.expand_path('../templates/bootstrap3', __FILE__)
+
+    argument :layout_name, :type => :string, :default => 'application'
+
+    class_option :app_name,     :type => :string,   :default => 'Web App',    :desc => 'Specify the application name'
+    class_option :engine,       :type => :string,   :default => 'erb',        :desc => 'Specify the template engine (erb, haml or slim)'
+    class_option :type,         :type => :string,   :default => 'bootstrap3', :desc => 'Layout type, default or bootstrap3'
+    class_option :template,     :type => :string,   :default => 'starter',    :desc => 'Layout template, default starter'
+
+    def copy_layout
+      layout = "#{options.template.underscore}.html.erb"
+      case options.engine
+        when 'erb'
+          template  layout, "app/views/layouts/#{layout_name.underscore}.html.erb"
+        when 'haml'
+          generate_haml_layout layout
+        when 'slim'
+          generate_slim_layout layout
+      end
+    end
+
+    protected
+
+    def generate_haml_layout(layout)
+      require 'haml'
+      require 'html2haml'
+      Dir.mktmpdir('web-app-template-haml') do |haml_root|
+        tmp_html_path = "#{haml_root}/#{layout}"
+        tmp_haml_path = "#{haml_root}/#{layout}.haml"
+        template layout, tmp_html_path, :verbose => false
+        `html2haml --erb --xhtml #{tmp_html_path} #{tmp_haml_path}`
+        copy_file tmp_haml_path, "app/views/layouts/#{layout_name.underscore}.html.haml"
+      end
+    rescue LoadError
+      say "HAML is not installed, or it is not specified in your Gemfile."
+      exit
+    end
+
+    def generate_slim_layout(layout)
+      require 'slim'
+      require 'html2haml'
+      require 'haml2slim'
+      Dir.mktmpdir('web-app-template-slim') do |slim_root|
+        tmp_html_path = "#{slim_root}/#{layout}"
+        tmp_haml_path = "#{slim_root}/#{layout}.haml"
+        tmp_slim_path = "#{slim_root}/#{layout}.slim"
+        template layout, tmp_html_path, :verbose => false
+        `html2haml --erb --xhtml #{tmp_html_path} #{tmp_haml_path}`
+        `haml2slim #{tmp_haml_path} #{tmp_slim_path}`
+        copy_file tmp_slim_path, "app/views/layouts/#{layout_name.underscore}.html.slim"
+      end
+    rescue LoadError
+      say "SLIM is not installed, or it is not specified in your Gemfile."
+      exit
+    end
+  end
+end

data/lib/generators/web_app_template/layout/templates/bootstrap3/carousel.html.erb

@@ -0,0 +1,336 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title><%= options.app_name %></title>
+
+  <%%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%%= csrf_meta_tag %>
+
+  <style type="text/css">
+    /* GLOBAL STYLES
+    -------------------------------------------------- */
+    /* Padding below the footer and lighter body text */
+
+    body {
+      padding-bottom: 40px;
+      color: #5a5a5a;
+    }
+
+
+
+    /* CUSTOMIZE THE NAVBAR
+    -------------------------------------------------- */
+
+    /* Special class on .container surrounding .navbar, used for positioning it into place. */
+    .navbar-wrapper {
+      position: absolute;
+      top: 0;
+      left: 0;
+      right: 0;
+      z-index: 20;
+    }
+
+    /* Flip around the padding for proper display in narrow viewports */
+    .navbar-wrapper .container {
+      padding-left: 0;
+      padding-right: 0;
+    }
+    .navbar-wrapper .navbar {
+      padding-left: 15px;
+      padding-right: 15px;
+    }
+
+
+    /* CUSTOMIZE THE CAROUSEL
+    -------------------------------------------------- */
+
+    /* Carousel base class */
+    .carousel {
+      height: 500px;
+      margin-bottom: 60px;
+    }
+    /* Since positioning the image, we need to help out the caption */
+    .carousel-caption {
+      z-index: 10;
+    }
+
+    /* Declare heights because of positioning of img element */
+    .carousel .item {
+      height: 500px;
+      background-color: #777;
+    }
+    .carousel-inner > .item > img {
+      position: absolute;
+      top: 0;
+      left: 0;
+      min-width: 100%;
+      height: 500px;
+    }
+
+
+
+    /* MARKETING CONTENT
+    -------------------------------------------------- */
+
+    /* Pad the edges of the mobile views a bit */
+    .marketing {
+      padding-left: 15px;
+      padding-right: 15px;
+    }
+
+    /* Center align the text within the three columns below the carousel */
+    .marketing .col-lg-4 {
+      text-align: center;
+      margin-bottom: 20px;
+    }
+    .marketing h2 {
+      font-weight: normal;
+    }
+    .marketing .col-lg-4 p {
+      margin-left: 10px;
+      margin-right: 10px;
+    }
+
+
+    /* Featurettes
+    ------------------------- */
+
+    .featurette-divider {
+      margin: 80px 0; /* Space out the Bootstrap <hr> more */
+    }
+
+    /* Thin out the marketing headings */
+    .featurette-heading {
+      font-weight: 300;
+      line-height: 1;
+      letter-spacing: -1px;
+    }
+
+
+
+    /* RESPONSIVE CSS
+    -------------------------------------------------- */
+
+    @media (min-width: 768px) {
+
+      /* Remove the edge padding needed for mobile */
+      .marketing {
+          padding-left: 0;
+          padding-right: 0;
+      }
+
+      /* Navbar positioning foo */
+      .navbar-wrapper {
+          margin-top: 20px;
+      }
+      .navbar-wrapper .container {
+          padding-left:  15px;
+          padding-right: 15px;
+      }
+      .navbar-wrapper .navbar {
+          padding-left:  0;
+          padding-right: 0;
+      }
+
+      /* The navbar becomes detached from the top, so we round the corners */
+      .navbar-wrapper .navbar {
+          border-radius: 4px;
+      }
+
+      /* Bump up size of carousel content */
+      .carousel-caption p {
+          margin-bottom: 20px;
+          font-size: 21px;
+          line-height: 1.4;
+      }
+
+      .featurette-heading {
+          font-size: 50px;
+      }
+
+    }
+
+    @media (min-width: 992px) {
+      .featurette-heading {
+          margin-top: 120px;
+      }
+    }
+  </style>
+</head>
+<!-- NAVBAR
+================================================== -->
+<body>
+<div class="navbar-wrapper">
+  <div class="container">
+
+    <div class="navbar navbar-inverse navbar-static-top" role="navigation">
+      <div class="container">
+        <div class="navbar-header">
+          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+            <span class="sr-only">Toggle navigation</span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </button>
+          <a class="navbar-brand" href="#"><%= options.app_name %></a>
+        </div>
+        <div class="navbar-collapse collapse">
+          <ul class="nav navbar-nav">
+            <li class="active"><a href="#">Home</a></li>
+            <li><a href="#about">About</a></li>
+            <li><a href="#contact">Contact</a></li>
+            <li class="dropdown">
+              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
+              <ul class="dropdown-menu">
+                <li><a href="#">Action</a></li>
+                <li><a href="#">Another action</a></li>
+                <li><a href="#">Something else here</a></li>
+                <li class="divider"></li>
+                <li class="dropdown-header">Nav header</li>
+                <li><a href="#">Separated link</a></li>
+                <li><a href="#">One more separated link</a></li>
+              </ul>
+            </li>
+          </ul>
+        </div>
+      </div>
+    </div>
+
+  </div>
+</div>
+
+
+<!-- Carousel
+================================================== -->
+<div id="myCarousel" class="carousel slide" data-ride="carousel">
+  <!-- Indicators -->
+  <ol class="carousel-indicators">
+    <li data-target="#myCarousel" data-slide-to="0" class="active"></li>
+    <li data-target="#myCarousel" data-slide-to="1"></li>
+    <li data-target="#myCarousel" data-slide-to="2"></li>
+  </ol>
+  <div class="carousel-inner">
+    <div class="item active">
+      <img data-src="holder.js/900x500/auto/#777:#7a7a7a/text:First slide" alt="First slide">
+      <div class="container">
+        <div class="carousel-caption">
+          <h1>Example headline.</h1>
+          <p>Note: If you're viewing this page via a <code>file://</code> URL, the "next" and "previous" Glyphicon buttons on the left and right might not load/display properly due to web browser security rules.</p>
+          <p><a class="btn btn-lg btn-primary" href="#" role="button">Sign up today</a></p>
+        </div>
+      </div>
+    </div>
+    <div class="item">
+      <img data-src="holder.js/900x500/auto/#666:#6a6a6a/text:Second slide" alt="Second slide">
+      <div class="container">
+        <div class="carousel-caption">
+          <h1>Another example headline.</h1>
+          <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
+          <p><a class="btn btn-lg btn-primary" href="#" role="button">Learn more</a></p>
+        </div>
+      </div>
+    </div>
+    <div class="item">
+      <img data-src="holder.js/900x500/auto/#555:#5a5a5a/text:Third slide" alt="Third slide">
+      <div class="container">
+        <div class="carousel-caption">
+          <h1>One more for good measure.</h1>
+          <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
+          <p><a class="btn btn-lg btn-primary" href="#" role="button">Browse gallery</a></p>
+        </div>
+      </div>
+    </div>
+  </div>
+  <a class="left carousel-control" href="#myCarousel" data-slide="prev"><span class="glyphicon glyphicon-chevron-left"></span></a>
+  <a class="right carousel-control" href="#myCarousel" data-slide="next"><span class="glyphicon glyphicon-chevron-right"></span></a>
+</div><!-- /.carousel -->
+
+
+
+<!-- Marketing messaging and featurettes
+================================================== -->
+<!-- Wrap the rest of the page in another container to center all the content. -->
+
+<div class="container marketing">
+
+  <!-- Three columns of text below the carousel -->
+  <div class="row">
+    <div class="col-lg-4">
+      <img class="img-circle" data-src="holder.js/140x140" alt="Generic placeholder image">
+      <h2>Heading</h2>
+      <p>Donec sed odio dui. Etiam porta sem malesuada magna mollis euismod. Nullam id dolor id nibh ultricies vehicula ut id elit. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Praesent commodo cursus magna.</p>
+      <p><a class="btn btn-default" href="#" role="button">View details &raquo;</a></p>
+    </div><!-- /.col-lg-4 -->
+    <div class="col-lg-4">
+      <img class="img-circle" data-src="holder.js/140x140" alt="Generic placeholder image">
+      <h2>Heading</h2>
+      <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh.</p>
+      <p><a class="btn btn-default" href="#" role="button">View details &raquo;</a></p>
+    </div><!-- /.col-lg-4 -->
+    <div class="col-lg-4">
+      <img class="img-circle" data-src="holder.js/140x140" alt="Generic placeholder image">
+      <h2>Heading</h2>
+      <p>Donec sed odio dui. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Vestibulum id ligula porta felis euismod semper. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</p>
+      <p><a class="btn btn-default" href="#" role="button">View details &raquo;</a></p>
+    </div><!-- /.col-lg-4 -->
+  </div><!-- /.row -->
+
+
+  <!-- START THE FEATURETTES -->
+
+  <hr class="featurette-divider">
+
+  <div class="row featurette">
+    <div class="col-md-7">
+      <h2 class="featurette-heading">First featurette heading. <span class="text-muted">It'll blow your mind.</span></h2>
+      <p class="lead">Donec ullamcorper nulla non metus auctor fringilla. Vestibulum id ligula porta felis euismod semper. Praesent commodo cursus magna, vel scelerisque nisl consectetur. Fusce dapibus, tellus ac cursus commodo.</p>
+    </div>
+    <div class="col-md-5">
+      <img class="featurette-image img-responsive" data-src="holder.js/500x500/auto" alt="Generic placeholder image">
+    </div>
+  </div>
+
+  <hr class="featurette-divider">
+
+  <div class="row featurette">
+    <div class="col-md-5">
+      <img class="featurette-image img-responsive" data-src="holder.js/500x500/auto" alt="Generic placeholder image">
+    </div>
+    <div class="col-md-7">
+      <h2 class="featurette-heading">Oh yeah, it's that good. <span class="text-muted">See for yourself.</span></h2>
+      <p class="lead">Donec ullamcorper nulla non metus auctor fringilla. Vestibulum id ligula porta felis euismod semper. Praesent commodo cursus magna, vel scelerisque nisl consectetur. Fusce dapibus, tellus ac cursus commodo.</p>
+    </div>
+  </div>
+
+  <hr class="featurette-divider">
+
+  <div class="row featurette">
+    <div class="col-md-7">
+      <h2 class="featurette-heading">And lastly, this one. <span class="text-muted">Checkmate.</span></h2>
+      <p class="lead">Donec ullamcorper nulla non metus auctor fringilla. Vestibulum id ligula porta felis euismod semper. Praesent commodo cursus magna, vel scelerisque nisl consectetur. Fusce dapibus, tellus ac cursus commodo.</p>
+    </div>
+    <div class="col-md-5">
+      <img class="featurette-image img-responsive" data-src="holder.js/500x500/auto" alt="Generic placeholder image">
+    </div>
+  </div>
+
+  <hr class="featurette-divider">
+
+  <!-- /END THE FEATURETTES -->
+
+
+  <!-- FOOTER -->
+  <footer>
+    <p class="pull-right"><a href="#">Back to top</a></p>
+    <p>&copy; 2013 Company, Inc. &middot; <a href="#">Privacy</a> &middot; <a href="#">Terms</a></p>
+  </footer>
+
+</div><!-- /.container -->
+
+</body>
+</html>