d-mark 1.0.0a2 → 1.0.0a3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 686fe4c2cf9132e4bfd42debaac837d66b911c40
-  data.tar.gz: 3649616bac8b3eccb25de17e433ecea93af77bc9
+  metadata.gz: b1542c550fe7394de16bd088b2b0adc7bc369419
+  data.tar.gz: 6601aacc0e5d8c9b5aae40309b8802acef9652dc
 SHA512:
-  metadata.gz: b419728d8c5bf01674fb87c1401f6a47c8a7d90883efce6fce0de6612f50060f5cb3dcf740e77ce6601df04992e7a2ad050a209631e8062fc2e1b5e89c63745b
-  data.tar.gz: 7404cc61b20b0c2fed2d7dd8fb76127e8c8ea30c6f42d2c6525297c027bf4d6b84a5deea1b311e621c305e9c82615f0ab0b8da187c6894ec690986e302edc166
+  metadata.gz: f5775a149e72d08f1ca5f24b3a2fd9f1ce78084fc790d6aa562db07912d0d19d62de09b1e1c3ff66636465bcf657ffb063345ddb6fa52a5bbce3ac1e989a0a55
+  data.tar.gz: c91e5b502cb9950561c257ba6f765d04d5b125c6f7ce965b336f843561a864050fcd217adb2b658b37f05c5ffbb70a56f8ca410159eabc72811f2639d34f5e1e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    d-mark (1.0.0a2)
+    d-mark (1.0.0a3)
 
 GEM
   remote: https://rubygems.org/
@@ -46,7 +46,7 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rainbow (2.1.0)
-    rake (10.5.0)
+    rake (11.1.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
@@ -54,7 +54,7 @@ GEM
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.3)
+    rspec-core (3.4.4)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -63,12 +63,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.37.2)
-      parser (>= 2.3.0.4, < 3.0)
+    rubocop (0.38.0)
+      parser (>= 2.3.0.6, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 0.3)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.7.5)
     shellany (0.0.1)
     simplecov (0.11.2)
@@ -78,7 +78,7 @@ GEM
     simplecov-html (0.10.0)
     slop (3.6.0)
     thor (0.19.1)
-    unicode-display_width (0.3.1)
+    unicode-display_width (1.0.2)
     url (0.3.2)
 
 PLATFORMS
@@ -94,4 +94,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/NEWS.md

@@ -1,5 +1,13 @@
 # D★Mark news
 
+## 1.0.0a3 (2016-07-03)
+
+Changes:
+
+* Dropped support for Ruby 2.1
+* Removed CLI
+* Changed `Translator` API to allow specialisation
+
 ## 1.0.0a2 (2016-03-06)
 
 Changes:

data/README.adoc

@@ -16,7 +16,7 @@ Here’s an example of D★Mark:
 ----
 para. This a paragraph; an element in block form containing some text.
 
-note[only=web]. This is a note that will %emph{only} show up on web.
+note[only=web]. This is a note that will %em{only} show up on web.
 ----
 
 For details, see the http://ddfreyne.github.io/d-mark/[D★Mark web page].

data/Rakefile

@@ -12,7 +12,3 @@ RuboCop::RakeTask.new(:rubocop) do |task|
 end
 
 task default: [:spec, :rubocop]
-
-rule 'doc.html' => 'doc.dmark' do |t|
-  sh "bundle exec ruby samples/doc2html.rb #{t.source} #{t.name}"
-end

data/d-mark.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.rdoc_options     = ['--main', 'README.adoc']
   s.extra_rdoc_files = ['LICENSE', 'README.adoc', 'NEWS.md']
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.2.0'
 
   s.add_development_dependency('bundler', '>= 1.11.2', '< 2.0')
 end

data/lib/d-mark/parser.rb

@@ -356,7 +356,7 @@ module DMark
         advance
         char.to_s
       when nil, "\n"
-        raise_parse_error("expected something after %")
+        raise_parse_error('expected something after %')
       else
         read_inline_element
       end

data/lib/d-mark/translator.rb

@@ -1,28 +1,57 @@
 module DMark
   class Translator
-    attr_reader :out
+    class UnhandledNode < StandardError
+      attr_reader :node
 
-    def initialize(nodes)
-      @nodes = nodes
+      def initialize(node)
+        @node = node
+      end
+
+      def message
+        case @node
+        when String
+          'Unhandled string node'
+        when DMark::ElementNode
+          "Unhandled element node #{@node.name.inspect}"
+        else
+          "Unhandled node #{@node.inspect}"
+        end
+      end
+    end
+
+    def self.translate(nodes, context = {})
+      new.translate(nodes, context)
+    end
 
-      @out = ''
+    def translate(nodes, context = {})
+      [nodes.map { |node| handle(node, context) }].flatten.join('')
     end
 
-    def run
-      @nodes.each do |node|
-        handle(node)
+    def handle(node, context = {})
+      case node
+      when String
+        handle_string(node, context)
+      when DMark::ElementNode
+        handle_element(node, context)
+      else
+        raise ArgumentError, "Cannot handle #{node.class}"
       end
-      @out
     end
 
-    private
+    # @abstract
+    def handle_string(string, _context)
+      raise DMark::Translator::UnhandledNode.new(string)
+    end
 
-    def handle(_node)
-      raise NotImplementedError
+    # @abstract
+    def handle_element(element, _context)
+      raise DMark::Translator::UnhandledNode.new(element)
     end
 
-    def handle_children(node)
-      node.children.each { |child| handle(child) }
+    private
+
+    def handle_children(node, context)
+      node.children.map { |child| handle(child, context) }
     end
   end
 end

data/lib/d-mark/version.rb

@@ -1,3 +1,3 @@
 module DMark
-  VERSION = '1.0.0a2'.freeze
+  VERSION = '1.0.0a3'.freeze
 end

data/samples/test.rb

@@ -0,0 +1,65 @@
+require 'd-mark'
+
+module DMarkBook
+  module Translators
+    class HTML < DMark::Translator
+      def handle_string(node)
+        [html_escape(node)]
+      end
+
+      def handle_element(node, path)
+        case node.name
+        when 'p', 'dl', 'dt', 'dd', 'ol', 'ul', 'li', 'code', 'kbd', 'blockquote'
+          wrap(node.name) { handle_children(node, path) }
+        when 'h'
+          depth = path.count { |node| node.name == 'section' } + 1
+          wrap("h#{depth}") { handle_children(node, path) }
+        when 'section'
+          wrap('section', id: id_for_section(node)) { handle_children(node, path) }
+        when 'em'
+          wrap('em') { handle_children(node, path) }
+        when 'link'
+          wrap('a', href: node.attributes['target']) { handle_children(node, path) }
+        when 'listing'
+          wrap('pre') { wrap('code') { handle_children(node, path) } }
+        else
+          raise DMark::Translator::UnhandledNode.new(node)
+        end
+      end
+
+      def wrap(name, params = {})
+        params_string = params.map { |k, v| " #{k}=\"#{html_escape(v)}\"" }.join('')
+        ["<#{name}#{params_string}>", yield, "</#{name}>"]
+      end
+
+      def html_escape(s)
+        s.gsub('&', '&amp;').gsub('<', '&lt;')
+      end
+
+      def id_for_section(node)
+        header = node.children.find { |c| c.name == 'h' }
+        text = header.children.join('')
+        text.downcase.gsub(/[^a-zA-Z-]/, '-')
+      end
+    end
+  end
+end
+
+class SpecialHTML < DMarkBook::Translators::HTML
+  def handle_element(node, depths)
+    case node.name
+    when 'firstterm', 'prompt', 'filename'
+      wrap('span', class: node.name) { handle_children(node, depths) }
+    when 'note', 'todo'
+      wrap('div', class: node.name) { handle_children(node, depths) }
+    else
+      super
+    end
+  end
+end
+
+content = File.readlines('site/content/index.dmark').drop(4).join
+parser = DMark::Parser.new(content)
+tree = parser.parse
+
+puts SpecialHTML.new.translate(tree)

data/samples/trivial.dmark

@@ -1 +1 @@
-p. I’m a %em{trivial} example!
+#p I’m a %em{trivial} example!

data/spec/d-mark/parser_spec.rb

@@ -44,7 +44,8 @@ describe 'DMark::Parser#parser' do
         'p', {},
         [
           element('foo', {}, ['}'])
-        ])
+        ]
+      )
     ]
   end
 
@@ -161,8 +162,8 @@ describe 'DMark::Parser#parser' do
   end
 
   it 'parses inline element in data lines' do
-    expect(parse("#p\n  %emph{donkey}")).to eq [
-      element('p', {}, [element('emph', {}, ['donkey'])])
+    expect(parse("#p\n  %em{donkey}")).to eq [
+      element('p', {}, [element('em', {}, ['donkey'])])
     ]
   end
 

data/spec/d-mark/translator_spec.rb

@@ -1,5 +1,5 @@
 describe DMark::Translator do
-  let(:translator) { translator_class.new(nodes) }
+  let(:translator) { translator_class.new }
   let(:translator_class) { described_class }
 
   let(:nodes) do
@@ -7,39 +7,95 @@ describe DMark::Translator do
       DMark::ElementNode.new(
         'para',
         { 'only' => 'web', 'animal' => 'donkey' },
-        ['Hi!']
+        [
+          DMark::ElementNode.new('em', {}, ['Hello']),
+          ' world!'
+        ]
       )
     ]
   end
 
-  describe '#run' do
-    subject { translator.run }
-
+  shared_examples 'translates' do
     context 'translator base class' do
-      it 'raises NotImplementedError' do
-        expect { subject }.to raise_error(NotImplementedError)
+      it 'raises error' do
+        expect { subject }.to raise_error(
+          DMark::Translator::UnhandledNode,
+          'Unhandled element node "para"'
+        )
       end
     end
 
     context 'custom translator' do
       let(:translator_class) do
         Class.new(described_class) do
-          def handle(node)
-            case node
-            when String
-              out << node
-            when DMark::ElementNode
-              out << "<#{node.name}"
-              out << node.attributes.map { |k, v| ' ' + [k, v].join('=') }.join
-              out << '>'
-              handle_children(node)
-              out << "</#{node.name}>"
+          def handle_string(string, _context)
+            [string]
+          end
+
+          def handle_element(element, context)
+            [
+              "<#{element.name}",
+              element.attributes.map { |k, v| ' ' + [k, v].join('=') }.join,
+              '>',
+              handle_children(element, context),
+              "</#{element.name}>"
+            ]
+          end
+        end
+      end
+
+      it { is_expected.to eql('<para only=web animal=donkey><em>Hello</em> world!</para>') }
+
+      context 'doing something with context' do
+        let(:translator_class) do
+          Class.new(described_class) do
+            def handle_string(string, context)
+              [string, " [parent=#{context[:kind]}]"]
+            end
+
+            def handle_element(element, context)
+              [
+                "<#{element.name}",
+                element.attributes.map { |k, v| ' ' + [k, v].join('=') }.join,
+                '>',
+                handle_children(element, context.merge(kind: element.name)),
+                "</#{element.name}>"
+              ]
             end
           end
         end
+
+        it { is_expected.to eql('<para only=web animal=donkey><em>Hello [parent=em]</em> world! [parent=para]</para>') }
       end
+    end
+  end
+
+  shared_examples 'errors on unknown type' do
+    it 'raises' do
+      expect { subject }.to raise_error(
+        ArgumentError,
+        'Cannot handle Symbol'
+      )
+    end
+  end
+
+  describe '.translate' do
+    subject { translator_class.translate(nodes) }
+    include_examples 'translates'
+
+    context 'unrecognised type' do
+      subject { translator_class.translate([:donkey]) }
+      include_examples 'errors on unknown type'
+    end
+  end
+
+  describe '#translate' do
+    subject { translator.translate(nodes) }
+    include_examples 'translates'
 
-      it { is_expected.to eql('<para only=web animal=donkey>Hi!</para>') }
+    context 'unrecognised type' do
+      subject { translator.translate([:donkey]) }
+      include_examples 'errors on unknown type'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: d-mark
 version: !ruby/object:Gem::Version
-  version: 1.0.0a2
+  version: 1.0.0a3
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,11 +49,11 @@ files:
 - Rakefile
 - d-mark.gemspec
 - lib/d-mark.rb
-- lib/d-mark/cli.rb
 - lib/d-mark/element_node.rb
 - lib/d-mark/parser.rb
 - lib/d-mark/translator.rb
 - lib/d-mark/version.rb
+- samples/test.rb
 - samples/trivial.dmark
 - samples/trivial.rb
 - spec/d-mark/element_node_spec.rb
@@ -74,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: markup language for writing text

data/lib/d-mark/cli.rb

@@ -1,28 +0,0 @@
-require_relative '../d-mark'
-
-data = File.read(ARGV[0]).strip
-
-parser = DMark::Parser.new(data)
-begin
-  before = Time.now
-  result = parser.parse
-  after = Time.now
-  result.each do |tree|
-    puts tree.inspect
-    puts
-  end
-  puts "parse duration: #{(after - before).to_f}s"
-rescue => e
-  case e
-  when DMark::Parser::ParserError
-    line = data.lines[e.line_nr]
-
-    puts "\e[31mError:\e[0m #{e.message}}"
-    puts
-    puts line
-    puts "\e[31m" + ' ' * e.col_nr + '↑' + "\e[0m"
-    exit 1
-  else
-    raise e
-  end
-end