yps 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43d89afcf4628612d4c00e6d902eb95bd92757e755b79297c72d73eac901ad53
-  data.tar.gz: e55453abcb53201a61704a790966ea0f7765e75e40856cf91f0365acd355a729
+  metadata.gz: bcd62aefae6b26fa2093fc9c156c016a52a60d9c8d8d91898901031cfc283580
+  data.tar.gz: 51d5d6b8ffa294355bbdf66d6d382931db6f8e8737bd014653bde7f5b1e87421
 SHA512:
-  metadata.gz: 29070662eff8e6b0d3210d444e88466b6c8fed647c0ca9742d1b4ca5196a195b90740d154836d8439eec89117fbcbfd99f1a67bab6d627c18508a7add5e754d1
-  data.tar.gz: aa948cb48fac9b1b83b306c093fa8df9c573b676928a00848fd7e8c03a012fab040f2829b2e2ac584ee103ff3018be9e22c2f34645e985606a67a3731bd45bc6
+  metadata.gz: 9dfe215b77ff8502f76ffe904bd7bf350fd0f38c1ff6ba75ed97feba8cb2600d19830dcf4912fcbc97d7ada69d2cc365971acde95052760ebcf94fa957da8399
+  data.tar.gz: b48ee98f7435e2fa1991b1a607833ee873a841d96b8056c74256103a32206e4e943979df9fc6d4a4365764f6fff092f9cc9ad7b51ae9036ee2ecb3977c03c1b3

data/README.md

@@ -28,11 +28,25 @@ gem install yps
 
 You can use the methods below to load a YAML code into Ruby objects with their position information (file name, line, and column).
 
-* `YPS.safe_load`/`YPS.load`
+* `YPS.safe_load`/`YPS.load`/`YPS.safe_load_stram`/`YPS.load_stream`
     * Load the given YAML string into Ruby objects with position information.
-* `YPS.safe_load_file`/`YPS.load_file`
+* `YPS.safe_load_file`/`YPS.load_file`/`YPS.safe_load_stram_file`/`YPS.load_stream_file`
     * Load the YAML code read from the given file path into Ruby objects with position information.
 
+For a YAML code that contains multiple documents, folowing methods load the 1st document only.
+
+* `YPS.safe_load`
+* `YPS.load`
+* `YPS.safe_load_file`
+* `YPS.load_file`
+
+On the other hand, following methods load all given documents and return them as a list.
+
+* `YPS.safe_load_stram`
+* `YPS.load_stream`
+* `YPS.safe_load_stram_file`
+* `YPS.load_stream_file`
+
 Parsed objects, except for hash keys, have their own position information.
 You can use the `position` method to get position information in the original YAML of the receiver object.
 
@@ -57,6 +71,25 @@ yaml['children'].each do |child|
     puts "#{key}: #{value} (#{value.position})"
   end
 end
+
+yaml = YPS.load_stream(<<~'YAML')
+- 0
+- 1
+---
+- foo
+- bar
+YAML
+
+# output
+# 0 (filename: unknown line 1 column 3)
+# 1 (filename: unknown line 2 column 3)
+# foo (filename: unknown line 4 column 3)
+# bar (filename: unknown line 5 column 3)
+yaml.each do |list|
+  list.each do |item|
+    puts "#{item} (#{item.position})"
+  end
+end
 ```
 
 ## Contributing

data/lib/yps/parser.rb

@@ -25,6 +25,10 @@ module YPS # :nodoc: all
   end
 
   class Parser < Psych::Parser
+    def self.parse(yaml, filename, &)
+      new(&).parse(yaml, filename)
+    end
+
     def initialize(&)
       super(Handler.new(&))
     end

data/lib/yps/version.rb

@@ -2,5 +2,5 @@
 
 module YPS
   # The version of YPS
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/yps/{visitors.rb → visitor.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module YPS # :nodoc: all
-  module Visitors
+  module Visitor
     using NodeExtension
 
     module Common
@@ -33,5 +33,22 @@ module YPS # :nodoc: all
     class NoAliasRuby < Psych::Visitors::NoAliasRuby
       include Common
     end
+
+    def self.create( # rubocop:disable Metrics/ParameterLists
+      permitted_classes, permitted_symbols, aliases,
+      symbolize_names, freeze, strict_integer, value_class
+    )
+      class_loader = Psych::ClassLoader::Restricted.new(
+        permitted_classes.map(&:to_s), permitted_symbols.map(&:to_s)
+      )
+      scanner =
+        if RUBY_VERSION >= '3.2.0'
+          Psych::ScalarScanner.new(class_loader, strict_integer:)
+        else
+          Psych::ScalarScanner.new(class_loader)
+        end
+      (aliases && ToRuby || NoAliasRuby)
+        .new(scanner, class_loader, value_class, symbolize_names:, freeze:)
+    end
   end
 end

data/lib/yps.rb

@@ -7,7 +7,7 @@ require_relative 'yps/version'
 require_relative 'yps/value'
 require_relative 'yps/node_extension'
 require_relative 'yps/parser'
-require_relative 'yps/visitors'
+require_relative 'yps/visitor'
 
 ##
 # = YPS: YAML Positioning Sysmte
@@ -22,6 +22,8 @@ module YPS
     # Safely load the YAML string in +yaml+ and add position information (file name line and column)
     # to each parsed objects except for hash keys.
     #
+    # Load the 1st documetns only if the given YAML contains multiple documents.
+    #
     # Parsed objects will be wrapped by YPS::Value class to add the accessor returning the position information.
     # You can use the +value_class+ to specify your own wrapper class.
     #
@@ -59,27 +61,16 @@ module YPS
       filename: nil, fallback: nil, symbolize_names: false, freeze: false,
       strict_integer: false, value_class: Value
     )
-      result = parse(yaml, filename)
-      return fallback unless result
-
-      class_loader =
-        Psych::ClassLoader::Restricted.new(
-          permitted_classes.map(&:to_s), permitted_symbols.map(&:to_s)
-        )
-      scanner =
-        if RUBY_VERSION >= '3.2.0'
-          Psych::ScalarScanner.new(class_loader, strict_integer:)
-        else
-          Psych::ScalarScanner.new(class_loader)
-        end
-      visitor =
-        if aliases
-          Visitors::ToRuby.new(scanner, class_loader, value_class, symbolize_names:, freeze:)
-        else
-          Visitors::NoAliasRuby.new(scanner, class_loader, value_class, symbolize_names:, freeze:)
-        end
+      Parser.parse(yaml, filename) do |node|
+        visitor =
+          Visitor.create(
+            permitted_classes, permitted_symbols, aliases,
+            symbolize_names, freeze, strict_integer, value_class
+          )
+        return visitor.accept(node)
+      end
 
-      visitor.accept(result)
+      fallback
     end
 
     ##
@@ -95,9 +86,7 @@ module YPS
     #
     # See also YPS.safe_load
     def safe_load_file(filename, **kwargs)
-      File.open(filename, 'r:bom|utf-8') do |f|
-        safe_load(f, filename:, **kwargs)
-      end
+      open_file(filename) { |f| safe_load(f, filename:, **kwargs) }
     end
 
     ##
@@ -105,19 +94,67 @@ module YPS
     #
     # See also YPS.load
     def load_file(filename, **kwargs)
-      File.open(filename, 'r:bom|utf-8') do |f|
-        load(f, filename:, **kwargs)
+      open_file(filename) { |f| load(f, filename:, **kwargs) }
+    end
+
+    DEFAULT_VALUE = Object.new.freeze
+    private_constant :DEFAULT_VALUE
+
+    ##
+    # Similar to +YPS.safe_load+, but load all documents given in +yaml+ and return them as a list.
+    #
+    # See also YPS.safe_load
+    def safe_load_stream( # rubocop:disable Metrics/ParameterLists
+      yaml,
+      permitted_classes: [], permitted_symbols: [], aliases: false,
+      filename: nil, fallback: DEFAULT_VALUE, symbolize_names: false,
+      freeze: false, strict_integer: false, value_class: Value
+    )
+      visitor = nil
+      results = []
+      Parser.parse(yaml, filename) do |node|
+        visitor ||=
+          Visitor.create(
+            permitted_classes, permitted_symbols, aliases,
+            symbolize_names, freeze, strict_integer, value_class
+          )
+        results << visitor.accept(node)
       end
+      return fallback if results.empty? && !fallback.equal?(DEFAULT_VALUE)
+
+      results
     end
 
-    private
+    ##
+    # Similar to +YPS.safe_load_sream+, but Symbol is allowed to be loaded by default.
+    #
+    # See also YPS.safe_load_stream
+    def load_stream(yaml, permitted_classes: [Symbol], **kwargs)
+      safe_load_stream(yaml, permitted_classes:, **kwargs)
+    end
 
-    def parse(yaml, filename)
-      Parser
-        .new { |node| return node }
-        .parse(yaml, filename)
+    ##
+    # Similar to +YPS.safe_load_stream+,
+    # but the YAML string is read from the file specified by the +filename+ argument.
+    #
+    # See also YPS.safe_load_stream
+    def safe_load_stream_file(filename, **kwargs)
+      open_file(filename) { |f| safe_load_stream(f, filename:, **kwargs) }
+    end
+
+    ##
+    # Similar to +YPS.load_stream+,
+    # but the YAML string is read from the file specified by the +filename+ argument.
+    #
+    # See also YPS.load_stream
+    def load_stream_file(filename, **kwargs)
+      open_file(filename) { |f| load_stream(f, filename:, **kwargs) }
+    end
+
+    private
 
-      false
+    def open_file(filename, &)
+      File.open(filename, 'r:bom|utf-8', &)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Taichi Ishitani
@@ -29,14 +29,17 @@ files:
 - lib/yps/parser.rb
 - lib/yps/value.rb
 - lib/yps/version.rb
-- lib/yps/visitors.rb
+- lib/yps/visitor.rb
 homepage: https://github.com/taichi-ishitani/yps
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/taichi-ishitani/yps/issues
+  changelog_uri: https://github.com/taichi-ishitani/yps/releases
+  documentation_uri: https://taichi-ishitani.github.io/yps/
   homepage_uri: https://github.com/taichi-ishitani/yps
-  source_code_uri: https://github.com/taichi-ishitani/yps
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/taichi-ishitani/yps
 rdoc_options:
 - "--main"
 - README.md