fortio-namelist 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6be9628b6a286eac9e31901c71c0793928166b260040cbe93d2d902a8c93096
-  data.tar.gz: 80b6989bed8bb98e11ffae89a42fd6675f24454e7438287166915fb1fd56a0fc
+  metadata.gz: aa95f21c798ef2256d484af31914c2688bd6b210f2a0704b69b13646eb16b338
+  data.tar.gz: 18f9dac9edbe377bc934985b703b34793737476d143c9787852b84564ca011b4
 SHA512:
-  metadata.gz: 3584a0f098e8f5ab224e02e01e60581483643034e25d326dcc04b5352c4ac1fdf1a83700cef61b012ba31b9822b1523707027c6aeb764789463a3465dd360eef
-  data.tar.gz: 37328c227c9aa6e927111056a98ca92a4651a3740944319f166c62d6e1a60cea194fcbf04de30d0f63d0b5136dfdcf3024c7ca2eb5aec353880b58d5dd64ef02
+  metadata.gz: a841ab206370ee553dd92850da27009ed9dbd97ce43545843e5ff190afc5ae46407d30440f7f900708088de95c01598b4b0550c17a48b5b69a4ce205fc0fca14
+  data.tar.gz: f9f6da26c88005cd5c49ad8bb6a916d0731e98c0fd34f6f360d7760cb1fc9727209c4b313d33d4c3adfafbee2bcc8bf09c849dcbdb3a1901c2118e540d3e99d8

data/README.md

@@ -1,15 +1,16 @@
-
 fortio-namelist
 ===============
 
-This is a library for reading and writing data in Fortran's namelist format. With this library, you can read Fortran's namelist format data from Ruby and convert it to Hash objects, and vice versa. 
+This is a Ruby library for reading and writing Fortran's namelist. 
+This library allows you to read a namelist string as a Hash object, 
+or dump a Hash object to a namelist string.
 
 Features
 --------
 
-* 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)
+* Flexible parsing of (too free) namelist format using Racc
+* Reading namelist string as a Ruby's Hash object
+* Converting a Hash object to a namelist string (specifying the format) 
 
 Installation
 ------------
@@ -27,22 +28,22 @@ Usage
 
 ### Useful methods
 
-The user only needs to remember the following two methods.
+To read and write a namelist, it is sufficient to use only the following two methods.
 
     FortIO::Namelist.parse(input, group: nil)
     FortIO::Namelist.dump(root, **format_options)
 
-### Reading namelist string
+### Reading namelist
 
 To create a Hash object with namelist structure by reading a namelist string, use the following method.
 
     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 ('duck typing'). 
+The argument `input` is given as a string, but it also accepts objects with a method `#read` which 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`.
+To read only a specific group, give a group name to the keyword argument `group`. If `group` is omitted, all namelist groups included in `input` will be read. To load multiple groups, give an array of group names to `group`.
 
-Use lowercase Symbol objects for both group and variable names. The Hash object of the return value has a two-level structure as follows.
+The Hash object of the return value has a two-level structure as follows.
 
     {
       group1: {
@@ -59,7 +60,7 @@ Use lowercase Symbol objects for both group and variable names. The Hash object
           :
     }
 
-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.
+The group and variable names are converted to lowercase Symbol objects and stored as keys in the hash. 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. We chose symbol as the key of the hash object because it is thought to be compatible with the pattern matching introduced in Ruby 2.7.
 
 Example:
 
@@ -82,17 +83,17 @@ input = %{
 }
 
 ### read all groups
-root = FortIO::Namelist.read(input)
+root = FortIO::Namelist.parse(input)
 # => {: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")
+root = FortIO::Namelist.parse(input, group: "group2")
 # => {:group2=>{:var1=>12, :var2=>22}}
 
 ### read only "group1" and "group3"
-root = FortIO::Namelist.read(input, group: ["group1", "group3"])
+root = FortIO::Namelist.parse(input, group: ["group1", "group3"])
 # => {:group1=>{:var1=>11, :var2=>12}, 
 #     :group3=>{:var1=>31, :var2=>32}}
 
@@ -137,7 +138,17 @@ This script print a namelist format string to stdout.
 
 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
+* `array_style`    : the notation for array elements
+* `logical_format` : boolean literals
+* `float_format`   : the notation for floating point numbers
+* `alignment`      : how variable identifiers are aligned
+* `uppercase`      : whether variable names, etc. should be uppercase or lowercase.
+* `separator`      : the separator between variable definitions
+* `group_end`      : the group terminator
+* `indent`         : the indentation for variable definition
+
+
+#### `array_style` specifies the notation for array elements
 
 * 'stream' : (default)
 * 'index'  :
@@ -166,7 +177,7 @@ puts FortIO::Namelist.dump(root, array_style: 'index')
 # /
 ```
 
-#### `logical_format` : Specifying a boolean literal
+#### `logical_format` specifies boolean literals
 
 * 'normal' : normal notation like `.true.`, `.false` (default)
 * 'short'  : short notation like `t`, `f`
@@ -189,7 +200,7 @@ puts FortIO::Namelist.dump(root, logical_format: 'short')
 # /
 ```
 
-#### `float_format` : Specifying notation for floating point numbers
+#### `float_format` specifies the notation for floating point numbers
 
 * 'normal' : format with "%g" (default)
 * 'd0'     : format with "%g" followed by 'd0'
@@ -223,7 +234,7 @@ puts FortIO::Namelist.dump(root, float_format: 'exp')
 # /
 ```
 
-#### `alignment` : Specifying how variable identifiers are aligned
+#### `alignment` specifies 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'
@@ -280,7 +291,7 @@ puts FortIO::Namelist.dump(root, alignment: 'stream')
 # /
 ```
 
-#### `uppercase` : Specify whether variable names, etc. should be uppercase or lowercase.
+#### `uppercase` specifies whether variable names, etc. should be uppercase or lowercase.
 
 * false : (default)
 * true  :  
@@ -303,7 +314,7 @@ puts FortIO::Namelist.dump(root, uppercase: true)
 # /
 ```
 
-#### `separator` :  Specifying the separator between variable definitions
+#### `separator` specifies the separator between variable definitions
 
 * "comma", "," : comma + NL separeted (default)
 * "nl", "\n"   : NL separated
@@ -339,7 +350,7 @@ puts FortIO::Namelist.dump(root, separator: "nl")
 # /
 ```
 
-#### `group_end` : Specifying a group terminator
+#### `group_end` specifies the group terminator
 
 * "slash", "/" : end with `/` (default)
 * "end"        : end with `&end`
@@ -362,7 +373,7 @@ puts FortIO::Namelist.dump(root, group_end: 'end')
 # &end
 ```
 
-#### `indent` : Specifying the indentation for variable definition
+#### `indent` specifies the indentation for variable definition
                     
 * ' '*2 : two spaces (default)
 

data/fortio-namelist.gemspec

@@ -1,5 +1,5 @@
 Gem::Specification::new do |s|
-  version = "1.3.0"
+  version = "1.4.0"
   files = Dir.glob("**/*") - [ 
                                Dir.glob("fortio-namelist-*.gem"), 
                                Dir.glob("test/**/*"),
@@ -10,10 +10,12 @@ Gem::Specification::new do |s|
   s.name        = "fortio-namelist"
   s.summary     = "A library for reading/writing fortran namelist file"
   s.description = <<-HERE
-    A library for reading/writing fortran namelist file
+  This is a Ruby library for reading and writing Fortran's namelist. 
+  This library allows you to read a namelist string as a Hash object, 
+  or dump a Hash object to a namelist string.
   HERE
   s.version     = version
-  s.licenses    = ['MIT']
+  s.license     = 'MIT'
   s.author      = "Hiroki Motoyoshi"
   s.email       = ""
   s.homepage    = 'https://github.com/himotoyoshi/fortio-namelist'

data/lib/fortio-namelist/fortran_namelist.rb

@@ -98,14 +98,7 @@ module FortIO::Namelist
   #
   
   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
+    return value.to_s.sub(/e/, d)
   end
   
   def self.format_element (value, 

data/spec/dump_spec.rb

@@ -11,7 +11,7 @@ describe "FortIO::Namelist" do
 &example
   v1 = 1.234567890123456,
   v2 = 0.123456789012345,
-  v3 = 1.234567890123456d+10
+  v3 = 12345678901.23456
 /
 HERE
 
@@ -26,7 +26,7 @@ HERE
 &example
   v1 = 1.234567890123456d0,
   v2 = 0.123456789012345d0,
-  v3 = 1.234567890123456d+10
+  v3 = 12345678901.23456d0
 /
 HERE
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fortio-namelist
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -24,7 +24,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description: "    A library for reading/writing fortran namelist file\n"
+description: "  This is a Ruby library for reading and writing Fortran's namelist.
+  \n  This library allows you to read a namelist string as a Hash object, \n  or dump
+  a Hash object to a namelist string.\n"
 email: ''
 executables: []
 extensions: []