metaheader 1.1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88dca1c4f81765e7568da7a5aa48b2d272975deb
-  data.tar.gz: f04beb0bd69cac43a5d9c044bdc5142475afa558
+  metadata.gz: b27a892f14adfb3c27237943a6092a25e7976b4a
+  data.tar.gz: 066516c6ee0af9a85544ef3ab226c249d2ed6d78
 SHA512:
-  metadata.gz: 741a2bb4f73c74bee313be60df2a82ef8fcee75bc6a848eed0917200cb8ef652a0df3b92211d638c60d8ff19b5b36e9e279d6d675d535bc89f5d25370bd1ba59
-  data.tar.gz: 492e930364f5af886d59a0accabd44aedf4787990da7725a2f0f579632faf0d67036bdecdf5249f4d6698cb4e1910dd213a34d06129be2420c2f9ab73050754e
+  metadata.gz: 0062129b4f626c499d89d340f6a43eb5f4a65ecf15632c186c9e3dbae68f5799c719e19d30b7c6835f5c98ccc7baf936fb5c0734a53e776d0d871ffa23bf29c7
+  data.tar.gz: 99f9068fbc6118c4bab541d6c96b8344ad80838f73990d9197ca0d2231a18af454975134ddf46afe1613c38842cd8bbd383d6e190f97c323507a51f0ee7e49d8

data/README.md

@@ -14,6 +14,10 @@
   value line 2
 
 @key
+@key true
+
+@nokey
+@key false
 ```
 
 Any kind of comment syntax or prefix can be used:
@@ -50,9 +54,10 @@ mh = MetaHeader.new input
 errors = mh.validate key: MetaHeader::REQUIRED
 
 # other validators are available:
+# mh.validate key: MetaHeader::BOOLEAN
 # mh.validate key: MetaHeader::OPTIONAL
 # mh.validate key: MetaHeader::SINGLELINE
-# mh.validate key: MetaHeader::HAS_VALUE
+# mh.validate key: MetaHeader::VALUE
 # mh.validate key: /^\w{2,}$/
 # mh.validate key: proc {|value| 'return nil or error' }
 

data/lib/metaheader/version.rb

@@ -1,4 +1,4 @@
 class MetaHeader
   # MetaHeader's version
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2'.freeze
 end

data/lib/metaheader.rb

@@ -28,10 +28,11 @@ class MetaHeader
     end
   end
 
-  REQUIRED = Object.new.freeze
+  BOOLEAN = Object.new.freeze
   OPTIONAL = Object.new.freeze
-  VALUE = Object.new.freeze
+  REQUIRED = Object.new.freeze
   SINGLELINE = Object.new.freeze
+  VALUE = Object.new.freeze
 
   # Whether to fail validation if unknown tags are encoutered.
   # @see #validate
@@ -71,15 +72,23 @@ class MetaHeader
   end
 
   # Returns the value of a tag by its name, or nil if not found.
+  # @param key [Symbol] tag name
+  # @param default [Object] value to return if key doesn't exist
   # @return [Object, nil]
-  def [](key)
-    tag = @data[key] and tag.value
+  def [](key, default = nil)
+    if tag = @data[key]
+      tag.value
+    else
+      default
+    end
   end
 
   # Replaces the value of a tag.
   # @param value the new value
   # @return value
   def []=(key, value)
+    raise ArgumentError, 'value cannot be nil' if value.nil?
+
     @data[key] ||= Tag.new key
     @data[key].value = value
   end
@@ -96,10 +105,23 @@ class MetaHeader
     @data.empty?
   end
 
+  # Whether a tag was found in the input.
+  # @param tag [Symbol] the tag to lookup
+  # @return [Boolean]
+  def has?(tag)
+    @data.has_key? tag.to_sym
+  end
+
+  # Removes a given tag from the list.
+  # @param tag [Symbol] the tag to remove
+  def delete(tag)
+    @data.delete tag
+  end
+
   # Make a hash from the parsed data
   # @return [Hash]
   def to_h
-    Hash[@data.map {|v| [v.first, v.last.value] }]
+    Hash[@data.map {|name, tag| [name, tag.value] }]
   end
 
   # Makes a human-readable representation of the current instance.
@@ -116,10 +138,11 @@ class MetaHeader
   #     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 REQUIRED
+  # @see BOOLEAN
   # @see OPTIONAL
-  # @see VALUE
+  # @see REQUIRED
   # @see SINGLELINE
+  # @see VALUE
   def validate(rules)
     errors = Array.new
 
@@ -148,6 +171,8 @@ 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
@@ -159,12 +184,8 @@ private
       if indent_level > 0
         tag = @data[@last_key]
 
-        if tag.value.is_a? String
-          tag.value += "\n"
-        else
-          tag.value = String.new
-        end
-
+        tag.value = @raw_value.to_s unless tag.value.is_a? String
+        tag.value += "\n" unless tag.value.empty?
         tag.value += stripped
 
         return
@@ -177,12 +198,29 @@ private
 
     # single line
     @last_prefix = match[:prefix]
-    @last_key = match[:key].downcase.gsub(/[^\w]/, '_').to_sym
+    key = match[:key].downcase.gsub(/[^\w]/, '_')
 
-    value = match[:value] || true
+    @raw_value = match[:value]
+    key, value = parse_value key, @raw_value
+
+    @last_key = key.to_sym
     @data[@last_key] = Tag.new match[:key].freeze, value
   end
 
+  def parse_value(key, value)
+    value ||= true
+
+    case value
+    when 'true'
+      value = true
+    when 'false'
+      value = false
+    when String
+      value = nil if value.empty?
+    end
+
+    [key, value]
+  end
 
   def validate_key(key, rules)
     rules = Array(rules)
@@ -212,6 +250,10 @@ private
         if str_value.empty?
           return "missing value for tag '%s'" % tag.name
         end
+      when BOOLEAN
+        unless [TrueClass, FalseClass].include? tag.value.class
+          return "tag '%s' cannot have a value" % tag.name
+        end
       when Regexp
         unless rule.match str_value
           return "invalid value for tag '%s'" % tag.name
@@ -221,7 +263,7 @@ private
           return "invalid value for tag '%s': %s" % [tag.name, error]
         end
       else
-        raise ArgumentError
+        raise ArgumentError, "unsupported validator #{rule}"
       end
     }
 

data/test/test_parser.rb

@@ -51,13 +51,22 @@ class TestParser < MiniTest::Test
     mh[:hello] = 'bacon'
     assert_equal 'bacon', mh[:hello]
     assert_equal 1, mh.size
+
+    error = assert_raises(ArgumentError) { mh[:hello] = nil }
+    assert_equal 'value cannot be nil', error.message
   end
 
-  def test_unrequired_value
-    mh = MetaHeader.new '@hello'
+  def test_implicit_boolean
+    mh = MetaHeader.new "@hello"
     assert_equal true, mh[:hello]
   end
 
+  def test_explicit_boolean
+    mh = MetaHeader.new "@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'
     assert_equal 'bacon', mh[:chunky]
@@ -120,6 +129,18 @@ class TestParser < MiniTest::Test
     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
@@ -152,6 +173,15 @@ class TestParser < MiniTest::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_read_file
     path = File.expand_path '../input/basic_tag', __FILE__
     mh = MetaHeader.from_file path
@@ -219,4 +249,22 @@ class TestParser < MiniTest::Test
     assert_equal File.read(path), CustomParser.input
     assert_same mh, CustomParser.instance
   end
+
+  def test_has_tag
+    mh = MetaHeader.new '@hello'
+    assert_equal true, mh.has?(:hello)
+    assert_equal false, mh.has?(:world)
+  end
+
+  def test_default_value
+    mh = MetaHeader.new String.new
+    assert_equal 'world', mh[:hello, 'world']
+  end
+
+  def test_delete
+    mh = MetaHeader.new '@hello world'
+    assert mh.has?(:hello)
+    mh.delete :hello
+    refute mh.has?(:hello)
+  end
 end

data/test/test_validator.rb

@@ -93,8 +93,18 @@ class TestValidator < MiniTest::Test
   end
 
   def test_invalid_rule
-    assert_raises ArgumentError do
-      validate '@hello world', hello: Object.new
+    obj = Object.new.freeze
+
+    error = assert_raises ArgumentError do
+      validate '@hello world', hello: obj
     end
+
+    assert_equal "unsupported validator #{obj.inspect}", error.message
+  end
+
+  def test_boolean
+    actual = validate "@hello true\n@hello world",
+      hello: MetaHeader::BOOLEAN
+    assert_equal ["tag 'hello' cannot have a value"], actual
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metaheader
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '1.2'
 platform: ruby
 authors:
 - cfillion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-07 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler