easy_html_generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbf67d8cf7bfda5daf5f4921a24c1ba0715c3c87
+  data.tar.gz: 4305ffba33eb60ee1ca3aff1d560632dd99e5ab1
+SHA512:
+  metadata.gz: 4386a2e634b820b4cc97cd8dbfbf0e6ae40916db22736f7d86418f85b19459c7ba18e884ebb2c83cdcc86dae244c8894be5f6ea01aa69b1506e38ce630077111
+  data.tar.gz: 3819e7952489e72af72bbacd050f4de9a2ea9f54a2be2f5a4932ec35872492c6eb1be93f922aea2caf4b106b164dafff0e022bc8e04dbd02b3827e2139b6bb49

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+##Issues
+
+- Report issues or feature requests on [GitHub Issues](https://github.com/creative-workflow/easy-html-generator/issues).
+- If reporting a bug, please add a [simplified example](http://sscce.org/).
+
+##Pull requests
+- Create a new topic branch for every separate change you make.
+- Create a test case if you are fixing a bug or implementing an important feature.
+- Make sure the build runs successfully.
+
+## Development
+
+###Tools
+We use the following tools for development:
+
+- [RSpec](http://rspec.info/) for tests.
+- [Rake](https://github.com/ruby/rake) for task management.
+- [RuboCop](https://github.com/bbatsov/rubocop) for code quality.
+- [NodeJS](http://nodejs.org/download/) required to run grunt.
+- [Grunt](http://gruntjs.com/getting-started) for task management inside a project.
+- [Bower](http://bower.io/#getting-started) for js dependency management inside a project.
+
+###Getting started
+Install [NodeJS](http://nodejs.org/).  
+Install globally grunt-cli using the following command:
+
+    $ npm install -g grunt-cli
+
+Browse to the project root directory and install the dev dependencies:
+
+    $ npm install -d
+
+To execute the build and tests run the following command in the root of the project:
+
+    $ grunt
+
+You should see a green message in the console:
+
+    Done, without errors.
+
+###testing
+You can run the tests with using the following command:
+
+    $ rake

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 creative-workflow
+
+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

@@ -0,0 +1,332 @@
+# easy-html-generator [![Build Status](https://travis-ci.org/creative-workflow/easy-html-generator.svg?branch=master)](https://travis-ci.org/creative-workflow/easy-html-generator) [![Code Climate](https://codeclimate.com/github/creative-workflow/easy-html-generator/badges/gpa.svg)](https://codeclimate.com/github/creative-workflow/easy-html-generator)
+
+This gem is a powerful and easy to use web development tool that helps developing modern web sites by generating static html pages. It uses:
+* [CoffeScript](http://coffeescript.org/) aka Javascript
+* [Sass](http://sass-lang.com/) aka css
+* [Haml](http://haml.info/) aka html
+* [ActionView](https://github.com/rails/rails/tree/master/actionview) for ruby haml templating comfort
+
+It can utilizes:
+* [Bootstrap](http://getbootstrap.com/) for responsive and modern html layouts
+* [HeadJS](http://headjs.com/) for performance optimized resource loading
+* [Bower](http://bower.io/) for javascript dependency management
+* [Grunt](http://gruntjs.com/) for javascript based task management
+* [Google Anlaytics](https://www.google.com/analytics/) tracking of pageclicks
+* minimizing from coffee-, javascript-, sass-, css-, png- and image-files
+
+It is developed with:
+- [Ruby](https://www.ruby-lang.org/) as implementation language
+- [Rspec](http://rspec.info/) for testing
+- [RuboCop](https://github.com/bbatsov/rubocop) for code quality
+
+It is based on:
+- [EasyHtmlCreator](https://github.com/dennisvandehoef/easy-html-creator) which was the fundament [Dennis van de Hoef](https://github.com/dennisvandehoef) and me developed on.
+
+## Basic concepts
+### setup
+Create a new project folder
+
+    mkdir my_project
+    cd my_project
+
+Create a ruby 'Gemfile'
+
+    touch Gemfile
+
+Paste this into the 'Gemfile'
+
+    source 'https://rubygems.org'
+
+    gem 'easy_html_generator'
+
+Run in terminal
+
+    bundle install
+    ehg --init
+    ehg --create my_project
+
+Now you should see the following folder sructure
+
+    ├── dist                    # the generated result will be stored here
+    └── src                     # the generation input is stored here
+        ├── demo
+        ├── my_project            # this is a project and will be available via http://localhost:9292/my_project
+        │   ├── assets
+        │   │   ├── images          # content will be copied to `dist/my_project/images`
+        │   │   ├── public            # public content gets directly copied to `dist/my_project/`
+        │   │   ├── scripts           # content will be copied to `dist/my_project/scripts`
+        │   │   └── styles            # content will be copied to `dist/my_project/styles`
+        │   ├── lib
+        │   │   ├── generators        # project specific generators
+        │   │   └── helper            # project specific view helpers you can use in haml files
+        │   ├── project.yml         # project specific generators config
+        │   └── views
+        │       ├── index.html.haml   # the ham file for index.html
+        │       └── layout.haml       # the layout file index.html will use
+        |
+        └── shared                # shared content over all projects
+            ├── assets              # shared assets over all projects
+            │   ├── images
+            │   ├── public
+            │   ├── scripts
+            │   └── styles
+            │       └── mixins        # here are css helpers for bootstrap and head js
+            ├── lib
+            │   ├── generators        # generators shared over all projects
+            │   └── helper            # view helpers you can use in haml files
+            ├── project.yml        # if a project doesnt have a `project.yml` this config will be used
+
+Now run
+    ehg --server
+
+...and go to `http://localhost:9292`
+
+After a sort time of generating you should see a directory listening in your browser.
+
+## Usage terminal
+    Usage: ehg [options]
+        -s, --server [HOST_AND_PORT]     start the rack server, default: 0.0.0.0:9292
+        -g, --generate [PROJECT]         generate one or all projects, default: all
+        -i, --init                       initialise ehg workspace
+        -c, --create [PROJECT]           create a new project from template, default: demo
+        -h, --help                       Show this message
+
+## Usage Generators
+There are several generators controlled by the `project.yml` configured like:
+
+    paths:
+      src:
+        images:     'assets/images'
+        scripts:    'assets/scripts'
+        styles:     'assets/styles'
+        ...
+
+    generators:
+      - structure:
+          enabled: true
+
+      - compile_coffee:
+          enabled: true
+          minimize: true
+          selector: '**/*.js.coffee'
+
+      - service_bower:
+          enabled: true
+          selector: 'bower.json'
+          target: 'lib'
+
+## Generators
+Generators are processed the way they appear in the `project.yml`. At the moment only one generator instance per `project.yml` is allowed. Every generator has the property `enabled`.
+
+### Basic-Generators
+#### Structure
+* operates on: `dist`
+* creates necessary dist folders
+* config:
+
+
+    generators:
+      - structure:
+          enabled: true
+
+#### Copy
+* operates on: `dist` and `src`
+* copies folder or files from dist to src
+* config:
+
+
+    generators:
+      - copy:
+          enabled: true
+          dirs:
+            -
+              source: 'assets/styles'
+              target: 'styles'
+              selector: '**/*.css'
+            -
+              source: 'assets/scripts'
+              target: 'scripts'
+              selector: '**/*.js'
+
+#### Combine
+* operates on: `dist`
+* combines merges files on dist
+* config:
+
+
+    generators:
+      - combine
+          enabled: true
+          packages:
+            -
+              file: 'scripts/combined.js'
+              files:
+                - 'scripts/**/*.js'
+            -
+              file: 'styles/combined.css'
+              files:
+                - 'styles/**/*.css'
+
+#### Delete
+* operates on: `dist`
+* deletes files or folders on dist
+* config:
+
+
+    generators:
+      - delete
+          enabled: false
+          files:
+            - '*'
+
+
+### Complie-Generators
+#### Compile::Haml
+* operates on: `dist` and `src`
+* compiles haml files from src to html files in dist, supports partials and action view, supports minimizing
+* config:
+
+
+    generators:
+      - compile_haml:
+          enabled: true
+          minimize: true
+          default_layout: 'views/layout.haml'
+          selector: '**/*.html.haml'
+          renderer:
+            attr_wrapper: '"'
+            format: :html5
+            shared_helper_path: 'shared/lib'
+
+#### Compile::Sass
+* operates on: `dist` and `src`
+* compiles sass files from src to css files in dist, supports shared mixins and minimizing
+* config:
+
+
+    generators:
+      - compile_sass:
+          enabled: true
+          minimize: true
+          selector: '**/*.css.sass'
+
+#### Compile::Coffee
+* operates on: `dist` and `src`
+* compiles coffee files from src to js files in dist, supports minimizing
+* config:
+
+
+    generators:
+      - compile_coffee:
+          enabled: true
+          minimize: true
+          selector: '**/*.js.coffee'
+
+### Minimize-Generators
+#### Minimize::Html
+* operates on: `dist` and `src`
+* minimizes src html files and copies to dist
+* config:
+
+
+    generators:
+      - minimize_html:
+          enabled: true
+          selector: '**/*.html'
+          prefix_extension: ''
+
+#### Minimize::Css
+* operates on: `dist` and `src`
+* cminimizes src css files and copies to dist
+* config:
+
+
+    generators:
+      - minimize_css:
+          enabled: true
+          selector: '**/*.css'
+          prefix_extension: '.min'
+
+#### Minimize::Js
+* operates on: `dist` and `src`
+* minimizes src js files and copies to dist
+* config:
+
+
+    generators:
+      - minimize_js:
+          enabled: true
+          selector: '**/*.js'
+          prefix_extension: '.min'
+
+#### Minimize::Images
+* operates on: `dist` and `src`
+* minimizes src image files and copies to dist, uses [Piet](https://github.com/albertbellonch/piet)
+* config:
+
+
+    generators:
+      - minimize_images:
+          enabled: true
+          selector: '**/*.{jpg,jpeg,png}'
+          options:
+            quality: 90
+            level: 3
+            verbose: true
+
+
+### Service-Generators
+#### Service::Bower
+* operates on: `dist` and `src`
+* resolves my_project/bower.json and copies bower_components to target in dist
+* config:
+
+
+    generators:
+      - service_bower:
+          enabled: true
+          selector: 'bower.json'
+          target: 'lib'
+
+#### Service::Grunt
+* operates on: `dist`
+* resolves my_project/Gruntfile.coffee and runs a task
+* config:
+
+
+    generators:
+      - service_grunt:
+          enabled: true
+          selector: 'Gruntfile.coffee'
+          task: 'default'
+
+#### Service::Analytics
+* operates on: `dist`
+* appends google analytics code to selected html files
+* config:
+
+
+    generators:
+      - service_analytics:
+          enabled: true
+          append_to_files:
+            - '**/*.html'
+          google:
+            enabled: true
+            code: "<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', '{GOOGLE_UA_ID}', 'auto');ga('send', 'pageview');</script>"
+            id: -1
+
+### Resources
+  * https://github.com/dennisvandehoef/easy-html-creator
+  * https://github.com/creative-workflow/easy-html-generator
+  * https://travis-ci.org/creative-workflow/easy-html-generator
+  * https://codeclimate.com/github/creative-workflow/easy-html-generator
+  * https://rubygems.org/gems/easy_html_generator
+
+### Authors
+
+  [Tom Hanoldt](https://github.com/monotom)
+
+# Contributing
+
+Check out the [Contributing Guidelines](CONTRIBUTING.md)

data/bin/ehg

@@ -0,0 +1,52 @@
+# encoding: utf-8
+# !/usr/bin/env ruby
+
+require 'optparse'
+require 'easy_html_generator'
+
+class EhgOptparse
+  def self.parse(args)
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: ehg [options]'
+
+      # http://hawkins.io/2012/07/rack_from_the_beginning/
+      opts.on('-s', '--server [HOST_AND_PORT]', '0.0.0.0:9292', 'start the rack server') do |host_and_port|
+        host_and_port ||= '0.0.0.0:9292'
+
+        tmp = host_and_port.split ':'
+        host = tmp.first
+        port = tmp.last
+
+        EasyHtmlGenerator.start_server(host, port)
+      end
+
+      opts.on('-g', '--generate [PROJECT]', 'all', 'generate one or all projects') do |project|
+        project ||= 'all'
+
+        if project == 'all'
+          EasyHtmlGenerator.generate_all
+        else
+          EasyHtmlGenerator.generate_project project
+        end
+      end
+
+      opts.on('-i', '--init', 'initialise ehg workspace') do
+        EasyHtmlGenerator::Workspace.init
+      end
+
+      opts.on('-c', '--create [PROJECT]', 'demo', 'create a new project from template') do |name|
+        name ||= 'demo'
+        EasyHtmlGenerator::Workspace.create_project name
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(args)
+  end
+end
+
+EhgOptparse.parse(ARGV)