trackman 0.6.0 → 0.6.1

data/Gemfile.lock

@@ -9,12 +9,11 @@ GIT
 PATH
   remote: .
   specs:
-    trackman (0.5.7)
+    trackman (0.6.1)
       heroku (>= 2.26.2)
       json
       nokogiri
       rack
-      rake
       rest-client
       versionomy
 
@@ -42,7 +41,6 @@ GEM
     netrc (0.7.7)
     nokogiri (1.5.5)
     rack (1.4.1)
-    rake (0.9.2.2)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
       rspec-expectations (~> 2.10.0)

data/README.md

@@ -5,7 +5,9 @@ You keep them within your project and Trackman syncs them to S3 when you deploy.
 Works out of the box for Ruby(1.8.7 and 1.9.3) on 
 * Rails 2.3
 * Rails 3
+* Sinatra
 
+For a detailed tutorial of each framework integration visit the [Wiki](https://github.com/SynApps/trackman/wiki).
 
 ## Quick peek  
 ### The first time
@@ -17,6 +19,8 @@ Works out of the box for Ruby(1.8.7 and 1.9.3) on
 Simply edit your static pages, link different assets, go crazy!
 Trackman will sync upon application boot on your next deployment.
 
+## How to use
+
 ### Conventions
 We assume your maintenance page is located at:
 
@@ -30,78 +34,17 @@ And the page to display if your app breaks during initialization:
 public/503-error.html
 ```
 
-## Getting started
-### Step 1 - Install the addon, add the gem and run bundle install
-
-
-```console
-heroku addons:add trackman
-```
-
-
-```ruby
-gem 'trackman'
-```
-
-
-```console
-bundle install
-```
-
-##### Step 1.5 (Rails 2 only) - Generate Trackman tasks 
-
-```console
-./script/generate trackman_tasks
-```
-
-
-This will add trackman.rake to lib/tasks/ 
-
-### Step 2 - Setup
-
-
-```console
-rake trackman:setup
-```
-
-
-This sets your initial heroku configurations and ensures that when your app is down or in maintenance your pages will be requested by heroku.
-If you already have maintenance or error pages configs for heroku, Trackman will copy with .bkp extensions before he overwrites them.  
-
-### Step 3 (optional) - Scaffold your static pages
-
-##### Rails 2.3
-
-```console
-./script/generate trackman_controller [name]  
-```
-
-##### Rails 3
-
-
-```console
-rails generate trackman:controller [name]
-```
-
-This will generate a special controller that, when on development, will create your maintenance pages for you when you execute its actions.
-Because Rails 3 can handle 500 and 404 pages dynamically, the controller also adds the required route to handle them.
-On Rails 2, it generates the 4 different static pages instead.
-
-The controller has class methods to filter the response output.  
-You can find examples on how to use them within the controller itself.
-
-### Step 4 -  Deploy
-Now that you have your maintenance pages, you can commit and push to Heroku.  
-Trackman will look for changes to your pages and linked assets and sync them on application boot.
-
 ### To troubleshoot the sync operation
 
+
 ```console
 heroku run rake trackman:sync
 ```
 
-
 Executing this task will throw exceptions instead of silently failing like the normal sync would.
+You can also turn debugging on by adding TRACKMAN_DEBUG_ON=true in your env.
+It will output every request done by restclient and also a diff about what is getting pushed.
+
 
 ### For best results, make sure you have those installed:
 * Heroku >= 2.26.2

data/lib/generators/controller/controller_generator.rb

@@ -7,7 +7,7 @@ module Trackman
     desc "Generates a controller to generate your static pages"
     
     @@actions = ['not_found', 'error', 'maintenance', 'maintenance_error']
-    @@routes = {'404' => 'not_found', '500' => 'error', 'maintenance' => 'maintenance', 'maintenance-error' => 'maintenance_error'}
+    @@routes = {'not-found' => 'not_found', 'error' => 'error', 'maintenance' => 'maintenance', 'maintenance-error' => 'maintenance_error'}
 
     def create_controller
       template "controller_layout.rb.erb", "app/controllers/#{controller_name}_controller.rb"
@@ -16,7 +16,7 @@ module Trackman
     def create_app_config
       puts "
     ------
-    Trackman added \"config.exceptions_app = self.routes\" in app/config/application.rb     
+    Trackman added \"config.exceptions_app = self.routes\" in config/application.rb     
     ------\n"
       application do
         "config.exceptions_app = self.routes"

data/lib/generators/controller/templates/controller_layout.rb.erb

@@ -1,6 +1,7 @@
-class ErrorsController < ApplicationController
+class <%= controller_name.camelize %>Controller < ApplicationController
   include  Trackman::Scaffold::ContentSaver
-  after_filter :save_content if Rails.env.development?
+  after_filter :save_filters if Rails.env.development?
+  after_filter :render_filters
   
   # ContentSaver defines two class methods for filtering the ouput of your pages
   #

data/lib/trackman/scaffold/content_saver.rb

@@ -17,7 +17,6 @@ module Trackman
         base.extend ClassMethods
       end
 
-      
       module ClassMethods
         def edit selector, &block
           raise 'block parameter is mandatory' unless block_given?
@@ -32,7 +31,10 @@ module Trackman
         def remove_nodes doc
           self.class.nodes_to_remove.each do |selector, predicate| 
             nodes = doc.search(selector)
-            nodes = nodes.select(&predicate) unless predicate.nil?
+            i = 0;
+            unless predicate.nil?
+              nodes = nodes.select { |n| r = predicate.call(n, i); i +=1;r } 
+            end
             nodes.each{|n| n.remove }
           end
           doc
@@ -40,24 +42,38 @@ module Trackman
 
         def edit_nodes doc
           self.class.nodes_to_edit.each do |selector, block|
-            doc.search(selector).each { |n| block.call(n) }
+            doc.search(selector).each_with_index { |n, i| block.call(n, i) }
           end
           doc
         end
+        def xslt
+          @xslt ||= Nokogiri::XSLT(File.open("#{File.dirname(__FILE__)}/pretty-print.xslt"))
+        end
+        
+        def new_content
+          html = Nokogiri::HTML(response.body)
+          
+          edit_nodes html
+          remove_nodes html
+          
+          xslt.apply_to(html).to_s
+        end 
+        
+        def cache key
+          @cache ||= {}
+          @cache[key] || yield
+        end
 
-        def save_content
+        def render_filters
+          response.body = cache(params[:action]) { new_content }
+        end
+        
+        def save_filters
           to_write = self.class.mappings[params[:action].to_sym]
-          
           unless to_write.nil?
             path = "/public/#{to_write}.html"
-
-            xsl = Nokogiri::XSLT(File.open("#{File.dirname(__FILE__)}/pretty-print.xslt"))
-            html = Nokogiri::HTML(response.body)
-          
-            edit_nodes html
-            remove_nodes html
-          
-            File.open(Rails.root.to_s + path, 'w') { |f| f.write(xsl.apply_to(html).to_s) } 
+            result = cache(params[:action]) { new_content }
+            File.open(Rails.root.to_s + path, 'w') { |f| f.write(result) } 
           end
         end
     end

data/lib/trackman/version.rb

@@ -1,3 +1,3 @@
 module Trackman
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/rails_generators/trackman_controller/templates/controller_layout.rb.erb

@@ -1,7 +1,7 @@
-class ErrorsController < ApplicationController
+class <%= controller_name.camelize %>Controller < ApplicationController
   include  Trackman::Scaffold::ContentSaver
-  after_filter :save_content if Rails.env.development?
-  
+  after_filter :save_filters if Rails.env.development?
+  after_filter :render_filters
   # ContentSaver defines two class methods for filtering the ouput of your pages
   #
   # Note that it uses nokogiri to parse the output.

data/rails_generators/trackman_controller/trackman_controller_generator.rb

@@ -8,7 +8,7 @@ class TrackmanControllerGenerator < ::Rails::Generator::Base
   attr_accessor :controller_name
 
   @@actions = ['not_found', 'error', 'maintenance', 'maintenance_error']
-  @@routes = {'404' => 'not_found', '500' => 'error', 'maintenance' => 'maintenance', 'maintenance-error' => 'maintenance_error'}
+  @@routes = {'not-found' => 'not_found', 'error' => 'error', 'maintenance' => 'maintenance', 'maintenance-error' => 'maintenance_error'}
 
   def manifest # this method is default entrance of generator
     puts route_doc false
@@ -27,12 +27,12 @@ class TrackmanControllerGenerator < ::Rails::Generator::Base
       @@actions.each do |n|
         m.template layout, "#{view_folder}/#{n}.html.#{engine}"
       end
-    end
+
 
     def route_doc show_as_comments = false
       char = show_as_comments ? '#' : ''
 "\n#{char} Don't forget to add the routes in config/routes.rb\n#{char} ------
-#{char} map.not_found '/not_found', :controller => '#{controller_name}', :action => :not_found
+#{char} map.not_found '/not-found', :controller => '#{controller_name}', :action => :not_found
 #{char} map.error '/error', :controller => '#{controller_name}', :action => :error
 #{char} map.maintenance '/maintenance', :controller => '#{controller_name}', :action => :maintenance
 #{char} map.maintenance_error '/maintenance-error', :controller => '#{controller_name}', :action => :maintenance_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trackman
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-09 00:00:00.000000000 Z
+date: 2012-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client