high_five 0.0.8 → 0.1.0

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    high_five (0.0.7)
+    high_five (0.0.8)
       compass (~> 0.12.2)
+      json (~> 1.7.7)
       sprockets (~> 2.9.0)
       thor (~> 0.17.0)
       uglifier (~> 2.1.1)
@@ -25,6 +26,7 @@ GEM
       multi_json (~> 1.0)
     fssm (0.2.10)
     hike (1.2.2)
+    json (1.7.7)
     multi_json (1.7.2)
     open4 (1.3.0)
     rack (1.5.2)

data/README.md

@@ -1,7 +1,14 @@
 High Five
 =========
 
-HTML5 build/deploy tool, usually used with PhoneGap. 
+HTML5 build/deploy tool, usually used with PhoneGap but also for standalone web-based apps
+
+Ruby
+====
+
+If you're on Windows, you need both Ruby and the Dev tools.  There is a great tutorial here: 
+
+https://github.com/oneclick/rubyinstaller/wiki/development-kit
 
 Installation
 ============
@@ -16,6 +23,8 @@ and also creating a few important files inside, most importantly high_five.rb.
 Configuration
 =============
 
+```hi5 init``` will create all the directories you need, and almost all of your configuration will happen inside of ```config/high_five.rb```.  It is reasonably well documented and contains a lot of sensible defaults.  I hope to improve the documentation here over time, but for now go read ```high_five.rb```
+
 
 Usage
 =====

data/high_five.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "yui-compressor", "~>0.9.6"
   s.add_runtime_dependency "uglifier", "~>2.1.1"
   s.add_runtime_dependency "sprockets", "~>2.9.0"
+  s.add_runtime_dependency "json", '~> 1.7.7'
   s.add_development_dependency "rspec", "~>2.13.0"
 
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/high_five/config.rb

@@ -1,21 +1,41 @@
 require 'json'
 module HighFive
   class Config
-    attr_accessor :root,         # Root of the project 
-      :destination,  # generated folder for project('www')
-      :page_title,   # <title>#{page_title}</title>
-      :meta,          # config.meta << { http-equiv: "Content-Type" content: "text/html; charset=utf-8" }
-      :static_assets,
-      :static_javascripts,
-      :static_stylesheets,
-      :sass_files,
-      :asset_paths,
-      :platform_configs,
-      :compass_dir,
-      :js_settings, #serialized out to HighFive.Settings in index.html
-      :is_environment, #boolean for if this config is an environment platform
-      :dev_index, #copy generated index.html to here on build for use in development
-      :minify #defaults to true in production mode and false otherwise, overridable
+    attr_accessor :meta,          # config.meta << { http-equiv: "Content-Type" content: "text/html; charset=utf-8" }
+                  :static_assets,
+                  :static_javascripts,
+                  :static_stylesheets,
+                  :sass_files,
+                  :asset_paths,
+                  :platform_configs,
+                  :js_settings, #serialized out to HighFive.Settings in index.html
+                  :is_environment #boolean for if this config is an environment platform
+
+
+    # shorthand for me to define lots and lots of config settings that need to be handled
+    # as attr_accessible, settable via setting(blah) instead of settings=blah, and also 
+    # persisted to derived platform configs
+    def self.config_setting(*settings)
+      config_variables = []
+      settings.each do |setting|
+        attr_accessor setting
+        define_method setting do |*args|
+          var = "@#{setting}".to_sym
+          config_variables << var
+          instance_variable_set(var, args[0]) if args.length == 1
+          instance_variable_get(var)
+        end
+      end
+      @@config_variables = config_variables
+    end
+
+    config_setting :root,         # Root of the project 
+                   :destination,  # generated folder for project('www')
+                   :page_title,   # <title>#{page_title}</title>
+                   :compass_dir,  # directory that contaings compass' config.rb
+                   :dev_index,    # copy generated index.html to here on build for use in development
+                   :minify,       # defaults to true in production mode and false otherwise, overridable
+                   :manifest      # generate html5 manifest
 
 
     def self.configure(&block) 
@@ -52,9 +72,11 @@ module HighFive
         new_config.static_stylesheets += self.static_stylesheets
         new_config.sass_files += self.sass_files
         new_config.asset_paths += self.asset_paths
-        new_config.compass_dir ||= self.compass_dir
-        new_config.dev_index ||= self.dev_index
-        new_config.minify ||= self.minify
+        @@config_variables.each do |svar|
+          if (new_config.instance_variable_get(svar).nil?)
+            new_config.instance_variable_set(svar, self.instance_variable_get(svar))
+          end
+        end
         new_config.js_settings.merge! self.js_settings do |key, new_setting, old_setting| 
           new_setting || old_setting #don't clobber settings from the parent
         end
@@ -82,6 +104,12 @@ module HighFive
         self.page_title = config.page_title
         self.meta = config.meta
         self.minify = config.minify
+        self.manifest = config.manifest
+        @@config_variables.each do |svar|
+          if (self.instance_variable_get(svar).nil?)
+            self.instance_variable_set(svar, config.instance_variable_get(svar))
+          end
+        end
       else
         @static_assets = []
         @static_javascripts = []
@@ -107,10 +135,6 @@ module HighFive
       @sass_files << path.dup
     end
 
-    def compass(config_dir)
-      @compass_dir = config_dir
-    end
-
     def stylesheets(path)
       @static_stylesheets << path.dup
     end
@@ -141,18 +165,5 @@ module HighFive
       js
     end
 
-    #easy setters
-
-    def dev_index(*args)
-      if args.length == 1
-        @dev_index = args[0] 
-      end
-      @dev_index 
-    end
-
-    def destination(*args)
-      @destination = args[0] if args.length == 1
-      @destination
-    end
   end
 end

data/lib/high_five/deploy_task.rb

@@ -24,6 +24,8 @@ module HighFive
           
           self.source_paths << File.join(base_config.root, @config_root)
           self.source_paths << File.join(base_config.root)
+          self.source_paths << File.join(File.dirname(__FILE__), 'generators')
+
 
           raise "Please set config.destination" if @config.destination.nil?
           self.destination_root = @config.destination
@@ -40,8 +42,6 @@ module HighFive
             say "Precompiling compass styles from #{compass_dir}}"
             pwd = Dir.pwd
             Dir.chdir compass_dir
-            # TODO make this invoke compass programatically
-            # Consider using sprockets for css too, although I kindof hate that
             success = false
             if @environment == "production"
               success = system("compass compile --force --no-debug-info -e production")
@@ -132,6 +132,23 @@ module HighFive
             end
           end
 
+          if (@config.manifest && @environment == 'production')
+            @manifest_attr = %Q(manifest="manifest.appcache") #for <html manifest=>
+            say "     create manifest", :green
+            @manifest_cache = @config.static_assets.collect do |path|
+              if (File.directory?(path))
+                Dir.glob(path + "/**/*")
+              else
+                path
+              end
+            end.flatten
+
+            @manifest_cache += @javascripts
+            @manifest_cache += @stylesheets
+
+            template "manifest.erb", File.join(self.destination_root, "manifest.appcache")
+          end
+
           @high_five_javascript = @config.high_five_javascript
           # Build index.html
           say "Generating index.html"

data/lib/high_five/generators/manifest.erb

@@ -0,0 +1,16 @@
+CACHE MANIFEST
+# Generated by high_five v<%= HighFive::VERSION %>
+# <%= Time.now %>
+
+# Explicitly cached 'master entries'.
+CACHE:
+<% @manifest_cache.each do |path| -%>
+<%= path %>
+<% end -%>
+
+
+# Resources that require the user to be online.
+NETWORK:
+
+# offline.html will be served in place of all other .html files
+FALLBACK:

data/lib/high_five/version.rb

@@ -1,3 +1,3 @@
 module HighFive
-    VERSION = "0.0.8"
+    VERSION = "0.1.0"
 end

data/spec/deploy_spec.rb

@@ -109,6 +109,7 @@ describe HighFive::DeployTask do
         config.assets "stylesheets"
         config.platform :web do |web|
            config.dev_index "index-debug.html"
+           config.manifest = true
         end
         config.environment :production do |prod|
 
@@ -126,6 +127,9 @@ describe HighFive::DeployTask do
     it "should not clone index.html to index-debug.html" do 
       File.exist?(File.join(@project_root, "index-debug.html")).should be_false
     end
+    it "should generate an html manifest" do 
+      expect(File.join(@project_root, "www", "manifest.appcache")).to exist
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: high_five
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,13 +144,12 @@ files:
 - Rakefile
 - bin/hi5
 - high_five.gemspec
-- lib/.DS_Store
 - lib/high_five.rb
 - lib/high_five/android_tasks.rb
 - lib/high_five/cli.rb
 - lib/high_five/config.rb
 - lib/high_five/deploy_task.rb
-- lib/high_five/html_includes.html.erb
+- lib/high_five/generators/manifest.erb
 - lib/high_five/init_task.rb
 - lib/high_five/version.rb
 - spec/config_spec.rb

data/lib/high_five/html_includes.html.erb

@@ -1 +0,0 @@
-html_includes.html.erb