jekyll-include_snippet 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 305febb9feb26637e9e49f2df6dfa0aef8b8adb0
-  data.tar.gz: 53c2dd21fc0c293242d3f7d217a9f2671e41fa9f
+SHA256:
+  metadata.gz: fc96c6c7044170c2e858747e776b28f800b03c60f03d2e729853904cf784963d
+  data.tar.gz: 6203cdb73dfb12262c8886f2b516aa88446037b2a53a41c6aa618e618356775b
 SHA512:
-  metadata.gz: b662ca4f9c5cee068093faab4298730aaa57fd048fb48e42f826c561cb2734fcb1191f0cfd10784d25fbc40fc5fc45aa09cc31edf2f9f37fba15d35a1a4e2e1f
-  data.tar.gz: 83a44f87ccb7c0fa174ee82e771ba1891111e012ae5e4ba11a4c1706696e107ea9992b734909f6e0dd04d573baa53a155860a8f7ccf780011a9db5ea8b1acf94
+  metadata.gz: eb15ef38f0bb497d0420d2d81722de82a1426b3cd4d19a1a7ff64c86402b461a7146862348afe8402451c3553034cb697484b9ac9a0de9a2a3f582e50c4900e6
+  data.tar.gz: 6a7aa922d917cb5c03d45ef92cdde145fd0709d640435327df6da5ce3870eccc99fb9c7653b63129607cb3392294cbbe54fc63ffaa2b894363cee20c84e16f5e

data/README.md

@@ -51,6 +51,30 @@ Optionally, you can set a default source path in the YAML frontmatter:
     {% include_snippet my_method_snippet %}
     ```
 
+## Languages Other Than Ruby
+
+If you're using another language, you will probably need to change the "comment prefix".
+
+  ---
+  title: "My Blerg Post"
+  date: "2018-01-01"
+  snippet_comment_prefix: "//"
+  ---
+
+  ```js
+  {% include_snippet whatever from whatever.js %}
+  ```
+
+```js
+// whatever.js
+
+// begin-snippet: whatever
+function whatever() {
+  console.log("Hello there");
+}
+// end-snippet
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/jekyll/include_snippet/extractor.rb

@@ -1,16 +1,11 @@
 module Jekyll
   module IncludeSnippet
     class Extractor
-      BEGIN_REGEX = %r{
-        (\s*)\#\s*      # Line must start with a hash (surrounding whitespace optional)
-        begin-snippet:  # Magic string for beginning a snippet
-        (.+)            # The remainder of the line is the snippet name
-      }x
+      attr_reader :comment_prefix
 
-      END_REGEX = %r{
-        \s*\#\s*     # Line must start with a hash (surrounding whitespace optional)
-        end-snippet  # Magic string for ending a snippet
-      }x
+      def initialize(comment_prefix:)
+        @comment_prefix = comment_prefix
+      end
 
       def call(source)
         everything = Snippet.new(name: 'everything', indent: 0)
@@ -19,9 +14,9 @@ module Jekyll
 
         source.each_line.each_with_index do |line, lineno|
           case line
-          when BEGIN_REGEX
+          when begin_regex
             active_snippets << Snippet.new(name: $2.strip, indent: $1.length)
-          when END_REGEX
+          when end_regex
             raise missing_begin_snippet(lineno) if active_snippets.empty?
             all_snippets << active_snippets.pop
           else
@@ -38,6 +33,25 @@ module Jekyll
 
       private
 
+      def begin_regex
+        %r{
+          (\s*)           # optional whitespace (indenting)
+          #{Regexp.quote(comment_prefix)} # the comment prefix
+          \s*             # optional whitespace
+          begin-snippet:  # magic string for beginning a snippet
+          (.+)            # the remainder of the line is the snippet name
+        }x
+      end
+
+      def end_regex
+        %r{
+          \s*          # optional whitespace (indenting)
+          #{Regexp.quote(comment_prefix)} # the comment prefix
+          \s*          # optional whitespace
+          end-snippet  # Magic string for ending a snippet
+        }x
+      end
+
       def missing_begin_snippet(lineno)
         <<~END_ERROR
           There was an `end-snippet` on line #{lineno}, but there doesn't

data/lib/jekyll/include_snippet/liquid_tag.rb

@@ -1,6 +1,8 @@
 module Jekyll
   module IncludeSnippet
     class LiquidTag < Liquid::Tag
+      DEFAULT_COMMENT_PREFIX = '#'
+
       def initialize(tag_name, arg_str, tokens)
         super
         @snippet_name, @source_path = arg_str.split(/\sfrom\s/).map(&:strip)
@@ -9,7 +11,7 @@ module Jekyll
       def render(context)
         source_path = source_path_for(context)
         source = File.read(source_path)
-        extractor = Extractor.new
+        extractor = Extractor.new(comment_prefix: comment_prefix_for(context))
         snippets = extractor.(source)
         snippets.fetch(@snippet_name) do
           fail "Snippet not found: #{@snippet_name.inspect}\n    in file: #{@source_path}"
@@ -19,9 +21,7 @@ module Jekyll
       private
 
       def source_path_for(context)
-        page = context['page']
-        frontmatter_default_source = page && page['snippet_source']
-        result = frontmatter_default_source || @source_path
+        result = get_option(:snippet_source, context) || @source_path
 
         if result.nil?
           fail "No source path provided for snippet: #{@snippet_name}"
@@ -29,6 +29,15 @@ module Jekyll
 
         result
       end
+
+      def comment_prefix_for(context)
+        get_option(:snippet_comment_prefix, context) || DEFAULT_COMMENT_PREFIX
+      end
+
+      def get_option(option_name, context)
+        page = context['page']
+        page && page[option_name.to_s]
+      end
     end
   end
 end

data/lib/jekyll/include_snippet/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module IncludeSnippet
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-include_snippet
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Dalling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2019-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -106,7 +106,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- jekyll-include-snippet.gemspec
+- jekyll-include_snippet.gemspec
 - lib/jekyll/include_snippet.rb
 - lib/jekyll/include_snippet/extractor.rb
 - lib/jekyll/include_snippet/liquid_tag.rb
@@ -130,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Include snippets of text from external files into your markdown