metaheader 1.2.1 → 1.3beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072b809611c9fdd9b3cda179f3a755ddef92685f
-  data.tar.gz: 0e68adce0f7675b27aa6ce58ce26f43de34f392e
+  metadata.gz: b2785ed7e70b818e49c72e9f8d8dfa868f382936
+  data.tar.gz: 69186b6be145a432dc9dc81efbc1d86f9c6b8c1c
 SHA512:
-  metadata.gz: 64c0785eb124d9a096467f11b3449a6def1c5a7b65c8198b378c04cdcfd45c0c27297df386746c4f0e3d28e142a9d3fcce05e07287a7d5f0ad39cce3d9027a6a
-  data.tar.gz: 15b1bd95e2fc1d4c8578e0d1eae8fa2a4a61e153ce307cbbc8fbe4526bfd2813995dc276ba557a5317350878d26f80e263f903e2db34101953530fad46e0f1ad
+  metadata.gz: 5cda458f1ad6a0a11c97018655aae2b66656b497316c35826d3f6567eabf7f84482f12a3591f8bd163ce80c40c332db3c211849f57e98afb7d7e8e901305e61b
+  data.tar.gz: 0bfe9167f00907300ceccadcc662287081036e70b251f637209c11048932f10fbe99fe09eaf7852c66a7bb5f67862a86400f72dd5b0f0dbecdb8380f7154aed1

data/lib/metaheader/version.rb

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

data/lib/metaheader.rb

@@ -64,7 +64,6 @@ class MetaHeader
     @data = {}
 
     @last_key = nil
-    @last_prefix = String.new
 
     input = input.encode universal_newline: true
     input.each_line {|line|
@@ -120,7 +119,7 @@ class MetaHeader
   # @param tag [Symbol] the tag to lookup
   # @return [Boolean]
   def has?(tag)
-    @data.has_key? tag.to_sym
+    @data.has_key? tag
   end
 
   # Removes a given tag from the list.
@@ -158,8 +157,8 @@ class MetaHeader
     errors = Array.new
 
     if @strict
-      @data.each_key {|key|
-        errors << "unknown tag '%s'" % key unless rules.has_key? key
+      @data.each {|key, tag|
+        errors << "unknown tag '%s'" % tag.name unless rules.has_key? key
       }
     end
 
@@ -172,6 +171,28 @@ class MetaHeader
     errors unless errors.empty?
   end
 
+  # Rename one or more tags.
+  # @param old [Symbol, Hash]
+  # @param new [Symbol]
+  # @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 }
+    else
+      Array(tags).each {|old|
+        @data[new] = delete old if has? old
+      }
+    end
+  end
+
 private
   # @api private
   Tag = Struct.new :name, :value
@@ -182,29 +203,19 @@ private
     \Z/x.freeze
 
   def parse(line)
-    line.rstrip!
-
-    # multiline value must have the same prefix
-    if @last_key && line.index(@last_prefix) == 0
-      # remove the line prefix
-      mline = line[@last_prefix.size..-1]
-      stripped = mline.strip
-
-      indent_level = mline.index stripped
-
-      if indent_level > 0
-        tag = @data[@last_key]
-
-        tag.value = @raw_value.to_s unless tag.value.is_a? String
-        tag.value += "\n" unless tag.value.empty?
-        tag.value += stripped
+    line.chomp!
 
+    # multiline value must have the same line prefix as the key
+    if @last_key && line.start_with?(@last_prefix.rstrip)
+      if append line
         return
       else
         @last_key = nil
       end
     end
 
+    line.rstrip!
+
     return unless match = REGEX.match(line)
 
     # single line
@@ -216,16 +227,41 @@ private
 
     @last_key = key.to_sym
     @data[@last_key] = Tag.new match[:key].freeze, value
+    @line_breaks = 0
   end
 
-  def parse_value(key, value)
-    value ||= true
+  def append(line)
+    if line.rstrip == @last_prefix.rstrip
+      @line_breaks += 1
+      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
+    else
+      return
+    end
+
+    tag = @data[@last_key]
+    tag.value = @raw_value.to_s unless tag.value.is_a? String
 
+    @line_breaks += 1 unless tag.value.empty?
+    tag.value += "\n" * @line_breaks
+    @line_breaks = 0
+
+    tag.value += stripped
+    stripped
+  end
+
+  def parse_value(key, value)
     case value
     when 'true'
       value = true
     when 'false'
       value = false
+    when nil
+      value = true
     when String
       value = nil if value.empty?
     end

data/test/test_parser.rb

@@ -109,6 +109,11 @@ class TestParser < MiniTest::Test
     assert_equal 2, mh.size
   end
 
+  def test_trailing_whitespace
+    mh = MetaHeader.new '@hello world   '
+    assert_equal 'world', mh[:hello]
+  end
+
   def test_multiline
     mh = MetaHeader.new <<-IN
     @test Lorem
@@ -137,8 +142,8 @@ class TestParser < MiniTest::Test
       test\x20
     IN
 
-    assert_equal 'test', mh[:hello]
-    assert_equal 'test', mh[:world]
+    assert_equal 'test ', mh[:hello]
+    assert_equal 'test ', mh[:world]
   end
 
   def test_multiline_prefix
@@ -182,6 +187,32 @@ class TestParser < MiniTest::Test
     assert_equal "true\ntest", mh[:test]
   end
 
+  def test_multiline_empty_line
+    mh = MetaHeader.new <<-IN
+    --@test
+    --  Hello
+    --
+    --  World
+    --
+    --@chunky
+    --  bacon
+    IN
+
+    assert_equal "Hello\n\nWorld", mh[:test]
+    assert_equal 'bacon', mh[:chunky] # no leading newline
+  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_read_file
     path = File.expand_path '../input/basic_tag', __FILE__
     mh = MetaHeader.from_file path
@@ -271,5 +302,38 @@ class TestParser < MiniTest::Test
   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.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.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.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 }
   end
 end

data/test/test_validator.rb

@@ -6,11 +6,11 @@ class TestValidator < MiniTest::Test
   end
 
   def test_unknown_strict
-    mh = MetaHeader.new "@hello\n@world"
+    mh = MetaHeader.new "@hello\n@WORLD"
     mh.strict = true
 
     actual = mh.validate Hash.new
-    assert_equal ["unknown tag 'hello'", "unknown tag 'world'"], actual
+    assert_equal ["unknown tag 'hello'", "unknown tag 'WORLD'"], actual
   end
 
   def test_unknown_tolerant
@@ -107,4 +107,11 @@ class TestValidator < MiniTest::Test
       hello: MetaHeader::BOOLEAN
     assert_equal ["tag 'hello' cannot have a value"], actual
   end
+
+  def test_alias
+    mh = MetaHeader.new "@a"
+    mh.alias :a, :b
+    assert_equal ["missing value for tag 'a'"],
+      mh.validate(b: [MetaHeader::REQUIRED, MetaHeader::VALUE])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metaheader
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3beta1
 platform: ruby
 authors:
 - cfillion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,9 +118,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 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.1