metaheader 1.3beta3 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4da8975afe832f43e402d8055e6d0b5ffd116b8
-  data.tar.gz: 8370402e66dd19c47c31959a1104492b38b680b2
+SHA256:
+  metadata.gz: 551a95591a97a5578a68b27fd13ec3f7e20a23925884b222bdf1d276fdb58910
+  data.tar.gz: f1d46558535100ff763f79f8d1a67fbb8965fd0a305f0cc249815fbe0a3fab78
 SHA512:
-  metadata.gz: 61ed6799668cbd4fea43f71cca2318dfb2f8ec1b9d39bcd4fd02762c63c118d9792eadc4e33ca542e4bdcdd85dafda35af69238719a73c702fe188655472f638
-  data.tar.gz: 77fb389959db93f0aa8ceeba8ca188210e18cca144c5bbf8712dd4067a253a86f14e5728de607a11c54a9af6c8873adeef0b935b80dac1b9c81e0b9b3d16840f
+  metadata.gz: 134d937cd06dfa13fd548cee84fa69b7e2368a7e603228cfcc56e54a96b2e321173a026d3df1abfcda35e223aa464f426d00fe2b4cbdd55c6478d5073e0f8f9c
+  data.tar.gz: c28c1672dc9feb00d073f199ff53373852915cd75b78603437a67c2c10bbdca290638d5621aca0dbdcaf0d0a281ac97980381bb472249d8afb31b447f1da4e18

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'pry'
-
 gemspec

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/metaheader.svg)](http://badge.fury.io/rb/metaheader)
 [![Build Status](https://travis-ci.org/cfillion/metaheader.svg?branch=master)](https://travis-ci.org/cfillion/metaheader)
-[![Coverage Status](https://coveralls.io/repos/cfillion/metaheader/badge.svg?branch=master&service=github)](https://coveralls.io/github/cfillion/metaheader?branch=master)
 
 ## Syntax
 
@@ -20,7 +19,8 @@
 @key false
 ```
 
-Any kind of comment syntax or prefix can be used:
+Any kind of comment syntax or prefix can be used (every line of a multiline
+value must begin with the same decoration characters):
 
 ```cpp
 /*
@@ -28,13 +28,14 @@ Any kind of comment syntax or prefix can be used:
  */
 ```
 
-An alternative syntax is also supported:
+An alternative syntax that allows spaces in the key name is also supported:
 
 ```
-Key Name: Value
+Key: Value
 ```
 
-Parsing stops at the first empty line (ignoring white space).
+Parsing stops at the first empty line outside of a multiline value
+(ignoring white space).
 
 ## Usage
 
@@ -42,14 +43,11 @@ Parsing stops at the first empty line (ignoring white space).
 require 'metaheader'
 
 input = '@key value'
-mh = MetaHeader.new input
+mh = MetaHeader.parse input
 
 # alternatively:
 # mh = MetaHeader.from_file path
 
-# mark unknown keys as invalid
-# mh.strict = true
-
 # set @key as mandatory
 errors = mh.validate key: MetaHeader::REQUIRED
 
@@ -66,13 +64,12 @@ value = mh[:key]
 
 ## Documentation
 
-MetaHeader's documentation is hosted at
-[http://rubydoc.info/gems/metaheader/MetaHeader](http://rubydoc.info/gems/metaheader/MetaHeader).
+MetaHeader's documentation is hosted at <https://rubydoc.info/gems/metaheader/MetaHeader>.
 
 ## Contributing
 
 1. [Fork this repository](https://github.com/cfillion/metaheader/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git switch -c my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push -u origin my-new-feature`)
 5. Create a new Pull Request

data/lib/metaheader.rb

@@ -1,84 +1,69 @@
 require 'metaheader/version'
 
-class MetaHeader
-  # @abstract Subclass and override {#parse} to implement a custom parser.
-  class Parser
-    class << self
-      # @api private
-      def inherited(k)
-        @parsers ||= []
-        @parsers << k
-      end
-
-      # @api private
-      def each(&b)
-        @parsers&.each(&b)
-      end
-    end
+require 'stringio'
 
-    # @return [MetaHeader] the current instance
-    def header
-      @mh
-    end
+# Parser for metadata header in plain-text files
+# @example
+#   mh = MetaHeader.parse '@hello world'
+#   puts mh[:hello]
+class MetaHeader
+  # Allow a tag to be omitted when validating in strict mode.
+  OPTIONAL = Object.new.freeze
 
-    # @param raw_input [IO]
-    # @return [void]
-    def parse(raw_input)
-      raise NotImplementedError
-    end
-  end
+  # Ensure a tag exists during validation.
+  REQUIRED = Object.new.freeze
 
+  # The tag cannot hold a value beside true or false during validation.
   BOOLEAN = Object.new.freeze
-  OPTIONAL = Object.new.freeze
-  REQUIRED = Object.new.freeze
-  SINGLELINE = Object.new.freeze
+
+  # The tag must have a string value (non-boolean tag) during validation.
   VALUE = Object.new.freeze
 
-  # Whether to fail validation if unknown tags are encoutered.
-  # @see #validate
-  # @return [Boolean]
-  attr_accessor :strict
+  # Don't allow multiline values during validation.
+  SINGLELINE = Object.new.freeze
 
   # Create a new instance from the contents of a file.
   # @param path [String] path to the file to be read
   # @return [MetaHeader]
   def self.from_file(path)
-    File.open(path) {|file| self.new file }
+    File.open(path) {|file| self.parse file }
   end
 
-  # Construct a new MetaHeader object or return the object untouched
-  # @param input [String, MetaHeader]
+  # Construct a MetaHeader object and parse every tags found in the input up to
+  # the first newline.
+  # @param input [String, IO, StringIO]
   # @return [MetaHeader]
   def self.parse(input)
-    if input.is_a? self
-      input
-    else
-      self.new input
-    end
+    mh = MetaHeader.new
+    mh.parse input
+    mh
   end
 
-  # Parse every tags found in input up to the first newline.
-  # @param input [String, IO]
-  def initialize(input)
-    @strict = false
+  # Construct a blank MetaHeader object
+  def initialize
     @data = {}
+  end
 
-    @last_tag = nil
-    @empty_lines = 0
-
-    unless input.is_a? IO
+  # Parse every tags found in the input up to the first newline.
+  # @param input [String, IO, StringIO]
+  # @return [Integer] Character position of the first content line in the input
+  # data following the header.
+  def parse(input)
+    if input.is_a? String
       input = StringIO.new input.encode universal_newline: true
     end
 
-    input.each_line {|line| break unless parse line }
-
-    Parser.each {|klass|
-      input.rewind
+    @last_tag = nil
+    @empty_lines = 0
 
-      parser = klass.new
-      parser.instance_variable_set :@mh, self
-      parser.parse input
-    }
+    content_offset = 0
+    input.each_line do |line|
+      full_line_size = line.size # parse_line can trim the line
+      continue = parse_line line
+      content_offset += full_line_size if continue || line.empty?
+      break unless continue
+    end
+    content_offset
   end
 
   # Returns the value of a tag by its name, or nil if not found.
@@ -95,7 +80,7 @@ class MetaHeader
 
   # Replaces the value of a tag.
   # @param value the new value
-  # @return value
+  # @return [Object] value
   def []=(key, value)
     raise ArgumentError, 'value cannot be nil' if value.nil?
 
@@ -104,7 +89,7 @@ class MetaHeader
   end
 
   # Returns how many tags were found in the input.
-  # @return [Fixnum]
+  # @return [Integer]
   def size
     @data.size
   end
@@ -129,7 +114,7 @@ class MetaHeader
   end
 
   # Make a hash from the parsed data
-  # @return [Hash]
+  # @return [Hash<Symbol, Object>]
   def to_h
     Hash[@data.map {|name, tag| [name, tag.value] }]
   end
@@ -141,22 +126,25 @@ class MetaHeader
   end
 
   # Validates parsed data according to a custom set of rules.
+  # A rule can be one of the predefined constants, a regex, a proc or a
+  # method (returing nil if the tag is valid or an error string otherwise).
   # @example
   #   mh = MetaHeader.new "@hello world\n@chunky bacon"
   #   mh.validate \
   #     hello: [MetaHeader::REQUIRED, MetaHeader::SINGLELINE, /\d/],
   #     chunky: proc {|value| 'not bacon' unless value == 'bacon' }
-  # @param rules [Hash] tag_name => rule or array_of_rules
-  # @return [Array, nil] error list or nil
-  # @see BOOLEAN
+  # @param rules [Hash] :tag_name => rule or [rule1, rule2, ...]
+  # @param strict [Boolean] Whether to report unknown tags as errors
+  # @return [Array<String>] List of error messasges
   # @see OPTIONAL
   # @see REQUIRED
-  # @see SINGLELINE
+  # @see BOOLEAN
   # @see VALUE
-  def validate(rules)
-    errors = Array.new
+  # @see SINGLELINE
+  def validate(rules, strict = false)
+    errors = []
 
-    if @strict
+    if strict
       @data.each {|key, tag|
         errors << "unknown tag '%s'" % tag.name unless rules.has_key? key
       }
@@ -168,27 +156,22 @@ class MetaHeader
       end
     }
 
-    errors unless errors.empty?
+    errors
   end
 
   # Rename one or more tags.
-  # @param old [Symbol, Hash]
-  # @param new [Symbol]
+  # @param old [Symbol, Array<Symbol>, Hash<Symbol, Symbol>]
+  # @param new [Symbol] Ignored if old is a Hash
   # @example
   #   mh.alias :old, :new
-  #   mh.alias :old1, :old2, :new
   #   mh.alias [:old1, :old2], :new
   #   mh.alias old1: :new1, old2: :new2
-  def alias(*args)
-    raise ArgumentError, 'wrong number of arguments' unless args.size.between? 1, 2
-
-    tags, new = args
-
-    if args.size == 1
-      tags.each {|k, v| self.alias k, v }
+  def alias(old, new = nil)
+    if old.is_a? Hash
+      old.each {|k, v| self.alias k, v }
     else
-      Array(tags).each {|old|
-        @data[new] = delete old if has? old
+      Array(old).each {|tag|
+        @data[new] = delete tag if has? tag
       }
     end
   end
@@ -202,8 +185,9 @@ private
     (?:\s*(?<value>[^\n]+))?
     \Z/x.freeze
 
-  def parse(line)
+  def parse_line(line)
     line.chomp!
+    line.encode! Encoding::UTF_8, invalid: :replace
 
     # multiline value must have the same line prefix as the key
     if @last_tag && line.start_with?(@last_prefix.rstrip)
@@ -227,6 +211,7 @@ private
 
     @last_tag = Tag.new match[:key].freeze, value
     @line_breaks = 0
+    @block_indent = nil
 
     # disable implicit values with the alternate syntax
     register @last_tag unless match[:alt] && match[:value].nil?
@@ -236,10 +221,12 @@ private
   end
 
   def register(tag)
+    return if has? tag
     key = tag.name.downcase.gsub(/[^\w]/, '_').to_sym
     @data[key] = tag
   end
 
+  # handle multiline tags
   def append(line)
     prefix = line.rstrip
     if prefix == @last_prefix.rstrip
@@ -248,9 +235,19 @@ private
       return true # add the line break later
     elsif line.start_with? @last_prefix
       mline = line[@last_prefix.size..-1]
-      stripped = mline.lstrip
-      indent_level = mline.index stripped
-      return if indent_level < 1
+
+      if @block_indent
+        if mline.start_with? @block_indent
+          stripped = mline[@block_indent.size..-1]
+        else
+          return
+        end
+      else
+        stripped = mline.lstrip
+        indent_level = mline.index stripped
+        return if indent_level < 1
+        @block_indent = mline[0, indent_level]
+      end
     else
       return
     end

data/lib/metaheader/version.rb

@@ -1,4 +1,4 @@
 class MetaHeader
   # MetaHeader's version
-  VERSION = '1.3beta3'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/metaheader.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name          = "metaheader"
   spec.version       = MetaHeader::VERSION
   spec.authors       = ["cfillion"]
-  spec.email         = ["metaheader@cfillion.tk"]
+  spec.email         = ["metaheader@cfillion.ca"]
   spec.summary       = %q{Parser for metadata headers in plain-text files}
   spec.homepage      = "https://github.com/cfillion/metaheader"
   spec.license       = "LGPL-3.0+"
@@ -20,9 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'minitest', '~> 5.8'
-  spec.add_development_dependency 'rake', '~> 11.0'
-  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
 end

data/test/helper.rb

@@ -1,11 +1,7 @@
-require 'coveralls'
 require 'simplecov'
 
-Coveralls::Output.silent = true
-
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter,
 ]
 
 SimpleCov.start {

data/test/test_multiline.rb

@@ -0,0 +1,193 @@
+require File.expand_path '../helper', __FILE__
+
+class TestMultiline < MiniTest::Test
+  def test_multiline
+    mh = MetaHeader.parse <<-IN
+    @test Lorem
+      Ipsum
+    IN
+
+    assert_equal "Lorem\nIpsum", mh[:test]
+    assert_equal 1, mh.size
+  end
+
+  def test_variant
+    mh = MetaHeader.parse <<-IN
+    @test
+      Lorem
+      Ipsum
+    IN
+
+    assert_equal "Lorem\nIpsum", mh[:test]
+  end
+
+  def test_trailing_space
+    mh = MetaHeader.parse <<-IN
+    @hello\x20
+      test\x20
+    @world\x20\x20
+      test\x20
+    IN
+
+    assert_equal 'test ', mh[:hello]
+    assert_equal 'test ', mh[:world]
+  end
+
+  def test_prefix
+    mh = MetaHeader.parse <<-IN
+--    @test Lorem
+--      Ipsum
+    IN
+
+    assert_equal "Lorem\nIpsum", mh[:test]
+    assert_equal 1, mh.size
+  end
+
+  def test_no_indent
+    mh = MetaHeader.parse <<-IN
+    @test Lorem
+    Ipsum
+      Test
+    IN
+
+    assert_equal 1, mh.size
+    assert_equal "Lorem", mh[:test]
+  end
+
+  def test_lose_indent
+    mh = MetaHeader.parse <<-IN
+    @test
+      Hello
+
+      World
+    @chunky bacon
+
+    @foo
+    IN
+
+    assert_equal "Hello\n\nWorld", mh[:test]
+    assert_equal 'bacon', mh[:chunky]
+    assert_nil mh[:foo]
+  end
+
+  def test_fewer_indent
+    mh = MetaHeader.parse <<-IN
+    @test Lorem
+      Ipsum
+     Hello
+      World
+    IN
+
+    assert_equal 1, mh.size
+    assert_equal "Lorem\nIpsum", mh[:test]
+  end
+
+  def test_extra_indent
+    mh = MetaHeader.parse <<-IN
+    @test Lorem
+      Ipsum
+        Hello
+      World
+    IN
+
+    assert_equal 1, mh.size
+    assert_equal "Lorem\nIpsum\n  Hello\nWorld", mh[:test]
+  end
+
+  def test_do_not_reuse_indent
+    mh = MetaHeader.parse <<-IN
+    @a
+      Lorem
+      Ipsum
+    @b
+    \tHello
+    \tWorld
+    IN
+
+    assert_equal 2, mh.size
+    assert_equal "Lorem\nIpsum", mh[:a]
+    assert_equal "Hello\nWorld", mh[:b]
+  end
+
+  def test_sub_alternate_syntax
+    mh = MetaHeader.parse <<-IN
+    @test Lorem
+      Ipsum:
+      Dolor: sit amet
+    IN
+
+    assert_equal "Lorem\nIpsum:\nDolor: sit amet", mh[:test]
+    assert_equal 1, mh.size
+  end
+
+  def test_explicit_boolean
+    mh = MetaHeader.parse <<-IN
+    @test true
+      test
+    IN
+
+    assert_equal "true\ntest", mh[:test]
+  end
+
+  def test_empty_line_prefix
+    mh = MetaHeader.parse <<-IN
+    --@test
+    --  Hello
+    --
+    --  World
+    --
+    --@chunky
+    --  bacon
+    IN
+
+    assert_equal "Hello\n\nWorld", mh[:test]
+    assert_equal 'bacon', mh[:chunky]
+  end
+
+  def test_empty_line_prefix_with_space
+    mh = MetaHeader.parse <<-IN
+    -- @test
+    --   Hello
+    --
+    --   World
+    IN
+
+    assert_equal "Hello\n\nWorld", mh[:test]
+  end
+
+  def test_empty_line
+    mh = MetaHeader.parse <<-IN
+    @test
+      Hello
+
+      World
+    @chunky bacon
+
+    @foo
+    IN
+
+    assert_equal "Hello\n\nWorld", mh[:test]
+    assert_equal 'bacon', mh[:chunky]
+    assert_nil mh[:foo]
+  end
+
+  def test_break_at_empty_line
+    mh = MetaHeader.parse <<-IN
+    -- @hello world
+
+    @chunky bacon
+    IN
+
+    assert_equal 'world', mh[:hello]
+    assert_nil mh[:chunky]
+  end
+
+  def test_alternate_syntax
+    mh = MetaHeader.parse <<-IN
+    -- Hello:
+    --   World
+    IN
+
+    assert_equal 'World', mh[:hello]
+  end
+end

data/test/test_parser.rb

@@ -1,47 +1,15 @@
 require File.expand_path '../helper', __FILE__
 
-class CustomParser < MetaHeader::Parser
-  def self.reset
-    @@called = false
-  end
-
-  def self.called?
-    @@called
-  end
-
-  def self.input
-    @@input
-  end
-
-  def self.instance
-    @@instance
-  end
-
-  def parse(input)
-    return unless header[:run_custom]
-
-    header[:hello] = header[:hello].to_s * 2
-
-    @@input = input.read
-    @@instance = header
-    @@called = true
-  end
-end
-
 class TestParser < MiniTest::Test
-  def setup
-    CustomParser.reset
-  end
-
   def test_basic_parser
-    mh = MetaHeader.new '@hello world'
+    mh = MetaHeader.parse '@hello world'
 
     assert_equal 'world', mh[:hello]
     assert_equal 1, mh.size
   end
 
   def test_set_value
-    mh = MetaHeader.new String.new
+    mh = MetaHeader.parse String.new
 
     assert_empty mh
     mh[:hello] = 'world'
@@ -57,23 +25,23 @@ class TestParser < MiniTest::Test
   end
 
   def test_implicit_boolean
-    mh = MetaHeader.new "@hello"
+    mh = MetaHeader.parse "@hello"
     assert_equal true, mh[:hello]
   end
 
   def test_explicit_boolean
-    mh = MetaHeader.new "@foo true\n@bar false"
+    mh = MetaHeader.parse "@foo true\n@bar false"
     assert_equal true, mh[:foo]
     assert_equal false, mh[:bar]
   end
 
   def test_ignore_prefix
-    mh = MetaHeader.new '-- @chunky bacon'
+    mh = MetaHeader.parse '-- @chunky bacon'
     assert_equal 'bacon', mh[:chunky]
   end
 
   def test_two_tags
-    mh = MetaHeader.new <<-IN
+    mh = MetaHeader.parse <<-IN
     -- @chunky bacon
     -- @hello world
     IN
@@ -84,7 +52,7 @@ class TestParser < MiniTest::Test
   end
 
   def test_break_at_empty_line
-    mh = MetaHeader.new <<-IN
+    mh = MetaHeader.parse <<-IN
     @hello world
 \x20
     @chunky bacon
@@ -95,7 +63,7 @@ class TestParser < MiniTest::Test
   end
 
   def test_ignore_c_comment_tokens
-    mh = MetaHeader.new <<-IN
+    mh = MetaHeader.parse <<-IN
 /*
     -- @hello world
 */
@@ -110,12 +78,12 @@ class TestParser < MiniTest::Test
   end
 
   def test_trailing_whitespace
-    mh = MetaHeader.new '@hello world   '
+    mh = MetaHeader.parse '@hello world   '
     assert_equal 'world', mh[:hello]
   end
 
   def test_empty_prefixed_line
-    mh = MetaHeader.new <<-IN
+    mh = MetaHeader.parse <<-IN
     -- @first
     --
     -- @second
@@ -124,272 +92,145 @@ class TestParser < MiniTest::Test
     refute_nil mh[:second]
   end
 
-  def test_multiline
-    mh = MetaHeader.new <<-IN
-    @test Lorem
-      Ipsum
-    IN
-
-    assert_equal "Lorem\nIpsum", mh[:test]
-    assert_equal 1, mh.size
-  end
-
-  def test_multiline_variant
-    mh = MetaHeader.new <<-IN
-    @test
-      Lorem
-      Ipsum
-    IN
-
-    assert_equal "Lorem\nIpsum", mh[:test]
-  end
-
-  def test_multiline_trailing_space
-    mh = MetaHeader.new <<-IN
-    @hello\x20
-      test\x20
-    @world\x20\x20
-      test\x20
-    IN
-
-    assert_equal 'test ', mh[:hello]
-    assert_equal 'test ', mh[:world]
-  end
-
-  def test_multiline_prefix
-    mh = MetaHeader.new <<-IN
---    @test Lorem
---      Ipsum
-    IN
-
-    assert_equal "Lorem\nIpsum", mh[:test]
-    assert_equal 1, mh.size
-  end
-
-  def test_multiline_wrong_indent
-    mh = MetaHeader.new <<-IN
-    @test Lorem
-    Ipsum
-      Test
-    IN
-
-    assert_equal 1, mh.size
-    assert_equal "Lorem", mh[:test]
-  end
-
-  def test_multiline_sub_alternate_syntax
-    mh = MetaHeader.new <<-IN
-    @test Lorem
-      Ipsum:
-      Dolor: sit amet
-    IN
+  def test_from_file
+    path = File.expand_path '../input/basic_tag', __FILE__
+    mh = MetaHeader.from_file path
 
-    assert_equal "Lorem\nIpsum:\nDolor: sit amet", mh[:test]
+    assert_equal 'Hello World', mh[:test]
     assert_equal 1, mh.size
   end
 
-  def test_multiline_explicit_boolean
-    mh = MetaHeader.new <<-IN
-    @test true
-      test
-    IN
-
-    assert_equal "true\ntest", mh[:test]
-  end
-
-  def test_multiline_empty_line_prefix
-    mh = MetaHeader.new <<-IN
-    --@test
-    --  Hello
-    --
-    --  World
-    --
-    --@chunky
-    --  bacon
-    IN
-
-    assert_equal "Hello\n\nWorld", mh[:test]
-    assert_equal 'bacon', mh[:chunky]
-  end
-
-  def test_multiline_empty_line_space_prefix
-    mh = MetaHeader.new <<-IN
-    -- @test
-    --   Hello
-    --
-    --   World
-    IN
-
-    assert_equal "Hello\n\nWorld", mh[:test]
-  end
-
-  def test_multiline_empty_line
-    mh = MetaHeader.new <<-IN
-    @test
-      Hello
-
-      World
-    @chunky bacon
-
-    @foo
-    IN
-
-    assert_equal "Hello\n\nWorld", mh[:test]
-    assert_equal 'bacon', mh[:chunky]
-    assert_nil mh[:foo]
-  end
-
-  def test_multiline_break_at_empty_line
-    mh = MetaHeader.new <<-IN
-    -- @hello world
-
-    @chunky bacon
-    IN
-
-    assert_equal 'world', mh[:hello]
-    assert_nil mh[:chunky]
-  end
-
-  def test_multiline_alternate_syntax
-    mh = MetaHeader.new <<-IN
-    -- Hello:
-    --   World
-    IN
-
-    assert_equal 'World', mh[:hello]
-  end
-
-  def test_read_file
+  def test_read_file_stream
     path = File.expand_path '../input/basic_tag', __FILE__
-    mh = MetaHeader.from_file path
+    mh = MetaHeader.parse File.open(path)
 
     assert_equal 'Hello World', mh[:test]
     assert_equal 1, mh.size
   end
 
+  def test_read_string_stream
+    stream = StringIO.new '@hello world'
+    MetaHeader.parse stream
+  end
+
   def test_to_hash
-    mh = MetaHeader.new '@key value'
+    mh = MetaHeader.parse '@key value'
     assert_equal Hash[key: 'value'], mh.to_h
   end
 
   def test_alternate_syntax
-    mh = MetaHeader.new 'Key Test: value'
+    mh = MetaHeader.parse 'Key Test: value'
     assert_equal Hash[key_test: 'value'], mh.to_h
   end
 
   def test_alternate_syntax_prefix
-    mh = MetaHeader.new '-- Key Test: Value'
+    mh = MetaHeader.parse '-- Key Test: Value'
     assert_equal Hash[key_test: 'Value'], mh.to_h
   end
 
-  def test_windows_newlines
-    mh = MetaHeader.new "key: value\r\n@run_custom"
+  def test_crlf_newlines
+    mh = MetaHeader.parse "key: value\r\n@run_custom"
     assert_equal 'value', mh[:key]
-    assert_equal "key: value\n@run_custom", CustomParser.input
+    assert_equal true, mh[:run_custom]
   end
 
   def test_alternate_syntax_trailing_space
-    mh = MetaHeader.new ' Key Test : Value'
+    mh = MetaHeader.parse ' Key Test : Value'
     assert_equal Hash[key_test: 'Value'], mh.to_h
   end
 
   def test_alternate_syntax_compact
-    mh = MetaHeader.new 'Key Test:Value'
+    mh = MetaHeader.parse 'Key Test:Value'
     assert_equal Hash[key_test: 'Value'], mh.to_h
   end
 
   def test_alternate_syntax_no_value
-    mh = MetaHeader.new 'Key Test:'
+    mh = MetaHeader.parse 'Key Test:'
     assert_equal Hash.new, mh.to_h
   end
 
   def test_inspect
-    mh = MetaHeader.new '@hello world'
+    mh = MetaHeader.parse '@hello world'
 
     hash = {hello: 'world'}
     assert_equal "#<MetaHeader #{hash.inspect}>", mh.inspect
   end
 
-  def test_default_parser_implementation
-    assert_raises NotImplementedError do
-      MetaHeader::Parser.new.parse String.new
-    end
-  end
-
-  def test_transform_from_text
-    input = "@run_custom\nHello\n\nWorld".freeze
-
-    mh = MetaHeader.new input
-
-    assert CustomParser.called?
-    assert_equal input, CustomParser.input
-    assert_same mh, CustomParser.instance
-  end
-
-  def test_transform_from_file
-    path = File.expand_path '../input/custom_parser', __FILE__
-
-    mh = MetaHeader.from_file path
-    assert_equal 'worldworld', mh[:hello]
-
-    assert CustomParser.called?
-    assert_equal File.read(path), CustomParser.input
-    assert_same mh, CustomParser.instance
-  end
-
   def test_has_tag
-    mh = MetaHeader.new '@hello'
+    mh = MetaHeader.parse '@hello'
     assert_equal true, mh.has?(:hello)
     assert_equal false, mh.has?(:world)
   end
 
   def test_default_value
-    mh = MetaHeader.new String.new
+    mh = MetaHeader.parse String.new
     assert_equal 'world', mh[:hello, 'world']
   end
 
   def test_delete
-    mh = MetaHeader.new '@hello world'
+    mh = MetaHeader.new
+    mh[:hello] = 'world'
     assert mh.has?(:hello)
     mh.delete :hello
     refute mh.has?(:hello)
   end
 
-  def test_construct_from_instance
-    mh = MetaHeader.new '@hello world'
-    assert_same mh, MetaHeader.parse(mh)
-    assert_equal mh.to_h, MetaHeader.parse('@hello world').to_h
-  end
-
   def test_alias
-    mh = MetaHeader.new '@a 1'
+    mh = MetaHeader.new
+    mh[:a] = '1'
     mh.alias :a, :b
     refute mh.has?(:a)
     assert_equal '1', mh[:b]
-
-    mh[:d] = '2'
-    mh.alias :c, :d
-    refute mh.has?(:c)
-    assert_equal '2', mh[:d]
   end
 
   def test_alias_hash
-    mh = MetaHeader.new "@a 1\n@b 2"
+    mh = MetaHeader.new
+    mh[:a] = '1'
+    mh[:b] = '2'
     mh.alias a: :c, b: :d
     assert_equal '1', mh[:c]
     assert_equal '2', mh[:d]
   end
 
   def test_alias_array
-    mh = MetaHeader.new "@a 1\n@b 2"
+    mh = MetaHeader.new
+    mh[:a] = '1'
+    mh[:b] = '2'
     mh.alias [:a, :b, :c], :d
     assert [:a, :b, :c].none? {|t| mh.has? t }
     assert_equal '2', mh[:d]
   end
 
-  def test_alias_invalid_args
-    mh = MetaHeader.new "@a 1\n@b 2"
-    assert_raises(ArgumentError) { mh.alias }
-    assert_raises(ArgumentError) { mh.alias 1, 2, 3 }
+  def test_utf16_bom
+    mh = MetaHeader.parse "\xff\xfe@a b\n"
+    assert_equal 'b', mh[:a]
+  end
+
+  def test_content_offset
+    mh = MetaHeader.new
+    input = "@hello\n@world s\n\nafter\n"
+    content_offset = mh.parse input
+    assert_equal input.index('after'), content_offset
+  end
+
+  def test_content_offset_decorated
+    mh = MetaHeader.new
+    input = "# @hello\n# @world\n\nafter\n"
+    content_offset = mh.parse input
+    assert_equal input.index('after'), content_offset
+  end
+
+  def test_content_offset_unicode
+    mh = MetaHeader.new
+    input = "@lang русский\n\nafter"
+    content_offset = mh.parse input
+    assert_equal input.index('after'), content_offset
+  end
+
+  def test_content_offset_trailing_space
+    mh = MetaHeader.new
+    input = "@foo\x20\x20\n  bar\n\nafter\n"
+    content_offset = mh.parse input
+    assert_equal input.index('after'), content_offset
   end
 end

data/test/test_validator.rb

@@ -2,42 +2,38 @@ require File.expand_path '../helper', __FILE__
 
 class TestValidator < MiniTest::Test
   def validate(input, rules)
-    MetaHeader.new(input).validate(rules)
+    MetaHeader.parse(input).validate(rules)
   end
 
   def test_unknown_strict
-    mh = MetaHeader.new "@hello\n@WORLD"
-    mh.strict = true
-
-    actual = mh.validate Hash.new
-    assert_equal ["unknown tag 'hello'", "unknown tag 'WORLD'"], actual
+    mh = MetaHeader.parse "@hello\n@WORLD"
+    errors = mh.validate Hash.new, true
+    assert_equal ["unknown tag 'hello'", "unknown tag 'WORLD'"], errors
   end
 
   def test_unknown_tolerant
-    mh = MetaHeader.new "@hello\n@world"
-    refute mh.strict
-
-    assert_nil mh.validate(Hash.new)
+    mh = MetaHeader.parse "@hello\n@world"
+    assert_empty mh.validate(Hash.new, false)
   end
 
   def test_strict_optional
-    mh = MetaHeader.new "@hello"
-    mh.strict = true
-
-    actual = mh.validate \
+    rules = {
       hello: MetaHeader::OPTIONAL,
-      world: MetaHeader::OPTIONAL
+      world: MetaHeader::OPTIONAL,
+    }
 
-    assert_nil actual
+    mh = MetaHeader.parse "@hello"
+    errors = mh.validate rules, true
+    assert_empty errors
   end
 
   def test_required
-    actual = validate '@foobar', version: MetaHeader::REQUIRED, foobar: []
-    assert_equal ["missing tag 'version'"], actual
+    errors = validate '@foobar', version: MetaHeader::REQUIRED, foobar: []
+    assert_equal ["missing tag 'version'"], errors
   end
 
   def test_singleline
-    mh = MetaHeader.new <<-IN
+    mh = MetaHeader.parse <<-IN
     @hello
       chunky
       bacon
@@ -46,50 +42,50 @@ class TestValidator < MiniTest::Test
       bar
     IN
 
-    actual = mh.validate :hello => MetaHeader::SINGLELINE
-    assert_equal ["tag 'hello' must be singleline"], actual
+    errors = mh.validate :hello => MetaHeader::SINGLELINE
+    assert_equal ["tag 'hello' must be singleline"], errors
   end
 
   def test_has_value
-    mh = MetaHeader.new '@hello'
+    mh = MetaHeader.parse '@hello'
 
-    actual = mh.validate :hello => [MetaHeader::VALUE]
-    assert_equal ["missing value for tag 'hello'"], actual
+    errors = mh.validate :hello => [MetaHeader::VALUE]
+    assert_equal ["missing value for tag 'hello'"], errors
   end
 
   def test_regex
-    actual = validate '@hello world', :hello => /\d+/
-    assert_equal ["invalid value for tag 'hello'"], actual
+    errors = validate '@hello world', :hello => /\d+/
+    assert_equal ["invalid value for tag 'hello'"], errors
   end
 
   def test_regex_no_value
-    mh = MetaHeader.new '@hello'
+    mh = MetaHeader.parse '@hello'
 
-    actual = mh.validate :hello => [/./]
-    assert_equal ["invalid value for tag 'hello'"], actual
+    errors = mh.validate :hello => [/./]
+    assert_equal ["invalid value for tag 'hello'"], errors
   end
 
   def test_custom_validator
-    actual = validate '@hello',
+    errors = validate '@hello',
       hello: Proc.new {|value| assert_equal true, value; nil }
-    assert_nil actual
+    assert_empty errors
 
-    actual = validate '@hello world',
+    errors = validate '@hello world',
       hello: Proc.new {|value| assert_equal 'world', value; nil }
-    assert_nil actual
+    assert_empty errors
 
-    actual = validate '@hello', hello: Proc.new {|value| 'Hello World!' }
-    assert_equal ["invalid value for tag 'hello': Hello World!"], actual
+    errors = validate '@hello', hello: Proc.new {|value| 'Hello World!' }
+    assert_equal ["invalid value for tag 'hello': Hello World!"], errors
   end
 
   def test_error_use_original_case
-    actual = validate 'HeLlO: world', hello: /\d+/
-    assert_equal ["invalid value for tag 'HeLlO'"], actual
+    errors = validate 'HeLlO: world', hello: /\d+/
+    assert_equal ["invalid value for tag 'HeLlO'"], errors
   end
 
   def test_single_error_per_tag
-    actual = validate '@hello', hello: [/\d/, /\d/]
-    assert_equal ["invalid value for tag 'hello'"], actual
+    errors = validate '@hello', hello: [/\d/, /\d/]
+    assert_equal ["invalid value for tag 'hello'"], errors
   end
 
   def test_invalid_rule
@@ -103,13 +99,13 @@ class TestValidator < MiniTest::Test
   end
 
   def test_boolean
-    actual = validate "@hello true\n@hello world",
+    errors = validate "@hello true\n@hello world",
       hello: MetaHeader::BOOLEAN
-    assert_equal ["tag 'hello' cannot have a value"], actual
+    assert_equal ["tag 'hello' cannot have a value"], errors
   end
 
   def test_alias
-    mh = MetaHeader.new "@a"
+    mh = MetaHeader.parse "@a"
     mh.alias :a, :b
     assert_equal ["missing value for tag 'a'"],
       mh.validate(b: [MetaHeader::REQUIRED, MetaHeader::VALUE])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metaheader
 version: !ruby/object:Gem::Version
-  version: 1.3beta3
+  version: 2.0.1
 platform: ruby
 authors:
 - cfillion
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,73 +16,59 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-description: 
+        version: '0.13'
+description:
 email:
-- metaheader@cfillion.tk
+- metaheader@cfillion.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -101,13 +87,14 @@ files:
 - test/helper.rb
 - test/input/basic_tag
 - test/input/custom_parser
+- test/test_multiline.rb
 - test/test_parser.rb
 - test/test_validator.rb
 homepage: https://github.com/cfillion/metaheader
 licenses:
 - LGPL-3.0+
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,18 +105,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Parser for metadata headers in plain-text files
 test_files:
 - test/helper.rb
 - test/input/basic_tag
 - test/input/custom_parser
+- test/test_multiline.rb
 - test/test_parser.rb
 - test/test_validator.rb