writedown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff8da87d42e5c852fc414144e24aa900ba2ad103
+  data.tar.gz: bfdcd2f44d8d44342dfb5dab9b7e2ef8bc9dc9ed
+SHA512:
+  metadata.gz: d5e6839151cf4b8ef4350df81db371fbabde01ee8c911443af5916ada6c7a9c1f3fcaa85f5c563352d14123fead09b355f8834b1d3eb8fa191b73698d2898530
+  data.tar.gz: '0582b54d6f3d5501882687e657a22a9c29fda420ff0fd2533285a98d5ca675503855f2aff992da5cf7b83bf07b18e4ff8daf063e18a125773c644ad5af2f9397'

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.travis.yml

@@ -0,0 +1,10 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=4a802850f20f8a5a315c700bd20153cc452ddb11b299f67ab994fc0199278d86
+language: ruby
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'byebug',    '~> 9.0'
+  gem 'rake',      '~> 12.0'
+  gem 'minitest',  '~> 5.10'
+  gem 'simplecov', '~> 0.15.0'
+  gem 'sinatra',   '~> 2.0'
+  gem 'thin',      '~> 1.7'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adam Hollett
+
+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.md

@@ -0,0 +1,130 @@
+# Writedown
+
+[![Travis](https://img.shields.io/travis/adamhollett/writedown.svg)](https://travis-ci.org/adamhollett/writedown)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/adamhollett/writedown.svg)](https://codeclimate.com/github/adamhollett/writedown)
+[![Code Climate](https://img.shields.io/codeclimate/c/adamhollett/writedown.svg)](https://codeclimate.com/github/adamhollett/writedown)
+
+**Writedown** is an enhanced renderer for [kramdown](https://github.com/gettalong/kramdown), the pure Ruby markdown converter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'writedown'
+```
+
+Then execute:
+
+``` shell
+bundle
+```
+
+or install it yourself with:
+
+``` shell
+gem install writedown
+```
+
+## Usage
+
+After installing the gem, replace instances of `Kramdown::Document#to_html` in your code with `Kramdown::Document#to_writedown`.
+
+## Features
+
+### Asides
+
+You can render asides or "margin notes" using an extended blockquote syntax:
+
+Markdown
+
+``` markdown
+> Note:
+> Don't forget to turn off the power.
+```
+
+HTML
+
+``` html
+<aside class="aside aside--note">
+  <h4>Note</h4>
+  <p>Don't forget to turn off the power.</p>
+</aside>
+```
+
+### Checkboxes
+
+You can render checkboxes in paragraphs or list items by adding a box to the beginning of the item. Fill the box with an `x` to have it pre-checked when the page is rendered:
+
+Markdown
+
+``` markdown
+- [ ] Buy dog food
+- [ ] Pick up laundry
+- [x] Pay bills
+```
+
+HTML
+
+``` html
+<ul>
+  <li>
+    <p>
+      <input type="checkbox" id="checkbox-1" />
+      <label for "checkbox-1">Buy dog food</label>
+    </p>
+  </li>
+  <li>
+    <p>
+      <input type="checkbox" id="checkbox-2" />
+      <label for "checkbox-2">Pick up laundry</label>
+    </p>
+  </li><li>
+    <p>
+      <input type="checkbox" id="checkbox-3" checked="checked" />
+      <label for "checkbox-3">Pay bills</label>
+    </p>
+  </li>
+</ul>
+```
+
+### Figures
+
+You can convert an image into an HTML5 figure by placing it on its own line without any other text. Passing a title to the image renders the title as a figure caption:
+
+Markdown
+
+``` markdown
+![A still life with fruits and flowers](picture.jpg "Still life")
+```
+
+HTML
+
+``` html
+<figure>
+  <img src="picture.jpg" alt="A still life with fruits and flowers" title="Still life" />
+  <figcaption>Still life</figcaption>
+</figure>
+```
+
+### Image dimensions
+
+If you embed a local image, Writedown uses [fastimage](https://github.com/sdsykes/fastimage) to check the image's dimensions and pass them to the HTML:
+
+``` markdown
+![](picture.jpg)
+```
+
+HTML
+
+``` html
+<img src="picture.jpg" alt="" width="640" height="480" />
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+task t: :test
+
+desc 'Start a console session'
+task :console do
+  sh 'ruby bin/console'
+end
+task c: :console
+
+desc 'Start a server to test Writedown in a browser'
+task :server do
+  sh 'ruby test/app/app.rb'
+end
+task s: :server
+
+desc 'Check dependencies'
+task :bundle do
+  sh 'bundle --quiet'
+end

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'kramdown'
+require 'writedown'
+require 'irb'
+
+IRB.start(__FILE__)

data/lib/kramdown/converter/writedown.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# TODO: - [x] Asides (note blocks)
+#       - [x] Checkboxes
+#             Give checkboxes IDs from the line number in the source document
+#       - [x] Checkboxes pre-filled with Xs
+#       - [x] Figures
+#       - [ ] Video embeds
+
+module Kramdown
+  module Converter
+    class Writedown < Html
+      include ::Writedown::Image
+      include ::Writedown::Aside
+      include ::Writedown::Checkbox
+      include ::Writedown::Figure
+
+      def convert_blockquote(el, indent)
+        if el.children.first.children.first.value =~ ASIDE_PATTERN
+          convert_aside(el, indent)
+        else
+          super
+        end
+      end
+
+      def convert_p(el, indent)
+        if el.children.size == 1 && el.children.first.type == :img
+          convert_figure(el, indent)
+        elsif el.children.first.value =~ CHECKBOX_PATTERN
+          convert_checkbox(el, indent)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/writedown.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+require 'writedown/utils'
+require 'writedown/image'
+require 'writedown/aside'
+require 'writedown/checkbox'
+require 'writedown/figure'
+require 'writedown/version'

data/lib/writedown/aside.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Writedown
+  module Aside
+    ASIDE_HEADINGS = %w(
+      note
+      info information tip
+      caution warning danger
+    )
+
+    ASIDE_PATTERN = /(#{ASIDE_HEADINGS.join('|')}):?\n/i
+
+    def convert_aside(el, indent)
+      el.type = :aside
+      text_content = el.children.first.children.first.value
+
+      # Determine the heading string used
+      heading_text = text_content.match(ASIDE_PATTERN)[1]
+
+      base_class    = 'aside'
+      aside_classes = [base_class]
+      heading_slug  = Writedown::Utils.slugify(heading_text)
+      aside_classes << "aside--#{heading_slug}" unless heading_slug == base_class
+
+      el.attr[:class] = aside_classes.join(' ')
+
+      # Remove the note pattern from the body contents
+      text_content.sub!(ASIDE_PATTERN, '')
+
+      heading_element = Kramdown::Element.new(:header, nil, nil, level: 4, raw_text: heading_text)
+      heading_element.children << Kramdown::Element.new(:text, heading_text.capitalize)
+
+      el.children.unshift(heading_element)
+
+      format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+    end
+  end
+end

data/lib/writedown/checkbox.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Writedown
+  module Checkbox
+    CHECKBOX_PATTERN = /^\[([ xX]?)\] ?/
+
+    def convert_checkbox(el, indent)
+      text_content = el.children.first.value
+
+      el.options[:transparent] = false
+      box_contents = text_content.match(CHECKBOX_PATTERN)[1]
+      text_content = text_content.sub(CHECKBOX_PATTERN, '')
+      checked = 'checked' if box_contents =~ /[xX]/
+      id = "checkbox-#{el.options[:location]}"
+
+      el.children = []
+
+      # Create the input element
+      input_attrs = { type: 'checkbox', id: id, checked: checked }
+      input_element = Kramdown::Element.new(
+        :html_element, :input, input_attrs, category: :block, content_model: :raw, is_closed: true
+      )
+
+      # Create the label
+      label_element = Kramdown::Element.new(:html_element, :label, { for: id }, category: :span, content_model: :span)
+      label_element.children << Kramdown::Element.new(:text, text_content)
+
+      el.children << input_element
+      el.children << label_element
+
+      format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+    end
+  end
+end

data/lib/writedown/figure.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Writedown
+  module Figure
+    def convert_figure(el, indent)
+      el.type = :figure
+
+      caption = el.children.first.attr['title']
+      if caption
+        caption_text = Kramdown::Element.new(:text, caption)
+        caption_element = Kramdown::Element.new(:html_element, :figcaption, nil, category: :block)
+        caption_element.children << caption_text
+        el.children << caption_element
+      end
+
+      format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+    end
+  end
+end

data/lib/writedown/image.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'fastimage'
+
+module Writedown
+  module Image
+    def convert_img(el, indent)
+      path = el.attr['src']
+      unless Writedown::Utils.remote?(path)
+        image_path = Dir.glob("**#{path}").first
+        dimensions = FastImage.size(image_path)
+
+        if dimensions
+          el.attr[:width]  = dimensions.first
+          el.attr[:height] = dimensions.last
+        end
+      end
+
+      super
+    end
+  end
+end

data/lib/writedown/utils.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Writedown
+  class Utils
+    class << self
+      def remote?(path)
+        !!path.match(%r{(?:https?|//)})
+      end
+
+      def slugify(string, sep = '-')
+        slugified_string = string
+        slugified_string.gsub!(/[^\w\-_]+/, sep)
+        unless sep.nil? || sep.empty?
+          re_sep = Regexp.escape(sep)
+          # No more than one of the separator in a row
+          slugified_string.gsub!(/#{re_sep}{2,}/, sep)
+          # Remove leading/trailing separator
+          slugified_string.gsub!(/^#{re_sep}|#{re_sep}$/, '')
+        end
+        slugified_string.downcase
+      end
+    end
+  end
+end

data/lib/writedown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Writedown
+  VERSION = '0.1.0'
+end

data/writedown.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'writedown/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'writedown'
+  s.version       = Writedown::VERSION
+  s.authors       = ['Adam Hollett']
+  s.email         = ['mail@adamhollett.com']
+
+  s.summary       = 'An enhanced renderer for kramdown, the pure Ruby Markdown converter.'
+  s.homepage      = 'https://github.com/admhlt/writedown'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.require_paths = ['lib']
+
+  s.add_dependency 'kramdown',  '~> 1.16', '>= 1.16.0'
+  s.add_dependency 'fastimage', '~> 2.0',  '>= 2.0.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: writedown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hollett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 
+email:
+- mail@adamhollett.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/kramdown/converter/writedown.rb
+- lib/writedown.rb
+- lib/writedown/aside.rb
+- lib/writedown/checkbox.rb
+- lib/writedown/figure.rb
+- lib/writedown/image.rb
+- lib/writedown/utils.rb
+- lib/writedown/version.rb
+- writedown.gemspec
+homepage: https://github.com/admhlt/writedown
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: An enhanced renderer for kramdown, the pure Ruby Markdown converter.
+test_files: []