jekyll-textile-converter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b686c1122d58c93344727d3cc56f2de6de0110b1
-  data.tar.gz: b244544e42ee63871f4e77412be64f683aee2b7d
+  metadata.gz: 09a7dd127ba4921e7b01e404aed9066173cf5d89
+  data.tar.gz: 38717e409e42c815fc070cf343aa43961ad2f6a6
 SHA512:
-  metadata.gz: 7eb6611682061fa975d9ecf77c6912a70453f25016ac493995f78603f1557e6c74f09c4f3bc4dff6137d8d08c16be2f64e019ebe3959988021ff25050e85b90d
-  data.tar.gz: c306cd98b0284042d8e79a6f6411ac37a246276350e54652fc799e9f9d573d17918b42463c4f2970697e04464ab6abb118f0e972f181152a502916f3bb48cd96
+  metadata.gz: d027a553de478371eda41e2b44d4c6f0e01d340124ecdcd471d2a0f53a5b5a3f49957ea2f925b89d827821a0070da6d884d30a7e0066e6867af5e6dde002a20e
+  data.tar.gz: dfb82fa8babb53b16ee6413774f954d5da333191be2f67a66d2e957e89d6dff79f9eeb7ff94d3eb787e2c7f1987cf136fde380e4aef9a6829a4f2039e3fdc550

data/.clash.yml

@@ -0,0 +1,6 @@
+-
+  title: Simple build
+  build: true
+-
+  title: Compare build
+  compare: _expected _site

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+spec/source/_site

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+sudo: false
+cache: bundler
+before_script: bundle update
+script: script/cibuild
+notifications:
+  email: false
+env:
+  - JEKYLL_VERSION=tip
+  - JEKYLL_VERSION=latest

data/Gemfile

@@ -2,3 +2,15 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jekyll-textile-converter.gemspec
 gemspec
+
+gem "clash", "~> 1.0"
+
+if ENV["JEKYLL_VERSION"]
+  if ENV["JEKYLL_VERSION"].eql?("tip")
+    gem "jekyll", github: "jekyll/jekyll", branch: ENV["JEKYLL_BRANCH"]
+  else
+    gem "jekyll", "2.5.3"
+  end
+else
+  gem "jekyll", ">= 2.0"
+end

data/History.markdown

@@ -0,0 +1,7 @@
+## 0.1.0 / 2014-01-17
+
+  * First working iteration.
+
+## 0.0.1 / 2014-01-17
+
+  * Birthday!

data/README.md

@@ -1,6 +1,8 @@
 # Jekyll::Textile::Converter
 
-TODO: Write a gem description
+Convert your `.textile` Jekyll content. For Jekyll 3.0 and up.
+
+[![Build Status](https://travis-ci.org/jekyll/jekyll-textile-converter.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-textile-converter)
 
 ## Installation
 
@@ -18,13 +20,27 @@ Or install it yourself as:
 
     $ gem install jekyll-textile-converter
 
+Lastly, add it to your `_config.yml` file:
+
+    gems:
+    - jekyll-textile-converter
+
 ## Usage
 
-TODO: Write usage instructions here
+Plop in a file with YAML front matter and watch Jekyll gobble it up and spit out beautiful HTML.
+
+If you'd like to use a file extension other than `.textile`, you may
+specify a comma-separated list of extensions in your `_config.yml`, like this:
+
+    textile_ext: "textile,txtl,tl"
+
+If that is the given configuration, then all files with `.textile`,
+`.txtl`, and `.tl` file extensions will be read in and interpreted as
+Textile. They must still contain YAML front matter.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/jekyll-textile-converter/fork )
+1. Fork it ( https://github.com/jekyll/jekyll-textile-converter/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/jekyll-textile-converter.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/textile/converter/version'
+require 'jekyll-textile-converter/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-textile-converter"
-  spec.version       = Jekyll::Textile::Converter::VERSION
+  spec.version       = Jekyll::TextileConverter::VERSION
   spec.authors       = ["Parker Moore"]
   spec.email         = ["parkrmoore@gmail.com"]
   spec.summary       = %q{Textile converter for Jekyll.}
@@ -17,6 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "RedCloth", "~> 4.0"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/jekyll-textile-converter.rb

@@ -0,0 +1,12 @@
+require 'jekyll'
+
+root = File.expand_path('jekyll-textile-converter', File.dirname(__FILE__))
+require "#{root}/filters"
+require "#{root}/version"
+
+require File.expand_path('jekyll/converters/textile', File.dirname(__FILE__))
+
+module Jekyll
+  module TextileConverter
+  end
+end

data/lib/jekyll-textile-converter/filters.rb

@@ -0,0 +1,18 @@
+module Jekyll
+  module Filters
+    # Convert a Textile string into HTML output.
+    #
+    # input - The Textile String to convert.
+    #
+    # Returns the HTML formatted String.
+    def textilize(input)
+      site = @context.registers[:site]
+      converter = if site.respond_to?(:find_converter_instance)
+        site.find_converter_instance(Jekyll::Converters::Textile)
+      else
+        site.getConverterImpl(Jekyll::Converters::Textile)
+      end
+      converter.convert(input)
+    end
+  end
+end

data/lib/jekyll-textile-converter/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module TextileConverter
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/converters/textile.rb

@@ -0,0 +1,65 @@
+module Jekyll
+  module Converters
+    class Textile < Converter
+      safe true
+
+      highlighter_prefix '<notextile>'
+      highlighter_suffix '</notextile>'
+
+      DEFAULT_CONFIGURATION = {
+        'textile_ext' => 'textile',
+        'redcloth' => {
+          'hard_breaks' => true
+        }
+      }
+
+      def initialize(config = {})
+        @config = Jekyll::Utils.deep_merge_hashes(DEFAULT_CONFIGURATION, config)
+        @setup = false
+      end
+
+      def setup
+        return if @setup
+        require 'redcloth'
+        @setup = true
+      rescue LoadError
+        STDERR.puts 'You are missing a library required for Textile. Please run:'
+        STDERR.puts '  $ [sudo] gem install RedCloth'
+        raise Errors::FatalException.new("Missing dependency: RedCloth")
+      end
+
+      def extname_list
+        @extname_list ||= @config['textile_ext'].split(',').map { |e| ".#{e}" }
+      end
+
+      def matches(ext)
+        extname_list.include? ext.downcase
+      end
+
+      def output_ext(ext)
+        ".html"
+      end
+
+      def convert(content)
+        setup
+
+        # Shortcut if config doesn't contain RedCloth section
+        return RedCloth.new(content).to_html if @config['redcloth'].nil?
+
+        # List of attributes defined on RedCloth
+        # (from https://github.com/jgarber/redcloth/blob/master/lib/redcloth/textile_doc.rb)
+        attrs = ['filter_classes', 'filter_html', 'filter_ids', 'filter_styles',
+                'hard_breaks', 'lite_mode', 'no_span_caps', 'sanitize_html']
+
+        r = RedCloth.new(content)
+
+        # Set attributes in r if they are NOT nil in the config
+        attrs.each do |attr|
+          r.instance_variable_set("@#{attr}".to_sym, @config['redcloth'][attr]) unless @config['redcloth'][attr].nil?
+        end
+
+        r.to_html
+      end
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle install -j8 $@

data/script/cibuild

@@ -0,0 +1,2 @@
+#!/bin/bash
+script/test $@ && script/clash

data/script/clash

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec clash spec/source

data/script/test

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec rspec --color --require spec_helper $@

data/spec/source/_config.yml

@@ -0,0 +1,2 @@
+gems:
+- jekyll-textile-converter

data/spec/source/_expected/2015/01/17/my-textile-post.html

@@ -0,0 +1,3 @@
+<h2>a post about textile</h2>
+<p>line 1<br />
+line 2</p>

data/spec/source/_expected/index.html

@@ -0,0 +1,3 @@
+<h1>Testing the textilize filter</h1>
+
+<p>this is a paragraph</p>

data/spec/source/_posts/2015-01-17-my-textile-post.textile

@@ -0,0 +1,8 @@
+---
+title: My textile post
+---
+
+h2. a post about textile
+
+p. line 1
+line 2

data/spec/source/index.html

@@ -0,0 +1,6 @@
+---
+---
+
+<h1>Testing the textilize filter</h1>
+
+{{ "p. this is a paragraph" | textilize }}

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'jekyll'
+require File.expand_path('../../lib/jekyll-textile-converter', __FILE__)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+
+  config.warnings = false
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/textile_converter_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+RSpec.describe(Jekyll::Converters::Textile) do
+  let(:configs)   { Hash.new }
+  let(:converter) { described_class.new(configs) }
+
+  context "configuration" do
+
+    context "`redcloth`" do
+      context "no explicit config" do
+        it "preserves single line breaks in HTML output" do
+          expect(converter.convert("p. line1\nline2").strip).to eq("<p>line1<br />\nline2</p>")
+        end
+      end
+
+      context "empty redcloth config" do
+        let(:configs)   { {'redcloth' => Hash.new} }
+
+        it "preserves single line breaks in HTML output" do
+          expect(converter.convert("p. line1\nline2").strip).to eq("<p>line1<br />\nline2</p>")
+        end
+      end
+
+      context "explicity enabled hard_breaks" do
+        let(:configs) { {'redcloth' => {'hard_breaks' => true}} }
+
+        it "preserves single line breaks in HTML output" do
+          expect(converter.convert("p. line1\nline2").strip).to eq("<p>line1<br />\nline2</p>")
+        end
+      end
+
+      context "explicity disabled hard_breaks" do
+        let(:configs) { {'redcloth' => {'hard_breaks' => false}} }
+
+        it "does not generate break tags in HTML output" do
+          expect(converter.convert("p. line1\nline2").strip).to eq("<p>line1\nline2</p>")
+        end
+      end
+
+      context "explicity disabled no_span_caps" do
+        let(:configs) { {'redcloth' => {'no_span_caps' => false}} }
+
+        it "generates span tags around capitalized words" do
+          expect(converter.convert("NSC").strip).to eq("<p><span class=\"caps\">NSC</span></p>")
+        end
+      end
+
+      context "explicitly enabled no_span_caps" do
+        let(:configs) { {'redcloth' => {'no_span_caps' => true}} }
+
+        it "does generates span tags around capitalized words" do
+          expect(converter.convert("NSC").strip).to eq("<p>NSC</p>")
+        end
+      end
+    end
+
+    context "`textile_ext`" do
+      context "with a custom list including the default" do
+        let(:configs) { {'textile_ext' => 'textile,text'} }
+
+        it "matches the new ext" do
+          expect(converter.matches('.text')).to be_truthy
+        end
+
+        it "matches the old ext" do
+          expect(converter.matches('.textile')).to be_truthy
+        end
+      end
+
+      context "with a replacement ext" do
+        let(:configs) { {'textile_ext' => 'text'} }
+
+        it "matches the new ext" do
+          expect(converter.matches('.text')).to be_truthy
+        end
+
+        it "doesn't match the old ext" do
+          expect(converter.matches('.textile')).to be_falsy
+        end
+      end
+    end
+  end
+
+  context "in code blocks" do
+    let(:content) do
+      <<-CONTENT
+_FIGHT!_
+
+{% highlight ruby %}
+puts "3..2..1.."
+{% endhighlight %}
+
+*FINISH HIM*
+CONTENT
+    end
+
+    # Broken in RedCloth 4.1.9
+    it "does not textilize highlight block" do
+      expect(converter.convert(content)).not_to match(%r{3\.\.2\.\.1\.\.&quot;</span><br />})
+    end
+  end
+
+end

data/spec/textilize_filter_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+RSpec.describe(Jekyll::Filters) do
+  class JekyllFilter
+    include Jekyll::Filters
+    attr_accessor :site, :context
+
+    def initialize(opts = {})
+      @site = Jekyll::Site.new(Jekyll::Configuration::DEFAULTS)
+      @context = Liquid::Context.new({}, {}, { :site => @site })
+    end
+  end
+
+  let(:filter) { JekyllFilter.new }
+
+  it "should convert textile" do
+    expect(filter.textilize("something *really* simple")).to eq("<p>something <strong>really</strong> simple</p>")
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-textile-converter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-01-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - parkrmoore@gmail.com
@@ -45,14 +73,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".clash.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
+- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile
 - jekyll-textile-converter.gemspec
-- lib/jekyll/textile/converter.rb
-- lib/jekyll/textile/converter/version.rb
+- lib/jekyll-textile-converter.rb
+- lib/jekyll-textile-converter/filters.rb
+- lib/jekyll-textile-converter/version.rb
+- lib/jekyll/converters/textile.rb
+- script/bootstrap
+- script/cibuild
+- script/clash
+- script/test
+- spec/source/_config.yml
+- spec/source/_expected/2015/01/17/my-textile-post.html
+- spec/source/_expected/index.html
+- spec/source/_posts/2015-01-17-my-textile-post.textile
+- spec/source/index.html
+- spec/spec_helper.rb
+- spec/textile_converter_spec.rb
+- spec/textilize_filter_spec.rb
 homepage: https://github.com/jekyll/jekyll-textile-converter
 licenses:
 - MIT
@@ -77,4 +122,12 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Textile converter for Jekyll.
-test_files: []
+test_files:
+- spec/source/_config.yml
+- spec/source/_expected/2015/01/17/my-textile-post.html
+- spec/source/_expected/index.html
+- spec/source/_posts/2015-01-17-my-textile-post.textile
+- spec/source/index.html
+- spec/spec_helper.rb
+- spec/textile_converter_spec.rb
+- spec/textilize_filter_spec.rb

data/lib/jekyll/textile/converter.rb

@@ -1,9 +0,0 @@
-require "jekyll/textile/converter/version"
-
-module Jekyll
-  module Textile
-    module Converter
-      # Your code goes here...
-    end
-  end
-end

data/lib/jekyll/textile/converter/version.rb

@@ -1,7 +0,0 @@
-module Jekyll
-  module Textile
-    module Converter
-      VERSION = "0.0.1"
-    end
-  end
-end