easy_html_generator 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbf67d8cf7bfda5daf5f4921a24c1ba0715c3c87
-  data.tar.gz: 4305ffba33eb60ee1ca3aff1d560632dd99e5ab1
+  metadata.gz: 905068c1d71ebf725bb4ea674447009ce8e8ea37
+  data.tar.gz: 4e878d00d63860408570c9448c2bb5053ab9259f
 SHA512:
-  metadata.gz: 4386a2e634b820b4cc97cd8dbfbf0e6ae40916db22736f7d86418f85b19459c7ba18e884ebb2c83cdcc86dae244c8894be5f6ea01aa69b1506e38ce630077111
-  data.tar.gz: 3819e7952489e72af72bbacd050f4de9a2ea9f54a2be2f5a4932ec35872492c6eb1be93f922aea2caf4b106b164dafff0e022bc8e04dbd02b3827e2139b6bb49
+  metadata.gz: 4543937826dae53a9bc558888b4f4573529da67f40c4e08f8cf3140aa1f9a410657a56b88a43135ca3d68702209da42841a556990206c71010dcde204f4b0db8
+  data.tar.gz: eaba1fb515be75abf5ef9c4702904dc82da93ea660459756c6837b6d13d9bc949e7fd6f91ef57e7682d1e061042be46b9351933b4928f1fccca469fdbc7ba746

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# 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) [![Gem Version](https://badge.fury.io/rb/easy_html_generator.svg)](http://badge.fury.io/rb/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
@@ -6,13 +6,14 @@ This gem is a powerful and easy to use web development tool that helps developin
 * [Haml](http://haml.info/) aka html
 * [ActionView](https://github.com/rails/rails/tree/master/actionview) for ruby haml templating comfort
 
-It can utilizes:
+It 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
+* ~ 600 lines of code 
 
 It is developed with:
 - [Ruby](https://www.ruby-lang.org/) as implementation language
@@ -24,6 +25,14 @@ It is based on:
 
 ## Basic concepts
 ### setup
+You have to install the following software if you want to use specific generators:
+* [OptiPng](http://optipng.sourceforge.net/) for png image minimizing
+* [JpegOptim](https://github.com/tjko/jpegoptim) for jpg image minimizing
+* [Bundler](http://bundler.io/) to use the easy_html_generator gem
+* [NodeJs](https://nodejs.org/download/) to use bower and grunt https://www.npmjs.com/
+* [Bower](http://bower.io/) to use bower `npm install -g bower`
+* [Grunt](http://gruntjs.com/getting-started) to use grunt `npm install -g grunt-cli`
+
 Create a new project folder
 
     mkdir my_project
@@ -77,11 +86,12 @@ Now you should see the following folder sructure
             ├── 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`
+...and navigate your web browser to `http://localhost:9292`
 
-After a sort time of generating you should see a directory listening in your browser.
+After a short time of generating you should see a directory listening in your browser.
 
 ## Usage terminal
     Usage: ehg [options]
@@ -99,7 +109,7 @@ There are several generators controlled by the `project.yml` configured like:
         images:     'assets/images'
         scripts:    'assets/scripts'
         styles:     'assets/styles'
-        ...
+    ...
 
     generators:
       - structure:
@@ -114,6 +124,7 @@ There are several generators controlled by the `project.yml` configured like:
           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`.
@@ -124,103 +135,109 @@ Generators are processed the way they appear in the `project.yml`. At the moment
 * creates necessary dist folders
 * config:
 
-
-    generators:
-      - structure:
-          enabled: true
+```
+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'
+```
+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'
+```
+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:
-            - '*'
-
+```
+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
+* compiles haml files from src to html files in dist, supports partials, action view syntax and 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'
+```
+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'
+```
+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'
+```
+generators:
+  - compile_coffee:
+      enabled: true
+      minimize: true
+      selector: '**/*.js.coffee'
+```
 
 ### Minimize-Generators
 #### Minimize::Html
@@ -228,52 +245,55 @@ Generators are processed the way they appear in the `project.yml`. At the moment
 * minimizes src html files and copies to dist
 * config:
 
-
-    generators:
-      - minimize_html:
-          enabled: true
-          selector: '**/*.html'
-          prefix_extension: ''
+```
+generators:
+  - minimize_html:
+      enabled: true
+      selector: '**/*.html'
+      prefix_extension: ''
+```
 
 #### Minimize::Css
 * operates on: `dist` and `src`
-* cminimizes src css files and copies to dist
+* minimizes src css files and copies to dist
 * config:
 
-
-    generators:
-      - minimize_css:
-          enabled: true
-          selector: '**/*.css'
-          prefix_extension: '.min'
+```
+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'
+```
+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
-
+```
+generators:
+  - minimize_images:
+      enabled: true
+      selector: '**/*.{jpg,jpeg,png}'
+      options:
+        quality: 90
+        level: 3
+        verbose: true
+```
 
 ### Service-Generators
 #### Service::Bower
@@ -281,24 +301,26 @@ Generators are processed the way they appear in the `project.yml`. At the moment
 * resolves my_project/bower.json and copies bower_components to target in dist
 * config:
 
-
-    generators:
-      - service_bower:
-          enabled: true
-          selector: 'bower.json'
-          target: 'lib'
+```
+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'
+```
+generators:
+  - service_grunt:
+      enabled: true
+      selector: 'Gruntfile.coffee'
+      task: 'default'
+```
 
 #### Service::Analytics
 * operates on: `dist`
@@ -306,15 +328,17 @@ Generators are processed the way they appear in the `project.yml`. At the moment
 * 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
+```
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_html_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tom Hanoldt
@@ -276,28 +276,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2-
-    It uses:
-      * CoffeScript aka Javascript
-      * Sass aka css
-      * Haml aka html
-      * ActionView for ruby haml templating comfort
-
-      It can utilizes:
-      * Bootstrap for responsive and modern html layouts
-      * HeadJ for performance optimized resource loading
-      * Bower for javascript dependency management
-      * Grunt for javascript based task management
-      * Google Anlaytics for tracking of pageclicks
-      * minimizing from coffee-, javascript-, sass-, css-, png- and image-files
-
-      It is developed with:
-      - Rspec for testing
-      - RuboCop for code quality
-      - Rack as Server
-
-      It is based on:
-      - EasyHtmlCreator (https://github.com/dennisvandehoef/easy-html-creator)
+description: |-
+  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, Sass, Haml, Bootstrap, HeadJs, Bower, Grunt, Google Anlaytics and minimizes coffee-, javascript-, sass-, css-, png- and image-files.
 email:
 - monotom@gmail.com
 executables: