fortio-namelist 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7031390445d9ff81165021b8e46fd90057b89748b6cfb7a2989cc645baeda333
-  data.tar.gz: e4f9bbbcc74241ba959796683606f06903ec94710350a7a2ec466532eb0ed2b8
+  metadata.gz: d6be9628b6a286eac9e31901c71c0793928166b260040cbe93d2d902a8c93096
+  data.tar.gz: 80b6989bed8bb98e11ffae89a42fd6675f24454e7438287166915fb1fd56a0fc
 SHA512:
-  metadata.gz: cf26eaf52e837df1eaa2385971129b086a9939cf370c0b6ee77f63717239792763c2d15a4594e0dcf4b5e45399fd3e50630ec8b362966c3068d538a712f14a9b
-  data.tar.gz: 0d5217634f78f0963b8eafb2638d584c680fa2746336fff36e5039196f84bab4f74462b81b4e34eea0b87c4dcf184a9069c56972de85744ea342906bc9d7601f
+  metadata.gz: 3584a0f098e8f5ab224e02e01e60581483643034e25d326dcc04b5352c4ac1fdf1a83700cef61b012ba31b9822b1523707027c6aeb764789463a3465dd360eef
+  data.tar.gz: 37328c227c9aa6e927111056a98ca92a4651a3740944319f166c62d6e1a60cea194fcbf04de30d0f63d0b5136dfdcf3024c7ca2eb5aec353880b58d5dd64ef02

data/README.md

@@ -7,9 +7,9 @@ This is a library for reading and writing data in Fortran's namelist format. Wit
 Features
 --------
 
-* Flexible parsing enables reading of namelists in various formats.
-* Various options to control the output namelist string in the format of your choice.
-* Able to convert namelist format to JSON or YAML format using Ruby's standard library
+* Flexible parsing using Racc to support various dialects
+* Options for controlling the format of the dump
+* Represents the structure of a name list with a Hash object (easy to convert to JSON or YAML format)
 
 Installation
 ------------
@@ -27,14 +27,14 @@ Usage
 
 ### Useful methods
 
-It is enough for the user to remember the following two methods.
+The user only needs to remember the following two methods.
 
     FortIO::Namelist.parse(input, group: nil)
     FortIO::Namelist.dump(root, **format_options)
 
-### Reading namelist format string
+### Reading namelist 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 namelist string, use the following method.
 
     FortIO::Namelist.parse(input, group: nil)
 
@@ -83,55 +83,28 @@ input = %{
 
 ### read all groups
 root = FortIO::Namelist.read(input)
-=> {:group1=>{:var1=>11, :var2=>12},
-    :group2=>{:var1=>12, :var2=>22},
-    :group3=>{:var1=>31, :var2=>32}}
-
+# => {:group1=>{:var1=>11, :var2=>12},
+#     :group2=>{:var1=>12, :var2=>22},
+#     :group3=>{:var1=>31, :var2=>32}}
 
 ### read only "group2"
 root = FortIO::Namelist.read(input, group: "group2")
-=> {:group2=>{:var1=>12, :var2=>22}}
-
+# => {:group2=>{:var1=>12, :var2=>22}}
 
 ### read only "group1" and "group3"
 root = FortIO::Namelist.read(input, group: ["group1", "group3"])
-=> {:group1=>{:var1=>11, :var2=>12}, 
-    :group3=>{:var1=>31, :var2=>32}}
+# => {:group1=>{:var1=>11, :var2=>12}, 
+#     :group3=>{:var1=>31, :var2=>32}}
 
 ```
 
-### Generating namelist format string from Hash object with namelist structure
+### Generating namelist string from Hash object with namelist structure
 
-To generate a namelist format string from a Hash object with a namelist structure, use the following method.
+To generate a namelist string from a Hash object with a namelist structure, use the following method.
 
     FortIO::Namelist.dump(root, **format_options)
 
-The argument `root` is given as a Hash object. The return value is a string in namelist format. You can finely control the output namelist string with the following keyword arguments (the first one is the default).
-
-    array_style:    'stream'
-                    'index'   
-                    
-    logical_format: 'normal'
-                    'short'
-
-    float_format:   'normal'
-                    'd0'
-
-    alignment:      'left'
-                    'right'
-                    'compact'
-                    Integer
-
-    uppercase:      false
-                    true
-    
-    separator:      "comma", ","
-                    "nl", "\n"
-
-    group_end:      "slash", "/"
-                    "end"
-                    
-    indent:         ' '*2
+The argument `root` is given as a Hash object. The return value is a namelist string. 
 
 Example:
 
@@ -159,3 +132,254 @@ This script print a namelist format string to stdout.
       var1 = 31,
       var2 = 32
     /
+
+### Format options for `FortIO::Namelist.dump`
+
+You can finely control the output namelist string with the following keyword arguments (the first one is the default).
+
+#### `array_style` : Specifying the notation for array elements
+
+* 'stream' : (default)
+* 'index'  :
+
+Example:
+
+```ruby
+root = {group: {var1: [1,2,3], var2: ["a","b","c"]}}
+
+puts FortIO::Namelist.dump(root, array_style: 'stream')
+# =>
+# &group
+#   var1 = 1, 2, 3,
+#   var2 = 'a', 'b', 'c'
+# /
+
+puts FortIO::Namelist.dump(root, array_style: 'index')
+# =>
+# &group
+#   var1(1) = 1,
+#   var1(2) = 2,
+#   var1(3) = 3,
+#   var2(1) = 'a',
+#   var2(2) = 'b',
+#   var2(3) = 'c'
+# /
+```
+
+#### `logical_format` : Specifying a boolean literal
+
+* 'normal' : normal notation like `.true.`, `.false` (default)
+* 'short'  : short notation like `t`, `f`
+
+```ruby
+root = {group: {var1: true, var2: false}}
+
+puts FortIO::Namelist.dump(root, logical_format: 'normal')
+# =>
+# &group
+#   var1 = .true.,
+#   var2 = .false.
+# /
+
+puts FortIO::Namelist.dump(root, logical_format: 'short')
+# =>
+# &group
+#   var1 = t,
+#   var2 = f
+# /
+```
+
+#### `float_format` : Specifying notation for floating point numbers
+
+* 'normal' : format with "%g" (default)
+* 'd0'     : format with "%g" followed by 'd0'
+* 'exp'    : exponential notation
+
+```ruby
+root = {group: {var1: 1.0, var2: 12.75, var3: 50.0e-8}}
+
+puts FortIO::Namelist.dump(root, float_format: 'normal')
+# =>
+# &group
+#   var1 = 1,
+#   var2 = 12.75,
+#   var3 = 5d-07
+# /
+
+puts FortIO::Namelist.dump(root, float_format: 'd0')
+# =>
+# &group
+#   var1 = 1d0,
+#   var2 = 12.75d0,
+#   var3 = 5d-07
+# /
+
+puts FortIO::Namelist.dump(root, float_format: 'exp')
+# =>
+# &group
+#   var1 = 1d+00,
+#   var2 = 1.275d+01,
+#   var3 = 5d-07
+# /
+```
+
+#### `alignment` : Specifying how variable identifiers are aligned
+
+* 'left'    : aligned, left-justified, position of '=' can be specified by number eg. 'left:7' (default)
+* 'right'   : aligned, right-justified, position of '=' can be specified by number eg. 'right:7'
+* 'none'    : not aligned
+* 'stream'  : not aligned, stream style, length of each line can be specified by number eg. 'stream:70'
+
+```ruby
+root = {group: {var1: 1, variable2: [1,2,3], v3: true}}
+
+puts FortIO::Namelist.dump(root, alignment: 'left')
+# =>
+# &group
+#   var1      = 1,
+#   variable2 = 1, 2, 3,
+#   v3        = .true.
+# /
+
+puts FortIO::Namelist.dump(root, alignment: 'left:7')
+# =>
+# &group
+#   var1  = 1,
+#   variable2 = 1, 2, 3,
+#   v3    = .true.
+# /
+
+puts FortIO::Namelist.dump(root, alignment: 'right')
+# =>
+# &group
+#        var1 = 1,
+#   variable2 = 1, 2, 3,
+#          v3 = .true.
+# /
+
+puts FortIO::Namelist.dump(root, alignment: 'right:7')
+# =>
+# &group
+#    var1 = 1,
+#   variable2 = 1, 2, 3,
+#      v3 = .true.
+# /
+
+puts FortIO::Namelist.dump(root, alignment: 'none')
+# =>
+# &group
+#   var1 = 1,
+#   variable2 = 1, 2, 3,
+#   v3 = .true.
+# /
+
+puts FortIO::Namelist.dump(root, alignment: 'stream')
+# =>
+# &group
+#   var1 = 1, variable2 = 1, 2, 3, v3 = .true.,
+# /
+```
+
+#### `uppercase` : Specify whether variable names, etc. should be uppercase or lowercase.
+
+* false : (default)
+* true  :  
+
+```ruby
+root = {group: {var1: 1, var2: "a"}}
+
+puts FortIO::Namelist.dump(root, uppercase: false)
+# =>
+# &group
+#   var1 = 1,
+#   val2 = 'a'
+# /
+
+puts FortIO::Namelist.dump(root, uppercase: true)
+# =>
+# &GROUP
+#   VAR1 = 1,
+#   VAL2 = 'a'
+# /
+```
+
+#### `separator` :  Specifying the separator between variable definitions
+
+* "comma", "," : comma + NL separeted (default)
+* "nl", "\n"   : NL separated
+
+```ruby
+root = {group1: {var1: 1, var2: "a", var3: true},
+        group2: {var1: 2, var2: "b", var3: false}}
+
+puts FortIO::Namelist.dump(root, separator: "comma")
+# =>
+# &group1
+#   var1 = 1,
+#   var2 = 'a',
+#   var3 = .true.
+# /
+# &group2
+#   var1 = 2,
+#   var2 = 'b',
+#   var3 = .false.
+# /
+
+puts FortIO::Namelist.dump(root, separator: "nl")
+# =>
+# &group1
+#   var1 = 1
+#   var2 = 'a'
+#   var3 = .true.
+# /
+# &group2
+#   var1 = 2
+#   var2 = 'b'
+#   var3 = .false.
+# /
+```
+
+#### `group_end` : Specifying a group terminator
+
+* "slash", "/" : end with `/` (default)
+* "end"        : end with `&end`
+
+```ruby
+root = {group: {var1: true, var2: false}}
+
+puts FortIO::Namelist.dump(root, group_end: 'slash')
+# =>
+# &group
+#   var1 = .true.,
+#   var2 = .false.
+# /
+
+puts FortIO::Namelist.dump(root, group_end: 'end')
+# =>
+# &group
+#   var1 = .true.,
+#   var2 = .false.
+# &end
+```
+
+#### `indent` : Specifying the indentation for variable definition
+                    
+* ' '*2 : two spaces (default)
+
+```ruby
+root = {group: {var1: true, var2: false}}
+
+puts FortIO::Namelist.dump(root, indent: ' '*2)
+# =>
+# &group
+#   var1 = .true.,
+#   var2 = .false.
+# /
+
+puts FortIO::Namelist.dump(root, indent: ' '*4)
+# =>
+# &group
+#     var1 = .true.,
+#     var2 = .false.
+# /
+```

data/fortio-namelist.gemspec

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

data/lib/fortio-namelist/fortran_namelist.rb

@@ -97,6 +97,17 @@ module FortIO::Namelist
   # hash -> namelist converter
   #
   
+  def self.float_to_string (value, d:)
+    if value == 0
+      return "0.0"
+    elsif Math.log10(value).between?(-4,4)
+      return "%.16g" % value
+    else
+      num,exp = ("%.16e" % value).split(/e/)
+      return ("%.16g" % num) + d + exp
+    end
+  end
+  
   def self.format_element (value, 
                            logical_format: 'normal', 
                            float_format: 'normal', 
@@ -112,12 +123,13 @@ module FortIO::Namelist
       d = uppercase ? "D" : "d"
       case float_format
       when 'normal'
-        return ("%g" % value).sub(/e/, d)
+        float_to_string(value, d: d)
       when 'd0'
-        value = ("%g" % value)
-        return ( value =~ /e/ ) ? value.sub(/e/, d) : value + d + "0"
+        value = float_to_string(value, d: d)
+        return ( value =~ /#{d}/ ) ? value : value + d + "0"
       when 'exp'
-        return ("%e" % value).sub(/e/, d)
+        num,exp = ("%.16e" % value).split(/e/)
+        return ("%.16g" % num) + d + exp
       else        
         raise "invalid float_format"
       end
@@ -191,24 +203,47 @@ module FortIO::Namelist
       raise "invalid keyword argument `separator` (should be 'comma', ',', 'nl', '\n')"
     end
     case alignment
+    when /\Astream(:(\d+))?/
+      maxlen = $2 ? $2.to_i : 79 - indent.size
+      elements = list.map { |ident, value|
+        format("%s = %s", ident, value)
+      }
+      body = ""
+      line = []
+      len  = indent.size
+      elements.each do |e|
+        if len + e.length >= maxlen
+          body += indent + line.join(", ") + nl
+          line = []
+          len  = indent.size
+        end
+        line << e
+        len += e.length + 2
+      end
+      body += indent + line.join(", ") + nl unless line.empty?
+      body = body.chomp
     when "none"
       body = list.map { |ident, value|
         format("%s%s = %s", indent, ident, value)
       }.join(nl)      
-    when "left"
-      ident_maxlen = list.map{|ident,value| ident.length}.max
+    when /\Aleft(:(\d+))?/
+      if $2
+        ident_maxlen = $2.to_i - indent.size
+      else
+        ident_maxlen = list.map{|ident,value| ident.length}.max
+      end
       body = list.map { |ident, value|
         format("%s%-#{ident_maxlen}s = %s", indent, ident, value)
       }.join(nl)
-    when "right"
-      ident_maxlen = list.map{|ident,value| ident.length}.max
+    when /\Aright(:(\d+))?/
+      if $2
+        ident_maxlen = $2.to_i - indent.size
+      else
+        ident_maxlen = list.map{|ident,value| ident.length}.max
+      end
       body = list.map { |ident, value|
         format("%s%#{ident_maxlen}s = %s", indent, ident, value)
       }.join(nl)
-    when Integer
-      body = list.map { |ident, value|
-        format("%s%-#{alignment-2}s = %s", indent, ident, value)
-      }.join(nl)
     else
       raise "invalid keyword argument `alignment` (should be 'normal' 'left' 'right' 'stream')"  
     end

data/lib/fortio-namelist/fortran_namelist.tab.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.5.2
+# This file is automatically generated by Racc 1.4.16
 # from Racc grammar file "".
 #
 
@@ -243,36 +243,36 @@ module_eval(<<'...end fortran_namelist.y/module_eval...', 'fortran_namelist.y',
 ##### State transition tables begin ###
 
 racc_action_table = [
-    48,    34,    65,    63,    47,     4,     5,    39,    14,    41,
-    62,    42,    43,    46,    49,    48,    66,    10,    13,    47,
-    15,    13,    39,    29,    41,    30,    42,    43,    46,    49,
-    47,    23,    24,    56,    55,    41,    47,    42,    43,    46,
-    13,    41,    47,    42,    43,    46,    26,    59,    24,    42,
-    43,    46,     4,     5,    21,    10,    13,    18,     4,     5,
-    21,    24,    59,    18,    13,    33,    46,    59,    30,    51,
-     7,    46,     4,     5,    13,    13,    57,    58,    61,    24,
-    24,    68,    70,    51,    74,    75,    51 ]
+    65,    51,    63,    14,    48,     4,     5,    21,    47,    62,
+    18,    39,    15,    41,    66,    42,    43,    46,    49,    48,
+    34,    13,    13,    47,    26,    30,    39,    24,    41,    47,
+    42,    43,    46,    49,    41,    51,    42,    43,    46,    47,
+     4,     5,    56,    55,    41,    47,    42,    43,    46,    13,
+    59,    13,    42,    43,    46,     4,     5,    21,    59,    13,
+    18,    29,    46,    30,    59,    24,    23,    24,    46,    33,
+     7,    57,     4,     5,    10,    13,    10,    13,    58,    61,
+    24,    24,    68,    70,    51,    74,    75 ]
 
 racc_action_check = [
-    28,    28,    57,    51,    28,     0,     0,    28,     6,    28,
-    51,    28,    28,    28,    28,    69,    57,     3,     3,    69,
-     7,    21,    69,    21,    69,    21,    69,    69,    69,    69,
-    36,    11,    11,    36,    36,    36,    55,    36,    36,    36,
-    10,    55,    58,    55,    55,    55,    19,    58,    22,    58,
-    58,    58,     9,     9,     9,    16,    16,     9,    25,    25,
-    25,    27,    47,    25,    61,    27,    47,    68,    61,    29,
-     1,    68,     1,     1,    30,    33,    37,    41,    50,    52,
-    53,    60,    62,    63,    70,    72,    74 ]
+    57,    74,    51,     6,    69,    25,    25,    25,    69,    51,
+    25,    69,     7,    69,    57,    69,    69,    69,    69,    28,
+    28,    61,    10,    28,    19,    61,    28,    22,    28,    55,
+    28,    28,    28,    28,    55,    29,    55,    55,    55,    36,
+     0,     0,    36,    36,    36,    58,    36,    36,    36,    30,
+    58,    33,    58,    58,    58,     9,     9,     9,    47,    21,
+     9,    21,    47,    21,    68,    27,    11,    11,    68,    27,
+     1,    37,     1,     1,    16,    16,     3,     3,    41,    50,
+    52,    53,    60,    62,    63,    70,    72 ]
 
 racc_action_pointer = [
-     3,    70,   nil,    12,   nil,   nil,     4,    20,   nil,    50,
-    34,    26,   nil,   nil,   nil,   nil,    50,   nil,   nil,    42,
-   nil,    15,    42,   nil,   nil,    56,   nil,    55,    -4,    56,
-    68,   nil,   nil,    69,   nil,   nil,    22,    64,   nil,   nil,
-   nil,    63,   nil,   nil,   nil,   nil,   nil,    49,   nil,   nil,
-    69,    -9,    73,    74,   nil,    28,   nil,    -2,    34,   nil,
-    69,    58,    69,    70,   nil,   nil,   nil,   nil,    54,    11,
-    72,   nil,    76,   nil,    73,   nil,   nil ]
+    38,    70,   nil,    71,   nil,   nil,    -1,    12,   nil,    53,
+    16,    61,   nil,   nil,   nil,   nil,    69,   nil,   nil,    20,
+   nil,    53,    21,   nil,   nil,     3,   nil,    59,    15,    22,
+    43,   nil,   nil,    45,   nil,   nil,    31,    59,   nil,   nil,
+   nil,    64,   nil,   nil,   nil,   nil,   nil,    45,   nil,   nil,
+    70,   -10,    74,    75,   nil,    21,   nil,    -4,    37,   nil,
+    70,    15,    70,    71,   nil,   nil,   nil,   nil,    51,     0,
+    73,   nil,    77,   nil,   -12,   nil,   nil ]
 
 racc_action_default = [
    -51,   -51,    -2,   -15,    -5,    -6,   -51,   -51,    -1,   -51,
@@ -285,24 +285,24 @@ racc_action_default = [
    -48,   -49,   -51,   -22,   -51,   -42,   -50 ]
 
 racc_goto_table = [
-    22,    50,    35,    60,    28,    17,    54,     2,     8,     9,
-    19,    27,    20,     1,    16,    67,   nil,   nil,   nil,   nil,
-    52,    31,    25,    53,    72,    64,    19,   nil,    32,   nil,
+    22,    50,    35,    60,    28,    20,    54,     2,     8,     9,
+    17,    27,    19,     1,    16,    67,   nil,   nil,   nil,   nil,
+    52,    32,    25,    53,    72,    64,    31,   nil,    19,   nil,
    nil,   nil,   nil,   nil,   nil,    71,   nil,   nil,   nil,   nil,
    nil,   nil,   nil,    73,    69,   nil,    76,   nil,   nil,   nil,
    nil,    27 ]
 
 racc_goto_check = [
-     8,    13,    12,    18,    11,     6,    16,     2,     2,     4,
-     7,     8,    10,     1,     5,    17,   nil,   nil,   nil,   nil,
-     8,     6,     4,     8,    18,    16,     7,   nil,    10,   nil,
+     8,    13,    12,    18,    11,    10,    16,     2,     2,     4,
+     6,     8,     7,     1,     5,    17,   nil,   nil,   nil,   nil,
+     8,    10,     4,     8,    18,    16,     6,   nil,     7,   nil,
    nil,   nil,   nil,   nil,   nil,    13,   nil,   nil,   nil,   nil,
    nil,   nil,   nil,    12,    11,   nil,    13,   nil,   nil,   nil,
    nil,     8 ]
 
 racc_goto_pointer = [
-   nil,    13,     7,   nil,     6,     5,    -4,     1,   -10,   nil,
-     3,   -17,   -26,   -28,   nil,   nil,   -30,   -43,   -44,   nil ]
+   nil,    13,     7,   nil,     6,     5,     1,     3,   -10,   nil,
+    -4,   -17,   -26,   -28,   nil,   nil,   -30,   -43,   -44,   nil ]
 
 racc_goto_default = [
    nil,   nil,   nil,     3,   nil,   nil,   nil,     6,    11,    12,

data/spec/dump_spec.rb

@@ -0,0 +1,51 @@
+require "fortio-namelist"
+require "rspec-power_assert"
+
+describe "FortIO::Namelist" do
+  
+  example "dumping float" do 
+    root = {example: {v1: 1.234567890123456, v2: 0.123456789012345, v3: 1.234567890123456e10}}
+    output = FortIO::Namelist.dump(root)
+
+    answer = <<HERE
+&example
+  v1 = 1.234567890123456,
+  v2 = 0.123456789012345,
+  v3 = 1.234567890123456d+10
+/
+HERE
+
+    is_asserted_by { output == answer  }
+  end
+
+  example "dumping float 'd0'" do 
+    root = {example: {v1: 1.234567890123456, v2: 0.123456789012345, v3: 1.234567890123456e10}}
+    output = FortIO::Namelist.dump(root, float_format: 'd0')
+
+    answer = <<HERE
+&example
+  v1 = 1.234567890123456d0,
+  v2 = 0.123456789012345d0,
+  v3 = 1.234567890123456d+10
+/
+HERE
+
+    is_asserted_by { output == answer  }
+  end
+
+  example "dumping float 'exp'" do 
+    root = {example: {v1: 1.234567890123456, v2: 0.123456789012345, v3: 1.234567890123456e10}}
+    output = FortIO::Namelist.dump(root, float_format: 'exp')
+
+    answer = <<HERE
+&example
+  v1 = 1.234567890123456d+00,
+  v2 = 1.23456789012345d-01,
+  v3 = 1.234567890123456d+10
+/
+HERE
+
+    is_asserted_by { output == answer  }
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fortio-namelist
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -39,6 +39,7 @@ files:
 - lib/fortio-namelist/fortran_namelist.tab.rb
 - lib/fortio-namelist/fortran_namelist.y
 - spec/array_spec.rb
+- spec/dump_spec.rb
 - spec/empty_spec.rb
 - spec/identifier_spec.rb
 - spec/scalar_spec.rb
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A library for reading/writing fortran namelist file