Class: SimpleRecord::Base

Inherits:
ActiveSdb::Base show all
Extended by:
ActiveModel::Callbacks, ActiveModel::Naming, Attributes::ClassMethods, Logging::ClassMethods, Sharding::ClassMethods, Validations::ClassMethods
Includes:
ActiveModel::Conversion, ActiveModel::Validations, ActiveModel::Validations::Callbacks, Attributes, Callbacks, Callbacks3, Json, Logging, Sharding, Translations, Validations
Defined in:
lib/simple_record.rb

Constant Summary collapse

@@active_model = 
false
@@cache_store = 
nil
@@regex_no_id = 
/.*Couldn't find.*with ID.*/
@@debug = 
""

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes inherited from ActiveSdb::Base

#attributes, #id

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Validations::ClassMethods

uniques, validates_uniqueness_of

Methods included from Attributes::ClassMethods

are_booleans, are_dates, are_floats, are_ints, belongs_to, define_dirty_methods, defined_attributes, get_sr_config, has_attributes, has_attributes2, has_booleans, has_clobs, has_dates, has_floats, has_ints, has_many, has_strings, has_virtuals, sr_config, virtuals

Methods included from Sharding::ClassMethods

find_sharded, is_sharded?, prefix_shard_name, shard, sharded_domains, sharding_options, shards

Methods included from Logging::ClassMethods

usage_line, write_usage

Methods included from Json

#as_json, included

Methods included from Sharding

included, #sharded_domain

Methods included from Attributes

#get_attribute, #get_attribute_sdb, #handle_virtuals, included, #set, #set_attribute_sdb

Methods included from Translations

#convert_dates_to_sdb, decrypt, encrypt, from_float, pad_and_offset, #pad_and_offset_ints_to_sdb, pass_hash, pass_hash_check, #ruby_to_sdb, #ruby_to_string_val, #sdb_to_ruby, #string_val_to_ruby, #to_bool, #to_date, un_offset_int, #unpad, #unpad_self, #wrap_if_required

Methods included from Validations

included, #invalid?, #read_attribute_for_validation, #valid?, #validate, #validate_on_create, #validate_on_update, #validate_uniques

Methods included from Callbacks

#after_destroy, #before_destroy, included, setup_callbacks

Methods inherited from ActiveSdb::Base

#apres_save2, #connection, connection, create_domain, #delete_attributes, delete_domain, #delete_values, find_with_metadata, generate_id, #mark_as_old, #pre_save2, #put, #put_attributes, #reload_attributes, #save2, #save_attributes

Methods included from ActiveSdb::ActiveSdbConnect

#close_connection, #connection, #establish_connection

Constructor Details

#initialize(attrs = {}) ⇒ Base

Returns a new instance of Base.



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/simple_record.rb', line 223

def initialize(attrs={})
  # todo: Need to deal with objects passed in. iterate through belongs_to perhaps and if in attrs, set the objects id rather than the object itself

  initialize_base(attrs)

    # Convert attributes to sdb values
  attrs.each_pair do |name, value|
    set(name, value, true)
  end
end

Class Attribute Details

.domain_prefix ⇒ Object

Returns the value of attribute domain_prefix.



286
287
288
 
# File 'lib/simple_record.rb', line 286

def domain_prefix
  @domain_prefix
end

Instance Attribute Details

#errors ⇒ Object

Returns the value of attribute errors.



203
204
205
 
# File 'lib/simple_record.rb', line 203

def errors
  @errors
end

Class Method Details

.all(*args) ⇒ Object 



1013
1014
1015
 
# File 'lib/simple_record.rb', line 1013

def self.all(*args)
  find(:all, *args)
end

.batch_delete(objects, options = {}) ⇒ Object

Pass in an array of objects



804
805
806
807
808
809
810
 
# File 'lib/simple_record.rb', line 804

def self.batch_delete(objects, options={})
  if objects
    objects.each_slice(25) do |objs|
      connection.batch_delete_attributes @domain, objs.collect { |x| x.id }
    end
  end
end

.batch_save(objects, options = {}) ⇒ Object

Run pre_save on each object, then runs batch_put_attributes Returns



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/simple_record.rb', line 779

def self.batch_save(objects, options={})
  options[:create_domain] = true if options[:create_domain].nil?
  results = []
  to_save = []
  if objects && objects.size > 0
    objects.each_slice(25) do |objs|
      objs.each do |o|
        ok = o.pre_save(options)
        raise "Pre save failed on object [" + o.inspect + "]" if !ok
        results << ok
        next if !ok # todo: this shouldn't be here should it?  raises above
        o.pre_save2
        to_save << Aws::SdbInterface::Item.new(o.id, o.attributes, true)
      end
      connection.batch_put_attributes(domain, to_save, options)
      to_save.clear
    end
  end
  objects.each do |o|
    o.save_lobs(nil)
  end
  results
end

.cache_key(class_name, id) ⇒ Object 



1077
1078
1079
 
# File 'lib/simple_record.rb', line 1077

def self.cache_key(class_name, id)
  return class_name + "/" + id.to_s
end

.cache_results(results) ⇒ Object 



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'lib/simple_record.rb', line 1056

def self.cache_results(results)
  if !cache_store.nil? && !results.nil?
    if results.is_a?(Array)
      # todo: cache each result
      results.each do |item|
        class_name = item.class.name
        id = item.id
        cache_key = self.cache_key(class_name, id)
          #puts 'caching result at ' + cache_key + ': ' + results.inspect
        cache_store.write(cache_key, item, :expires_in =>30)
      end
    else
      class_name = results.class.name
      id = results.id
      cache_key = self.cache_key(class_name, id)
        #puts 'caching result at ' + cache_key + ': ' + results.inspect
      cache_store.write(cache_key, results, :expires_in =>30)
    end
  end
end

.cache_store ⇒ Object 



297
298
299
 
# File 'lib/simple_record.rb', line 297

def self.cache_store
  return @@cache_store
end

.cache_store=(cache) ⇒ Object

Set the cache to use



293
294
295
 
# File 'lib/simple_record.rb', line 293

def self.cache_store=(cache)
  @@cache_store = cache
end

.convert_condition_params(options) ⇒ Object 



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/simple_record.rb', line 1043

def self.convert_condition_params(options)
  return if options.nil?
  conditions = options[:conditions]
  return if conditions.nil?
  if conditions.size > 1
    # all after first are values
    conditions.collect! { |x|
      Translations.pad_and_offset(x)
    }
  end

end

.count(*args) ⇒ Object 



1021
1022
1023
 
# File 'lib/simple_record.rb', line 1021

def self.count(*args)
  find(:count, *args)
end

.create(attributes = {}) ⇒ Object 



554
555
556
557
 
# File 'lib/simple_record.rb', line 554

def self.create(attributes={})
#            puts "About to create in domain #{domain}"
  super
end

.create!(attributes = {}) ⇒ Object 



559
560
561
562
563
 
# File 'lib/simple_record.rb', line 559

def self.create!(attributes={})
  item = self.new(attributes)
  item.save!
  item
end

.debug ⇒ Object 



1083
1084
1085
 
# File 'lib/simple_record.rb', line 1083

def self.debug
  @@debug
end

.delete(id) ⇒ Object

Usage: ClassName.delete id



815
816
817
818
 
# File 'lib/simple_record.rb', line 815

def self.delete(id)
  connection.delete_attributes(domain, id)
  @deleted = true
end

.delete_all(options = {}) ⇒ Object

Pass in the same OPTIONS you’d pass into a find(:all, OPTIONS)



821
822
823
824
825
826
827
828
829
830
 
# File 'lib/simple_record.rb', line 821

def self.delete_all(options={})
  # could make this quicker by just getting item_names and deleting attributes rather than creating objects
  obs = self.find(:all, options)
  i = 0
  obs.each do |a|
    a.delete
    i+=1
  end
  return i
end

.destroy_all(options = {}) ⇒ Object

Pass in the same OPTIONS you’d pass into a find(:all, OPTIONS)



833
834
835
836
837
838
839
840
841
 
# File 'lib/simple_record.rb', line 833

def self.destroy_all(options={})
  obs = self.find(:all, options)
  i = 0
  obs.each do |a|
    a.destroy
    i+=1
  end
  return i
end

.domain ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/simple_record.rb', line 322

def self.domain
  unless @domain
    # This strips off the module if there is one.
    n2 = name.split('::').last || name
#                puts 'n2=' + n2
    if n2.respond_to?(:tableize)
      @domain = n2.tableize
    else
      @domain = n2.downcase
    end
    set_domain_name @domain
  end
  domain_name_for_class = (SimpleRecord::Base.domain_prefix || "") + @domain.to_s
  domain_name_for_class
end

.extended(base) ⇒ Object 



219
220
221
 
# File 'lib/simple_record.rb', line 219

def self.extended(base)

end

.find(*params) ⇒ Object

Usage: Find by ID:

MyModel.find(ID)

Query example:

MyModel.find(:all, :conditions=>["name = ?", name], :order=>"created desc", :limit=>10)

Extra options:

:per_token => the number of results to return per next_token, max is 2500.
:consistent_read => true/false  --  as per http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3572
:retries => maximum number of times to retry this query on an error response.
:shard => shard name or array of shard names to use on this query.



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/simple_record.rb', line 929

def self.find(*params)
  #puts 'params=' + params.inspect

  q_type = :all
  select_attributes=[]
  if params.size > 0
    q_type = params[0]
  end
  options = {}
  if params.size > 1
    options = params[1]
  end
  conditions = options[:conditions]
  if conditions && conditions.is_a?(String)
    conditions = [conditions]
    options[:conditions] = conditions
  end

  if !options[:shard_find] && is_sharded?
    # then break off and get results across all shards
    return find_sharded(*params)
  end

    # Pad and Offset number attributes
  params_dup = params.dup
  if params.size > 1
    options = params[1]
      #puts 'options=' + options.inspect
      #puts 'after collect=' + options.inspect
    convert_condition_params(options)
    per_token = options[:per_token]
    consistent_read = options[:consistent_read]
    if per_token || consistent_read then
      op_dup = options.dup
      op_dup[:limit] = per_token # simpledb uses Limit as a paging thing, not what is normal
      op_dup[:consistent_read] = consistent_read
      params_dup[1] = op_dup
    end
  end
    #            puts 'params2=' + params.inspect

  ret = q_type == :all ? [] : nil
  begin
    results=find_with_metadata(*params_dup)
    #puts "RESULT=" + results.inspect
    write_usage(:select, domain, q_type, options, results)
      #puts 'params3=' + params.inspect
    SimpleRecord.stats.selects += 1
    if q_type == :count
      ret = results[:count]
    elsif q_type == :first
      ret = results[:items].first
        # todo: we should store request_id and box_usage with the object maybe?
      cache_results(ret)
    elsif results[:single_only]
      ret = results[:single]
      #puts 'results[:single] ' + ret.inspect
      cache_results(ret)
    else
      #puts 'last step items = ' + results.inspect
      if results[:items] #.is_a?(Array)
        cache_results(results[:items])
        ret = SimpleRecord::ResultsArray.new(self, params, results, next_token)
      end
    end
  rescue Aws::AwsError, SimpleRecord::ActiveSdb::ActiveSdbError => ex
    #puts "RESCUED: " + ex.message
    if (ex.message().index("NoSuchDomain") != nil)
      # this is ok
      #        elsif (ex.message() =~ @@regex_no_id) This is RecordNotFound now
      #          ret = nil
    else
      #puts 're-raising'
      raise ex
    end
  end
    #            puts 'single2=' + ret.inspect
  return ret
end

.first(*args) ⇒ Object 



1017
1018
1019
 
# File 'lib/simple_record.rb', line 1017

def self.first(*args)
  find(:first, *args)
end

.get_encryption_key ⇒ Object 



698
699
700
701
702
703
704
705
 
# File 'lib/simple_record.rb', line 698

def self.get_encryption_key()
  key = SimpleRecord.options[:encryption_key]
#            if key.nil?
#                puts 'WARNING: Encrypting attributes with your AWS Access Key. You should use your own :encryption_key so it doesn\'t change'
#                key = connection.aws_access_key_id # default to aws access key. NOT recommended in case you start using a new key
#            end
  return key
end

.inherited(base) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/simple_record.rb', line 258

def self.inherited(base)
#      puts 'SimpleRecord::Base is inherited by ' + base.inspect
  Callbacks.setup_callbacks(base)

#            base.has_strings :id
  base.has_dates :created, :updated
  base.before_create :set_created, :set_updated
  base.before_update :set_updated

end

.paginate(options = {}) ⇒ Object

This gets less and less efficient the higher the page since SimpleDB has no way to start at a specific row. So it will iterate from the first record and pull out the specific pages.



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/simple_record.rb', line 1027

def self.paginate(options={})
#            options = args.pop
#            puts 'paginate options=' + options.inspect if SimpleRecord.logging?
  page = options[:page] || 1
  per_page = options[:per_page] || 50
#            total    = options[:total_entries].to_i
  options[:page] = page.to_i # makes sure it's to_i
  options[:per_page] = per_page.to_i
  options[:limit] = options[:page] * options[:per_page]
#            puts 'paging options=' + options.inspect
  fr = find(:all, options)
  return fr

end

.quote_regexp(a, re) ⇒ Object 



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/simple_record.rb', line 894

def self.quote_regexp(a, re)
  a =~ re
    #was there a match?
  if $&
    before=$`
    middle=$&
    after =$'

    before =~ /'$/ #is there already a quote immediately before the match?
    unless $&
      return "#{before}'#{middle}'#{quote_regexp(after, re)}" #if not, put quotes around the match
    else
      return "#{before}#{middle}#{quote_regexp(after, re)}" #if so, assume it is quoted already and move on
    end
  else
    #no match, just return the string
    return a
  end
end

.sanitize_sql(*params) ⇒ Object 



1087
1088
1089
 
# File 'lib/simple_record.rb', line 1087

def self.sanitize_sql(*params)
  return ActiveRecord::Base.sanitize_sql(*params)
end

.select(*params) ⇒ Object 



1009
1010
1011
 
# File 'lib/simple_record.rb', line 1009

def self.select(*params)
  return find(*params)
end

.set_domain_name(table_name) ⇒ Object

Sets the domain name for this class



313
314
315
 
# File 'lib/simple_record.rb', line 313

def self.set_domain_name(table_name)
  super
end

.set_domain_prefix(prefix) ⇒ Object

If you want a domain prefix for all your models, set it here.



302
303
304
305
 
# File 'lib/simple_record.rb', line 302

def self.set_domain_prefix(prefix)
  #puts 'set_domain_prefix=' + prefix
  self.domain_prefix = prefix
end

.set_table_name(table_name) ⇒ Object

Same as set_table_name



308
309
310
 
# File 'lib/simple_record.rb', line 308

def self.set_table_name(table_name)
  set_domain_name table_name
end

.table_name ⇒ Object 



1091
1092
1093
 
# File 'lib/simple_record.rb', line 1091

def self.table_name
  return domain
end

Instance Method Details

#[](attribute) ⇒ Object 



403
404
405
 
# File 'lib/simple_record.rb', line 403

def [](attribute)
  super
end

#[]=(attribute, values) ⇒ Object 



398
399
400
401
 
# File 'lib/simple_record.rb', line 398

def []=(attribute, values)
  make_dirty(attribute, values)
  super
end

#after_save_cleanup ⇒ Object 



1110
1111
1112
 
# File 'lib/simple_record.rb', line 1110

def after_save_cleanup
  @dirty = {}
end

#cache_store ⇒ Object 



427
428
429
 
# File 'lib/simple_record.rb', line 427

def cache_store
  @@cache_store
end

#changed ⇒ Object 



1095
1096
1097
 
# File 'lib/simple_record.rb', line 1095

def changed
  return @dirty.keys
end

#changed? ⇒ Boolean

Returns:

  • (Boolean) 


1099
1100
1101
 
# File 'lib/simple_record.rb', line 1099

def changed?
  return @dirty.size > 0
end

#changes ⇒ Object 



1103
1104
1105
1106
1107
1108
 
# File 'lib/simple_record.rb', line 1103

def changes
  ret = {}
    #puts 'in CHANGES=' + @dirty.inspect
  @dirty.each_pair { |key, value| ret[key] = [value, get_attribute(key)] }
  return ret
end

#clear_errors ⇒ Object 



390
391
392
393
394
395
396
 
# File 'lib/simple_record.rb', line 390

def clear_errors
  if defined?(ActiveModel)
    @errors = ActiveModel::Errors.new(self)
  else
    @errors=SimpleRecord_errors.new
  end
end

#create(options) ⇒ Object

:nodoc:



521
522
523
524
525
526
527
528
529
530
 
# File 'lib/simple_record.rb', line 521

def create(options) #:nodoc:
  puts '3 create'
  ret = true
  run_callbacks :create do
    x = do_actual_save(options)
#        puts 'create old_save result=' + x.to_s
    ret = x
  end
  ret
end

#create_or_update(options) ⇒ Object

if @@active_model

  alias_method :old_save, :save

  def save(options={})
    puts 'extended save'
    x = create_or_update
    puts 'save x=' + x.to_s
    x
  end
end



510
511
512
513
514
515
516
517
518
519
 
# File 'lib/simple_record.rb', line 510

def create_or_update(options) #:nodoc:
                              #      puts 'create_or_update'
  ret = true
  run_callbacks :save do
    result = new_record? ? create(options) : update(options)
#        puts 'save_callbacks result=' + result.inspect
    ret = result
  end
  ret
end

#created_at ⇒ Object

an aliased method since many people use created_at/updated_at naming convention



417
418
419
 
# File 'lib/simple_record.rb', line 417

def created_at
  self.created
end

#defined_attributes_local ⇒ Object 



278
279
280
281
282
 
# File 'lib/simple_record.rb', line 278

def defined_attributes_local
  # todo: store this somewhere so it doesn't keep going through this
  ret = self.class.defined_attributes
  ret.merge!(self.class.superclass.defined_attributes) if self.class.superclass.respond_to?(:defined_attributes)
end

#delete(options = {}) ⇒ Object 



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

def delete(options={})
  if self.class.is_sharded?
    options[:domain] = sharded_domain
  end
  super(options)

    # delete lobs now too
  delete_lobs
end

#delete_lobs ⇒ Object 



621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/simple_record.rb', line 621

def delete_lobs
  defined_attributes_local.each_pair do |k, v|
    if v.type == :clob
      if self.class.get_sr_config[:single_clob]
        s3_bucket(false, :s3_bucket=>:new).delete_key(single_clob_id)
        SimpleRecord.stats.s3_deletes += 1
        return
      else
        s3_bucket.delete_key(s3_lob_id(k))
        SimpleRecord.stats.s3_deletes += 1
      end
    end
  end
end

#delete_niled(to_delete) ⇒ Object 



863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/simple_record.rb', line 863

def delete_niled(to_delete)
#            puts 'to_delete=' + to_delete.inspect
  if to_delete.size > 0
#      puts 'Deleting attributes=' + to_delete.inspect
    SimpleRecord.stats.deletes += 1
    delete_attributes to_delete
    to_delete.each do |att|
      att_meta = get_att_meta(att)
      if att_meta.type == :clob
        s3_bucket.key(s3_lob_id(att)).delete
      end
    end
  end
end

#destroy ⇒ Object 



853
854
855
856
857
858
859
860
861
 
# File 'lib/simple_record.rb', line 853

def destroy
  if @@active_model
    run_callbacks :destroy do
      delete
    end
  else
    return run_before_destroy && delete && run_after_destroy
  end
end

#destroyed? ⇒ Boolean

Returns:

  • (Boolean) 


274
275
276
 
# File 'lib/simple_record.rb', line 274

def destroyed?
  @deleted
end

#do_actual_save(options) ⇒ Object 



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/simple_record.rb', line 476

def do_actual_save(options)
  begin
    is_create = new_record? # self[:id].nil?

    dirty = @dirty
                            #                    puts 'dirty before=' + @dirty.inspect
    if options[:dirty]
#                        puts '@dirty=' + @dirty.inspect
      return true if @dirty.size == 0 # This should probably never happen because after pre_save, created/updated dates are changed
      options[:dirty_atts] = @dirty
    end
    to_delete = get_atts_to_delete

    if self.class.is_sharded?
      options[:domain] = sharded_domain
    end
    return save_super(dirty, is_create, options, to_delete)
  rescue Aws::AwsError => ex
    raise ex
  end

end

#domain ⇒ Object 



318
319
320
 
# File 'lib/simple_record.rb', line 318

def domain
  self.class.domain
end

#domain_ok(ex, options = {}) ⇒ Object 



431
432
433
434
435
436
437
438
 
# File 'lib/simple_record.rb', line 431

def domain_ok(ex, options={})
  if (ex.message().index("NoSuchDomain") != nil)
    dom = options[:domain] || domain
    self.class.create_domain(dom)
    return true
  end
  return false
end

#get_att_meta(name) ⇒ Object 



343
344
345
346
347
348
349
350
 
# File 'lib/simple_record.rb', line 343

def get_att_meta(name)
  name_s = name.to_s
  att_meta = defined_attributes_local[name.to_sym]
  if att_meta.nil? && has_id_on_end(name_s)
    att_meta = defined_attributes_local[name_s[0..-4].to_sym]
  end
  return att_meta
end

#get_atts_to_delete ⇒ Object 



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/simple_record.rb', line 759

def get_atts_to_delete
  to_delete = []
  changes.each_pair do |key, v|
    if v[1].nil?
      to_delete << key
      @attributes.delete(key)
    end
  end
#            @attributes.each do |key, value|
##                puts 'key=' + key.inspect + ' value=' + value.inspect
#                if value.nil? || (value.is_a?(Array) && value.size == 0) || (value.is_a?(Array) && value.size == 1 && value[0] == nil)
#                    to_delete << key
#                    @attributes.delete(key)
#                end
#            end
  return to_delete
end

#has_id_on_end(name_s) ⇒ Object 



338
339
340
341
 
# File 'lib/simple_record.rb', line 338

def has_id_on_end(name_s)
  name_s = name_s.to_s
  name_s.length > 3 && name_s[-3..-1] == "_id"
end

#hash ⇒ Object 



1114
1115
1116
1117
 
# File 'lib/simple_record.rb', line 1114

def hash
  # same as ActiveRecord
  id.hash
end

#initialize_base(attrs = {}) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/simple_record.rb', line 234

def initialize_base(attrs={})

  #we have to handle the virtuals.
  handle_virtuals(attrs)

  clear_errors

  @dirty = {}

  @attributes = {} # sdb values
  @attributes_rb = {} # ruby values
  @lobs = {}
  @new_record = true

end

#initialize_from_db(attrs = {}) ⇒ Object 



250
251
252
253
254
255
 
# File 'lib/simple_record.rb', line 250

def initialize_from_db(attrs={})
  initialize_base(attrs)
  attrs.each_pair do |k, v|
    @attributes[k.to_s] = v
  end
end

#is_dirty?(name) ⇒ Boolean

Returns:

  • (Boolean) 


651
652
653
654
655
656
 
# File 'lib/simple_record.rb', line 651

def is_dirty?(name)
  # todo: should change all the dirty stuff to symbols?
  #            puts '@dirty=' + @dirty.inspect
  #            puts 'name=' +name.to_s
  @dirty.include? name.to_s
end

#make_dirty(arg, value) ⇒ Object 



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/simple_record.rb', line 374

def make_dirty(arg, value)
  sdb_att_name = sdb_att_name(arg)
  arg = arg.to_s

#            puts "Marking #{arg} dirty with #{value}" if SimpleRecord.logging?
  if @dirty.include?(sdb_att_name)
    old = @dirty[sdb_att_name]
#                puts "#{sdb_att_name} was already dirty #{old}"
    @dirty.delete(sdb_att_name) if value == old
  else
    old = get_attribute(arg)
#                puts "dirtifying #{sdb_att_name} old=#{old.inspect} to new=#{value.inspect}" if SimpleRecord.logging?
    @dirty[sdb_att_name] = old if value != old
  end
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


441
442
443
444
 
# File 'lib/simple_record.rb', line 441

def new_record?
  # todo: new_record in activesdb should align with how we're defining a new record here, ie: if id is nil
  super
end

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


270
271
272
 
# File 'lib/simple_record.rb', line 270

def persisted?
  !@new_record && !destroyed?
end

#pre_save(options) ⇒ Object 



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
 
# File 'lib/simple_record.rb', line 707

def pre_save(options)

#      puts '@@active_model ? ' + @@active_model.inspect

  ok = true
  is_create = self[:id].nil?
  unless @@active_model
    ok = run_before_validation && (is_create ? run_before_validation_on_create : run_before_validation_on_update)
    return false unless ok
  end

#      validate()
#      is_create ? validate_on_create : validate_on_update
  if !valid?
    puts 'not valid'
    return false
  end
#
##      puts 'AFTER VALIDATIONS, ERRORS=' + errors.inspect
#      if (!errors.nil? && errors.size > 0)
##        puts 'THERE ARE ERRORS, returning false'
#        return false
#      end

  unless @@active_model
    ok = run_after_validation && (is_create ? run_after_validation_on_create : run_after_validation_on_update)
    return false unless ok
  end

    # Now for callbacks
  unless @@active_model
    ok = respond_to?(:before_save) ? before_save : true
    if ok
#          puts 'ok'
      if is_create && respond_to?(:before_create)
#            puts 'responsds to before_create'
        ok = before_create
      elsif !is_create && respond_to?(:before_update)
        ok = before_update
      end
    end
    if ok
      ok = run_before_save && (is_create ? run_before_create : run_before_update)
    end
  else

  end
  prepare_for_update
  ok
end

#put_lob(k, val, options = {}) ⇒ Object 



637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/simple_record.rb', line 637

def put_lob(k, val, options={})
  begin
    s3_bucket(false, options).put(k, val)
  rescue Aws::AwsError => ex
    if ex.include? /NoSuchBucket/
      s3_bucket(true, options).put(k, val)
    else
      raise ex
    end
  end
  SimpleRecord.stats.s3_puts += 1
end

#reload ⇒ Object 



878
879
880
 
# File 'lib/simple_record.rb', line 878

def reload
  super()
end

#s3 ⇒ Object 



658
659
660
661
662
663
664
 
# File 'lib/simple_record.rb', line 658

def s3

  return SimpleRecord.s3 if SimpleRecord.s3
    # todo: should optimize this somehow, like use the same connection_mode as used in SR
    # or keep open while looping in ResultsArray.
  Aws::S3.new(SimpleRecord.aws_access_key, SimpleRecord.aws_secret_key)
end

#s3_bucket(create = false, options = {}) ⇒ Object

options:

:s3_bucket => :old/:new/"#{any_bucket_name}". :new if want to use new bucket. Defaults to :old for backwards compatability.



668
669
670
 
# File 'lib/simple_record.rb', line 668

def s3_bucket(create=false, options={})
  s3.bucket(s3_bucket_name(options[:s3_bucket]), create)
end

#s3_bucket_name(s3_bucket_option = :old) ⇒ Object 



672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/simple_record.rb', line 672

def s3_bucket_name(s3_bucket_option=:old)
  if s3_bucket_option == :new || SimpleRecord.options[:s3_bucket] == :new
    # this is the bucket that will be used going forward for anything related to s3
    ret = "simple_record_#{SimpleRecord.aws_access_key}"
  elsif !SimpleRecord.options[:s3_bucket].nil? && SimpleRecord.options[:s3_bucket] != :old
    ret = SimpleRecord.options[:s3_bucket]
  else
    ret = SimpleRecord.aws_access_key + "_lobs"
  end
  ret
end

#s3_lob_id(name) ⇒ Object 



684
685
686
687
688
689
690
691
 
# File 'lib/simple_record.rb', line 684

def s3_lob_id(name)
  # if s3_bucket is not nil and not :old, then we use the new key.
  if !SimpleRecord.options[:s3_bucket].nil? && SimpleRecord.options[:s3_bucket] != :old
    "lobs/#{self.id}_#{name}"
  else
    self.id + "_" + name.to_s
  end
end

#save(options = {}) ⇒ Object

Options:

- :except => Array of attributes to NOT save
- :dirty => true - Will only store attributes that were modified. To make it save regardless and have it update the :updated value, include this and set it to false.
- :domain => Explicitly define domain to use.



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/simple_record.rb', line 455

def save(options={})
  puts 'SAVING: ' + self.inspect if SimpleRecord.logging?
    # todo: Clean out undefined values in @attributes (in case someone set the attributes hash with values that they hadn't defined)
  clear_errors
    # todo: decide whether this should go before pre_save or after pre_save? pre_save dirties "updated" and perhaps other items due to callbacks
  if options[:dirty]
#                puts '@dirtyA=' + @dirty.inspect
    return true if @dirty.size == 0 # Nothing to save so skip it
  end

  ok = pre_save(options) # Validates and sets ID
  if ok
    if @@active_model
      ok = create_or_update(options)
    else
      ok = do_actual_save(options)
    end
  end
  return ok
end

#save!(options = {}) ⇒ Object 



545
546
547
 
# File 'lib/simple_record.rb', line 545

def save!(options={})
  save(options) || raise(RecordNotSaved.new(self))
end

#save_lobs(dirty = nil) ⇒ Object 



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/simple_record.rb', line 588

def save_lobs(dirty=nil)
#            puts 'dirty.inspect=' + dirty.inspect
  dirty = @dirty if dirty.nil?
  all_clobs = {}
  dirty_clobs = {}
  defined_attributes_local.each_pair do |k, v|
    # collect up the clobs in case it's a single put
    if v.type == :clob
      val = @lobs[k]
      all_clobs[k] = val
      if dirty.include?(k.to_s)
        dirty_clobs[k] = val
      else
#                        puts 'NOT DIRTY'
      end

    end
  end
  if dirty_clobs.size > 0
    if self.class.get_sr_config[:single_clob]
      # all clobs in one chunk
      # using json for now, could change later
      val = all_clobs.to_json
      puts 'val=' + val.inspect
      put_lob(single_clob_id, val, :s3_bucket=>:new)
    else
      dirty_clobs.each_pair do |k, val|
        put_lob(s3_lob_id(k), val)
      end
    end
  end
end

#save_super(dirty, is_create, options, to_delete) ⇒ Object 



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/simple_record.rb', line 566

def save_super(dirty, is_create, options, to_delete)
  SimpleRecord.stats.saves += 1
  if save2(options)
    self.class.cache_results(self)
    delete_niled(to_delete)
    save_lobs(dirty)
    after_save_cleanup
    unless @@active_model
      if (is_create ? run_after_create : run_after_update) && run_after_save
#                            puts 'all good?'
        return true
      else
        return false
      end
    end
    return true
  else
    return false
  end
end

#save_with_validation!(options = {}) ⇒ Object

this is a bit wonky, save! should call this, not sure why it’s here.



550
551
552
 
# File 'lib/simple_record.rb', line 550

def save_with_validation!(options={})
  save!
end

#sdb_att_name(name) ⇒ Object 



352
353
354
355
356
357
358
 
# File 'lib/simple_record.rb', line 352

def sdb_att_name(name)
  att_meta = get_att_meta(name)
  if att_meta.type == :belongs_to && !has_id_on_end(name.to_s)
    return "#{name}_id"
  end
  name.to_s
end

#set_created ⇒ Object 



408
409
410
 
# File 'lib/simple_record.rb', line 408

def set_created
  set(SimpleRecord.options[:created_col] || :created, Time.now)
end

#set_updated ⇒ Object 



412
413
414
 
# File 'lib/simple_record.rb', line 412

def set_updated
  set(SimpleRecord.options[:updated_col] || :updated, Time.now)
end

#single_clob_id ⇒ Object 



693
694
695
 
# File 'lib/simple_record.rb', line 693

def single_clob_id
  "lobs/#{self.id}_single_clob"
end

#strip_array(arg) ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/simple_record.rb', line 360

def strip_array(arg)
  if arg.is_a? Array
    if arg.length==1
      ret = arg[0]
    else
      ret = arg
    end
  else
    ret = arg
  end
  return ret
end

#update(options) ⇒ Object

:nodoc:



533
534
535
536
537
538
539
540
541
542
 
# File 'lib/simple_record.rb', line 533

def update(options) #:nodoc:
  puts '3 update'
  ret = true
  run_callbacks :update do
    x = do_actual_save(options)
#        puts 'update old_save result=' + x.to_s
    ret = x
  end
  ret
end

#update_attributes(atts) ⇒ Object 



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

def update_attributes(atts)
  set_attributes(atts)
  save
end

#update_attributes!(atts) ⇒ Object 



888
889
890
891
 
# File 'lib/simple_record.rb', line 888

def update_attributes!(atts)
  set_attributes(atts)
  save!
end

#updated_at ⇒ Object

an aliased method since many people use created_at/updated_at naming convention



422
423
424
 
# File 'lib/simple_record.rb', line 422

def updated_at
  self.updated
end