pubba 0.5.0 → 0.6.0

data/.gitignore

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

data/CHANGES

@@ -1,5 +1,17 @@
 master
 
+
+0.6.0
+
+  * 0.5.0 broken process; not pointing to new out directory
+  * Consistency with directory names javascripts -> js, stylesheets -> css
+  * Update to Statica 0.2.0
+  * Don't restrict asset sources to *.js and *.css to allow for pipelining
+
+0.5.0
+
+  * Move output files to {asset_dir}/out/{type}
+
 0.4.2
   * Use Rack::StaticaServer
 

data/README.md

@@ -10,9 +10,6 @@ __I do not consider this project production ready at this time. It will be soon
 
 TODO:
 
-* Add cache bursting functionality
-* Remove requirement for placing of scripts/styles in subdirectories. For instance, the convention now is scripts would be in subdirs like javascripts/custom and javscripts/third-party. The only scripts/styles in the root dir are those generated by this extension.
-* Compress the combined assets
 * More tests!
 * Improve documentation!
 
@@ -27,7 +24,7 @@ Any process that involves changing code between environments, even in an automat
 As mentioned, code organization is another focus of pubba. The config file __pubba.yml__  uses the global section to clearly state which assets should be on all pages. This functionality is not restricted to your local assets. The pubba config file also allows you to declare external assets. In short, you should not have a single script tag in your views other than those generated by the `page_head_tags` and `page_body_tags` helpers provided by pubba.
 
 
-In addition, when using R18n, pubba gives you access through a single page object.
+In addition, when using R18n, pubba gives you access through a single page object. This allows you to have all your static text in a central location.
 
 
 # Settings
@@ -122,7 +119,20 @@ Next up is creating the all important __pubba.yml__ config file:
           - "custom/lightbox"
 
 
-The config file is referencing the javascripts and stylesheets located in the `asset_folder`.
+The config file is referencing the javascripts and stylesheets located in the `asset_folder`. The default folder structure for assets:
+
+    # Javascript assets
+    {asset_folder}/js/
+
+    # Stylesheet assets
+    {asset_folder}/css/
+
+    # After processing javascripts will be placed in:
+    {public_folder}/js/
+
+    # After processing stylesheets will be placed in:
+    {public_folder}/css/
+
 
 Now you obviouslly need some helpers to make use of the definitions in __pubba.yml__, and here they are:
 
@@ -147,16 +157,16 @@ What you'll see when working with pubba is that the files in your `asset_folder`
 Using the above __pubba.yml__ configuration, if you are using the 'home' page definition, the output of `page_head_tags` will be (formatted for the README):
 
     <link href="http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css" rel="stylesheet" type="text/css"></link>
-    <link href="/stylesheets/home-all.css" rel="stylesheet" type="text/css"></link>
-    <link href="/stylesheets/home-phone.css" media="only screen and (max-width: 480px)" rel="stylesheet" type="text/css"></link>
-    <link href="/stylesheets/home-desktop.css" media="only screen and (min-width: 480px)" rel="stylesheet" type="text/css"></link>
+    <link href="/css/home-all.css" rel="stylesheet" type="text/css"></link>
+    <link href="/css/home-phone.css" media="only screen and (max-width: 480px)" rel="stylesheet" type="text/css"></link>
+    <link href="/css/home-desktop.css" media="only screen and (min-width: 480px)" rel="stylesheet" type="text/css"></link>
     <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js" type="text/javascript"></script>
-    <script src="/javascripts/home-head.js" type="text/javascript"></script>|
+    <script src="/js/home-head.js" type="text/javascript"></script>|
 
 Again, using the above __pubba.yml__ configuration, if you are using the 'home' page definition, the output of `page_body_tags` will be (formatted for the README):
 
     <script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js" type="text/javascript"></script>
-    <script src="/javascripts/home-body.js" type="text/javascript"></script>
+    <script src="/js/home-body.js" type="text/javascript"></script>
 
 # R18n
 

data/lib/sinatra/pubba/assets/sprockets_handler.rb

@@ -20,8 +20,10 @@ module Sinatra
           @sprockets ||= Sprockets::Environment.new()
         end
 
-        def self.process(source, pattern, destination)
-          Dir.glob("#{source}/#{pattern}") do |file|
+        def self.process(source, destination)
+          FileUtils.mkdir_p destination
+
+          Dir.glob("#{source}/*") do |file|
             asset = find(file)
             asset.save_as "#{destination}/#{File.basename(file)}"
           end

data/lib/sinatra/pubba/page.rb

@@ -112,14 +112,14 @@ module Sinatra
       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 : "/stylesheets/#{name}-#{group}.css"
+        h[:href]  = url.start_with?("http") ? url : "/#{Site.style_folder}/#{name}-#{group}.css"
 
         maybe_add_tag(@head_tags, h, :href)
       end
 
       def add_script_tag(group, url)
         h = { tag: 'script', type: "text/javascript" }
-        h[:src]   = url.start_with?("http") ? url : "/javascripts/#{name}-#{group}.js"
+        h[:src]   = url.start_with?("http") ? url : "/#{Site.script_folder}/#{name}-#{group}.js"
 
         tag_set = (group == "head") ? @head_tags : @body_tags
         maybe_add_tag(tag_set, h, :src)

data/lib/sinatra/pubba/site.rb

@@ -53,11 +53,14 @@ module Sinatra
       def process
         pages.each{|name, p| p.assetize }
 
+        asset_script_folder = File.join(asset_folder, 'out', script_folder)
+        asset_style_folder = File.join(asset_folder, 'out', style_folder)
+
         public_script_folder = File.join(public_folder, script_folder)
         public_style_folder = File.join(public_folder, style_folder)
 
-        asset_handler.process(asset_folder, "*.js",  public_script_folder)
-        asset_handler.process(asset_folder, "*.css", public_style_folder)
+        asset_handler.process(asset_script_folder, public_script_folder)
+        asset_handler.process(asset_style_folder, public_style_folder)
 
         asset_minifier.minify(public_script_folder, :js)
         asset_minifier.minify(public_style_folder, :css)
@@ -82,8 +85,8 @@ module Sinatra
       def set_folder_defaults(settings)
         @public_folder    = settings.public_folder
         @asset_folder     = settings.asset_folder
-        @script_folder    = 'javascripts'
-        @style_folder     = 'stylesheets'
+        @script_folder    = 'js'
+        @style_folder     = 'css'
 
         Statica.root_dir  = settings.public_folder
       end

data/lib/sinatra/pubba/version.rb

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

data/pubba.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('r18n-desktop', ['~> 0.4.13'])
   s.add_runtime_dependency('yui-compressor', ['>= 0.9.4'])
   s.add_runtime_dependency('fssm', ['>= 0.2.7'])
-  s.add_runtime_dependency('statica', ['>= 0.1.0'])
+  s.add_runtime_dependency('statica', ['>= 0.2.0'])
 
   s.add_development_dependency('rake', ['>= 0.9.2'])
   s.add_development_dependency('sinatra', ['>= 1.3.1'])

data/test/pubba/html/test_helpers.rb

@@ -6,7 +6,7 @@ class TestPubbaHTMLHelper < TestPubba
 
   def test_home_page_head_tags
     res = get('/home-page-head-tags').body
-    reg = Regexp.new '<link href="http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css" rel="stylesheet" type="text/css"></link><link href="/stylesheets/home-all.css/\w+" rel="stylesheet" type="text/css"></link><link href="/stylesheets/home-phone.css/\w+" media="only screen and \(max-width: 480px\)" rel="stylesheet" type="text/css"></link><link href="/stylesheets/home-desktop.css/\w+" media="only screen and \(min-width: 480px\)" rel="stylesheet" type="text/css"></link><script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js" type="text/javascript"></script><script src="/javascripts/home-head.js/\w+" type="text/javascript"></script>'
+    reg = Regexp.new '<link href="http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css" rel="stylesheet" type="text/css"></link><link href="/css/home-all.css/\w+" rel="stylesheet" type="text/css"></link><link href="/css/home-phone.css/\w+" media="only screen and \(max-width: 480px\)" rel="stylesheet" type="text/css"></link><link href="/css/home-desktop.css/\w+" media="only screen and \(min-width: 480px\)" rel="stylesheet" type="text/css"></link><script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js" type="text/javascript"></script><script src="/js/home-head.js/\w+" type="text/javascript"></script>'
 
 
     assert_match reg, res
@@ -14,7 +14,7 @@ class TestPubbaHTMLHelper < TestPubba
 
   def test_home_page_body_tags
     res = get('/home-page-body-tags').body
-    reg = Regexp.new '<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js" type="text/javascript"></script><script src="/javascripts/home-body.js/\w+" type="text/javascript"></script>'
+    reg = Regexp.new '<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js" type="text/javascript"></script><script src="/js/home-body.js/\w+" type="text/javascript"></script>'
 
     assert_match reg, res
   end

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, 'stylesheets', 'home-all.css')){|f| f.read }
+    css = File.open( File.join(R.asset_folder, 'out', 'css', 'home-all.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::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, 'stylesheets', 'home-phone.css')){|f| f.read }
+    css = File.open( File.join(R.asset_folder, 'out', 'css', 'home-phone.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::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, 'stylesheets', 'home-desktop.css')){|f| f.read }
+    css = File.open( File.join(R.asset_folder, 'out', 'css', 'home-desktop.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::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, 'stylesheets', 'search-all.css')){|f| f.read }
+    css = File.open( File.join(R.asset_folder, 'out', 'css', 'search-all.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::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, 'stylesheets', 'search-phone.css')){|f| f.read }
+    css = File.open( File.join(R.asset_folder, 'out', 'css', 'search-phone.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::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, 'stylesheets', 'search-desktop.css')){|f| f.read }
+    css = File.open( File.join(R.asset_folder, 'out', 'css', 'search-desktop.css')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::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, 'javascripts', 'home-head.js')){|f| f.read }
+    js = File.open( File.join(R.asset_folder, 'out', 'js', 'home-head.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::Pubba::Site.asset_configuration.name}
@@ -103,7 +103,7 @@ TEXT
   end
 
   def test_home_body_js_asset
-    js = File.open( File.join(R.asset_folder, 'javascripts', 'home-body.js')){|f| f.read }
+    js = File.open( File.join(R.asset_folder, 'out', 'js', 'home-body.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::Pubba::Site.asset_configuration.name}
@@ -117,7 +117,7 @@ TEXT
   end
 
   def test_search_head_js_asset
-    js = File.open( File.join(R.asset_folder, 'javascripts', 'search-head.js')){|f| f.read }
+    js = File.open( File.join(R.asset_folder, 'out', 'js', 'search-head.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::Pubba::Site.asset_configuration.name}
@@ -129,7 +129,7 @@ TEXT
   end
 
   def test_search_body_js_asset
-    js = File.open( File.join(R.asset_folder, 'javascripts', 'search-body.js')){|f| f.read }
+    js = File.open( File.join(R.asset_folder, 'out', 'js', 'search-body.js')){|f| f.read }
     contents = <<TEXT
 // This file is automatically generated from the contents
 // in #{Sinatra::Pubba::Site.asset_configuration.name}

data/test/pubba/test_site.rb

@@ -18,10 +18,10 @@ class TestPubbaSite < TestPubba
   end
 
   def test_script_folder_initialization
-    assert_equal "javascripts", Sinatra::Pubba::Site.script_folder
+    assert_equal "js", Sinatra::Pubba::Site.script_folder
   end
 
   def test_style_folder_initialization
-    assert_equal "stylesheets", Sinatra::Pubba::Site.style_folder
+    assert_equal "css", Sinatra::Pubba::Site.style_folder
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pubba
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-21 00:00:00.000000000 Z
+date: 2011-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &2151797060 !ruby/object:Gem::Requirement
+  requirement: &2151888640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2151797060
+  version_requirements: *2151888640
 - !ruby/object:Gem::Dependency
   name: r18n-desktop
-  requirement: &2151812720 !ruby/object:Gem::Requirement
+  requirement: &2151887220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.13
   type: :runtime
   prerelease: false
-  version_requirements: *2151812720
+  version_requirements: *2151887220
 - !ruby/object:Gem::Dependency
   name: yui-compressor
-  requirement: &2151812000 !ruby/object:Gem::Requirement
+  requirement: &2151902720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *2151812000
+  version_requirements: *2151902720
 - !ruby/object:Gem::Dependency
   name: fssm
-  requirement: &2151811180 !ruby/object:Gem::Requirement
+  requirement: &2151901700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +54,21 @@ dependencies:
         version: 0.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *2151811180
+  version_requirements: *2151901700
 - !ruby/object:Gem::Dependency
   name: statica
-  requirement: &2151810620 !ruby/object:Gem::Requirement
+  requirement: &2151900860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2151810620
+  version_requirements: *2151900860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2151810000 !ruby/object:Gem::Requirement
+  requirement: &2151900020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2151810000
+  version_requirements: *2151900020
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2151809500 !ruby/object:Gem::Requirement
+  requirement: &2151899180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *2151809500
+  version_requirements: *2151899180
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
-  requirement: &2151808940 !ruby/object:Gem::Requirement
+  requirement: &2151898320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *2151808940
+  version_requirements: *2151898320
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2151808040 !ruby/object:Gem::Requirement
+  requirement: &2151897500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151808040
+  version_requirements: *2151897500
 description: 
 email:
 - andy@stonean.com
@@ -145,21 +145,19 @@ files:
 - test/pubba/html/test_helpers.rb
 - test/pubba/test_page.rb
 - test/pubba/test_site.rb
-- test/sinatra/app/assets/javascripts/custom/app.js
-- test/sinatra/app/assets/javascripts/custom/lightbox.js
-- test/sinatra/app/assets/javascripts/custom/tracker.js
-- test/sinatra/app/assets/javascripts/third-party/backbone.js
-- test/sinatra/app/assets/javascripts/third-party/modernizr.js
-- test/sinatra/app/assets/stylesheets/custom/global.css
-- test/sinatra/app/assets/stylesheets/custom/home.css
-- test/sinatra/app/assets/stylesheets/custom/large.css
-- test/sinatra/app/assets/stylesheets/custom/search.css
-- test/sinatra/app/assets/stylesheets/custom/small.css
-- test/sinatra/app/assets/stylesheets/third-party/widget.css
+- test/sinatra/app/assets/css/custom/global.css
+- test/sinatra/app/assets/css/custom/home.css
+- test/sinatra/app/assets/css/custom/large.css
+- test/sinatra/app/assets/css/custom/search.css
+- test/sinatra/app/assets/css/custom/small.css
+- test/sinatra/app/assets/css/third-party/widget.css
+- test/sinatra/app/assets/js/custom/app.js
+- test/sinatra/app/assets/js/custom/lightbox.js
+- test/sinatra/app/assets/js/custom/tracker.js
+- test/sinatra/app/assets/js/third-party/backbone.js
+- test/sinatra/app/assets/js/third-party/modernizr.js
 - test/sinatra/app/i18n/en.yml
 - test/sinatra/config/pubba.yml
-- test/sinatra/public/javascripts/_
-- test/sinatra/public/stylesheets/_
 homepage: http://github.com/stonean/pubba
 licenses: []
 post_install_message: