pubba 0.7.2 → 0.8.0

data/.gitignore

@@ -14,6 +14,4 @@ coverage
 pkg
 
 test/sinatra/app/assets/out
-test/sinatra/app/assets/js/*.js
-test/sinatra/app/assets/css/*.css
 test/sinatra/public

data/CHANGES

@@ -1,5 +1,14 @@
 master
 
+0.7.2
+  * Support id attribute on style tag
+
+0.7.1
+  * Fix asset_host functionality
+  * Don't stop monitoring if compressor encounters error
+
+0.7.0
+
   * Conceptual change from Sinatra extension to generic library
   * Namespace changed from Sinatra::Pubba to Pubba
   * Change to configuration implementation

data/README.md

@@ -253,4 +253,5 @@ Huge thanks to my company, [Primedia](http://primedia.com) for encouraging open
 
 I highly value contributions and will happily list all those who submit accepted pull requests.
 
+[Blanton Black](https://github.com/blanton-black) : Id atttribute support on style tag
 [Chas Lemley](https://github.com/chaslemley) : YUI Compressor support

data/Rakefile

@@ -1,3 +1,24 @@
+module Prepare
+  def self.do
+    require File.join(File.dirname(__FILE__), 'lib', 'pubba')
+    require File.join(File.dirname(__FILE__), 'test', 'resources')
+
+    $>.print(">> Cleaning resources from public directories\n")
+    Resources.clean
+
+    Pubba.configure do |p|
+      p.config_file   = Resources.pubba_config_file
+      p.public_folder = Resources.public_folder
+      p.asset_folder  = Resources.asset_folder
+      p.r18n_folder   = Resources.r18n_folder
+    end
+
+    $>.print(">> Processing assets")
+    Pubba::Site.process
+  end
+end
+
+
 begin
   require 'bundler'
   Bundler::GemHelper.install_tasks
@@ -7,6 +28,7 @@ end
 require 'rake/testtask'
 
 Rake::TestTask.new('test') do |t|
+  Prepare.do
   t.libs << 'lib' << 'test'
   t.test_files = Dir.glob('test/**/test_*.rb')
   t.verbose = true
@@ -44,3 +66,5 @@ desc "Generate Documentation"
 task :doc => :yard
 
 task :default => 'test'
+
+

data/lib/pubba/assets/handler.rb

@@ -1,9 +1,67 @@
+require 'octopi'
+
 module Pubba
   module Assets
     class Handler
-      def self.asset(file)
-        raise NotImplementedError
-      end
+      class << self
+        include Octopi
+
+        def asset(file)
+          raise NotImplementedError
+        end
+
+        # @return path, ext Path and extension of resource
+        def get_external_resource(url)
+          path  = ''
+          ext   = ''
+
+          authenticated do
+            parts = url.split(':')
+            user  = parts[1]
+            repo  = parts[2]
+            tag   = parts[3]
+            file  = parts[4]
+
+            # file extension: .js
+            ext  = File.extname(file)
+
+            # file name without extension
+            basename = File.basename(file, ext)
+
+            # subdir gitub/primedia
+            subdir = File.join(parts[0], user)
+
+            # github/repo/file
+            path = File.join(subdir, basename)
+
+            folder = (ext == '.css' ? Pubba.style_folder : Pubba.script_folder)
+
+            # assets/js/github/repo/file
+            out_path = File.join(Pubba.asset_folder, folder, subdir)
+            FileUtils.mkdir_p(out_path)
+
+            # assets/js/github/repo/file
+            out_file = File.join(out_path, basename + ext)
+
+            r = Repository.find(user: user, repo: repo)
+            r.tags.each do |t|
+              if t.name = tag
+                sha = t.sha
+                begin
+                  blob = Blob.find(user: user, repo: repo, sha: sha, path: file)
+                  File.open(out_file, "w"){|f| f.write(blob.data) }
+                  break
+                rescue Octopi::APIError => e
+                  puts "Error attempting to get: user: #{user}, repo: #{repo}, sha: #{sha}, path: #{file}"
+                  puts e.message
+                end
+              end
+            end
+          end
+
+          return path, ext.split('.').last
+        end
+      end # class block
 
       def save_as(file)
         raise NotImplementedError

data/lib/pubba/assets/sprockets_handler.rb

@@ -5,37 +5,46 @@ require_relative 'handler'
 module Pubba
   module Assets
     class SprocketsHandler < Handler
-      def self.find(file)
-        SprocketsHandler.new(sprockets.find_asset(file))
-      end
+      class << self
+        def find(file)
+          SprocketsHandler.new(sprockets.find_asset(file))
+        end
 
-      def self.asset_paths(*paths)
-        paths.each do |path|
-          sprockets.append_path path
+        def asset_paths(*paths)
+          paths.each do |path|
+            sprockets.append_path path
+          end
         end
-      end
 
-      def self.sprockets
-        @sprockets ||= Sprockets::Environment.new()
-      end
+        def sprockets
+          @sprockets ||= Sprockets::Environment.new()
+        end
 
-      def self.process(source, destination)
-        FileUtils.mkdir_p destination
+        def process(source, destination)
+          FileUtils.mkdir_p destination
 
-        Dir.glob("#{source}/*") do |file|
-          asset = find(file)
-          asset.save_as "#{destination}/#{File.basename(file)}"
+          Dir.glob("#{source}/*") do |file|
+            asset = find(file)
+            asset.save_as "#{destination}/#{File.basename(file)}"
+          end
         end
-      end
 
-      def self.build(name, type, ext, urls)
-        content = urls.collect{|url| "//= require #{url}.#{ext}"}.compact.join("\n")
-        out_folder = File.join(Pubba.asset_folder, "out", ext)
-        FileUtils.mkdir_p out_folder
-        fname = File.join(out_folder, "#{name}-#{type}.#{ext}")
-        File.open(fname, 'w') do |f|
-          f.write Site.asset_configuration.disclaimer
-          f.write content
+        def build(name, type, ext, urls)
+          content = urls.collect do |url|
+            if url.start_with?("github:")
+              url,ext = get_external_resource(url)
+            end
+
+            "//= require #{url}.#{ext}"
+          end.compact.join("\n")
+
+          out_folder = File.join(Pubba.asset_folder, "out", ext)
+          FileUtils.mkdir_p out_folder
+          fname = File.join(out_folder, "#{name}-#{type}.#{ext}")
+          File.open(fname, 'w') do |f|
+            f.write Site.asset_configuration.disclaimer
+            f.write content
+          end
         end
       end
 

data/lib/pubba/page.rb

@@ -74,7 +74,7 @@ module Pubba
       style_groups do |group, hash|
         urls = []
         style_urls(group) do |url|
-          next if url.start_with?("http")
+          next if external?(url)
           urls << url
         end
         Pubba.asset_handler.build(name, group, "css", urls)
@@ -85,7 +85,7 @@ module Pubba
       script_groups do |group|
         urls = []
         script_urls(group) do |url|
-          next if url.start_with?("http")
+          next if external?(url)
           urls << url
         end
         Pubba.asset_handler.build(name, group, "js", urls)
@@ -111,7 +111,7 @@ module Pubba
     def add_style_tag(group, hash, url)
       h = { tag: 'link', type: 'text/css', rel: 'stylesheet' }
       h[:media] = hash['media'] if hash['media']
-      h[:href]  = url.start_with?("http") ? url : "/#{Pubba.style_folder}/#{name}-#{group}.css"
+      h[:href]  = external?(url) ? url : "/#{Pubba.style_folder}/#{name}-#{group}.css"
       h[:id] = hash['id'] if hash['id']
 
       maybe_add_tag(@head_tags, h, :href)
@@ -119,7 +119,7 @@ module Pubba
 
     def add_script_tag(group, url)
       h = { tag: 'script', type: "text/javascript" }
-      h[:src]   = url.start_with?("http") ? url : "/#{Pubba.script_folder}/#{name}-#{group}.js"
+      h[:src]   = external?(url) ? url : "/#{Pubba.script_folder}/#{name}-#{group}.js"
 
       tag_set = (group == "head") ? @head_tags : @body_tags
       maybe_add_tag(tag_set, h, :src)
@@ -130,5 +130,9 @@ module Pubba
       tag_set.each{|tag| found = true if tag[key] == hash[key]}
       tag_set << hash unless found
     end
+
+    def external?(url)
+      (url.start_with?("http") and not url.start_with?("github:")) ? true : false
+    end
   end # Page
 end # Pubba

data/lib/pubba/version.rb

@@ -1,5 +1,5 @@
 module Pubba
   # Pubba version string
   # @api public
-  VERSION = '0.7.2'
+  VERSION = '0.8.0'
 end

data/pubba.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('yui-compressor', ['>= 0.9.4'])
   s.add_runtime_dependency('fssm', ['>= 0.2.7'])
   s.add_runtime_dependency('statica', ['>= 0.3.0'])
+  s.add_runtime_dependency('octopi', ['>= 0.4.5'])
 
   s.add_development_dependency('rake', ['>= 0.9.2'])
   s.add_development_dependency('sinatra', ['>= 1.3.1'])

data/test/helper.rb

@@ -1,32 +1,9 @@
 require 'minitest/unit'
 require 'sinatra/test_helpers'
+require_relative 'resources'
 
 MiniTest::Unit.autorun
 
-module R
-  extend self
-
-  def app_folder
-    File.join(File.dirname(__FILE__), 'sinatra', 'app')
-  end
-
-  def asset_folder
-    File.join(app_folder, 'assets')
-  end
-
-  def r18n_folder
-    File.join(app_folder, 'i18n')
-  end
-
-  def public_folder
-    File.join(File.dirname(__FILE__), 'sinatra', 'public')
-  end
-
-  def pubba_config_file
-    File.join(File.dirname(__FILE__), 'sinatra', 'config', 'pubba.yml')
-  end
-end
-
 class TestPubba < MiniTest::Unit::TestCase
   include Sinatra::TestHelpers
 
@@ -34,13 +11,13 @@ class TestPubba < MiniTest::Unit::TestCase
     mock_app do
       require 'pubba'
 
-      settings.set :public_folder, R.public_folder
+      settings.set :public_folder, Resources.public_folder
 
       Pubba.configure do |p|
-        p.config_file   = R.pubba_config_file
+        p.config_file   = Resources.pubba_config_file
         p.public_folder = settings.public_folder
-        p.asset_folder  = R.asset_folder
-        p.r18n_folder   = R.r18n_folder
+        p.asset_folder  = Resources.asset_folder
+        p.r18n_folder   = Resources.r18n_folder
       end
 
       Pubba::Site.configure

data/test/pubba/assets/test_configuration.rb

@@ -2,17 +2,17 @@ require 'helper'
 
 class TestPubbaAssetsConfiguration < TestPubba
   def setup
-    @config = Pubba::Assets::Configuration.new(R.pubba_config_file)
+    @config = Pubba::Assets::Configuration.new(Resources.pubba_config_file)
   end
 
   def test_yaml_is_initialized
-    hsh = {"global"=>{"styles"=>{"all"=>{"urls"=>["http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css", "custom/global"]}, "phone"=>{"media"=>"only screen and (max-width: 480px)", "urls"=>["custom/small"]}, "desktop"=>{"media"=>"only screen and (min-width: 480px)", "urls"=>["custom/large"]}}, "scripts"=>{"head"=>["https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js", "third-party/modernizr"], "body"=>["https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js", "third-party/backbone", "custom/app", "custom/tracker"]}}, "home"=>{"styles"=>{"all"=>{"urls"=>["custom/home"]}}}, "search"=>{"styles"=>{"all"=>{"urls"=>["custom/search", "third-party/widget"]}}, "scripts"=>{"body"=>["custom/lightbox"]}}}
+    hsh = {"global"=>{"styles"=>{"all"=>{"urls"=>["http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css", "custom/global"]}, "phone"=>{"media"=>"only screen and (max-width: 480px)", "urls"=>["custom/small"]}, "desktop"=>{"media"=>"only screen and (min-width: 480px)", "urls"=>["custom/large"]}}, "scripts"=>{"head"=>["https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js", "third-party/modernizr"], "body"=>["https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js", "github:documentcloud:underscore:1.2.4:underscore.js", "github:documentcloud:backbone:0.5.3:backbone.js", "custom/app", "custom/tracker"]}}, "home"=>{"styles"=>{"all"=>{"urls"=>["custom/home"]}}}, "search"=>{"styles"=>{"all"=>{"urls"=>["custom/search", "third-party/widget"]}}, "scripts"=>{"body"=>["custom/lightbox"]}}}
 
     assert_equal hsh, @config.yaml
   end
 
   def test_global_config
-    hsh = {"styles"=>{"all"=>{"urls"=>["http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css", "custom/global"]}, "phone"=>{"media"=>"only screen and (max-width: 480px)", "urls"=>["custom/small"]}, "desktop"=>{"media"=>"only screen and (min-width: 480px)", "urls"=>["custom/large"]}}, "scripts"=>{"head"=>["https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js", "third-party/modernizr"], "body"=>["https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js", "third-party/backbone", "custom/app", "custom/tracker"]}}
+    hsh = {"styles"=>{"all"=>{"urls"=>["http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css", "custom/global"]}, "phone"=>{"media"=>"only screen and (max-width: 480px)", "urls"=>["custom/small"]}, "desktop"=>{"media"=>"only screen and (min-width: 480px)", "urls"=>["custom/large"]}}, "scripts"=>{"head"=>["https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js", "third-party/modernizr"], "body"=>["https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js", "github:documentcloud:underscore:1.2.4:underscore.js", "github:documentcloud:backbone:0.5.3:backbone.js", "custom/app", "custom/tracker"]}}
 
     assert_equal hsh, @config.global_config!
 

data/test/pubba/test_page.rb

@@ -16,7 +16,7 @@ class TestPubbaPage < TestPubba
   end
 
   def test_home_all_css_asset
-    css = File.open( File.join(R.asset_folder, 'out', 'css', 'home-all.css')){|f| f.read }
+    css = File.open( File.join(Resources.asset_folder, 'out', 'css', 'home-all.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -29,7 +29,7 @@ TEXT
   end
 
   def test_home_phone_css_asset
-    css = File.open( File.join(R.asset_folder, 'out', 'css', 'home-phone.css')){|f| f.read }
+    css = File.open( File.join(Resources.asset_folder, 'out', 'css', 'home-phone.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -41,7 +41,7 @@ TEXT
   end
 
   def test_home_desktop_css_asset
-    css = File.open( File.join(R.asset_folder, 'out', 'css', 'home-desktop.css')){|f| f.read }
+    css = File.open( File.join(Resources.asset_folder, 'out', 'css', 'home-desktop.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -53,7 +53,7 @@ TEXT
   end
 
   def test_search_all_css_asset
-    css = File.open( File.join(R.asset_folder, 'out', 'css', 'search-all.css')){|f| f.read }
+    css = File.open( File.join(Resources.asset_folder, 'out', 'css', 'search-all.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -67,7 +67,7 @@ TEXT
   end
 
   def test_search_phone_css_asset
-    css = File.open( File.join(R.asset_folder, 'out', 'css', 'search-phone.css')){|f| f.read }
+    css = File.open( File.join(Resources.asset_folder, 'out', 'css', 'search-phone.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -79,7 +79,7 @@ TEXT
   end
 
   def test_search_desktop_css_asset
-    css = File.open( File.join(R.asset_folder, 'out', 'css', 'search-desktop.css')){|f| f.read }
+    css = File.open( File.join(Resources.asset_folder, 'out', 'css', 'search-desktop.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -91,7 +91,7 @@ TEXT
   end
 
   def test_home_head_js_asset
-    js = File.open( File.join(R.asset_folder, 'out', 'js', 'home-head.js')){|f| f.read }
+    js = File.open( File.join(Resources.asset_folder, 'out', 'js', 'home-head.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -103,12 +103,13 @@ TEXT
   end
 
   def test_home_body_js_asset
-    js = File.open( File.join(R.asset_folder, 'out', 'js', 'home-body.js')){|f| f.read }
+    js = File.open( File.join(Resources.asset_folder, 'out', 'js', 'home-body.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
 //
-//= require third-party/backbone.js
+//= require github/documentcloud/underscore.js
+//= require github/documentcloud/backbone.js
 //= require custom/app.js
 //= require custom/tracker.js
 TEXT
@@ -117,7 +118,7 @@ TEXT
   end
 
   def test_search_head_js_asset
-    js = File.open( File.join(R.asset_folder, 'out', 'js', 'search-head.js')){|f| f.read }
+    js = File.open( File.join(Resources.asset_folder, 'out', 'js', 'search-head.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
@@ -129,12 +130,13 @@ TEXT
   end
 
   def test_search_body_js_asset
-    js = File.open( File.join(R.asset_folder, 'out', 'js', 'search-body.js')){|f| f.read }
+    js = File.open( File.join(Resources.asset_folder, 'out', 'js', 'search-body.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Pubba::Site.asset_configuration.name}
 //
-//= require third-party/backbone.js
+//= require github/documentcloud/underscore.js
+//= require github/documentcloud/backbone.js
 //= require custom/app.js
 //= require custom/tracker.js
 //= require custom/lightbox.js

data/test/pubba/test_site.rb

@@ -10,11 +10,11 @@ class TestPubbaSite < TestPubba
   end
 
   def test_asset_folder_initialization
-    assert_equal "#{R.asset_folder}", Pubba.asset_folder
+    assert_equal "#{Resources.asset_folder}", Pubba.asset_folder
   end
 
   def test_public_folder_initialization
-    assert_equal "#{R.public_folder}", Pubba.public_folder
+    assert_equal "#{Resources.public_folder}", Pubba.public_folder
   end
 
   def test_script_folder_initialization

data/test/resources.rb

@@ -0,0 +1,61 @@
+module Resources
+  extend self
+
+  def app_folder
+    File.join(File.dirname(__FILE__), 'sinatra', 'app')
+  end
+
+  def asset_folder
+    File.join(app_folder, 'assets')
+  end
+
+  def r18n_folder
+    File.join(app_folder, 'i18n')
+  end
+
+  def public_folder
+    File.join(File.dirname(__FILE__), 'sinatra', 'public')
+  end
+
+  def public_js_folder
+    File.join(File.dirname(__FILE__), 'sinatra', 'public', 'js')
+  end
+
+  def public_css_folder
+    File.join(File.dirname(__FILE__), 'sinatra', 'public', 'css')
+  end
+
+  def pubba_config_file
+    File.join(File.dirname(__FILE__), 'sinatra', 'config', 'pubba.yml')
+  end
+
+  def out_js_folder
+    File.join(asset_folder, 'out', 'js')
+  end
+
+  def out_css_folder
+    File.join(asset_folder, 'out', 'css')
+  end
+
+  def clean
+    Dir.glob(Resources.public_js_folder + "/*.js").each do |entry|
+      $>.print "deleting: #{entry}\n"
+      File.delete(entry)
+    end
+
+    Dir.glob(Resources.public_css_folder + "/*.css").each do |entry|
+      $>.print "deleting: #{entry}\n"
+      File.delete(entry)
+    end
+
+    Dir.glob(Resources.out_js_folder + "/*.js").each do |entry|
+      $>.print "deleting: #{entry}\n"
+      File.delete(entry)
+    end
+
+    Dir.glob(Resources.out_css_folder + "/*.css").each do |entry|
+      $>.print "deleting: #{entry}\n"
+      File.delete(entry)
+    end
+  end
+end

data/test/sinatra/app/assets/js/custom/home.js

@@ -0,0 +1,3 @@
+function home(){
+  alert('This is the home test file');
+}

data/test/sinatra/app/assets/js/custom/search.js

@@ -0,0 +1,3 @@
+function search(){
+  alert('This is the search test file');
+}