easy_html_generator 1.0.0

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

@@ -0,0 +1,70 @@
+# encoding: utf-8
+require 'fileutils'
+require 'haml'
+require 'easy_html_generator/generator/base'
+
+# this generator compiles haml files from src folder and copies them
+# to the dist folder
+class EasyHtmlGenerator::Generator::Compile::Haml <
+  EasyHtmlGenerator::Generator::Base
+
+  require 'easy_html_generator/generator/compile/haml/context'
+  require 'easy_html_generator/generator/compile/haml/layout'
+
+  def initialize(project, config)
+    super(project, config)
+    @config.src  = project.config.paths.src.views
+    @config.dest = project.config.paths.dist.views
+  end
+
+  def do_input(input, layout, context, scope, _input_file)
+    # If the file being processed by Haml contains a yield statement,
+    # the block passed to "render" will be called when it's hit.
+    result = layout.render(context, body_class: scope) do
+      # Render the actual page contents in place of the call to "yield".
+      body   = Haml::Engine.new(input, @config.renderer)
+      body.render(context)
+    end
+
+    return result unless @config.minimize
+
+    EasyHtmlGenerator::Generator::Minimize::Html.compress result
+  end
+
+  def should_do_file?(i)
+    # dont check if file changed, because partials could have changed
+    !File.basename(i).start_with? '_'
+  end
+
+  def input_to_output_file(i)
+    super(i).gsub('.html.haml', '.html')
+  end
+
+  def generate
+    return unless @config.enabled
+
+    log_running
+
+    FileUtils.mkdir_p dest_path
+
+    walk_files(File.join(src_path, @config.selector)) do |i, o|
+      next unless should_do_file? i
+
+      compile_file i, o
+    end
+  end
+
+  def compile_file(src, target)
+    file_name = File.basename src
+    scope     = file_name.split('.').first
+    context   = Context.new(@project, @config, scope)
+    layout    = Layout.layout_from_file(@project.src_path_to(:views),
+                                        src, @config.renderer)
+
+    begin
+      do_file(src, target, layout, context, scope)
+    rescue StandardError => e
+      raise e, "#{e.message} in #{src} ", e.backtrace
+    end
+  end
+end

data/lib/easy_html_generator/generator/compile/haml/context.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'action_view'
+
+helper_path = 'easy_html_generator/generator/compile/haml/helper'
+require "#{helper_path}/activesupport_override.rb"
+require "#{helper_path}/asset_helper.rb"
+
+# this class represents the render context for a haml file
+class EasyHtmlGenerator::Generator::Compile::Haml::Context
+  # Any properties of this object are available in the Haml templates.
+  attr_reader :project
+
+  include ActionView::Helpers
+  include ActivesupportOverride
+  include AssetHelper
+
+  def initialize(project, config, scope)
+    @config       = config
+    @project      = project
+    @scope        = scope
+    @input_folder = @project.src_path_to :views
+
+    load_helper EasyHtmlGenerator::SHARED_HELPER_PATH
+    load_helper @project.src_path_to :helper
+  end
+
+  def load_helper(folder)
+    Dir.glob("#{folder}/**/*.rb").each do |path|
+      load path
+      file_without_ext = path.split('/')[-1].split('.').first
+      module_name      = file_without_ext.classify
+      STDERR.puts "  | -> loading haml helper: #{module_name.green}"
+      self.class.send(:include, module_name.constantize)
+    end
+  end
+
+  def render_partial(file_name)
+    file_to_render = "#{@input_folder}/#{file_name}.haml"
+    if @scope
+      # Look for a partial prefixed with the current "scope"
+      # (which is just the name of the primary template being rendered).
+      scope_file = "#{@input_folder}/#{@scope}_#{file_name}.haml"
+      # Use it if it's there.
+      file_to_render = scope_file if File.exist? scope_file
+    end
+    if File.exist? file_to_render
+      Haml::Engine.new(File.read(file_to_render), @config).render self
+    end
+  rescue StandardError => e
+    raise e, "#{e.message} in #{file_name} ", e.backtrace
+  end
+end

data/lib/easy_html_generator/generator/compile/haml/helper/activesupport_override.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+# this module overrides some active support methods for working paths etc.
+module ActivesupportOverride
+  def stylesheet_link_tag(path, media = 'screen')
+    '<link href="' + path_to_css(path) + '" media="' + media +
+      '" rel="stylesheet" type="text/css" />'
+  end
+
+  def javascript_include_tag(path)
+    '<script src="' + path_to_js(path) + '"></script>'
+  end
+
+  def meta_tag(type, content)
+    '<meta name="' + type + '" content="' + content + '" />'
+  end
+
+  def meta_tag_http(type, content)
+    '<meta http-equiv="' + type + '" content="' + content + '" />'
+  end
+
+  def link_tag(source, relation, type = '')
+    type = " type='#{type}'" if type
+    '<link rel="' + relation + '" href="' + source + '"' + type + '/>'
+  end
+
+  def path_to_css(path)
+    return path if external_path?(path)
+    test = @project.uri_path_to(:styles, path)
+    file_exists?(test) ? test : path
+  end
+
+  def path_to_js(path)
+    return path if external_path? path
+    test = @project.uri_path_to(:scripts, path)
+    file_exists?(test) ? test : path
+  end
+
+  def path_to_image(path)
+    return path if external_path? path
+    test = @project.uri_path_to(:images, path)
+    file_exists?(test) ? test : path
+  end
+
+  #  def url_for(options = '')
+  #  return options
+  #  end
+end

data/lib/easy_html_generator/generator/compile/haml/helper/asset_helper.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require 'coffee-script'
+require 'uglifier'
+
+# this module exposes additional features for haml files
+module AssetHelper
+  include ActionView::Context
+
+  def external_path?(path)
+    path.start_with?('//') || path.start_with?('http')
+  end
+
+  def file_exists?(path)
+    File.exist? File.join(EasyHtmlGenerator::DIST_PATH, path)
+  end
+
+  def with_coffee(&block)
+    input = capture_haml(&block)
+    content_tag :script do
+      raw @project.generators.compile_coffee.do_input input
+    end
+  end
+
+  def with_sass(&block)
+    input = capture_haml(&block)
+    content_tag :style do
+      raw @project.generators.compile_sass.do_input input
+    end
+  end
+
+  def glyph_icon_classes(icon)
+    "glyphicon glyphicon-#{icon}"
+  end
+
+  def glyph_icon(icon, content = '')
+    content_tag(:span, content, class: glyph_icon_classes(icon))
+  end
+
+  def headjs_javascript_include_tag(tag, path)
+    content_tag :script do
+      raw "head.load({'#{tag}': '#{path_to_js(path)}'});"
+    end
+  end
+
+  def headjs_stylesheet_link_tag(tag, path)
+    headjs_javascript_include_tag(tag, path_to_css(path))
+  end
+
+  def inline_stylesheet_link_tag(path)
+    return path if external_path?(path)
+
+    styles_path = @project.dist_path_to(:styles, path)
+    if File.exists? styles_path
+      path = styles_path
+    else
+      path = File.join(@project.dist_path, path)
+    end
+
+    content_tag :style do
+      raw @project.generators.minimize_css.do_input File.read(path)
+    end
+  end
+
+  def inline_javascript_include_tag(path)
+    return path if external_path?(path)
+
+    scripts_path = @project.dist_path_to(:scripts, path)
+    if File.exists? scripts_path
+      path = scripts_path
+    else
+      path = File.join(@project.dist_path, path)
+    end
+
+    content_tag :script do
+      raw @project.generators.minimize_js.do_input File.read(path)
+    end
+  end
+end

data/lib/easy_html_generator/generator/compile/haml/layout.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+# this class helps with haml layout files
+class EasyHtmlGenerator::Generator::Compile::Haml::Layout
+  @layouts = {}
+
+  def self.layout_from_file(haml_folder, template, haml_config)
+    first_line = File.readlines(template).first
+
+    if first_line.include? '-# ehg layout:'
+      name = first_line.sub('-# ehg layout:', '').strip
+    else
+      name = 'layout'
+    end
+
+    path  = "#{haml_folder}#{name}.haml"
+    path  = "#{haml_folder}layout.haml" unless File.exist? path
+
+    load_from_file(path, haml_config) if should_load_from_file path
+
+    @layouts[path]
+  end
+
+  def self.should_load_from_file(layout_file)
+    return true unless @layouts.key? layout_file
+    EasyHtmlGenerator::Checksum.file_changed? layout_file
+  end
+
+  def self.load_from_file(layout_file, haml_config)
+    fail "layout not found '#{path}'" unless File.exist? layout_file
+    @layouts[layout_file] = Haml::Engine.new(File.read(layout_file),
+                                             haml_config)
+    EasyHtmlGenerator::Checksum.store_file(layout_file)
+  end
+end

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

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'sass'
+
+require 'easy_html_generator'
+require 'easy_html_generator/generator/base'
+
+# this generator compiles sass files from src folder and copies them
+# to the dist folder
+class EasyHtmlGenerator::Generator::Compile::Sass <
+  EasyHtmlGenerator::Generator::Base
+
+  def self.add_load_path(path)
+    ::Sass.load_paths << path unless ::Sass.load_paths.include?(path)
+  end
+
+  add_load_path EasyHtmlGenerator::SHARED_STYLES_PATH
+
+  def initialize(project, config)
+    super(project, config)
+
+    self.class.add_load_path "#{@project.src_path_to :styles}"
+
+    @config.src  = project.config.paths.src.styles
+    @config.dest = project.config.paths.dist.styles
+  end
+
+  def do_input(input, src='inline')
+    renderer = ::Sass::Engine.new(input)
+    result   = renderer.render
+
+    return result unless @config.minimize
+
+    EasyHtmlGenerator::Generator::Minimize::Css.compress result
+  rescue StandardError => e
+    raise e, "#{e.message} in #{src} ", e.backtrace
+  end
+
+
+  def should_do_file?(i)
+    # dont check if file changed, because partials could have changed
+    !File.basename(i).start_with? '_'
+  end
+
+  def input_to_output_file(i)
+    super(i).gsub('.css.sass', '.css')
+  end
+end

data/lib/easy_html_generator/generator/copy.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'fileutils'
+require 'easy_html_generator/generator/base'
+
+# this generator copies files from src ro dist folder
+class EasyHtmlGenerator::Generator::Copy < EasyHtmlGenerator::Generator::Base
+  def generate
+    return unless @config.enabled
+
+    log_running
+
+    @config.dirs.each do |config|
+      src_path  = "#{@project.src_path}/#{config.source}"
+      dest_path = "#{@project.dist_path}/#{config.target}"
+
+      self.class.copy_r(src_path, dest_path, config.selector)
+    end
+  end
+
+  # cannot use copy_entry or cp_r with symbolic existent links in target
+  # FileUtils::copy_entry(src_dir, output_folder, true, false, true)
+  # if File.directory? src_dir
+  def self.copy_r(src_path, dest_path, selector)
+    return unless File.exist? src_path
+
+    FileUtils.mkdir_p dest_path
+
+    Dir[File.join(src_path, selector)].each do |input_file|
+      next if input_file.empty?
+
+      output_file = input_file.sub(src_path, dest_path)
+
+      copy(input_file, output_file)
+    end
+  end
+
+  def self.copy(input_file, output_file)
+    if File.directory? input_file
+      FileUtils.mkdir_p(output_file) unless File.exist? output_file
+    else
+      FileUtils.copy input_file, output_file
+    end
+  end
+end

data/lib/easy_html_generator/generator/delete.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'fileutils'
+require 'easy_html_generator/generator/base'
+
+# this generator deletes in the dest folder
+class EasyHtmlGenerator::Generator::Delete < EasyHtmlGenerator::Generator::Base
+  def generate
+    return unless @config.enabled
+
+    log_running
+
+    @config.files.each do |file_pattern|
+      Dir[File.join(@project.dist_path, file_pattern)].each do |file|
+        EasyHtmlGenerator::Checksum.invalidate_file file
+
+        FileUtils.rm_rf file
+      end
+    end
+  end
+end

data/lib/easy_html_generator/generator/minimize/css.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'cssminify'
+require 'easy_html_generator/generator/base'
+
+# this generator minifies css files from src folder and copies them
+# to the dist folder
+class EasyHtmlGenerator::Generator::Minimize::Css <
+  EasyHtmlGenerator::Generator::Base
+
+  def initialize(project, config)
+    super(project, config)
+
+    @config.src  = project.config.paths.src.styles
+    @config.dest = project.config.paths.dist.styles
+  end
+
+  def do_input(input, *_args)
+    self.class.compress input
+  end
+
+  def input_to_output_file(i)
+    super(i).gsub('.css', "#{@config.prefix_extension}.css")
+  end
+
+  def self.compress(input)
+    CSSminify.compress input
+  end
+end

data/lib/easy_html_generator/generator/minimize/html.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'htmlcompressor'
+require 'easy_html_generator/generator/base'
+
+# this generator minifies html files from src folder and copies them
+# to the dist folder
+class EasyHtmlGenerator::Generator::Minimize::Html <
+  EasyHtmlGenerator::Generator::Base
+
+  def initialize(project, config)
+    super(project, config)
+
+    @config.src  = project.config.paths.src.views
+    @config.dest = project.config.paths.dist.views
+  end
+
+  def do_input(input, *_args)
+    self.class.compress input
+  end
+
+  def input_to_output_file(i)
+    super(i).gsub('.html', "#{@config.prefix_extension}.html")
+  end
+
+  def self.compressor
+    @compressor ||= HtmlCompressor::Compressor.new
+  end
+
+  def self.compress(input)
+    compressor.compress input
+  end
+end