fortio-namelist 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed7fddd6ffa15b9134cf1818215a1bf4cd6b1086165df795faa955224277ef4a
-  data.tar.gz: 75f1f40c5dfb92e5e5877e2fe9ba696a7e8399810a7affea8371f72412957603
+  metadata.gz: 7031390445d9ff81165021b8e46fd90057b89748b6cfb7a2989cc645baeda333
+  data.tar.gz: e4f9bbbcc74241ba959796683606f06903ec94710350a7a2ec466532eb0ed2b8
 SHA512:
-  metadata.gz: 48cedc4dea6b54cc81c69a206e8a5fbe5253fb074e6f4b1b1956422bf96ae6ebcd971c1c71c526c7750b1f66a24c5cc0da89e79b8f1aacf54e81a4962a95a547
-  data.tar.gz: 90c9ddd5cc7044cd8326e0d4baa2896d9e186887d06a24b9fd20cc26076e56f6ed20e8b8352feffcec7a3f433a29a1ecd2e7eff4017ed161d0ce566d03f0a5d2
+  metadata.gz: cf26eaf52e837df1eaa2385971129b086a9939cf370c0b6ee77f63717239792763c2d15a4594e0dcf4b5e45399fd3e50630ec8b362966c3068d538a712f14a9b
+  data.tar.gz: 0d5217634f78f0963b8eafb2638d584c680fa2746336fff36e5039196f84bab4f74462b81b4e34eea0b87c4dcf184a9069c56972de85744ea342906bc9d7601f

data/README.md

@@ -29,20 +29,20 @@ Usage
 
 It is enough for the user to remember the following two methods.
 
-    FortIO::Namelist.read(input, group: nil)
+    FortIO::Namelist.parse(input, group: nil)
     FortIO::Namelist.dump(root, **format_options)
 
 ### Reading namelist format string
 
-To create a Hash object with Namelist structure by reading a string in namelist format, use the following method.
+To create a Hash object with namelist structure by reading a string in namelist format, use the following method.
 
-    FortIO::Namelist.read(input, group: nil)
+    FortIO::Namelist.parse(input, group: nil)
 
-The argument `input` is given as a string, but it also accepts objects with a method `#read` returns a string like an IO object. 
+The argument `input` is given as a string, but it also accepts objects with a method `#read` returns a string like an IO object ('duck typing'). 
 
 If the keyword argument `group` is omitted, all namelist groups included in `input` will be read. To read only a specific group, give a group name to `group`. To load multiple groups, give an array of group names to `group`.
 
-The Hash object of the return value has a two-level structure as follows.
+Use lowercase Symbol objects for both group and variable names. The Hash object of the return value has a two-level structure as follows.
 
     {
       group1: {
@@ -59,7 +59,7 @@ The Hash object of the return value has a two-level structure as follows.
           :
     }
 
-Group names and variable names are given as String objects. The value is Ruby's String, Integer, Float, Complex, TrueClass, or FalseClass objects, depending on the literal in the namelist. In the case of an array, it will be an Array object with the above objects as elements.
+The value can be Ruby's String, Integer, Float, Complex, TrueClass, or FalseClass objects, depending on the literal in the namelist. In the case that the value is an array, it will be expressed as an Array in Ruby.
 
 Example:
 

data/fortio-namelist.gemspec

@@ -1,5 +1,5 @@
 Gem::Specification::new do |s|
-  version = "1.2.0"
+  version = "1.2.1"
   files = Dir.glob("**/*") - [ 
                                Dir.glob("fortio-namelist-*.gem"), 
                                Dir.glob("test/**/*"),

data/lib/fortio-namelist/fortran_namelist.rb

@@ -72,7 +72,7 @@ module FortIO::Namelist
       @namelist = FortIO::Namelist::Parser.new.parse(text)
     end
   
-    def read (group, out={})
+    def parse (group, out={})
       group = group.downcase
       raise "no definition of namelist group '#{group}'" \
                                         unless nml = @namelist[group]
@@ -230,7 +230,7 @@ module FortIO::Namelist
   #
   #  FortIO::Namelist.read(input, name: nil) 
   #
-  def self.read (input, group: nil)
+  def self.parse (input, group: nil)
     case input
     when String
       text = input
@@ -250,8 +250,12 @@ module FortIO::Namelist
     end
     return groups.each_with_object({}) { |group, root|
       root[group] = {}
-      reader.read(group, root[group])
-    }
+      reader.parse(group, root[group])
+    }    
+  end
+  
+  def self.read (input, group: nil)
+    parse(input, group: group)
   end
 
   #
@@ -261,7 +265,7 @@ module FortIO::Namelist
   #  return value : namelist string
   #
   def self.filter (input, **format_options)
-    config = read(input)
+    config = parse(input)
     yield config
     return dump(config, **format_options)
   end

data/spec/array_spec.rb

@@ -10,7 +10,7 @@ describe "FortIO::Namelist" do
   v2 = 6,7,8,9,10,
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [1,2,3,4,5]  }
@@ -21,7 +21,7 @@ describe "FortIO::Namelist" do
     input = %{
 &example v1 = 1,2,3,4,5, v2 = 6,7,8,9,10, /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [1,2,3,4,5]  }
@@ -40,7 +40,7 @@ describe "FortIO::Namelist" do
   v2(3:5) = 8,9,10,
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [1,2,3,4,5]  }
@@ -55,7 +55,7 @@ describe "FortIO::Namelist" do
   v2(3:5) = 8,9,10,
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [nil,2,nil,nil,5]  }
@@ -68,7 +68,7 @@ describe "FortIO::Namelist" do
   v1(2) = 2,3,4,5
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [nil,2,3,4,5]  }
@@ -83,7 +83,7 @@ describe "FortIO::Namelist" do
   v4 = 5 * f
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [2,2,2,2,2]  }
@@ -98,7 +98,7 @@ describe "FortIO::Namelist" do
   v1 = "a",'b',"c"
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == ["a","b","c"]  }
@@ -110,7 +110,7 @@ describe "FortIO::Namelist" do
   v1 = a, b, c
 /
     }
-    expect { FortIO::Namelist.read(input) }.to raise_error(RuntimeError)
+    expect { FortIO::Namelist.parse(input) }.to raise_error(RuntimeError)
   end
 
   example "array of identifier 2" do 
@@ -119,7 +119,7 @@ describe "FortIO::Namelist" do
   v1 = a, 0_b, _c
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == ["a","0_b","_c"]  }
@@ -131,7 +131,7 @@ describe "FortIO::Namelist" do
   v1 = "a", b, "c"
 /
     }
-    expect { FortIO::Namelist.read(input) }.to raise_error(RuntimeError)
+    expect { FortIO::Namelist.parse(input) }.to raise_error(RuntimeError)
   end
 
   example "don't permit to mix identifier and string in array stream 2" do 
@@ -140,7 +140,7 @@ describe "FortIO::Namelist" do
   v1 = a, "b", c
 /
     }
-    expect { FortIO::Namelist.read(input) }.to raise_error(RuntimeError)
+    expect { FortIO::Namelist.parse(input) }.to raise_error(RuntimeError)
   end
 
   example "empty element" do 
@@ -150,7 +150,7 @@ describe "FortIO::Namelist" do
   v2 = , , 3, , 5
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == [nil, nil, 3, nil, 5]  }

data/spec/empty_spec.rb

@@ -8,7 +8,7 @@ describe "FortIO::Namelist" do
 &example
 &end
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].empty?  }
@@ -19,7 +19,7 @@ describe "FortIO::Namelist" do
 $example
 $end
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
   end
 
@@ -28,7 +28,7 @@ $end
 &example
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
   end
 
@@ -38,10 +38,11 @@ $end
   ! this is comment
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
   end
 
+
   example "only newlines" do 
     input = %{
 &example
@@ -49,7 +50,7 @@ $end
 
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
   end
 
@@ -57,7 +58,7 @@ $end
     input = %{
 &example /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
   end
   

data/spec/identifier_spec.rb

@@ -11,7 +11,7 @@ describe "FortIO::Namelist" do
   abc = 1
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -26,7 +26,7 @@ describe "FortIO::Namelist" do
   abc123 = 1
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -41,7 +41,7 @@ describe "FortIO::Namelist" do
   abc_123 = 1
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -54,7 +54,7 @@ describe "FortIO::Namelist" do
   1a = 1
 /
     }
-    expect { FortIO::Namelist.read(input) }.to raise_error(RuntimeError)
+    expect { FortIO::Namelist.parse(input) }.to raise_error(RuntimeError)
   end
 
   example "can't start with underscore" do 
@@ -63,7 +63,7 @@ describe "FortIO::Namelist" do
   _a = 1
 /
     }
-    expect { FortIO::Namelist.read(input) }.to raise_error(RuntimeError)
+    expect { FortIO::Namelist.parse(input) }.to raise_error(RuntimeError)
   end
 
   example "t and f can be used as indentifier" do 
@@ -73,7 +73,7 @@ describe "FortIO::Namelist" do
   f = 2
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml[:example][:t] == 1 }
     is_asserted_by { nml[:example][:f] == 2 }
   end

data/spec/scalar_spec.rb

@@ -12,7 +12,7 @@ describe "FortIO::Namelist" do
   v4 = -01
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == 1  }
@@ -35,7 +35,7 @@ describe "FortIO::Namelist" do
   v9 = 90.0d-01
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == 1.0  }
@@ -63,7 +63,7 @@ describe "FortIO::Namelist" do
   v9 = -90.0d-01
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == -1.0  }
@@ -83,7 +83,7 @@ describe "FortIO::Namelist" do
   v1 = 01.0
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == 1.0  }
@@ -97,7 +97,7 @@ describe "FortIO::Namelist" do
   v3 = string
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == "string"  }
@@ -113,7 +113,7 @@ describe "FortIO::Namelist" do
   v3 = 0_string
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == "string"  }
@@ -132,7 +132,7 @@ describe "FortIO::Namelist" do
   v6 = T
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == true  }
@@ -154,7 +154,7 @@ describe "FortIO::Namelist" do
   v6 = F
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == false  }
@@ -172,7 +172,7 @@ describe "FortIO::Namelist" do
   v2 = (1d0,1d0)
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == 1+1i  }
@@ -186,7 +186,7 @@ describe "FortIO::Namelist" do
   v2 = ,
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example][:v1] == ""  }

data/spec/structure_spec.rb

@@ -11,7 +11,7 @@ describe "FortIO::Namelist" do
   abc = 3
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -23,7 +23,7 @@ describe "FortIO::Namelist" do
     input = %{
 &example  a = 1  ab = 2  abc = 3 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -37,7 +37,7 @@ describe "FortIO::Namelist" do
   a = 1  ab = 2  abc = 3
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -49,7 +49,7 @@ describe "FortIO::Namelist" do
     input = %{
 &example  a = 1,  ab = 2,  abc = 3 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -63,7 +63,7 @@ describe "FortIO::Namelist" do
   a = 1,  ab = 2,  abc = 3
 /
     }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -79,7 +79,7 @@ describe "FortIO::Namelist" do
   abc = 3
 /
 }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -95,7 +95,7 @@ describe "FortIO::Namelist" do
   abc = 3,
 /
 }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -110,7 +110,7 @@ describe "FortIO::Namelist" do
   abc = 3
 /
 }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -126,7 +126,7 @@ describe "FortIO::Namelist" do
   abc =3
 /
 }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 3 }
@@ -150,7 +150,7 @@ describe "FortIO::Namelist" do
   4
 /
 }
-    nml = FortIO::Namelist.read(input)
+    nml = FortIO::Namelist.parse(input)
     is_asserted_by { nml.has_key? :example  }
     is_asserted_by { nml[:example].is_a? Hash  }
     is_asserted_by { nml[:example].keys.size == 4 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fortio-namelist
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc