stupid_formatter 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Christoph Olszowka
+
+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.rdoc

@@ -0,0 +1,33 @@
+= StupidFormatter
+
+This is a super-stupid gem for formatting text in a chain. You can change the chain by doing this:
+
+  StupidFormatter.chain = [StupidFormatter::ErbWithCoderay, StupidFormatter::RDiscount]
+
+Then, pass in your Markdown-markedup, erb-riddled string to StupidFormatter.result and you'll
+see results.
+
+This is so completely alpha, you have no idea!
+
+== Custom formatters
+
+You can define your own formatters and by conforming to the public api, which is:
+
+* inherit from StupidFormatter::AbstractFormatter
+* make a result instance method that does not take any arguments
+* use the local attribute 'input' to do whatever you want with the text, and return it
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stupid_formatter"
+    gem.summary = %Q{A stupid formatter for piping text through markup processors}
+    gem.description = %Q{With stupid_formatter you can pipe your blog post through erb and markdown in a chain}
+    gem.email = "christoph at olszowka dot de"
+    gem.homepage = "http://github.com/colszowka/stupid_formatter"
+    gem.authors = ["Christoph Olszowka"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stupid_formatter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/stupid_formatter.rb

@@ -0,0 +1,74 @@
+require 'rdiscount'
+require 'erb'
+require 'coderay'
+
+module StupidFormatter
+  
+  # Make the formatter chain configurable.
+  class << self
+    def chain
+      @chain ||= [StupidFormatter::RDiscount]
+    end
+    
+    def chain=(chain)
+      @chain = chain
+    end
+    
+    # Will put the input string through all formatters in the chain
+    def result(input)
+      output = input.clone
+      chain.each do |formatter|
+        output = formatter.new(output).result
+      end
+      output
+    end
+  end
+  
+  class AbstractFormatter
+    attr_reader :input
+    
+    def initialize(input)
+      @input = input.to_s.strip
+      raise "Please use this only in subclasses" if self.class == AbstractFormatter
+    end
+    
+    def result
+      raise "This should be implemented by subclasses"
+    end
+  end
+  
+  class Erb < AbstractFormatter
+    def result(alternative_binding=nil)
+      ERB.new(input, 0, "%<>", "@output_buffer").result(alternative_binding || binding)
+    end
+    
+    # Helper for capturing output in a erb block for later use, i.e.
+    #   <% @my_var = capture do %>
+    #     Bar
+    #   <% end %>
+    #   Foo<%= @my_var %>
+    # will render FooBar.
+    #
+    def capture
+      old_buffer, @output_buffer = @output_buffer, ''
+      yield
+      @output_buffer
+    ensure
+      @output_buffer = old_buffer
+    end
+  end
+  
+  # Actually, this might get converted into a module that can optionally be mixed into the formatter
+  class ErbWithCoderay < Erb
+    def highlight(language=:ruby)
+      code = capture { yield }
+      @output_buffer << CodeRay.scan(code, language).div(:css => :class)
+    end
+  end
+  
+  class RDiscount < AbstractFormatter
+    def result
+      Markdown.new(input).to_html
+    end
+  end
+end

data/stupid_formatter.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stupid_formatter}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-02-11}
+  s.description = %q{With stupid_formatter you can pipe your blog post through erb and markdown in a chain}
+  s.email = %q{christoph at olszowka dot de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/stupid_formatter.rb",
+     "stupid_formatter.gemspec",
+     "test/fixtures/erb_coderay_markdown_example.txt",
+     "test/fixtures/erb_coderay_markdown_expectation.txt",
+     "test/helper.rb",
+     "test/test_erb_formatter.rb",
+     "test/test_rdiscount_formatter.rb",
+     "test/test_stupid_formatter.rb"
+  ]
+  s.homepage = %q{http://github.com/colszowka/stupid_formatter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A stupid formatter for piping text through markup processors}
+  s.test_files = [
+    "test/test_stupid_formatter.rb",
+     "test/helper.rb",
+     "test/test_erb_formatter.rb",
+     "test/test_rdiscount_formatter.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/fixtures/erb_coderay_markdown_example.txt

@@ -0,0 +1,11 @@
+# A heading
+
+<p>A basic paragraph</p>
+
+<% if 1 == 2 %>
+  Some plain ERB conditional
+<% end %>
+
+<% highlight do %>
+  puts "foo bar baz"
+<% end %>

data/test/fixtures/erb_coderay_markdown_expectation.txt

@@ -0,0 +1,12 @@
+<h1>A heading</h1>
+
+<p>A basic paragraph</p>
+
+
+
+
+<div class="CodeRay">
+  <div class="code"><pre>  puts <span class="s"><span class="dl">&quot;</span><span class="k">foo bar baz</span><span class="dl">&quot;</span></span>
+</pre></div>
+</div>
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'stupid_formatter'
+
+class Test::Unit::TestCase
+  #
+  # Loads fixture files into a string
+  #
+  def fixtures(filename)
+    @fixtures ||= {} # Initialize cache if not present
+    return @fixtures[filename.to_sym] if @fixtures[filename.to_sym] # Return if cached
+    @fixtures[filename.to_sym] = File.read( File.join(File.dirname(__FILE__), 'fixtures', "#{filename}.txt") )
+  end
+end

data/test/test_erb_formatter.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestErbFormatter < Test::Unit::TestCase
+  context "A chunk of erb-formatted text" do
+    setup do
+      @text = "<%= 'foo bar baz' %>"
+    end
+    
+    context "after piping it through a new erb formatter instance" do
+      setup do
+        @result = StupidFormatter::Erb.new(@text).result
+      end
+      
+      should("render 'foo bar baz'") { assert_equal 'foo bar baz', @result.strip.chomp }
+    end
+  end
+  
+  context "A chunk of erb-formatted text that includes a block using the highlight-syntax" do
+    setup do
+      @text = '<% highlight do %>
+puts "foo bar baz"
+<% end %>'
+    end
+    
+    context "after piping it through a new erb with coderay formatter instance" do
+      setup do
+        @result = StupidFormatter::ErbWithCoderay.new(@text).result
+      end
+      
+      should('match <div class="CodeRay">') { assert_match /\<div class="CodeRay"\>/, @result.strip.chomp }
+    end
+  end
+end

data/test/test_rdiscount_formatter.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestRDiscountFormatter < Test::Unit::TestCase
+  context "With a chunk of markdown-formatted text" do
+    setup do
+      @text = "# some heading"
+    end
+    
+    context "after piping it through a new rdiscount formatter instance" do
+      setup do
+        @result = StupidFormatter::RDiscount.new(@text).result
+      end
+      
+      should("render '<h1>some heading</h1>'") { assert_equal '<h1>some heading</h1>', @result.strip.chomp }
+    end
+  end
+end

data/test/test_stupid_formatter.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestStupidFormatter < Test::Unit::TestCase
+  context "After configuring the StupidFormatter.chain to [StupidFormatter::ErbWithCoderay, StupidFormatter::RDiscount]" do
+    setup do
+      StupidFormatter.chain = [StupidFormatter::ErbWithCoderay, StupidFormatter::RDiscount]
+    end
+    
+    should "return StupidFormatter::ErbWithCoderay for the first chain item" do
+      assert_equal StupidFormatter::ErbWithCoderay, StupidFormatter.chain[0]
+    end
+    
+    should "return StupidFormatter::RDiscount for the last chain item" do
+      assert_equal StupidFormatter::RDiscount, StupidFormatter.chain[-1]
+    end
+    
+    should("have 2 chain items") { assert_equal 2, StupidFormatter.chain.length }
+    
+    context "when I put a complex erb/coderay/markdown fixture through the formatter" do
+      setup do
+        @result = StupidFormatter.result(fixtures(:erb_coderay_markdown_example))
+      end
+      
+      should "render as in the expectation fixture" do
+        assert_equal fixtures(:erb_coderay_markdown_expectation), @result
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: stupid_formatter
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: With stupid_formatter you can pipe your blog post through erb and markdown in a chain
+email: christoph at olszowka dot de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/stupid_formatter.rb
+- stupid_formatter.gemspec
+- test/fixtures/erb_coderay_markdown_example.txt
+- test/fixtures/erb_coderay_markdown_expectation.txt
+- test/helper.rb
+- test/test_erb_formatter.rb
+- test/test_rdiscount_formatter.rb
+- test/test_stupid_formatter.rb
+has_rdoc: true
+homepage: http://github.com/colszowka/stupid_formatter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A stupid formatter for piping text through markup processors
+test_files: 
+- test/test_stupid_formatter.rb
+- test/helper.rb
+- test/test_erb_formatter.rb
+- test/test_rdiscount_formatter.rb