gedcom 0.9.2 → 0.9.3

data/lib/gedcom/multimedia_format_record.rb

@@ -0,0 +1,82 @@
+require 'gedcom_base.rb'
+
+#
+#=GEDCOM 5.5.1
+#=MULTIMEDIA_LINK:=
+#  n OBJE  <XREF>                         {1:1} is a reference to level 0 multimedia record.
+#  | 
+#  n OBJE                                 {1:1} is inline reference to an external file, rather than multimedia record.
+#    +1 FILE <MULTIMEDIA_FILE_REFN>       {1:M}	Now 1:M in 5.5.1, was 1:1 in 5.5
+#    	+2 FORM	 <MULTIMEDIA_FORMAT>        {1:1} Was as level 1 in GEDCOM 5.5
+#    		+3 MEDI <SOURCE_MEDIA_TYPE>       {0:1} New in 5.5.1
+#    +1 TITL <DESCRIPTIVE_TITLE>          {0:1} 
+#
+# No blobs in 5.5.1
+#
+#
+#The attributes are all arrays for the level +1 tags/records. 
+#* Those ending in _ref are GEDCOM XREF index keys
+#* Those ending in _record are array of classes of that type.
+#* The remainder are arrays of attributes that could be present in this record.
+
+class Multimedia_format_record < GEDCOMBase
+  attr_accessor :media_type, :format
+  attr_accessor :note_citation_record #for user defined tags
+  
+  ClassTracker <<  :Multimedia_format_record
+  
+  def to_gedcom(level=0)
+    
+    @this_level =  [ [:print, "FORM", :format]]
+    @sub_level =  [#level 1
+                    [:print, "MEDI",    :media_type ],            
+                    [:walk, nil,    :note_citation_record ],      #for user defined tags
+                  ]
+    
+    super(level)
+  end
+  
+  def type
+    :media_type
+  end
+  
+end
+
+#Almost the same structure inline in OBJE record. 
+#   Note TITL subordinate to FILE, rather than at same level.
+#        TYPE used, where MEDI used in Link version.
+#=MULTIMEDIA_RECORD:=
+#  0 @XREF:OBJE@ OBJE                     {0:M}
+#    +1 FILE <MULTIMEDIA_FILE_REFN>       {1:M}	New in 5.5.1
+#    	+2 FORM	 <MULTIMEDIA_FORMAT>        {1:1} Was as level 1 in GEDCOM 5.5
+#    		+3 TYPE <SOURCE_MEDIA_TYPE>       {0:1} New in 5.5.1
+#    	+2 TITL <DESCRIPTIVE_TITLE>         {0:1} Was as level 1 in GEDCOM 5.5
+#    ....
+#The attributes are all arrays for the level +1 tags/records. 
+#* Those ending in _ref are GEDCOM XREF index keys
+#* Those ending in _record are array of classes of that type.
+#* The remainder are arrays of attributes that could be present in this record.
+
+class Multimedia_obje_format_record < GEDCOMBase
+  attr_accessor :media_type, :format
+  attr_accessor :note_citation_record #for user defined tags
+  
+  ClassTracker <<  :Multimedia_obje_format_record
+  
+  def to_gedcom(level=0)
+    
+    @this_level =  [ [:print, "FORM", :format]]
+    @sub_level =  [#level 1
+                    [:print, "TYPE",    :media_type ],            
+                    [:walk, nil,        :note_citation_record ],      #for user defined tags
+                  ]
+    
+    super(level)
+  end
+  
+  def type
+    :media_type
+  end
+  
+end
+

data/lib/gedcom/multimedia_record.rb

@@ -3,7 +3,7 @@ require 'gedcom_base.rb'
 #Internal representation of the GEDCOM OBJE record type
 #GEDCOM has both inline OBJE records and references to level 0 OBJE records.
 #both are stored here and referenced through a Multimedia_citation_record class.
-#
+#=GEDCOM 5.5
 #=MULTIMEDIA_RECORD:=
 #  0 @XREF:OBJE@ OBJE                     {0:M}
 #    +1 FORM <MULTIMEDIA_FORMAT>          {1:1}
@@ -22,7 +22,10 @@ require 'gedcom_base.rb'
 #  subordinate OBJE tag to chain to the next <MULTIMEDIA_RECORD> fragment. This will allow
 #  GEDCOM records to be maintained below the 32K limit for use in systems with limited resources.
 #
-#  n OBJE                                 {1:1} is a reference to an external file, rather than inline.
+#=MULTIMEDIA_LINK:=
+#  n OBJE  <XREF>                         {1:1} is a reference to level 0 multimedia record.
+#  | 
+#  n OBJE                                 {1:1} is a reference to an external file, rather than inline blob.
 #    +1 FORM <MULTIMEDIA_FORMAT>          {1:1}
 #    +1 TITL <DESCRIPTIVE_TITLE>          {0:1}
 #    +1 FILE <MULTIMEDIA_FILE_REFERENCE>  {1:1}
@@ -37,14 +40,40 @@ require 'gedcom_base.rb'
 #  the GEDCOM file in context, but the maintenance and transfer of the multimedia files are external to
 #  GEDCOM. The parser can just treat this as a comment and doesn't check for the file being present.
 #
+#=GEDCOM 5.5.1
+#=MULTIMEDIA_RECORD:=
+#  0 @XREF:OBJE@ OBJE                     {0:M}
+#    +1 FILE <MULTIMEDIA_FILE_REFN>       {1:M}	New in 5.5.1
+#    	+2 FORM	 <MULTIMEDIA_FORMAT>        {1:1} Was as level 1 in GEDCOM 5.5
+#    		+3 TYPE <SOURCE_MEDIA_TYPE>       {0:1} New in 5.5.1
+#    	+2 TITL <DESCRIPTIVE_TITLE>         {0:1} Was as level 1 in GEDCOM 5.5
+#    +1 <<NOTE_STRUCTURE>>                {0:M}
+#    +1 <<SOURCE_CITATION>>               {0:M}	New in 5.5.1
+#    +1 REFN <USER_REFERENCE_NUMBER>      {0:M}
+#      +2 TYPE <USER_REFERENCE_TYPE>      {0:1}
+#    +1 RIN <AUTOMATED_RECORD_ID>         {0:1}
+#    +1 <<CHANGE_DATE>>                   {0:1}
+#
+#=MULTIMEDIA_LINK:=
+#  n OBJE  <XREF>                         {1:1} is a reference to level 0 multimedia record.
+#  | 
+#  n OBJE                                 {1:1} is inline reference to an external file, rather than multimedia record.
+#    +1 FILE <MULTIMEDIA_FILE_REFN>       {1:M}	Now 1:M in 5.5.1, was 1:1 in 5.5
+#    	+2 FORM	 <MULTIMEDIA_FORMAT>        {1:1} Was as level 1 in GEDCOM 5.5
+#    		+3 TYPE <SOURCE_MEDIA_TYPE>       {0:1} New in 5.5.1
+#    +1 TITL <DESCRIPTIVE_TITLE>          {0:1} 
+#
 #The attributes are all arrays for the level +1 tags/records. 
 #* Those ending in _ref are GEDCOM XREF index keys
 #* Those ending in _record are array of classes of that type.
 #* The remainder are arrays of attributes that could be present in this record.
 class Multimedia_record < GEDCOMBase
-  attr_accessor :multimedia_ref, :format, :title, :encoded_line_record, :next_multimedia_ref, :filename
+  attr_accessor :multimedia_ref, :title, :encoded_line_record, :next_multimedia_ref
   attr_accessor :refn_record, :automated_record_id, :note_citation_record, :change_date_record
-
+  attr_accessor :multimedia_obje_file_record #GEDCOM 5.5.1, though some 5.5 variants need this too.
+  attr_accessor :multimedia_file_record, :multimedia_format_record #GEDCOM 5.5.1, though some 5.5 variants need this too.
+  attr_accessor :source_citation_record #Gedcom 5.5.1
+  
   ClassTracker <<  :Multimedia_record
   
   def to_gedcom(level=0)
@@ -56,17 +85,36 @@ class Multimedia_record < GEDCOMBase
     end
 
     @sub_level =  [#level 1
-                    [:print, "TITL",    :title ],
-                    [:print, "FORM",    :format ],
-                    [:walk, nil,    :encoded_line_record ],
-                    [:xref, nil,     :next_multimedia_ref ],
-                    [:print, "FILE",    :filename ],
-                    [:walk, nil,    :note_citation_record ],
-                    [:walk, nil,     :refn_record ],
-                    [:print, "RIN",    :automated_record_id ],
+                    [:walk, nil,    :multimedia_obje_file_record ], #"FILE", GEDCOM 5.5.1, FILE reference, rather than blobs.
+                    [:walk, nil,    :multimedia_file_record ], #"FILE", GEDCOM 5.5.1, FILE reference, rather than blobs.
+                    [:print, "TITL",:title ],                    #GEDCOM 5.5, Subordinate to FILE in 5.5.1
+                    [:walk, nil,    :multimedia_format_record ], # "FORM", GEDCOM 5.5, Subordinate to FILE in 5.5.1
+                    [:walk, nil,    :encoded_line_record ],       #GEDCOM 5.5 BLOB
+                    [:xref, nil,    :next_multimedia_ref ],      #GEDCOM 5.5 OBJE, Next BLOB reference.
+                    [:walk, nil,    :source_citation_record],      #GEDCOM 5.5.1
+                    [:walk, nil,    :note_citation_record ],    
+                    [:walk, nil,    :refn_record ],
+                    [:print, "RIN", :automated_record_id ],
                     [:walk, nil,    :change_date_record ],
                   ]
-    
+      
     super(level)
   end
+  
+  #Replacing :filename with multimedia_file_record could break some code, 
+  #so def filename returns the filename in the first multimedia_file_record's filename field.
+  def filename
+    #ALL Tag values get stored in arrays, as there could be more than one instance of a Tag
+    #Hence the 'first' is added.
+      multimedia_obj_file_record != nil ? multimedia_obj_file_record.first.filename : nil
+  end
+
+  #Replacing :format with multimedia_format_record could break some code, 
+  #so def format returns the format in the first multimedia_format_record's format field.
+  def format
+    #ALL Tag values get stored in arrays, as there could be more than one instance of a Tag
+    #Hence the 'first' is added.
+      multimedia_obj_format_record != nil ? multimedia_obj_format_record.first.format : nil
+  end
+  
 end

data/lib/gedcom/name_phonetic_record.rb

@@ -0,0 +1,70 @@
+require 'gedcom_base.rb'
+
+#GEDCOM 5.5.1 Draft adds as subordinate to NAME
+#
+#    +1 FONE <NAME_PHONETIC_VARIATION>
+#      +2 TYPE <PHONETIC_TYPE>
+#      +2 <<PERSONAL_NAME_PIECES>> 
+#
+#==NAME_PHONETIC_VARIATION:=                                               {Size=1:120}
+#  PHONETIC_TYPE [<user defined> | hangul | kana]                        {Size=5:30}
+#The phonetic variation of the name is written in the same form as the was the name used in the superior <NAME_PERSONAL> primitive,
+# but phonetically written using the method indicated by the subordinate <PHONETIC_TYPE> value, for example if hiragana was used 
+#to provide a reading of a name written in kanji, then the <PHONETIC_TYPE> value would indicate 'kana'. 
+#
+
+class Name_phonetic_record < GEDCOMBase
+  #Phonetic Name is stored in phonetic_name and recovered via def name, or the alias phonetic_name
+  attr_writer :phonetic_name
+  attr_accessor :prefix, :given, :nickname, :surname_prefix, :surname, :suffix
+  attr_accessor :restriction, :source_citation_record, :note_citation_record
+  ClassTracker <<  :Name_phonetic_record
+  
+  def initialize(*a)
+    super(*a)
+     @this_level = [ [:print, "FONE", :phonetic_name] ]
+     @sub_level = [
+                       [:print, "NPFX",    :prefix ],
+                       [:print, "GIVN",    :given ],
+                       [:print, "NICK",    :nickname ],
+                       [:print, "SPFX",    :surname_prefix ],
+                       [:print, "SURN",    :surname ],
+                       [:print, "NSFX",    :suffix ],
+                       [:walk, nil,    :source_citation_record],
+                       [:walk, nil,    :note_citation_record],
+                       [:print, "RESN", :restriction],
+                   ] 
+  end
+  
+  #return the name as a string. It might be returned be the #phonetic_name method.
+  # or it might need to be contructed from the Name_phonetic_record personal name pieces attributes. 
+  def name
+    if (name = phonetic_name) == nil
+      name = "" #could be what we return if none of the Name_record attributes are set
+      if @prefix
+        name += @prefix.first
+        name += ' ' if @given || @nickname || @surname_prefix || @surname || @suffix
+      end
+      if @given
+        name += @given.first  
+        name += ' ' if  @nickname || @surname_prefix || @surname || @suffix
+      end
+      if @nickname
+        name += '(' + @nickname.first + ')'  
+        name += ' ' if @surname_prefix || @surname || @suffix
+      end
+      if @surname_prefix
+        name += @surname_prefix.first
+        name += ' ' if  @surname || @suffix
+      end
+      if @surname
+        name += ( '/' + @surname.first + '/' ) 
+        name += ' ' if  @suffix
+      end
+      name += @suffix.first  if @suffix
+    end
+    return name.first
+  end
+  
+  alias :phonetic_name :name
+end

data/lib/gedcom/name_record.rb

@@ -32,10 +32,10 @@ require 'individual_attribute_record.rb'
 #
 #  The surname of an individual, if known, is enclosed between two slash (/) characters. The order of the
 #  name parts should be the order that the person would, by custom of their culture, have used when
-#  giving it to a recorder. Early versions of Personal Ancestral File and other products did not use the ®
+#  giving it to a recorder. Early versions of Personal Ancestral File and other products did not use the (R)
 #  trailing slash when the surname was the last element of the name. If part of name is illegible, that part
 #  is indicated by an ellipsis (...). Capitalize the name of a person or place in the conventional
-#  manner—capitalize the first letter of each part and lowercase the other letters, unless conventional
+#  manner-capitalize the first letter of each part and lowercase the other letters, unless conventional
 #  usage is otherwise. For example: McMurray.
 #  Examples:
 #    1 NAME William Lee                 (given name only or surname not known)
@@ -69,8 +69,40 @@ require 'individual_attribute_record.rb'
 #* Those ending in _ref are GEDCOM XREF index keys
 #* Those ending in _record are array of classes of that type.
 #* The remainder are arrays of attributes that could be present in this record.
+#
+#GEDCOM 5.5.1 Draft adds
+#
+#    +1 TYPE <NAME_TYPE> 
+#    +1 FONE <NAME_PHONETIC_VARIATION>
+#      +2 TYPE <PHONETIC_TYPE>
+#      +2 <<PERSONAL_NAME_PIECES>> 
+#    +1 ROMN <NAME_ROMANIZED_VARIATION>
+#      +2 TYPE <ROMANIZED_TYPE> 
+#      +2 <<PERSONAL_NAME_PIECES>>
+#
+#==NAME_TYPE:=	                                                         {Size=5:30} 
+# [ aka | birth | immigrant | maiden | married | <user defined> ]
+#Indicates the name type, for example the name issued or assumed as an immigrant.
+#e.g. birth indicates name given on birth certificate.
+#
+#==NAME_PHONETIC_VARIATION:=                                               {Size=1:120}
+#  PHONETIC_TYPE [<user defined> | hangul | kana]                        {Size=5:30}
+#The phonetic variation of the name is written in the same form as the was the name used in the superior <NAME_PERSONAL> primitive,
+# but phonetically written using the method indicated by the subordinate <PHONETIC_TYPE> value, for example if hiragana was used 
+#to provide a reading of a name written in kanji, then the <PHONETIC_TYPE> value would indicate 'kana'. 
+#
+#==NAME_ROMANIZED_VARIATION:=	                                              {Size=1:120} 
+#  ROMANIZED_TYPE [<user defined> | pinyin | romaji | wadegiles]            {Size=5:30}
+#The romanized variation of the name is written in the same form prescribed for the name used in the superior <NAME_PERSONAL> context. 
+#The method used to romanize the name is indicated by the line_value of the subordinate <ROMANIZED_TYPE>, for example 
+#if romaji was used to provide a reading of a name written in kanji, then the ROMANIZED_TYPE subordinate to the ROMN tag 
+#would indicate romaji.
+#==TYPE:=
 class Name_record < Individual_attribute_record
+  #Name stored in field "value", as this is an individual_attribute_record subtype.
+  #Value of attribute "type" is set to NAME
   attr_accessor :prefix, :given, :nickname, :surname_prefix, :surname, :suffix
+  attr_accessor :name_type, :name_phonetic_record, :name_romanized_record #GEDCOM 5.5.1
   ClassTracker <<  :Name_record
   
   def initialize(*a)
@@ -82,9 +114,13 @@ class Name_record < Individual_attribute_record
                        [:print, "SPFX",    :surname_prefix ],
                        [:print, "SURN",    :surname ],
                        [:print, "NSFX",    :suffix ],
+                       [:print, "TYPE",    :name_type ], #5.5.1
+                       [:walk,  "FONE",    :name_phonetic_record],
+                       [:walk,  "ROMN",    :name_romanized_record],
                    ] + @sub_level
   end
 
+  #Attributes and Events have a common class, as they are essentially identical.
   def event_tag(tag)
     case tag
     when "NAME" then tag

data/lib/gedcom/name_romanized_record.rb

@@ -0,0 +1,72 @@
+require 'gedcom_base.rb'
+
+#GEDCOM 5.5.1 Draft adds as subordinate to NAME
+#
+#    +1 ROMN <NAME_ROMANIZED_VARIATION>
+#      +2 TYPE <ROMANIZED_TYPE> 
+#      +2 <<PERSONAL_NAME_PIECES>>
+#
+#
+#
+#==NAME_ROMANIZED_VARIATION:=	                                              {Size=1:120} 
+#  ROMANIZED_TYPE [<user defined> | pinyin | romaji | wadegiles]            {Size=5:30}
+#The romanized variation of the name is written in the same form prescribed for the name used in the superior <NAME_PERSONAL> context. 
+#The method used to romanize the name is indicated by the line_value of the subordinate <ROMANIZED_TYPE>, for example 
+#if romaji was used to provide a reading of a name written in kanji, then the ROMANIZED_TYPE subordinate to the ROMN tag 
+#would indicate romaji.
+
+class Name_romanized_record < GEDCOMBase
+  #romanized Name is stored in romanized_name and recovered via def name, or the alias romanized_name
+  attr_writer :romanized_name
+  attr_accessor :prefix, :given, :nickname, :surname_prefix, :surname, :suffix
+  attr_accessor :restriction, :source_citation_record, :note_citation_record
+  ClassTracker <<  :Name_romanized_record
+  
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:print, "ROMN", :romanized_name] ]
+     @sub_level = [
+                       [:print, "NPFX",    :prefix ],
+                       [:print, "GIVN",    :given ],
+                       [:print, "NICK",    :nickname ],
+                       [:print, "SPFX",    :surname_prefix ],
+                       [:print, "SURN",    :surname ],
+                       [:print, "NSFX",    :suffix ],
+                       [:walk, nil,    :source_citation_record],
+                       [:walk, nil,    :note_citation_record],
+                       [:print, "RESN", :restriction],
+                   ] 
+  end
+  
+  #return the name as a string. It might be returned be the romanized_name method.
+  # or it might need to be contructed from the Name_romanized_record personal name pieces attributes. 
+  def name
+    if (name = romanized_name) == nil
+      name = "" #could be what we return if none of the Name_record attributes are set
+      if @prefix
+        name += @prefix.first
+        name += ' ' if @given || @nickname || @surname_prefix || @surname || @suffix
+      end
+      if @given
+        name += @given.first  
+        name += ' ' if  @nickname || @surname_prefix || @surname || @suffix
+      end
+      if @nickname
+        name += '(' + @nickname.first + ')'  
+        name += ' ' if @surname_prefix || @surname || @suffix
+      end
+      if @surname_prefix
+        name += @surname_prefix.first
+        name += ' ' if  @surname || @suffix
+      end
+      if @surname
+        name += ( '/' + @surname.first + '/' ) 
+        name += ' ' if  @suffix
+      end
+      name += @suffix.first  if @suffix
+    end
+    return name.first
+  end
+  
+  alias :romanized_name :name
+end

data/lib/gedcom/place_record.rb

@@ -21,7 +21,9 @@ require 'gedcom_base.rb'
 #* Those ending in _record are array of classes of that type.
 #* The remainder are arrays of attributes that could be present in the PLAC records.
 class Place_record < GEDCOMBase
-  attr_accessor :place_value, :place_hierachy, :source_citation_record, :note_citation_record
+  attr_accessor :place_value, :place_hierachy
+  attr_accessor :source_citation_record, :note_citation_record
+  attr_accessor :placename_phonetic_record, :placename_romanized_record, :placename_map_record
 
   ClassTracker <<  :Place_record
   
@@ -30,6 +32,9 @@ class Place_record < GEDCOMBase
       @this_level = [  [:print, "PLAC", :place_value] ]
       @sub_level =  [ #level + 1
                       [:print, "FORM", :place_hierachy],
+                      [:print, "FONE", :placename_phonetic_record],
+                      [:print, "ROMN", :placename_romanized_record],
+                      [:print, "MAP", :placename_map_record],
                       [:walk, nil,    :source_citation_record],
                       [:walk, nil,    :note_citation_record],
                     ]
@@ -37,6 +42,9 @@ class Place_record < GEDCOMBase
       @this_level = [  [:nodata, "PLAC", nil] ]
       @sub_level =  [ #level + 1
                       [:print, "FORM", :place_hierachy],
+                      [:print, "FONE", :placename_phonetic_record],
+                      [:print, "ROMN", :placename_romanized_record],
+                      [:print, "MAP", :placename_map_record],
                       [:walk, nil,    :source_citation_record],
                       [:walk, nil,    :note_citation_record],
                     ]

data/lib/gedcom/placename_map_record.rb

@@ -0,0 +1,39 @@
+require 'gedcom_base.rb'
+
+#=Placename_map_record
+#GEDCOM 5.5.1 Draft adds as subordinate to PLAC
+#
+#    +1 MAP 
+#      +2 LATI <PLACE_LATITUDE> 
+#      +2 LONG <PLACE_LONGITUDE>
+#
+#==PLACE_LATITUDE:=                                               {Size=5:8}
+#  The value specifying the latitudinal coordinate of the place name. The latitude coordinate is 
+#the direction North or South from the equator in degrees and fraction of degrees carried out to give 
+#the desired accuracy. For example: 18 degrees, 9 minutes, and 3.4 seconds North would be formatted 
+#as N18.150944. Minutes and seconds are converted by dividing the minutes value by 60 and the seconds 
+#value by 3600 and adding the results together. This sum becomes the fractional part of the degree's value. 
+#
+#==PLACE_LONGITUDE:=	                                            {Size=5:8} 
+#The value specifying the longitudinal coordinate of the place name. The longitude coordinate is Degrees 
+#and fraction of degrees east or west of the zero or base meridian coordinate. For example: 168 degrees, 
+#9 minutes, and 3.4 seconds East would be formatted as E168.150944.
+#
+#I allow a NOTE record too, to cope with user defined tags
+
+class Placename_map_record < GEDCOMBase
+  attr_accessor :latitude, :longitude
+  attr_accessor :note_citation_record
+  ClassTracker <<  :Placename_map_record
+  
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:print, "MAP", nil] ]
+     @sub_level = [
+                       [:print, "LATI", :latitude],
+                       [:print, "LONG", :longitude], #Not standard
+                       [:walk, nil,    :note_citation_record],
+                   ] 
+  end
+end
+