hldr 0.1.1

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/Readme.md

@@ -0,0 +1,78 @@
+# Hldr
+A Ruby gem to generate portable interactive documents by compiling all linked assets from an HTML document into a single file (rendered to `stdout`). The value of the Word document is diminishing by the minute!
+
+Suppose you have a somewhat complicated, well broken out HTML document or front-end prototype that you want to quickly show a non-technical colleague, Bernard. Your document may look like this:
+
+    .
+    └── img
+    │   ├── icons
+    │   │   └── star.png
+    │   └── cake_decors.png
+    │   └── kittens.png
+    ├── js
+    │   ├── app.js
+    │   └── jquery.js
+    ├── css
+    │   ├── app.css
+    │   └── bootstrap.css
+    │
+    └── cakeRecipe.html
+
+Wouldn't it be great if we could quickly compile all of this into a **single** file to give Bernard?
+
+    $ hldr cakeRecipe.html > flatfile.html
+
+![There can be only be one](http://cdn1-www.craveonline.com/assets/uploads/2011/01/file_130400_2_highlander04.jpg)
+
+Yeah, obviously the output is a lot bigger than the original structure or a zip archive (especially if embedding images), but this is easier and cleaner for all parties involved. The vision for Hldr is twofold:
+
+1. Allowing (even non-technical) content creators to more easily leverage powerful interactive frameworks within their document.
+1. Make HTML front-end prototype sharing quick and easy.
+
+## Usage
+
+Installation is simple, just suck down the gem via `gem install hldr`
+
+## Really advanced usage
+
+    $ hldr new cakeRecipe
+    $ cd cakeRecipe
+
+    $ hldr add bootstrap-3.0.0-rc2 
+    $ hldr add jquery-mobile js
+    $ hldr add d3 js
+    $ hldr add flatui css
+    $ hldr add anotherCssJsFw
+
+As a bonus, swapping out assets is a breeze: 
+
+    $ hldr rm bootstrap-3.0.0-rc2
+    $ hldr add bootstrap-2.3.0
+    $ hldr cakeRecipe.md > flatCakeRecipeFile.html
+
+## Example Config File
+
+    scaffolding:
+      - http://somecdn.com/css/bootstrap.min.css
+      - http://somecdn.com/js/BBD-G23-4SIOU23-452 : js
+
+## The Future
+- [x] ship anything
+- [ ] compress images, html, js and css 
+- [ ] templates
+- [ ] support md
+- [ ] support haml
+- [ ] Keep everything in .hldr cache
+- [ ] fetch remotes
+- [ ] support inline of css `@import`
+- [ ] support inline of css `@import` media queries
+- [ ] support inline of css fonts 
+- [ ] option to compress images below 32k for IE8 support
+- [ ] support css image inline
+- [ ] create gem that installs to path
+- [ ] handle css, scss, less, sass
+- [ ] handle requireJs
+- [ ] set max cache size in config
+
+## Bugs
+* Handle malformed input (ie file not found, etc)

data/bin/hldr

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'hldr/hldr_entry'

data/lib/hldr.rb

@@ -0,0 +1,2 @@
+require 'hldr/hldr_entry'
+

data/lib/hldr/hldr_entry.rb

@@ -0,0 +1,53 @@
+require 'trollop'
+require 'hldr/hldr_processor'
+require 'hldr/hldr_globals'
+
+hldr_opts = Trollop::options do
+  version "Hldr #{HLDR_VERSION} (c) 2013 Nate Fisher. \n\nThere can be only one!"
+  banner <<-EOS
+Hldr - Generate a flat HTML file from linked assets.
+
+Usage:
+    hldr [options] <file>
+    hldr <command> [args]
+
+Examples:
+    hldr index.html > flat.html
+    hldr index.md > flat.html
+
+Commands: 
+    update      Updates external content in the config file and stores to cache
+    init        Creates a config file
+    new NAME    Creates a new document folder, empty contents and a config file
+
+Options:
+
+EOS
+
+  opt :no_embed, "Inhibits base64 data URI image embedding", :default => true
+
+end
+
+hldr_cmd = ARGV.shift 
+case hldr_cmd
+  when "update" 
+        # update cache from config file
+  when "init"
+        # create config file
+        HldrProcessor::generate_config
+        HldrProcessor::generate_cache
+  when "new"  
+    if ARGV.first.nil?
+        puts "Name of document required for NEW command."
+    else
+        # create project folder
+    end
+  else
+    # no subcommand entered
+    if hldr_cmd.nil? 
+        Trollop::die "No input given."
+    else
+        # Processing file
+        puts HldrProcessor.new(hldr_cmd, hldr_opts).to_s
+    end
+  end

data/lib/hldr/hldr_globals.rb

@@ -0,0 +1 @@
+HLDR_VERSION = "0.1.1"

data/lib/hldr/hldr_processor.rb

@@ -0,0 +1,86 @@
+require 'nokogiri'
+require 'yaml'
+require 'hldr/inliners/script_inliner'
+require 'hldr/inliners/image_inliner'
+require 'hldr/inliners/style_inliner'
+
+class HldrProcessor
+
+    def initialize(location, options)
+        begin
+            @doc = Nokogiri::HTML(open(location))
+        rescue
+            puts "Could not open input file '#{location}'"
+            exit(1)
+        end
+            @options = options
+    end
+
+    def to_s
+
+        ## add config file scaffolding
+        add_scaffolding
+
+        ## process inlining
+        inline_assets
+        
+        return @doc.to_html
+
+    end
+
+    def add_scaffolding
+
+        hldr_config = YAML.load_file('.hldrconfig')
+        hldr_config["scaffolding"].each do |resource|
+
+            # if ends in .css or is a hash with value of css, add style
+            if resource[-4..-1] == ".css"
+                
+                css_res = Nokogiri::XML::Node.new "style", @doc
+                css_res.content = open(resource).read
+                css_res[:type] = "text/css"
+
+                head = @doc.at_css("html") 
+                head << css_res
+                
+            end
+
+        end 
+
+    end
+
+    def inline_assets
+
+        inliners = {
+            :link   => StyleInliner, 
+            :script => ScriptInliner
+        }
+
+        # inhibit embedding images if flag set
+        if @options[:no_embed]
+            inliners[:img] = ImageInliner
+        end
+
+        inliners.each do |tag, inliner|
+
+            @doc.css(tag.to_s).each do |element| 
+                inliner::embed(element) 
+            end
+
+        end
+
+        
+
+    end
+
+    # creates a cache location
+    def HldrProcessor.generate_cache
+        Dir::mkdir ".hldr" if !Dir::exist? ".hldr"
+    end
+
+    # creates a new config file
+    def HldrProcessor.generate_config
+        File::open ".hldrconfig", "w" if !File::exist? ".hldrconfig"
+    end
+
+end

data/lib/hldr/inliners/image_inliner.rb

@@ -0,0 +1,19 @@
+require 'base64'
+require 'hldr/inliners/inliner'
+
+class ImageInliner < Inliner
+    def ImageInliner.embed(element)
+
+        # try to retrieve content
+        content = getContent(element[:src])
+        return if content[:data].nil?
+
+        # create embedded data uri 
+        data = "data:#{content[:type]};base64,"
+        data += Base64::encode64(content[:data])
+
+        # embed content
+        element[:src] = data
+
+    end 
+end

data/lib/hldr/inliners/inliner.rb

@@ -0,0 +1,48 @@
+require 'open-uri'
+
+class Inliner
+
+    def Inliner.get_image_extension(local_file_path)
+        # take from Alain Beauvois's post in
+        # http://stackoverflow.com/questions/4600679/detect-mime-type-of-uploaded-file-in-ruby
+        
+        png = Regexp.new("\x89PNG".force_encoding("binary"))
+        jpg = Regexp.new("\xff\xd8\xff\xe0\x00\x10JFIF".force_encoding("binary"))
+        jpg2 = Regexp.new("\xff\xd8\xff\xe1(.*){2}Exif".force_encoding("binary"))
+
+        case IO.read(local_file_path, 10)
+        when /^GIF8/
+            'image/gif'
+        when /^#{png}/
+            'image/png'
+        when /^#{jpg}/
+            'image/jpg'
+        when /^#{jpg2}/
+            'image/jpg'
+        else
+            mime_type = `file #{local_file_path} --mime-type`.gsub("\n", '') # Works on linux and mac
+            raise UnprocessableEntity, "unknown file type" if !mime_type
+            mime_type.split(':')[1].split('/')[1].gsub('x-', '').gsub(/jpeg/, 'jpg').gsub(/text/, 'txt').gsub(/x-/, '')
+        end  
+
+    end
+
+    def Inliner.getContent(location)
+
+        content = Hash.new
+
+        begin
+            if location[0..3] == "http"
+                content[:data] = open(location).read
+                content[:type] = open(location).meta["content-type"]
+            else
+                content[:data] = File::open(location, "rb").read
+                content[:type] = self.get_image_extension(location)
+            end 
+        rescue
+        end
+
+        return content
+
+    end
+end

data/lib/hldr/inliners/script_inliner.rb

@@ -0,0 +1,25 @@
+require 'hldr/inliners/inliner'
+
+class ScriptInliner < Inliner
+    def ScriptInliner.embed(element)
+        
+        # ignore if content exists within tags
+        return if element.content &&
+            !element.content.strip.empty?
+
+        # try to retrieve content
+        content = getContent(element[:src])
+        return if content[:data].nil?
+
+        # remove src attribute
+        element.attributes["src"].remove
+
+        # force script type to javascript if null
+        element[:type] = "text/javascript" if 
+            element[:type].nil? || element[:type] == ""
+        
+        # embed content
+        element.content = content[:data]
+
+    end
+end

data/lib/hldr/inliners/style_inliner.rb

@@ -0,0 +1,29 @@
+require 'hldr/inliners/inliner'
+
+class StyleInliner < Inliner
+    def StyleInliner.embed(element)
+
+        # try to retrieve content
+        content = getContent(element[:href])
+        return if content[:data].nil?
+
+        # keep media and type; remove all other params
+        whitelist = ["type", "media"]
+        element.attributes.each do |key, val|
+            if !whitelist.include?(key)
+                element.attributes[key].remove
+            end
+        end
+
+        # force rel type to style if null
+        element[:type] = "text/css" if 
+            element[:type].nil? || element[:type] == ""
+
+        # rename tag to style
+        element.name = "style"
+
+        # embed content
+        element.content = content[:data]
+
+    end 
+end

data/test/test_inliner.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'hldr'
+
+class HldrProcessorTest < Test::Unit::TestCase
+  def test_something
+    assert_equal 1,1
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: hldr
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Nate Fisher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: ! 'Hldr is a utility to compile all linked assets from an html document
+  into a single file, rendered to STDOUT. The point is to allow content creators to
+  more easily use powerful interactive frameworks within their document. '
+email: nate.scott.fisher@gmail.com
+executables:
+- hldr
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/hldr
+- lib/hldr.rb
+- lib/hldr/inliners/image_inliner.rb
+- lib/hldr/inliners/inliner.rb
+- lib/hldr/inliners/style_inliner.rb
+- lib/hldr/inliners/script_inliner.rb
+- lib/hldr/hldr_processor.rb
+- lib/hldr/hldr_entry.rb
+- lib/hldr/hldr_globals.rb
+- test/test_inliner.rb
+- Readme.md
+- Rakefile
+homepage: http://github.com/thenatefisher/hldr
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generate a flat HTML file from linked assets
+test_files: []