texttube_baby 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 418cb4a5268b6c0f2e97adadcd5f98ead13fb5ab
+  data.tar.gz: f767767cd2ab6c8800717fb87af479bc3db01f2c
+SHA512:
+  metadata.gz: 4abc064a958b26c54291288ac0c89d41ff7ebabee88ce5abb0ff7ec32fb60d74f0a7742683fead1b078f2f402016a873e9d7443fc482c998d2cb768cbf2ddc24
+  data.tar.gz: b2aa89e936d22a0153e31770777ad88024925fdb29fe473703e219b3ab2ae951f5f821125986574f74c171770e030f966a7d09951d9a9104d868b7f1e6a64b82

data/.gitignore

@@ -0,0 +1,25 @@
+*.old
+*.tmproj
+.DS_Store
+.rvmrc
+
+*.gem
+
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+pkg
+rdoc
+.rspec
+Gemfile.lock
+bin/
+vendor/
+coverage/
+docs/
+.yardoc/
+.bundle/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in TextTubeBaby.gemspec
+gemspec
+
+group :test do
+	gem "rspec"
+	gem "simplecov"
+end

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Iain Barnett
+
+MIT Licence
+
+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,242 @@
+# TextTubeBaby
+
+Here are some ready built filters to use with TextTube. If you write any you think would be useful, send me a pull request!
+
+### Note! ###
+
+If you're having a problem with the TextTube::InsideBlock filter on Heroku it could be because of the version of Libxml2 it uses, as [the problem given here states](http://stackoverflow.com/q/8598958/335847), which means Nokogiri won't always work properly on Heroku. When using the InsideBlock filter this can be a problem, so use the `hpricot` branch instead.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'texttube_baby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install texttube_baby
+
+## The Filters! ##
+
+### LinkReffing ###
+
+If you'd don't want your links inline and would prefer to have them at the bottom of the document, then you can use this:
+
+    require 'texttube/base'
+    require 'texttube/baby/link_reffing'
+    
+    class TextWithLinks < TextTube::Base
+      register TextTube::Baby::LinkReffing
+    end
+    
+    s = TextWithLinks.new %q!Iain's blog[[http://iainbarnett.me.uk|My blog]] is good. Erik Hollensbe's blog[[http://erik.hollensbe.org/|Holistic Engineering]] is also good, as is James Coglan's blog[[http://blog.jcoglan.com/|The If Works]]!
+
+    s.filter
+
+and it will produce this:
+
+    # => "Iain's blog[&#8304;](#0 "Jump to reference") is good. Erik Hollensbe's blog[&sup1;](#1 "Jump to reference") is also good, as is James Coglan's blog[&sup2;](#2 "Jump to reference")\n<div markdown='1' id='reflinks'>\n<a name="0"></a>&#91;0&#93; [http://iainbarnett.me.uk](http://iainbarnett.me.uk "http://iainbarnett.me.uk") My blog\n\n\n<a name="1"></a>&#91;1&#93; [http://erik.hollensbe.org/](http://erik.hollensbe.org/ "http://erik.hollensbe.org/") Holistic Engineering\n\n\n<a name="2"></a>&#91;2&#93; [http://blog.jcoglan.com/](http://blog.jcoglan.com/ "http://blog.jcoglan.com/") The If Works\n\n</div>"
+
+Run that through a markdown parser and you get:
+
+    <p>Iain's blog<a href="#0" title="Jump to reference">&#8304;</a> is good. Erik Hollensbe's blog<a href="#1" title="Jump to reference">&sup1;</a> is also good, as is James Coglan's blog<a href="#2" title="Jump to reference">&sup2;</a></p>
+    
+    <div markdown='1' id='reflinks'>
+    <a name="0"></a>&#91;0&#93; [http://iainbarnett.me.uk](http://iainbarnett.me.uk "http://iainbarnett.me.uk") My blog
+    
+    
+    <a name="1"></a>&#91;1&#93; [http://erik.hollensbe.org/](http://erik.hollensbe.org/ "http://erik.hollensbe.org/") Holistic Engineering
+    
+    
+    <a name="2"></a>&#91;2&#93; [http://blog.jcoglan.com/](http://blog.jcoglan.com/ "http://blog.jcoglan.com/") The If Works
+    
+    </div>
+
+Using this will probably end up with also using InsideBlock, to transform the markdown inside the div.
+
+### InsideBlock ###
+
+Sometimes it'd be useful to wrap some markdown with HTML, for example:
+
+    <div id="notes">
+    
+    * first
+    * second
+    * third
+    
+    </div>
+
+If you put this through a markdown parser the markdown won't get parsed:
+
+    require 'rdiscount'
+    s = "<div id="notes">\n\n* first\n* second\n* third\n\n</div>\n"
+    puts RDiscount.new(s).to_html
+
+This is the output:
+
+    <div id="notes">
+    
+    * first
+    * second
+    * third
+    
+    </div>
+
+My brilliant idea to get around this is to add an HTML attribute of `markdown='1'` to HTML tags that you want the markdown parser to look inside:
+
+    <div id="notes" markdown='1'>
+    
+    * first
+    * second
+    * third
+    
+    </div>
+
+Trying this with `InsideBlock` gives:
+
+    puts TextTube::Baby::InsideBlock.run s
+
+    <div id="notes">
+    <ul>
+    <li>first</li>
+    <li>second</li>
+    <li>third</li>
+    </ul>
+    
+    </div>
+
+To use it as a filter:
+
+    require 'texttube/base'
+    
+    class MyFilter < TextTube::Baby::Base
+      register TextTube::Baby::InsideBlock
+    end
+    
+    myf = MyFilter.new(s)
+    # => "<div id="notes" markdown='1'>\n\n* first\n* second\n* third\n\n</div>\n"
+    
+    puts myf.filter
+
+Gives:
+
+    <div id="notes">
+    <ul>
+    <li>first</li>
+    <li>second</li>
+    <li>third</li>
+    </ul>
+    
+    </div>
+
+### Coderay ###
+
+Filters an HTML code block and marks it up with [coderay](http://coderay.rubychan.de/):
+
+
+
+    require 'texttube/base'
+    require 'texttube/baby/coderay'
+    require 'rdiscount' # a markdown parser
+    
+    class TextWithCode < TextTube::Baby::Base
+      register do
+        filter_with :rdiscount do |text|
+          RDiscount.new(text).to_html
+        end
+      end
+      register TextTube::Baby::Coderay
+    end
+
+    s = TextWithCode.new <<'STR'
+    # FizzBuzz #
+    
+        ::::ruby
+        (1..100).each do |n| 
+          out = "#{n}: "
+          out << "Fizz" if n % 3 == 0
+          out << "Buzz" if n % 5 == 0
+          puts out
+        end
+    
+    That's all folks!
+    STR
+    # => "# FizzBuzz #\n\n    ::::ruby\n    (1..100).each do |n| \n      out = "\#{n}: "\n      out << "Fizz" if n % 3 == 0\n      out << "Buzz" if n % 5 == 0\n      puts out\n    end\n\nThat's all folks!\n"
+
+
+    puts s.filter
+
+Produces:
+
+    <h1>FizzBuzz</h1>
+    
+    <pre><code class="CodeRay">(<span class="integer">1</span>..<span class="integer">100</span>).each <span class="keyword">do</span> |n| 
+      out = <span class="string"><span class="delimiter">"</span><span class="inline"><span class="inline-delimiter">#{</span>n<span class="inline-delimiter">}</span></span><span class="content">: </span><span class="delimiter">"</span></span>
+      out &lt;&lt; <span class="string"><span class="delimiter">"</span><span class="content">Fizz</span><span class="delimiter">"</span></span> <span class="keyword">if</span> n % <span class="integer">3</span> == <span class="integer">0</span>
+      out &lt;&lt; <span class="string"><span class="delimiter">"</span><span class="content">Buzz</span><span class="delimiter">"</span></span> <span class="keyword">if</span> n % <span class="integer">5</span> == <span class="integer">0</span>
+      puts out
+    <span class="keyword">end</span></code></pre>
+    
+    <p>That's all folks!</p>
+
+The language was specified with a leading `::::ruby`. It didn't have to be as the default is to use Ruby, but if you want to use any other of the [coderay supported languages](http://coderay.rubychan.de/doc/CodeRay/Scanners.html), that's how to do it.
+
+### Spiffing ###
+
+Transforms CSS written in British English into its ugly sister from across the pond. Inspired by [visualidiot's SpiffingCSS](https://github.com/visualidiot/Spiffing).
+
+    content = <<CSS
+      body {
+        background-colour: darkgrey;
+        background-photograph: url(logo.gif);
+        transparency: .7;
+      
+        font: 72px "Comic Sans", cursive !please;
+        font-weight: plump;
+        p { text-align: centre }
+        fieldset input {
+          text-transform: capitalise;
+        }
+      }
+    CSS
+
+    require 'texttube/base'
+    require 'texttube/baby/spiffing'
+
+    class CssString < TextTube::Base
+      register TextTube::Baby::Spiffing
+    end
+
+    puts CssString.new(content).filter
+
+    # output:
+
+    body {
+      background-color: darkgray;
+      background-image: url(logo.gif);
+      opacity: .7;
+    
+      font: 72px "Comic Sans", cursive !important;
+      font-weight: bold;
+      p { text-align: center }
+      fieldset input {
+        text-transform: capitalize;
+      }
+    }
+
+God save the Queen!
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/TextTubeBaby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ext/blank.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+module TextTube
+  module CoreExtensions
+  
+    def blank?
+      respond_to?(:empty?) ? 
+        empty? :
+        !self
+    end
+  end
+
+	class String < ::String
+		include CoreExtensions
+	end
+end
+
+# Standard lib class.
+class Hash
+  include TextTube::CoreExtensions
+end

data/lib/texttube/baby.rb

@@ -0,0 +1,5 @@
+module TextTube
+  module Baby
+		# Your code goes here...
+  end
+end

data/lib/texttube/baby/coderay.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+module TextTube
+
+  require 'nokogiri'
+  require_relative "../../ext/blank.rb"
+  require 'coderay'
+  require "texttube/filterable"
+
+  # a filter for Coderay
+  module Coderay
+    extend Filterable
+
+    filter_with :coderay do |text|
+      TextTube::Coderay.run text
+    end
+
+
+    # @param [String] content
+    # @param [Hash] options
+    # @return [String]
+    def self.run(content, options={})
+      options = {lang: :ruby } if options.blank? 
+      doc = Nokogiri::HTML::fragment(content) 
+
+      code_blocks = doc.xpath("pre/code").map do |code_block| 
+        #un-escape as Coderay will escape it again
+        inner_html = code_block.inner_html
+        
+        # following the convention of Rack::Codehighlighter
+        if inner_html.start_with?("::::")
+          lines = inner_html.split("\n")
+          options[:lang] = lines.shift.match(%r{::::(\w+)})[1].to_sym
+          inner_html = lines.join("\n")
+        end
+
+        if (options[:lang] == :skip) || (! options.has_key? :lang )
+          code_block.inner_html = inner_html
+        else
+          code = Coderay.codify(Coderay.html_unescape(inner_html), options[:lang]) 
+          code_block.inner_html = code 
+          code_block["class"] = "CodeRay"    
+        end      
+      end#block
+
+      doc.to_s
+    end#def
+
+    # @private
+    # Unescape the HTML as the Coderay scanner won't work otherwise.
+    def self.html_unescape(a_string) 
+      a_string.gsub('&amp;', '&').gsub('&lt;', '<').gsub('&gt;', 
+      '>').gsub('&quot;', '"') 
+    end#def
+
+    # Run the Coderay scanner.
+    # @private
+    # @param [String] str
+    # @param [String] lang
+    # @example
+    #   self.class.codify "x = 2", "ruby"
+    def self.codify(str, lang) 
+      CodeRay.scan(str, lang).html
+    end#def
+
+  end#class 
+
+
+end#module

data/lib/texttube/baby/embedding_audio.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+require "texttube/filterable"
+
+module TextTube
+	module Baby
+		# Embed some audio via [audio[link|name]]
+		module EmbeddingAudio
+			extend TextTube::Filterable
+	
+			filter_with :embeddingaudio do |text|
+				run text
+			end
+	
+			# default attributes
+			DEFAULTS = {
+				src_base:  "/streams/",
+				preload:   "metadata",
+				fallback_text: "Your browser does not support HTML5, update your browser you fool!",
+				controls: "controls",
+			}
+		
+			# [audio[link|name]]
+			R_link = /             # [audio[url|description]]
+				\[audio\[        # opening square brackets
+					([^\|]+)     # link
+						\|      # separator
+					([^\[]+)  # description
+				\]\]        # closing square brackets
+			/x
+
+
+			# @param [String] content
+			# @param [Hash] options
+			# @return [String]
+			def self.run(content, options={})
+				options ||= {}
+				attributes = DEFAULTS.merge options
+					 
+				content.gsub( R_link ) { |m|
+					url,desc = $1,$2
+					EmbeddingAudio::render_tag(url,desc,attributes)
+				}
+			end
+
+
+			# Does the grunt work of rendering the tag.
+			# @private
+			# @param [String] link
+			# @param [String] desc
+			# @param [Hash] attributes
+			def self.render_tag(link,desc,attributes)
+				fallback_text = attributes.delete(:fallback_text)
+				src_base = attributes.delete(:src_base)
+				make_inner = ->(lnk){%Q!<source src='#{src_base}#{lnk}' type='audio/#{File.extname(lnk)[1..-1]}' />!}
+				inner = make_inner.( link )
+				inner += make_inner.( link.sub(/m4a$/, "ogg") ) if File.extname(link) == ".m4a"
+				%Q!<div class='audio'><h3>#{desc}</h3><audio #{attributes.map{|(k,v)| "#{k}='#{v}'" }.join(" ")}>#{inner}#{fallback_text}</audio></div>!.strip.gsub /\s+/, " "
+			end
+
+		end # class
+	end
+end # module