jekyll-include_snippet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00f11048d745f88a45a271aeb681ee50e15ccfc6
+  data.tar.gz: 9045192b86846e6e30a556cf3b854acd6a8bf060
+SHA512:
+  metadata.gz: 55f1afa12468169590277215842aa22e9ac7c7119bee84371e45ee318c7df82b3d03b72923a704b98b57f22d493c571b5c0b4f463837a6a3528d47a5442f6ac1
+  data.tar.gz: 47022efa04a82c1e5ef482acb5ca6d54b5da59e339ba94e8ce57ad42d6a63238bed4eb6aaff230481decff2824540b4f0cc7a276cf9be8037eec672b33136046

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tom Dalling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Jekyll::IncludeSnippet
+
+Include snippets of text from external files into your markdown
+
+## Installation
+
+Add it to your `Gemfile`:
+
+    source 'https://rubygems.org'
+
+    gem 'jekyll-include_snippet', github: 'tomdalling/jekyll-include_snippet'
+
+## Usage
+
+Put the special "begin-snippet" and "end-snippet" comments into your source file:
+
+    # blah.rb
+
+    class Blah
+      # begin-snippet: my_method_snippet
+      def blah
+        puts 'blah blah blah'
+      end
+      # end-snippet
+    end
+
+Use it from your markdown:
+
+    Blah blah here is some code:
+
+    ```ruby
+    {% include_snippet my_method_snippet from path/to/blah.rb %}
+    ```
+
+Alternatively, you can set a default source path in the YAML frontmatter:
+
+    ---
+    title: "My Blerg Post"
+    date: "2018-01-01"
+    snippet_source: "path/to/blah.rb"
+    ---
+
+    ```ruby
+    {% include_snippet my_method_snippet %}
+    ```
+
+And the text from `blah.rb` will be included into your post (and processed as markdown).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/jekyll-include-snippet.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/include_snippet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-include_snippet"
+  spec.version       = Jekyll::IncludeSnippet::VERSION
+  spec.authors       = ["Tom Dalling"]
+  spec.email         = ["tom@tomdalling.com"]
+
+  spec.summary       = %q{Include snippets of text from external files into your markdown}
+  spec.homepage      = "https://github.com/tomdalling/jekyll-include_snippet"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'liquid', '>= 3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "gem-release"
+end

data/lib/jekyll/include_snippet.rb

@@ -0,0 +1,11 @@
+require 'liquid'
+
+module Jekyll
+  module IncludeSnippet
+  end
+end
+
+%w(version extractor liquid_tag).each do |file|
+  require "jekyll/include_snippet/#{file}"
+end
+

data/lib/jekyll/include_snippet/extractor.rb

@@ -0,0 +1,61 @@
+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
+
+      END_REGEX = %r{
+        \s*\#\s*        # Line must start with a hash (surrounding whitespace optional)
+        end-snippet    # Magic string for ending a snippet
+      }x
+
+      def call(source)
+        everything = Snippet.new(name: 'everything', indent: 0)
+        all_snippets = []
+        active_snippets = []
+
+        source.each_line do |line|
+          case line
+          when BEGIN_REGEX
+            active_snippets << Snippet.new(name: $2.strip, indent: $1.length)
+          when END_REGEX
+            all_snippets << active_snippets.pop
+          else
+            (active_snippets + [everything]).each do |snippet|
+              snippet.lines << line
+            end
+          end
+        end
+
+        (all_snippets + [everything])
+          .map { |s| [s.name, s.dedented_text] }
+          .to_h
+      end
+
+      private
+
+      def hash_from_snippets(snippets)
+      end
+
+      class Snippet
+        attr_reader :name, :indent, :lines
+
+        def initialize(name:, indent:)
+          @name = name
+          @indent = indent
+          @lines = []
+        end
+
+        def dedented_text
+          lines
+            .map { |l| l[indent..-1] }
+            .join
+            .rstrip
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/include_snippet/liquid_tag.rb

@@ -0,0 +1,36 @@
+module Jekyll
+  module IncludeSnippet
+    class LiquidTag < Liquid::Tag
+      def initialize(tag_name, arg_str, tokens)
+        super
+        @snippet_name, @source_path = arg_str.split('from').map(&:strip)
+      end
+
+      def render(context)
+        source_path = source_path_for(context)
+        source = File.read(source_path)
+        extractor = Extractor.new
+        snippets = extractor.(source)
+        snippets.fetch(@snippet_name) do
+          fail "Snippet not found: #{@snippet_name.inspect}\n    in file: #{@source_path}"
+        end
+      end
+
+      private
+
+      def source_path_for(context)
+        page = context['page']
+        frontmatter_default_source = page && page['snippet_source']
+        result = frontmatter_default_source || @source_path
+
+        if result.nil?
+          fail "No source path provided for snippet: #{@snippet_name}"
+        end
+
+        result
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('include_snippet', Jekyll::IncludeSnippet::LiquidTag)

data/lib/jekyll/include_snippet/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module IncludeSnippet
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-include_snippet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: gem-release
+  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'
+description: 
+email:
+- tom@tomdalling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- jekyll-include-snippet.gemspec
+- lib/jekyll/include_snippet.rb
+- lib/jekyll/include_snippet/extractor.rb
+- lib/jekyll/include_snippet/liquid_tag.rb
+- lib/jekyll/include_snippet/version.rb
+homepage: https://github.com/tomdalling/jekyll-include_snippet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Include snippets of text from external files into your markdown
+test_files: []