md_inc 0.2.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in md_inc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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,76 @@
+# MdInc
+
+MdInc is a text utility that allows you to suck text from one file into another.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'md_inc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install md_inc
+
+## Usage
+
+MdInc is a simple text inclusion filter intended for use
+with markdown and similar text formatting utilities. 
+MdInc provides simple 'include this other file' kind
+of processing. Using md_inc is straight forwark: Just require
+it in and use the process method:
+
+    require 'md_inc'
+    
+    v = MdInc::TextProcessor.new
+    output = v.process 'The quick brown fox'
+    
+In the simple case like the one above, md_inc simply 
+returns the text unchanged. The interesting bit is
+when your input text includes commands that md_inc
+recognizes. MdInc commands all start with a . in
+the first column of a line. The most basic is
+`.inc`. Here is some input that includes an `.inc` 
+command:
+
+    Here is the first line.
+    Now I'm going to include another file.
+    .inc 'some_other_file.md'
+    And the last line.
+
+Run the file above through md_inc and the output
+will include the contents of `some_other_file.md`
+embedded in it.
+
+You can also pluck out only part of the included
+file based on a pair of regular expressions:
+
+    Here we are going to include only part of file1,
+    just the lines between START and END.
+    .between(/START/, /END/, inc('file1'))
+    Note that the lines matching START and END are
+    not included in the output.
+
+And you can exclude lines based on a regular expression:
+
+    Pull in the contents of file1, skipping any
+    lines that contain DONTWANT
+    .skip(/DONTWANT/, inc('file1'))
+
+As you can probably guess from this last example,
+the MdInc dot commands are really just inline Ruby
+code that gets executed during file processing.
+Because of this it's easy to extend MdInc with
+your own commands. See the specs for an example.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'rake/clean'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec, :build]
+
+CLEAN.include 'pkg'

data/lib/md_inc/md_inc_commands.rb

@@ -0,0 +1,58 @@
+module MdInc
+  module Commands
+    public :instance_eval
+
+    class << self
+      attr_accessor :root
+
+      def full_path(path)
+        @root ? File.join(@root, path) : path
+      end
+
+      def x(*args)
+        []
+      end
+
+      def inc(path)
+        lines = File.readlines(full_path(path))
+        lines.map &:rstrip!
+      end
+
+      def code_inc(path, re1=nil, re2=nil)
+        if re1
+          code(between(re1, re2, inc(path)))
+        else
+          code(inc(path))
+        end
+      end
+
+      def code(lines)
+        lines.map {|l| l.rstrip.prepend('    ')}
+      end
+
+      def between(re1, re2, lines)
+        state = :outside
+        output = []
+        lines.each do |l|
+          if state == :outside && re1 =~ l
+            state = :inside
+          elsif state == :inside && re2 =~ l
+            state = :outside
+          else
+            output << l if state==:inside
+          end
+        end
+        STDERR.puts "Warning: no output from included file" if output.empty?
+        output
+      end
+
+      def skip(re, lines)
+        output = []
+        lines.each do |l|
+          output << l unless l =~ re
+        end
+        output
+      end
+    end
+  end
+end

data/lib/md_inc/version.rb

@@ -0,0 +1,3 @@
+module MdInc
+  VERSION = "0.2.1"
+end

data/lib/md_inc.rb

@@ -0,0 +1,24 @@
+require 'md_inc/version'
+require 'md_inc/md_inc_commands'
+
+module MdInc
+  class TextProcessor
+    def process(content)
+      output = []
+      content.split("\n").each do |line|
+        if /^\./ =~ line
+          output << process_command(line)
+        else
+          output << line
+        end
+      end
+      out = output.flatten.join("\n")
+      out
+    end
+
+    def process_command(command_line)
+      cmd = command_line[1..-1]
+      Commands.instance_eval(cmd)
+    end
+  end
+end

data/md_inc.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/md_inc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Russ Olsen"]
+  gem.email         = ["russ@russolsen.com"]
+  gem.description   = %q{MdInc is a simple text inclusion utility (it sucks in files) intended for use with markdown and similar utilities.}
+  gem.summary       = %q{A simple text inclusion utility}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "md_inc"
+  gem.require_paths = ["lib"]
+  gem.version       = MdInc::VERSION
+end

data/spec/md_inc_spec.rb

@@ -0,0 +1,65 @@
+require 'md_inc'
+require 'fileutils'
+
+describe MdInc::TextProcessor do
+  let(:mdi) { MdInc::TextProcessor.new }
+
+  context 'basic processing' do
+    it 'copies input to output by default' do
+      text = "aaa\nbbb\nccc"
+      mdi.process(text).should == text
+    end
+
+    it 'handles empty input' do
+      text = ''
+      mdi.process(text).should == text
+    end
+
+    it 'can require in plain old ruby files' do
+      text = '.x require "set"'
+      mdi.process(text).should == ''
+    end
+  end
+
+  context 'commands' do
+    before :each do
+      File.open("temp1",'w') {|f| f.puts("aaa\nbbb\n")}
+
+      File.open("temp2",'w') do |f|
+        1.upto(10) {|n| f.puts "line #{n}" }
+      end
+    end
+
+    after :each do
+      FileUtils.rm_f("temp1")
+      FileUtils.rm_f("temp2")
+    end
+
+    it 'can pull in the contents of another file with inc' do
+      text = "first\n.inc 'temp1'\nlast"
+      output = mdi.process(text)
+      output.should == "first\naaa\nbbb\nlast"
+    end
+
+    it 'can do include just the lines between two matching lines' do
+      text = "first\n.between(/line 4/, /line 7/, inc('temp2') )\nlast"
+      output = mdi.process(text)
+      output.should == "first\nline 5\nline 6\nlast"
+    end
+
+    it 'can skip lines matching a regular expression' do
+      text = "first\n.skip(/1|2/, inc('temp2'))\nlast"
+      output = mdi.process(text)
+      output.should_not match("line 1")
+      output.should_not match("line 2")
+      output.should match("line 3")
+      output.should match("line 4")
+    end
+
+    it 'can allows for new commands to be added' do
+      text = ".x require 'new_commands'\nfirst\n.inc_up 'temp1'\nlast"
+      output = mdi.process(text)
+      output.should == "first\nAAA\nBBB\nlast"
+    end
+  end
+end

data/spec/new_commands.rb

@@ -0,0 +1,11 @@
+# This is an example of what you need to do to
+# Add a new command to MdInc: Just add a new
+# module level method to the Vacuum::Commands
+# module and off you go.
+module MdInc
+  module Commands
+    def self.inc_up(path)
+      inc(path).map {|s| s.upcase!}
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: md_inc
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Russ Olsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000Z
+dependencies: []
+description: MdInc is a simple text inclusion utility (it sucks in files) intended
+  for use with markdown and similar utilities.
+email:
+- russ@russolsen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/md_inc.rb
+- lib/md_inc/md_inc_commands.rb
+- lib/md_inc/version.rb
+- md_inc.gemspec
+- spec/md_inc_spec.rb
+- spec/new_commands.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple text inclusion utility
+test_files:
+- spec/md_inc_spec.rb
+- spec/new_commands.rb