texttube 5.1.1 → 6.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2fd3b516b75ad314db454507278459173618f6e
+  data.tar.gz: 33b727194070771ecb3e32517204f376c1ec468c
+SHA512:
+  metadata.gz: 114c1141b316a4e5ad05f92487ceb4a014fb542794fe150d348c1bb9527e9c90e11f86db33bc44889495a34396999be68999c99ea116675c310bd1ed89224384
+  data.tar.gz: 6216d74f04173b226bcebaa5de1ba673e09d52822ffba0e4c09f2ece08c2c1c40365191f5837fc08369bab7a754b1004b14255b8785a39fbba1e841184a49067

data/.gitignore

@@ -20,3 +20,6 @@ Gemfile.lock
 bin/
 vendor/
 coverage/
+docs/
+.yardoc/
+.bundle/

data/CHANGES.md

@@ -1,5 +1,13 @@
 # CH CH CH CHANGES! #
 
+## Friday the 17th of October 2014, v6.0.0 ##
+
+* Moved extra filters into TextTubeBaby to make the library lighter and easier to install.
+* Updated specs to check core lib now filter specs have gone.
+
+----
+
+
 ## Wednesday the 30th of July 2014, v5.1.1 ##
 
 * Updated info in the README about Spiffing CSS website, since it's gone.

data/Gemfile

@@ -21,4 +21,5 @@ group :test do
   gem "maruku"
   gem "rdiscount"
   gem "kramdown"
+  gem "rspec-its"
 end

data/README.md

@@ -2,10 +2,6 @@
 
 Pass a string through filters to transform it.
 
-### 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.
-
 ### Build status ###
 
 Master branch:
@@ -130,223 +126,14 @@ The class picks which filters to use, and can add filters on the fly, by using `
     s.filter
     # => "Let me introduce <a href="iainbarnett.me.uk" title="My blog">Iain Barnett</a>. He writes Ruby code. ©2013. Let me introduce <a href="iainbarnett.me.uk" title="My blog">Iain Barnett</a>. He writes Ruby code. ©2013. "
 
+### Ready made filters ###
 
-## The Filters ##
-
-Here are some ready built filters to use.
-
-### 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/filters/link_reffing'
-    
-    class TextWithLinks < TextTube::Base
-      register TextTube::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::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::Base
-      register TextTube::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/filters/coderay'
-    require 'rdiscount' # a markdown parser
-    
-    class TextWithCode < TextTube::Base
-      register do
-        filter_with :rdiscount do |text|
-          RDiscount.new(text).to_html
-        end
-      end
-      register TextTube::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/filters/spiffing'
-
-    class CssString < TextTube::Base
-      register TextTube::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!
+They used to come with this library, but sometimes they caused problems with installation (things like Nokogiri can be painful to install at times) so I spun them off into their own library - TextTubeBaby!
 
 
 ### Contributors ###
 
-Many thanks to Eleni Karinou and [Annette Smith](https://twitter.com/moosecatear) for brainsplatting a new name for the library, and after many unusable and clearly disturbing suggestions, to Annette for the final name (and its future spin off, which will remain secret for now).
+Many thanks to Eleni Karinou and [Annette Smith](https://twitter.com/moosecatear) for brainsplatting a new name for the library, and after many unusable and clearly disturbing suggestions, to Annette for the final name (and its spin off, TextTubeBaby).
 
 
 ### Licence ###

data/lib/texttube/version.rb

@@ -2,5 +2,5 @@
 
 module TextTube
   # This library's version.
-  VERSION = "5.1.1"
+  VERSION = "6.0.0"
 end

data/lib/texttube.rb

@@ -1,23 +1,4 @@
 # encoding: UTF-8
 
 require_relative "./ext/blank.rb"
-require_relative "./ext/to_constant.rb"
-
-# The original. Maybe. I haven't checked.
-module TextTube
-
-  # Require all the filters.
-  # The `map` is there to show the result of this and
-  # show which libs were required (if so desired).
-  # @return [Array<String,TrueClass>]
-  def self.load_all_filters
-    Dir.glob( File.join File.dirname(__FILE__), "/texttube/filters/*.rb" )
-       .reject{|name| name.end_with? "version.rb" }
-       .map{|filter| 
-         tf = require filter
-         [File.basename(filter, ".rb").gsub("_",""), tf]
-       }
-  end
-
-
-end
+require_relative "./ext/to_constant.rb"

data/spec/base_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'rspec/its'
+require_relative "../lib/texttube/base.rb"
+
+module TextTube # for convenience
+
+describe Base do
+	
+	context "Checking the basics" do
+		context "Instances" do
+			subject { Base.new "anything" }
+			it { should be_a_kind_of String }
+			it { should respond_to :options }
+			its(:options) { should respond_to :empty? }
+			its(:options) { should be_empty }
+		end
+		context "Class methods and their defaults" do
+			subject { Base }
+			it { should respond_to :options }
+			its(:options) { should respond_to :empty? }
+			its(:options) { should be_empty }
+			it { should respond_to :reset! }
+			it { should respond_to :filters }
+			its(:filters) { should respond_to :empty? }
+			its(:filters) { should be_empty }
+			it { should respond_to :register }
+			it { should respond_to :inherited }
+		end
+	end
+end
+
+
+end

data/spec/examples_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'rspec/its'
+require_relative "../lib/texttube/base.rb"
+require_relative "../lib/texttube/filterable.rb"
+
+module TextTube # for convenience
+
+describe "Example usage" do
+	before :all do
+		module AFilter
+			extend TextTube::Filterable
+
+			filter_with :double do |text|
+				text * 2
+			end
+
+			filter_with :triple do |text|
+				text * 3
+			end
+		end
+
+		module BFil
+			extend TextTube::Filterable
+
+			filter_with :spacial do |current,options|
+				current.split(//).join " " 
+			end
+		end
+
+		class NeuS < TextTube::Base
+			register BFil
+			register AFilter
+			register do
+				filter_with :dashes do |text|
+					"---#{text}---"
+				end
+			end
+		end
+	end # before
+
+	context "Instantiation" do
+		let(:n) { NeuS.new "abc" }
+		subject { n }
+		it { should == "abc" }
+
+		context "filtering" do
+			context "With no arguments" do
+				subject { n.filter }
+				it { should == "---a b ca b ca b ca b ca b ca b c---" }
+			end
+			context "Given a specific filter" do
+				subject { n.filter :spacial }
+				it { should == "a b c" }
+			end
+			context "Given several specific filters" do
+				subject { n.filter :spacial, :dashes, :spacial }
+				it { should == "- - - a   b   c - - -" }
+			end
+		end
+	end
+end
+
+end # inconvenient

data/spec/spec_helper.rb

@@ -27,7 +27,6 @@ Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f|
 end
 
 
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-end
+# RSpec.configure do |config|
+# end`
 

data/texttube.gemspec

@@ -4,17 +4,13 @@ require "texttube/version"
 
 Gem::Specification.new do |s|
   s.name           = "texttube"
-  s.summary        = "Some useful filters for markdown that I use in my blogs"
-  s.description = <<-EOF
-    Some markdown filters I find useful.
-  EOF
+  s.summary        = "Create chainable filters with ease."
+  s.description 	 = s.summary
   s.version        = TextTube::VERSION
   s.platform       = Gem::Platform::RUBY
   s.required_ruby_version    = ">= 1.9.1"
   s.author         = "Iain Barnett"
   s.files          = `git ls-files`.split("\n")
-  s.add_dependency("nokogiri", '~>1.5.9' )
-  s.add_dependency("coderay", '~>1.0' )
   s.email          = "iainspeed @nospam@ gmail.com"
   s.test_files     = `git ls-files -- {test,spec,features}`.split("\n")
   s.homepage       = "https://github.com/yb66/TextTube"

metadata

@@ -1,64 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: texttube
-version: !ruby/object:Gem::Version 
-  hash: 49
-  prerelease: 
-  segments: 
-  - 5
-  - 1
-  - 1
-  version: 5.1.1
+version: !ruby/object:Gem::Version
+  version: 6.0.0
 platform: ruby
-authors: 
+authors:
 - Iain Barnett
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-07-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 1
-        - 5
-        - 9
-        version: 1.5.9
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: coderay
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  type: :runtime
-  version_requirements: *id002
-description: "    Some markdown filters I find useful.\n"
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies: []
+description: Create chainable filters with ease.
 email: iainspeed @nospam@ gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .travis.yml
+files:
+- ".gitignore"
+- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - README.md
@@ -68,61 +27,35 @@ files:
 - lib/texttube.rb
 - lib/texttube/base.rb
 - lib/texttube/filterable.rb
-- lib/texttube/filters/coderay.rb
-- lib/texttube/filters/embedding_audio.rb
-- lib/texttube/filters/embedding_video.rb
-- lib/texttube/filters/inside_block.rb
-- lib/texttube/filters/link_reffing.rb
-- lib/texttube/filters/spiffing.rb
 - lib/texttube/version.rb
-- spec/coderay_spec.rb
-- spec/embedding_audio_spec.rb
-- spec/inside_block_spec.rb
-- spec/link_reffing_spec.rb
-- spec/markdownfilters_spec.rb
+- spec/base_spec.rb
+- spec/examples_spec.rb
 - spec/spec_helper.rb
-- spec/spiffing_spec.rb
 - texttube.gemspec
 homepage: https://github.com/yb66/TextTube
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 49
-      segments: 
-      - 1
-      - 9
-      - 1
+    - !ruby/object:Gem::Version
       version: 1.9.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: Some useful filters for markdown that I use in my blogs
-test_files: 
-- spec/coderay_spec.rb
-- spec/embedding_audio_spec.rb
-- spec/inside_block_spec.rb
-- spec/link_reffing_spec.rb
-- spec/markdownfilters_spec.rb
+specification_version: 4
+summary: Create chainable filters with ease.
+test_files:
+- spec/base_spec.rb
+- spec/examples_spec.rb
 - spec/spec_helper.rb
-- spec/spiffing_spec.rb

data/lib/texttube/filters/coderay.rb

@@ -1,68 +0,0 @@
-# encoding: UTF-8
-module TextTube
-
-  require 'nokogiri'
-  require_relative "../../ext/blank.rb"
-  require 'coderay'
-  require_relative "../filterable.rb"
-
-  # 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