Initial commit

Author: tomdalling

.gitignore

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

.rspec

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

Gemfile

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

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.

README.md

@@ -0,0 +1,15 @@
+# Jekyll::IncludeSnippet
+
+Include snippets of text from external files into your markdown
+
+## Installation
+
+TODO: here
+
+## Usage
+
+TODO: Write usage instructions here
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

jekyll-include-snippet.gemspec

@@ -0,0 +1,27 @@
+# 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         = ["[email protected]"]
+
+  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_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"
+end

lib/jekyll/include_snippet.rb

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

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

lib/jekyll/include_snippet/version.rb

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

spec/extractor_spec.rb

@@ -0,0 +1,69 @@
+RSpec.describe Jekyll::IncludeSnippet::Extractor do
+  subject { extractor.(input) }
+  let(:extractor) { described_class.new }
+
+  context 'a simple snippet' do
+    let(:input) { <<~END_INPUT }
+      This is the first line
+
+      # begin-snippet: wakka
+      This is the wakka snippet.
+      # end-snippet
+
+      Last line.
+    END_INPUT
+
+    its(['wakka']) { is_expected.to eq('This is the wakka snippet.') }
+    its(['everything']) { is_expected.to eq(<<~END_TEXT.strip) }
+      This is the first line
+
+      This is the wakka snippet.
+
+      Last line.
+    END_TEXT
+  end
+
+  context 'nested snippets' do
+    let(:input) { <<~END_INPUT }
+      #begin-snippet: outer
+      This is outer
+      #begin-snippet: inner
+      This is inner
+      #end-snippet
+      #end-snippet
+    END_INPUT
+
+    its(['inner']) { is_expected.to eq('This is inner') }
+    its(['outer']) { is_expected.to eq("This is outer\nThis is inner") }
+  end
+
+  context 'indented snippets' do
+    let(:input) { <<~END_INPUT }
+      First
+        #begin-snippet: indented
+              I
+                  am
+           indented
+                 #end-snippet
+      Last
+    END_INPUT
+
+    its(['indented']) { is_expected.to eq(
+      [
+        "      I",
+        "          am",
+        "   indented"
+      ].join("\n")
+    ) }
+
+    its(['everything']) { is_expected.to eq(
+      [
+        "First",
+        "        I",
+        "            am",
+        "     indented",
+        "Last"
+      ].join("\n")
+    ) }
+  end
+end

spec/jekyll-include_snippet_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Jekyll::IncludeSnippet do
+  it "has a version number" do
+    expect(Jekyll::IncludeSnippet::VERSION.split('.').size).to eq(3)
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "bundler/setup"
+require 'rspec/its'
+require 'byebug'
+require "jekyll/include_snippet"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end