Module: Datoki

Defined in:
lib/datoki.rb

Defined Under Namespace

Modules: Def_Field

Constant Summary collapse

UTC_NOW_DATE = 
::Sequel.lit("CURRENT_DATE")
UTC_NOW_RAW = 
"timezone('UTC'::text, now())"
UTC_NOW = 
::Sequel.lit("timezone('UTC'::text, now())")
Invalid = 
Class.new RuntimeError
Schema_Conflict = 
Class.new RuntimeError
Actions = 
[:all, :create, :read, :update, :update_or_create, :trash, :delete]
Char_Types = 
[:varchar, :text, :string_ish]
Numeric_Types = 
[:smallint, :integer, :bigint, :decimal, :numeric]
Types = 
Char_Types + Numeric_Types + [:datetime]
Key_Not_Found = 
lambda { |hash, key|
  fail ArgumentError, "Key not found: #{key.inspect}"
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#error ⇒ Object (readonly)

Instance Methods ===============


506
507
508
 
# File 'lib/datoki.rb', line 506

def error
  @error
end

#raw ⇒ Object (readonly)

Instance Methods ===============


506
507
508
 
# File 'lib/datoki.rb', line 506

def raw
  @raw
end

Class Method Details

.db(db = :return) ⇒ Object 



29
30
31
32
33
 
# File 'lib/datoki.rb', line 29

def db db = :return
  return @db if db == :return
  @db = db
  @tables = @db.tables
end

.db_type_to_ruby(type, alt = nil) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/datoki.rb', line 35

def db_type_to_ruby type, alt = nil
  if Datoki::Types.include?( type.to_sym )
    type.to_sym
  elsif type['character varying']
    :varchar
  elsif Datoki::Types.include?(alt)
    alt
  else
    fail("Unknown db type: #{type.inspect}")
  end
end

.included(klass) ⇒ Object 



24
25
26
27
 
# File 'lib/datoki.rb', line 24

def included klass
  klass.extend Def_Field
  klass.initialize_def_field
end

Instance Method Details

#clean(*args) ⇒ Object 



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/datoki.rb', line 617

def clean *args
  @clean ||= {}

  return @clean if args.empty?

  # === Handle required fields:
  # Example:
  #   :name!, :age!
  if args.size > 1
    return args.each { |f| clean f }
  end

  name = args.first

  if (real_name = self.class.fields_as_required[name])
    return(clean! real_name) 
  end

  @clean[name] = @raw[name] if !clean.has_key?(name) && @raw.has_key?(name)

  # === Skip cleaning if key is not set:
  return nil unless @clean.has_key?(name)

  field_name(name)
  f_meta = self.class.fields[name]

  # === Strip the value:
  if clean[name].is_a?(String) && field[:allow][:strip]
    clean[name].strip!
  end

  if field?(:chars) && !field.has_key?(:min) && clean[name].is_a?(String) && field[:allow][:null]
    clean[name] = nil
  end

  if field?(:numeric) && clean[name].is_a?(String)
    clean_val = Integer(clean[name]) rescue String
    if clean_val == String
      fail! :wrong_type, "{{English name}} must be numeric."
    else
      clean[name] = clean_val
    end
  end

  if field?(:text) && clean[name].is_a?(String) && clean[name].empty? && field[:min].to_i > 0
    fail! :required, "{{English name}} is required."
  end
  # ================================

  # === check min, max ======
  if clean[name].is_a?(String) || clean[name].is_a?(Numeric)
    case [field[:min], field[:max]].map(&:class)

    when [NilClass, NilClass]
      # do nothing

    when [NilClass, Fixnum]
      case
      when clean[name].is_a?(String) && clean[name].size > field[:max]
        fail! :big, "{{English name}} can't be longer than {{max}} characters."
      when clean[name].is_a?(Numeric) && clean[name] > field[:max]
        fail! :big, "{{English name}} can't be higher than {{max}}."
      end

    when [Fixnum, NilClass]
      case
      when clean[name].is_a?(String) && clean[name].size < field[:min]
        fail! :short, "{{English name}} can't be shorter than {{min}} characters."
      when clean[name].is_a?(Numeric) && clean[name] < field[:min]
        fail! :short, "{{English name}} can't be less than {{min}."
      end

    when [Fixnum, Fixnum]
      case
      when field?(:chars) && clean[name].size > field[:max]
        fail! :big, "{{English name}} must be between {{min}} and {{max}} characters."
      when field?(:chars) && clean[name].size < field[:min]
        fail! :small, "{{English name}} must be between {{min}} and {{max}} characters."

      when field?(:numeric) && clean[name] > field[:max]
        fail! :big, "{{English name}} must be between {{min}} and {{max}}."
      when field?(:numeric) && clean[name] < field[:min]
        fail! :small, "{{English name}} must be between {{min}} and {{max}}."
      end

    else
      fail "Unknown values for :min, :max: #{field[:min].inspect}, #{field[:max].inspect}"
    end
  end # === if
  # ================================

  # === to_i if necessary ==========
  if field?(:numeric)
    if clean[name].nil? && !field[:allow][:null]
      clean[name] = clean[name].to_i
    end
  end
  # ================================

  # === :strip if necessary ========
  if field?(:chars) && field[:allow][:strip] && clean[name].is_a?(String)
    clean[name] = clean[name].strip
  end
  # ================================

  # === Is value in options? =======
  if field[:options]
    if !field[:options].include?(clean[name])
      fail! :mis_match, "{{English name}} can only be: #{field[:options].map(&:inspect).join ', '}"
    end
  end
  # ================================

  field[:cleaners].each { |cleaner, args|
    next if args === false # === cleaner has been disabled.

      case cleaner

      when :type
        case
        when field?(:numeric) && !clean[name].is_a?(Integer)
          fail! :wrong_type, "{{English name}} needs to be an integer."
        when field?(:chars) && !clean[name].is_a?(String)
          fail! :wrong_type, "{{English name}} needs to be a String."
        end

      when :exact_size
        if clean[name].size != field[:exact_size]
          case
          when field?(:chars) || clean[name].is_a?(String)
            fail! :mis_match, "{{English name}} needs to be {{exact_size}} in length."
          else
            fail! :mis_match, "{{English name}} can only be {{exact_size}} in size."
          end
        end

      when :set_to
        args.each { |meth|
          clean[name] = (meth.is_a?(Symbol) ? send(meth) : meth.call(self, clean[name]))
        }

      when :equal_to
        args.each { |pair|
          meth, msg, other = pair
          target = send(meth)
          fail!(msg || "{{English name}} must be equal to: #{target.inspect}") unless clean[name] == target
        }

      when :included_in
        arr, msg, other = args
        fail!(msg || "{{English name}} must be one of these: #{arr.join ', '}") unless arr.include?(clean[name])

      when :upcase
        clean[name] = clean[name].upcase

      when :match
        args.each { |regex|
          case regex
          when Regexp
            if clean[name] !~ regex
              fail!(:mis_match, "{{English name}} is invalid.")
            end

          when Proc
            if !regex.call(self, clean[name])
              fail!(:mis_match, "{{English name}} is invalid.")
            end

          else
            fail ArgumentError, "Unknown matcher: #{regex.inspect}"
          end
        }

      else
        fail "Cleaner not implemented: #{cleaner.inspect}"
      end # === case cleaner
  } # === field[:cleaners].each
end

#clean!(*args) ⇒ Object 



607
608
609
610
611
612
613
614
615
 
# File 'lib/datoki.rb', line 607

def clean! *args
  args.each { |name|
    if @raw[name].nil? && (!@clean || @clean[name].nil?)
      fail ArgumentError, "#{name.inspect} is not set."
    else
      clean name
    end
  }
end

#create? ⇒ Boolean

Returns:

  • (Boolean) 


875
876
877
 
# File 'lib/datoki.rb', line 875

def create?
  !!(@raw.has_key?(:create) && @raw[:create])
end

#data ⇒ Object 



587
588
589
590
 
# File 'lib/datoki.rb', line 587

def data
  fail "Data not set." unless @data
  @data
end

#db_clean ⇒ Object 



600
601
602
603
604
605
 
# File 'lib/datoki.rb', line 600

def db_clean
  @clean.select { |k, v|
    meta = self.class.fields[k]
    !meta || !meta[:pseudo]
  }
end

#db_insert ⇒ Object 



899
900
901
902
903
904
905
906
907
 
# File 'lib/datoki.rb', line 899

def db_insert
  k = :db_insert
  fail "Already inserted." if @db_ops[k]

  final = db_clean
  new_data = TABLE().returning(*returning_fields).insert(final).first
  @data = (@data || {}).merge(new_data)
  @db_ops[k] = true
end

#db_update ⇒ Object 



909
910
911
912
913
914
915
916
917
918
919
920
921
922
 
# File 'lib/datoki.rb', line 909

def db_update
  k = :db_update
  fail "Already updated" if @db_ops[k]

  final = db_clean
  new_data = TABLE().
    returning(*returning_fields).
    where(primary_key[:name] => final.delete(primary_key[:name])).
    update(final).
    first

  @data = (@data || {}).merge(new_data)
  @db_ops[:db_update]  = true
end

#delete? ⇒ Boolean

Returns:

  • (Boolean) 


887
888
889
 
# File 'lib/datoki.rb', line 887

def delete?
  !!(@raw.has_key?(:delete) && !@raw[:delete])
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 


596
597
598
 
# File 'lib/datoki.rb', line 596

def error?
  @error && !@error.empty?
end

#error_msg(type) ⇒ Object

def clean



796
797
798
 
# File 'lib/datoki.rb', line 796

def error_msg type
  field[:error_msgs] && field[:error_msgs][type]
end

#fail!(*args) ⇒ Object 



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/datoki.rb', line 800

def fail! *args
  case args.size
  when 1
    msg = args.shift
  when 2
    msg = error_msg(args.shift) || args.shift
  else
    fail ArgumentError, "Unknown args: #{args.inspect}"
  end

  err_msg = msg.gsub(/\{\{([a-z\_\-\ ]+)\}\}/i) { |raw|
    name = $1
    case name
    when "English name"
      self.class.fields[field_name][:english_name].capitalize.gsub('_', ' ')
    when "ENGLISH NAME"
      self.class.fields[field_name][:english_name].upcase.gsub('_', ' ')
    when "max", "min", "exact_size"
      self.class.fields[field_name][name.downcase.to_sym]
    when "val"
      clean[field_name]
    else
      fail "Unknown value: #{name}"
    end
  }

  @error = {:field_name=>field_name, :msg=>err_msg, :value=>clean[field_name]}
  throw :invalid, self
end

#field(*args) ⇒ Object 



843
844
845
846
847
848
849
850
851
852
 
# File 'lib/datoki.rb', line 843

def field *args
  case args.size
  when 0
    self.class.fields[field_name]
  when 1
    self.class.fields[args.first]
  else
    fail "Unknown args: #{args.inspect}"
  end
end

#field?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


854
855
856
 
# File 'lib/datoki.rb', line 854

def field? *args
  self.class.inspect_field? :type, field_name, *args
end

#field_name(*args) ⇒ Object 



830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/datoki.rb', line 830

def field_name *args
  case args.size
  when 0
    fail "Field name not set." unless @field_name
    @field_name
  when 1
    fail ArgumentError, "Unknown field: #{args.first.inspect}" unless self.class.fields[args.first]
    @field_name = args.first
  else
    fail "Unknown args: #{args.inspect}"
  end
end

#id ⇒ Object 



858
859
860
861
862
863
 
# File 'lib/datoki.rb', line 858

def id
  d = data
  pk = primary_key[:name]
  fail "No primary key set yet." unless d.has_key?(pk)
  d[pk]
end

#initialize(unknown = nil) ⇒ Object 



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/datoki.rb', line 507

def initialize unknown = nil
  @data       = nil
  @field_name = nil
  @clean      = nil
  @error      = nil
  @skips      = {}
  @db_ops     = {} # Ex: :db_insert=>true, :db_update=>true

  if unknown
    is_record = unknown.keys.all? { |f|
      self.class.fields.has_key?(f) ||
        (self.class.schema && self.class.schema.has_key?(f)) 
    }

    if is_record
      @data = unknown
      @data.default_proc = Key_Not_Found
    else
      @raw = unknown
    end

  end

  if @raw

    schema = self.class.schema

    case
    when create?
      create
    when update?
      clean primary_key[:name]
      update
    when delete?
      delete
    end

    if @clean
      @clean.each { |k, v|
        # === Delete nil value if schema has a default value:
        @clean.delete(k) if @clean[k].nil? && schema[k] && schema[k][:default]
      }
    end

    fail "No clean values found." if (!@clean || @clean.empty?)

    if !@skips[:db] && !self.class.schema.empty?

      begin
        case

        when create?
          db_insert

        when update?
          db_update

        when delete?
          final = db_clean
          DB[self.class.table].
            where(primary_key[:name] => final.delete(primary_key[:name])).
            delete

        end

      rescue Sequel::UniqueConstraintViolation => e

        self.class.fields.each { |f, meta|
          if meta[:unique_index] && e.message[%^unique constraint "#{meta[:unique_index]}"^]
            field_name f
            fail! :unique, "{{English name}} already taken: #{meta[:name]}"
          end
        }
        raise e

      end # === begin/rescue
    end # === if !@skips[:db]
  end # === if @raw
end

#new? ⇒ Boolean

Returns:

  • (Boolean) 


871
872
873
 
# File 'lib/datoki.rb', line 871

def new?
  !@data
end

#primary_key ⇒ Object 



865
866
867
868
869
 
# File 'lib/datoki.rb', line 865

def primary_key
  name, meta = self.class.fields.detect { |k, v| v[:primary_key] }
  fail "Primary key not found." unless meta
  meta
end

#read? ⇒ Boolean

Returns:

  • (Boolean) 


879
880
881
 
# File 'lib/datoki.rb', line 879

def read?
  !!(@raw.has_key?(:read) && @raw[:read])
end

#returning_fields ⇒ Object 



895
896
897
 
# File 'lib/datoki.rb', line 895

def returning_fields
  self.class.returning_fields
end

#skip(name) ⇒ Object 



592
593
594
 
# File 'lib/datoki.rb', line 592

def skip name
  @skips[name] = true
end

#TABLE ⇒ Object 



891
892
893
 
# File 'lib/datoki.rb', line 891

def TABLE
  self.class::TABLE
end

#update? ⇒ Boolean

Returns:

  • (Boolean) 


883
884
885
 
# File 'lib/datoki.rb', line 883

def update?
  !!(@raw.has_key?(:update) && @raw[:update])
end