maruku_snippet 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rvmrc

@@ -0,0 +1,3 @@
+
+rvm_gemset_create_on_use_flag=1
+rvm 1.9.2@maruku-snippet

data/Gemfile

@@ -0,0 +1,14 @@
+
+source :rubygems
+#If this is a gem
+#Normal gems go in maruku-snippet.gemspec
+gemspec
+
+#development and test not install on heroku deployment
+group :development do
+
+end
+
+group :test do
+  gem "rspec", :require => "spec"
+end

data/LICENSE

@@ -0,0 +1,25 @@
+
+Copyright (c) 2012, Morgan Prior
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+* Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+* Neither the name of the organization nor the
+names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,37 @@
+maruku-snippet
+==============
+
+Extends MaRuKu markdown parsing to adding .to_html_snippet(lines).  
+A simpe way to generate document previews with out breaking links. 
+
+This might be useful for you main blog roll page to show a paragraph
+from your last 10 posts, each followed by a read more link
+
+Install
+==
+
+    gem install maruku_snippet
+    
+Usage
+==
+
+This just addes the to_html_snippet(lines) method to maruku, everything else stays the same.
+
+    require 'maruku_snippet'
+
+    doc = MarukuSnippet.new(markdown_string)
+    puts doc.to_html_snippet(10)
+
+Maruku would be:
+
+    require 'maruku'
+
+    doc = Maruku.new(markdown_string)
+    puts doc.to_html
+
+Markdown Syntax
+==
+
+For syntax see [DaringFireball][].
+
+[DaringFireball]: http://daringfireball.net/projects/markdown/syntax

data/Rakefile

@@ -0,0 +1,12 @@
+
+require 'rspec/core/rake_task'
+
+file_list = FileList['spec/*_spec.rb']
+
+RSpec::Core::RakeTask.new('spec') do |t|
+t.pattern = file_list
+t.rspec_opts = ["--colour", "--format progress"]
+end
+
+desc 'Default: run specs.'
+task :default => 'spec'

data/lib/maruku_snippet.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+require 'maruku'
+
+module MaRuKuSnippet
+  VERSION = '0.0.1'
+end
+
+## ruby 1.9.2+ methods first fall back to 1.8 style 
+begin
+  require_relative 'maruku_snippet/maruku_snippet_document'
+rescue
+  require 'maruku_snippet/maruku_snippet_document'
+end
+
+# This is the public interface
+class MarukuSnippet < MaRuKuSnippet::Document; 
+end
+

data/lib/maruku_snippet/maruku_snippet_document.rb

@@ -0,0 +1,62 @@
+module MaRuKuSnippet
+  class Document
+
+    def initialize( markdown )
+      @markdown = markdown
+    end
+
+    ## TODO or maybe not, we currently cut styling  -- == underlining if it is on the line after the cut off length.
+    # would you want a snippet ending with a heading though?
+
+    def to_html_snippet( lines=-1 )
+      if lines == -1
+        return Maruku.new(@markdown).to_html 
+      else
+
+        markdown_a    = @markdown.split("\n")
+        markdown_temp = (markdown_a[0...lines]).join("\n")
+
+        ## Is the input text longer than cut off length
+        if markdown_a.size > lines
+          ## Are we mid table ?
+          mid_table       = false
+          if markdown_a[lines-1].match(/\|/) and markdown_a[lines].match(/\|/)
+            mid_table = true
+          end
+
+          ## Looking for markdown elements we can not break (Link targets, tables)
+          (markdown_a[lines...(markdown_a.size)]).each_with_index do |text, index| 
+            ## Make sure keep link targets
+            if text.match(/^[ \t ]*\[[\W\w]*\]:[\W\w]*/)
+              markdown_temp << "\n" + text
+            end
+
+            if mid_table
+              #Still parsing table or have we finished
+              if text.match(/\|/) 
+                markdown_temp << "\n" + text
+              else
+                mid_table        = false
+              end
+            end
+
+          end
+        end
+        return Maruku.new(markdown_temp).to_html   
+      end
+    end
+
+    ## Delegate to to Maruku via method missing
+    def method_missing(method, *args, &block)
+      delegate = Maruku.new( @markdown )
+      if delegate.respond_to? method
+        return delegate.send(method)
+      else
+        raise NoMethodError
+      end
+    end
+  end
+
+end
+
+

data/maruku_snippet.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib")
+require 'maruku_snippet'
+
+Gem::Specification.new do |s|
+s.name        = 'maruku_snippet'
+s.version     = MaRuKuSnippet::VERSION
+s.platform    = Gem::Platform::RUBY
+s.authors     = ["Morgan Prior"]
+s.email       = ["maruku_snippet@amaras-tech.co.uk"]
+s.homepage    = "http://github.com/morganp/maruku_snippet"
+s.summary     = %q{Just like Maruku but with snippets }
+s.description = %q{maruku_snippet adds the to_html_snippet(lines) method.
+All existing features of Maruku are delegated to Maruku.}
+
+s.files         = `git ls-files`.split("\n")
+s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+s.executables   = `git ls-files -- bin/*`.split("").map{ |f| File.basename(f) }
+s.require_paths = ["lib"]
+
+s.add_dependency('maruku', '>= 0.6.0')
+end

data/spec/maruku_snippet_spec.rb

@@ -0,0 +1,25 @@
+
+require 'spec_helper'
+
+describe MarukuSnippet do
+  it "Parse complete Markdown" do
+    basic_md = "line1  \n[line2][]  \nline3  \nline4  \nline5  \n[line2]: http://google.co.uk"
+    test = MarukuSnippet.new( basic_md )
+
+    test.to_html.should == %{<p>line1<br /><a href='http://google.co.uk'>line2</a><br />line3<br />line4<br />line5</p>}
+
+    snippet = test.to_html_snippet(10)
+    snippet.should == %{<p>line1<br /><a href='http://google.co.uk'>line2</a><br />line3<br />line4<br />line5</p>}
+  end
+
+  it "Parse limited markdown with out breaking links" do
+    basic_md = "line1  \n[line2][]  \nline3  \nline4  \nline5  \n[line2]: http://google.co.uk"
+    test = MarukuSnippet.new( basic_md )
+
+    test.to_html.should == %{<p>line1<br /><a href='http://google.co.uk'>line2</a><br />line3<br />line4<br />line5</p>}
+
+    snippet = test.to_html_snippet(3)
+    snippet.should == %{<p>line1<br /><a href='http://google.co.uk'>line2</a><br />line3</p>}
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rspec'
+require 'maruku_snippet'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: maruku_snippet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Morgan Prior
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: &2153294820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153294820
+description: ! 'maruku_snippet adds the to_html_snippet(lines) method.
+
+  All existing features of Maruku are delegated to Maruku.'
+email:
+- maruku_snippet@amaras-tech.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/maruku_snippet.rb
+- lib/maruku_snippet/maruku_snippet_document.rb
+- maruku_snippet.gemspec
+- spec/maruku_snippet_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/morganp/maruku_snippet
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Just like Maruku but with snippets
+test_files:
+- spec/maruku_snippet_spec.rb
+- spec/spec_helper.rb