genealogy 2.0.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdf7cbe432225d76eb4038f8ef6cfc11187614d1
-  data.tar.gz: 7320907b67ee1429f362b64ae2d0a725d89c0860
+  metadata.gz: 471eb61c7e2d5e29edac1c8796a0f35ab53d9405
+  data.tar.gz: ae2209d3c81a59f012649877ad9678eff6b4ddd4
 SHA512:
-  metadata.gz: b817085d638f75df6a32f17de986e8483482b4a420ef8e7582f6fd456530a48049c8f4bb930f02730e6e0b1c348fb830294b4e69f4ab9e8fd89d3c774c36cecc
-  data.tar.gz: 4fbf968ff2b4adf48adefaa9b0bb905abd0f37d26e8d42e5974f721d8bfc8240365e0c35e17285f1843b45f723ea30d2fbd5f4ec4137ff23d561e2e69858c861
+  metadata.gz: 4fe4635b6ad80fe2cbd6dfb6d6fb1c8740e7bb9c8e429e8aac7fb82231c3e1520c9d19a10587f6e0485d984030cfde9e6f625f5b94cc303a0b82b9c20aae0700
+  data.tar.gz: ff633aa6af193a025ae015edbaca533956b8e2fa2f391640bd213aacb08ecaccc00bfebf27d654b516cf053bb5f44b8efa09de049f22357b0c5474376b1cc2b9

data/lib/genealogy/ineligible_methods.rb

@@ -6,57 +6,48 @@ module Genealogy
 
     include Constants
 
-    # @!macro [attach] generate
+    # @!macro [attach] generate_method_ineligibles_parent_with_docs
     #   @method ineligible_$1s
-    #   list of individual who cannot be $1 
-    #   @return [Array,NilClass] Return nil if $1 already assigned
-    def self.generate_method_ineligibles_parent(parent)
-      define_method "ineligible_#{parent}s" do
-        unless self.send(parent) 
+    #   list of individual who cannot be $1 according to the ineligibility level in use.
+    #   At `:pedigree` level it returns `self` along with their descendants and all $2s.
+    #   At `:pedigree_and_dates` level it also includes all individuals who were not fertile during `self`'s estimated birth period.
+    #   @return [Array, NilClass] Return nil if $1 already assigned
+    def self.generate_method_ineligibles_parent_with_docs(parent_role,unexpected_sex)
+      define_method "ineligible_#{parent_role}s" do
+        unless self.send(parent_role) 
           ineligibles = []
-          ineligibles |= descendants | [self] | gclass.send("#{OPPOSITESEX[PARENT2SEX[parent]]}s") if gclass.ineligibility_level >= PEDIGREE
-          if gclass.ineligibility_level >= PEDIGREE_AND_DATES  and life_range
+          ineligibles |= descendants | [self] | gclass.send("#{unexpected_sex}s") if gclass.ineligibility_level >= PEDIGREE
+          if gclass.ineligibility_level >= PEDIGREE_AND_DATES  and birth_range
             ineligibles |= (gclass.all - ineligibles).find_all do |indiv|
-              if indiv.life_range
-                if birth
-                  !indiv.can_procreate_on?(birth)
-                else
-                  !indiv.can_procreate_during?(life_range)
-                end
-              else
-                false
-              end
+              !indiv.can_procreate_during?(birth_range)
             end
           end
           ineligibles
         end
       end
     end
-    generate_method_ineligibles_parent(:father)
-    generate_method_ineligibles_parent(:mother)
+    generate_method_ineligibles_parent_with_docs(:father, :female)
+    generate_method_ineligibles_parent_with_docs(:mother, :male)
 
 
-    # @!macro [attach] generate
-    #   @method ineligible_$1_grand$2(grandparent)
-    #   list of individual who cannot be $1 grand$2 
-    #   @return [Array,NilClass] Return nil if $$1 grand$2 already assigned
-    def self.generate_method_ineligible_grandparent(lineage,grandparent)
-      relationship = "#{lineage}_grand#{grandparent}"
+    # @!macro [attach] generate_method_ineligible_grandparent_with_docs
+    #   @method ineligible_$1_grand$3s
+    #   list of individual who cannot be $1 grand$3 according to the ineligibility level in use. If `self`'s $2 is known, it returns $2's ineligible $3s. 
+    #   Otherwise, at `:pedigree` level it returns `self` along with descendants, full siblings and all $4s.
+    #   At `:pedigree_and_dates` level it also includes all individuals who were not fertile during `self`'s $2 estimated birth period.
+    #   @return [Array, NilClass] Return nil if $1 grand$3 already assigned
+    def self.generate_method_ineligible_grandparent_with_docs(lineage,parent_role,grandparent2parent_role,unexpected_sex)
+      relationship = "#{lineage}_grand#{grandparent2parent_role}"
       define_method "ineligible_#{relationship}s" do
         unless send(relationship)
-          parent = send(LINEAGE2PARENT[lineage])          
           ineligibles = []
-          ineligibles |= [parent].compact | descendants | siblings | send("#{lineage}_half_siblings") | [self] | gclass.send("#{OPPOSITESEX[PARENT2SEX[grandparent]]}s") if gclass.ineligibility_level >= PEDIGREE
-          if gclass.ineligibility_level >= PEDIGREE_AND_DATES              
-            ineligibles |= if parent
-              parent.send("ineligible_#{grandparent}s")
-            else
-              (gclass.all - ineligibles).find_all do |indiv|
-                if indiv.life_range
-                  !indiv.can_procreate_during?(send("#{LINEAGE2PARENT[lineage]}_birth_range"))
-                else
-                  false
-                end
+          if parent = send(parent_role)          
+            ineligibles |= parent.send("ineligible_#{grandparent2parent_role}s")
+          elsif gclass.ineligibility_level >= PEDIGREE
+            ineligibles |= descendants | siblings | [self] | gclass.send("#{unexpected_sex}s")
+            if gclass.ineligibility_level >= PEDIGREE_AND_DATES              
+              ineligibles |= (gclass.all - ineligibles).find_all do |indiv|
+                !indiv.can_procreate_during?(send("#{parent_role}_birth_range"))
               end
             end
           end
@@ -65,12 +56,14 @@ module Genealogy
       end
     end
     
-    generate_method_ineligible_grandparent(:paternal,:father)
-    generate_method_ineligible_grandparent(:paternal,:mother)
-    generate_method_ineligible_grandparent(:maternal,:father)
-    generate_method_ineligible_grandparent(:maternal,:mother)
+    generate_method_ineligible_grandparent_with_docs(:paternal,:father,:father, :female)
+    generate_method_ineligible_grandparent_with_docs(:paternal,:father,:mother, :male)
+    generate_method_ineligible_grandparent_with_docs(:maternal,:mother,:father, :female)
+    generate_method_ineligible_grandparent_with_docs(:maternal,:mother,:mother, :male)
 
-    # list of individual who cannot be children: ancestors, children, full siblings, theirself and all individuals with father or mother according to self's sex
+    # list of individual who cannot be children according to the ineligibility level in use. 
+    # At `:pedigree` level it returns `self` along with their ancestors, children, full siblings and all individuals that already have father (if male) or mother (if female).
+    # At `:pedigree_and_dates` level it also includes all individuals who was born outside `self`'s fertility range, if estimable.
     # @return [Array]
     def ineligible_children
       ineligibles = []
@@ -81,7 +74,10 @@ module Genealogy
       ineligibles
     end
 
-    # list of individual who cannot be full siblings: ancestors, descendants, siblings, theirself and all individuals with different father or mother
+    # list of individual who cannot be siblings according to the ineligibility level in use. 
+    # At `:pedigree` level it returns `self` along with their full siblings, ancestors, descendants and all individuals with different father or mother.
+    # At `:pedigree_and_dates` level it also includes all individuals who cannot be siblings for age reasons. For each parent, if it is known 
+    # it includes parent's ineligible children, otherwise it tries to estimate parent's fertility period: if it's possible it includes all individuals whose estimated birth period doesn't overlap parent's fertility period.
     # @return [Array]
     def ineligible_siblings
       ineligibles = []
@@ -91,13 +87,14 @@ module Genealogy
         ineligibles |= (mother ? gclass.all_with(:mother).where("mother_id != ?", mother) : [])
       end
       if gclass.ineligibility_level >= PEDIGREE_AND_DATES 
-        # if a parent is present ineligible siblings are parent's ineligible children, otherwise try to estimate parent birth range.
-        # If it's possible ineligible siblings are all individuals whose life range overlaps parent birth range
         [:father,:mother].each do |parent|
           if p = send(parent)
+            # if a parent is present ineligible siblings are parent's ineligible children
             ineligibles |= p.ineligible_children
           elsif parent_fertility_range = send("#{parent}_fertility_range")
+            # if it's possible to estimate parent's fertility period
             remainings = gclass.all - ineligibles
+            # includes all individuals whose estimated birth period doesn't overlap parent's fertility period
             ineligibles |= remainings.find_all do |indiv|
               if ibr = indiv.birth_range
                 !parent_fertility_range.overlaps? ibr

data/lib/genealogy/query_methods.rb

@@ -9,19 +9,19 @@ module Genealogy
     def parents
       [father,mother]
     end
-    # @return [ActiveRecord] 
+    # @return [ActiveRecord, NilClass] 
     def paternal_grandfather
       father && father.father
     end
-    # @return [ActiveRecord] 
+    # @return [ActiveRecord, NilClass] 
     def paternal_grandmother
       father && father.mother
     end
-    # @return [ActiveRecord] 
+    # @return [ActiveRecord, NilClass] 
     def maternal_grandfather
       mother && mother.father
     end
-    # @return [ActiveRecord] 
+    # @return [ActiveRecord, NilClass] 
     def maternal_grandmother
       mother && mother.mother
     end
@@ -101,7 +101,7 @@ module Genealogy
         ids = siblings(half: :father).pluck(:id) | siblings(half: :mother).pluck(:id)
         result.where(id: ids)
       when :include # including half siblings
-        result.where("father_id == ? or mother_id == ?", father_id, mother_id)
+        result.where("father_id = ? or mother_id = ?", father_id, mother_id)
       else
         raise ArgumentError, "Admitted values for :half options are: :father, :mother, false, true or nil"
       end

data/lib/genealogy/util_methods.rb

@@ -63,14 +63,14 @@ module Genealogy
     # @param [Date] date
     # @return [Boolean] or nil if cannot be computable (#fertility_range returns nil)
     def can_procreate_on?(date)
-      fertility_range.cover? date if date and fertility_range
+      fertility_range.cover? date if (date and fertility_range)
     end
 
     # It tests whether fertility range overlaps specified period
     # @param [Range] period 
     # @return [Boolean] or nil if cannot be computable (#fertility_range returns nil)
     def can_procreate_during?(period)
-      fertility_range.overlaps? period if period and fertility_range
+      fertility_range.overlaps? period if (period and fertility_range)
     end
 
     # @!macro [attach] generate

data/lib/genealogy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genealogy
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.1
 platform: ruby
 authors:
 - masciugo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: "[none]"
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Make ActiveRecord model act as a pedigree