preprocessor 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'rspec', '~> 2.6.0'
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Brandan Lennox
+
+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,6 @@
+Text Preprocessor
+=================
+
+Ruby module that I use on a couple of blogs as a shortcut to reference images, audio, footnotes, etc. It's very specific to my needs, but you might find something useful in it.
+
+I'm maintaining [the docs](http://bclennox.com/projects/preprocessor) on my site now.

data/lib/preprocessor.rb

@@ -0,0 +1,88 @@
+require 'preprocessor/utilities'
+require 'preprocessor/image'
+require 'preprocessor/audio'
+require 'preprocessor/video'
+require 'preprocessor/footnote'
+
+module Preprocessor
+  def self.included(base)
+    base.class_eval do
+      def preprocessed
+        @preprocessed ||= BasicPreprocessor.new(self)
+      end
+    end
+  end
+
+  class BasicPreprocessor
+    attr_accessor :delegate
+
+    include ::Preprocessor::Utilities
+    include ::Preprocessor::Image
+    include ::Preprocessor::Audio
+    include ::Preprocessor::Video
+    include ::Preprocessor::Footnote
+
+    TAG_REGEX = /(.)?\{\{(\S+?)(?:\s+(.*?))?\}\}/
+    REPLACEMENT_REGEX = /\{-\{-(.*?)-\}-\}/
+
+    def initialize(delegate)
+      self.delegate = delegate
+    end
+
+    def method_missing(sym, *args)
+      text = delegate.send(sym, *args)
+
+      while text.match(TAG_REGEX)
+        text.sub!(TAG_REGEX, replacement_for($2, $3, $1 || ''))
+      end
+
+      text.gsub!(REPLACEMENT_REGEX, '{{\1}}')
+      text
+    end
+
+  private
+
+    def replacement_for(message, options_string, antecedant)
+      if escape?(antecedant)
+        antecedant = ''
+        replacement = replacement_placeholder(message, options_string)
+      else
+        replacement = if respond_to?(message)
+          send(message, options_from_string(options_string))
+        elsif delegate.respond_to?(message)
+          delegate.send(message)
+        else
+          replacement_placeholder(message, options_string)
+        end
+      end
+
+      antecedant + replacement
+    end
+
+    def replacement_placeholder(text, options)
+      "{-{-#{[text, options].compact.join(' ')}-}-}"
+    end
+
+    def escape?(char)
+      char == '\\'
+    end
+
+    def options_from_string(options_string)
+      return {} if options_string.nil?
+
+      # replace strings first
+      re = /:(["'|])(.*?)(\1)/
+      string_refs = []
+      while options_string.match(re)
+        options_string.sub!(re, ":ppstringref#{string_refs.length}")
+        string_refs.push($2)
+      end
+
+      options_string.split(/\s+/).inject({}) do |memo, o|
+        q = o.split(/:/, 2)
+        memo[q.first.to_sym] = q.last.match(/ppstringref(\d+)/) ? string_refs[$1.to_i] : q.last
+        memo
+      end
+    end
+  end
+end

data/lib/preprocessor/audio.rb

@@ -0,0 +1,14 @@
+module Preprocessor
+  module Audio
+    class << self
+      attr_accessor :options
+    end
+
+    @options = { :default_path => '/audio' }
+
+    def audio(options)
+      src = absolutize(options[:src], ::Preprocessor::Audio.options[:default_path])
+      %{<audio controls><source src="#{src}.oga" type="audio/ogg" /><source src="#{src}.mp3" type="audio/mpeg" /></audio>}
+    end
+  end
+end

data/lib/preprocessor/footnote.rb

@@ -0,0 +1,37 @@
+module Preprocessor
+  module Footnote
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :footnote_refs
+      end
+    end
+
+    def footnote(options)
+      ref = options[:ref]
+      add_footnote(ref, options[:text])
+
+      id = "#{guid}-#{options[:ref]}"
+      %{<a href="#fn-#{id}" class="footnote" id="ref-#{id}">#{ref}</a>}
+    end
+
+    def footnotes(options)
+      footnote_refs.nil? ? "" : footnote_refs.map { |fn| footnote_content(fn) }.join
+    end
+
+  private
+
+    def guid
+      delegate.slug
+    end
+
+    def add_footnote(ref, text)
+      @footnote_refs ||= {}
+      @footnote_refs[ref] = text
+    end
+
+    def footnote_content(fn)
+      id = "#{guid}-#{fn[0]}"
+      %:#(#fn-#{id}) #{fn[1]} <a href="#ref-#{id}" class="returner" title="Return to where you left off">&#8617;</a>\n:
+    end
+  end
+end

data/lib/preprocessor/image.rb

@@ -0,0 +1,31 @@
+module Preprocessor
+  module Image
+    class << self
+      attr_accessor :options
+    end
+
+    @options = { :default_path => '/images' }
+
+    def image(options)
+      attrs = {
+        :src => absolutize(options[:src], ::Preprocessor::Image.options[:default_path]),
+        :alt => options[:alt] || "",
+        :title => options[:title] == "alt" ? options[:alt] : options[:title]
+      }
+
+      caption_text = case options[:caption]
+      when "alt"
+        attrs[:alt]
+      when "title"
+        attrs[:title]
+      else
+        options[:caption]
+      end
+
+      caption = %{<span class="caption">#{caption_text}</span>}
+      attr_str = attrs.map { |k, v| %{#{k}="#{v}"} }.join(' ')
+
+      %{<p class="image"><img #{attr_str} />#{caption}</p>}
+    end
+  end
+end

data/lib/preprocessor/utilities.rb

@@ -0,0 +1,11 @@
+module Preprocessor
+  module Utilities
+    def absolutize(src, path)
+      absolute?(src) ? src : "#{path}/#{src}"
+    end
+
+    def absolute?(src)
+      src =~ /^\/|http:\/\//
+    end
+  end
+end

data/lib/preprocessor/video.rb

@@ -0,0 +1,56 @@
+module Preprocessor
+  module Video
+    class << self
+      attr_accessor :options
+    end
+
+    @options = { :default_path => '/video' }
+
+    class YouTube
+      attr_accessor :src
+      URL_REGEXP = /youtube\.com\/(?:watch\?v=|v\/)([^\/?&]+)/i
+
+      def initialize(options)
+        self.src = options[:src]
+      end
+
+      def tag
+        if src =~ URL_REGEXP
+          url = "http://www.youtube.com/v/#{$1}"
+          %{<object width="425" height="344"><param name="movie" value="#{url}"></param><param name="allowFullScreen" value="true"></param><param name="allowscriptaccess" value="always"></param><embed src="#{url}" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="425" height="344"></embed></object>}
+        end
+      end
+
+      def self.recognizes?(src)
+        src =~ URL_REGEXP
+      end
+    end
+
+    class Default
+      attr_accessor :src, :poster
+
+      # lame
+      include ::Preprocessor::Utilities
+
+      def initialize(options)
+        self.src = options[:src]
+        self.poster = options[:poster]
+      end
+
+      def tag
+        src = absolutize(self.src, ::Preprocessor::Video.options[:default_path])
+        poster = self.poster && %{poster="#{self.poster}"}
+
+        # eventually should use http://camendesign.com/code/video_for_everybody
+        %{<video controls #{poster}><source src="#{src}.ogv" type="video/ogg" /><source src="#{src}.mp4" type="video/mp4" /></video>}
+      end
+    end
+
+    CUSTOM_EMBEDDERS = [YouTube]
+
+    def video(options)
+      embedder = CUSTOM_EMBEDDERS.detect { |e| e.recognizes?(options[:src]) } || Default
+      embedder.new(options).tag
+    end
+  end
+end

data/preprocessor.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "preprocessor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "preprocessor"
+  s.version     = Preprocessor::VERSION
+  s.authors     = ["Brandan Lennox"]
+  s.email       = ["brandan@bclennox.com"]
+  s.homepage    = "https://github.com/bclennox/preprocessor"
+  s.date        = "2012-01-28"
+  s.summary     = %q{Ruby text munger}
+  s.description = %q{Ruby module that I use on a couple of blogs as a shortcut to reference images, audio, footnotes, etc. It's very specific to my needs, but you might find something useful in it.}
+
+  s.rubyforge_project = "preprocessor"
+
+  s.files = %w{
+    preprocessor.gemspec
+    Gemfile
+    MIT-LICENSE
+    README.markdown
+
+    lib/preprocessor.rb
+    lib/preprocessor/audio.rb
+    lib/preprocessor/footnote.rb
+    lib/preprocessor/image.rb
+    lib/preprocessor/utilities.rb
+    lib/preprocessor/video.rb
+  }
+
+  s.test_files = %w{
+    spec/preprocessor_spec.rb
+    spec/spec_helper.rb
+  }
+
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/spec/preprocessor_spec.rb

@@ -0,0 +1,181 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class PreprocessorTester
+  def initialize(options = {})
+    options.each do |message, value|
+      self.class.class_eval { attr_accessor message }
+      send("#{message}=", value)
+    end
+  end
+
+  include ::Preprocessor
+end
+
+describe Preprocessor do
+  it 'should ignore escaped curlies' do
+    tester = PreprocessorTester.new(:name => 'Munge', :title => 'Remember my \{{name with:"a mnemonic"}}')
+    tester.preprocessed.title.should == 'Remember my {{name with:"a mnemonic"}}'
+  end
+
+  it 'should substitute method return values if the delegate responds_to?' do
+    tester = PreprocessorTester.new(:name => 'Fooject', :title => 'This is the {{name}}')
+    tester.preprocessed.title.should == 'This is the Fooject'
+  end
+
+  it 'should prioritize sub-module methods over delegate methods' do
+    tester = PreprocessorTester.new(:image => 'paperclip', :text => 'Look! My new Zune: {{image src:shit-brown.png}}')
+    tester.preprocessed.text.should_not =~ /paperclip/
+  end
+
+  it 'should return the unchanged string if neither it nor the delegate responds_to?' do
+    tester = PreprocessorTester.new(:text => "I don't understand {{anything}}")
+    tester.preprocessed.text.should == "I don't understand {{anything}}"
+  end
+
+  describe "parsing option strings" do
+    before(:each) do
+      @tester = PreprocessorTester.new
+    end
+
+    def options_from_string(string)
+      @tester.preprocessed.send(:options_from_string, string)
+    end
+
+    it 'should parse unquoted option values' do
+      options_from_string('arg:simple').should == { :arg => 'simple' }
+    end
+
+    it 'should parse single-quoted option values' do
+      options_from_string(%{arg:'Not so much "fat" as "dumb".'}).should == { :arg => 'Not so much "fat" as "dumb".' }
+    end
+
+    it 'should parse double-quoted option values' do
+      options_from_string(%{arg:"D'oh!"}).should == { :arg => "D'oh!" }
+    end
+
+    it 'should parse piped option values' do
+      options_from_string(%{arg:|And I said, "Frankly, my dear, I don't give a damn!"|}).should == { :arg => %{And I said, "Frankly, my dear, I don't give a damn!"} }
+    end
+
+    it 'should parse option values with special characters' do
+      options_from_string(%{arg:http://www.example.com/}).should == { :arg => 'http://www.example.com/' }
+    end
+  end
+
+  describe "utilities" do
+    class UtilitiesTester
+      include ::Preprocessor::Utilities
+    end
+
+    it 'should ignore absolute paths' do
+      UtilitiesTester.new.absolutize('/my/stuff/me.png', '/where/ever').should == '/my/stuff/me.png'
+    end
+
+    it 'should not prepend the default path to URLs' do
+      UtilitiesTester.new.absolutize('http://example.com/illicit.png', '/lalala').should == 'http://example.com/illicit.png'
+    end
+  end
+
+  describe "#image" do
+    it 'should have src, alt, title attributes and a caption' do
+      tester = PreprocessorTester.new(:text => 'This chick is mad hot: {{image src:chick.png alt:"Chicken in the oven" title:"No title necessary" caption:"Look how hot yah"}}')
+      tester.preprocessed.text.should =~ /src="\/images\/chick.png"/
+      tester.preprocessed.text.should =~ /alt="Chicken in the oven"/
+      tester.preprocessed.text.should =~ /title="No title necessary"/
+      tester.preprocessed.text.should =~ /Look how hot yah/
+    end
+
+    it 'should allow shortcutting title and caption' do
+      tester = PreprocessorTester.new(:text => 'Lazy {{image src:foo.png alt:"Required" title:alt caption:title}}')
+      tester.preprocessed.text.should =~ /title="Required"/
+      tester.preprocessed.text.should =~ /<span class="caption">Required<\/span>/
+    end
+
+    it 'should set the default path' do
+      ::Preprocessor::Image.options[:default_path] = '/system/assets'
+      tester = PreprocessorTester.new(:text => 'Hope it works: {{image src:boo.png alt:"Whatevs"}}')
+      tester.preprocessed.text.should =~ /src="\/system\/assets\/boo.png"/
+    end
+  end
+
+  describe "#audio" do
+    before(:each) do
+      @tester = PreprocessorTester.new(:text => 'Peep this sweet cut: {{audio src:piano-rock}}')
+    end
+
+    it 'should contain a source for the MP3 file' do
+      @tester.preprocessed.text.should =~ /piano-rock.mp3/
+    end
+
+    it 'should contain a source for the Ogg file' do
+      @tester.preprocessed.text.should =~ /piano-rock.oga/
+    end
+
+    it 'should set the default path' do
+      ::Preprocessor::Audio.options[:default_path] = '/somewhere/else'
+      @tester.preprocessed.text.should =~ /\/somewhere\/else\/piano-rock/
+    end
+
+    it 'should not prepend the default path to absolute paths' do
+      tester = PreprocessorTester.new(:text => 'Baddies: {{audio src:/i/love/bob}}')
+      tester.preprocessed.text.should =~ /\/i\/love\/bob/
+    end
+  end
+
+  describe "#video" do
+    describe 'YouTube videos' do
+      it 'should recognize a "watch" URL with a query string' do
+        ::Preprocessor::Video::YouTube.should recognize('http://www.youtube.com/watch?v=jHyC0ggI3Ow&feature=player_embedded')
+      end
+
+      it 'should recognize a "/v/" URL with a query string' do
+        ::Preprocessor::Video::YouTube.should recognize('http://www.youtube.com/v/jHyC0ggI3Ow&hl=en_US&fs=1&rel=0')
+      end
+
+      it 'should include the object and embed shit' do
+        tester = PreprocessorTester.new(:text => 'LOLOL {{video src:"http://www.youtube.com/watch?v=jHyC0ggI3Ow"}}')
+        tester.preprocessed.text.should =~ /param name="movie" value="http:\/\/www.youtube.com\/v\/jHyC0ggI3Ow"/
+        tester.preprocessed.text.should =~ /embed src="http:\/\/www.youtube.com\/v\/jHyC0ggI3Ow"/
+      end
+    end
+
+    describe "HTML 5 videos" do
+      it 'should include the MP4 source' do
+        tester = PreprocessorTester.new(:text => '{{video src:/videos/dancedancedance}}')
+        tester.preprocessed.text.should =~ /dancedancedance.mp4/
+      end
+
+      it 'should include the Ogg source' do
+        tester = PreprocessorTester.new(:text => '{{video src:/videos/ooouuuuttttt}}')
+        tester.preprocessed.text.should =~ /ooouuuuttttt.ogv/
+      end
+
+      it 'should include an optional poster' do
+        tester = PreprocessorTester.new(:text => '{{video src:/videos/help poster:/images/posse.png}}')
+        tester.preprocessed.text.should =~ /poster="\/images\/posse.png"/
+      end
+    end
+  end
+
+  describe "#footnote" do
+    before(:each) do
+      @tester = PreprocessorTester.new(:text => 'Surprised kitten is surprised.{{footnote ref:1 text:"Not for resale."}} Some more content{{footnote ref:2 text:"Is there more?"}} haha. Content sucks. {{footnotes}}', :slug => 'slug-boat')
+    end
+
+    it 'should contain reference links' do
+      [1, 2].each do |i|
+        @tester.preprocessed.text.should =~ /<a href="#fn-slug-boat-#{i}".*id="ref-slug-boat-#{i}".*?>#{i}/
+      end
+    end
+
+    it 'should contain the footnotes in a Textile list' do
+      @tester.preprocessed.text.should =~ /#\(#fn-slug-boat-1\)\s+Not for resale./
+      @tester.preprocessed.text.should =~ /#\(#fn-slug-boat-2\)\s+Is there more?/
+    end
+
+    it 'should not explode if {{footnotes}} is called without any footnotes' do
+      tester = PreprocessorTester.new(:text => 'There are no {{footnotes}}.')
+      tester.preprocessed.text.should == 'There are no .'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'preprocessor')
+
+# for video embedders
+RSpec::Matchers.define :recognize do |src|
+  match do |embedder|
+    embedder.recognizes?(src)
+  end
+
+  failure_message_for_should do |embedder|
+    "#{embedder} should recognize #{src} and doesn't"
+  end
+
+  failure_message_for_should_not do |embedder|
+    "#{embedder} should not recognize #{src} and does"
+  end
+
+  description do
+    "whatever"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: preprocessor
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brandan Lennox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Ruby module that I use on a couple of blogs as a shortcut to reference images, audio, footnotes, etc. It's very specific to my needs, but you might find something useful in it.
+email: 
+- brandan@bclennox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- preprocessor.gemspec
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- lib/preprocessor.rb
+- lib/preprocessor/audio.rb
+- lib/preprocessor/footnote.rb
+- lib/preprocessor/image.rb
+- lib/preprocessor/utilities.rb
+- lib/preprocessor/video.rb
+- spec/preprocessor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bclennox/preprocessor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: preprocessor
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby text munger
+test_files: 
+- spec/preprocessor_spec.rb
+- spec/spec_helper.rb