jekyll-gist 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 242bfcd82535771e780626e0048175703253a275
-  data.tar.gz: 18c154d812f86fce780416c6cc95f99f54dffee9
+  metadata.gz: a99d6197be7bf77cd1ce83e1df647719fe1e280c
+  data.tar.gz: 3efd76801e613587054fab6aea4733e8db3f68fd
 SHA512:
-  metadata.gz: 99699f569f1419c98cb332f286f90a4b5453b30c07d6446bafaa26e5fe58c6c9bc1bac16c852e9d36bb7190935bc6a4794e5cab495533f6fdfd36202a4ec5075
-  data.tar.gz: ec10b6433bd686c79ccba4f98f231449cfdcac9bc3c92b2a8686df793ad05e7adc12fc09045619896ef8d9fe9d1d63b2b78008a7bef31192c1b23d843e0c843d
+  metadata.gz: 54b90840b261aae9fd31927bd9d6731caf5485079d478950b8cece2c18667116edc7a959527d6e80086a303db17524f2ba73700b32d61a725e56a355aba29f41
+  data.tar.gz: fe8c68f496c3228083ef3d513e36b813831725493031abd325688df8103df7dcb3f0c0f26bdb027049eae0e86dc1c1ea7b2e16a278cc0d72746bfb3240b5aa27

data/History.markdown

@@ -1,3 +1,7 @@
+## HEAD
+
+  * Added an `noscript` fallback for browsers without JavaScript enabled. (#7)
+
 ## 1.2.1 / 2015-03-22
 
   * Use `has_key?` (#6)

data/jekyll-gist.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "jekyll", "~> 2.0"
 end

data/lib/jekyll-gist/gist_tag.rb

@@ -1,3 +1,6 @@
+require 'cgi'
+require 'open-uri'
+
 module Jekyll
   module Gist
     class GistTag < Liquid::Tag
@@ -11,7 +14,9 @@ module Jekyll
           if context.has_key?(filename)
             filename = context[filename]
           end
-          gist_script_tag(gist_id, filename)
+          noscript_tag = gist_noscript_tag(gist_id, filename)
+          script_tag = gist_script_tag(gist_id, filename)
+          "#{noscript_tag}#{script_tag}"
         else
           raise ArgumentError.new <<-eos
   Syntax error in tag 'gist' while parsing the following markup:
@@ -35,13 +40,33 @@ module Jekyll
       end
 
       def gist_script_tag(gist_id, filename = nil)
-        if filename.empty?
-          "<script src=\"https://gist.github.com/#{gist_id}.js\"> </script>"
+        url = "https://gist.github.com/#{gist_id}.js"
+        url = "#{url}?file=#{filename}" unless filename.empty?
+        "<script src=\"#{url}\"> </script>"
+      end
+
+      def gist_noscript_tag(gist_id, filename = nil)
+        code = fetch_raw_code(gist_id, filename)
+        if !code.nil?
+          "<noscript><pre>#{CGI.escapeHTML(code)}</pre></noscript>"
         else
-          "<script src=\"https://gist.github.com/#{gist_id}.js?file=#{filename}\"> </script>"
+          Jekyll.logger.warn "Warning:", "The <noscript> tag for your gist #{gist_id} could not"
+          Jekyll.logger.warn "", "be generated. This will affect users who do not have"
+          Jekyll.logger.warn "", "JavaScript available or enabled in their browsers."
         end
       end
 
+      def fetch_raw_code(gist_id, filename = nil)
+        begin
+          url = "https://gist.githubusercontent.com/#{gist_id}/raw"
+          url = "#{url}/#{filename}" unless filename.empty?
+          open(url).read.chomp
+        rescue SocketError
+          nil
+        rescue OpenURI::HTTPError
+          nil
+        end
+      end
     end
   end
 end

data/lib/jekyll-gist/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Gist
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

data/spec/gist_tag_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe(Jekyll::Gist::GistTag) do
+  let(:http_output) { "<test>true</test>" }
   let(:doc) { doc_with_content(content) }
   let(:content)  { "{% gist #{gist} %}" }
   let(:output) do
@@ -11,30 +12,43 @@ describe(Jekyll::Gist::GistTag) do
 
   context "valid gist" do
     context "with user prefix" do
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist}/raw").to_return(body: http_output) }
       let(:gist) { "mattr-/24081a1d93d2898ecf0f" }
 
       it "produces the correct script tag" do
         expect(output).to match(/<script src="https:\/\/gist.github.com\/#{gist}.js">\s<\/script>/)
       end
+      it "produces the correct noscript tag" do 
+        expect(output).to match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
     end
 
     context "without user prefix" do
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist}/raw").to_return(body: http_output) }
       let(:gist) { "28949e1d5ee2273f9fd3" }
 
       it "produces the correct script tag" do
         expect(output).to match(/<script src="https:\/\/gist.github.com\/#{gist}.js">\s<\/script>/)
       end
+      it "produces the correct noscript tag" do 
+        expect(output).to match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
     end
 
     context "classic Gist id style" do
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist}/raw").to_return(body: http_output) }
       let(:gist) { "1234321" }
 
       it "produces the correct script tag" do
         expect(output).to match(/<script src="https:\/\/gist.github.com\/#{gist}.js">\s<\/script>/)
       end
+      it "produces the correct noscript tag" do 
+        expect(output).to match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
     end
 
     context "with file specified" do
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist}/raw/#{filename}").to_return(body: http_output) }
       let(:gist)     { "mattr-/24081a1d93d2898ecf0f" }
       let(:filename) { "myfile.ext" }
       let(:content)  { "{% gist #{gist} #{filename} %}" }
@@ -42,12 +56,17 @@ describe(Jekyll::Gist::GistTag) do
       it "produces the correct script tag" do
         expect(output).to match(/<script src="https:\/\/gist.github.com\/#{gist}.js\?file=#{filename}">\s<\/script>/)
       end
+      it "produces the correct noscript tag" do 
+        expect(output).to match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
     end
 
     context "with variable gist id" do
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist_id}/raw").to_return(body: http_output) }
+      let(:gist_id)  { "1342013" }
       let(:gist)     { "page.gist_id" }
       let(:output) do
-        doc.data['gist_id'] = "1342013"
+        doc.data['gist_id'] = gist_id
         doc.content = content
         doc.output  = Jekyll::Renderer.new(doc.site, doc).run
       end
@@ -55,12 +74,18 @@ describe(Jekyll::Gist::GistTag) do
       it "produces the correct script tag" do
         expect(output).to match(/<script src="https:\/\/gist.github.com\/#{doc.data['gist_id']}.js">\s<\/script>/)
       end
+      it "produces the correct noscript tag" do 
+        expect(output).to match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
     end
 
     context "with variable gist id and filename" do
-      let(:gist)     { "page.gist_id" }
-      let(:filename) { "page.gist_filename" }
-      let(:content)  { "{% gist #{gist} #{filename} %}" }
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist_id}/raw/#{gist_filename}").to_return(body: http_output) }
+      let(:gist_id)       { "1342013" }
+      let(:gist_filename) { "atom.xml" }
+      let(:gist)          { "page.gist_id" }
+      let(:filename)      { "page.gist_filename" }
+      let(:content)       { "{% gist #{gist} #{filename} %}" }
       let(:output) do
         doc.data['gist_id'] = "1342013"
         doc.data['gist_filename'] = "atom.xml"
@@ -71,7 +96,28 @@ describe(Jekyll::Gist::GistTag) do
       it "produces the correct script tag" do
         expect(output).to match(/<script src="https:\/\/gist.github.com\/#{doc.data['gist_id']}.js\?file=#{doc.data['gist_filename']}">\s<\/script>/)
       end
+
+      it "produces the correct noscript tag" do 
+        expect(output).to match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
     end
+
+    context "with valid gist id and invalid filename" do 
+      before { stub_request(:get, "https://gist.githubusercontent.com/#{gist_id}/raw/#{gist_filename}").to_return(status: 404) }
+      let(:gist_id)     { "mattr-/24081a1d93d2898ecf0f" }
+      let(:gist_filename) { "myfile.ext" }
+      let(:content)  { "{% gist #{gist_id} #{gist_filename} %}" }
+
+      it "produces the correct script tag" do
+        expect(output).to match(/<script src="https:\/\/gist.github.com\/#{gist_id}.js\?file=#{gist_filename}">\s<\/script>/)
+      end
+
+      it "does not produce the noscript tag" do 
+        expect(output).to_not match(/<noscript><pre>&lt;test&gt;true&lt;\/test&gt;<\/pre><\/noscript>\n/)
+      end
+
+    end
+
   end
 
 

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 TEST_DIR = File.dirname(__FILE__)
 TMP_DIR  = File.expand_path("../tmp", TEST_DIR)
 
+require 'webmock/rspec'
+require 'cgi'
 require 'jekyll'
 require File.expand_path("../lib/jekyll-gist.rb", TEST_DIR)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gist
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Liquid tag for displaying GitHub Gists in Jekyll sites.