jekyll_github_sample 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbe426f3a4ba56ae33eea0b0d06f3168cc6a1847
-  data.tar.gz: 0cf73c713e0123584116c20c51cac8a0c63b9789
+  metadata.gz: bc04ac952632c2231479dc871d6b2abcfebf96ee
+  data.tar.gz: e71916874ca33eea7bc973099ed2eedd4a610e2f
 SHA512:
-  metadata.gz: 3d6c630ffc6c0ddf6118cec63f96a0e66a93921e9d025250297f29f4aff4d28c6eb3a423667d28abcb01a12f77475dbd062625eeccd382b1b933ea8d568a3a93
-  data.tar.gz: 58df351402012f1550b74c2c65fe88c0781eee8f1b780f5c0bd58d3b2239f9f670b5d9fa80b587935e5a324f7d22a87e31004dd579bb95cadc3e925ad17c946c
+  metadata.gz: 7f53146882fc4603a272b1b93436dc9cfbadfe3ccad3d134a1c532740852f2b3f7c920b09b4c8bb8de84e2fdd134b9174777f9c1939072b5d16b990c4e842834
+  data.tar.gz: 0c02616d019a1a15c321ce6e1d527a8b3585c2e02a569f46d13be85bca93dbc64d3d8d6b496ff238bfa45876d925c5a8dc73b77e7401fbef1b0b5c0a192e383e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll_github_sample (0.2.0)
+    jekyll_github_sample (0.3.0)
       activesupport (~> 4.0)
       jekyll (~> 3.0)
 
@@ -76,4 +76,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.13.6
+   1.13.7

data/README.md

@@ -5,7 +5,7 @@ Two Jekyll Liquid tags to display a code sample from a file in a public Github r
 
 # Install
 
-- First add the gem to your `Gemfile` 
+- First add the gem to your `Gemfile`
 ```
 gem 'jekyll_github_sample'
 ```
@@ -30,6 +30,16 @@ A [write up](https://bwillis.github.io/2014/05/28/include-github-repo-code-in-je
  * START_LINE_NUMBER - (optional) number that is the first line to include (0 based)
  * END_LINE_NUMBER - (optional) number that is the last line to include, if excluded will read to end of file
 
+One can also specify the lines to include based on markings in the file itself.
+This is done by invoking
+
+```
+{% github_sample URL_WITH_USERNAME_REPO_AND_FILE tag:TAG_NAME %}
+```
+
+and placing the strings `[START TAG_NAME]` and `[END TAG_NAME]` anywhere in the lines immediately before and after the content you wish to include.
+
+
 # github_sample_ref Usage
 ```
 {% github_sample_ref URL_WITH_USERNAME_REPO_AND_FILE %}
@@ -53,6 +63,7 @@ This is how you would display, reference and highlight code in your Jekyll post.
 Thanks to all those who have helped make this really awesome:
 
 * [heedfull](https://github.com/heedfull)
+* [robertwb](https://github.com/robertwb)
 
 # License
 Jekyll Github Sample is released under the MIT license: www.opensource.org/licenses/MIT

data/lib/jekyll_github_sample/code_tag.rb

@@ -11,7 +11,6 @@ module JekyllGithubSample
     def initialize(tag_name, params, tokens)
       github_file_path, @line_start, @line_end = params.split
       @github_file                             = FileHelper.new(github_file_path)
-      @line_start, @line_end                   = determine_line_numbers(@line_start, @line_end)
       super
     end
 
@@ -19,7 +18,12 @@ module JekyllGithubSample
       all_lines = cache.fetch(@github_file.raw_uri) do
         open(@github_file.raw_uri).readlines
       end
-      lines     = all_lines[@line_start..@line_end]
+      if @line_start.respond_to?(:match) and tag_match = @line_start.match(/^tag:(.*)/)
+        lines     = extract_tagged_lines(all_lines, tag_match[1])
+      else
+        @line_start, @line_ends     = determine_line_numbers(@line_start, @line_end)
+        lines     = all_lines[@line_start..@line_end]
+      end
       lines     = remove_common_indentation(lines)
       lines.join
     end

data/lib/jekyll_github_sample/text_utils.rb

@@ -18,5 +18,24 @@ module JekyllGithubSample
         line.length == 1 ? line : line[leading_spaces.min..-1]
       end
     end
+
+    def extract_tagged_lines(lines, tag)
+      start_tag = "[START #{tag}]"
+      end_tag = "[END #{tag}]"
+      tagged_lines = []
+      in_tagged_content = false
+      lines.each do |line|
+        if in_tagged_content
+          if line.include? end_tag
+            in_tagged_content = false
+          else
+            tagged_lines << line
+          end
+        else
+          in_tagged_content = line.include? start_tag
+        end
+      end
+      tagged_lines
+    end
   end
 end

data/lib/jekyll_github_sample/version.rb

@@ -1,3 +1,3 @@
 module JekyllGithubSample
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/lib/jekyll_github_sample/text_utils_spec.rb

@@ -33,4 +33,24 @@ describe JekyllGithubSample::TextUtils do
     end
   end
 
-end
+  context '#extract_tagged_lines' do
+    let(:lines) { [
+        'header',
+        '[START tag]',
+        'content 1',
+        'content 2',
+        '[END tag]',
+        'footer 1',
+        'footer 2'
+    ] }
+    subject { text_utils.extract_tagged_lines(lines, 'tag') }
+
+    it 'extracts content' do
+      should =~ [
+        'content 1',
+        'content 2'
+      ]
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_github_sample
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Willis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-13 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Include a sample of a Github repo file.