nanoc-toolbox 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## developement
 
+## Release 0.0.5
+* NEW:      Analytics Helper
+* NEW:      JS Minify Filter
+
 ## Release 0.0.5
 * CHANGED:  add the ability to filter by an attributes of an item on navigation_for
 

data/Gemfile.lock

@@ -1,20 +1,22 @@
 PATH
   remote: .
   specs:
-    nanoc-toolbox (0.0.3)
+    nanoc-toolbox (0.0.6)
+      jsmin (>= 1.0.1)
       nanoc (>= 3.1.6)
       nokogiri (>= 1.4.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    cri (1.0.1)
+    cri (2.0.2)
     diff-lcs (1.1.2)
-    nanoc (3.1.6)
-      nanoc3 (>= 3.1.6)
-    nanoc3 (3.1.6)
-      cri (>= 1.0.0)
-    nokogiri (1.4.4)
+    jsmin (1.0.1)
+    nanoc (3.2.3)
+      nanoc3 (>= 3.2.3)
+    nanoc3 (3.2.3)
+      cri (~> 2.0)
+    nokogiri (1.5.0)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
       rspec-expectations (~> 2.4.0)
@@ -29,7 +31,5 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
-  nanoc (>= 3.1.6)
   nanoc-toolbox!
-  nokogiri (>= 1.4.4)
   rspec (>= 1.0.0)

data/README.md

@@ -8,17 +8,24 @@ The nanoc-toolbox is a collection of filters and helpers for the static site gen
 
 ## Features
 
-* Navigation Helper
-* Gravatar Helper
-* HtmlTag Helper
+### Helpers
 
-* AddSection Filter
-* HtmlTidy Filter
+ * **Navigation**: Menu, Breadcrumb, Table of contents, 
+ * **Gravatar**: Avatar Using the Gravatar System
+ * **HtmlTag**: HTML Tag helper for other helpers
+ * **Google Analytics***: Generate the JS code snipet for Analytics
+
+### Filters
+
+ * **AddSection**: Section div's based on headers
+ * **HtmlTidy**: Clean up the generated html code with Nokogiri
+ * **JS Minify**: Minifies the JS files using JSMin
 
 ## Requirements
 
-* nanoc3
-* Nokogiri
+ * **nanoc3**: It requires obviously the Nanoc gem
+ * **Nokogiri**: For the HTML Tidy Filter
+ * **jsmin**: For the JS Minify Filter
 
 ## Installation
 
@@ -28,35 +35,39 @@ To use the nanoc-toolbox, you have to start by installing the gem.
 
 Then require the project main file in your default.rb file in the lib directory of your nanoc project.
 
-    require "nanoc/toolbox"
+```ruby
+require "nanoc/toolbox"
+```
 
 And the last step is to include the required helper or filter, anywhere in the lib directory of your lib directory.
 The usage wants you to put it in the default.rb or the helpers.rb file. 
 
 The following example shows a sample helpers_.rb file in the lib directory
 
-    # Default Helpers provided By Nanoc
-    include Nanoc3::Helpers::Blogging
-    include Nanoc3::Helpers::Breadcrumbs
+```ruby
+# Default Helpers provided By Nanoc
+include Nanoc3::Helpers::Blogging
+include Nanoc3::Helpers::Breadcrumbs
 
-    # Custom Helpers
-    include Nanoc::Toolbox::Helpers::Navigation
-    include Nanoc::Toolbox::Helpers::Gravatar
+# Custom Helpers
+include Nanoc::Toolbox::Helpers::Navigation
+include Nanoc::Toolbox::Helpers::Gravatar
+```
 
 ## Acknowledgments
 
+All the people in [this list](https://github.com/aadlani/nanoc-toolbox/contributors)
 
-
-## Author
+## Authors
 
 * Anouar ADLANI <anouar@adlani.com>
 
 ## Changelog
 
-See the CHANGELOG.rdoc file for details.
+See the [CHANGELOG](https://github.com/aadlani/nanoc-toolbox/blob/master/CHANGELOG.md) file for details.
 
 
 ## License
 
 Copyright (c) 2011 Anouar ADLANI, nanoc-toolbox is released under the MIT license.
-See the LICENSE.md file for details.
+See the [LICENSE](https://github.com/aadlani/nanoc-toolbox/blob/master/LICENSE.md) file for details.

data/lib/nanoc/toolbox/filters/js_minify.rb

@@ -0,0 +1,15 @@
+require 'jsmin'
+
+module Nanoc::Toolbox::Filters
+  # NANOC Filter for minifying the JS Files
+  # using the JSMin gem
+  # @see http://rubygems.org/gems/jsmin
+  # @author Anouar ADLANI <anouar@adlani.com>
+  class JsMinify < Nanoc3::Filter
+    identifier :js_minify
+
+    def run(content, args = {})
+      JSMin.minify(content)
+    end
+  end
+end

data/lib/nanoc/toolbox/filters.rb

@@ -1,7 +1,7 @@
 require 'nanoc/toolbox/filters/html_tidy'
 require 'nanoc/toolbox/filters/add_sections'
+require 'nanoc/toolbox/filters/js_minify'
 
 # This module will regroup all the filters for nanoc
 module Nanoc::Toolbox::Filters
-
 end

data/lib/nanoc/toolbox/helpers/google_analytics.rb

@@ -0,0 +1,33 @@
+require 'nanoc/toolbox/helpers/html_tag'
+
+module Nanoc::Toolbox::Helpers  
+  # NANOC Helper for the Google Analytics JS to add at the end of the layout.
+  #
+  # This module contains helper functions to generate the JS code snipet
+  # used to track your site analytics by simply entering your tracking ID as 
+  # parameter or in the configuration file
+  #
+  # @see http://www.google.com/analytics/
+  # @author Anouar ADLANI <anouar@adlani.com>
+  module GoogleAnalytics
+    include Nanoc::Toolbox::Helpers::HtmlTag
+    
+    def ga_tracking_snippet(ga_tracking_code=nil)
+      ga_tracking_code ||= @site.config[:ga_tracking_code]
+      js = <<-EOS
+        
+        var _gaq = _gaq || [];
+        _gaq.push(['_setAccount', '#{ga_tracking_code}']);
+        _gaq.push(['_trackPageview']);
+
+        (function() {
+          var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+          ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+          var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+        })();
+        
+      EOS
+      content_tag('script', js, { :type => 'text/javascript' })
+    end
+  end
+end

data/lib/nanoc/toolbox/helpers.rb

@@ -1,6 +1,7 @@
 require 'nanoc/toolbox/helpers/navigation'
 require 'nanoc/toolbox/helpers/gravatar'
 require 'nanoc/toolbox/helpers/html_tag'
+require 'nanoc/toolbox/helpers/google_analytics'
 
 # This module will regroup all the helpers for nanoc
 module Nanoc::Toolbox::Helpers

data/lib/nanoc/toolbox/version.rb

@@ -4,7 +4,7 @@ module Nanoc
     module Version
       MAJOR = 0
       MINOR = 0
-      PATCH = 5
+      PATCH = 6
       BUILD = nil
 
       STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")

data/nanoc-toolbox.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "nanoc", ">= 3.1.6"
   s.add_dependency "nokogiri", ">= 1.4.4"
+  s.add_dependency "jsmin", ">= 1.0.1"
   
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rspec", ">= 1.0.0"

data/spec/helpers/google_analytics_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+include Nanoc::Toolbox::Helpers::GoogleAnalytics
+
+describe Nanoc::Toolbox::Helpers::GoogleAnalytics do
+  subject { Nanoc::Toolbox::Helpers::GoogleAnalytics }
+  it { should respond_to(:ga_tracking_snippet) }
+  describe ".ga_tracking_snippet" do
+    it "returns a string that contains the JS" do
+      ga_tracking_snippet("").should include("<script")
+      ga_tracking_snippet("").should include("var _gaq = _gaq || [];")
+    end
+    
+    it "includes the passed code" do
+      ga_tracking_snippet("qwertzuiop").should include("qwertzuiop")      
+    end
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc-toolbox
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors: 
 - Anouar ADLANI
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-24 00:00:00 +01:00
-default_executable: 
+date: 2011-11-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nanoc
@@ -25,10 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 1
-        - 6
         version: 3.1.6
   type: :runtime
   version_requirements: *id001
@@ -40,43 +31,42 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 4
         version: 1.4.4
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: jsmin
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  type: :development
+        version: 1.0.1
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: bundler
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
 description: The nanoc-toolbox is a collection of filters and helpers for the static site generator tool nanoc
 email: 
 - anouar@adlani.com
@@ -99,7 +89,9 @@ files:
 - lib/nanoc/toolbox/filters.rb
 - lib/nanoc/toolbox/filters/add_sections.rb
 - lib/nanoc/toolbox/filters/html_tidy.rb
+- lib/nanoc/toolbox/filters/js_minify.rb
 - lib/nanoc/toolbox/helpers.rb
+- lib/nanoc/toolbox/helpers/google_analytics.rb
 - lib/nanoc/toolbox/helpers/gravatar.rb
 - lib/nanoc/toolbox/helpers/html_tag.rb
 - lib/nanoc/toolbox/helpers/navigation.rb
@@ -108,11 +100,11 @@ files:
 - spec/data/filters/item_without_sections.html
 - spec/filters/add_sections_spec.rb
 - spec/filters/html_tidy_spec.rb
+- spec/helpers/google_analytics_spec.rb
 - spec/helpers/gravatar_spec.rb
 - spec/helpers/html_tag_spec.rb
 - spec/helpers/navigation_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://aadlani.github.com/nanoc-toolbox/
 licenses: []
 
@@ -127,23 +119,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A collection of helper and filters for nanoc