hldr 0.1.1 → 0.1.8

data/Readme.md

@@ -1,6 +1,4 @@
 # 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:
 
     .
@@ -22,57 +20,56 @@ Wouldn't it be great if we could quickly compile all of this into a **single** f
 
     $ 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)
+![There can be only be one](http://i.imgflip.com/4cgiz.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.
+1. Allow (even non-technical) content creators to more easily leverage modern interactive frameworks within their document.
+1. Make server-less (and connection-less) HTML content and front-end prototype sharing quick and easy.
 
-## Usage
+## Setup
 
 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: 
+You can then immediately use the binary on any HTML file (`hldr document.html`), or you can have Hldr help you setup a new document with popular frameworks (see next section).
 
-    $ hldr rm bootstrap-3.0.0-rc2
-    $ hldr add bootstrap-2.3.0
-    $ hldr cakeRecipe.md > flatCakeRecipeFile.html
+## Environment File
 
-## Example Config File
+This file (`.hldrenv`) resides in the project root and can help you jump start a project by adding libraries and frameworks quickly. If you already have a resource linked into your HTML file, you would not want to have it in this file as well. An environment file can be created with `hldr init` or `hldr new NAME`
 
     scaffolding:
       - http://somecdn.com/css/bootstrap.min.css
       - http://somecdn.com/js/BBD-G23-4SIOU23-452 : js
 
+Using it is simple. Just specify the remote resources you want included and Hldr will always inline the content. If the resource type cannot be determined by extension, it will be ignored. However, you can force a content type by using a colon and then the type (which can be either `js` or `css`). 
+
+## Limitations
+
+1. The file is going to be big. If you choose to embed images, it will be significantly larger than referencing them externally. However, this isn't too big a deal for a small amount of images. Also, if you decide against this feature, it's easily disabled with the `--no-images` flag.
+1. Internet Explorer 8 will not show any embedded image data over 32k. Awesome, right? 
+
 ## 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)
+* compress images, html, js and css 
+* templates
+* keep everything in .hldr cache
+* set max cache size in config
+* 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
+* support input files outside of pwd
+* support remote input
+* support markdown input
+* support haml input
+
+## Contributing
+
+Gitty up! If you love it and you know it, send a pull request!
+
+## License
+
+Hldr is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/bin/hldr

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

data/lib/hldr.rb

@@ -1,2 +1,63 @@
-require 'hldr/hldr_entry'
+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
+
+Commands: 
+    init        Creates a env file
+    new NAME    Creates a new document folder, empty contents and a env file
+
+Options:
+
+EOS
+
+  opt :images, "Embeds images as base64 in the data URI (allows you to embed images into the HTML file)", :default => true
+
+end
+
+hldr_cmd = ARGV.shift 
+case hldr_cmd
+
+  when "init"
+    # create env and cache
+    HldrProcessor::generate_env
+    HldrProcessor::generate_cache
+
+  when "new"  
+    if ARGV.first.nil?
+        Trollop::die "Name of project required for NEW command"
+    else
+        # create project folder
+        if !Dir::exist? ARGV.first
+          if Dir::mkdir ARGV.first
+            # create content file
+            File::open File::join(ARGV.first, "#{ARGV.first}.html"), "w"
+            # create env file and cache
+            HldrProcessor::generate_env(ARGV.first)
+            HldrProcessor::generate_cache(ARGV.first)
+          end
+        end
+    end
+
+  else
+    if hldr_cmd.nil? 
+        # no command entered
+        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

@@ -1 +1,3 @@
-HLDR_VERSION = "0.1.1"
+HLDR_VERSION = "0.1.8"
+HLDR_ENV = ".hldrenv"
+HLDR_CACHE = ".hldr"

data/lib/hldr/hldr_processor.rb

@@ -3,6 +3,7 @@ require 'yaml'
 require 'hldr/inliners/script_inliner'
 require 'hldr/inliners/image_inliner'
 require 'hldr/inliners/style_inliner'
+require 'hldr/hldr_globals'
 
 class HldrProcessor
 
@@ -28,20 +29,62 @@ class HldrProcessor
 
     end
 
+    # inline resources specified in the ENV file
     def add_scaffolding
 
-        hldr_config = YAML.load_file('.hldrconfig')
+        # load yaml env file
+        env_path = File::join(Dir::pwd, HLDR_ENV)
+
+        return if !File::exists? env_path
+        return if File.zero?(env_path)
+        hldr_config = YAML.load_file(env_path)
+
+        # ensure scaffolding section is defined
+        return if !hldr_config || 
+            hldr_config["scaffolding"].nil? || 
+            hldr_config["scaffolding"].empty?
+
         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"
+            if (resource[-4..-1] == ".css") || 
+                (resource.is_a?(Hash) && resource[resource.keys.first] == "css")
+
+                begin
+                    css_res = Nokogiri::XML::Node.new "style", @doc
+                    res_handler = open(resource)
+                    next if !res_handler
+
+                    css_res.content = res_handler.read
+                    css_res[:type] = "text/css"
+                    head = @doc.at_css("html") 
+                    head << css_res if !head.nil?
+
+                    res_handler.close
+                rescue
+                    next
+                end
                 
-                css_res = Nokogiri::XML::Node.new "style", @doc
-                css_res.content = open(resource).read
-                css_res[:type] = "text/css"
+            end
 
-                head = @doc.at_css("html") 
-                head << css_res
+            # if ends in .js or is a hash with value of js, add script
+            if (resource[-4..-1] == ".js") || 
+                (resource.is_a?(Hash) && resource[resource.keys.first] == "js")
+
+                begin
+                    css_res = Nokogiri::XML::Node.new "script", @doc
+                    res_handler = open(resource)
+                    next if !res_handler
+
+                    css_res.content = res_handler.read
+                    css_res[:type] = "text/javascript"
+                    head = @doc.at_css("html") 
+                    head << css_res if !head.nil?
+
+                    res_handler.close
+                rescue
+                    next
+                end
                 
             end
 
@@ -49,6 +92,7 @@ class HldrProcessor
 
     end
 
+    # copy all asset content directly into the original document
     def inline_assets
 
         inliners = {
@@ -57,7 +101,7 @@ class HldrProcessor
         }
 
         # inhibit embedding images if flag set
-        if @options[:no_embed]
+        if @options[:images]
             inliners[:img] = ImageInliner
         end
 
@@ -69,18 +113,33 @@ class HldrProcessor
 
         end
 
-        
-
     end
 
-    # creates a cache location
-    def HldrProcessor.generate_cache
-        Dir::mkdir ".hldr" if !Dir::exist? ".hldr"
+    # creates a cache location (optionally in another path)
+    def HldrProcessor.generate_cache(path=nil)
+        # guard against bogus path
+        return nil if (!path.nil? && !Dir::exist?(path))
+
+        dir_path = File::join(Dir::pwd, HLDR_CACHE)
+        dir_path = File::join(path, HLDR_CACHE) if path
+
+        Dir::mkdir(dir_path) if !Dir::exist? dir_path
     end
 
-    # creates a new config file
-    def HldrProcessor.generate_config
-        File::open ".hldrconfig", "w" if !File::exist? ".hldrconfig"
+    # creates a new config file (optionally in another path)
+    def HldrProcessor.generate_env(path=nil)
+        # guard against bogus path
+        return nil if (!path.nil? && !Dir::exist?(path))
+
+        env_path = File::join(Dir::pwd, HLDR_ENV)
+        env_path = File::join(path, HLDR_ENV) if path
+
+        if !File::exist? env_path
+            env_file = File::open(env_path, "w") 
+            env_file.write("scaffolding:\n")
+            env_file.close
+        end
+
     end
 
 end

data/lib/hldr/inliners/inliner.rb

@@ -33,11 +33,19 @@ class Inliner
 
         begin
             if location[0..3] == "http"
-                content[:data] = open(location).read
-                content[:type] = open(location).meta["content-type"]
+                handler = open(location)
+                return if !handler
+
+                content[:data] = handler.read
+                content[:type] = handler.meta["content-type"]
+                handler.close
             else
-                content[:data] = File::open(location, "rb").read
+                handler = File::open(location, "rb")
+                return if !handler
+                
+                content[:data] = handler.read
                 content[:type] = self.get_image_extension(location)
+                handler.close
             end 
         rescue
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hldr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -43,12 +43,11 @@ files:
 - 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
+homepage: http://thenatefisher.github.io/hldr
 licenses:
 - MIT
 post_install_message: 

data/lib/hldr/hldr_entry.rb

@@ -1,53 +0,0 @@
-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