nanoc-toolbox 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc-toolbox (0.0.8)
+    nanoc-toolbox (0.1.1)
       jsmin (~> 1.0)
       nanoc (~> 3.4)
       nokogiri (~> 1.4)

data/README.md

@@ -21,6 +21,7 @@ If you feel something's missing, feel free to contribute.
  * **Blogging Extra**: Add extra blog post behavior
  * **Tagging Extra**: Add extra tagging behavior
  * **Disqus**: Disqus comments helper
+ * **Github Gist**: Github Gist helper
 
 ### Filters
 

data/lib/nanoc/toolbox/helpers.rb

@@ -5,6 +5,7 @@ require 'nanoc/toolbox/helpers/disqus'
 require 'nanoc/toolbox/helpers/blogging_extra'
 require 'nanoc/toolbox/helpers/tagging_extra'
 require 'nanoc/toolbox/helpers/google_analytics'
+require 'nanoc/toolbox/helpers/github_gist'
 
 # This module will regroup all the helpers for nanoc
 module Nanoc::Toolbox::Helpers

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

@@ -0,0 +1,40 @@
+module Nanoc::Toolbox::Helpers
+
+  # NANOC Helper for Github Gists
+  #
+  # This module contains helper functions to embed gists to your content
+  #
+  # @see https://gist.github.com/
+  #
+  # @author Anouar ADLANI <anouar@adlani.com>
+  module GithubGist
+    include Nanoc::Toolbox::Helpers::HtmlTag
+
+    # GIST script base URL
+    GIST_HOST = "https://gist.github.com"
+    GIST_EXT  = "js"
+
+    # Generates the script tag for the supplied Gist ID
+    # optionaly displays only the specified file
+    #
+    # @example
+    #   gist(1)
+    #   #=> <script src="https://gist.github.com/1.js"> </script>
+    #   gist(1, "gistfile1.txt")
+    #   #=> <script src="https://gist.github.com/1.js?file=gistfile1.txt"></script>
+    #
+    # @param [Integer] gist_id - the ID of the Gist
+    # @param [String] filename - the optional filename to display
+    def gist(gist_id, filename=nil)
+      raise ArgumentError, "Gist ID should be a Integer" unless gist_id.is_a? Integer 
+      url = "#{GIST_HOST}/#{gist_id}.#{GIST_EXT}"
+
+      if filename
+        raise ArgumentError, "Filename should be a string" unless filename.is_a? String
+        url += "?file=#{filename}"
+      end
+
+      content_tag :script, "", :src => url
+    end
+  end
+end

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

@@ -1,5 +1,3 @@
-require 'nanoc/toolbox/helpers/html_tag'
-
 module Nanoc::Toolbox::Helpers
 
   # NANOC Helper for the Gravatar avatars

data/lib/nanoc/toolbox/version.rb

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

data/spec/helpers/github_gist_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+class GithubGistDummyClass
+  include Nanoc::Toolbox::Helpers::GithubGist
+end
+
+describe Nanoc::Toolbox::Helpers::GithubGist do
+  subject { GithubGistDummyClass.new }
+  it {should respond_to(:gist) }
+
+  describe "#gist" do
+    context "without a filename" do
+      it "takes at list a Gist ID as parameter" do
+        lambda{ subject.gist }.should raise_error(ArgumentError)
+      end
+
+      it "ensures that Gist ID is an Integer" do
+        lambda{ subject.gist('abc') }.should raise_error(ArgumentError)
+        lambda{ subject.gist('123') }.should raise_error(ArgumentError)
+        lambda{ subject.gist(12345) }.should_not raise_error(ArgumentError)
+      end
+
+      it "returns the script tag for a gist" do
+        src = "https://gist.github.com/123.js"
+        subject.gist(123).should eq %Q{<script src="#{src}"></script>}
+      end
+    end
+
+    context "with a filename" do
+      it "ensures that the file name is an String" do
+        lambda{ subject.gist(12345, 12345) }.should raise_error(ArgumentError)
+        lambda{ subject.gist(12345, 'index.html') }.should_not raise_error(ArgumentError)
+      end
+
+      it "returns the script tag for a specific file if specified" do
+        src = "https://gist.github.com/123.js?file=README.md"
+        subject.gist(123, "README.md").should eq %Q{<script src="#{src}"></script>}
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-toolbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
@@ -134,6 +134,7 @@ files:
 - lib/nanoc/toolbox/helpers.rb
 - lib/nanoc/toolbox/helpers/blogging_extra.rb
 - lib/nanoc/toolbox/helpers/disqus.rb
+- lib/nanoc/toolbox/helpers/github_gist.rb
 - lib/nanoc/toolbox/helpers/google_analytics.rb
 - lib/nanoc/toolbox/helpers/gravatar.rb
 - lib/nanoc/toolbox/helpers/html_tag.rb
@@ -147,6 +148,7 @@ files:
 - spec/filters/js_minify_spec.rb
 - spec/helpers/blogging_extra_spec.rb
 - spec/helpers/disqus_spec.rb
+- spec/helpers/github_gist_spec.rb
 - spec/helpers/google_analytics_spec.rb
 - spec/helpers/gravatar_spec.rb
 - spec/helpers/html_tag_spec.rb