assets_offline 0.0.3 → 0.0.4

data/README.textile

@@ -0,0 +1,97 @@
+assets_offline
+============
+
+**Stable Version**: 0.0.3
+
+This gem is specifically for Rails 3.1 projects that wish to use HTML5 and its offline cache feature with the Asset Pipeline.
+
+Installing
+----------
+
+Installation is straight forward simply add the gem to your gemfile and do a bundle install or on the terminal as follows
+
+<pre>
+$ gem install assets_offline
+</pre>
+
+<pre>
+# Last Updated DD/MM/YYYY
+application:
+  asset-cache:
+    - "application.css"
+    - "checkout.js"
+    - "favicon.ico"
+    - "favicon.png"
+    - "logo.png"
+  cache:
+    - "/dictionary.json"
+  fallback:
+    - "/prompts.json # /prompts.json"
+    - "/prices.json # /prices.json"
+  network:
+    - "/checkout/start_transaction.json"
+    - "/checkout/submit_transaction.json"
+</pre>
+
+Documentation
+----------------------
+
+The yaml file "assets_offline.yml" needs to be added to the rails config folder. The yaml is split by route name. So the exmaple above can be added to html using "/assets_offline/application". You can add as many root nodes to the yaml as you require and just add the name to the path to get the generated file.
+
+There are 6 sections to add files to in the Yaml
+* asset-cache
+* cache
+* asset-fallback
+* fallback
+* network
+* asset-network
+
+Sections starting asset will use the rails asset_path() helper to get the file path. Non asset sections will use the path specified.
+Fallback requires two paths which need to be seperated by a "#"
+
+Manifest file generates a hash key in development this key is changed every 5 seconds so the cache will never function, in production the key is based on the hash of the yaml file. To force a cache refresh you must update the last updated value in the yaml file.
+
+Roadmap
+---------
+* Rake task to create YAML files
+* Automating key update in production mode
+* Adding directories to cache file rather than individual files
+
+
+Changelog
+---------
+
+**v0.0.3**
+
+* Beta release
+
+
+Credits
+-------
+
+* [broomyocymru](mailto: broomyocymru@hotmail.com)
+
+
+License
+-------
+
+Copyright (c) 2011 broomyocymru
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app/.svn/all-wcprops

@@ -0,0 +1,5 @@
+K 25
+svn:wc:ra_dav:version-url
+V 56
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/app
+END

data/app/.svn/entries

@@ -0,0 +1,31 @@
+10
+
+dir
+3734
+https://svn.torex.com/svn/TorexNG/trunk/gems/assets_offline/app
+https://svn.torex.com/svn/TorexNG
+
+
+
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+45178cb0-7fed-444c-b58d-06e1424a9ccb
+
+controllers
+dir
+

data/app/controllers/.svn/all-wcprops

@@ -0,0 +1,11 @@
+K 25
+svn:wc:ra_dav:version-url
+V 68
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/app/controllers
+END
+assets_offline_controller.rb
+K 25
+svn:wc:ra_dav:version-url
+V 97
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/app/controllers/assets_offline_controller.rb
+END

data/app/controllers/.svn/entries

@@ -0,0 +1,62 @@
+10
+
+dir
+3734
+https://svn.torex.com/svn/TorexNG/trunk/gems/assets_offline/app/controllers
+https://svn.torex.com/svn/TorexNG
+
+
+
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+45178cb0-7fed-444c-b58d-06e1424a9ccb
+
+assets_offline_controller.rb
+file
+
+
+
+
+2011-12-02T14:38:49.402396Z
+fa45977fe7a847e4fa4be00ea5d80b3d
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+2490
+

data/app/controllers/.svn/text-base/assets_offline_controller.rb.svn-base

@@ -0,0 +1,85 @@
+require 'yaml'
+
+class AssetsOfflineController < ActionController::Base
+
+  def show
+    config = YAML.load_file("#{Rails.root}/config/assets_offline.yml")
+    root = config[params[:id]]
+
+    body =  "# GENERATED USING ASSET_OFFLINE\n"
+    body <<  "# Mode: #{Rails.env} \n"
+    body << "# #{generate_key()} \n\n"
+
+    body << "CACHE MANIFEST \n"
+    # CACHE SECTION
+    if !root["asset-cache"].blank? and root["asset-cache"].count() > 0
+      root["asset-cache"].each do |asset_name|
+        body << "#{view_context.asset_path(asset_name)}\n"
+      end
+    end
+    if !root["cache"].blank? and root["cache"].count() > 0
+      root["cache"].each do |asset_name|
+        body << "#{asset_name}\n"
+      end
+    end
+    body << "\n"
+
+    # NETWORK SECTION
+    body << "NETWORK:\n"
+    body << "# Resources where a connection is required \n"
+    if !root["asset-network"].blank? and root["asset-network"].count() > 0
+      root["asset-network"].each do |asset_name|
+        body << "#{view_context.asset_path(asset_name)}\n"
+      end
+    end
+    if !root["network"].blank? and root["network"].count() > 0
+      root["network"].each do |asset_name|
+        body << "#{asset_name}\n"
+      end
+    end
+    body << "\n"
+
+    #FALLBACK SECTION
+    body << "FALLBACK:\n"
+    body << "# Resources where a connection is used if available \n"
+    if !root["asset-fallback"].blank? and root["asset-fallback"].count() > 0
+      root["asset-fallback"].each do |asset_name|
+        asset_name_part = asset_name.split("#")
+        body << "#{view_context.asset_path(asset_name_part[0].strip())} #{view_context.asset_path(asset_name_part[1].strip())}\n"
+      end
+    end
+    if !root["fallback"].blank? and root["fallback"].count() > 0
+      root["fallback"].each do |asset_name|
+        asset_name_part = asset_name.split("#")
+        body << "#{asset_name_part[0].strip()} #{asset_name_part[1].strip()}\n"
+      end
+    end
+    body << "\n"
+
+    headers['Content-Type'] = 'text/cache-manifest'
+    render :text => body, :layout => false
+  end
+
+  private
+
+  def generate_key
+    if Rails.env.production?
+      production_key
+    else
+      development_key
+    end
+
+  end
+
+  def production_key
+    #Invalidate production by updating the datetime stamp in the comment
+    path = "#{Rails.root}/config/assets_offline.yml"
+    Digest::SHA2.hexdigest(File.read(path)) if ::File.file?(path)
+  end
+
+  def development_key
+    now = Time.now.to_i - Time.now.to_i % 5
+    Digest::SHA2.hexdigest(now.to_s)
+  end
+
+end

data/app/controllers/assets_offline_controller.rb

@@ -6,12 +6,12 @@ class AssetsOfflineController < ActionController::Base
     config = YAML.load_file("#{Rails.root}/config/assets_offline.yml")
     root = config[params[:id]]
 
-    body =  "# GENERATED USING ASSET_OFFLINE\n"
+    body = "CACHE MANIFEST \n"
+    body << "# GENERATED USING ASSET_OFFLINE\n"
     body <<  "# Mode: #{Rails.env} \n"
     body << "# #{generate_key()} \n\n"
-
-    body << "CACHE MANIFEST \n"
     # CACHE SECTION
+    body << "CACHE:\n"
     if !root["asset-cache"].blank? and root["asset-cache"].count() > 0
       root["asset-cache"].each do |asset_name|
         body << "#{view_context.asset_path(asset_name)}\n"

data/config/.svn/all-wcprops

@@ -0,0 +1,11 @@
+K 25
+svn:wc:ra_dav:version-url
+V 59
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/config
+END
+routes.rb
+K 25
+svn:wc:ra_dav:version-url
+V 69
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/config/routes.rb
+END

data/config/.svn/entries

@@ -0,0 +1,62 @@
+10
+
+dir
+3734
+https://svn.torex.com/svn/TorexNG/trunk/gems/assets_offline/config
+https://svn.torex.com/svn/TorexNG
+
+
+
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+45178cb0-7fed-444c-b58d-06e1424a9ccb
+
+routes.rb
+file
+
+
+
+
+2011-12-02T14:39:29.970397Z
+1b9a1db281aa1d112beb8340d29ead47
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+66
+

data/config/.svn/text-base/routes.rb.svn-base

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :assets_offline
+end 

data/lib/.svn/all-wcprops

@@ -0,0 +1,11 @@
+K 25
+svn:wc:ra_dav:version-url
+V 56
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/lib
+END
+assets_offline.rb
+K 25
+svn:wc:ra_dav:version-url
+V 74
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/lib/assets_offline.rb
+END

data/lib/.svn/entries

@@ -0,0 +1,65 @@
+10
+
+dir
+3734
+https://svn.torex.com/svn/TorexNG/trunk/gems/assets_offline/lib
+https://svn.torex.com/svn/TorexNG
+
+
+
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+45178cb0-7fed-444c-b58d-06e1424a9ccb
+
+assets_offline
+dir
+
+assets_offline.rb
+file
+
+
+
+
+2011-12-02T15:12:09.590444Z
+7f49316f1e14bcd77b955b39158c6a6d
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+145
+

data/lib/.svn/text-base/assets_offline.rb.svn-base

@@ -0,0 +1,6 @@
+require "assets_offline/version"
+
+module AssetsOffline
+  class Engine < Rails::Engine
+  end if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/assets_offline/.svn/all-wcprops

@@ -0,0 +1,11 @@
+K 25
+svn:wc:ra_dav:version-url
+V 71
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/lib/assets_offline
+END
+version.rb
+K 25
+svn:wc:ra_dav:version-url
+V 82
+/svn/TorexNG/!svn/ver/3734/trunk/gems/assets_offline/lib/assets_offline/version.rb
+END

data/lib/assets_offline/.svn/entries

@@ -0,0 +1,62 @@
+10
+
+dir
+3734
+https://svn.torex.com/svn/TorexNG/trunk/gems/assets_offline/lib/assets_offline
+https://svn.torex.com/svn/TorexNG
+
+
+
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+45178cb0-7fed-444c-b58d-06e1424a9ccb
+
+version.rb
+file
+
+
+
+
+2011-12-02T15:16:44.894451Z
+c47858446fefbb4d8ef552e650df25ea
+2011-12-02T15:46:33.442319Z
+3734
+Anthony.Broome
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+45
+

data/lib/assets_offline/.svn/text-base/version.rb.svn-base

@@ -0,0 +1,3 @@
+module AssetsOffline
+  VERSION = "0.0.3"
+end

data/lib/assets_offline/version.rb

@@ -1,3 +1,3 @@
 module AssetsOffline
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assets_offline
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000Z
+date: 2011-12-05 00:00:00.000000000Z
 dependencies: []
 description: Rails 3.1 offline cache manifest view
 email:
@@ -20,14 +20,27 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
-- README~
+- README.textile
 - Rakefile
+- app/.svn/all-wcprops
+- app/.svn/entries
+- app/controllers/.svn/all-wcprops
+- app/controllers/.svn/entries
+- app/controllers/.svn/text-base/assets_offline_controller.rb.svn-base
 - app/controllers/assets_offline_controller.rb
 - assets_offline.gemspec
+- config/.svn/all-wcprops
+- config/.svn/entries
+- config/.svn/text-base/routes.rb.svn-base
 - config/routes.rb
 - init.rb
+- lib/.svn/all-wcprops
+- lib/.svn/entries
+- lib/.svn/text-base/assets_offline.rb.svn-base
 - lib/assets_offline.rb
+- lib/assets_offline/.svn/all-wcprops
+- lib/assets_offline/.svn/entries
+- lib/assets_offline/.svn/text-base/version.rb.svn-base
 - lib/assets_offline/version.rb
 homepage: ''
 licenses: []

data/README

@@ -1 +0,0 @@
-TODO