genealogy 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 471eb61c7e2d5e29edac1c8796a0f35ab53d9405
-  data.tar.gz: ae2209d3c81a59f012649877ad9678eff6b4ddd4
+SHA256:
+  metadata.gz: 0b07b270d80c0d915e01f45424b27989f04b920a79bb4cd973484589d47530a6
+  data.tar.gz: 40753227d2d9e72a7779aa6fa28365f2a37e6e5121df1b0a821d71a835850de7
 SHA512:
-  metadata.gz: 4fe4635b6ad80fe2cbd6dfb6d6fb1c8740e7bb9c8e429e8aac7fb82231c3e1520c9d19a10587f6e0485d984030cfde9e6f625f5b94cc303a0b82b9c20aae0700
-  data.tar.gz: ff633aa6af193a025ae015edbaca533956b8e2fa2f391640bd213aacb08ecaccc00bfebf27d654b516cf053bb5f44b8efa09de049f22357b0c5474376b1cc2b9
+  metadata.gz: 67a933f6335a5a8d95dffa4284e8a198062a09cca098888e6d785608a22fbf463164322232376e1c83d7f1ea0362254ebbfac4e7e36bc8c500bb97510eb06b21
+  data.tar.gz: edb60383749cd28a0458252102e994b676796025a1fb55e716cc16a23f20810f23c3c9801163a4e93c06bbae45078cd41d71be40cbdd3808ddf4d8e1145b7845

data/lib/genealogy.rb

@@ -3,6 +3,7 @@ require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/exception
 require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/util_methods')
 require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/ineligible_methods')
 require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/query_methods')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/complex_query_methods')
 require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/alter_methods')
 require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/current_spouse_methods')
 require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/genealogy')

data/lib/genealogy/complex_query_methods.rb

@@ -0,0 +1,46 @@
+module Genealogy
+  module ComplexQueryMethods
+    extend ActiveSupport::Concern
+    include Constants
+
+    module ClassMethods
+
+      # Takes a splat argument of gclass objects and @return [ActiveRecord::Relation] of the first individual(s) to show up in the ancestors of the given people
+      # It moves up one generation at a time for each individual, stopping when there is a shared ancestor id or when there are no more ancestors
+      # If called on two full siblings, it will return both parents, as they appears in the same generation
+      # If called on two half siblings, it will return only the shared parent
+      # If one individual is the ancestor of the other, it will return that individual as the least common shared ancestors
+      # If none are found, it will return an empty AR relation.
+      def lowest_common_ancestors(*people)
+        raise ArgumentError, "all inputs must be an instance of the #{gclass} class" if people.select{|record| !record.is_a?(gclass)}.length > 0
+
+        parent_ids_temp = people.map{|person| [person.id]}
+        parent_ids_store = parent_ids_temp.clone
+
+        generation_count = 1
+
+        while parent_ids_temp.select{|array_of_ids| array_of_ids.length > 0}.length > 0
+          next_gen_ids = parent_ids_temp.map{|ids| gclass.where(id: ids).select([:father_id, :mother_id]).map{|result| [result.father_id, result.mother_id]}.flatten.compact}
+
+          next_gen_ids.each_with_index do |ids, index|
+            parent_ids_store[index] += ids
+            parent_ids_temp[index]   = ids
+          end
+
+          if parent_ids_store.reduce(:&).length > 0
+            return gclass.where(id: (parent_ids_store.reduce(:&)))
+          else
+            generation_count += 1
+          end
+        end
+        gclass.where(id: nil)
+      end
+    end
+
+    def lowest_common_ancestors(*people)
+      people << self
+      self.class.lowest_common_ancestors(*people)
+    end
+
+  end
+end

data/lib/genealogy/genealogy.rb

@@ -3,36 +3,41 @@ module Genealogy
   extend ActiveSupport::Concern
 
   module ClassMethods
-    
+
     include Genealogy::Constants
 
     # gives to ActiveRecord model geneaogy capabilities. Modules UtilMethods QueryMethods IneligibleMethods AlterMethods and SpouseMethods are included
     # @param [Hash] options
     # @option options [Boolean] current_spouse (false) specifies whether to track or not individual's current spouse
     # @option options [Boolean] perform_validation (true) specifies whether to perform validation or not while altering pedigree that is before updating relatives external keys
-    # @option options [Boolean, Symbol] ineligibility (:pedigree) specifies ineligibility setting. If `false` ineligibility checks will be disabled and you can assign, as a relative, any individuals you want. 
+    # @option options [Boolean, Symbol] ineligibility (:pedigree) specifies ineligibility setting. If `false` ineligibility checks will be disabled and you can assign, as a relative, any individuals you want.
     #   This can be dangerous because you can build nosense loop (in terms of pedigree). If pass one of symbols `:pedigree` or `:pedigree_and_dates` ineligibility checks will be enabled.
-    #   More specifically with `:pedigree` (or `true`) checks will be based on pedigree topography, i.e., ineligible children will include ancestors. With `:pedigree_and_dates` check will also be based on 
+    #   More specifically with `:pedigree` (or `true`) checks will be based on pedigree topography, i.e., ineligible children will include ancestors. With `:pedigree_and_dates` check will also be based on
     #   procreation ages (min and max, male and female) and life expectancy (male and female), i.e. an individual born 200 years before is an ineligible mother
-    # @option options [Hash] limit_ages (min_male_procreation_age:12, max_male_procreation_age:75, min_female_procreation_age:9, max_female_procreation_age:50, max_male_life_expectancy:110, max_female_life_expectancy:110) 
+    # @option options [Hash] limit_ages (min_male_procreation_age:12, max_male_procreation_age:75, min_female_procreation_age:9, max_female_procreation_age:50, max_male_life_expectancy:110, max_female_life_expectancy:110)
     #   specifies one or more limit ages different than defaults
     # @option options [Hash] column_names (sex:'sex', father_id:'father_id', mother_id:'mother_id', current_spouse_id:'current_spouse_id', birth_date:'birth_date', death_date:'death_date') specifies column names to map database individual table
-    # @option options [Array] sex_values (['M','F']) specifies values used in database sex column 
-    # @return [void] 
+    # @option options [Array] sex_values (['M','F']) specifies values used in database sex column
+    # @return [void]
+
     def has_parents options = {}
 
       include Genealogy::UtilMethods
       include Genealogy::QueryMethods
+      include Genealogy::ComplexQueryMethods
       include Genealogy::IneligibleMethods
       include Genealogy::AlterMethods
       include Genealogy::CurrentSpouseMethods
 
+
       check_has_parents_options(options)
 
       # keep track of the original extend class to prevent wrong scopes in query method in case of STI
       class_attribute :gclass, instance_writer: false
-      self.gclass = self 
-      
+      self.gclass = self
+
+      self.extend(Genealogy::ComplexQueryMethods::ClassMethods)
+
       class_attribute :ineligibility_level, instance_accessor: false
       self.ineligibility_level = case options[:ineligibility]
       when :pedigree
@@ -77,7 +82,7 @@ module Genealogy
       self.sex_values = options[:sex_values] || DEFAULTS[:sex_values]
       self.sex_male_value = self.sex_values.first
       self.sex_female_value = self.sex_values.last
-      
+
       # validation
       validates_presence_of :sex
       validates_format_of :sex, with: /[#{sex_values.join}]/
@@ -85,14 +90,14 @@ module Genealogy
       tracked_relatives = [:father, :mother]
       tracked_relatives << :current_spouse if current_spouse_enabled
       tracked_relatives.each do |k|
-        belongs_to k, class_name: self, foreign_key: self.send("#{k}_id_column")
+        belongs_to k, class_name: self.name, foreign_key: self.send("#{k}_id_column")
       end
 
-      has_many :children_as_father, class_name: self, foreign_key: self.father_id_column, dependent: :nullify
-      has_many :children_as_mother, class_name: self, foreign_key: self.mother_id_column, dependent: :nullify
+      has_many :children_as_father, class_name: self.name, foreign_key: self.father_id_column, dependent: :nullify
+      has_many :children_as_mother, class_name: self.name, foreign_key: self.mother_id_column, dependent: :nullify
 
     end
 
   end
 
-end
+end

data/lib/genealogy/query_methods.rb

@@ -128,27 +128,61 @@ module Genealogy
 
     # get list of known ancestrors iterateing over parents
     # @param [Hash] options
-    # @return [ActiveRecord::Relation] list of ancestors
+    # @option options [Symbol] generations lets you limit how many generations will be included in the output.
+    # @return [ActiveRecord::Relation] list of ancestors (limited by a number of generations if so indicated)
     def ancestors(options = {})
       ids = []
-      remaining_ids = parents.compact.map(&:id)
-      until remaining_ids.empty?
-        ids << remaining_ids.shift
-        remaining_ids += gclass.find(ids.last).parents.compact.map(&:id)
+      if options[:generations]
+        raise ArgumentError, ":generations option must be an Integer" unless options[:generations].is_a? Integer
+        generation_count = 0
+        generation_ids = parents.compact.map(&:id)
+        while (generation_count < options[:generations]) && (generation_ids.length > 0)
+          next_gen_ids = []
+          ids += generation_ids
+          until generation_ids.empty?
+            ids.unshift(generation_ids.shift)
+            next_gen_ids += gclass.find(ids.first).parents.compact.map(&:id)
+          end
+          generation_ids = next_gen_ids
+          generation_count += 1
+        end
+      else
+        remaining_ids = parents.compact.map(&:id)
+        until remaining_ids.empty?
+          ids << remaining_ids.shift
+          remaining_ids += gclass.find(ids.last).parents.compact.map(&:id)
+        end
       end
       gclass.where(id: ids)
     end
 
 
     # get list of known descendants iterateing over children ...
-    # @return [ActiveRecord::Relation] list of descendants
-    def descendants
+    # @param [Hash] options
+    # @option options [Symbol] generations lets you limit how many generations will be included in the output.
+    # @return [ActiveRecord::Relation] list of descendants (limited by a number of generations if so indicated)
+    def descendants(options = {})
       ids = []
-      remaining_ids = children.map(&:id)
-      until remaining_ids.empty?
-        ids << remaining_ids.shift
-        remaining_ids += gclass.find(ids.last).children.pluck(:id)
-        # break if (remaining_ids - ids).empty? can be necessary in case of loop. Idem for ancestors method
+      if options[:generations]
+        generation_count = 0
+        generation_ids = children.map(&:id)
+        while (generation_count < options[:generations]) && (generation_ids.length > 0)
+          next_gen_ids = []
+          ids += generation_ids
+          until generation_ids.empty?
+            ids.unshift(generation_ids.shift)
+            next_gen_ids += gclass.find(ids.first).children.map(&:id)
+          end
+          generation_ids = next_gen_ids
+          generation_count += 1
+        end
+      else
+        remaining_ids = children.map(&:id)
+        until remaining_ids.empty?
+          ids << remaining_ids.shift
+          remaining_ids += gclass.find(ids.last).children.pluck(:id)
+          # break if (remaining_ids - ids).empty? can be necessary in case of loop. Idem for ancestors method
+        end
       end
       gclass.where(id: ids)
     end

data/lib/genealogy/version.rb

@@ -1,3 +1,3 @@
 module Genealogy
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: genealogy
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - masciugo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +244,7 @@ extra_rdoc_files: []
 files:
 - lib/genealogy.rb
 - lib/genealogy/alter_methods.rb
+- lib/genealogy/complex_query_methods.rb
 - lib/genealogy/constants.rb
 - lib/genealogy/current_spouse_methods.rb
 - lib/genealogy/exceptions.rb
@@ -272,9 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: "[none]"
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Make ActiveRecord model act as a pedigree
 test_files: []
-has_rdoc: