jekyll-code-example-tag 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 313440e34ab23b1fc7dbf0f74007afac212cf8d6
-  data.tar.gz: 1000fa7315fecf654b1b691c3675d0a9ee45f915
+  metadata.gz: f78a0b35d2b5412c1ee9037a9d9e00dfd1475544
+  data.tar.gz: f88e066633873bc16b1f2f4302977968c5ff4f95
 SHA512:
-  metadata.gz: 03cfaf2a1f6389da446bbb38a2001242d77199e80ffc15f51a519c49736de856f5d9952d185bfc9b995007daa193f69c958d08230e0ff7f41ab76a646852b087
-  data.tar.gz: db4d25d8a1c4e354e89656d0c0f9658a920794ea1b40fdaab2e29a3e7f3cea19cc3fc7ad5abc80722d53cca7a08e1c1c7dd5e69068d307f623a63c64048ad4d8
+  metadata.gz: 6aa90895e3fc7074828bd7f7ea02261b2c56b812d52d3403402aa1f120707b755359b8612b587b66be08b6f8aba4201fcb40afc8deeffa4fca608e9688e2e393
+  data.tar.gz: 9ce37f352f410ab46dbc01b2cf314a3f05f7f04d69a48630739fdbb948bf82b7a2632df0c97b1183ac06e6b4a0ec6e2192e372252cfe4d713cf45be5ed2dc481

data/.travis.yml

@@ -4,3 +4,6 @@ rvm:
   - 2.1.5
   - 2.2.0
 script: "bundle exec rspec"
+branches:
+  only:
+    -master

data/Gemfile.lock

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

data/README.md

@@ -124,6 +124,43 @@ the resulting markup will include just the Ruby example:
       </div>
     </div>
 
+The *code_example* tag can also support examples organized in sub directories.
+For example, say you would like to organize some of your code examples by
+product and API version:
+
+    .
+    |-code_examples
+      |-productA
+        |-api_v1
+          |-ruby
+            |-widget_maker
+          |-python
+            |-widget_maker
+        |-api_v2
+          |-ruby
+            |-widget_maker
+          |-python
+            |-widget_maker
+      |-productB
+        |-api_v1
+          |-ruby
+            |-authenticating
+          |-python
+            |-authenticating
+      |-ruby
+        |-hello_world
+      |-python
+        |-hello_world
+
+With the above directory structure, including any of the following calls to
+code_example will result in including only the relevant code examples from
+the referred to directory:
+
+    {% code_example productA/api_v1/widget_maker %}
+    {% code_example productA/api_v2/widget_maker %}
+    {% code_example productB/api_v1/authenticating %}
+    {% code_example hello_world %}
+
 ### all_page_code_examples
 
 If you have included a few code examples on a page via the *code_example* tag,

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.4'
+  s.version     = '0.0.5'
   s.date        = '2015-02-03'
   s.authors     = ['GovDelivery']
   s.email       = 'support@govdelivery.com'

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

@@ -6,9 +6,9 @@ module Jekyll
     end
 
     # Returns a hash of available code examples (per language) for the provided example name
-    def self.code_examples(example_name, site)
+    def self.code_examples(context_path, example_name, site)
       # Collect all relevant files
-      examples_root = code_example_dir(site)
+      examples_root = File.join(code_example_dir(site), context_path)
 
       code_folders = Dir.entries(examples_root).select do |entry|
         File.directory? File.join(examples_root, entry) and !(entry =='.' || entry == '..')
@@ -55,15 +55,29 @@ EOF
       "<div class='code-examples'>#{content}</div>"
     end
 
+    def self.get_example_name_and_context(example_string)
+      example_string.strip! 
+      if example_string.include?('/')
+        example_arr = example_string.split('/')
+        example_name = example_arr.delete_at(-1)
+        context_path = example_arr.join(File::SEPARATOR) + File::SEPARATOR 
+      else
+        context_path = ''
+        example_name = example_string
+      end
+
+      return context_path, example_name
+    end
+
     class CodeExampleTag < Liquid::Tag
-      def initialize(tag_name, example_name, tokens)
-          @example_name = example_name.strip
-          super
+      def initialize(tag_name, example_string, tokens)
+        @context_path, @example_name = Jekyll::CodeExampleTags::get_example_name_and_context(example_string) 
+        super
       end
 
       def render(context)
 
-        examples = Jekyll::CodeExampleTags::code_examples(@example_name, context['site'])
+        examples = Jekyll::CodeExampleTags::code_examples(@context_path, @example_name, context['site'])
 
         # Build the code example elements
         output = Jekyll::CodeExampleTags::buttons_markup(examples)
@@ -80,7 +94,8 @@ EOF
       def render(context)
         examples = {}
         context['page']['content'].scan(/\{%\s*code_example (\S+)\s*%\}/) do |name|
-          more_examples = Jekyll::CodeExampleTags::code_examples(name[0], context['site'])
+          context_path, example_name = Jekyll::CodeExampleTags::get_example_name_and_context(name[0])
+          more_examples = Jekyll::CodeExampleTags::code_examples(context_path, example_name, context['site'])
           examples.merge!(more_examples){|key, pre_example, new_example| "#{pre_example}\n#{new_example}"}
         end
 

data/spec/code_example_spec.rb

@@ -1,33 +1,63 @@
 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
+  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"'
+  python_example = o_obj.xpath('/div[@class="code-examples"]/div[@class="highlight example python"]/pre/code[@class="language python"][@data-lang="python"]')
+  expect(python_example).not_to be_empty
+  expect(python_example.first.content).to eq 'print "Hello World"'
+end
+
 describe 'code_example', fakefs: true do
 
   let(:page) { "{% code_example hello_world %}" }
 
   before(:all) do
     FakeFS.activate!
+  end
+
+  after(:all) do
+    FakeFS.deactivate!
+  end
 
+  it 'can be used' 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' => {}})
+    o_obj = Nokogiri::XML.parse(o)
+    check_code_example_conditions(o_obj)
   end
 
-  after(:all) do
-    FakeFS.deactivate!
+  it 'can be configured via "code_example_dir"' do
+    FileUtils.mkdir_p('examples/ruby')
+    FileUtils.mkdir_p('examples/python')
+    File.open('examples/ruby/hello_world', 'w') { |f| f << 'puts "Hello World"'}
+    File.open('examples/python/hello_world', 'w') { |f| f << 'print "Hello World"'}  
+
+    t = Liquid::Template.parse(page)
+    o = t.render!({'site' => {'code_example_dir' => 'examples'}})
+    o_obj = Nokogiri::XML.parse(o)
+    check_code_example_conditions(o_obj)
   end
 
-  it 'can be used' do
+  it 'allows for dividing examples via context' do
+    FileUtils.mkdir_p('code_examples/v1/ruby')
+    FileUtils.mkdir_p('code_examples/v1/python')
+    File.open('code_examples/v1/ruby/hello_world', 'w') { |f| f << 'puts "Hello World"'}
+    File.open('code_examples/v1/python/hello_world', 'w') { |f| f << 'print "Hello World"'}  
+
+    page = "{% code_example v1/hello_world %}"
+
     t = Liquid::Template.parse(page)
     o = t.render!({'site' => {}})
     o_obj = Nokogiri::XML.parse(o)
-    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
-    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"'
-    python_example = o_obj.xpath('/div[@class="code-examples"]/div[@class="highlight example python"]/pre/code[@class="language python"][@data-lang="python"]')
-    expect(python_example).not_to be_empty
-    expect(python_example.first.content).to eq 'print "Hello World"'
+    check_code_example_conditions(o_obj)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-code-example-tag
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - GovDelivery