easy_html_generator 1.0.4 → 1.0.5

data/docs/GENERATORS.md

@@ -0,0 +1,210 @@
+# Basic-Generators
+### Structure
+* creates necessary dist folders
+
+```
+  - structure:
+      enabled: true
+```
+
+### Copy
+* copies folder or files
+* `selector` is optional, default selector: `**/*`
+
+```
+  - copy:
+      enabled: true
+      repetitive:
+        -
+          source: 'src.styles://'
+          target: 'dist.styles://'
+          selector: '**/*.css'
+        -
+          source: 'src://assets/scripts'
+          target: 'dist://scripts'
+          selector: '**/*.js'
+```
+
+### Combine
+* combines multiple files
+
+```
+  - combine:
+      enabled: true
+      repetitive:
+        -
+          target: 'dist.scripts://app.combined.js'
+          sources:
+            - 'dist.scripts://*.js'
+```
+
+### Delete
+* deletes files or folders
+
+```
+  - delete:
+      enabled: false
+      source: 'dist://**/*'
+```
+
+# Compile-Generators
+### Compile::Haml
+* compiles haml files to html files
+* supports partials and minimizing
+* supports [ActionView](https://github.com/rails/rails/tree/master/actionview) syntax and view helper
+* supports layouts, the layout can bespezified in the first line of a haml file with `-# ehg layout: layout.blank`, default layout is `my_project/views/layout.haml`
+
+```
+  - compile_haml:
+      enabled: true
+      minimize: true
+      source: 'src.views://'
+      target: 'dist.views://'
+      selector: '**/*.html.haml'
+      default_layout: 'views/layout.haml'
+      renderer:
+        attr_wrapper: '"'
+        format: :html5
+        shared_helper_path: 'shared/lib'
+```
+
+### Compile::Sass
+* compiles sass files to css files
+* supports shared mixins and minimizing
+
+```
+  - compile_sass:
+      enabled: true
+      minimize: true
+      source: 'src.styles://'
+      target: 'dist.styles://'
+      selector: '**/*.css.sass'
+```
+
+### Compile::Coffee
+* compiles coffee files to js files
+* supports minimizing
+
+```
+  - compile_coffee:
+      enabled: true
+      minimize: true
+      source: 'src.scripts://'
+      target: 'dist.scripts://'
+      selector: '**/*.js.coffee'
+```
+
+# Minimize-Generators
+### Minimize::Html
+* minimizes html files and copies to `target`
+* `prefix_extension='.min'` stores athe minimized content from `foo.html` to `foo.min.html`
+
+```
+  - minimize_html:
+      enabled: true
+      source: 'src.public://'
+      target: 'dist.public://'
+      selector: '**/*.html'
+      prefix_extension: ''
+```
+
+### Minimize::Css
+* minimizes css files and copies to `target`
+
+```
+  - minimize_css:
+      enabled: true
+      source: 'src.styles://'
+      target: 'dist.styles://'
+      selector: '**/*.css'
+      prefix_extension: '.min'
+```
+
+#### Minimize::Js
+* minimizes js files and copies to `target`
+
+```
+  - minimize_js:
+      enabled: true
+      source: 'src.scripts://'
+      target: 'dist.scripts://'
+      selector: '**/*.js'
+      prefix_extension: '.min'
+```
+
+### Minimize::Images
+* minimizes image files and copies to `target`
+* uses [Piet](https://github.com/albertbellonch/piet) for image processing
+
+```
+  - minimize_images:
+      enabled: true
+      source: 'src.images://'
+      target: 'dist.images://'
+      selector: '**/*.{jpg,png}'
+      options:
+        quality: 90
+        level: 3
+        verbose: true
+```
+
+## Service-Generators
+#### Service::Bower
+* resolves `src://bower.json` and copies bower_components to target folder
+
+```
+  - service_bower:
+      enabled: true
+      source: 'src://'
+      target: 'dist://lib'
+```
+
+### Service::Grunt
+* resolves `src://Gruntfile.coffee` and runs a `task`
+
+```
+  - service_grunt:
+      enabled: false
+      source: 'src://Gruntfile.coffee'
+      task: 'default'
+```
+
+### Service::Analytics
+* appends tracking codes to the end of head tag to selected html files
+
+```
+  - service_analytics:
+      enabled: true
+      source: 'dist.views://'
+      target: 'dist.views://'
+      selector: '*.html'
+      repetitive:
+        -
+          enabled: true
+          name: 'google'
+          code: "<script>[...] _gaq.push(['_setAccount', '{GOOGLE_UA_ID}']); [...]</script>"
+          params:
+            GOOGLE_UA_ID: 'UA-65996211-1'
+```
+### Service::Sitemap
+* generates a sitemap xml file  based on selected files
+* `blacklist` can be used to exclude files
+
+```
+  - service_sitemap:
+      domain: 'beta.creative-workflow.berlin'
+      enabled: true
+      source: 'dist.views://*.html'
+      target: 'dist.views://sitemap.xml'
+      selector: '**/*.html'
+      blacklist:
+```
+
+
+# Resources
+
+> "[Getting started](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/GETSTARTED.md)"
+
+> "[Configuration](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/CONFIGURATION.md)"
+
+ >"[Contributing](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/CONTRIBUTING.md)"

data/docs/GETSTARTED.md

@@ -0,0 +1,92 @@
+# 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'
+
+For the latest development version use
+
+    gem 'easy_html_generator', git: 'git@github.com:creative-workflow/easy-html-generator.git', branch: 'development-master'
+
+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 haml 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
+
+
+
+# Resources
+
+> "[Configuration](https://github.com/creative-workflow/easy-html-generator/blob/master/docs/CONFIGURATION.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/easy_html_generator.gemspec

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_html_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'easy_html_generator'
+  spec.version     = EasyHtmlGenerator::VERSION
+  spec.licenses    = 'MIT'
+  spec.authors     = ["Tom Hanoldt", "Alex Illmayer"]
+
+  spec.summary     = "This gem is a powerful and easy to use web development tool that helps developing modern web sites by generating static html pagespec."
+  spec.description = "This gem is a powerful and easy to use web development tool that helps developing modern web sites by generating static html pagespec.
+    It uses CoffeScript, Sass, Haml, Bootstrap, HeadJs, Bower, Grunt, Google Anlaytics and minimizes coffee-, javascript-, sass-, css-, png- and image-filespec."
+
+  spec.email       = ['monotom@gmail.com']
+  spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.homepage    = 'https://github.com/creative-workflow/easy-html-generator'
+
+  spec.executables = ["ehg"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.require_paths = ["lib", "src/shared/lib"]
+
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'thin'
+  spec.add_runtime_dependency 'rack-contrib'
+  spec.add_runtime_dependency 'shotgun'
+  spec.add_runtime_dependency 'haml'
+  spec.add_runtime_dependency 'sass'
+  spec.add_runtime_dependency 'coffee-script'
+  spec.add_runtime_dependency 'bootstrap-sass'
+  spec.add_runtime_dependency 'actionview'
+  spec.add_runtime_dependency 'cssminify'
+  spec.add_runtime_dependency 'uglifier'
+  spec.add_runtime_dependency 'htmlcompressor'
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'piet'
+  spec.add_runtime_dependency 'piet-binary'
+  spec.add_runtime_dependency 'xml-sitemap'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'bundler'
+  #spec.add_development_dependency 'ruby-prof'
+end

data/lib/easy_html_generator/checksum.rb

@@ -33,6 +33,10 @@ class EasyHtmlGenerator::Checksum
     @file_checksums.delete(key)
   end
 
+  def self.invalidate_all()
+    @file_checksums = {}
+  end
+
   def self.build_key(file, context = '')
     "#{context}.#{file}"
   end

data/lib/easy_html_generator/config.rb

@@ -68,80 +68,3 @@ class EasyHtmlGenerator::Config
     end
   end
 end
-
-# class EasyHtmlGenerator::Config
-#   def self.from_file(path)
-#     return unless File.exist? path
-#
-#     ConfigHash.new YAML.load(File.open(path))
-#   end
-#
-#   # symbolizes the keys and makes the hash accessable via object attributes
-#   class ConfigHash < Hash
-#     def initialize(hash = nil)
-#       super
-#       return unless hash
-#
-#       hash = self.class.symbolize_keys hash
-#       hash.each { |k, v| self[k] = v }
-#     end
-#
-#     def method_missing(name, *args)
-#       # setter
-#       if /^(\w+)=$/ =~ name
-#         self[Regexp.last_match(1).to_sym] = args[0]
-#       # getter
-#       else
-#         return super.method_missing name unless key? name
-#       end
-#
-#       self[name]
-#     end
-#
-#     def self.symbolize_keys(obj)
-#       case obj
-#       when Array
-#         inject_array(obj)
-#       when Hash
-#         inject_hash(obj)
-#       else
-#         obj
-#       end
-#     end
-#
-#     def self.inject_array(obj)
-#       obj.each_with_object([]) do |res, val|
-#         res << case val
-#                when Hash, Array
-#                  symbolize_keys(val)
-#                else
-#                  val
-#                end
-#         res
-#       end
-#     end
-#
-#     def self.inject_hash(obj)
-#       obj.each_with_object(ConfigHash.new) do |res, (key, val)|
-#         nkey = inject_hash_key key
-#         nval = inject_hash_value val
-#         res[nkey] = nval
-#         res
-#       end
-#     end
-#
-#     def self.inject_hash_key(key)
-#       case key
-#       when String then return key.to_sym
-#       else return key
-#       end
-#     end
-#
-#     def self.inject_hash_value(val)
-#       case val
-#       when Hash, Array then symbolize_keys(val)
-#       else val
-#       end
-#     end
-#   end
-# end

data/lib/easy_html_generator/generator/base.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 require 'colorize'
-require 'fileutils'
-require 'easy_html_generator/generators'
 
 # this is the generator base class
 class EasyHtmlGenerator::Generator::Base
@@ -12,68 +10,36 @@ class EasyHtmlGenerator::Generator::Base
     @config  = config
   end
 
-  def src_path
-    "#{@project.src_path}/#{@config.src}"
-  end
-
-  def dest_path
-    "#{@project.dist_path}/#{@config.dest}"
-  end
-
-  def log_running
-    log "#{self.class.name.yellow}"
+  def enabled?
+    !!@config[:enabled]
   end
 
   def generate
-    return unless @config.enabled
+    return unless enabled?
 
     log_running
 
-    selector  = File.join(src_path, @config.selector)
-
-    FileUtils.mkdir_p dest_path
-
-    walk_files(selector) do |i, o|
-      next unless should_do_file? i
-
-      do_file(i, o)
+    tasks.each do |task|
+      generate! @config.merge(task)
     end
   end
 
-  def walk_files(selector)
-    Dir[selector].each do |input_file|
-      output_file = input_to_output_file(input_file)
-
-      yield(input_file, output_file)
-    end
+  def generate!(_config)
+    fail NotImplementedError.new "#{self.class.name} is an abstract class."
   end
 
-  def should_do_file?(i)
-    EasyHtmlGenerator::Checksum.file_changed? i
+  def repetitive?
+    @config.key? :repetitive
   end
 
-  def input_to_output_file(input_file)
-    input_file.sub(src_path, dest_path)
-  end
+  def tasks
+    return [@config] unless repetitive?
 
-  def do_input(input, *_args)
-    input
+    @config[:repetitive]
   end
 
-  def do_file(src, target, *args)
-    return unless File.exist?(src) && File.file?(src)
-
-    log "-> do_file #{src.sub(@project.src_path, '').green}"
-
-    FileUtils.mkdir_p File.dirname(target)
-
-    args.push target
-    i = File.read(src)
-    o = do_input(i, *args)
-
-    File.write(target, o)
-
-    EasyHtmlGenerator::Checksum.store_file(src)
+  def log_running
+    log "#{self.class.name.yellow}"
   end
 
   def log(msg)
@@ -81,15 +47,11 @@ class EasyHtmlGenerator::Generator::Base
       .sub('EasyHtmlGenerator::', '')}"
   end
 
-  def resolve_path_prefix(path, default_prefix = '')
-    if path.include? 'src://'
-      default_prefix = @project.src_path
-      path.sub!('src://', '')
-    end
-    if path.include? 'dist://'
-      default_prefix = @project.dist_path
-      path.sub!('dist://', '')
-    end
-    File.join(default_prefix, path)
+  def file_changed?(file)
+    EasyHtmlGenerator::Checksum.file_changed? file
+  end
+
+  def store_file_hash(file)
+    EasyHtmlGenerator::Checksum.store_file(file)
   end
 end

data/lib/easy_html_generator/generator/combine.rb

@@ -6,26 +6,16 @@ require 'easy_html_generator/generator/base'
 class EasyHtmlGenerator::Generator::Combine <
   EasyHtmlGenerator::Generator::Base
 
-  def generate
-    return unless @config.enabled
-
-    log_running
-
-    @config.packages.each do |config|
-      do_config config
-    end
-  end
-
-  def do_config(config)
-    target_file = resolve_path_prefix(config.file, @project.dist_path)
-    o = ''
-    config.files.each do |file_pattern|
-      resolved_pattern = resolve_path_prefix(file_pattern, @project.dist_path)
-      Dir[resolved_pattern].each do |file|
-        next if target_file == file
-        o += File.read(file) + "\n"
+  def generate!(config)
+    result = ''
+    config.sources.each do |file_pattern|
+      Dir[file_pattern].each do |file|
+        next if config.target == file
+        result += File.read(file) + "\n"
       end
     end
-    File.write(target_file, o)
+    FileUtils.mkdir_p File.dirname(config.target)
+
+    File.write(config.target, result)
   end
 end

data/lib/easy_html_generator/generator/compile/base.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'colorize'
+
+# this is the generator base class
+class EasyHtmlGenerator::Generator::Compile::Base <
+  EasyHtmlGenerator::Generator::Base
+
+  def generate!(config)
+    walk_files(config) do |input_file, output_file|
+      next unless file_changed? input_file
+
+      do_file(input_file, output_file, config)
+    end
+  end
+
+  def walk_files(config)
+    selector = File.join(config.source, config.selector)
+
+    Dir[selector].each do |input_file|
+      output_file = input_to_output_file(input_file, config)
+
+      yield(input_file, output_file)
+    end
+  end
+
+  def input_to_output_file(input_file, config)
+    input_file.sub(config.source, config.target)
+  end
+
+  def do_input!(_input, _input_file)
+    fail NotImplementedError.new "#{self.class.name} is an abstract class."
+  end
+
+  def do_file(input_file, output_file, config)
+    return unless File.exist?(input_file) && File.file?(input_file)
+
+    log "-> do_file #{input_file.sub(@project.src_path, '').green}"
+
+    FileUtils.mkdir_p File.dirname(output_file)
+
+    input_content  = File.read(input_file)
+
+    output_content = do_input!(input_content, input_file, output_file, config)
+
+    store_file_hash(input_file)
+
+    return unless output_content
+
+    File.write(output_file, output_content)
+  end
+end

data/lib/easy_html_generator/generator/compile/coffee.rb

@@ -1,30 +1,23 @@
 # encoding: utf-8
 require 'coffee_script'
-require 'easy_html_generator/generator/base'
+require 'easy_html_generator/generator/compile/base'
 
 # this generator coffee sass files from src folder and copies them
 # to the dist folder
 class EasyHtmlGenerator::Generator::Compile::Coffee <
-  EasyHtmlGenerator::Generator::Base
+  EasyHtmlGenerator::Generator::Compile::Base
 
-  def initialize(project, config)
-    super(project, config)
-
-    @config.src  = project.config.paths.src.scripts
-    @config.dest = project.config.paths.dist.scripts
-  end
-
-  def do_input(input, src = 'inline')
+  def do_input!(input, input_file = 'inline', *_args)
     result = CoffeeScript.compile input
 
     return result unless @config.minimize
 
     EasyHtmlGenerator::Generator::Minimize::Js.compress result
   rescue StandardError => e
-    raise e, "#{e.message} in #{src} ", e.backtrace
+    raise e, "#{e.message} in #{input_file} ", e.backtrace
   end
 
-  def input_to_output_file(i)
-    super(i).gsub('.js.coffee', '.js')
+  def input_to_output_file(input_file, config)
+    super(input_file, config).gsub('.js.coffee', '.js')
   end
 end