nanoc-toolbox 0.0.7 → 0.1.0

data/CHANGELOG.md

@@ -2,14 +2,25 @@
 
 ## developement
 
-## Release 0.0.5
+* CHANGE:   Code refactoring, Bug Fixes and Better test coverage
+* DELETE:   Unused helpers
+
+## Release 0.0.7
+
+* NEW: TRAVIS CI
+* FIXED: Compatibility Issue with 1.8.7
+
+## Release 0.0.6
+
 * 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
 
 ## Release 0.0.4
+
 * NEW:      add_section Filter
 * CHANGED:  bugfix on navigation helper 
 
@@ -29,4 +40,4 @@
 * NEW:      Add Yardoc
 
 ## Release 0.0.1
-* First Release
+* First Release

data/Gemfile

@@ -2,3 +2,6 @@ source :gemcutter
 
 # Specify your gem's dependencies in nanoc-toolbox.gemspec
 gemspec
+
+gem 'simplecov', :require => false, :group => :test
+gem 'guard-rspec', :require => false, :group => :development

data/Gemfile.lock

@@ -1,23 +1,39 @@
 PATH
   remote: .
   specs:
-    nanoc-toolbox (0.0.6)
-      jsmin (>= 1.0.1)
-      nanoc (>= 3.1.6)
-      nokogiri (>= 1.4.4)
+    nanoc-toolbox (0.0.8)
+      jsmin (~> 1.0)
+      nanoc (~> 3.4)
+      nokogiri (~> 1.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    cri (2.0.2)
+    colored (1.2)
+    cri (2.3.0)
+      colored (>= 1.2)
     diff-lcs (1.1.2)
+    ffi (1.0.11)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
     jsmin (1.0.1)
-    nanoc (3.2.3)
-      nanoc3 (>= 3.2.3)
-    nanoc3 (3.2.3)
-      cri (~> 2.0)
-    nokogiri (1.5.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    nanoc (3.4.0)
+      cri (~> 2.2)
+    nokogiri (1.5.5)
     rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
       rspec-expectations (~> 2.4.0)
@@ -26,12 +42,19 @@ GEM
     rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.4.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    thor (0.15.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.0.0)
+  bundler (~> 1.1)
+  guard-rspec
   nanoc-toolbox!
-  rake
-  rspec (>= 1.0.0)
+  rake (~> 0.9)
+  rspec (~> 2.4)
+  simplecov

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,10 +1,14 @@
 # nanoc-toolbox
 
 [![Build Status](https://secure.travis-ci.org/aadlani/nanoc-toolbox.png)](http://travis-ci.org/aadlani/nanoc-toolbox)
+[![Dependency Status](https://gemnasium.com/aadlani/nanoc-toolbox.png)](https://gemnasium.com/aadlani/nanoc-toolbox)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/aadlani/nanoc-toolbox)
 
 ## Presentation
 
 The nanoc-toolbox is a collection of filters and helpers for the static site generator tool nanoc.
+I have created this gem for my personal need on [my blog/resume website]( http://anouar.im ).
+If you feel something's missing, feel free to contribute.
 
 ## Features
 
@@ -13,7 +17,10 @@ The nanoc-toolbox is a collection of filters and helpers for the static site gen
  * **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
+ * **Google Analytics**: Generate the JS code snipet for Analytics
+ * **Blogging Extra**: Add extra blog post behavior
+ * **Tagging Extra**: Add extra tagging behavior
+ * **Disqus**: Disqus comments helper
 
 ### Filters
 
@@ -24,7 +31,7 @@ The nanoc-toolbox is a collection of filters and helpers for the static site gen
 ## Requirements and compatibility
 
  * **ruby >= 1.8.7**: This gem has been tested against ruby 1.8.7 and 1.9.2
- * **nanoc3**: It requires obviously the Nanoc gem
+ * **nanoc**: It requires obviously the Nanoc gem
  * **Nokogiri**: For the HTML Tidy Filter
  * **jsmin**: For the JS Minify Filter
 
@@ -32,7 +39,7 @@ The nanoc-toolbox is a collection of filters and helpers for the static site gen
 
 To use the nanoc-toolbox, you have to start by installing the gem.
 
-    gem install nanox-toolbox
+    gem install nanoc-toolbox
 
 Then require the project main file in your default.rb file in the lib directory of your nanoc project.
 
@@ -43,7 +50,7 @@ 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
+The following example shows a sample `helpers_.rb` file in the lib directory
 
 ```ruby
 # Default Helpers provided By Nanoc
@@ -55,11 +62,21 @@ include Nanoc::Toolbox::Helpers::Navigation
 include Nanoc::Toolbox::Helpers::Gravatar
 ```
 
+## Documentation
+
+### API Documentation
+
+The API documentation could be found on [RubyDoc.info](http://rubydoc.info/github/aadlani/nanoc-toolbox/frames)
+
+### Usage Guides
+
+Some usage guides could be found on the [GitHub wiki](https://github.com/aadlani/nanoc-toolbox/wiki)
+
 ## Acknowledgments
 
 All the people in [this list](https://github.com/aadlani/nanoc-toolbox/contributors)
 
-## Authors
+## Author
 
 * Anouar ADLANI <anouar@adlani.com>
 

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

@@ -31,7 +31,7 @@ module Nanoc::Toolbox::Filters
   #   section
   #     p
   # @author Denis Defreyne <denis.defreyne@stoneship.org>
-  class AddSections < Nanoc3::Filter
+  class AddSections < Nanoc::Filter
 
     identifiers :add_sections
 
@@ -89,4 +89,4 @@ module Nanoc::Toolbox::Filters
       doc.to_s
     end
   end
-end
+end

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

@@ -2,12 +2,12 @@ module Nanoc::Toolbox::Filters
   # NANOC Filter for html output tidy
   #
   # @author Anouar ADLANI <anouar@adlani.com>
-  class HtmlTidy < Nanoc3::Filter
-    
+  class HtmlTidy < Nanoc::Filter
+
     identifier :html_tidy
-    
+
     # Tidy the HTML output
-    # Runs the content through Nokogiry document parser, and request the html output, 
+    # Runs the content through Nokogiry document parser, and request the html output,
     # which is tidied by default.
     #
     # @param [String] content The content to filter
@@ -18,4 +18,4 @@ module Nanoc::Toolbox::Filters
       Nokogiri::HTML::Document.parse(content).to_html
     end
   end
-end
+end

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

@@ -5,11 +5,11 @@ module Nanoc::Toolbox::Filters
   # using the JSMin gem
   # @see http://rubygems.org/gems/jsmin
   # @author Anouar ADLANI <anouar@adlani.com>
-  class JsMinify < Nanoc3::Filter
+  class JsMinify < Nanoc::Filter
     identifier :js_minify
 
     def run(content, args = {})
       JSMin.minify(content)
     end
   end
-end
+end

data/lib/nanoc/toolbox/filters.rb

@@ -2,6 +2,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
+end

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

@@ -0,0 +1,105 @@
+module Nanoc::Toolbox::Helpers
+  # NANOC Helper for giving items extra blog post behavior.
+  #
+  # This module contains features to the default Nanoc::Helpers::Blogging
+  # module, like tagging, slug, etc...
+  # @author Anouar ADLANI
+  module BloggingExtra
+    include Nanoc::Helpers::Blogging
+
+    # Enable blog post behavior on all the items located in the post folder(s)
+    #
+    # @example
+    #   # In your config.yaml
+    #   # post_dirs: [ 'posts' ]
+    #
+    #   # In your Rules file
+    #   preprocess do
+    #     add_post_attributes
+    #   end
+    def add_post_attributes
+      @config[:post_dirs] ||= ['_posts', '_articles']
+      items.each do |item|
+        # check the item's parent directory against the post_dirs
+        if (item[:filename] && @config[:post_dirs].include?(File.dirname(item[:filename]).split('/').last))
+          act_as_post(item)
+        end
+      end
+    end
+
+    # Enable blog post behavior on an item
+    #
+    # @param [Nanoc::Item] item the item that will act as a post
+    # @return [Nanoc::Item] the adapted item
+    #
+    # @example
+    #   items.each do |item|
+    #     act_as_post(item)
+    #   end
+    def act_as_post(item)
+      fname = slug_for(item)
+
+      if fname =~ /^\d+-\d+-\d+-/
+        # get the date from the filename
+        item[:year], item[:month], item[:day] = fname.split("-", 4)[0..2]
+
+        # Set creation date param from the values in the filename
+        item[:created_at] = Time.local(item[:year], item[:month], item[:day])
+
+        # Strip the date from the filename
+        item[:slug] = fname.sub(/^\d+-\d+-\d+-/,'')
+      else
+        item[:created_at] ||= Time.now
+        item[:created_at] = attribute_to_time(item[:created_at])
+
+        # get the date from
+        item[:year]  = item[:created_at].year
+        item[:month] = item[:created_at].month
+        item[:day]   = item[:created_at].day
+      end
+
+      # Add additional meta data
+      item[:kind] = 'article'
+
+      # Enable comments unless specifically turned off
+      item[:comments] = true unless item[:comments] === false
+      item
+    end
+
+    # Get an item's slug if it has one, or use its filename sans extension
+    #
+    # @param [Nanoc::Item] item the item that will act as a post
+    # @return [String] either the slug specified in the item or generate one
+    #
+    # @example
+    #   # item[:filename] = "abc def geh.html"
+    #   slug_for(item) # => "abc-def-geh"
+    def slug_for(item)
+      return item[:slug] if item[:slug]
+
+      item[:slug] = File.basename(item[:filename], File.extname(item[:filename]))
+      item[:slug].gsub!(/\s+/, '-')
+      item[:slug]
+    end
+
+    # Returns n number of recent posts, optionally omits the current one
+    #
+    # @param [Integer] count the number of item to return
+    # @param [Nanoc::Item] current_item the current item to exclude from the list
+    #
+    # #return [Array<Nanoc::Item>] an array of recent items
+    def recent_posts(count=5, current_item=nil)
+      (sorted_articles - [current_item])[0, count]
+    end
+
+    # Retreive the list of existing articles grouped by years and months
+    #
+    # @return [Hash] Items grouped in a hash
+    # @example
+    #   posts_by_date # => { 2011 => { 12 => [item0, item1], 3 => [item0, item2]}, 2010 => {12 => [...]}}
+    def posts_by_date
+      Hash[sorted_articles.group_by{|item| item[:year]}.map{ |y, items|
+        [y, items.group_by{|i| i[:month]}]}]
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'nanoc/toolbox/helpers/blogging_extra'
+
+module Nanoc::Toolbox::Helpers
+
+  # NANOC Helper for Disqus comments
+  #
+  # This module contains functions for ...
+  #
+  # @see http://disqus.com/
+  module Disqus
+    include Nanoc::Toolbox::Helpers::HtmlTag
+    include Nanoc::Toolbox::Helpers::BloggingExtra
+
+    # Creates an id out of the page slug that disqus uses for an id
+    def disqus_id_for(item, options={})
+      id = ''
+      id += options[:disqus_id_prefix] if options[:disqus_id_prefix]
+      id += slug_for(item)
+      id.gsub(/-/, '_')
+    end
+
+    # @see http://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables
+    def disqus_js_snippet(variables={})
+      configuration_variables = ""
+
+      variables.each do |k, v|
+        configuration_variables += "var disqus_#{k} = '#{v}';\n" unless v.nil?
+      end
+
+      js_string = <<-EOS
+        #{configuration_variables}
+        (function() {
+            var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+            dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+            (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+        })();
+      EOS
+
+      content_tag('script', js_string, { :type => 'text/javascript' })
+    end
+
+    def disqus_nojs_snippet(message=nil)
+      message ||= "Please enable JavaScript to view the <a href=\"http://disqus.com/?ref_noscript\">comments powered by Disqus.</a>"
+      content_tag('noscript', message)
+    end
+  end
+end

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

@@ -12,10 +12,13 @@ module Nanoc::Toolbox::Helpers
   module GoogleAnalytics
     include Nanoc::Toolbox::Helpers::HtmlTag
     
+    # Return the javascript code snipet to use in your layout or views
+    #
+    # @param [String] ga_tracking_code the Google Analytics Tracking Code
+    # @return [String] the script tag to place in your layout
     def ga_tracking_snippet(ga_tracking_code=nil)
-      ga_tracking_code ||= @site.config[:ga_tracking_code]
+      ga_tracking_code ||= @config[:ga_tracking_code] || "UA-xxxxxx-x"
       js = <<-EOS
-        
         var _gaq = _gaq || [];
         _gaq.push(['_setAccount', '#{ga_tracking_code}']);
         _gaq.push(['_trackPageview']);
@@ -23,11 +26,10 @@ module Nanoc::Toolbox::Helpers
         (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);
+          var s  = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
         })();
-        
       EOS
       content_tag('script', js, { :type => 'text/javascript' })
     end
   end
-end
+end

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

@@ -27,8 +27,8 @@ module Nanoc::Toolbox::Helpers
     SIZE = 1..512
 
     # Available options that could be configure
-    HELPER_OPTION = [:ext, :secure]
-    GRAVATAR_OPTIONS = [:default_icon, :size, :rating]
+    HELPER_OPTION     = [:ext, :secure]
+    GRAVATAR_OPTIONS  = [:default_icon, :size, :rating]
     AVAILABLE_OPTIONS = HELPER_OPTION + GRAVATAR_OPTIONS
 
     # Default values set to the options

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

@@ -8,15 +8,15 @@ module Nanoc::Toolbox::Helpers
   module HtmlTag
     # Simple tag
     #
-    # @example
-    #   tag("br")
-    #    # => <br />
-    #
-    #   tag("hr", class => "thin", true)
-    #    # => <br class="thin">
+    # @param [String] name the tag name
+    # @param [Hash] options options to set to the html element
+    # @param [Boolean] open flag to set if the tag is self closing or not
+    # @return [String] the requested tag string
     #
-    #   tag("input", :type => 'text')
-    #    # => <input type="text" />
+    # @example
+    #   tag("br") # => <br />
+    #   tag("hr", class => "thin", true) # => <br class="thin">
+    #   tag("input", :type => 'text') # => <input type="text" />
     #
     def tag(name, options={}, open=false)
       "<#{name}#{tag_options(options) if options}#{open ? ">" : " />"}"
@@ -24,6 +24,11 @@ module Nanoc::Toolbox::Helpers
 
     # Content tag
     #
+    # @param [String] name the tag name
+    # @param [Hash] options options to set to the html element
+    # @param [Boolean] open flag to set if the tag is self closing or not
+    # @return [String] the requested tag string
+    #
     # @example
     #   content_tag(:p, "Hello world!")
     #    # => <p>Hello world!</p>