jekyll-code-example-tag 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f78a0b35d2b5412c1ee9037a9d9e00dfd1475544
-  data.tar.gz: f88e066633873bc16b1f2f4302977968c5ff4f95
+  metadata.gz: 445ae1847daf8f0cf13a31c1e42f271db93c35f7
+  data.tar.gz: 19112d1ad9e6f7dde6050e70c4b3f6f218eff2d5
 SHA512:
-  metadata.gz: 6aa90895e3fc7074828bd7f7ea02261b2c56b812d52d3403402aa1f120707b755359b8612b587b66be08b6f8aba4201fcb40afc8deeffa4fca608e9688e2e393
-  data.tar.gz: 9ce37f352f410ab46dbc01b2cf314a3f05f7f04d69a48630739fdbb948bf82b7a2632df0c97b1183ac06e6b4a0ec6e2192e372252cfe4d713cf45be5ed2dc481
+  metadata.gz: 33c5c0e3de929fe09bb757ca32845b8bd74f79ab8f610cede0640ec42dd6ad1712bbe7ab13d4d9a3ad1007e09703c8922c5ffbe0e56776572c55f2cc4ce83fc7
+  data.tar.gz: cb04d87c67fad9f267df293bb4e9e4751ed2da5a0494e7c8e7e9d2dfa51d5816ac3c2fc861f867db3043d34fa2b4520b661ec9c97ba84fbc6d6c3e7fe987c758

data/CHANGELOG

@@ -0,0 +1,12 @@
+CHANGELOG
+==========
+
+This project does *not* adhere to Semantic Versioning
+
+## 0.0.6 - 2015-03-16
+
+### Added
+
+- CSS classes applied to buttons and button container elements can now be
+	configured via _config.yml. Supporting JavaScript also uses classes set in
+	_config.yml. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-code-example-tag (0.0.5)
+    jekyll-code-example-tag (0.0.6)
       jekyll
 
 GEM

data/README.md

@@ -32,6 +32,20 @@ file in the `/js/` directory of your Jekyll project.
 
 ## Usage
 
+### Configure CSS Classes
+
+Via your site's _config.yml, you can define what CSS class or classes the 
+example buttons and button containers will have. For example:
+
+    code_example_buttons_class: 'the_buttons'
+    code_example_button_class: 'a_button'
+
+will cause each button to have the class `a_button`, and buttons will be inside
+a div with the class `the_buttons`. 
+
+`code_example_buttons_class` defaults to 'buttons', and 
+`code_example_button_class` defaults to 'button'.
+
 ### code_example
 
 First, select a folder to place your code examples in. By default, the top

data/jekyll-code-example-tag.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'jekyll-code-example-tag'
-  s.version     = '0.0.5'
+  s.version     = '0.0.6'
   s.date        = '2015-02-03'
   s.authors     = ['GovDelivery']
   s.email       = 'support@govdelivery.com'

data/lib/jekyll-code-example-tag.rb

@@ -1,3 +1,5 @@
+require_relative 'js/jekyll-code-example-buttons.js.rb'
+
 module Jekyll
   module CodeExampleTags
 
@@ -28,13 +30,16 @@ module Jekyll
       examples
     end
 
-    def self.buttons_markup(examples)
+    def self.buttons_markup(examples, context)
+      site = context['site']
+      buttons_class = site['code_example_buttons_class'] ? site['code_example_buttons_class'] : 'buttons'
+      button_class = site['code_example_button_class'] ? site['code_example_button_class'] : 'button'
       menu_items = ""
       examples.each_key do |lang|
-        menu_items << "<li><a href='#' class='button' target='#{lang}'>#{lang.capitalize}</a></li>"
+        menu_items << "<li><a href='#' class='#{button_class}' target='#{lang}'>#{lang.capitalize}</a></li>"
       end
       <<EOF
-            <div class="buttons examples">
+            <div class="#{buttons_class} examples">
               <ul>
                 #{menu_items}
               </ul>
@@ -80,7 +85,7 @@ EOF
         examples = Jekyll::CodeExampleTags::code_examples(@context_path, @example_name, context['site'])
 
         # Build the code example elements
-        output = Jekyll::CodeExampleTags::buttons_markup(examples)
+        output = Jekyll::CodeExampleTags::buttons_markup(examples, context)
         examples.each do |lang, path|
           example_content = File.read(path)
           output << Jekyll::CodeExampleTags::example_markup(lang, example_content)
@@ -100,7 +105,7 @@ EOF
         end
 
         # Build the code example elements
-        output = Jekyll::CodeExampleTags::buttons_markup(examples)
+        output = Jekyll::CodeExampleTags::buttons_markup(examples, context)
         examples.each do |lang, paths|
           example_content = ""
           for path in paths.split("\n")
@@ -116,15 +121,10 @@ EOF
     class CodeExamplesJsFile < Jekyll::StaticFile
       def write(dest)
 
-        if File.file?(File.join(FileUtils.pwd, @dir, @name))
-          in_path = File.join(FileUtils.pwd, @dir, @name)
-        else
-          in_path = File.join(File.dirname(__FILE__), @dir, @name)
-        end
         dest_path = File.join(dest, @dir, @name)
 
         FileUtils.mkdir_p(File.dirname(dest_path))
-        content = File.read(in_path)
+        content = code_example_buttons_js(@site)
         File.open(dest_path, 'w') do |f|
           f.write(content)
         end

data/lib/js/jekyll-code-example-buttons.js.rb

@@ -0,0 +1,24 @@
+def code_example_buttons_js(site) 
+  buttons_class = site.config['code_example_buttons_class'] ? site.config['code_example_buttons_class'] : 'buttons' 
+  button_class = site.config['code_example_button_class'] ? site.config['code_example_button_class'] : 'button' 
+
+  <<EOF
+"use strict";
+
+jQuery(function(){
+  jQuery('.#{buttons_class}.examples .#{button_class}').click(function(e){
+        e.preventDefault();
+        var parent = jQuery(this).closest('body');
+        var target = jQuery(this).attr('target');
+
+        parent.find('.example').hide();
+        parent.find('.example.'+target).show();
+        parent.find('.#{buttons_class}.examples .#{button_class}.active').removeClass('active');
+        parent.find('.#{buttons_class}.examples .#{button_class}[target="'+target+'"]').addClass('active');
+  });
+
+
+  jQuery('.#{buttons_class}.examples li:first-child .#{button_class}').click();
+});
+EOF
+end

data/spec/code_example_spec.rb

@@ -1,8 +1,8 @@
 require_relative './spec_helper.rb'
 
-def check_code_example_conditions(o_obj)
-  expect(o_obj.xpath('/div[@class="code-examples"]/div[@class="buttons examples"]/ul/li/a[@class="button"][@target="ruby"][.="Ruby"]')).not_to be_empty
-  expect(o_obj.xpath('/div[@class="code-examples"]/div[@class="buttons examples"]/ul/li/a[@class="button"][@target="python"][.="Python"]')).not_to be_empty
+def check_code_example_conditions(o_obj, buttons_class: 'buttons', button_class: 'button')
+  expect(o_obj.xpath('/div[@class="code-examples"]/div[@class="'+buttons_class+' examples"]/ul/li/a[@class="'+button_class+'"][@target="ruby"][.="Ruby"]')).not_to be_empty
+  expect(o_obj.xpath('/div[@class="code-examples"]/div[@class="'+buttons_class+' examples"]/ul/li/a[@class="'+button_class+'"][@target="python"][.="Python"]')).not_to be_empty
   ruby_example = o_obj.xpath('/div[@class="code-examples"]/div[@class="highlight example ruby"]/pre/code[@class="language ruby"][@data-lang="ruby"]')
   expect(ruby_example).not_to be_empty
   expect(ruby_example.first.content).to eq 'puts "Hello World"'
@@ -47,6 +47,31 @@ describe 'code_example', fakefs: true do
     check_code_example_conditions(o_obj)
   end
 
+  it 'can be configured via "code_example_button_class"' do
+    FileUtils.mkdir_p('code_examples/ruby')
+    FileUtils.mkdir_p('code_examples/python')
+    File.open('code_examples/ruby/hello_world', 'w') { |f| f << 'puts "Hello World"'}
+    File.open('code_examples/python/hello_world', 'w') { |f| f << 'print "Hello World"'}  
+
+    t = Liquid::Template.parse(page)
+    o = t.render!({'site' => {'code_example_button_class' => 'button'}})
+    o_obj = Nokogiri::XML.parse(o)
+    check_code_example_conditions(o_obj, button_class: 'button')
+  end
+
+  it 'can be configured via "code_example_buttons_class"' do
+    FileUtils.mkdir_p('code_examples/ruby')
+    FileUtils.mkdir_p('code_examples/python')
+    File.open('code_examples/ruby/hello_world', 'w') { |f| f << 'puts "Hello World"'}
+    File.open('code_examples/python/hello_world', 'w') { |f| f << 'print "Hello World"'}  
+
+    t = Liquid::Template.parse(page)
+    o = t.render!({'site' => {'code_example_buttons_class' => 'button-group'}})
+    o_obj = Nokogiri::XML.parse(o)
+    check_code_example_conditions(o_obj, buttons_class: 'button-group')
+  end
+
+
   it 'allows for dividing examples via context' do
     FileUtils.mkdir_p('code_examples/v1/ruby')
     FileUtils.mkdir_p('code_examples/v1/python')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-code-example-tag
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - GovDelivery
@@ -35,13 +35,14 @@ extra_rdoc_files: []
 files:
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - jekyll-code-example-tag.gemspec
 - lib/jekyll-code-example-tag.rb
-- lib/js/jekyll-code-example-buttons.js
+- lib/js/jekyll-code-example-buttons.js.rb
 - spec/all_page_code_examples_spec.rb
 - spec/code_example_spec.rb
 - spec/spec_helper.rb

data/lib/js/jekyll-code-example-buttons.js

@@ -1,17 +0,0 @@
-"use strict";
-
-jQuery(function(){
-  jQuery('.buttons.examples .button').click(function(e){
-        e.preventDefault();
-        var parent = jQuery(this).closest('body');
-        var target = jQuery(this).attr('target');
-
-        parent.find('.example').hide();
-        parent.find('.example.'+target).show();
-        parent.find('.buttons.examples .button.active').removeClass('active');
-        parent.find('.buttons.examples .button[target="'+target+'"]').addClass('active');
-  });
-
-
-  jQuery('.buttons.examples li:first-child .button').click();
-});