fat_config 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d987b854bd4105f55ead3efbc73a77a1e168b4c5bcfc6caa487e248463df95e
-  data.tar.gz: 8d65e3589a6402eb4f4fa374a815ffad56902162d4f0e107c0ef6f676ed39252
+  metadata.gz: 9402d73a4e16cab2a9088bece9dfa623d406858b5c0ae641df01ee988029e6a1
+  data.tar.gz: 042c81ad9c917ea1073db02259718a73792dd7e134f8c9c3aa4b60f7d9b756b4
 SHA512:
-  metadata.gz: f19a80712d34593aa39ebf5f5763a48aa5cce085b721b90a6a591417da9ce878c466800938f482aa88b5c6dac4c2ebdfb2250c7d798e8a0a8cbf415867e8b353
-  data.tar.gz: 0c8575cf4ffc410eba8c6d14e194e802f0e8505f266e0e08e4a63c7905c2cd5c2c184c6114b870bcec8b86dc56758035a4a8c8b2c5d48fbb871e17423224e073
+  metadata.gz: 9026e4d9b87df9db13e341e5e9af201388335db1a750e7e5d72ddea797787034545bdc03b0358acef9a16ae7fb37e31c7e305f23fc6f1023b5e3acf7fb7f2b72
+  data.tar.gz: 24b464de194eef9fb81afdcc23afd24dfcf4dcca35b6411d9befed18435dc6c98c3d147c5f6971d586a04e345fdc027be4b34e07fc6f75b6caf47a1ee4da7ccd

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+- [Version 0.7.1 <span class="timestamp-wrapper"><span class="timestamp">[2026-02-06 Fri]</span></span>](#org48cabe8)
+- [Version 0.7.0 <span class="timestamp-wrapper"><span class="timestamp">[2026-02-05 Thu]</span></span>](#orga2f16a3)
+
+
+<a id="org48cabe8"></a>
+
+# Version 0.7.1 <span class="timestamp-wrapper"><span class="timestamp">[2026-02-06 Fri]</span></span>
+
+-   Improved error diagnostics on ParseError
+
+
+<a id="orga2f16a3"></a>
+
+# Version 0.7.0 <span class="timestamp-wrapper"><span class="timestamp">[2026-02-05 Thu]</span></span>
+
+-   Parsing error dignostics added

data/CHANGELOG.org

@@ -0,0 +1,13 @@
+* COMMENT CHANGELOG tips:
+1. Don't dump your git change logs into this file, write them yourself.
+2. Keep entries short and user-focused,
+3. Use non-technical language, but do speak in the vocabulary of your gem.
+4. Don't document changes only of interest to the programmers, just those the
+   user would find useful.
+5. Give each heading a version number and an inactive date (C-c ! is useful here).
+
+* Version 0.7.1 [2026-02-06 Fri]
+- Improved error diagnostics on ParseError
+
+* Version 0.7.0 [2026-02-05 Thu]
+- Parsing error dignostics added

data/README.md

@@ -1,26 +1,26 @@
-- [Introduction](#org6ea1400)
-- [Installation](#org0bfc9c4)
-- [Usage:](#orgb03325f)
-  - [Following XDG Standards](#orgcc49e5b)
-  - [Following Classic UNIX Standards](#orgb094a10)
-  - [Available Config File Styles](#org77efd19)
-  - [Hash Keys](#org2489659)
-  - [Hash Values](#org3c327fd)
-    - [YAML](#org47246cf)
-    - [TOML](#orgcd934bb)
-    - [JSON](#orge3c0568)
-    - [INI](#org479cf72)
-  - [Creating a Reader](#org195ed64)
-  - [Calling the `read` method on a `Reader`](#org0c26613)
+- [Introduction](#orgc4b482f)
+- [Installation](#orgbce0696)
+- [Usage:](#org7684da4)
+  - [Following XDG Standards](#orga8e28a3)
+  - [Following Classic UNIX Standards](#orgd716a45)
+  - [Available Config File Styles](#org152041e)
+  - [Hash Keys](#orgb744014)
+  - [Hash Values](#org02d5c86)
+    - [YAML](#org73fadf6)
+    - [TOML](#orge78f21a)
+    - [JSON](#org22479cd)
+    - [INI](#org850bdf4)
+  - [Creating a Reader](#org570f7c5)
+  - [Calling the `read` method on a `Reader`](#org9637e7b)
   - [Parsing Environment and Command Line Strings](#parsing-environment-and-command-line-strings)
-- [Development](#orgadf9605)
-- [Contributing](#org00f8770)
-- [License](#orgbb61eac)
+- [Development](#orgda3ea75)
+- [Contributing](#orgfb56ba2)
+- [License](#org0377369)
 
 [![img](https://github.com/ddoherty03/fat_config/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/ddoherty03/fat_config/actions/workflows/main.yml)
 
 
-<a id="org6ea1400"></a>
+<a id="orgc4b482f"></a>
 
 # Introduction
 
@@ -29,7 +29,7 @@ Allowing a user to configure an application to change its behavior at runtime ca
 `FatConfig` eliminates the tedium of reading configuration files and the environment to populate a Hash of configuration settings. You need only define a `FatConfig::Reader` and call its `#read` method to look for, read, translate, and merge any config files into a single Hash that encapsulates all the files in the proper priority. It can be set to read `YAML`, `TOML`, `JSON`, or `INI` config files.
 
 
-<a id="org0bfc9c4"></a>
+<a id="orgbce0696"></a>
 
 # Installation
 
@@ -46,7 +46,7 @@ gem install fat_config
 ```
 
 
-<a id="orgb03325f"></a>
+<a id="org7684da4"></a>
 
 # Usage:
 
@@ -64,7 +64,7 @@ config = reader.read
 The `reader.read` method will parse the config files (by default assumed to be YAML files), config environment variable, and optional command-line parameters and return the composite config as a Hash.
 
 
-<a id="orgcc49e5b"></a>
+<a id="orga8e28a3"></a>
 
 ## Following XDG Standards
 
@@ -78,7 +78,7 @@ By default, `FatConfig::Reader#read` follows the [XDG Desktop Standards](https:/
 6.  Finally, it will merge in any options given in the optional `command_line:` named parameter to the `#read` method. That parameter can either be a `Hash` or a `String`. If it is a `String`, it is interpreted the same way as the environment variable `MYAPP_OPTIONS` as explained below in [Parsing Environment and Command Line Strings](#parsing-environment-and-command-line-strings); if it is a `Hash`, it is used directly and merged into the hash returned from the prior methods.
 
 
-<a id="orgb094a10"></a>
+<a id="orgd716a45"></a>
 
 ## Following Classic UNIX Standards
 
@@ -101,7 +101,7 @@ With the optional `:xdg` keyword parameter to `FatConfig::Reader#read` set to `f
 6.  Finally, it will merge in any options given in the optional `command_line:` named parameter to the `#read` method. That parameter can either be a `Hash` or a `String`. If it is a `String`, it will interpret the string as explained below in [Parsing Environment and Command Line Strings](#parsing-environment-and-command-line-strings); if it is a `Hash`, it is used directly and merged into the hash returned from the prior methods.
 
 
-<a id="org77efd19"></a>
+<a id="org152041e"></a>
 
 ## Available Config File Styles
 
@@ -115,7 +115,7 @@ With the optional `:xdg` keyword parameter to `FatConfig::Reader#read` set to `f
 By default, the style is `yaml`. Note that the style only pertains to the syntax of on-disk configuration files. Configuration can also be set by an environment variable, `MYAPP_OPTIONS` and by a command-line string optionally provided to the `#read` method. Those are simple parsers that parse strings of option settings as explained below. See, [Parsing Environment and Command Line Strings](#parsing-environment-and-command-line-strings).
 
 
-<a id="org2489659"></a>
+<a id="orgb744014"></a>
 
 ## Hash Keys
 
@@ -124,14 +124,14 @@ Any keys that are Strings will be converted to a symbol, using the names given i
 Keys that are not Strings will be left alone, so that, for example, you might have Integer keys, which may be useful below the top level.
 
 
-<a id="org3c327fd"></a>
+<a id="org02d5c86"></a>
 
 ## Hash Values
 
 Whether the values of the returned Hash will be 'deserialized' into a Ruby object is controlled by the style of the configuration files.
 
 
-<a id="org47246cf"></a>
+<a id="org73fadf6"></a>
 
 ### YAML
 
@@ -148,7 +148,7 @@ The `:yaml` style deserializes the following types:
 -   Date, DateTime, and Time, which FatConfig adds to the foregoing default types deserialized by the default YAML library.
 
 
-<a id="orgcd934bb"></a>
+<a id="orge78f21a"></a>
 
 ### TOML
 
@@ -164,7 +164,7 @@ The `:toml` style deserializes the following types:
 -   Date and Time, when given in ISO form YYYY-MM-DD or YYYY-MM-DDThh:mm:ss
 
 
-<a id="orge3c0568"></a>
+<a id="org22479cd"></a>
 
 ### JSON
 
@@ -180,7 +180,7 @@ The `:json` style deserializes the following types:
 -   Date and Time, NOT deserialized, returns a parse error
 
 
-<a id="org479cf72"></a>
+<a id="org850bdf4"></a>
 
 ### INI
 
@@ -196,7 +196,7 @@ The `:ini` style deserializes the following types:
 -   Date and Time, NOT deserialized, returned as a String
 
 
-<a id="org195ed64"></a>
+<a id="org570f7c5"></a>
 
 ## Creating a Reader
 
@@ -213,7 +213,7 @@ reader3 = FatConfig.new('labrat', style: 'ini', xdg: false)  # Use classic UNIX
 ```
 
 
-<a id="org0c26613"></a>
+<a id="org9637e7b"></a>
 
 ## Calling the `read` method on a `Reader`
 
@@ -276,7 +276,7 @@ Here are the parsing rules:
 4.  These rules apply regardless of style being used for config files.
 
 
-<a id="orgadf9605"></a>
+<a id="orgda3ea75"></a>
 
 # Development
 
@@ -285,14 +285,14 @@ After checking out the repo, run \`bin/setup\` to install dependencies. Then, ru
 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 [rubygems.org](https://rubygems.org).
 
 
-<a id="org00f8770"></a>
+<a id="orgfb56ba2"></a>
 
 # Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/ddoherty03/fat_config>.
 
 
-<a id="orgbb61eac"></a>
+<a id="org0377369"></a>
 
 # License
 

data/lib/fat_config/errors.rb

@@ -15,39 +15,26 @@ module FatConfig
     end
 
     def self.snippet_from_string(str, line:, column:)
-      snippet = nil
-
+      line = line&.to_i || 1
+      column = column&.to_i || 0
       if str && line && line.to_i > 0
-        lines = str.lines
-        idx = line.to_i - 1
-        if idx >= 0 && idx < lines.length
-          src = lines[idx].chomp
-          caret =
-            if column
-              (" " * column.to_i) + "^"
-            end
-          snippet = [src, caret].compact.join("\n")
-        end
+        lines = str.lines.map(&:chomp)
+        (lines[0..line - 1] +
+          [(' ' * column) + '^'] +
+          lines[line..]).join("\n")
       end
-
-      snippet
     end
 
     def self.snippet_from_file(file_name, line:, column:)
       text = nil
-
       begin
         text = File.read(file_name, encoding: "UTF-8")
       rescue StandardError
         text = nil
       end
-
-      snippet = nil
       if text
-        snippet = snippet_from_string(text, line: line, column: column)
+        snippet_from_string(text, line: line, column: column)
       end
-
-      snippet
     end
 
     private
@@ -61,17 +48,17 @@ module FatConfig
         else
           ""
         end
-
-      msg = +"#{format.to_s.upcase} parse error in #{file}#{loc}: #{problem}"
-
+      msg = +"#{format.to_s.upcase} parse error in:\n  #{file}\n  #{loc}:\n\nERROR:#{problem}"
       if snippet && !snippet.empty?
-        msg << "\n\n#{snippet}"
+        msg << "\n\n===========================\n"
+        msg << snippet
+        msg << "\n===========================\n\n"
       end
-
       if context && !context.empty?
-        msg << "\n\n#{context}"
+        msg << "\n\n==========================="
+        msg << context
+        msg << "===========================\n\n"
       end
-
       msg
     end
   end

data/lib/fat_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FatConfig
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fat_config
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Daniel E. Doherty
 bindir: bin
 cert_chain: []
-date: 2026-02-05 00:00:00.000000000 Z
+date: 2026-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -85,6 +85,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
+- CHANGELOG.md
+- CHANGELOG.org
 - LICENSE.txt
 - README.md
 - README.org