model_formatting 0.5 → 0.6.6

data/Gemfile

@@ -3,9 +3,9 @@ source "http://gem.entp.com"
 
 gem 'rake'
 gem 'redcarpet', '~> 2.2'
-gem 'actionpack', '~> 3.0.0'
-gem 'activerecord', '~> 3.0.0'
-gem 'activesupport', '~> 3.0.0'
+gem 'actionpack', '~> 3.2'
+gem 'activerecord', '~> 3.2'
+gem 'activesupport', '~> 3.2'
 gem 'tidy_ffi', '~> 0.1.2'
 
 group :development, :test do

data/Gemfile.lock

@@ -2,55 +2,63 @@ GEM
   remote: http://rubygems.org/
   remote: http://gem.entp.com/
   specs:
-    abstract (1.0.0)
-    actionpack (3.0.12)
-      activemodel (= 3.0.12)
-      activesupport (= 3.0.12)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.5)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.12)
-      activesupport (= 3.0.12)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.12)
-      activemodel (= 3.0.12)
-      activesupport (= 3.0.12)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.12)
-    arel (2.0.10)
-    builder (2.1.2)
+    actionpack (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.15)
+      activesupport (= 3.2.15)
+      builder (~> 3.0.0)
+    activerecord (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.15)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
     context (0.5.5)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
+    erubis (2.7.0)
     ffi (1.0.10)
-    i18n (0.5.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    journey (1.0.4)
     matchy (0.4.0)
-    rack (1.2.5)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    multi_json (1.8.2)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
       rack (>= 1.0)
     rake (0.9.2)
     redcarpet (2.2.2)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
     tidy_ffi (0.1.3)
       ffi (>= 0.3.5)
-    tzinfo (0.3.32)
+    tilt (1.4.1)
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 3.0.0)
-  activerecord (~> 3.0.0)
-  activesupport (~> 3.0.0)
+  actionpack (~> 3.2)
+  activerecord (~> 3.2)
+  activesupport (~> 3.2)
   context (= 0.5.5)
   matchy (~> 0.4.0)
   rake
-  redcarpet
+  redcarpet (~> 2.2)
   tidy_ffi (~> 0.1.2)

data/README

@@ -1,3 +1,9 @@
-This is a plugin for Rails 2.2.x that performs automatic text-to-html formatting.
+This is a plugin for Rails that performs automatic text-to-html formatting. 
+
+For rails 2.3, please use the 'rails23' branch (you can specify ~> 0.2 in your gemfile)
+
+It uses the 'redcarpet' markdown library with a few other pre-processing steps.
+Note: tests do not run on 1.9.x series due to a bug in the test frameworks we use,
+but the code works fine.
 
 It is extracted from and used by [Tender](http://tenderapp.com/) and [Lighthouse](http://lighthouseapp.com/).

data/Rakefile

@@ -1,21 +1,22 @@
 require 'rubygems/package_task'
-require 'rake/testtask'
+# require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = "model_formatting"
-  s.version = "0.5"
+  s.version = "0.6.6"
   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 redcarpet (markdown) and Tender/Lighthouse extensions."
+  s.summary = "Automatically format model attributes using Redcarpet (markdown) and Tender/Lighthouse extensions."
+  s.description = s.summary
   s.files = FileList['[a-zA-Z]*', 'bin/*', 'lib/**/*', 'rails/**/*', 'test/**/*']
   s.has_rdoc = false
   s.extra_rdoc_files = ["README"]
   s.add_dependency("redcarpet", "~>2.2")
-  s.add_dependency("actionpack", "~>3.0.0")
-  s.add_dependency("activerecord", "~>3.0.0")
-  s.add_dependency("activesupport", "~>3.0.0")
+  s.add_dependency("actionpack", "~>3.2")
+  s.add_dependency("activerecord", "~>3.2")
+  s.add_dependency("activesupport", "~>3.2")
   s.add_dependency("tidy_ffi", "~>0.1.2")
   s.add_development_dependency("jeremymcanally-context", "~>0.5.5")
   s.add_development_dependency("jeremymcanally-matchy", "~>0.1.0")
@@ -27,7 +28,3 @@ Gem::PackageTask.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

@@ -1,5 +1,6 @@
 require 'cgi'
 require 'active_support' # NilClass#blank?
+require 'redcarpet_custom'
 module ModelFormatting
   class Part < Array
     attr_reader :format
@@ -97,7 +98,7 @@ module ModelFormatting
     format == :html ? "<div>#{string}</div>" : string
   end
 
-  CODEBLOCK_RE = /^@@@( ([a-z]+)\s*)?$/
+  CODEBLOCK_RE = /^(@@@|```)( ([a-z]+)\s*)?$/
 
   # Parse a string into a given array of [CodeBlcok, FormattedBlock, CodeBlock, FormattedBlock]
   #
@@ -122,7 +123,7 @@ module ModelFormatting
           current_part = nil
         else
           if current_part then parts << current_part end
-          current_part = CodePart.new(format, $2)
+          current_part = CodePart.new(format, $3)
         end
         in_code_block = !in_code_block
       else
@@ -178,11 +179,6 @@ module ModelFormatting
 
   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  ")
@@ -195,14 +191,12 @@ module ModelFormatting
   begin
     require 'redcarpet'
     def self.process_markdown(text)
-      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::Custom,
         :no_intra_emphasis => true,
         :tables => true,
         :fenced_code_blocks => true,
-        :space_after_headers => true,
-#        :hard_wrap => true, 
-#        :with_toc_data => true, 
-        :autolink => true).render(text)
+        :space_after_headers => true
+      ).render(text)
     end
   rescue LoadError
     puts "No Redcarpet gem found.  `gem install redcarpet`."

data/lib/model_formatting/init.rb

@@ -31,7 +31,7 @@ module ModelFormatting::Init
     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, 
+      class_attribute :model_formatting_attributes, 
         :model_formatting_white_list, :model_formatting_context, 
         :model_formatting_before_callback, :model_formatting_after_callback
       send :include, ModelFormatting::InstanceMethods

data/lib/redcarpet_custom.rb

@@ -0,0 +1,27 @@
+require 'redcarpet'
+module Redcarpet::Render
+  class Custom < HTML
+    # include Redcarpet::Render::HTML
+    def header(title, level)
+      @headers ||= []
+      # you can use this permalink style: 1-foo-bar with the level in it
+      # permalink = "#{level}-#{title.gsub(/\W+/, "-")}"
+      
+      # .. or just use title. you might like a better regex here, too
+      permalink = title.gsub(/\W+/, "-").downcase
+      
+      # for extra credit: implement this as its own method
+      if @headers.include?(permalink)
+        permalink += "_1"
+         # my brain hurts
+        loop do
+          break if !@headers.include?(permalink)
+          # generate titles like foo-bar_1, foo-bar_2
+          permalink.gsub!(/\_(\d+)$/, "_#{$1.to_i + 1}")
+        end
+      end
+      @headers << permalink
+      %(\n<h#{level} id=\"#{permalink}\"><a name="#{permalink}" class="anchor" href="##{permalink}"></a>#{title}</h#{level}>\n)
+    end
+  end
+end

data/test/formatting_test.rb

@@ -5,7 +5,7 @@ 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
+      class_attribute :before_save_callback
 
       def self.before_save(method = nil)
         if method

data/test/model_formatting_test.rb

@@ -7,6 +7,11 @@ class ModelFormattingTest < Test::Unit::TestCase
     parts.first.class.should == ModelFormatting::FormattedPart
     parts.first.should == 'foo'
   end
+  
+  it "generates TOC titles" do
+   ModelFormatting.process(:html, "# Title One\n\n# Title Two\n\n## Title One").should == \
+     "<div><h1 id=\"title-one\"><a name=\"title-one\" class=\"anchor\" href=\n\"#title-one\" id=\"title-one\"></a>Title One</h1>\n<h1 id=\"title-two\"><a name=\"title-two\" class=\"anchor\" href=\n\"#title-two\" id=\"title-two\"></a>Title Two</h1>\n<h2 id=\"title-one_1\"><a name=\"title-one_1\" class=\"anchor\" href=\n\"#title-one_1\" id=\"title-one_1\"></a>Title One</h2></div>"
+  end
 
   it "parses empty code block into array of single CodeBlock" do
     parts = ModelFormatting.parse_text_parts(nil, nil, "@@@ foo\n@@@")
@@ -105,8 +110,8 @@ class ModelFormattingTest < Test::Unit::TestCase
       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")
+    it "does not touch 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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: model_formatting
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 5
-  version: "0.5"
+  - 6
+  - 6
+  version: 0.6.6
 platform: ruby
 authors: 
 - ENTP
@@ -14,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-19 00:00:00 Z
+date: 2013-10-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: redcarpet
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -29,60 +28,57 @@ dependencies:
         - 2
         - 2
         version: "2.2"
+  requirement: *id001
+  prerelease: false
+  name: redcarpet
   type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: actionpack
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 3
-        - 0
-        - 0
-        version: 3.0.0
+        - 2
+        version: "3.2"
+  requirement: *id002
+  prerelease: false
+  name: actionpack
   type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 3
-        - 0
-        - 0
-        version: 3.0.0
+        - 2
+        version: "3.2"
+  requirement: *id003
+  prerelease: false
+  name: activerecord
   type: :runtime
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 3
-        - 0
-        - 0
-        version: 3.0.0
+        - 2
+        version: "3.2"
+  requirement: *id004
+  prerelease: false
+  name: activesupport
   type: :runtime
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: tidy_ffi
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -93,12 +89,12 @@ dependencies:
         - 1
         - 2
         version: 0.1.2
+  requirement: *id005
+  prerelease: false
+  name: tidy_ffi
   type: :runtime
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: jeremymcanally-context
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -109,12 +105,12 @@ dependencies:
         - 5
         - 5
         version: 0.5.5
+  requirement: *id006
+  prerelease: false
+  name: jeremymcanally-context
   type: :development
-  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: jeremymcanally-matchy
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -125,9 +121,11 @@ dependencies:
         - 1
         - 0
         version: 0.1.0
+  requirement: *id007
+  prerelease: false
+  name: jeremymcanally-matchy
   type: :development
-  version_requirements: *id007
-description: 
+description: Automatically format model attributes using Redcarpet (markdown) and Tender/Lighthouse extensions.
 email: company@entp.com
 executables: []
 
@@ -138,13 +136,14 @@ extra_rdoc_files:
 files: 
 - Gemfile
 - Gemfile.lock
-- README
 - Rakefile
+- README
 - bin/model_formatting
-- lib/model_formatting.rb
 - lib/model_formatting/config.rb
 - lib/model_formatting/init.rb
 - lib/model_formatting/instance_methods.rb
+- lib/model_formatting.rb
+- lib/redcarpet_custom.rb
 - rails/init.rb
 - test/fixtures/mkd-extraction.txt
 - test/formatting_test.rb
@@ -182,6 +181,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Automatically format model attributes using redcarpet (markdown) and Tender/Lighthouse extensions.
+summary: Automatically format model attributes using Redcarpet (markdown) and Tender/Lighthouse extensions.
 test_files: []