gedcom 0.9.0

data/lib/gedcom/gedcom_record.rb

@@ -0,0 +1,44 @@
+require 'gedcom_base.rb'
+
+#Internal representation of the GEDCOM GEDC record type in a HEAD record.
+#
+#=HEADER:=
+#  n HEAD                                          {1:1}
+#    ...
+#   +1 GEDC                                        {1:1}
+#     +2 VERS <VERSION_NUMBER>                     {1:1}
+#     +2 FORM <GEDCOM_FORM>                        {1:1}
+#   ...
+#
+#==VERSION_NUMBER:=
+#  An identifier that represents the version level
+#  changed by the creators of the product.
+#
+#==GEDCOM_FORM:= {Size=14:20}
+#  [ LINEAGE-LINKED ]
+#  The GEDCOM form used to construct this transmission. There maybe other forms used such as
+#  CommSoft's "EVENT_LINEAGE_LINKED" but these specifications define only the LINEAGELINKED
+#  Form. Systems will use this value to specify GEDCOM compatible with these
+#  specifications.
+#
+#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 Gedcom_record < GEDCOMBase
+  attr_accessor :version, :encoding_format
+  attr_accessor :note_citation_record
+
+  ClassTracker <<  :Gedcom_record
+  
+  #new sets up the state engine arrays @this_level and @sub_level, which drive the to_gedcom method generating GEDCOM output.
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:nodata, "GEDC", nil] ]
+    @sub_level =  [ #level + 1
+                    [ :print, "VERS", :version],
+                    [ :print, "FORM", :encoding_format],
+                    [ :walk, nil,  :note_citation_record],
+                  ]
+  end  
+end

data/lib/gedcom/header_data_record.rb

@@ -0,0 +1,49 @@
+require 'gedcom_base.rb'
+
+#Internal representation of the GEDCOM DATA in a SOUR record in a level 0 HEAD record type
+#This is not the same record type as DATA tags in level 0 SOUR record.
+#
+#=HEADER:=
+#  n HEAD                                             {1:1}
+#    +1 SOUR <APPROVED_SYSTEM_ID>                     {1:1}
+#      ...
+#      +2 DATA <NAME_OF_SOURCE_DATA>                  {0:1}
+#        +3 DATE <PUBLICATION_DATE>                   {0:1}
+#        +3 COPR <COPYRIGHT_SOURCE_DATA>              {0:1}
+#      ...
+#   ...
+#==NAME_OF_SOURCE_DATA:= {Size=1:90}
+#  The name of the electronic data source that was used to obtain the data in this transmission. For
+#  example, the data may have been obtained from a CD-ROM disc that was named "U.S. 1880
+#  CENSUS CD-ROM vol. 13."
+#
+#==PUBLICATION_DATE:= {Size=10:11}
+#  <DATE_EXACT>:= <DAY> <MONTH> <YEAR_GREG> {Size=10:11}
+#  The date this source was published or created.
+#
+#==COPYRIGHT_SOURCE_DATA:= {Size=1:90}
+#  A copyright statement required by the owner of data from which this information was down- loaded.
+#  For example, when a GEDCOM down-load is requested from the Ancestral File, this would be the
+#  copyright statement to indicate that the data came from a copyrighted source.
+#
+#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 Header_data_record < GEDCOMBase
+  attr_accessor :data_source, :date, :copyright
+  attr_accessor :note_citation_record
+
+  ClassTracker <<  :Header_data_record
+  
+  #new sets up the state engine arrays @this_level and @sub_level, which drive the to_gedcom method generating GEDCOM output.
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:print, "DATA", :data_source] ]
+    @sub_level =  [ #level + 1
+                    [:print, "DATE", :date],
+                    [:print, "COPR", :copyright],
+                    [:walk, nil,    :note_citation_record],
+                  ]
+  end  
+end

data/lib/gedcom/header_record.rb

@@ -0,0 +1,75 @@
+require 'gedcom_base.rb'
+
+#Internal representation of the GEDCOM level 0 HEAD record type
+#
+#=HEADER:=
+#  n HEAD                                          {1:1}
+#    +1 SOUR <APPROVED_SYSTEM_ID>                  {1:1}
+#      +2 VERS <VERSION_NUMBER>                    {0:1}
+#      +2 NAME <NAME_OF_PRODUCT>                   {0:1}
+#      +2 CORP <NAME_OF_BUSINESS>                  {0:1}
+#        +3 <<ADDRESS_STRUCTURE>>                  {0:1}
+#      +2 DATA <NAME_OF_SOURCE_DATA>               {0:1}
+#        +3 DATE <PUBLICATION_DATE>                {0:1}
+#        +3 COPR <COPYRIGHT_SOURCE_DATA>           {0:1}
+#   +1 DEST <RECEIVING_SYSTEM_NAME>                {0:1} (See NOTE below)
+#   +1 DATE <TRANSMISSION_DATE>                    {0:1}
+#     +2 TIME <TIME_VALUE>                         {0:1}
+#   +1 SUBM @XREF:SUBM@                            {1:1}
+#   +1 SUBN @XREF:SUBN@                            {0:1}
+#   +1 FILE <FILE_NAME>                            {0:1}
+#   +1 COPR <COPYRIGHT_GEDCOM_FILE>                {0:1}
+#   +1 GEDC                                        {1:1}
+#     +2 VERS <VERSION_NUMBER>                     {1:1}
+#     +2 FORM <GEDCOM_FORM>                        {1:1}
+#   +1 CHAR <CHARACTER_SET>                        {1:1}
+#     +2 VERS <VERSION_NUMBER>                     {0:1}
+#   +1 LANG <LANGUAGE_OF_TEXT>                     {0:1}
+#   +1 PLAC                                        {0:1}
+#     +2 FORM <PLACE_HIERARCHY>                    {1:1}
+#   +1 NOTE <GEDCOM_CONTENT_DESCRIPTION>           {0:1}
+#     +2 [CONT|CONC] <GEDCOM_CONTENT_DESCRIPTION>  {0:M}
+#  NOTE::
+#    Submissions to the Family History Department for Ancestral File submission or for clearing temple ordinances must use a
+#    DESTination of ANSTFILE or TempleReady.
+#
+#  The header structure provides information about the entire transmission. The SOURce system name
+#  identifies which system sent the data. The DESTination system name identifies the intended receiving
+#  system.
+#
+#  Additional GEDCOM standards will be produced in the future to reflect GEDCOM expansion and
+#  maturity. This requires the reading program to make sure it can read the GEDC.VERS and the
+#  GEDC.FORM values to insure proper readability. The CHAR tag is required. All character codes
+#  greater than 0x7F must be converted to ANSEL.
+#
+#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 Header_record < GEDCOMBase
+  attr_accessor :header_source_record, :destination, :date_record, :submitter_ref, :submission_ref
+  attr_accessor :file_name, :copyright, :gedcom_record, :character_set_record, :language_id
+  attr_accessor :place_record, :note_citation_record
+  
+  ClassTracker <<  :Header_record
+  
+  #new sets up the state engine arrays @this_level and @sub_level, which drive the to_gedcom method generating GEDCOM output.
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:nodata, "HEAD", nil] ]
+    @sub_level =  [ #level + 1
+                    [:walk, nil,:header_source_record],
+                    [:print, "DEST", :destination],
+                    [:walk, nil, :date_record], 
+                    [:xref, "SUBM", :submitter_ref], 
+                    [:xref, "SUBN", :submission_ref],
+                    [:print, "FILE", :file_name], 
+                    [:print, "COPR", :copyright], 
+                    [:walk, nil, :gedcom_record],  
+                    [:walk, nil, :character_set_record], 
+                    [:print, "LANG", :language_id], 
+                    [:walk, nil, :place_record], 
+                    [:walk, nil, :note_citation_record],
+                  ]
+  end  
+end

data/lib/gedcom/header_source_record.rb

@@ -0,0 +1,42 @@
+require 'gedcom_base.rb'
+
+#Internal representation of the GEDCOM SOUR record in a level 0 HEAD record.
+#These SOUR records are not the same as level 0 SOUR records.
+#
+#=HEADER:=
+#  0 HEAD                                 {1:1}
+#    1 SOUR <APPROVED_SYSTEM_ID>          {1:1}
+#      +1 VERS <VERSION_NUMBER>           {0:1}
+#      +1 NAME <NAME_OF_PRODUCT>          {0:1}
+#      +1 CORP <NAME_OF_BUSINESS>         {0:1}
+#        +2 <<ADDRESS_STRUCTURE>>         {0:1}
+#      +1 DATA <NAME_OF_SOURCE_DATA>      {0:1}
+#        +2 DATE <PUBLICATION_DATE>       {0:1}
+#        +2 COPR <COPYRIGHT_SOURCE_DATA>  {0:1}
+#    ...
+#
+#  The SOURce system name identifies which system sent the data.
+#
+#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 Header_source_record < GEDCOMBase
+  attr_accessor :approved_system_id, :version, :name, :corporate_record, :header_data_record
+  attr_accessor :note_citation_record
+  
+  ClassTracker <<  :Header_source_record
+  
+  #new sets up the state engine arrays @this_level and @sub_level, which drive the to_gedcom method generating GEDCOM output.
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:print, "SOUR", :approved_system_id] ]
+    @sub_level =  [ #level + 1
+                    [:print, "VERS", :version],
+                    [:print, "NAME", :name],
+                    [:walk, nil, :corporate_record],
+                    [:walk, nil, :header_data_record],
+                    [:walk, nil, :note_citation_record],
+                  ]
+  end  
+end

data/lib/gedcom/individual_attribute_record.rb

@@ -0,0 +1,86 @@
+require 'gedcom_base.rb'
+require 'event_record.rb'
+
+#Internal representation of the GEDCOM Individual_Attribute_Structure.
+#Individual_attribute_record subclasses Event_record, as they share the same class attributes as events.
+#
+#=INDIVIDUAL_ATTRIBUTE_STRUCTURE:=      {0:M} Note that this structure can occur many times an Individual_record.
+#  n SEX <SEX_VALUE>                    {0:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n CAST <CASTE_NAME>                  {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n DSCR <PHYSICAL_DESCRIPTION>        {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n EDUC <SCHOLASTIC_ACHIEVEMENT>      {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n IDNO <NATIONAL_ID_NUMBER>          {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n NATI <NATIONAL_OR_TRIBAL_ORIGIN>   {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n NCHI <COUNT_OF_CHILDREN>           {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n NMR <COUNT_OF_MARRIAGES>           {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n OCCU <OCCUPATION>                  {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n PROP <POSSESSIONS>                 {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n RELI <RELIGIOUS_AFFILIATION>       {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n RESI                               {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n SSN <SOCIAL_SECURITY_NUMBER>       {0:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+#  n TITL <NOBILITY_TYPE_TITLE>         {1:1}
+#    +1 <<EVENT_DETAIL>>                {0:1}
+# 
+#  Note:: The usage of IDNO requires that the subordinate TYPE tag be used to define what kind of
+#         number is assigned to IDNO.
+#
+#  Also Note that SEX has been added here, and removed from the Individual_record. This allows SEX
+#  To be included multiple times, and have associated events (e.g. a sex change). I also do not check
+#  That the SEX_VALUE is M,F or U. to allow for the XXY, XXXY and X and other genetic anomolies 
+#  associated with gender that might need to be recorded. None of this affects reading GEDCOM files,
+#  and will not affect the writing of them if you don't add an event, or use non-standard SEX_VALUEs.
+#
+#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 Individual_attribute_record < Event_record
+
+  ClassTracker <<  :Individual_attribute_record
+  
+  def attr_type=(value)
+    @event_type = value
+  end
+  def attr_type
+    @event_type
+  end
+  def value=(value)
+    @event_status = value
+  end
+  def value
+    @event_status
+  end
+
+  def event_tag(tag)
+    case tag
+    when "SEX" then tag
+    when "CAST" then tag
+    when "DSCR" then tag
+    when "EDUC" then tag
+    when "IDNO" then tag
+    when "NATI" then tag
+    when "NCHI" then tag
+    when "NMR"  then tag
+    when "OCCU" then tag
+    when "PROP" then tag
+    when "RELI" then tag
+    when "RESI" then tag
+    when "SSN"  then tag
+    when "TITL" then tag
+    else super(tag)
+    end
+  end
+end

data/lib/gedcom/individual_record.rb

@@ -0,0 +1,128 @@
+require 'gedcom_base.rb'
+
+#Internal representation of the GEDCOM level 0 INDI record type
+#
+#=INDIVIDUAL_RECORD:=
+#  n @XREF:INDI@ INDI                       {1:1}
+#    +1 RESN <RESTRICTION_NOTICE>           {0:1}
+#    +1 <<PERSONAL_NAME_STRUCTURE>>         {0:M}
+#    +1 <<INDIVIDUAL_EVENT_STRUCTURE>>      {0:M}
+#    +1 <<INDIVIDUAL_ATTRIBUTE_STRUCTURE>>  {0:M}
+#    +1 <<LDS_INDIVIDUAL_ORDINANCE>>        {0:M}
+#    +1 <<CHILD_TO_FAMILY_LINK>>            {0:M}
+#    +1 <<SPOUSE_TO_FAMILY_LINK>>           {0:M}
+#    +1 SUBM @<XREF:SUBM>@                  {0:M}
+#    +1 <<ASSOCIATION_STRUCTURE>>           {0:M}
+#    +1 ALIA @<XREF:INDI>@                  {0:M}
+#    +1 ANCI @<XREF:SUBM>@                  {0:M}
+#    +1 DESI @<XREF:SUBM>@                  {0:M}
+#    +1 <<SOURCE_CITATION>>                 {0:M}
+#    +1 <<MULTIMEDIA_LINK>>                 {0:M}
+#    +1 <<NOTE_STRUCTURE>>                  {0:M}
+#    +1 RFN <PERMANENT_RECORD_FILE_NUMBER>  {0:1}
+#    +1 AFN <ANCESTRAL_FILE_NUMBER>         {0: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}
+#
+#  The individual record is a compilation of facts, known or discovered, about an individual. Sometimes
+#  these facts are from different sources. This form allows documentation of the source where each of
+#  the facts were discovered.
+#
+#  The normal lineage links are shown through the use of pointers from the individual to a family
+#  through either the FAMC tag or the FAMS tag. The FAMC tag provides a pointer to a family where
+#  this person is a child. The FAMS tag provides a pointer to a family where this person is a spouse or
+#  parent. The <<CHILD_TO_FAMILY_LINK>> (see page 27) structure contains a FAMC pointer
+#  which is required to show any child to parent linkage for pedigree navigation. The
+#  <<CHILD_TO_FAMILY_LINK>> structure also indicates whether the pedigree link represents a
+#  birth lineage, an adoption lineage, or a sealing lineage.
+#
+#  Linkage between a child and the family they belonged to at the time of an event can also optionally
+#  be shown by a FAMC pointer subordinate to the appropriate event. For example, a FAMC pointer
+#  subordinate to an adoption event would show which family adopted this individual. Biological parent
+#  or parents can be indicated by a FAMC pointer subordinate to the birth event. The FAMC tag can
+#  also optionally be used subordinate to an ADOPtion, or BIRTh event to differentiate which set of
+#  parents were related by adoption, sealing, or birth.
+#
+#  I removed SEX from INDI and added it to the Individual_attribute_record class.
+#
+#  Other associations or relationships are represented by the ASSOciation tag. The person's relation
+#  or association is the person being pointed to. The association or relationship is stated by the value
+#  on the subordinate RELA line. For example:
+#    0 @I1@ INDI
+#    1 NAME Fred/Jones/
+#    1 ASSO @I2@
+#    2 RELA Godfather
+#
+#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 Individual_record < GEDCOMBase
+  attr_accessor :individual_ref, :restriction, :name_record, :event_record, :individual_attribute_record, :alias_ref
+  attr_accessor :families_individuals, :association_record, :submitter_ref, :ancestor_interest_ref, :descendant_interest_ref
+  attr_accessor :source_citation_record, :multimedia_citation_record, :note_citation_record
+  attr_accessor :registered_ref_id, :lds_ancestral_file_no, :refn_record, :automated_record_id, :change_date_record
+
+  ClassTracker <<  :Individual_record
+  
+  #new sets up the state engine arrays @this_level and @sub_level, which drive the to_gedcom method generating GEDCOM output.
+  def initialize(*a)
+    super(*a)
+    @this_level = [ [:xref, "INDI", :individual_ref] ]
+    @sub_level =  [ #level 1
+                    [:print, "RESN", :restriction],
+                    [:walk, nil,  :name_record],
+                    [:walk, nil, :individual_attribute_record],
+                    [:walk, nil, :event_record],
+                    [:walk, nil, :families_individuals],
+                    [:walk, nil, :association_record],
+                    [:xref, "ALIA", :alias_ref],
+                    [:xref, "ANCI", :ancestor_interest_ref],
+                    [:xref, "DESI", :descendant_interest_ref],
+                    [:xref, "SUBM", :submitter_ref],
+                    [:walk, nil,    :multimedia_citation_record ],
+                    [:walk, nil,    :source_citation_record ],
+                    [:walk, nil,    :note_citation_record ],
+                    [:print, "RFN", :registered_ref_id],
+                    [:print, "AFN", :lds_ancestral_file_no],
+                    [:walk, nil, :refn_record ],
+                    [:walk, nil,    :change_date_record],
+                    [:print, "RIN",  :automated_record_id ],
+                  ]
+  end  
+  
+  def id
+    #temporary 
+    @individual_ref
+  end
+  
+  def parents_family
+    parents_family = []
+    @families_individuals.each { |m| parents_family << m.parents_family_ref if m.relationship_type == "FAMC"}
+    parent_family
+  end
+  
+  def spouses
+    spouses = []
+    @families_individuals.each { |m| spouses << m.own_family if m.relationship_type == "FAMS"}
+    spouses
+  end
+  
+  def birth
+    if @event_record != nil
+      @event_record.each { |e| if e.is_event('BIRT') then return e end }
+    else
+      nil
+    end
+  end
+  
+  def death
+    if @event_record != nil
+      @event_record.each { |e| if e.is_event('DEAT') then return e end }
+    else
+      nil
+    end
+  end
+end

data/lib/gedcom/multimedia_citation_record.rb

@@ -0,0 +1,55 @@
+require 'gedcom_base.rb'
+
+#Internal representation of a reference to the GEDCOM level 0 OBJE record type
+#GEDCOM has both inline OBJE records and references to level 0 OBJE records.
+#both are stored stored in a Multimedia_record class and both get referenced through this class.
+#
+#=MULTIMEDIA_LINK:=
+#  n OBJE @<XREF:OBJE>@           {1:1}
+#
+#  This structure provides two options in handling the GEDCOM multimedia interface. The first
+#  alternative (embedded) includes all of the data, including the multimedia object, within the
+#  transmission file. The embedded method includes pointers to GEDCOM records that contain
+#  encoded image or sound objects. Each record represents a multimedia object or object fragment. An
+#  object fragment is created by breaking the multimedia files into several multimedia object records of
+#  32K or less. These fragments are tied together by chaining from one multimedia object fragment to
+#  the next in sequence. This procedure will help manage the size of a multimedia GEDCOM record so
+#  that existing systems which are not expecting large multimedia records may discard the records
+#  without crashing due to the size of the record. Systems which handle embedded multimedia can
+#  reconstitute the multimedia fragments by decoding the object fragments and concatenating them to
+#  the assigned multimedia file.
+#
+#  This second method allows the GEDCOM context to be connected to an external multimedia file.
+#  GEDCOM defines this in the MULTIMEDIA_LINK definition, but I have put it into the Multimedia_record.
+#  as the attributes are the same, except BLOB becomes FILE. A Multimedia_citation_record is also created
+#  to make all references to Multimedia records consistent.
+#
+#  This process is only managed by GEDCOM in the sense that the appropriate file name is included in
+#  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.
+#
+#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_citation_record < GEDCOMBase
+  attr_accessor :multimedia_ref, :multimedia_record
+  attr_accessor :note_citation_record
+
+  ClassTracker <<  :Multimedia_citation_record
+  
+  def to_gedcom(level=0)
+    if @multimedia_ref != nil
+      @this_level = [ [:xref, "OBJE", :multimedia_ref] ]
+      @sub_level =  [#level 1
+                      [:walk, nil,    :note_citation_record ],
+                    ]
+    else
+      @this_level = [ [:walk, nil, :multimedia_record] ]
+      @sub_level =  [#level 1
+                    ]
+    end
+    super(level)
+  end
+end
+