pubba 0.2.0 → 0.2.1

data/CHANGES

@@ -1,5 +1,7 @@
 master
 
+0.2.0
+
   * Ability to add external references
   * Ability to add media query requirement to styles
 

data/README.md

@@ -10,6 +10,7 @@ __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!
@@ -23,9 +24,10 @@ If you've ever had to deal with an audit department, you understand some of the
 
 Any process that involves changing code between environments, even in an automated fashion, is great fodder for the audit machine. This extension makes sure the javascript and css you work with in development is the same as it will be in production.
 
-This does result in the use of a cache bursting query parameter to be added to the url instead of the digest per asset approach. While the digest approach is much more accurate it complicates using a commit/tag to completely represent the deployment contents.
+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.
 
-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. 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.
 
 
 # Settings
@@ -122,6 +124,42 @@ Next up is creating the all important __pubba.yml__ config file:
 
 The config file is referencing the javascripts and stylesheets located in the `asset_folder`.
 
+Now you obviouslly need some helpers to make use of the definitions in __pubba.yml__, and here they are:
+
+* `page_head_tags`
+  * This helper emits the `link` and `script` tags with the contents defined in __pubba.yml__
+* `page_body_tags`
+  * This helper emits the `script` tag with the contents defined in __pubba.yml__. You would typically place this just before the `</body>` tag.
+
+Sample use:
+
+    html
+      head
+        title = @page.title
+        == page_head_tags
+      body
+        menu
+          a href="/" = @page.home_link
+        == page_body_tags
+
+What you'll see when working with pubba is that the files in your `asset_folder` are never referenced in your view. Even in development mode! The intent is that development mode is as close to production mode as possible. So, you are working with the same combined asset file you will be deploying.
+
+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>
+    <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>|
+
+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>
+
+# R18n
+
 If you're using R18n, you will need a translation file, here's a sample en.yml:
 
     home:
@@ -153,28 +191,6 @@ The `@page` variable gives you access to the definitions in __en.yml__. In your
 
 Notice that `title` is defined under the `home` section, but `home_link` is a top level definition. Pubba makes the effort to correctly resolve the __en.yml__ reference for you. Nice isn't it.
 
-Now you obviouslly need some helpers to make use of the definitions in __pubba.yml__, and here they are:
-
-* `page_head_tags`
-  * This helper emits the `link` and `script` tags with the contents defined in __pubba.yml__
-* `page_body_tags`
-  * This helper emits the `script` tag with the contents defined in __pubba.yml__. You would typically place this just before the `</body>` tag.
-* `burst(url)`
-  * This helper simply appends a cache bursting parameter named `aid` to the end of the url. In development mode the `aid` value is updated per request. The intent is to help with the particularly aggressive caching Google's Chrome browser likes to implement. In production mode, Pubba requires `ENV[ASSET_ID]` to be set and uses this for the `aid` value. I expect this to be tweaked as I get further into implementation.
-
-Sample use:
-
-    html
-      head
-        title = @page.title
-        == page_head_tags
-      body
-        menu
-          a href="/" = @page.home_link
-        == page_body_tags
-
-What you'll see when working with Pubba is that the files in your `asset_folder` are never referenced in your view. Even in development mode! The intent is that development mode is as close to production mode as possible. So, you are working with the same combined asset file you will be deploying.
-
 # Acknowledgement
 
 Huge thanks to my company, [Primedia](http://primedia.com) for encouraging open source contributions. This particular extension is obviously very new and hasn't hit a production site yet, but it will. I will post a list here as we migrate our applications from Rails to Sinatra.

data/lib/sinatra/pubba/version.rb

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

data/pubba.gemspec

@@ -8,8 +8,7 @@ Gem::Specification.new do |s|
   s.date              = Date.today.to_s
   s.authors           = ['Andrew Stone']
   s.email             = ['andy@stonean.com']
-  s.summary           = 'Pubba is a Sinatra extension.'
-  s.description       = 'Pubba is a Sinatra extension designed to help you manage your site.'
+  s.summary           = 'Pubba is a Sinatra extension designed to help you manage the static components of your site.'
   s.homepage          = 'http://github.com/stonean/pubba'
   s.extra_rdoc_files  = %w(README.md)
   s.rdoc_options      = %w(--charset=UTF-8)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pubba
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &2151907280 !ruby/object:Gem::Requirement
+  requirement: &2151907440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2151907280
+  version_requirements: *2151907440
 - !ruby/object:Gem::Dependency
   name: r18n-desktop
-  requirement: &2151906520 !ruby/object:Gem::Requirement
+  requirement: &2151906680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.11
   type: :runtime
   prerelease: false
-  version_requirements: *2151906520
+  version_requirements: *2151906680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2151906000 !ruby/object:Gem::Requirement
+  requirement: &2151906160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2151906000
+  version_requirements: *2151906160
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2151905480 !ruby/object:Gem::Requirement
+  requirement: &2151905660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *2151905480
+  version_requirements: *2151905660
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
-  requirement: &2151904780 !ruby/object:Gem::Requirement
+  requirement: &2151904960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *2151904780
+  version_requirements: *2151904960
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2151904200 !ruby/object:Gem::Requirement
+  requirement: &2151904380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,8 +76,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151904200
-description: Pubba is a Sinatra extension designed to help you manage your site.
+  version_requirements: *2151904380
+description: 
 email:
 - andy@stonean.com
 executables: []
@@ -147,6 +147,7 @@ rubyforge_project: pubba
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Pubba is a Sinatra extension.
+summary: Pubba is a Sinatra extension designed to help you manage the static components
+  of your site.
 test_files: []
 has_rdoc: