model_formatting 0.2.0

data/README

@@ -0,0 +1,3 @@
+This is a plugin for Rails 2.2.x that performs automatic text-to-html formatting.
+
+It is extracted from and used by [Tender](http://tenderapp.com/) and [Lighthouse](http://lighthouseapp.com/).

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new do |s|
+  s.name = "model_formatting"
+  s.version = "0.2.0"
+  s.author = "ENTP"
+  s.email = "company@entp.com"
+  s.homepage = "http://github.com/entp"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Automatically format model attributes using rdiscount and Tender/Lighthouse extensions."
+  s.files = FileList['[a-zA-Z]*', 'lib/**/*', 'rails/**/*', 'test/**/*']
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+  s.add_dependency("rdiscount", "~>1.5.5")
+  s.add_dependency("actionpack", "~>2.2.3")
+  s.add_dependency("activerecord", "~>2.2.3")
+  s.add_dependency("activesupport", "~>2.2.3")
+  s.add_dependency("tidy", "~>1.1.2")
+  s.add_development_dependency("jeremymcanally-context", "~>0.5.5")
+  s.add_development_dependency("jeremymcanally-matchy", "~>0.1.0")
+end
+
+
+desc 'Build the gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+

data/lib/model_formatting.rb

@@ -0,0 +1,205 @@
+require 'cgi'
+module ModelFormatting
+  class Part < Array
+    attr_reader :format
+    def initialize(format, *args)
+      @format = format
+      @simple_string = @formatted_string = nil
+      super(*args)
+    end
+
+    def <<(s)
+      @simple_string = @formatted_string = nil
+      super
+    end
+
+    def compact!
+      @simple_string = @formatted_string = nil
+      super
+    end
+
+    def simple_string
+      @simple_string ||= join("\n")
+    end
+
+    def formatted_string
+      @formatted_string ||= begin
+        if @format == :html
+          %(<pre><code#{%( class="#{@class_name}") unless @class_name.blank?}>#{simple_string}</code></pre>)
+        else
+          simple_string
+        end
+      end
+    end
+
+    def ==(other)
+      simple_string == other
+    end
+
+    def inspect
+      "#{self.class.name}: #{simple_string.inspect}"
+    end
+  end
+
+  class CodePart < Part
+    attr_reader :class_name
+
+    def initialize(format, class_name, *args)
+      @class_name = class_name
+      super(format, *args)
+    end
+
+    def <<(s)
+      super CGI.escapeHTML(s)
+    end
+  end
+
+  class FormattedPart < Part
+    attr_reader :options
+
+    def initialize(format, options = {}, *args)
+      @options = options || {}
+      super(format, *args)
+    end
+
+    def formatted_string
+      @formatted_string ||= begin
+        str = simple_string
+        str = @options[:before].call(@format, str, @options) if @options[:before]
+        str
+      end
+    end
+  end
+
+  def self.process(format, text, options = {})
+    parts  = parse_text_parts(format, options, text)
+    string = parts.map { |p| p.formatted_string } * "\n"
+    string.gsub! /\r/, ''
+    if format == :html
+      string.gsub! /code><\/pre>/, "code>\n</pre>" # do this so markdown registers ending </pre>'s as a linebreak
+      string = gfm(string)
+      string = process_markdown(string)
+      string.gsub! /\s+<\/code>/, '</code>' # clear linebreak preceding closing <code>
+    end
+    if options[:after]
+      extract_tag(string, :pre, :code) do |str|
+        str.replace options[:after].call(format, str, options)
+      end
+    end
+    if format == :html
+      if options[:white_list]
+        string = options[:white_list].sanitize(string)
+      end
+      string = process_tidy(string)
+    end
+    string.strip!
+    format == :html ? "<div>#{string}</div>" : string
+  end
+
+  CODEBLOCK_RE = /^@@@( ([a-z]+)\s*)?$/
+
+  # Parse a string into a given array of [CodeBlcok, FormattedBlock, CodeBlock, FormattedBlock]
+  #
+  #   @@@ my code block
+  #   @@@ end code block
+  #
+  #   Blah blah formatted block
+  #
+  #   @@@ my code block
+  #   @@@ end code block
+  #
+  #   Blah blah formatted block
+  def self.parse_text_parts(format, options, text)
+    parts = []
+    current_part  = nil
+    in_code_block = false
+    text.split("\n").each do |line|
+      if line.rstrip =~ CODEBLOCK_RE
+        line.rstrip!
+        if in_code_block
+          parts << current_part
+          current_part = nil
+        else
+          if current_part then parts << current_part end
+          current_part = CodePart.new(format, $2)
+        end
+        in_code_block = !in_code_block
+      else
+        if !in_code_block && current_part.is_a?(CodePart)
+          parts << current_part
+          current_part = nil
+        end
+        current_part ||= FormattedPart.new(format, options)
+        current_part << line
+      end
+    end
+    parts << current_part if current_part
+    parts.compact!
+    parts.each { |p| p.compact! }
+  end
+
+  def self.extract_tag(text, *tag_names)
+    # Extract pre blocks
+    extractions = {}
+    tag_names.each do |tag_name|
+      text.gsub!(%r{<#{tag_name}[^>]*>.*?</#{tag_name}>}m) do |match|
+        md5 = Digest::MD5.hexdigest(match)
+        extractions[md5] = match
+        "{mkd-extraction-#{md5}}"
+      end
+    end
+    yield text
+    # Insert pre block extractions
+    text.gsub!(/\{mkd-extraction-([0-9a-f]{32})\}/) do
+      extractions[$1]
+    end
+    text
+  end
+
+  def self.gfm(text)
+    extract_tag(text, :pre) do |txt| 
+      # prevent foo_bar_baz from ending up with an italic word in the middle
+      text.gsub!(/(^(?! {4}|\t)\w+_\w+_\w[\w_]*)/) do |x|
+        x.gsub('_', '\_') if x.split('').sort.to_s[0..1] == '__'
+      end
+ 
+      # in very clear cases, let newlines become <br /> tags
+      #text.gsub!(/(\A|^$\n)(^\w[^\n]*\n)(^\w[^\n]*$)+/m) do |x|
+      #  x.gsub(/^(.+)$/, "\\1  ")
+      text.gsub!(/^[\w\<][^\n]*\n+/) do |x|
+        x =~ /\n{2}/ ? x : (x.strip!; x << "  \n")
+      end
+    end
+  end
+
+  begin
+    gem 'rdiscount', '>= 1.2.7.1'
+    require 'rdiscount'
+    def self.process_markdown(text)
+      RDiscount.new(text).to_html
+    end
+  rescue Gem::LoadError
+    puts "No RDiscount gem found.  `gem install rdiscount`."
+    def self.process_markdown(text)
+      text
+    end
+  end
+
+  begin
+    gem 'tidy'
+    require 'tidy'
+    Tidy.path = ENV['TIDY_PATH'] unless ENV['TIDY_PATH'].blank?
+    def self.process_tidy(text)
+      return text unless Tidy.path
+      Tidy.open(:show_body_only => true, :input_encoding => :utf8) do |tidy|
+        tidy.options.new_inline_tags = "video"
+        tidy.clean(text)
+      end
+    end
+  rescue Gem::LoadError
+    puts "No Tidy gem found.  `gem install tidy`.  Don't forget to set Tidy.path."
+    def self.process_tidy(text)
+      text
+    end
+  end
+end

data/lib/model_formatting/config.rb

@@ -0,0 +1,25 @@
+# Used to configure model formatting for a specific class. See ModelFormatting::Init
+class ModelFormatting::Config
+  attr_reader :white_list, :attributes, :context, :before_callback, :after_callback
+
+  def initialize(white_list, attributes, context)
+    @before_callback = nil
+    @after_callback  = nil
+    @white_list      = white_list
+    @attributes      = attributes
+    @context         = context
+  end
+
+  def before(&block)
+    @before_callback = block
+  end
+
+  def after(&block)
+    @after_callback = block
+  end
+
+  # replace vars in the string with a symbolized key of the same name in the context.
+  def replace_vars(string, context)
+    string.gsub!(/:([a-z_]+)/) { |m| $1 && $1.size > 0 && context[$1.to_sym] }; string
+  end
+end

data/lib/model_formatting/init.rb

@@ -0,0 +1,56 @@
+module ModelFormatting::Init
+  def self.setup_on(base)
+    base.extend self
+  end
+
+  # class Foo < ActiveRecord::Base
+  #   formats :body => :formatted_body do
+  #     # add more attributes
+  #     attributes[:title] = :full_title
+  #
+  #     # add model methods to add to the processing context
+  #     context << :project_id
+  #
+  #     # modify the sanitizer
+  #     white_list.allowed_tags << 'form'
+  #     white_list.allowed_attributes << 'class'
+  #
+  #     # add a callback for before html/markdown is processed
+  #     before do |format, text, options|
+  #
+  #     end
+  #
+  #     # add a callback for after html/markdown is processed
+  #     after do |format, text, options|
+  #
+  #     end
+  #   end
+  # end
+  #
+  def formats(*args, &block)
+    unless respond_to?(:model_formatting_attributes)
+      # use all these attributes instead of a single ModelFormatting::Config because
+      # it's easier to support subclassing.
+      class_inheritable_accessor :model_formatting_attributes, 
+        :model_formatting_white_list, :model_formatting_context, 
+        :model_formatting_before_callback, :model_formatting_after_callback
+      send :include, ModelFormatting::InstanceMethods
+      self.model_formatting_context    = []
+      self.model_formatting_attributes = {} 
+      self.model_formatting_white_list = HTML::WhiteListSanitizer.new
+      before_save :format_content_with_model_formatting
+    end
+
+    model_formatting_attributes.update args.extract_options!
+    args.each do |field|
+      model_formatting_attributes[field] = "formatted_#{field}"
+    end
+
+    if block
+      config = ModelFormatting::Config.new(model_formatting_white_list, model_formatting_attributes, model_formatting_context)
+      config.instance_eval &block
+      self.model_formatting_before_callback = config.before_callback if config.before_callback
+      self.model_formatting_after_callback  = config.after_callback  if config.after_callback
+    end
+  end
+end

data/lib/model_formatting/instance_methods.rb

@@ -0,0 +1,24 @@
+module ModelFormatting
+  module InstanceMethods
+  protected
+    def format_content_with_model_formatting
+      self.class.model_formatting_attributes.each do |original, formatted|
+        text = send(original)
+        data = \
+          if text.blank?
+            ''
+          else
+            options = {:white_list => model_formatting_white_list,
+                       :before => model_formatting_before_callback,
+                       :after => model_formatting_after_callback}
+            model_formatting_context.inject(options) do |o, attribute|
+              o.update attribute => send(attribute)
+            end
+            ModelFormatting.process(:html, text, options)
+          end
+          
+        send("#{formatted}=", data)
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+ModelFormatting::Init.setup_on ActiveRecord::Base

data/tender.patch

@@ -0,0 +1,95 @@
+Only in .: .git
+diff -ur ./lib/model_formatting/instance_methods.rb ../tender/vendor/plugins/model_formatting/lib/model_formatting/instance_methods.rb
+--- ./lib/model_formatting/instance_methods.rb	2010-07-09 10:29:14.000000000 -0700
++++ ../tender/vendor/plugins/model_formatting/lib/model_formatting/instance_methods.rb	2010-06-14 13:45:10.000000000 -0700
+@@ -2,13 +2,12 @@
+   module InstanceMethods
+   protected
+     def format_content_with_model_formatting
+-      model_formatting_attributes.each do |original, formatted|
++      self.class.model_formatting_attributes.each do |original, formatted|
+         text = send(original)
+         data = \
+           if text.blank?
+             ''
+           else
+-            text.strip!
+             options = {:white_list => model_formatting_white_list,
+                        :before => model_formatting_before_callback,
+                        :after => model_formatting_after_callback}
+diff -ur ./lib/model_formatting.rb ../tender/vendor/plugins/model_formatting/lib/model_formatting.rb
+--- ./lib/model_formatting.rb	2010-07-09 11:29:32.000000000 -0700
++++ ../tender/vendor/plugins/model_formatting/lib/model_formatting.rb	2010-02-19 14:49:00.000000000 -0800
+@@ -138,11 +138,11 @@
+     parts.each { |p| p.compact! }
+   end
+ 
+-  def self.extract_regex(text, *regexes)
++  def self.extract_tag(text, *tag_names)
+     # Extract pre blocks
+     extractions = {}
+-    regexes.each do |regex|
+-      text.gsub!(regex) do |match|
++    tag_names.each do |tag_name|
++      text.gsub!(%r{<#{tag_name}[^>]*>.*?</#{tag_name}>}m) do |match|
+         md5 = Digest::MD5.hexdigest(match)
+         extractions[md5] = match
+         "{mkd-extraction-#{md5}}"
+@@ -156,16 +156,6 @@
+     text
+   end
+ 
+-  def self.tag_name_to_regex(name)
+-    %r{<#{name}[^>]*>.*?</#{name}>}m
+-  end
+-
+-  def self.extract_tag(text, *tag_names)
+-    extract_regex text, *tag_names.map { |n| tag_name_to_regex(n) } do |text|
+-      yield text
+-    end
+-  end
+-
+   def self.gfm(text)
+     extract_tag(text, :pre) do |txt| 
+       # prevent foo_bar_baz from ending up with an italic word in the middle
+@@ -183,13 +173,13 @@
+   end
+ 
+   begin
+-    gem 'rdiscount', '~> 1.2.7.1'
++    gem 'rdiscount', '>= 1.2.7.1'
+     require 'rdiscount'
+     def self.process_markdown(text)
+       RDiscount.new(text).to_html
+     end
+   rescue Gem::LoadError
+-    puts "No RDiscount gem found.  `gem install rdiscount -v '~>1.2.7.1'`."
++    puts "No RDiscount gem found.  `gem install rdiscount`."
+     def self.process_markdown(text)
+       text
+     end
+@@ -212,4 +202,4 @@
+       text
+     end
+   end
+-end
++end
+
+Only in .: tender.patch
+diff -ur ./test/formatting_test.rb ../tender/vendor/plugins/model_formatting/test/formatting_test.rb
+--- ./test/formatting_test.rb	2010-07-09 10:29:14.000000000 -0700
++++ ../tender/vendor/plugins/model_formatting/test/formatting_test.rb	2010-02-19 14:49:00.000000000 -0800
+@@ -38,6 +38,13 @@
+         record.save
+         record.formatted_body.should == %(<div><p>booya</p></div>)
+       end
++      
++      it "preserves leading spaces in code blocks" do
++        record = Simple.new
++        record.body = "    code\n    more code\n\nnot code\n\n"
++        record.save
++        record.formatted_body.should == %(<div><pre><code>code\nmore code</code></pre>\n\n<p>not code</p></div>)
++      end
+     end
+ 
+     class Post < Base

data/test/formatting_test.rb

@@ -0,0 +1,161 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+module ModelFormatting
+  class Test < Test::Unit::TestCase
+    class Base < Struct.new(:body, :formatted_body, :title, :title_html, :bio, :full_bio)
+      ModelFormatting::Init.setup_on self
+      class_inheritable_accessor :before_save_callback
+
+      def self.before_save(method = nil)
+        if method
+          self.before_save_callback = method
+        else
+          before_save_callback
+        end
+      end
+
+      def save
+        send self.class.before_save
+      end
+    end
+
+    class Simple < Base
+      formats :body
+    end
+  
+    describe "Simple with formatting" do
+      it "has attribute from #formats arguments" do
+        Simple.model_formatting_attributes[:body].should == "formatted_body"
+      end
+
+      it "sets before_save callback" do
+        Simple.before_save.should == :format_content_with_model_formatting
+      end
+  
+      it "formats all fields" do
+        record = Simple.new
+        record.body = 'booya'
+        record.save
+        record.formatted_body.should == %(<div><p>booya</p></div>)
+      end
+      
+      it "preserves leading spaces in code blocks" do
+        record = Simple.new
+        record.body = "    code\n    more code\n\nnot code\n\n"
+        record.save
+        record.formatted_body.should == %(<div><pre><code>code\nmore code</code></pre>\n\n<p>not code</p></div>)
+      end
+    end
+
+    class Post < Base
+      formats :body, :title => :title_html do
+        attributes[:bio] = :full_bio
+
+        white_list.allowed_tags << 'table'
+
+        before do |format, text, options|
+          text.reverse!
+          text
+        end
+
+        after do |format, text, options|
+          "(#{text.strip})"
+        end
+      end
+    end
+  
+    describe "Post with formatting" do
+      it "has attribute from #formats arguments" do
+        Post.model_formatting_attributes[:body].should == "formatted_body"
+      end
+  
+      it "has attribute added from #formats options hash" do
+        Post.model_formatting_attributes[:title].should == :title_html
+      end
+  
+      it "has attribute added from #attributes  options hash" do
+        Post.model_formatting_attributes[:bio].should == :full_bio
+      end
+  
+      it "has white list sanitizer that allows table tags" do
+        Post.model_formatting_white_list.allowed_tags.should include('table')
+      end
+  
+      it "sets before_save callback" do
+        Post.before_save.should == :format_content_with_model_formatting
+      end
+
+      describe "being saved" do
+        before :all do
+          @record = Post.new
+          @record.body  = 'booya'
+          @record.title = 'wtf'
+          @record.save
+        end
+
+        it "formats #body" do
+          @record.formatted_body.should == %(<div>(<p>ayoob</p>)</div>)
+        end
+
+        it "formats #title" do
+          @record.title_html.should == %(<div>(<p>ftw</p>)</div>)
+        end
+
+        it "formats #bio" do
+          @record.full_bio.should == ''
+        end
+      end
+    end
+
+    class ChildPost < Post
+      formats do
+        attributes.delete :bio
+
+        before do |format, text, options|
+          text.upcase!
+          text
+        end
+
+        after do |format, text, options|
+          text
+        end
+      end
+    end
+  
+    describe "ChildPost with formatting" do
+      it "has attribute from #formats arguments" do
+        ChildPost.model_formatting_attributes[:body].should == "formatted_body"
+      end
+  
+      it "has attribute added from #formats options hash" do
+        ChildPost.model_formatting_attributes[:title].should == :title_html
+      end
+  
+      it "removes attribute added from superclass#attributes options hash" do
+        ChildPost.model_formatting_attributes.keys.should_not include(:bio)
+      end
+  
+      it "sets before_save callback" do
+        ChildPost.before_save.should == :format_content_with_model_formatting
+      end
+
+      describe "being saved" do
+        before :all do
+          @record = ChildPost.new
+          @record.body = 'booya'
+          @record.bio  = 'wtf'
+          @record.save
+        end
+
+        it "formats #body" do
+          @record.formatted_body.should == %(<div><p>BOOYA</p></div>)
+        end
+
+        it "skips #bio" do
+          @record.full_bio.should == nil
+        end
+      end
+    end
+  end
+end
+      

data/test/model_formatting_test.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ModelFormattingTest < Test::Unit::TestCase
+  it "parses simple string into array of single FormattedBlock" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, 'foo')
+    parts.size.should == 1
+    parts.first.class.should == ModelFormatting::FormattedPart
+    parts.first.should == 'foo'
+  end
+
+  it "parses empty code block into array of single CodeBlock" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, "@@@ foo\n@@@")
+    parts.size.should == 1
+    parts.first.class.should == ModelFormatting::CodePart
+    parts.first.should == ''
+  end
+
+  it "parses simple code block into array of single CodeBlock" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, "@@@ foo\nbar\n@@@")
+    parts.size.should == 1
+    parts.first.class.should == ModelFormatting::CodePart
+    parts.first.should == 'bar'
+  end
+
+  it "parses formatted block followed by code block into array of parts" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, "foo \n@@@ foo\nbar\n@@@")
+    parts.size.should == 2
+    parts.map { |p| p.class }.should  == [ModelFormatting::FormattedPart, ModelFormatting::CodePart]
+    parts.map { |p| p.simple_string }.should == ["foo ", "bar"]
+  end
+
+  it "parses code block followed by formatted block into array of parts" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, "@@@ foo\nbar\n@@@\n foo \n")
+    parts.size.should == 2
+    parts.map { |p| p.class }.should  == [ModelFormatting::CodePart, ModelFormatting::FormattedPart]
+    parts.map { |p| p.simple_string }.should == ["bar", " foo "]
+  end
+
+  it "parses formatted block followed by unfinished code block" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, "foo \n@@@ foo\nbar\nbaz")
+    parts.size.should == 2
+    parts.map { |p| p.class }.should  == [ModelFormatting::FormattedPart, ModelFormatting::CodePart]
+    parts.map { |p| p.simple_string }.should == ["foo ", "bar\nbaz"]
+  end
+
+  it "parses mixed blocks" do
+    parts = ModelFormatting.parse_text_parts(nil, nil, "foo \n@@@ foo\nbar\nbaz\n@@@\n\nblah blah")
+    parts.size.should == 3
+    parts.map { |p| p.class }.should  == [ModelFormatting::FormattedPart, ModelFormatting::CodePart, ModelFormatting::FormattedPart]
+    parts.map { |p| p.simple_string }.should == ["foo ", "bar\nbaz", "\nblah blah"]
+  end
+
+  it "#replace_vars replaces variables in a string with a given context" do
+    ModelFormatting::Config.new(nil, nil, nil).replace_vars("a:abc/:d_e_f/:foo!", :abc => 'bc', :d_e_f => '-').should == "abc/-/!"
+  end
+
+  it "links and encodes urls correctly" do
+    ModelFormatting.process(:html, "a *b*  \n[Whoo](http://entp.com?a=1&b=2)").should == %(<div><p>a <em>b</em><br/>\n<a href="http://entp.com?a=1&amp;b=2">Whoo</a></p></div>)
+  end
+  
+  it "converts @@@ to code blocks" do
+    ModelFormatting.process(:html, "<a>foo</a>\n\n@@@\n<a>bar</a>\n@@@\n\n@@@\nbaz\n@@@\n\n@@@ wah wah \n \n").should == %(<div><p><a>foo</a></p>\n\n<pre><code>&lt;a&gt;bar&lt;/a&gt;</code>\n</pre>\n\n\n\n\n<pre><code>baz</code>\n</pre>\n\n\n<p>@@@ wah wah</p></div>)
+  end
+  
+  it "converts @@@ with params to code blocks" do
+    ModelFormatting.process(:html, "foo\n@@@ ninja\nbar\n@@@\n@@@\nbaz\n@@@\n@@@ wah wah \n \n").should == %(<div><p>foo<br/>\n</p>\n\n<pre><code class=\"ninja\">bar</code>\n</pre>\n\n\n<pre><code>baz</code>\n</pre>\n\n\n<p>@@@ wah wah</p></div>)
+  end
+  
+  it "fixes irregular number of @@@'s" do
+    ModelFormatting.process(:html, "foo\n@@@\nbar\n@@@\n@@@\nbaz\n@@@\n@@@ wah wah \n \n@@@").should == %(<div><p>foo<br/>\n</p>\n\n<pre><code>bar</code>\n</pre>\n\n\n<pre><code>baz</code>\n</pre>\n\n\n<p>@@@ wah wah</p>\n\n<pre><code></code>\n</pre></div>)
+  end
+  
+  it "converts @@@ with params to code blocks with text format" do
+    ModelFormatting.process(:text, "foo\n@@@ ninja\nbar\n@@@\n@@@\nbaz\n@@@\n@@@ wah wah \n \n").should == %(foo\nbar\nbaz\n@@@ wah wah)
+  end
+  
+  it "fixes irregular number of @@@'s with text format" do
+    ModelFormatting.process(:text, "foo\n@@@\nbar\n@@@\n@@@\nbaz\n@@@\n@@@ wah wah \n \n@@@").should == %(foo\nbar\nbaz\n@@@ wah wah)
+  end
+  
+  it "treats linebreaks correctly" do
+    ModelFormatting.process(:html, "Line breaks should not be treated as\nnew paragraphs.  They are not paragraphs.\n\nHowever, when a line is skipped, that is a paragraph.\nGMail, and basically every comment or submission form on the \nweb work this way.").should == \
+      "<div><p>Line breaks should not be treated as<br/>\nnew paragraphs.  They are not paragraphs.</p>\n\n<p>However, when a line is skipped, that is a paragraph.<br/>\nGMail, and basically every comment or submission form on the<br/>\nweb work this way.</p></div>"
+  end
+
+  describe "GFM" do
+    it "does not touch single underscores inside words" do
+      assert_equal "foo_bar", ModelFormatting.gfm("foo_bar")
+    end
+  
+    it "does not touch underscores in code blocks" do
+      assert_equal "    foo_bar_baz", ModelFormatting.gfm("    foo_bar_baz")
+    end
+  
+    it "does not touch underscores in pre blocks" do
+      assert_equal "<pre>\nfoo_bar_baz\n</pre>", ModelFormatting.gfm("<pre>\nfoo_bar_baz\n</pre>")
+    end
+  
+    it "escapes two or more underscores inside words" do
+      assert_equal "foo\\_bar\\_baz", ModelFormatting.gfm("foo_bar_baz")
+    end
+  
+    it "turns newlines into br tags in simple cases" do
+      assert_equal "foo  \nbar", ModelFormatting.gfm("foo\nbar")
+    end
+  
+    it "converts newlines in all groups" do
+      assert_equal "apple  \npear  \norange  \nbanana\n\nruby  \npython  \nerlang  \njavascript",
+        ModelFormatting.gfm("apple\npear\norange\nbanana\n\nruby\npython\nerlang\njavascript")
+    end
+  
+    it "does not not convert newlines in lists" do
+      assert_equal "# foo\n# bar", ModelFormatting.gfm("# foo\n# bar")
+      assert_equal "* foo\n* bar", ModelFormatting.gfm("* foo\n* bar")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'action_controller'
+require 'action_view'
+require 'model_formatting'
+require 'model_formatting/init'
+require 'model_formatting/config'
+require 'model_formatting/instance_methods'
+require 'context'
+require 'matchy'
+
+begin
+  require 'ruby-debug'
+  Debugger.start
+rescue LoadError
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification 
+name: model_formatting
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- ENTP
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 5
+        - 5
+        version: 1.5.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: tidy
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeremymcanally-context
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        - 5
+        version: 0.5.5
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeremymcanally-matchy
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :development
+  version_requirements: *id007
+description: 
+email: company@entp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- README
+- tender.patch
+- lib/model_formatting/config.rb
+- lib/model_formatting/init.rb
+- lib/model_formatting/instance_methods.rb
+- lib/model_formatting.rb
+- rails/init.rb
+- test/formatting_test.rb
+- test/model_formatting_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/entp
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automatically format model attributes using rdiscount and Tender/Lighthouse extensions.
+test_files: []
+