hummel 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51c766a08cd0ff86bb1c6e7b24015ac5a0dcb7bccfce1afd50b97943d5e2b2e4
-  data.tar.gz: ca7137d3dfe54500e91f34cc83f295b35096a688690168a13edcab8071522d33
+  metadata.gz: 4b63f273b7a493c53d0d0bdfad24ee9a273005cb0bc63cd81605d8bfd6f660dc
+  data.tar.gz: 446cb68dbfdf83a1182c88dcdeb40250548fc41a61bbe3f7fe440383591d0032
 SHA512:
-  metadata.gz: 16a70da398fb107964d014cd393a18417fc6112d7bbb854f72297e9626ef718b196bd8b6a128f95c23444c4db95b81add9708d2aa19e55b8fdf1a7fc2773f275
-  data.tar.gz: 28018bb7b58fcc429a53c8001ea643d62331aeec9432a8aa267a8c7ab03c3b1a7e1f9a4263d83621cd8b893e8067255b31918abf3d4d3529fbbc05a84ab9d5fa
+  metadata.gz: 6c5d709a0459493125a4caea694b7b89f93f8511207d9ff2e3a41d2389608f416860781a2b1d10633ccde5ea44aa87fee18f1dc041d49e243d50dc11b1861bac
+  data.tar.gz: 5a04eb2f91d13e99c060980e123f17447be47813579165c3ab6653accb6219c4dead58e5d71e5f399dfffcdef99cf54eadc190a1640329ec69475fec9fb77229

data/.ruby-version

@@ -1 +1 @@
-3.4.7
+4.0.1

data/CHANGELOG.md

@@ -1,5 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
+## [0.2.0] - 2026-02-16
+
+### Changed
+- Update parser and encoder to HUML v0.2.0 spec
+- Remove triple-backtick multiline string syntax
+- Triple-quote `"""` multiline strings now preserve relative indentation (strip uniform indent)
+- Enforce strict indentation for multiline vectors inside list items
+
+### Internal
+- Abort test suite early if `tests/` submodule is missing
+
+## [0.1.1] - 2025-10-12
+
+### Changed
+- Improve code coverage and remove dead code
+- Update README.md with naming scheme and fixes
+
+### Fixed
+- Fix README example
+
+### Internal
+- Achieve 100% code coverage
+- Add code coverage tracking with SimpleCov
+- Update CI workflow with permissions and coverage upload
+- Add matrix.ruby to artifact naming
+- Add workflow_dispatch trigger to CI
+
 ## [0.1.0] - 2025-10-12
 
 - Initial release

data/README.md

@@ -1,15 +1,13 @@
-# hummel
+# Hummel
 
-An HUML parser implementation in ruby.
-
-> **Note:** The gem is named `hummel` because `huml` was already taken on rubygems.org.
+An [HUML](https://huml.io) parser implementation in ruby.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hummel', source: 'https://gem.coop'
+gem 'hummel'
 ```
 
 And then execute:
@@ -21,7 +19,7 @@ bundle install
 Or install it yourself as:
 
 ```bash
-gem install hummel --source https://gem.coop
+gem install hummel
 ```
 
 ## Usage
@@ -32,9 +30,9 @@ gem install hummel --source https://gem.coop
 require 'hummel'
 
 huml_string = <<~HUML
-  name: John Doe
+  name: "John Doe"
   age: 30
-  email: john@example.com
+  email: "john@example.com"
 HUML
 
 data = Hummel::Decode.parse(huml_string)
@@ -80,7 +78,24 @@ Hummel::Encode.stringify(data, include_version: true)
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [gem.coop](https://gem.coop).
+To install this gem onto your local machine, run `bin/rake install`.
+
+To release a new version:
+
+1. Run tests and linters: `bin/rake` and address any issues in separate commits.
+2. Update the version number in `lib/hummel/version.rb`.
+3. Update the `CHANGELOG.md` to include this version and brief summaries of changes.
+4. Commit changes:
+
+        git add lib/hummel/version.rb CHANGELOG.md
+        git commit -m "Bump version to 0.2.0"
+
+5. Run `bin/rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+6. Create a GitHub Release from the tag with the CHANGELOG.md notes.
+
+> **Note**: In follow up commits to this release please re-add the [Unreleased] section to CHANGELOG.md for future work.
+
+> **Note**: Make sure you're authed with rubygems.org via `gem signin` before running the release command.
 
 ## Contributing
 
@@ -93,3 +108,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Hummel project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/djbender/hummel/blob/main/CODE_OF_CONDUCT.md).
+
+## Name
+
+This gem is named `hummel` because `huml` was already taken on [rubygems.org](https://rubygems.org).

data/lib/hummel/decode.rb

@@ -78,8 +78,8 @@ module Hummel
 
           if pos > starting_pos
             version = data[starting_pos...pos]
-            if version != "v0.1.0"
-              raise error("unsupported version '#{version}'. expected 'v0.1.0'")
+            if version != "v0.2.0"
+              raise error("unsupported version '#{version}'. expected 'v0.2.0'")
             end
           end
         end
@@ -178,7 +178,7 @@ module Hummel
         result[key] = if indicator == ":"
           assert_space("after ':'")
 
-          multiline = peek_string("```") || peek_string('""""')
+          multiline = peek_string('"""')
 
           value = parse_value(current_indent)
 
@@ -249,6 +249,10 @@ module Hummel
         vector_type = multiline_vector_type(indent)
         next_indent = current_indent
 
+        if next_indent != indent
+          raise error("bad indent #{next_indent}, expected #{indent}")
+        end
+
         parse_multiline_method = method(:"parse_multiline_#{vector_type}")
         return parse_multiline_method.call(next_indent)
       end
@@ -364,11 +368,11 @@ module Hummel
       character = data[self.pos]
 
       if character == '"'
-        return peek_string('"""') ? parse_multiline_string(key_indent, false) : parse_string
+        return peek_string('"""') ? parse_multiline_string(key_indent) : parse_string
       end
 
       if character == "`" && peek_string("```")
-        return parse_multiline_string(key_indent, true)
+        raise error("backtick multiline strings are not supported in HUML v0.2.0")
       end
 
       SPECIAL_VALUES.each do |string, value|
@@ -450,24 +454,19 @@ module Hummel
       raise error("unclosed string")
     end
 
-    def parse_multiline_string(key_indent, preserve_spaces)
+    def parse_multiline_string(key_indent)
       delimiter = data[pos, 3]
       advance(3)
       consume_line
 
-      # define line processing base on string type
-      process_line = if preserve_spaces
-        ->(content, line_indent) do
-          # strip required 2-space indent relative to key
-          required_indent = key_indent + 2
-          if content.length >= required_indent && space_string?(content[0, required_indent])
-            return content[required_indent..]
-          end
-
-          content
+      # strip required 2-space indent relative to key
+      required_indent = key_indent + 2
+      process_line = ->(content, _line_indent) do
+        if content.length >= required_indent && space_string?(content[0, required_indent])
+          return content[required_indent..]
         end
-      else
-        ->(content, _line_indent) { content.strip }
+
+        content
       end
 
       lines = []
@@ -515,7 +514,7 @@ module Hummel
 
       NUMBER_BASE_PREFIXES.each do |prefix, base|
         if peek_string(prefix)
-          parse_base(start: starting_pos, base: base, prefix:)
+          return parse_base(start: starting_pos, base: base, prefix:)
         end
       end
 
@@ -579,10 +578,7 @@ module Hummel
         line_start = self.pos
         skip_spaces
 
-        if done?
-          raise error("trailing spaces are not allowed") if self.pos > line_start
-          return
-        end
+        raise error("trailing spaces are not allowed") if done?
 
         if !["\n", "#"].include?(data[self.pos])
           return # Found content
@@ -714,9 +710,7 @@ module Hummel
       current_pos = pos
       while current_pos < data.length && !["\n", "#"].include?(data[current_pos])
         if data[current_pos] == ":"
-          if current_pos + 1 >= data.length || data[current_pos + 1] != ":"
-            return true
-          end
+          return true
         end
         current_pos += 1
       end
@@ -733,12 +727,12 @@ module Hummel
     end
 
     def inline_dict_at_root?
-      line_end = data.index("\n", pos) || data.length
-      comment_index = data.index("#", pos) || data.length
+      line_end = data.index("\n", pos)
+      comment_index = data.index("#", pos)
 
       marker = [
-        line_end,
-        comment_index
+        line_end || data.length,
+        comment_index || data.length
       ].min
 
       line = data[pos...marker]
@@ -747,13 +741,15 @@ module Hummel
 
       return false unless has_colon && has_comma
 
-      remaining_content = if line_end != -1
-        data[0...line_end]
+      remaining_content = if line_end.nil?
+        # Single-line input, no subsequent lines
+        false
       else
-        data
-      end.split("\n")[1..].any? do |line|
-        trimmed = line.strip
-        trimmed && !trimmed.start_with?("#")
+        # Multi-line input, check if subsequent lines have non-comment content
+        data.split("\n")[1..].any? do |line|
+          trimmed = line.strip
+          trimmed && !trimmed.start_with?("#")
+        end
       end
 
       !remaining_content
@@ -813,8 +809,6 @@ module Hummel
     end
 
     def skip_first
-      return unless block_given?
-
       @first = true if @first.nil?
       yield unless @first
       @first = false

data/lib/hummel/encode.rb

@@ -9,7 +9,7 @@ module Hummel
       # Convert a Ruby object to HUML format
       def stringify(obj, cfg = {})
         lines = []
-        lines.concat(["%HUML v0.1.0", ""]) if cfg[:include_version]
+        lines.concat(["%HUML v0.2.0", ""]) if cfg[:include_version]
 
         lines.concat(encode_value(obj, 0, true))
         lines << "" # Ensure document ends with newline
@@ -25,6 +25,7 @@ module Hummel
       def encode_value(value, indent, is_root_level = false)
         return ["null"] if value.nil?
 
+        # TODO: dynamic dispatch refactor?
         case value
         when TrueClass, FalseClass
           [value.to_s]
@@ -58,9 +59,8 @@ module Hummel
 
         # Multi-line string
         str_lines = str.split("\n")
-        str_lines.pop if str_lines.last && str_lines.last.empty?
 
-        ["```"] + str_lines.map { |line| "#{" " * indent}#{line}" } + ["#{" " * (indent - 2)}```"]
+        ['"""'] + str_lines.map { |line| "#{" " * indent}#{line}" } + ["#{" " * (indent - 2)}\"\"\""]
       end
 
       # Encode an array value - returns array of lines

data/lib/hummel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hummel
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hummel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Derek Bender
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A Ruby parser and encoder for HUML (Human Markup Language)
 test_files: []