snippeteer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 762100a898939f8f15917f878a8d74808b014e72
+  data.tar.gz: 4d5724e1217213c8785f24651056c5059c529233
+SHA512:
+  metadata.gz: f2f1fe5b7d58d13b55c6efe6093d32f76ad9e683de6dfa0831bf682ba2822f3255b38633fb49b692e8c6f9345fa62ab32aa4805a5d611433b859a70db14c8c6c
+  data.tar.gz: e7544e3e86a77d7ded34f91506de0c2da8b504c5ea3e9cfef7afa3cb60f8f660536397e8fe7519c24c45e371630049d8eb8d2d492d080dc1aa8b14e094fd0526

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 feivel jellyfish
+
+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.markdown

@@ -0,0 +1,46 @@
+# snippeteer
+code snippet extractor & runner for Jekyll blog posts. test your examples with almost no effort!
+
+```shell
+$ cat post.markdown
+herp derp blog post
+
+{% highlight c %}
+int herp;
+{% endhighlight %}
+
+{% highlight python %}
+puts('derpity')
+{% endhighlight %}
+
+{% highlight c %}
+double derp = herp;
+{% endhighlight %}
+
+$ snippeteer snip post.markdown
+wrote post.markdown.c
+wrote post.markdown.py
+$ cat post.markdown.c
+int herp;
+double derp = herp;
+```
+
+`snippeteer` also knows how to run code in some languages directly:
+
+```shell
+$ snippeteer run post.markdown
+derpity
+```
+
+## extending
+
+`snippeteer` can be extended to recognize new languages:
+
+```shell
+$ cat snip_ext.rb
+class Snippeteer::Lang
+  register "trendy", ".tr", "runtrendy"
+end
+$ snippeteer --load snip_ext.rb run trendy-lang-takes-hacker-news-by-storm.markdown
+```
+

data/bin/snippeteer

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'snippeteer'
+require 'commander/import'
+
+program :version, Snippeteer::VERSION
+program :description, 'Code snippet extractor for Jekyll posts.'
+
+default_scanners = [Snippeteer::LiquidHighlightScanner]
+
+global_option '--load CONFIGS', Array, "Load CONFIGS before executing." do |configs|
+  configs.each {|cfg| load cfg}
+end
+
+command :snip do |c|
+  c.syntax = 'snippeteer snip [FILES ...]'
+  c.description = 'Extract snippets from files.'
+  c.action do |files, options|
+    files.each do |f|
+      Snippeteer::Writer.new(f, default_scanners).write_sources.values.each do |fn|
+        puts "wrote #{fn}"
+      end
+    end
+  end
+end
+
+command :run do |c|
+  c.syntax = 'snippeteer run [FILES ...]'
+  c.description = 'Run snippets from files'
+  c.option '--noclean', "Don't remove source files after running them."
+  c.action do |files, opts|
+    run, ok = [], true
+    files.each do |f|
+      puts opts.no_clean
+      run += Snippeteer::Writer.new(f, default_scanners).run_sources(!opts.noclean)
+    end
+    run.each do |filename, ran_ok|
+      if not ran_ok
+        $stderr.puts "# warning: execution of #{filename} finished with non-zero exit status"
+        ok = false
+      end
+    end
+    exit 1 if not ok
+  end
+end
+

data/lib/snippeteer.rb

@@ -0,0 +1,147 @@
+module Snippeteer
+  VERSION = '0.1.0'
+  # Container for code tagged with language metadata.
+  class Snippet < Struct.new(:lang, :code); end
+
+  # Filesystem interface for the document reader. Reads files
+  # and writes/runs extracted snippets.
+  class Writer
+    attr_reader :path, :scanners
+
+    # Takes a filename and a list of scanners. Scanners are expected to have
+    # a `scan' method that takes a string and returns a list of Snippets.
+    def initialize(path, scanners)
+      @path, @scanners = path, scanners
+    end
+
+    # Write extracted snippets to files according to their language. Returns
+    # a hash mapping language to filename.
+    def write_sources
+      basename = File.basename path
+      sources.each_with_object({}) do |snip, written|
+        lang, src = snip
+        srcname = basename + lang.ext
+        File.open(srcname, 'w') {|srcfile| srcfile.write src}
+        written[lang] = srcname
+      end
+    end
+
+    # Write extracted snippets, then execute them if an execution command is
+    # given for their language. By default, removes the written files after
+    # execution. Returns a list of filename, exit status pairs.
+    def run_sources(cleanup = true)
+      srcs = write_sources.each_with_object([]) do |written, run|
+        lang, srcfile = written
+        if lang.exec
+          run << [srcfile, system("#{lang.exec} #{srcfile}")]
+          FileUtils.rm srcfile if cleanup
+        end
+      end
+    end
+
+    def sources
+      Reader.new(File.read(@path), @scanners).sources
+    end
+  end
+
+  # Document reader. Extracts and aggregates snippets from data.
+  class Reader
+    attr_reader :data, :scanners
+    def initialize(data, scanners)
+      @data, @scanners = data, scanners
+    end
+
+    def snippets
+      scanners.reduce([]) {|snips, scanner| snips + scanner.scan(data)}
+    end
+
+    def sources
+      snippets.each_with_object({}) do |snip, srcs|
+        srcs[snip.lang] ||= ""
+        srcs[snip.lang] << snip.code
+      end
+    end
+  end
+
+  # Container & registry for language information.
+  class Lang < Struct.new(:ext, :exec)
+    UNKNOWN = new ".txt"
+    @registry = {}
+
+    class << self
+      # Define a new (or redefine an old) language, with
+      # filename extension and optional execution command.
+      def register(name, ext, exec = nil)
+        @registry[name] = new(ext, exec)
+      end
+
+      def find(lang)
+        if found = @registry.keys.find {|m| m == lang}
+          @registry[found]
+        else
+          UNKNOWN
+        end
+      end
+    end
+
+    # here's a super incomplete list of languages
+    register "haskell", ".hs", "runhaskell"
+    register "ruby", ".rb", "ruby"
+    register "python", ".py", "python"
+    register "c", ".c"
+    register "c++", ".c++"
+    register "php", ".php", "php -f"
+    register "perl", ".pl", "perl"
+    register "javascript", ".js"
+    register "coffeescript", ".coffee", "coffee"
+    register "clojure", ".clj", "clojure"
+    register "clojurescript", ".cljs"
+    register "erlang", ".erl"
+    register "lisp", ".lisp", "sbcl --script" # arbitrary + non-portable choice
+    register "shell", ".sh", "sh"
+    register "java", ".java"
+    register "lua", ".lua", "lua"
+    register "scheme", ".scm"
+    register "go", ".go"
+    register "ocaml", ".ml"
+  end
+
+  # A _very_ simple parser for Jekyll pages that tries to extract code from
+  # Liquid highlight tags and partition it by language. Should just work as
+  # long as you don't give it nested highlight blocks or something like that.
+  class LiquidHighlightScanner
+    HIGHLIGHT = /^\s*{%\s*highlight\s+(\w+).*%}\s*$/
+    ENDHIGHLIGHT = /^\s*{%\s*endhighlight\s*%}\s*$/
+
+    def self.scan(doc)
+      new(doc).scan
+    end
+
+    def initialize(doc)
+      @lines = doc.lines.each
+      @snips = []
+    end
+
+    def scan
+      unhighlit
+    rescue StopIteration
+      @snips
+    end
+
+    private
+    def highlit(lang)
+      snip = Snippet.new lang, ""
+      until (l = @lines.next) =~ ENDHIGHLIGHT
+        snip.code += l
+      end
+      @snips << snip
+      unhighlit
+    end
+
+    def unhighlit
+      until (l = @lines.next) =~ HIGHLIGHT; end
+      highlit Lang.find $1
+    end
+  end
+end
+

data/snippeteer.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require 'snippeteer'
+require 'rake'
+
+Gem::Specification.new do |spec|
+  spec.name = 'snippeteer'
+  spec.version = Snippeteer::VERSION
+  spec.author = 'feivel jellyfish'
+  spec.email = 'walpurgisriot@gmail.com'
+  spec.files = FileList['snippeteer.gemspec',
+                        'README.markdown',
+                        'LICENSE',
+                        'lib/*',
+                        'bin/*']
+  spec.test_files = FileList['test/**/*']
+  spec.executables = ["snippeteer"]
+  spec.bindir = 'bin'
+  spec.license = 'MIT/X11'
+  spec.homepage = 'http://github.com/walpurgisriot/jekyll-snippeteer'
+  spec.summary = 'Code snippet extractor & runner.'
+  spec.description = 'Code snippet extractor & runner for Jekyll posts.'
+end
+

data/test/test.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+require_relative '../lib/snippeteer'
+
+POST = <<EOF
+hai this hurr is my blog
+i have written sum coed:
+{% highlight c %}
+int num = 2;
+{% endhighlight%}
+
+{%highlight  ruby%}
+nums = [1,2,3] # lol
+{% endhighlight %}
+
+{% highlight  c %}
+const char *myTxt = "i am writin c";
+// lol i dont get y C needs semmicolons?
+{%  endhighlight  %}
+
+<a href="mailto:the_code_kid93@yahoo.com">HIRE ME</a>
+EOF
+
+POST.freeze
+
+
+class LangTest < Test::Unit::TestCase
+  def test_find
+    assert_equal Snippeteer::Lang.find("haskell"), Snippeteer::Lang.new(".hs", "runhaskell")
+    assert_equal Snippeteer::Lang.find("ruby"),    Snippeteer::Lang.new(".rb", "ruby")
+    assert_equal Snippeteer::Lang.find("blargysploo"), Snippeteer::Lang::UNKNOWN
+  end
+
+  def test_register
+    # modifying entries
+    Snippeteer::Lang.register "ruby", ".rb", "jruby"
+    assert_equal Snippeteer::Lang.find("ruby").exec, "jruby"
+
+    # creating new entries
+    Snippeteer::Lang.register "made_up_lang", ".mul"
+    assert_equal Snippeteer::Lang.find("made_up_lang"), Snippeteer::Lang.new(".mul", nil)
+  end
+end
+
+class ScannerTest < Test::Unit::TestCase
+  def test_scan
+    results = Snippeteer::LiquidHighlightScanner.scan POST
+    assert_equal results.size, 3
+    assert_equal results.select {|r| r.lang.ext == ".c"}.size, 2
+    assert_equal results.select {|r| r.lang.ext == ".rb"}.size, 1
+
+    text = results.map(&:code).join
+    assert !(text =~ /HIRE ME/)
+  end
+end
+
+class ReaderTest < Test::Unit::TestCase
+  def lang(l)
+    Snippeteer::Lang.find l
+  end
+
+  def test_sources
+    srcs = Snippeteer::Reader.new(POST, [Snippeteer::LiquidHighlightScanner]).sources
+    assert_equal srcs.size, 2
+    assert srcs.has_key? lang "ruby"
+    assert srcs.has_key? lang "c"
+    assert_equal srcs[lang "c"].lines.size, 3
+  end
+end
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: snippeteer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- feivel jellyfish
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-05 00:00:00.000000000 Z
+dependencies: []
+description: Code snippet extractor & runner for Jekyll posts.
+email: walpurgisriot@gmail.com
+executables:
+- snippeteer
+extensions: []
+extra_rdoc_files: []
+files:
+- snippeteer.gemspec
+- README.markdown
+- LICENSE
+- lib/snippeteer.rb
+- bin/snippeteer
+- test/test.rb
+homepage: http://github.com/walpurgisriot/jekyll-snippeteer
+licenses:
+- MIT/X11
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Code snippet extractor & runner.
+test_files:
+- test/test.rb