kramdown-converter-indesign 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce8cacf46a285384da26fc974a60e09bc30708dbc252f83bb83d1494677c858c
+  data.tar.gz: f9d2824ef7834d77206aeeea5defe829962b4c64ecfe77950ab69780ce013513
+SHA512:
+  metadata.gz: 5c1aa412bd692a61af1db6f0b4f47b1cec3f6118271ea4638e4f48d316a15bbb711eb154c2c9c7754dba48a5dd194af83ea0a190bb45bfdd4ec11aaaa3e742f5
+  data.tar.gz: 6e0d649b5134e28594ae010f3fbe7bbe921543510bf36d38d5feca77ed230c45f27e76b301bab617547c18ddfc1c073e020e669877bdc2a250dc6e0b85a47430

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.gem
+Gemfile.lock
+test//output

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1 @@
+FIXME

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test_*.rb']
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,15 @@
+# TODO
+
+## NOW -- bugs, problems
+
+
+## SOON -- improvements
+
+- find comprehensive test input document
+
+- make correct elements for <a> link
+
+
+## LATER -- features
+
+- allow custom styles to be specified to converter (via options)

data/kramdown-converter-indesign.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'kramdown-converter-indesign'
+  s.version       = '0.1'
+  s.summary       = 'Converts a Kramdown/Markdown document to InDesign\'s ICML format.'
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+  s.description   = %q{
+    Kramdown::Converter::Indesign converts a Kramdown/Markdown document to InDesign's ICML format.
+  }
+  s.license       = 'MIT'
+  s.homepage      = 'http://github.com/jslabovitz/kramdown-converter-indesign'
+  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("\n").map { |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_dependency 'kramdown', '~> 2.4'
+  s.add_dependency 'nokogiri', '~> 1.13'
+
+  s.add_development_dependency 'bundler', '~> 2.3'
+  s.add_development_dependency 'minitest', '~> 5.16'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+end

data/lib/kramdown-converter-indesign/extensions/kramdown.rb

@@ -0,0 +1,55 @@
+module Kramdown
+
+  class Element
+
+    attr_accessor :parent
+    attr_accessor :level
+
+    def setup_tree(parent=nil)
+      @parent = parent
+      @level = parent ? parent.level + 1 : 0
+      @children.each { |e| e.setup_tree(self) }
+    end
+
+    def previous
+      if (i = index) && i > 0
+        @parent.children[i - 1]
+      else
+        nil
+      end
+    end
+
+    def next
+      if (i = index)
+        @parent.children[i + 1]
+      else
+        nil
+      end
+    end
+
+    def index
+      @parent&.children.index(self)
+    end
+
+    def ial_class
+      (ial = @options[:ial]) && ial['class']
+    end
+
+    TEXT_TYPES = [:text, :smart_quote, :typographic_sym, :entity]
+
+    def is_text?
+      TEXT_TYPES.include?(@type)
+    end
+
+    def to_s
+      "* %s%s <%p> (%s)" % [
+        "\t" * (@level || 0),
+        @type,
+        @value,
+        (@options || {}).map { |k, v| "#{k}: #{v.inspect}" }.join(', ')
+      ]
+    end
+
+  end
+
+end

data/lib/kramdown-converter-indesign/extensions/nokogiri.rb

@@ -0,0 +1,23 @@
+module Nokogiri
+
+  module XML
+
+    class Builder
+
+      def processing_instruction(string, content)
+        insert(doc.create_processing_instruction(string, content))
+      end
+
+    end
+
+    class Document
+
+      def create_processing_instruction(string, content)
+        Nokogiri::XML::ProcessingInstruction.new(self, string.to_s, content.to_s)
+      end
+
+    end
+
+  end
+
+end

data/lib/kramdown-converter-indesign/style.rb

@@ -0,0 +1,55 @@
+module Kramdown
+
+  module Converter
+
+    class Indesign
+
+      class Style
+
+        attr_accessor :name
+        attr_accessor :attrs
+        attr_accessor :based_on
+
+        def initialize(name:, attrs: nil, based_on: nil)
+          @name = name
+          @attrs = attrs || {}
+          @based_on = based_on
+        end
+
+        def build(xml)
+          xml.send(self.class.type, Self: to_s, Name: @name, **attrs) do
+            if @based_on
+              xml.Properties do
+                xml.BasedOn(@based_on.to_s, type: 'object')
+              end
+            end
+          end
+        end
+
+        def to_s
+          "#{self.class.type}/#{@name}"
+        end
+
+      end
+
+      class ParagraphStyle < Style
+
+        def self.type
+          'ParagraphStyle'
+        end
+
+      end
+
+      class CharacterStyle < Style
+
+        def self.type
+          'CharacterStyle'
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/kramdown-converter-indesign/style_group.rb

@@ -0,0 +1,90 @@
+module Kramdown
+
+  module Converter
+
+    class Indesign
+
+      class StyleGroup
+
+        attr_accessor :id
+        attr_accessor :base_style
+
+        def self.add_styles(specs)
+          new.tap { |g| g.add_styles(specs) }
+        end
+
+        def initialize(base_style:, id: nil)
+          @id = id || self.class.default_id
+          @base_style = base_style
+          @styles = {}
+        end
+
+        def add_styles(specs)
+          specs.each do |name, spec|
+            add_style(spec.merge(name: name))
+          end
+        end
+
+        def add_style(params)
+          params = params.dup
+          if (base = params[:based_on])
+            base = self[base] if base.kind_of?(String)
+          end
+          params[:based_on] = base || @base_style
+          style = self.class.style_class.new(**params)
+          @styles[style.name] = style
+          style
+        end
+
+        def [](name)
+          @styles[name] or raise "Can't find style: #{name}"
+        end
+
+        def build(xml)
+          xml.send(self.class.xml_tag, Self: @id) do
+            @base_style.build(xml) if @base_style
+            @styles.values.each do |style|
+              style.build(xml)
+            end
+          end
+        end
+
+      end
+
+      class ParagraphStyleGroup < StyleGroup
+
+        def self.style_class
+          ParagraphStyle
+        end
+
+        def self.xml_tag
+          'RootParagraphStyleGroup'
+        end
+
+        def self.default_id
+          'paragraph_styles'
+        end
+
+      end
+
+      class CharacterStyleGroup < StyleGroup
+
+        def self.style_class
+          CharacterStyle
+        end
+
+        def self.xml_tag
+          'RootCharacterStyleGroup'
+        end
+
+        def self.default_id
+          'character_styles'
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/kramdown-converter-indesign.rb

@@ -0,0 +1,260 @@
+require 'kramdown'
+require 'nokogiri'
+
+module Kramdown
+
+  module Converter
+
+    class Indesign < Base
+
+      class Error < StandardError; end
+
+      def initialize(root, options)
+        super
+        @paragraph_style_group = make_paragraph_styles
+        @character_style_group = make_character_styles
+        root.setup_tree
+      end
+
+      def make_paragraph_styles
+        base_style = ParagraphStyle.new(name: '$ID/NormalParagraphStyle')
+        group = ParagraphStyleGroup.new(base_style: base_style)
+        group.add_styles(
+          'head1' => {},
+          'head2' => {},
+          'head3' => {},
+          'para' => {},
+          'para first' => { based_on: 'para' },
+          'bul item' => {},
+          'num item' => {},
+          'footnote' => {},
+          'blockquote' => {},
+          'credit' => {},
+        )
+        group
+      end
+
+      def make_character_styles
+        base_style = CharacterStyle.new(name: '$ID/[No character style]')
+        group = CharacterStyleGroup.new(base_style: base_style)
+        group.add_styles(
+          'bold' => { attrs: { FontStyle: 'Bold' } },
+          'italic' => { attrs: { FontStyle: 'Italic' } },
+          'small caps' => { attrs: { Capitalization: 'CapToSmallCap' } },
+          'code' => { attrs: {} },  #FIXME: mono font
+          'footnote ref' => { },   #FIXME: OpenType superior
+        )
+        group
+      end
+
+      def convert(elem, options={})
+# ;;puts elem
+        begin
+          method_name = "convert_#{elem.type}"
+          raise Error, "Can't convert element" unless respond_to?(method_name)
+          send(method_name, elem)
+        rescue Error => e
+          raise Error, "#{e} (type: #{elem.type.inspect}, value: #{elem.value.inspect}, location: #{elem.options[:location]})"
+        end
+      end
+
+      def convert_children(elem)
+        elem.children.each do |e|
+          if e.is_text? && @xml.parent.name != 'Content'
+            build_character(@character_style_group.base_style) { convert(e) }
+          else
+            convert(e)
+          end
+        end
+      end
+
+      def convert_root(elem)
+        Nokogiri::XML::Builder.new do |xml|
+          @xml = xml
+          build_document do
+            convert_children(elem)
+          end
+        end.doc.to_xml(save_with: 0)
+      end
+
+      def convert_xml_comment(elem)
+        # ignore
+      end
+
+      def convert_html_element(elem)
+        if elem.value == 'a'
+          convert_a(elem)
+        else
+          raise Error, "Unsupported HTML element: <#{elem.value}>"
+        end
+      end
+
+      def convert_header(elem)
+        build_paragraph("head#{elem.options[:level]}") { convert_children(elem) }
+      end
+
+      def convert_p(elem)
+        style = elem.ial_class \
+          || @next_paragraph_style \
+          || (@previous_paragraph_style && @previous_paragraph_style.name.start_with?('head') && 'para first') \
+          || 'para'
+        build_paragraph(style) { convert_children(elem) }
+      end
+
+      def convert_blockquote(elem)
+        @next_paragraph_style = 'blockquote'
+        convert_children(elem)
+        @next_paragraph_style = nil
+      end
+
+      def convert_footnote(elem)
+        build_character('footnote ref', 'Footnote') do
+          convert(elem.value)
+        end
+      end
+
+      def convert_footnote_def(elem)
+        elem.children.each_with_index do |e, i|
+          build_paragraph('footnote') do
+            if i == 0
+              build_character('footnote ref') do
+                @xml.processing_instruction('ACE', '4')
+              end
+            end
+            convert_children(e)
+          end
+        end
+      end
+
+      def convert_em(elem)
+        style = case elem.ial_class
+        when 'sc'
+          'small caps'
+        else
+          'italic'
+        end
+        build_character(style) { convert_children(elem) }
+      end
+
+      def convert_strong(elem)
+        build_character('bold') { convert_children(elem) }
+      end
+
+      def convert_codespan(elem)
+        build_character('code') { @xml.text(elem.value) }
+      end
+
+      def convert_ul(elem)
+        @next_paragraph_style = 'bul item'
+        convert_children(elem)
+        @next_paragraph_style = nil
+      end
+
+      def convert_ol(elem)
+        @next_paragraph_style = 'num item'
+        convert_children(elem)
+        @next_paragraph_style = nil
+      end
+
+      def convert_li(elem)
+        # handled in convert_p
+        @xml.Br
+        convert_children(elem)
+      end
+
+      def convert_br(elem)
+        # newline automatically inserted
+      end
+
+      def convert_hr(elem)
+        # paragraph_style('section')
+        # @xml.text('* * *')
+      end
+
+      def convert_a(elem)
+        # link ignored
+        convert_children(elem)
+      end
+
+      def convert_blank(elem)
+        @xml.Br
+      end
+
+      def convert_text(elem)
+        @xml.text(elem.value)
+      end
+
+      def convert_entity(elem)
+        @xml << "&#{elem.value.name};"
+      end
+
+      def convert_smart_quote(elem)
+        text = case elem.value
+        when :lsquo
+          '‘'
+        when :rsquo
+          '’'
+        when :ldquo
+          '“'
+        when :rdquo
+          '”'
+        else
+          raise "Unknown smart quote: #{elem.value.inspect}"
+        end
+        @xml.text(text)
+      end
+
+      def convert_typographic_sym(elem)
+        text = case elem.value
+        when :ndash
+          '–'
+        when :hellip
+          '…'
+        else
+          raise "Unknown typographic symbol: #{elem.value.inspect}"
+        end
+        @xml.text(text)
+      end
+
+      ###
+
+      def build_document(&block)
+        @xml.processing_instruction('aid', 'style="50" type="snippet" readerVersion="6.0" featureSet="513" product="8.0(370)"')
+        @xml.processing_instruction('aid', 'SnippetType="InCopyInterchange"')
+        @xml.Document(DOMVersion: '8.0', Self: 'doc') do
+          @character_style_group.build(@xml)
+          @paragraph_style_group.build(@xml)
+          build_story(&block)
+        end
+      end
+
+      def build_story(&block)
+        @xml.Story(Self: 'story') do
+          @xml.StoryPreference(OpticalMarginAlignment: true, OpticalMarginSize: 12)
+          yield
+        end
+      end
+
+      def build_paragraph(style, &block)
+        style = @paragraph_style_group[style] unless style.kind_of?(Style)
+        @xml.ParagraphStyleRange(AppliedParagraphStyle: style, &block)
+        @previous_paragraph_style = style
+      end
+
+      def build_character(style, sub_name='Content', &block)
+        style = @character_style_group[style] unless style.kind_of?(Style)
+        @xml.CharacterStyleRange(AppliedCharacterStyle: style) do
+          @xml.send(sub_name, &block)
+        end
+      end
+
+    end
+
+  end
+
+end
+
+require_relative 'kramdown-converter-indesign/style'
+require_relative 'kramdown-converter-indesign/style_group'
+require_relative 'kramdown-converter-indesign/extensions/kramdown'
+require_relative 'kramdown-converter-indesign/extensions/nokogiri'

data/test/helpers.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+require 'kramdown-converter-indesign'
+
+class Test < MiniTest::Test
+
+  def convert(input)
+    @doc = Kramdown::Document.new(File.read(input))
+    @output = @doc.to_indesign.to_s
+  end
+
+  def assert_xml
+    assert { @output =~ /^<\?xml/ }
+  end
+
+end

data/test/input/complex.md

@@ -0,0 +1,38 @@
+# Main heading
+
+Hello, _first_\\
+‘WAVING’!
+
+And second.
+
+* * *
+
+Another section, [linked](http://foo.bar).
+
+
+## Subheading
+
+Foo bar -- & zot?
+
+"Quotes" or 'quotes,' with ... ellipses.
+
+Some _small_{:.sc} capitals.
+
+Some `code` here.[^1]
+
+[^1]: A footnote, _with style._
+
+
+### Sub-subheading
+
+More here:
+
+- a
+- bulleted
+- list
+
+and:
+
+1. a
+2. numbered
+3. list

data/test/input/gettysburg.md

@@ -0,0 +1,16 @@
+# The Gettysburg Address
+
+_Four score and seven years ago_ our fathers brought forth on this continent, a new nation, conceived in Liberty, and dedicated to the proposition that all men are created equal.
+
+> Here is a block of quoted text.
+
+Now we are engaged in a great civil war, testing whether that nation, or any nation so conceived and so dedicated, can long endure. We are met on a great battle-field of that war. We have come to dedicate a portion of that field, as a final resting place for those who here gave their lives that that nation might live. It is altogether fitting and proper that we should do this.
+
+But, in a larger sense, we can not dedicate—we can not consecrate—we can not hallow—this ground. The brave men, living and dead, who struggled here, have consecrated it, far above our poor power to add or detract. The world will little note, nor long remember what we say here, but it can never forget what they did here. It is for us the living, rather, to be dedicated here to the unfinished work which they who fought here have thus far so nobly advanced. It is rather for us to be here dedicated to the great task remaining before us—that from these honored dead we take increased devotion to that cause for which they gave the last full measure of devotion—that we here highly resolve that these dead shall not have died in vain—that this nation, under God, shall have a new birth of freedom—and that government of the people, by the people, for the people, shall not perish from the earth.
+
+Abraham Lincoln[^lincoln] \\
+Gettysburg, Pennsylvania \\
+November 19, 1863
+{:.credit}
+
+[^lincoln]: A footnote.

data/test/input/simple.md

@@ -0,0 +1,3 @@
+The _main_ thing is to stay calm.[^1]
+
+[^1]: A footnote, _with style._

data/test/test_complex.rb

@@ -0,0 +1,13 @@
+require_relative 'helpers'
+
+class TestComplex < Test
+
+  def setup
+    convert('test/input/complex.md')
+  end
+
+  def test_build
+    assert_xml
+  end
+
+end

data/test/test_gettysburg.rb

@@ -0,0 +1,13 @@
+require_relative 'helpers'
+
+class TestGettysburg < Test
+
+  def setup
+    convert('test/input/gettysburg.md')
+  end
+
+  def test_build
+    assert_xml
+  end
+
+end

data/test/test_simple.rb

@@ -0,0 +1,13 @@
+require_relative 'helpers'
+
+class TestSimple < Test
+
+  def setup
+    convert('test/input/simple.md')
+  end
+
+  def test_build
+    assert_xml
+  end
+
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-converter-indesign
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- John Labovitz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: "\n    Kramdown::Converter::Indesign converts a Kramdown/Markdown document
+  to InDesign's ICML format.\n  "
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- TODO.md
+- kramdown-converter-indesign.gemspec
+- lib/kramdown-converter-indesign.rb
+- lib/kramdown-converter-indesign/extensions/kramdown.rb
+- lib/kramdown-converter-indesign/extensions/nokogiri.rb
+- lib/kramdown-converter-indesign/style.rb
+- lib/kramdown-converter-indesign/style_group.rb
+- test/helpers.rb
+- test/input/complex.md
+- test/input/gettysburg.md
+- test/input/simple.md
+- test/test_complex.rb
+- test/test_gettysburg.rb
+- test/test_simple.rb
+homepage: http://github.com/jslabovitz/kramdown-converter-indesign
+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: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Converts a Kramdown/Markdown document to InDesign's ICML format.
+test_files:
+- test/helpers.rb
+- test/input/complex.md
+- test/input/gettysburg.md
+- test/input/simple.md
+- test/test_complex.rb
+- test/test_gettysburg.rb
+- test/test_simple.rb