pandoc-include-filter 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00a9df949ac69ee1ccf0089e5d30964698f3407c
+  data.tar.gz: ca55267b55d4354dfb29aa4362d74178c7c2bcb9
+SHA512:
+  metadata.gz: 54605ad487ddf94c56844e106ee9f36202322d4fd87bf62a91ad3617726fe54a3de097ac7a44eed55ab2e8f65a553699d278fbec77ce944e646d1a2fabc491f5
+  data.tar.gz: 1ab850a36c01038eddf2a9be7a726de76723a6d74fc25ed7d2d92eb9e65e82dc855b7379c708b52cc4e5fcb49237056f6bc66209ecd9e682fd167b6ad48f89e4

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg/

data/.rspec

@@ -0,0 +1,7 @@
+-I lib
+--backtrace
+--color
+--format documentation
+--order rand
+--require spec_helper
+--tty

data/.rubocop.yml

@@ -0,0 +1,177 @@
+AllCops:
+  TargetRubyVersion: 2.4.2
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/config.ru'
+    - '**/*.rake'
+  Exclude:
+    - vendor/**/*
+    - db/migrations/**/*
+
+  DisplayCopNames:
+    Enabled: true
+
+  DisplayStyleGuide:
+    Enabled: true
+
+Naming/FileName:
+  Exclude:
+  - Guardfile
+  - Vagrantfile
+  - test/Vagrantfile
+  - Dockerfile
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/LineLength:
+  Max: 180
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Performance/Sample:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Layout/AlignParameters:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Layout/MultilineBlockLayout:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/StructInheritance:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4
+script:
+  - bundle exec rake rubocop
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    pandoc-include-filter (0.3.0)
+      paru
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    paru (0.3.0.0)
+    powerpack (0.1.1)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rainbow (2.2.2)
+      rake
+    rake (12.2.1)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  guard
+  guard-bundler
+  guard-rspec
+  pandoc-include-filter!
+  pry
+  pry-byebug
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.15.4

data/Guardfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  watch(%r{^exe/(.+)$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^lib/.+/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+
+  dsl.watch_spec_files_for(dsl.ruby.lib_files)
+end

data/README.markdown

@@ -0,0 +1,15 @@
+# Pandoc `#include` Filter
+
+[![Build Status](https://travis-ci.org/suhlig/pandoc-include-filter.svg?branch=master)](https://travis-ci.org/suhlig/pandoc-include-filter)
+
+This is a [Pandoc](http://pandoc.org/) [filter](http://www.pandoc.org/filters.html) for including files in code blocks.
+
+Look at [spec/fixtures/input.md](spec/fixtures/input.md) for an example input file. Use the filter to include the referenced file with:
+
+```bash
+$ pandoc spec/fixtures/input.md --filter exe/pandoc-include-filter
+```
+
+# References
+
+* [paru docs](https://heerdebeer.org/Software/markdown/paru/#writing-and-using-pandoc-filters-with-paru)

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: ['spec:all']
+
+namespace :spec do
+  desc 'Run all specs'
+  task all: ['rubocop:auto_correct', :unit]
+
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+end

data/exe/pandoc-include-filter

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
+
+require 'optparse'
+require 'paru/filter'
+require 'pandoc/include_filter/version'
+require 'pandoc/include_filter/included_file'
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = <<~BANNER
+      A Pandoc filter that includes files declared with #include filename. See http://www.pandoc.org/filters.html for general filter usage.
+      Usage: pandoc --filter pandoc-include-filter [OPTIONS] [FILES]
+    BANNER
+
+    opts.version = "v.#{Pandoc::IncludeFilter::VERSION}"
+  end.parse!
+rescue OptionParser::InvalidOption => e
+  warn e.message
+  exit 1
+end
+
+Paru::Filter.run do
+  with 'CodeBlock' do |code_block|
+    command, included_file_path, *classes = code_block.string.strip.split(' ')
+
+    if command == '#include'
+      included_file = Pandoc::IncludeFilter::IncludedFile.new(included_file_path).pathname
+
+      if !included_file.exist?
+        warn "Warning: Could not read included file #{included_file_path} \
+        (resolved to absolute path #{included_file}). Keeping literal statement."
+      else
+        code_block.string = included_file.read
+
+        classes.each do |c|
+          code_block.attr.classes.push(c)
+        end
+      end
+    end
+  end
+end

data/lib/pandoc/include_filter/included_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Pandoc
+  module IncludeFilter
+    class IncludedFile
+      def initialize(path)
+        @path = path
+      end
+
+      def pathname
+        Pathname(clean_path(@path)).expand_path
+      end
+
+      private
+
+      def clean_path(raw_path)
+        raw_path.gsub(/\\_/, '_').tap do |path|
+          path.slice!(0) if path.start_with?('"', "'")
+          path.slice!(-1) if path.end_with?('"', "'")
+        end
+      end
+    end
+  end
+end

data/lib/pandoc/include_filter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pandoc
+  module IncludeFilter
+    VERSION = '0.3.0'
+  end
+end

data/pandoc_include_filter.gemspec

@@ -0,0 +1,36 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pandoc/include_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pandoc-include-filter'
+  spec.version       = Pandoc::IncludeFilter::VERSION
+  spec.authors       = ['Steffen Uhlig']
+  spec.email         = ['steffen@familie-uhlig.net']
+
+  spec.summary       = 'Pandoc filter for including files in code blocks'
+  spec.description   = 'A filter for Pandoc that includes other files at compile time.'
+  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_dependency 'paru'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: pandoc-include-filter
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Steffen Uhlig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: guard
+  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: guard-bundler
+  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: guard-rspec
+  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: pry
+  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: pry-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: rake
+  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: rspec
+  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: rubocop
+  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: A filter for Pandoc that includes other files at compile time.
+email:
+- steffen@familie-uhlig.net
+executables:
+- pandoc-include-filter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.markdown
+- Rakefile
+- exe/pandoc-include-filter
+- lib/pandoc/include_filter/included_file.rb
+- lib/pandoc/include_filter/version.rb
+- pandoc_include_filter.gemspec
+homepage: 
+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.14
+signing_key: 
+specification_version: 4
+summary: Pandoc filter for including files in code blocks
+test_files: []