genealogy 1.5.0 → 2.0.0

data/lib/genealogy/util_methods.rb

@@ -0,0 +1,180 @@
+module Genealogy
+  # Module UtilMethods provides methods to run utility methods. It's included by the genealogy enabled AR model
+  module UtilMethods
+    extend ActiveSupport::Concern
+
+    include Constants
+
+    # Genealogy thinks time in term of Date, not DateTime
+    # @return [Date]
+    def birth
+      birth_date.try(:to_date)
+    end
+
+    # Genealogy thinks time in term of Date, not DateTime
+    # @return [Date]
+    def death
+      death_date.try(:to_date)
+    end
+
+    # optimistic (longest) estimation of life period. Calculation is based on available dates and max life expectancy
+    # @return [Range] life period or nil if cannot be computable
+    def life_range
+      if birth
+        if death
+          birth..death # exact
+        else
+          birth..(birth + max_le) # estimation based on birth
+        end
+      elsif death
+        (death - max_le)..death # estimation based on death
+      end
+    end
+
+    # optimistic (longest) estimation of birth date. Calculation is based on available dates and max life expectancy
+    # @return [Range] longest possible birth date interval or nil if cannot be computable
+    def birth_range
+      if birth
+        birth..birth # exact
+      elsif death
+        (death - max_le)..death # estimation based on death
+      end
+    end
+
+    # optimistic (longest) estimation of fertility period. Calculation is based on available dates, max life expectancy and min and max fertility procreation ages
+    # @return [Range] fertility period, nil if cannot be computable, false if died before reaching min fertility age
+    def fertility_range
+      if birth
+        if death
+          if death > birth + min_fpa
+            (birth + min_fpa)..([(birth + max_fpa), death].min) # best estimation
+          else
+            false # died before reaching min fertility age
+          end
+        else
+          (birth + min_fpa)..(birth + max_fpa) # estimation based on birth
+        end
+      elsif death
+        (death - max_le + min_fpa)..death # estimation based on death
+      end
+    end
+
+    # It tests whether fertility range covers specified date
+    # @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
+    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
+    end
+
+    # @!macro [attach] generate
+    #   @method $1_birth_range
+    #   optimistic (longest) estimation of $1's birth date. Calculation is based on receiver's birth or #life_range, max life expectancy and min and max fertility procreation ages
+    #   @return [Range] longest possible $1's birth date interval or nil when is not computable that is when birth or life range are not available
+    def self.generate_method_parent_birth_range(parent)
+      define_method "#{parent}_birth_range" do
+        if birth
+          (birth - gclass.send("max_#{PARENT2SEX[parent]}_procreation_age").years)..(birth - gclass.send("min_#{PARENT2SEX[parent]}_procreation_age").years)
+        elsif life_range
+          (life_range.begin - gclass.send("max_#{PARENT2SEX[parent]}_procreation_age").years)..(life_range.end - gclass.send("min_#{PARENT2SEX[parent]}_procreation_age").years)
+        end
+      end
+    end
+    generate_method_parent_birth_range(:father)
+    generate_method_parent_birth_range(:mother)
+
+    # @!macro [attach] generate
+    #   @method $1_fertility_range
+    #   optimistic (longest) estimation of $1's fertility range. Calculation is based on receiver's #$1_birth_range, min and max fertility procreation ages
+    #   @return [Range] longest possible $1's fertility period or nil when is not computable that is when $1_birth_range is not computable
+    def self.generate_method_parent_fertility_range(parent)
+      define_method "#{parent}_fertility_range" do
+        if parent_birth_range = send("#{parent}_birth_range")
+          (parent_birth_range.begin + gclass.send("min_#{PARENT2SEX[parent]}_procreation_age").years)..(parent_birth_range.end + gclass.send("max_#{PARENT2SEX[parent]}_procreation_age").years)
+        end
+      end
+    end
+    generate_method_parent_fertility_range(:father)
+    generate_method_parent_fertility_range(:mother)
+
+    # sex in terms of :male or :female
+    # @return [Symbol] 
+    def ssex
+      case sex
+      when gclass.sex_male_value
+        :male
+      when gclass.sex_female_value
+        :female
+      else
+        raise SexError, "Sex value not valid for #{self}"
+      end
+    end
+
+    # opposite sex in terms of :male or :female
+    # @return [Symbol] 
+    def opposite_ssex
+      OPPOSITESEX[ssex]
+    end
+
+    # @return [Boolean] 
+    def is_female?
+      return female? if respond_to?(:female?)
+      sex == gclass.sex_female_value
+    end
+
+    # @return [Boolean] 
+    def is_male?
+      return male? if respond_to?(:male?)
+      sex == gclass.sex_male_value
+    end
+    
+    # max life expectancy in terms of years. It depends on sex
+    # @return [Integer] 
+    def max_le
+      gclass.send("max_#{ssex}_life_expectancy").years
+    end
+    
+    # max fertility procreation age in terms of years. It depends on sex
+    # @return [Integer] 
+    def max_fpa
+      gclass.send("max_#{ssex}_procreation_age").years
+    end
+    
+    # min fertility procreation age in terms of years. It depends on sex
+    # @return [Integer] 
+    def min_fpa
+      gclass.send("min_#{ssex}_procreation_age").years
+    end
+
+    private 
+
+    def check_incompatible_relationship(*args)
+      relationship = args.shift
+      args.each do |relative|
+        # puts "[#{__method__}]: #{arg} class: #{arg.class}, #{self} class: #{self.class}"
+        next if relative.nil?
+        check_indiv(relative)
+        if gclass.ineligibility_level >= PEDIGREE
+          if ineligibles = self.send("ineligible_#{relationship.to_s.pluralize}")
+            # puts "[#{__method__}]: checking if #{relative} can be #{relationship} of #{self}"
+            raise IncompatibleRelationshipException, "#{relative} can't be #{relationship} of #{self}" if ineligibles.include? relative
+          else
+            raise IncompatibleRelationshipException, "#{self} already has #{relationship}"
+          end
+        end
+      end
+    end
+
+    def check_indiv(arg, arg_sex=nil)
+      raise ArgumentError, "Expected #{self.gclass} object. Got #{arg.class}" unless arg.class.equal? self.gclass
+      raise SexError, "Expected a #{arg_sex} as argument. Got a #{arg.ssex}" if arg_sex and arg.ssex != arg_sex
+    end
+
+  end
+end

data/lib/genealogy/version.rb

@@ -1,3 +1,3 @@
 module Genealogy
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,115 +1,185 @@
 --- !ruby/object:Gem::Specification
 name: genealogy
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - masciugo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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
     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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.99.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.99.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   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: database_cleaner
+  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: yard
+  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: redcarpet
+  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: github-markup
+  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: gem-release
   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: byebug
+  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'
-description: Genealogy is a ruby gem library which extend ActiveRecord::Base class
-  with familiar relationships capabilities in order to build and query genealogies
+description: Genealogy is a ruby gem library which extends ActiveRecord models in
+  order to make its instances act as relatives so that you can build and query genealogies
 email:
 - masciugo@gmail.com
 executables: []
@@ -119,10 +189,12 @@ files:
 - lib/genealogy.rb
 - lib/genealogy/alter_methods.rb
 - lib/genealogy/constants.rb
+- lib/genealogy/current_spouse_methods.rb
 - lib/genealogy/exceptions.rb
 - lib/genealogy/genealogy.rb
+- lib/genealogy/ineligible_methods.rb
 - lib/genealogy/query_methods.rb
-- lib/genealogy/spouse_methods.rb
+- lib/genealogy/util_methods.rb
 - lib/genealogy/version.rb
 homepage: https://github.com/masciugo/genealogy
 licenses:
@@ -134,18 +206,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ! '[none]'
-rubygems_version: 2.1.10
+rubyforge_project: "[none]"
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Organise ActiveRecord models into a genealogical tree structure
+summary: Make ActiveRecord model act as a pedigree
 test_files: []
+has_rdoc: 

data/lib/genealogy/spouse_methods.rb

@@ -1,53 +0,0 @@
-module Genealogy
-  module SpouseMethods
-    extend ActiveSupport::Concern
-
-    # add method
-    def add_current_spouse(obj)
-      raise IncompatibleObjectException, "Linked objects must be instances of the same class" unless obj.is_a? self.genealogy_class
-      raise WrongSexException, "Can't add current_spouse with same sex" if self.sex == obj.sex
-
-      if perform_validation
-        self.current_spouse = obj
-        obj.current_spouse = self
-        transaction do
-          obj.save!
-          save!
-        end
-      else
-        transaction do
-          self.update_attribute(:current_spouse,obj)
-          obj.update_attribute(:current_spouse,self)
-        end
-      end
-
-    end
-
-    # remove method
-    def remove_current_spouse
-      if perform_validation
-        ex_current_spouse = current_spouse
-        current_spouse.current_spouse = nil
-        self.current_spouse = nil
-        transaction do
-          ex_current_spouse.save!
-          save!
-        end
-      else
-        transaction do
-          current_spouse.update_attribute(:current_spouse,nil)
-          self.update_attribute(:current_spouse,nil)
-        end
-      end
-    end
-
-    # query methods
-    def eligible_current_spouses
-      self.genealogy_class.send("#{Genealogy::OPPOSITESEX[sex_to_s.to_sym]}s") - spouses
-    end
-
-    module ClassMethods
-    end
-
-  end
-end