trackman 0.0.5

data/lib/trackman/assets/components/shippable.rb

@@ -0,0 +1,31 @@
+module Trackman
+  module Assets
+    module Components
+      module Shippable
+        def ship diff
+          to_ship = diff.inject([])do |memo, (k, v)| 
+            memo + v.map{ |x| {:proc => build_proc(k, x), :value => x} }
+          end
+          
+          to_ship.sort_by{ |x| x[:value] }.each do |x| 
+            x[:proc].call
+          end 
+        end
+      private 
+        def build_proc symbol, instance 
+          case symbol
+          when :update
+            proc = Proc.new { instance.update! }
+          when :create
+            proc = Proc.new { instance.create! }
+          when :delete
+            proc = Proc.new { instance.delete }
+          else
+            raise "something is wrong."
+          end
+          proc
+        end
+      end
+    end
+  end
+end

data/lib/trackman/assets/components.rb

@@ -0,0 +1,11 @@
+module Trackman
+  module Assets
+    module Components
+      @@modules = [:Conventions, :Diffable, :Hashable, :Shippable, :CompositeAsset, :AssetFactory, :PathResolver, :Rails32PathResolver, :RailsPathResolver]
+     
+      ::Trackman::Assets.autoloads 'trackman/assets/components', @@modules do |s,p|
+          autoload s, p 
+      end
+    end
+  end
+end

data/lib/trackman/assets/css_asset.rb

@@ -0,0 +1,11 @@
+module Trackman
+  module Assets
+    class CssAsset < Asset
+      include Components::CompositeAsset
+
+      protected
+		    alias children_paths inner_css_paths
+		
+    end
+  end
+end

data/lib/trackman/assets/errors/asset_not_found_error.rb

@@ -0,0 +1,8 @@
+module Trackman
+  module Assets
+    module Errors
+      class AssetNotFoundError < StandardError
+      end
+    end
+  end  
+end

data/lib/trackman/assets/errors/config_not_found_error.rb

@@ -0,0 +1,8 @@
+module Trackman
+  module Assets
+    module Errors
+      class ConfigNotFoundError < StandardError
+      end
+    end
+  end  
+end

data/lib/trackman/assets/errors.rb

@@ -0,0 +1,10 @@
+module Trackman
+  module Assets
+    module Errors
+      @@classes = [:AssetNotFoundError, :ConfigNotFoundError]
+      ::Trackman::Assets.autoloads 'trackman/assets/errors', @@classes do |s,p|
+          autoload s, p 
+      end
+    end
+  end
+end

data/lib/trackman/assets/html_asset.rb

@@ -0,0 +1,30 @@
+require 'nokogiri'
+module Trackman
+  module Assets
+    class HtmlAsset < Asset
+      include Components::CompositeAsset
+
+      def document
+        @doc ||= Nokogiri::HTML(data)     
+      end  
+      
+      def img_paths        
+        @images_paths ||= refine_path(document.css('img'), 'src')
+      end
+      def js_paths
+        @js_paths ||= refine_path(document.xpath('//script'), 'src')
+      end
+      def css_paths
+        @css_paths ||= refine_path(document.xpath('//link[@type="text/css"]'), 'href')
+      end
+
+      def children_paths
+         @children_paths ||= img_paths + js_paths + css_paths + inner_css_paths
+      end
+
+      def refine_path(paths, node)
+        paths.collect{|n| n[node].to_s }.select{|n|n && n =~/\w/ && n.internal_path? }
+      end
+    end 
+  end
+end

data/lib/trackman/assets/remote_asset.rb

@@ -0,0 +1,72 @@
+require 'rest-client'
+require 'json'
+require 'uri'
+
+module Trackman
+  module Assets
+    class RemoteAsset < Asset
+      @@server_url = ENV['TRACKMAN_URL']
+      @@site = "#{@@server_url}/assets"
+
+      attr_reader :id
+
+      def initialize attributes = {}
+        ensure_config
+        super
+
+        @id = attributes[:id]
+        @file_hash = attributes[:file_hash]
+      end
+      
+      def file_hash
+        @file_hash || super
+      end
+      
+      def validate_path?
+        false
+      end
+
+      def self.find id
+        response = RestClient.get "#{@@site}/#{id}"
+        body = Hash[JSON.parse(response).map{ |k, v| [k.to_sym, v] }]
+        RemoteAsset.new(body)
+      end
+
+      def self.all
+        JSON.parse(RestClient.get @@site).map{|r|  Hash[r.map{ |k, v| [k.to_sym, v] }] }.map { |r| RemoteAsset.new(r) }.sort
+      end
+
+      def create!
+        puts "server = #{@@server_url}"
+        puts "site = #{@@site}"
+        response = RestClient.post @@site, :asset => {:path => path.to_s, :file => File.open(path)}, :content_type => :json, :accept => :json
+        path = response.headers[:location]
+        @id = path[/\d+$/].to_i
+      end
+
+      def update!
+        RestClient.put "#{@@site}/#{id}", :asset => {:path => path, :file => File.open(path)}, :content_type => :json, :accept => :json
+      end  
+      def delete
+        response = RestClient.delete "#{@@site}/#{id}"
+        true
+      end
+
+      def ==(other)
+        result = super
+        if result
+          if other.is_a? RemoteAsset
+            result = other.id == id && other.file_hash == file_hash 
+          end
+          return result
+        end
+        false 
+      end
+
+      private 
+        def ensure_config
+          raise Errors::ConfigNotFoundError, "The config TRACKMAN_URL is missing." if @@server_url.nil?      
+        end
+    end 
+  end
+end

data/lib/trackman/assets.rb

@@ -0,0 +1,37 @@
+class String
+  def trackman_underscore
+    word = dup
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end
+
+class Symbol
+  def trackman_underscore
+    to_s.trackman_underscore
+  end
+end
+
+module Trackman
+  module Assets
+    
+    #TODO do something better than this to share the scope
+    def self.autoloads path, items
+      items.each do |s|
+        if block_given? 
+          yield(s, "#{path}/#{s.trackman_underscore}" ) 
+        else
+          autoload s, "#{path}/#{s.trackman_underscore}" 
+        end
+      end
+    end
+
+    @@classes = [:Asset, :HtmlAsset, :RemoteAsset, :CssAsset]
+    @@modules = [:Components, :Errors]
+
+    autoloads 'trackman/assets', @@classes.concat(@@modules)
+  end
+end

data/lib/trackman/rack_middleware.rb

@@ -0,0 +1,12 @@
+module Trackman
+  class RackMiddleware
+    def initialize(app)
+      @app = app
+      Trackman::Assets::Asset.autosync
+    end
+    
+    def call(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/trackman/railtie.rb

@@ -0,0 +1,7 @@
+module Trackman
+  class Railtie < Rails::Railtie
+    initializer "trackman.insert_middleware" do |app|
+      app.config.middleware.use "Trackman::RackMiddleware"
+    end
+  end
+end

data/lib/trackman/version.rb

@@ -0,0 +1,3 @@
+module Trackman
+  VERSION = "0.0.5"
+end

data/lib/trackman.rb

@@ -0,0 +1,34 @@
+require "rubygems"
+require "bundler/setup"
+require 'tasks'
+
+module Trackman
+  autoload :RackMiddleware, 'trackman/rack_middleware'
+  autoload :Assets, 'trackman/assets'
+end 
+
+if defined?(Rails)
+  if ::Rails::VERSION::STRING =~ /^2\.[1-9]/
+    Rails.configuration.middleware.use Trackman::RackMiddleware
+  elsif ::Rails::VERSION::STRING =~ /^[3-9]\.[1-9]/
+    require "trackman/railtie"
+  end
+end
+
+
+#ruby 1.8.7 does not take blocks (this fixes it) -- used in Asset.all
+if RUBY_VERSION !~ /^1\.9/
+  class Array
+    def uniq
+      ret, keys = [], []
+      each do |x|
+        key = block_given? ? yield(x) : x
+        unless keys.include? key
+          ret << x
+          keys << key
+        end
+      end
+      ret
+    end
+  end
+end

data/rails_generators/trackman/templates/trackman.rake

@@ -0,0 +1,59 @@
+require 'trackman'
+namespace :trackman do
+  ERROR = 'ERROR_PAGE_URL'
+  MAINTENANCE = 'MAINTENANCE_PAGE_URL'
+  TRACKMAN_ERROR = 'TRACKMAN_ERROR_PAGE_URL'
+  TRACKMAN_MAINTENANCE = 'TRACKMAN_MAINTENANCE_PAGE_URL'
+
+  desc "Syncs your assets with the server, this is what gets executed when you deploy to heroku."
+  task :sync do
+    Trackman::Assets::Asset.sync
+  end
+
+  desc "Sets up the heroku configs required by Trackman" 
+  task :setup do
+    heroku_version = `heroku version`
+    if heroku_version !~ /^[2-9]\.[2-9]/
+      puts "your heroku version is too low, we recommend '~> 2.26' at least"
+    else
+      configs = `heroku config -s` 
+      rename_configs configs
+      add_configs configs
+      puts "done! Thank you for using Trackman!"
+    end
+  end 
+
+  def rename_configs configs
+    bkp = {}
+
+    [ERROR, MAINTENANCE].each do |c|
+      bkp[c] = extract_config_value(configs, c) if configs.include? c
+    end
+    
+    add = Hash[bkp.map {|k, v| [k + ".bkp", v] }].map{|k,v| "#{k}=#{v}" }.join(' ')
+    
+    `heroku config:add #{add}`
+    puts "backuping configs to heroku...\n running heroku config:add #{add}"
+  end
+
+  def add_configs configs
+    puts "overriding the required heroku configs #{MAINTENANCE} and #{ERROR}"
+
+    if configs.include?(TRACKMAN_ERROR) && configs.include?(TRACKMAN_MAINTENANCE)
+      trackman_configs = {}
+      [[TRACKMAN_ERROR, ERROR], [TRACKMAN_MAINTENANCE, MAINTENANCE]].each do |old_c, new_c|
+        trackman_configs[new_c] = extract_config_value(configs, old_c)
+      end
+
+      add = trackman_configs.map{|k,v| "#{k}=#{v}" }.join(' ')
+      `heroku config:add #{add}`
+      puts "running heroku config:add #{add}"
+    else
+      puts "cannot find trackman configuration, make sure trackman addon is installed"
+    end
+  end
+
+  def extract_config_value configs, name
+    configs[/#{name}=.+$/][/[^=]+$/]
+  end
+end

data/rails_generators/trackman/trackman_generator.rb

@@ -0,0 +1,8 @@
+class TrackmanGenerator < Rails::Generator::Base
+  def manifest 
+    record do |m|
+      m.directory('lib/tasks')
+      m.file('trackman.rake', 'lib/tasks/trackman.rake')
+    end
+  end
+end

data/spec/asset_all_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Trackman::Assets::Asset do
+  class TestAsset < Asset
+  end
+  
+  describe "#all" do
+    it "returns every asset for a given maintenance path" do
+      class TestAsset
+        def self.maintenance_page
+          Asset.create(:path => 'spec/test_data/all/all.html')
+        end 
+        def self.maintenance_path
+          Pathname.new('spec/test_data/all/all.html')
+        end
+      end 
+
+      expected = [
+        TestAsset.create(:path => 'spec/test_data/all/1.css'), 
+        TestAsset.create(:path => 'spec/test_data/all/2.gif'),  
+        TestAsset.maintenance_page
+      ]
+
+      actual = TestAsset.all
+
+      actual.should eq(expected)
+    end
+
+
+    it "includes assets from error page if it is also specified" do
+      class TestAsset
+        def self.maintenance_page
+          TestAsset.create(:path => 'spec/test_data/all/all.html')
+        end
+        def self.error_page
+          TestAsset.create(:path => 'spec/test_data/all/all2.html')
+        end 
+
+        def self.maintenance_path
+          Pathname.new('spec/test_data/all/all.html')
+        end
+        def self.error_path
+          Pathname.new('spec/test_data/all/all2.html')
+        end 
+      end 
+
+      expected = [
+        TestAsset.create(:path => 'spec/test_data/all/3.js'),
+        TestAsset.create(:path => 'spec/test_data/all/2.gif'), 
+        TestAsset.create(:path => 'spec/test_data/all/1.css'),
+        TestAsset.maintenance_page,
+        TestAsset.error_page
+      ]
+      actual = TestAsset.all 
+      
+      actual.map{|x| x.path}.should == expected.map{|x| x.path}
+      actual.should eq(expected)
+    end
+
+    it "does not include the same asset twice" do
+      class TestAsset
+        def self.maintenance_page
+          TestAsset.create(:path => 'spec/test_data/all/all.html')
+        end
+        def self.error_page
+          TestAsset.create(:path => 'spec/test_data/all/all3.html')
+        end
+        def self.maintenance_path
+          Pathname.new('spec/test_data/all/all.html')
+        end
+        def self.error_path
+          Pathname.new('spec/test_data/all/all3.html')
+        end  
+      end 
+
+      expected = [
+        TestAsset.create(:path => 'spec/test_data/all/1.css'), 
+        TestAsset.create(:path => 'spec/test_data/all/2.gif'), 
+        TestAsset.maintenance_page, 
+        TestAsset.error_page
+      ]
+      
+      actual = TestAsset.all
+
+      actual.should eq(expected)
+    end
+
+    it "testing equality of 2 assets" do
+      one = [TestAsset.create(:path => 'spec/test_data/all/all3.html'), TestAsset.create(:path => 'spec/test_data/all/all3.html')]
+      the_same = [TestAsset.create(:path => 'spec/test_data/all/all3.html'), TestAsset.create(:path => 'spec/test_data/all/all3.html')]
+
+      one.should eq(the_same)
+    end
+
+    it "does not include external assets" do
+      class TestAsset
+        def self.maintenance_page
+          TestAsset.create(:path => 'spec/test_data/external_paths/1.html')
+        end
+        def self.error_page
+          TestAsset.create(:path => '/invalid/path')
+        end
+        def self.maintenance_path
+          Pathname.new('spec/test_data/external_paths/1.html')
+        end 
+        def self.error_path
+          Pathname.new('/invalid/path')
+        end  
+      end 
+
+      expected = [TestAsset.create(:path => 'spec/test_data/external_paths/1.css'), TestAsset.maintenance_page]
+      
+      TestAsset.all.should eq(expected)
+    end
+
+    it "return html assets always at the end" do
+      class TestAsset
+        def self.maintenance_page
+          TestAsset.create(:path => 'spec/test_data/external_paths/1.html')
+        end
+        def self.error_page
+          TestAsset.create(:path => 'spec/test_data/external_paths/1.html')
+        end
+        def self.maintenance_path
+          Pathname.new('spec/test_data/external_paths/1.html')
+        end 
+        def self.error_path
+          Pathname.new('spec/test_data/external_paths/1.html')
+        end  
+      end
+     
+      expected = [TestAsset.create(:path => 'spec/test_data/external_paths/1.css'), TestAsset.maintenance_page] 
+      TestAsset.all.should eq(expected)
+    end
+  end
+end

data/spec/asset_factory_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Trackman::Assets::Components::AssetFactory do
+  class TestFactory
+    extend Trackman::Assets::Components::AssetFactory
+  end
+  
+  before :all do
+    class Trackman::Assets::Asset
+      def validate_path?
+        false
+      end
+    end
+  end  
+  after :each do
+    begin
+      Object.send(:remove_const, :Rails)
+    rescue
+    end
+  end
+  after :all do
+    class Trackman::Assets::Asset
+      def validate_path?
+        true
+      end
+    end
+  end
+
+  it "returns an HtmlAsset" do
+    asset = TestFactory.create(:path => 'spec/test_data/sample.html')
+    
+    asset.should be_a_kind_of HtmlAsset
+  end
+
+
+  it "returns a Rails32 when asset pipeline is configured to be used" do  
+    module Rails
+      def self.application
+        Rails::App.new
+      end
+      
+      class App
+        def config
+          Rails::Config.new
+        end
+      end
+
+      class Config
+        def assets
+          Rails::Assets.new
+        end 
+      end
+
+      class Assets
+        def enabled
+          true
+        end
+      end
+    end
+    
+    TestFactory.asset_pipeline_enabled?.should be_true
+  end
+
+  it "returns a normal asset if asset pipepeline is not defined or not used" do
+
+    TestFactory.asset_pipeline_enabled?.should be_false
+    asset = TestFactory.create(:path => 'x.css')
+    asset.should_not be_a_kind_of Rails32PathResolver 
+  end
+end

data/spec/asset_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'digest/md5'
+
+describe Trackman::Assets::Asset do
+  it "should raise an exception if the path is not good" do 
+    wrong_path = "./wrong_path.html"
+    lambda { Asset.new(:path => wrong_path) }.should raise_error Trackman::Assets::Errors::AssetNotFoundError
+  end
+
+  it "is equal if the path is the same" do
+    path = "./spec/spec_helper.rb"
+
+    asset1 = Asset.new(:path => path)
+    asset2 = Asset.new(:path => path)
+
+    asset1.should == asset2
+  end
+  
+
+  it "is equal if the path points to the same place" do
+    path1 = "spec/spec_helper.rb"
+    path2 = "spec/../spec/spec_helper.rb"
+    
+    asset1 = Asset.new(:path => path1)
+    asset2 = Asset.new(:path => path2)
+
+    asset1.should == asset2
+  end
+  
+  describe "#data" do
+    it "returns content of the file specified by path" do
+      path = "./spec/spec_helper.rb"
+      asset = Asset.new(:path => path)
+      
+      asset.data.should eq(File.open(path).read)    
+    end
+  end
+  
+  describe "#hash" do
+    it "returns the fingerprint of data" do
+      path = "./spec/spec_helper.rb"
+      asset = Asset.new(:path => path)
+        
+      file = File.open path
+      asset.file_hash.should eq(Digest::MD5.hexdigest(file.read))
+    end
+  end
+  
+  describe "#remote" do
+    
+    class TestAsset < Asset
+      def self.maintenance_page
+        Asset.create(:path => 'spec/test_data/sample.html')
+      end
+    end
+
+    it "returns a remote asset equal to the previous one" do
+      local = TestAsset.maintenance_page
+      
+      AppCreator.create
+      remote = local.to_remote
+      AppCreator.reset
+
+      local.should eq(remote)
+      remote.is_a?(RemoteAsset).should be_true
+    end  
+  end
+
+  it "compares html higher than any other asset" do
+    asset1 = Asset.create(:path => 'spec/test_data/sample.html')
+    asset2 = Asset.create(:path => 'spec/test_data/test1.jpeg')
+
+    (asset1 <=> asset2).should == 1
+    (asset2 <=> asset1).should == -1
+  end
+
+  it "compares html equal to any other html asset" do
+    asset1 = Asset.create(:path => 'spec/test_data/sample.html')
+    asset2 = Asset.create(:path => 'spec/test_data/sample.html')
+
+    (asset1 <=> asset2).should == 0
+  end
+
+  it "compares two htmls by their path" do
+    asset1 = Asset.create(:path => 'spec/test_data/all/all.html')
+    asset2 = Asset.create(:path => 'spec/test_data/all/all2.html')
+
+    (asset1 <=> asset2).should == -1
+  end
+
+
+  it "compares a css asset higher than its dependencies" do
+    dependent = Asset.create(:path => 'spec/test_data/css/with-asset.css')
+    dependency = dependent.assets.first
+
+    (dependent <=> dependency).should == 1
+    (dependency <=> dependent).should == -1
+  end
+end

data/spec/composite_asset_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+class FakeCompositeAsset 
+  #include CompositeAsset
+end
+
+describe FakeCompositeAsset do
+  it "" do
+    asset = CssAsset.new(:path => 'spec/test_data/css/with-asset.css')
+    asset.assets.should == [CssAsset.new(:path => 'spec/test_data/css/imported.css')] 
+  end
+end