genealogy 0.0.2.beta1

data/lib/genealogy.rb

@@ -0,0 +1,10 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/constants')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/exceptions')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/query_methods')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/linking_methods')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/spouse_methods')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'genealogy/genealogy')
+
+ActiveRecord::Base.send :extend, Genealogy
+
+

data/lib/genealogy/constants.rb

@@ -0,0 +1,3 @@
+module Genealogy
+  LINEAGE_NAME = { :father => :paternal, :mother => :maternal }
+end

data/lib/genealogy/exceptions.rb

@@ -0,0 +1,13 @@
+module Genealogy
+  class WrongArgumentException < RuntimeError;  end
+  class WrongOptionException < RuntimeError;  end
+  class WrongOptionValueException < RuntimeError;  end
+  class LineageGapException < RuntimeError;  end
+  class IncompatibleObjectException < RuntimeError;  end
+  class WrongSexException < RuntimeError;  end
+  class IncompatibleRelationshipException < RuntimeError
+    def initialize(msg = "Trying to create a relationship incopatible with the the existing ones")
+      super(msg)
+    end
+  end
+end

data/lib/genealogy/genealogy.rb

@@ -0,0 +1,67 @@
+module Genealogy
+
+  def check_options(options, admitted_keys)
+
+    raise WrongArgumentException, "first argument must be in a hash." unless options.is_a? Hash
+    raise WrongArgumentException, "seconf argument must be in an array." unless admitted_keys.is_a? Array
+
+    options.each do |key, value|
+      unless admitted_keys.include? key
+        raise WrongOptionException.new("Unknown option: #{key.inspect} => #{value.inspect}.")
+      end
+      if block_given?
+        yield key, value
+      end
+    end
+
+  end
+
+
+  def has_parents options = {}
+
+    admitted_keys = [:sex_column, :sex_values, :father_column, :mother_column, :spouse_column, :spouse]
+    check_options(options, admitted_keys) do |key, value|
+      if key == :sex_values
+        raise WrongOptionException, ":sex_values option must be an array with two char: first for male sex symbol an last for female" unless value.is_a?(Array) and value.size == 2 and value.first.to_s.size == 1 and value.last.to_s.size == 1
+      end
+    end
+    
+    class_attribute :spouse_enabled
+    self.spouse_enabled = options[:spouse].try(:==,true) || false
+    tracked_parents = [:father, :mother]
+    tracked_parents << :spouse if spouse_enabled
+
+    ## sex
+    # class attributes
+    class_attribute :sex_column, :sex_values, :sex_male_value, :sex_female_value
+    self.sex_column = options[:sex_column] || :sex
+    self.sex_values = (options[:sex_values] and options[:sex_values].to_a.map(&:to_s)) || ['M','F']
+    self.sex_male_value = self.sex_values.first
+    self.sex_female_value = self.sex_values.last
+    # instance attribute
+    alias_attribute :sex, sex_column if self.sex_column != :sex
+    # validation
+    validates_presence_of sex_column
+    validates_format_of sex_column, :with => /[#{sex_values.join}]/ 
+
+    ## relatives associations
+    tracked_parents.each do |key|
+      # class attribute where is stored the correspondig foreign_key column name
+      class_attribute_name = "#{key}_column"
+      foreign_key = "#{key}_id"
+      class_attribute class_attribute_name
+      self.send("#{class_attribute_name}=", options[class_attribute_name.to_sym] || foreign_key)
+      
+      # self join association
+      attr_accessible foreign_key
+      belongs_to key, class_name: self, foreign_key: foreign_key
+    
+    end
+
+    # Include instance methods and class methods
+    include Genealogy::QueryMethods
+    include Genealogy::LinkingMethods
+
+  end
+  
+end

data/lib/genealogy/linking_methods.rb

@@ -0,0 +1,192 @@
+module Genealogy
+  module LinkingMethods
+    extend ActiveSupport::Concern
+
+    # parents 
+    [:father, :mother].each do |parent|
+
+      # add method
+      define_method "add_#{parent}" do |relative|
+        unless relative.nil?
+          raise IncompatibleObjectException, "Linked objects must be instances of the same class: got #{relative.class} for #{self.class}" unless relative.is_a? self.class
+          incompatible_parents = self.offspring | self.siblings.to_a | [self] 
+          raise IncompatibleRelationshipException, "#{relative} can't be #{parent} of #{self}" if incompatible_parents.include? relative
+          raise WrongSexException, "Can't add a #{relative.sex} #{parent}" unless (parent == :father and relative.is_male?) or (parent == :mother and relative.is_female?)
+        end
+        self.send("#{parent}=",relative)
+        save!
+      end
+      
+      # remove method
+      define_method "remove_#{parent}" do
+        self.send("#{parent}=",nil)
+        save!
+      end
+
+    end
+
+    # add both
+    def add_parents(father,mother)
+      transaction do
+        add_father(father)
+        add_mother(mother)
+      end
+    end
+
+    # remove both
+    def remove_parents
+      transaction do
+        remove_father
+        remove_mother
+      end
+    end
+
+    # grandparents
+    [:father, :mother].each do |parent|
+      [:father, :mother].each do |grandparent|
+        # add one 
+        define_method "add_#{Genealogy::LINEAGE_NAME[parent]}_grand#{grandparent}" do |relative|
+          raise IncompatibleRelationshipException, "#{self} can't be grand#{grandparent} of itself" if relative == self
+          raise_if_gap_on(parent)
+          send(parent).send("add_#{grandparent}",relative)
+        end
+        # remove one
+        define_method "remove_#{Genealogy::LINEAGE_NAME[parent]}_grand#{grandparent}" do
+          raise_if_gap_on(parent)
+          send(parent).send("remove_#{grandparent}")
+        end
+      end
+    end
+
+    [:father, :mother].each do |parent|
+      # add two by lineage
+      define_method "add_#{Genealogy::LINEAGE_NAME[parent]}_grandparents" do |grandfather,grandmother|
+        raise_if_gap_on(parent)
+        send(parent).send("add_parents",grandfather,grandmother)
+      end
+      # remove two by lineage
+      define_method "remove_#{Genealogy::LINEAGE_NAME[parent]}_grandparents" do
+        raise_if_gap_on(parent)
+        send(parent).send("remove_parents")
+      end
+    end
+
+    # add all
+    def add_grandparents(pgf,pgm,mgf,mgm)
+      transaction do
+        add_paternal_grandparents(pgf,pgm)
+        add_maternal_grandparents(mgf,mgm)
+      end
+    end
+
+    # remove all
+    def remove_grandparents
+      transaction do
+        remove_paternal_grandparents
+        remove_maternal_grandparents
+      end
+    end
+
+
+    ## siblings
+    def add_siblings(*args)
+      options = args.extract_options!
+      raise LineageGapException, "Can't add siblings if both parents are nil" unless father and mother
+      raise IncompatibleRelationshipException, "Can't add an ancestor as sibling" unless (ancestors.to_a & args).empty?
+      transaction do
+        args.each do |sib|
+          case options[:half]
+          when :father
+            sib.add_father(self.father)
+            sib.add_mother(options[:spouse]) if options[:spouse]
+          when :mother
+            sib.add_father(options[:spouse]) if options[:spouse]
+            sib.add_mother(self.mother)
+          when nil
+            sib.add_father(self.father)
+            sib.add_mother(self.mother)
+          else
+            raise WrongOptionValueException, "Admitted values for :half options are: :father, :mother or nil"
+          end
+        end
+      end
+    end
+
+    def remove_siblings(options = {})
+      options.delete_if{ |key,value| key == :half and ![:father,:mother].include?(value) }
+
+      resulting_indivs = siblings(options)
+
+      transaction do
+
+        resulting_indivs.each do |sib|
+          case options[:half]
+          when :father
+            sib.remove_father
+            sib.remove_mother if options[:affect_spouse] == true
+          when :mother
+            sib.remove_father if options[:affect_spouse] == true
+            sib.remove_mother
+          when nil
+            sib.remove_parents
+          end  
+
+        end
+      end
+
+    end
+
+    # offspring
+    def add_offspring(*args)
+      options = args.extract_options!
+      
+      raise_if_sex_undefined
+
+      transaction do
+        args.each do |child|
+          case sex
+          when sex_male_value
+            child.add_father(self)
+            child.add_mother(options[:spouse]) if options[:spouse]
+          when sex_female_value
+            child.add_father(options[:spouse]) if options[:spouse]
+            child.add_mother(self)
+          end
+        end
+      end
+    end
+
+    def remove_offspring(options = {})
+      
+      raise_if_sex_undefined
+
+      resulting_indivs = offspring(options)
+      transaction do
+        resulting_indivs.each do |child|
+          if options[:affect_spouse] == true
+            child.remove_parents
+          else
+            case sex
+            when sex_male_value
+              child.remove_father
+            when sex_female_value
+              child.remove_mother
+            end  
+          end
+        end
+      end
+      resulting_indivs.empty? ? false : true
+    end
+
+    private
+
+    def raise_if_gap_on(relative)
+      raise LineageGapException, "#{self} doesn't have #{relative}" unless send(relative)
+    end
+
+    def raise_if_sex_undefined
+      raise WrongSexException, "Can't proceed if sex undefined for #{self}" unless is_male? or is_female?
+    end
+
+  end
+end

data/lib/genealogy/query_methods.rb

@@ -0,0 +1,113 @@
+module Genealogy
+  module QueryMethods
+    extend ActiveSupport::Concern
+
+    # parents
+    def parents
+      if father or mother
+        [father,mother]
+      else
+        []
+      end
+    end
+
+    # grandparents
+    [:father, :mother].each do |parent|
+      [:father, :mother].each do |grandparent|
+
+        # get one
+        define_method "#{Genealogy::LINEAGE_NAME[parent]}_grand#{grandparent}" do
+          send(parent) && send(parent).send(grandparent)
+        end
+
+      end
+
+      # get two by lineage
+      define_method "#{Genealogy::LINEAGE_NAME[parent]}_grandparents" do
+        (send(parent) && send(parent).parents) || []
+      end
+
+    end
+
+    # get all
+    def grandparents
+      result = []
+      [:father, :mother].each do |parent|
+        [:father, :mother].each do |grandparent|
+          result << send("#{Genealogy::LINEAGE_NAME[parent]}_grand#{grandparent}")
+        end
+      end
+      result.compact! if result.all?{|gp| gp.nil? }
+      result
+    end
+
+    def offspring(options = {})
+
+      if spouse = options[:spouse]
+        raise WrongSexException, "Something wrong with spouse #{spouse} gender." if spouse.sex == sex 
+      end
+      case sex
+      when sex_male_value
+        self.class.find_all_by_father_id(id, :conditions => (["mother_id == ?", spouse.id] if spouse) )
+      when sex_female_value
+        self.class.find_all_by_mother_id(id, :conditions => (["father_id == ?", spouse.id] if spouse) )
+      end
+    end
+
+    def siblings(options = {})
+      result = case options[:half]
+      when :father # common father
+        father.try(:offspring, options).to_a
+      when :mother # common mother
+        mother.try(:offspring, options).to_a
+      when nil # exluding half siblings
+        siblings(:half => :father) & siblings(:half => :mother)
+      when :only # only half siblings
+        siblings(:half => :include) - siblings
+      when :include # including half siblings
+        siblings(:half => :father) | siblings(:half => :mother)
+      else
+        raise WrongOptionValueException, "Admitted values for :half options are: :father, :mother, false, true or nil"
+      end
+      result - [self]
+    end
+
+    def half_siblings(options = {})
+      siblings(:half => :only)
+      # todo: inprove with option :father and :mother 
+    end
+
+    def ancestors
+      result = []
+      remaining = parents.to_a.compact
+      until remaining.empty?
+        result << remaining.shift
+        remaining += result.last.parents.to_a.compact
+      end
+      result.uniq
+    end
+
+    def descendants
+      result = []
+      remaining = offspring.to_a.compact
+      until remaining.empty?
+        result << remaining.shift
+        remaining += result.last.offspring.to_a.compact
+      end
+      result.uniq
+    end
+
+
+    def is_female?
+      sex == sex_female_value
+    end
+
+    def is_male?
+      sex == sex_male_value  
+    end
+
+    module ClassMethods
+    end
+
+  end
+end

data/lib/genealogy/spouse_methods.rb

@@ -0,0 +1,32 @@
+module Genealogy
+  module SpouseMethods
+    extend ActiveSupport::Concern
+
+    # add method
+    def add_spouse(obj)
+      raise IncompatibleObjectException, "Linked objects must be instances of the same class" unless obj.is_a? self.class
+      raise WrongSexException, "Can't add spouse with same sex" if self.sex == obj.sex
+      self.spouse = obj
+      obj.spouse = self
+      transaction do
+        obj.save!
+        save!
+      end
+    end
+
+    # remove method
+    def remove_spouse
+      transaction do
+        ex_spouse = spouse
+        spouse.spouse = nil
+        self.spouse = nil
+        ex_spouse.save!
+        save!
+      end
+    end
+
+    module ClassMethods
+    end
+
+  end
+end

data/lib/genealogy/version.rb

@@ -0,0 +1,3 @@
+module Genealogy
+  VERSION = "0.0.2.beta1"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: genealogy
+version: !ruby/object:Gem::Version
+  version: 0.0.2.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- masciugo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a description
+email:
+- masciugo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/genealogy.rb
+- lib/genealogy/constants.rb
+- lib/genealogy/exceptions.rb
+- lib/genealogy/genealogy.rb
+- lib/genealogy/linking_methods.rb
+- lib/genealogy/query_methods.rb
+- lib/genealogy/spouse_methods.rb
+- lib/genealogy/version.rb
+homepage: https://github.com//genealogy
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: ! '[none]'
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Organise ActiveRecord models into a genealogical tree structure
+test_files: []