easy_html_generator 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4121de001c06afef8a4674c5027e2327efc693c9
-  data.tar.gz: c67d23e2d49c758f6278ee9a1dc88cb9fb19cef8
+  metadata.gz: 09e261a245dc181a7eccc30b1996735cef82ac01
+  data.tar.gz: 9b16640da263e0de0e464b282fe8caa1a53cb386
 SHA512:
-  metadata.gz: 65d9714558acef3e3feaf91b4e9904225529fee83f4b293fec3717cd2acd2d099a0c10f0f28ac1ee9d97b6315ae795e7775b62a5572268b4511b1ef75fe2e348
-  data.tar.gz: e48670c042579af8ebbf2a4690ff75cbbf4a42eaf7d6faefb2bf336f9b7ea238a89500308d44095abe69ae4715ec9260fdeb04922cf5351047cca8086a9e47b2
+  metadata.gz: 5bb7994ee0aab9b4892f4ef48564d1fc2f861b16de6aced27466a43a5e3f3e16372043ae55afb2a94c8e2db57fa37b920dc48155a8b9b72412e65c09b1311cf4
+  data.tar.gz: c3699481eaf0aab10f8b55174e7c922b7e4add82d337c0d4a2cdb582a4b1dffe5abe5dab51f06bdffbc8f8d637d6e12a0d156445ef5ba3a8a1661251bd460aee

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+languages:
+  Ruby: true
+
+exclude_paths:
+ - "dist/*"
+ - "spec/*"

data/.gitignore

@@ -0,0 +1,12 @@
+.sass-cache
+.DS_Store
+coverage
+spec/fixtures/src/demo/node_modules
+spec/fixtures/src/demo/bower_components
+spec/fixtures/dist
+dist
+src/demo/bower_components
+Gemfile.lock
+.bundle
+.yardoc
+tmp

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Metrics/LineLength:
+  Max: 79
+
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - spec/fixtures/**/*
+
+Style/Encoding:
+  Enabled: true
+
+Style/RedundantException:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 2.2.0
+
+node_js:
+  - 0.10
+
+before_script:
+  - npm install -g grunt-cli bower
+  - sudo apt-get install -y optipng jpegoptim
+  - bundle install
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,364 +1,78 @@
 # 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 utilizes:
+This gem is a powerful and easy to use web development tool that helps developing modern web sites in a comfortable and fast way by generating static html pages.
+
+#### ehg utilizes:
 * [CoffeScript](http://coffeescript.org/) a.k.a. Javascript
 * [Sass](http://sass-lang.com/) a.k.a. Css
 * [Haml](http://haml.info/) a.k.a. Html
 * [ActionView](https://github.com/rails/rails/tree/master/actionview) for ruby haml templating comfort
-* ~ 600 lines of code
 
-It supports:
+#### ehg supports:
 * [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 of coffee-, javascript-, sass-, css-, png- and jpg files
-* per project generators and ruby/haml view helper
-* shared generators, helpers, static-, sass- 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.
-
-## Get started
-At first you need [Ruby](https://www.ruby-lang.org/de/) and [Bundler](http://bundler.io/).
-
-For specific generators install:
-* [OptiPng](http://optipng.sourceforge.net/) for png image minimizing
-* [JpegOptim](https://github.com/tjko/jpegoptim) for jpg image minimizing
-* [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 workspace folder
-
-    mkdir my_workspace
-    cd my_workspace
-
-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 structure with `ls -alR`
-
-    my_workspace
-    ├── 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 navigate your web browser to `http://localhost:9292`
-
-After a short 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                       initialize 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`. If a project misses the project.yml the file `my_workspace/shared/project.yml` will be loaded and looks like this:
-
-    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 per default
-* supports `src://` and `dist://`
-* config:
-
-```
-generators:
-  - copy:
-      enabled: true
-      dirs:
-        -
-          source: 'assets/styles'
-          target: 'styles'
-          selector: '**/*.css'
-        -
-          source: 'src://assets/scripts'
-          target: 'dist://scripts'
-          selector: '**/*.js'
-```
-
-#### Combine
-* operates on: `dist`
-* combines merges files on dist per default
-* supports `src://` and `dist://`
-* config:
-
-```
-generators:
-  - combine
-      enabled: true
-      packages:
-        -
-          file: 'scripts/combined.js'
-          files:
-            - 'scripts/**/*.js'
-        -
-          file: 'dist://styles/combined.css'
-          files:
-            - 'src://styles/**/*.css'
-```
-
-#### Delete
-* operates on: `dist`
-* deletes files or folders on dist per default
-* supports `src://` and `dist://`
-* config:
-
-```
-generators:
-  - delete
-      enabled: false
-      files:
-        - '*'
-        - 'src://bower_components'
-```
-
-### Compile-Generators
-#### Compile::Haml
-* operates on: `dist` and `src`
-* 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'
-```
-
-#### 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`
-* minimizes 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:
+* `minimizing` of coffee-, javascript-, sass-, css-, html-, haml-, png- and jpg files
+* workspace `shared` generator-, haml-helper-, static-, sass- and image files
+* `inline` sass and coffee script in haml files, `inline_stylesheet_link_tag` and `inline_javascript_include_tag`
+* `partitial templates` and `layout files` for haml
 
-```
-generators:
-  - minimize_js:
-      enabled: true
-      selector: '**/*.js'
-      prefix_extension: '.min'
-```
+## Resources
 
-#### Minimize::Images
-* operates on: `dist` and `src`
-* minimizes src image files and copies to dist, uses [Piet](https://github.com/albertbellonch/piet)
-* config:
+> "[Getting started](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/GETSTARTED.md)"
 
-```
-generators:
-  - minimize_images:
-      enabled: true
-      selector: '**/*.{jpg,jpeg,png}'
-      options:
-        quality: 90
-        level: 3
-        verbose: true
-```
+> "[Configuration](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/CONFIGURATION.md)"
 
-### Service-Generators
-#### Service::Bower
-* operates on: `dist` and `src`
-* resolves my_workspace/bower.json and copies bower_components to target in dist
-* config:
+> "[Generators](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/GENERATORS.md)"
 
-```
-generators:
-  - service_bower:
-      enabled: true
-      selector: 'bower.json'
-      target: 'lib'
-```
+ >"[Contributing](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/CONTRIBUTING.md)"
 
-#### Service::Grunt
-* operates on: `dist`
-* resolves my_workspace/Gruntfile.coffee and runs a task
-* config:
 
-```
-generators:
-  - service_grunt:
-      enabled: true
-      selector: 'Gruntfile.coffee'
-      task: 'default'
-```
+## Changes
 
-#### Service::Analytics
-* operates on: `dist`
-* appends google analytics code to selected html files
-* config:
+#### Version 1.0.5
+  * refactor Generator::* and clean up code
+  * implement Generator::Service::Sitemap
+  * add repetitive feature to every generator
+  * add generic support for analytic codes, not only for google
+  * implement src:// and dest:// path expanding for all config values, streamline config names
+  * streamline project.yml parameter names
+  * you have to adjust your project.yml by adding path shortcuts to all your generators `src://` and `dest://` (see README for more path shortcuts) and rename some parameter names
 
+#### Version 1.0.4
+  * add src:// and dest:// path expanding to basic generators
+  * raise on missing partial rendering
+  * set thin server to debug level, see requests
+  * extend bootsrap fixes
+  * add headjs hide-* mixins and classes
+  * better override path_to_stylesheet instead of hole stylesheet_link_tag method to make action_view_helper work with ehg
+  * don’t cache combined result
+  * create target dir on copy
+  * add missing rubocop dev dependency
 
-```
-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
-```
+#### Version 1.0.3
+  * bower target relative from dist folder not from dist/scripts folder
+  * optimize rack for local pagespeed testing
+  * fix directory listening
+  * add Rack::ShowExceptions
+  * project.uri_path retuns now relative paths
 
-### Resources
-  * 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
-  * http://www.rubydoc.info/gems/easy_html_generator
-  * https://github.com/dennisvandehoef/easy-html-creator
+#### Version 1.0.2
+  * fix generate all `ehg -g`
+  * refactor rack app, use thin server
+  * implement ehg as rack middleware
 
-### Authors
+#### Version 1.0.1
+  * setup instructions
+  * travis integration
+  * code coverage
+  * rubocop rake task
 
-  [Tom Hanoldt](https://github.com/monotom)
 
-# Contributing
+# Authors
 
-Check out the [Contributing Guidelines](CONTRIBUTING.md)
+- [Tom Hanoldt](https://github.com/monotom)
+- [Alexander Illmayer](https://github.com/arecords)
+- 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.

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'rake'
+require 'easy_html_generator'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'generate one or all project ditributions'
+task :generate do |project|
+  if project
+    EasyHtmlGenerator.generate_project project
+  else
+    EasyHtmlGenerator.generate_all
+  end
+end
+
+desc 'Starts the rack server, see config.ru'
+task :server, :host_and_port do |_t, args|
+  host_and_port = args[:host_and_port] || '0.0.0.0:9292'
+
+  tmp = host_and_port.split ':'
+  host = tmp.first
+  port = tmp.last
+
+  Rack::Server.start(app: EasyHtmlGenerator::Rackapp, Host: host, Port: port)
+end
+
+desc 'runs rubocop'
+task :lint do
+  puts `rubocop .`
+end
+
+desc 'create a new project'
+task :create, :name do |_t, args|
+  EasyHtmlGenerator::Workspace.create_project args[:name]
+end
+
+RSpec::Core::RakeTask.new
+
+desc 'Run tests'
+task test: :spec
+
+task default: :test

data/config.ru

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require 'easy_html_generator'
+
+run EasyHtmlGenerator.rack_app

data/docs/CONFIGURATION.md

@@ -0,0 +1,84 @@
+# Configuration
+
+### project.yml
+There are several generators controlled by the `project.yml`. If a project misses the project.yml the file `my_workspace/shared/project.yml` will be loaded and looks like this:
+
+    paths:
+      src:
+        images:     'assets/images'
+        scripts:    'assets/scripts'
+        styles:     'assets/styles'
+    [...]
+    generators:
+      - structure:
+          enabled: true
+      - compile_coffee:
+          enabled: true
+          minimize: true
+          selector: 'src.scripts://**/*.js.coffee'
+    [...]
+
+### Path shortcuts
+Any config value can use `path shortcuts` which will be resolved at runtime. The following shortcuts are available:
+  * `src://`:            project.src_path
+  * `dist://`:           project.dist_path
+  * `src.scripts://`:    project.src_path_to(:scripts)
+  * `src.styles://`:     project.src_path_to(:styles)
+  * `src.images://`:     project.src_path_to(:images)
+  * `src.public://`:     project.src_path_to(:public)
+  * `src.views://`:         project.src_path_to(:views),
+  * `dist.scripts://`:   project.dist_path_to(:scripts)
+  * `dist.styles://`:    project.dist_path_to(:styles)
+  * `dist.images://`:    project.dist_path_to(:images)
+  * `dist.public://`:    project.dist_path_to(:public)
+  * `dist.views://`:     project.dist_path_to(:views),
+  * `workspace.root://`: EasyHtmlGenerator::WORKSPACE_PATH
+  * `ehg.root://`:       EasyHtmlGenerator::EHG_SRC_PATH
+
+If we have a config value like ```src.scripts://bower_components/*``` the value will be expanded to ```/Users/mono/code/cw/tools/easy-html-generator/src/scripts/bower_components/*``` for ex..
+
+### Path regexp
+based on ruby's [Dir method](http://www.rubydoc.info/stdlib/core/2.2.2/Dir.glob) pattern resolving.
+  * `*`matches all files
+  * `m*` matches all files beginning with m
+  * `*o` matches all files ending with o
+  * `*no*` matches all files that have no in them
+  * `**` matches directories recursively
+  * `?` matches any one character
+  *  `[set]` matches any one character in set
+  *  `{p,q}` matches either literal p or literal q
+  *  `\` escapes the next metacharacter
+
+### Repetitive configuration
+Nearly any generator can be configured repetitive. That means that the following copy generator configuration...
+
+    - copy:
+        enabled: true
+        source: 'src.styles://'
+        target: 'dist.styles://'
+        selector: '**/*.css'
+
+...can be transformed to:
+
+    - copy:
+        enabled: true
+        selector: '**/*'
+        repetitive:
+          -
+            source: 'src.images://'
+            target: 'dist.images://'
+          -
+            source: 'src.styles://'
+            target: 'dist.styles://'
+            selector: '**/*.css'
+
+
+Note that the repetitive config will be merged with the configuration from root node (see `selector`).
+
+# Resources
+
+> "[Getting started](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/GETSTARTED.md)"
+
+> "[Generators](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/GENERATORS.md)"
+
+ >"[Contributing](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/CONTRIBUTING.md)"

data/{CONTRIBUTING.md → docs/CONTRIBUTING.md}

@@ -1,3 +1,5 @@
+#Contributing
+
 ##Issues
 
 - Report issues or feature requests on [GitHub Issues](https://github.com/creative-workflow/easy-html-generator/issues).