d-mark 1.0.0a1 → 1.0.0b2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a113f03eb0aba71874ec39fdb2eeeb53327da22a
-  data.tar.gz: 8a022441c7fb0ef0bb82b23d696e2d165f0e5193
+SHA256:
+  metadata.gz: 5108217b3f4db3e0f50eaf6613a7ac7be6fc1df7ed910167c014593c2e05f74c
+  data.tar.gz: 1fcfc2341f5f3b49d903e52a2c743b02fbaece7d4415a5d2e72db4bac90ccb09
 SHA512:
-  metadata.gz: 9b67ee738116a651db12715abf33da46b4d9ab78425b30d801ca6c5398be45bbd2bcae3092b7e48566538ec98d7a6620063a94d2da4a3546342229b143f9e991
-  data.tar.gz: a61696ac50d227e5b90c652d3593d300a46a66bed352e852c26feb5951c88c639fed7e9af32e6c304cb520b7edfd0b37e5b8716fddbedea77acb151f8aac02e0
+  metadata.gz: e4d5238ced88d951e8edf2b6323a4ff698a24c70021265353d3f778b854b235f76aad85d872bce2c8bcb7683b4078f7a0b839e21f39380e9fe1583a7cebcb2e9
+  data.tar.gz: 41f4a62ed8cf1d86da8e0b5615f0e5ff485e3d314a5590e518e6ca5d32984b9ba792484bd60be2654a057ef68df4512b3de9ba9a4f2fa489b92651d72bc9e517

data/Gemfile.lock

@@ -1,25 +1,24 @@
 PATH
   remote: .
   specs:
-    d-mark (1.0.0a1)
+    d-mark (1.0.0b2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.2.0)
-    codecov (0.1.4)
+    ast (2.4.1)
+    codecov (0.2.12)
       json
       simplecov
-      url
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    ffi (1.9.10)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.4)
+    ffi (1.14.2)
     formatador (0.2.5)
-    guard (2.13.0)
+    guard (2.16.2)
       formatador (>= 0.2.4)
-      listen (>= 2.7, <= 4.0)
-      lumberjack (~> 1.0)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
@@ -28,64 +27,68 @@ 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)
-    lumberjack (1.0.10)
-    method_source (0.8.2)
+    json (2.5.1)
+    listen (3.4.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     nenv (0.3.0)
-    notiffany (0.0.8)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parser (2.3.0.4)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rainbow (2.1.0)
-    rake (10.5.0)
-    rb-fsevent (0.9.7)
-    rb-inotify (0.9.7)
-      ffi (>= 0.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.2)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       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)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 0.3)
-    ruby-progressbar (1.7.5)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     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)
-    unicode-display_width (0.3.1)
-    url (0.3.2)
+    simplecov (0.20.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.11.2, < 2.0)
   codecov
   d-mark!
   guard
@@ -94,4 +97,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.11.2
+   1.17.3

data/NEWS.md

@@ -1,5 +1,41 @@
 # D★Mark news
 
+## 1.0.0b2 (2021-01-01)
+
+Enhancements:
+
+* Added support for Ruby 3.x
+
+## 1.0.0b1 (2018-02-26)
+
+Enhancements:
+
+* Added `ParserError#fancy_message`
+
+## 1.0.0a4 (2017-08-19)
+
+Changes:
+
+* Relaxed identifier restrictions (#16, #17)
+
+Enhancements:
+
+* Made various speed improvements
+
+## 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:
+
+* Changed block form from `elem. content` to `#elem content` (#6)
+
 ## 1.0.0a1 (2016-02-20)
 
 Fixes:

data/README.md

@@ -0,0 +1,20 @@
+# D★Mark
+
+[![Gem version](http://img.shields.io/gem/v/d-mark.svg)](http://rubygems.org/gems/d-mark)
+[![Build status](http://img.shields.io/travis/ddfreyne/d-mark.svg)](https://travis-ci.org/ddfreyne/d-mark)
+[![Code Climate](http://img.shields.io/codeclimate/github/ddfreyne/d-mark.svg)](https://codeclimate.com/github/ddfreyne/d-mark)
+[![Code Coverage](http://img.shields.io/codecov/c/github/ddfreyne/d-mark.svg)](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.
+
+If you’re a technical writer looking for a flexible markup language, D★Mark might be a good fit.
+
+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 %em{only} show up on web.
+```
+
+For details, see the [D★Mark web page](http://ddfreyne.github.io/d-mark/).

data/Rakefile

@@ -7,8 +7,8 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.options  = %w( --display-cop-names --format simple )
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.options  = %w[--display-cop-names --format simple]
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'Gemfile', '*.gemspec', 'Rakefile']
 end
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/d-mark.gemspec

@@ -17,10 +17,8 @@ Gem::Specification.new do |s|
     ['d-mark.gemspec']
   s.require_paths = ['lib']
 
-  s.rdoc_options     = ['--main', 'README.adoc']
-  s.extra_rdoc_files = ['LICENSE', 'README.adoc', 'NEWS.md']
+  s.rdoc_options     = ['--main', 'README.md']
+  s.extra_rdoc_files = ['LICENSE', 'README.md', 'NEWS.md']
 
-  s.required_ruby_version = '>= 2.1.0'
-
-  s.add_development_dependency('bundler', '>= 1.11.2', '< 2.0')
+  s.required_ruby_version = '>= 2.5'
 end

data/ideas.dmark

@@ -0,0 +1,17 @@
+#h1 Ideas
+
+#ul
+  #li
+    #p Support validation. Which elements can contain which other elements? Which elements can live at the root?
+
+  #li
+    #p Have different translators built-in. I’m thinking %code{BasicMarkdown2HTML} and %code{HTMLForWriters2HTML}, and perhaps %code{DocBook2HTML}.
+
+  #li
+    #p A refactored parser that does not need to reset %code{@pos}, and maybe not even have any kind of mutable state at all.
+
+  #li
+    #p Fancy exception handling actually used somewhere.
+
+  #li
+    #p Documentation for every exception that occurs.

data/lib/d-mark/parser.rb

@@ -4,20 +4,35 @@ module DMark
       attr_reader :line_nr
       attr_reader :col_nr
 
-      def initialize(line_nr, col_nr, msg)
+      def initialize(line_nr, col_nr, msg, content)
         @line_nr = line_nr
         @col_nr = col_nr
         @msg = msg
+        @content = content
 
         super("parse error at line #{@line_nr + 1}, col #{@col_nr + 1}: #{@msg}")
       end
+
+      def fancy_message
+        line = @content.lines[line_nr]
+
+        lines = [
+          message,
+          '',
+          line.rstrip,
+          "\e[31m" + ' ' * [col_nr, 0].max + '↑' + "\e[0m"
+        ]
+
+        lines.join("\n")
+      end
     end
 
     attr_reader :pos
 
     def initialize(input)
       @input = input
-      @input_chars = @input.chars
+      @input_chars = input.chars
+      @length = @input_chars.size
 
       @pos = 0
       @col_nr = 0
@@ -40,6 +55,7 @@ module DMark
 
       loop do
         break if eof?
+
         res << read_block_with_children
       end
 
@@ -48,20 +64,12 @@ module DMark
 
     ##########
 
-    def peek_char(pos = @pos)
-      if eof?
-        nil
-      else
-        @input_chars[pos]
-      end
-    end
-
     def eof?(pos = @pos)
-      pos >= @input_chars.size
+      pos >= @length
     end
 
     def advance
-      if !eof? && @input_chars[@pos] == "\n"
+      if @input_chars[@pos] == "\n"
         @line_nr += 1
         @col_nr = 0
       end
@@ -70,10 +78,10 @@ module DMark
       @col_nr += 1
     end
 
-    def read_char(c)
-      char = peek_char
-      if char != c
-        raise_parse_error("expected #{c.inspect}, but got #{char.nil? ? 'EOF' : char.inspect}")
+    def read_char(expected_char)
+      char = @input_chars[@pos]
+      if char != expected_char
+        raise_parse_error("expected #{expected_char.inspect}, but got #{char.nil? ? 'EOF' : char.inspect}")
       else
         advance
         char
@@ -118,7 +126,7 @@ module DMark
       pos = @pos
 
       loop do
-        case peek_char(pos)
+        case @input_chars[pos]
         when ' '
           pos += 1
         when nil
@@ -133,32 +141,11 @@ module DMark
 
     # FIXME: ugly and duplicated
     def try_read_block_start
-      old_pos = @pos
-
-      success =
-        if try_read_identifier_head
-          read_identifier_tail
-
-          case peek_char
-          when '['
-            true
-          when '.'
-            advance
-            [' ', "\n", nil].include?(peek_char)
-          end
-        end
-
-      @pos = old_pos
-      success
-    end
-
-    # FIXME: ugly and duplicated
-    def try_read_identifier_head
-      char = peek_char
-      case char
-      when 'a'..'z'
-        advance
-        char
+      if @input_chars[@pos] == '#'
+        next_char = @input_chars[@pos + 1]
+        ('a'..'z').cover?(next_char)
+      else
+        false
       end
     end
 
@@ -167,7 +154,7 @@ module DMark
       pos = @pos
 
       loop do
-        case peek_char(pos)
+        case @input_chars[pos]
         when ' '
           pos += 1
           indentation_chars += 1
@@ -187,18 +174,17 @@ module DMark
     end
 
     def read_single_block
+      read_char('#')
       identifier = read_identifier
 
       attributes =
-        if peek_char == '['
+        if @input_chars[@pos] == '['
           read_attributes
         else
           {}
         end
 
-      read_char('.')
-
-      case peek_char
+      case @input_chars[@pos]
       when nil, "\n"
         advance
         ElementNode.new(identifier, attributes, [])
@@ -211,7 +197,7 @@ module DMark
     end
 
     def read_end_of_inline_content
-      char = peek_char
+      char = @input_chars[@pos]
       case char
       when "\n", nil
         advance
@@ -229,9 +215,9 @@ module DMark
     end
 
     def read_identifier_head
-      char = peek_char
+      char = @input_chars[@pos]
       case char
-      when 'a'..'z'
+      when 'a'..'z', 'A'..'Z'
         advance
         char
       else
@@ -239,18 +225,17 @@ module DMark
       end
     end
 
+    IDENTIFIER_CHARS = Set.new(['a'..'z', 'A'..'Z', ['-', '_'], '0'..'9'].map(&:to_a).flatten)
+
     def read_identifier_tail
       res = ''
 
       loop do
-        char = peek_char
-        case char
-        when 'a'..'z', '-', '0'..'9'
-          advance
-          res << char
-        else
-          break
-        end
+        char = @input_chars[@pos]
+        break unless IDENTIFIER_CHARS.include?(char)
+
+        advance
+        res << char
       end
 
       res.to_s
@@ -263,7 +248,7 @@ module DMark
 
       at_start = true
       loop do
-        char = peek_char
+        char = @input_chars[@pos]
         case char
         when ']'
           advance
@@ -272,7 +257,7 @@ module DMark
           read_char(',') unless at_start
 
           key = read_attribute_key
-          if peek_char == '='
+          if @input_chars[@pos] == '='
             read_char('=')
             value = read_attribute_value
           else
@@ -297,7 +282,7 @@ module DMark
 
       is_escaping = false
       loop do
-        char = peek_char
+        char = @input_chars[@pos]
 
         if is_escaping
           case char
@@ -337,7 +322,7 @@ module DMark
       res = []
 
       loop do
-        char = peek_char
+        char = @input_chars[@pos]
         case char
         when "\n", nil
           break
@@ -358,7 +343,7 @@ module DMark
       res = ''
 
       loop do
-        char = peek_char
+        char = @input_chars[@pos]
         case char
         when nil, "\n", '%', '}'
           break
@@ -368,17 +353,17 @@ module DMark
         end
       end
 
-      res.to_s
+      res
     end
 
     def read_percent_body
-      char = peek_char
+      char = @input_chars[@pos]
       case char
-      when '%', '}'
+      when '%', '}', '#'
         advance
-        char.to_s
+        char
       when nil, "\n"
-        raise_parse_error("expected something after %")
+        raise_parse_error('expected something after %')
       else
         read_inline_element
       end
@@ -387,7 +372,7 @@ module DMark
     def read_inline_element
       name = read_identifier
       attributes =
-        if peek_char == '['
+        if @input_chars[@pos] == '['
           read_attributes
         else
           {}
@@ -400,7 +385,7 @@ module DMark
     end
 
     def raise_parse_error(msg)
-      raise ParserError.new(@line_nr, @col_nr, msg)
+      raise ParserError.new(@line_nr, @col_nr, msg, @input)
     end
   end
 end