d-mark 0.2.0 → 1.0.0a1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee205ce9623266e9787eec60d991ddc1f3b99a3
-  data.tar.gz: 490bbf23b2a0a0b8cb1767f6b7a542f38a749ba1
+  metadata.gz: a113f03eb0aba71874ec39fdb2eeeb53327da22a
+  data.tar.gz: 8a022441c7fb0ef0bb82b23d696e2d165f0e5193
 SHA512:
-  metadata.gz: 13cabb5e530a7067fe5e665c883d42f1bf59208249e2fd2ef9fe49cf87cfa0dffa1974be4307769dbb862d51ba466403154e6bbbbf655a244a275d760b26bacd
-  data.tar.gz: e65a20361865f63a70cf4de93fa27634dcf831ac4d966c64ccb146dabd03796e277b23fdb43dd7ebeef9fdde947f2c1d800e2afeb5710ebf79ec4d9231608bc9
+  metadata.gz: 9b67ee738116a651db12715abf33da46b4d9ab78425b30d801ca6c5398be45bbd2bcae3092b7e48566538ec98d7a6620063a94d2da4a3546342229b143f9e991
+  data.tar.gz: a61696ac50d227e5b90c652d3593d300a46a66bed352e852c26feb5951c88c639fed7e9af32e6c304cb520b7edfd0b37e5b8716fddbedea77acb151f8aac02e0

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'codecov', require: false
 gem 'guard'
 gem 'guard-rake'
 gem 'rspec'

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    d-mark (0.1.0)
-      treetop (~> 1.4)
+    d-mark (1.0.0a1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.2.0)
+    codecov (0.1.4)
+      json
+      simplecov
+      url
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     ffi (1.9.10)
     formatador (0.2.5)
     guard (2.13.0)
@@ -24,6 +28,7 @@ GEM
     guard-rake (1.0.0)
       guard
       rake
+    json (1.8.3)
     listen (3.0.6)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
@@ -35,7 +40,6 @@ GEM
       shellany (~> 0.0)
     parser (2.3.0.4)
       ast (~> 2.2)
-    polyglot (0.3.5)
     powerpack (0.1.1)
     pry (0.10.3)
       coderay (~> 1.1.0)
@@ -67,17 +71,22 @@ GEM
       unicode-display_width (~> 0.3)
     ruby-progressbar (1.7.5)
     shellany (0.0.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
     thor (0.19.1)
-    treetop (1.6.3)
-      polyglot (~> 0.3)
     unicode-display_width (0.3.1)
+    url (0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.11.2, < 2.0)
+  codecov
   d-mark!
   guard
   guard-rake

data/NEWS.md

@@ -1,5 +1,12 @@
 # D★Mark news
 
+## 1.0.0a1 (2016-02-20)
+
+Fixes:
+
+* Allowed document to begin with blank lines (#4)
+* Ensured error is raised on incorrectly escaped attribute value (#5)
+
 ## 0.2 (2016-02-11)
 
 Fixes:

data/README.adoc

@@ -1,7 +1,10 @@
 = D★Mark
 Denis Defreyne <denis@stoneship.org>
 
-CAUTION: D★Mark is experimental — use at your own risk!
+image:http://img.shields.io/gem/v/d-mark.svg[Gem version, link="http://rubygems.org/gems/d-mark"]
+image:http://img.shields.io/travis/ddfreyne/d-mark.svg[Build status, link="https://travis-ci.org/ddfreyne/d-mark"]
+image:http://img.shields.io/codeclimate/github/ddfreyne/d-mark.svg[Code Climate, link="https://codeclimate.com/github/ddfreyne/d-mark"]
+image:http://img.shields.io/codecov/c/github/ddfreyne/d-mark.svg[Code Coverage, link="https://codecov.io/github/ddfreyne/d-mark"]
 
 _D★Mark_ is a language for marking up prose. It facilitates writing semantically meaningful text, without limiting itself to the semantics provided by HTML or Markdown.
 
@@ -205,7 +208,7 @@ class MyXMLLikeTranslator < DMark::Translator
     case node
     when String
       out << node
-    when DMark::Parser::ElementNode
+    when DMark::ElementNode
       out << "<#{node.name}>"
       handle_children(node)
       out << "</#{node.name}>"

data/d-mark.gemspec

@@ -22,6 +22,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.1.0'
 
-  s.add_runtime_dependency('treetop', '~> 1.4')
   s.add_development_dependency('bundler', '>= 1.11.2', '< 2.0')
 end

data/lib/d-mark.rb

@@ -1,2 +1,3 @@
+require_relative 'd-mark/element_node'
 require_relative 'd-mark/parser'
 require_relative 'd-mark/translator'

data/lib/d-mark/element_node.rb

@@ -0,0 +1,36 @@
+module DMark
+  class ElementNode
+    attr_reader :name
+    attr_reader :attributes
+    attr_reader :children
+
+    def initialize(name, attributes, children)
+      @name = name
+      @attributes = attributes
+      @children = children
+    end
+
+    def inspect
+      io = ''
+      io << 'Element(' << @name << ', '
+      if @attributes.any?
+        io << @attributes.inspect
+        io << ', '
+      end
+      io << @children.inspect
+      io << ')'
+      io
+    end
+
+    def ==(other)
+      case other
+      when ElementNode
+        @name == other.name &&
+          @children == other.children &&
+          @attributes == other.attributes
+      else
+        false
+      end
+    end
+  end
+end

data/lib/d-mark/parser.rb

@@ -13,41 +13,6 @@ module DMark
       end
     end
 
-    class ElementNode
-      attr_reader :name
-      attr_reader :attributes
-      attr_reader :children
-
-      def initialize(name, attributes, children)
-        @name = name
-        @attributes = attributes
-        @children = children
-      end
-
-      def inspect
-        io = ''
-        io << 'Element(' << @name << ', '
-        if @attributes.any?
-          io << @attributes.inspect
-          io << ', '
-        end
-        io << @children.inspect
-        io << ')'
-        io
-      end
-
-      def ==(other)
-        case other
-        when ElementNode
-          @name == other.name &&
-            @children == other.children &&
-            @attributes == other.attributes
-        else
-          false
-        end
-      end
-    end
-
     attr_reader :pos
 
     def initialize(input)
@@ -62,6 +27,17 @@ module DMark
     def parse
       res = []
 
+      loop do
+        break if eof?
+
+        blank_pos = try_read_blank_line
+        break unless blank_pos
+
+        @pos = blank_pos
+        @line_nr += 1
+        @col_nr = 0
+      end
+
       loop do
         break if eof?
         res << read_block_with_children
@@ -161,14 +137,14 @@ module DMark
 
       success =
         if try_read_identifier_head
-          if try_read_identifier_tail
-            case peek_char
-            when '['
-              true
-            when '.'
-              advance
-              [' ', "\n", nil].include?(peek_char)
-            end
+          read_identifier_tail
+
+          case peek_char
+          when '['
+            true
+          when '.'
+            advance
+            [' ', "\n", nil].include?(peek_char)
           end
         end
 
@@ -186,24 +162,6 @@ module DMark
       end
     end
 
-    # FIXME: ugly and duplicated
-    def try_read_identifier_tail
-      res = ''
-
-      loop do
-        char = peek_char
-        case char
-        when 'a'..'z', '-', '0'..'9'
-          advance
-          res << char
-        else
-          break
-        end
-      end
-
-      res.to_s
-    end
-
     def detect_indentation
       indentation_chars = 0
       pos = @pos
@@ -221,26 +179,6 @@ module DMark
       indentation_chars / 2
     end
 
-    def read_until_eol_or_eof
-      res = ''
-
-      loop do
-        char = peek_char
-        case char
-        when "\n"
-          advance
-          break
-        when nil
-          break
-        else
-          advance
-          res << char
-        end
-      end
-
-      res.to_s
-    end
-
     def read_indentation(indentation)
       indentation.times do
         read_char(' ')
@@ -363,20 +301,28 @@ module DMark
 
         if is_escaping
           case char
-          when nil, "\n"
-            break
-          else
+          when '%', ']', ','
             advance
             res << char
             is_escaping = false
+          when nil
+            raise_parse_error('unexpected file end in attribute value')
+          when "\n"
+            raise_parse_error('unexpected line break in attribute value')
+          else
+            raise_parse_error(%(expected "%", "," or "]" after "%", but got #{char.inspect}))
           end
         else
           case char
-          when nil, "\n", ']', ','
+          when ']', ','
             break
           when '%'
             advance
             is_escaping = true
+          when nil
+            raise_parse_error('unexpected file end in attribute value')
+          when "\n"
+            raise_parse_error('unexpected line break in attribute value')
           else
             advance
             res << char

data/lib/d-mark/version.rb

@@ -1,3 +1,3 @@
 module DMark
-  VERSION = '0.2.0'.freeze
+  VERSION = '1.0.0a1'.freeze
 end

data/samples/trivial.rb

@@ -5,7 +5,7 @@ class MyHTMLTranslator < DMark::Translator
     case node
     when String
       out << node
-    when DMark::Parser::ElementNode
+    when DMark::ElementNode
       out << "<#{node.name}>"
       handle_children(node)
       out << "</#{node.name}>"

data/spec/d-mark/element_node_spec.rb

@@ -0,0 +1,54 @@
+describe DMark::ElementNode do
+  let(:element_node) { described_class.new(name, attributes, children) }
+
+  let(:name) { 'para' }
+  let(:attributes) { {} }
+  let(:children) { ['Hello!'] }
+
+  describe '#inspect' do
+    subject { element_node.inspect }
+
+    context 'no attributes' do
+      let(:attributes) { {} }
+
+      it { is_expected.to eql('Element(para, ["Hello!"])') }
+    end
+
+    context 'attributes' do
+      let(:attributes) { { 'only' => 'web' } }
+
+      it { is_expected.to eql('Element(para, {"only"=>"web"}, ["Hello!"])') }
+    end
+  end
+
+  describe '#==' do
+    subject { element_node == other }
+
+    context 'other is not an element node' do
+      let(:other) { 'donkey' }
+      it { is_expected.to be false }
+    end
+
+    context 'other is an element node' do
+      context 'other does not differ' do
+        let(:other) { described_class.new(name, attributes, children) }
+        it { is_expected.to be true }
+      end
+
+      context 'other differs in name' do
+        let(:other) { described_class.new('giraffe', attributes, children) }
+        it { is_expected.to be false }
+      end
+
+      context 'other differs in attributes' do
+        let(:other) { described_class.new(name, { 'friend' => 'donkey' }, children) }
+        it { is_expected.to be false }
+      end
+
+      context 'other differs in children' do
+        let(:other) { described_class.new(name, attributes, []) }
+        it { is_expected.to be false }
+      end
+    end
+  end
+end

data/spec/d-mark/parser_spec.rb

@@ -3,7 +3,7 @@ def parse(s)
 end
 
 def element(name, attributes, children)
-  DMark::Parser::ElementNode.new(name, attributes, children)
+  DMark::ElementNode.new(name, attributes, children)
 end
 
 describe 'DMark::Parser#parser' do
@@ -260,6 +260,37 @@ describe 'DMark::Parser#parser' do
     ]
   end
 
+  it 'parses document starting with blank lines' do
+    expect(parse("  \n \np. Hi!")).to eq [
+      element('p', {}, ['Hi!'])
+    ]
+  end
+
+  it 'does not parse percent escapes' do
+    expect { parse('p. %ref[url=https://github.com/pulls?q=is%3Aopen+user%3Ananoc]{eek}') }
+      .to raise_error(DMark::Parser::ParserError, 'parse error at line 1, col 43: expected "%", "," or "]" after "%", but got "3"')
+  end
+
+  it 'does not parse attribute values ending with an end-of-file' do
+    expect { parse('p. %ref[url=hello') }
+      .to raise_error(DMark::Parser::ParserError, 'parse error at line 1, col 18: unexpected file end in attribute value')
+  end
+
+  it 'does not parse attribute values ending with a line break' do
+    expect { parse("p. %ref[url=hello\n") }
+      .to raise_error(DMark::Parser::ParserError, 'parse error at line 1, col 18: unexpected line break in attribute value')
+  end
+
+  it 'does not parse escaped attribute values ending with an end-of-file' do
+    expect { parse('p. %ref[url=hello%') }
+      .to raise_error(DMark::Parser::ParserError, 'parse error at line 1, col 19: unexpected file end in attribute value')
+  end
+
+  it 'does not parse escaped attribute values ending with a line break' do
+    expect { parse("p. %ref[url=hello%\n") }
+      .to raise_error(DMark::Parser::ParserError, 'parse error at line 1, col 19: unexpected line break in attribute value')
+  end
+
   it 'does not parse' do
     expect { parse('p') }.to raise_error(DMark::Parser::ParserError)
     expect { parse('0') }.to raise_error(DMark::Parser::ParserError)

data/spec/d-mark/translator_spec.rb

@@ -0,0 +1,45 @@
+describe DMark::Translator do
+  let(:translator) { translator_class.new(nodes) }
+  let(:translator_class) { described_class }
+
+  let(:nodes) do
+    [
+      DMark::ElementNode.new(
+        'para',
+        { 'only' => 'web', 'animal' => 'donkey' },
+        ['Hi!']
+      )
+    ]
+  end
+
+  describe '#run' do
+    subject { translator.run }
+
+    context 'translator base class' do
+      it 'raises NotImplementedError' do
+        expect { subject }.to raise_error(NotImplementedError)
+      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}>"
+            end
+          end
+        end
+      end
+
+      it { is_expected.to eql('<para only=web animal=donkey>Hi!</para>') }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,10 @@
 require 'rspec'
+
+require 'simplecov'
+SimpleCov.start
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
 require 'd-mark'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: d-mark
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0a1
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-02-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: treetop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,13 +50,16 @@ files:
 - 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/identifiers-and-patterns.dmark
 - samples/trivial.dmark
 - samples/trivial.rb
+- spec/d-mark/element_node_spec.rb
 - spec/d-mark/parser_spec.rb
+- spec/d-mark/translator_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/d-mark
 licenses:
@@ -89,9 +78,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2