tomlrb 2.0.4 → 3.0.0

data/lib/tomlrb/version.rb

@@ -1,5 +1,5 @@
-# frozen-string-literal: true
+# frozen_string_literal: true
 
 module Tomlrb
-  VERSION = '2.0.4'
+  VERSION = "3.0.0"
 end

data/lib/tomlrb.rb

@@ -1,49 +1,35 @@
-# frozen-string-literal: true
+# frozen_string_literal: true
 
-require 'time'
-require 'stringio'
-require 'tomlrb/version'
-require 'tomlrb/local_date_time'
-require 'tomlrb/local_date'
-require 'tomlrb/local_time'
-require 'tomlrb/string_utils'
-require 'tomlrb/scanner'
-require 'tomlrb/parser'
-require 'tomlrb/handler'
+require_relative "tomlrb/version"
+require_relative "tomlrb/local_date"
+require_relative "tomlrb/local_date_time"
+require_relative "tomlrb/local_time"
+require_relative "tomlrb/parser"
 
 module Tomlrb
   class ParseError < StandardError; end
 
-  # Parses a valid TOML string into its Ruby data structure
+  # Parses a TOML document into a Hash.
   #
-  # @param string_or_io [String, StringIO] the content
+  # @param string_or_io [String, #read] the document
   # @param options [Hash] the options hash
   # @option options [Boolean] :symbolize_keys (false) whether to return the keys as symbols or strings
+  # @option options ["1.1", "1.0"] :version ("1.1") the TOML spec to follow. A valid 1.0 document parses the
+  #   same under 1.1; "1.0" also rejects what 1.1 added (`\e`, `\xHH`, times without seconds, multi-line
+  #   inline tables), for when another consumer of the file only reads 1.0
   # @return [Hash] the Ruby data structure represented by the input
+  # @raise [ParseError] on invalid TOML
   def self.parse(string_or_io, **options)
-    io = string_or_io.is_a?(String) ? StringIO.new(string_or_io) : string_or_io
-    scanner = Scanner.new(io)
-    parser = Parser.new(scanner, **options)
-    begin
-      handler = parser.parse
-    rescue Racc::ParseError => e
-      raise ParseError, e.message
-    end
-
-    handler.output
+    src = string_or_io.is_a?(String) ? string_or_io : string_or_io.read
+    Parser.new(src, **options).parse
   end
 
-  # Reads a file content and parses it into its Ruby data structure
+  # Reads a UTF-8 file and parses it; see {.parse} for the options.
   #
-  # @param path [String] the path to the file
-  # @param options [Hash] the options hash
-  # @option options [Boolean] :symbolize_keys (false) whether to return the keys as symbols or strings
+  # @param path [String, Pathname] the path to the file
   # @return [Hash] the Ruby data structure represented by the input
   def self.load_file(path, **options)
-    # By default Ruby sets the external encoding of an IO object to the
-    # default external encoding. The default external encoding is set by
-    # locale encoding or the interpreter -E option.
-    tmp = File.read(path, encoding: 'utf-8')
-    Tomlrb.parse(tmp, **options)
+    # Read as UTF-8 whatever the default external encoding (locale, -E) is.
+    parse(File.read(path, encoding: "utf-8"), **options)
   end
 end

data/sig/tomlrb.rbs

@@ -0,0 +1,75 @@
+module Tomlrb
+  VERSION: String
+
+  class ParseError < StandardError
+  end
+
+  # TOML spec to follow; "1.0" also rejects what 1.1 added.
+  type version = "1.1" | "1.0"
+
+  type key = String | Symbol
+  type table = Hash[key, value]
+  type value = String | Integer | Float | bool | Time | LocalDate | LocalDateTime | LocalTime | Array[value] | table
+
+  interface _Reader
+    def read: () -> String
+  end
+
+  # Parses a TOML document (TOML 1.1 unless `version: "1.0"`). Keys are Strings, or Symbols with `symbolize_keys: true`.
+  def self.parse: (String | _Reader string_or_io, ?symbolize_keys: boolish, ?version: version) -> table
+
+  # Reads a UTF-8 file and parses it.
+  def self.load_file: (path path, ?symbolize_keys: boolish, ?version: version) -> table
+
+  class Parser
+    def initialize: (String src, ?symbolize_keys: boolish, ?version: version) -> void
+    def parse: () -> table
+  end
+
+  class LocalDate
+    def self.valid_date?: (Integer year, Integer month, Integer day) -> bool
+
+    attr_reader year: Integer
+    attr_reader month: Integer
+    attr_reader day: Integer
+
+    def initialize: (int | String year, int | String month, int | String day) -> void
+    def to_time: (?String | Integer | nil offset) -> Time
+    def to_s: () -> String
+    def ==: (untyped other) -> bool
+    def inspect: () -> String
+  end
+
+  class LocalDateTime
+    def initialize: (int | String year, int | String month, int | String day,
+                     int | String hour, int | String min, Numeric sec) -> void
+    def year: () -> Integer
+    def month: () -> Integer
+    def day: () -> Integer
+    def hour: () -> Integer
+    def min: () -> Integer
+    def sec: () -> Integer
+    def usec: () -> Integer
+    def nsec: () -> Integer
+    def to_time: (?String | Integer | nil offset) -> Time
+    def to_s: () -> String
+    def ==: (untyped other) -> bool
+    def inspect: () -> String
+  end
+
+  class LocalTime
+    # `hh:mm:ss`, plus `.` and the fraction digits if `sec` has any.
+    def self.format: (Integer hour, Integer min, Numeric sec) -> String
+
+    def initialize: (int | String hour, int | String min, Numeric sec) -> void
+    def hour: () -> Integer
+    def min: () -> Integer
+    def sec: () -> Integer
+    def usec: () -> Integer
+    def nsec: () -> Integer
+    def to_time: (int year, int month, int day, ?String | Integer | nil offset) -> Time
+    def to_s: () -> String
+    def ==: (untyped other) -> bool
+    def inspect: () -> String
+  end
+end

metadata

@@ -1,51 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: tomlrb
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Francois Bernier
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-description: A racc based toml parser
+dependencies: []
+description: Parses TOML 1.1 and 1.0 documents into Ruby Hashes. Pure Ruby, no runtime
+  dependencies, checked against the official toml-test suite.
 email:
 - frankbernier@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
+- README.md
 - lib/tomlrb.rb
-- lib/tomlrb/generated_parser.rb
-- lib/tomlrb/handler.rb
 - lib/tomlrb/local_date.rb
 - lib/tomlrb/local_date_time.rb
 - lib/tomlrb/local_time.rb
 - lib/tomlrb/parser.rb
-- lib/tomlrb/parser.y
-- lib/tomlrb/scanner.rb
-- lib/tomlrb/string_utils.rb
 - lib/tomlrb/version.rb
+- sig/tomlrb.rbs
 homepage: https://github.com/fbernier/tomlrb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/fbernier/tomlrb
+  changelog_uri: https://github.com/fbernier/tomlrb/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/fbernier/tomlrb/issues
+  documentation_uri: https://rubydoc.info/gems/tomlrb
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -53,14 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
-summary: A racc based toml parser
+summary: A fast, pure-Ruby TOML 1.1 and 1.0 parser
 test_files: []