GitHub Sale: sign up for any paid plan this week and pay nothing until January 1, 2009!  [ hide ]

public
Rubygem
Description: DataMapper - Core
Homepage: http://datamapper.org
Clone URL: git://github.com/sam/dm-core.git
guyvdb (author)
Tue Apr 22 21:24:35 -0700 2008
commit  a90ceab95f70e08a5ed16c9795b4a8adf3735c60
tree    53e53f79f643dd9b466e6217bbcb28c56ab8cfea
parent  92470da3a1b03d83a4bb33c3e0bb3ea9e7f7baab
dm-core / lib / data_mapper / adapters / data_objects_adapter.rb
100644 543 lines (445 sloc) 19.869 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
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
require __DIR__ + 'abstract_adapter'
require __DIR__.parent + 'loaded_set'
 
begin
  require 'fastthread'
rescue LoadError
end
require 'data_objects'
 
module DataMapper
 
  module Resource
    
    module ClassMethods
      #
      # Find instances by manually providing SQL
      #
      # ==== Parameters
      # <String>:: An SQL query to execute
      # <Array>:: An Array containing a String (being the SQL query to execute) and the parameters to the query.
      # example: ["SELECT name FROM users WHERE id = ?", id]
      # <DataMapper::Query>:: A prepared Query to execute.
      # <Hash>:: An options hash.
      #
      # A String, Array or Query is required.
      #
      # ==== Options (the options hash)
      # :repository<Symbol>:: The name of the repository to execute the query in. Defaults to self.default_repository_name.
      # :reload<Boolean>:: Whether to reload any instances found that allready exist in the identity map. Defaults to false.
      # :properties<Array>:: The Properties of the instance that the query loads. Must contain DataMapper::Properties. Defaults to self.properties.
      #
      # ==== Returns
      # LoadedSet:: The instance matched by the query.
      #
      # ==== Example
      # MyClass.find_by_sql(["SELECT id FROM my_classes WHERE county = ?", selected_county], :properties => MyClass.property[:id], :repository => :county_repo)
      #
      # -
      # @public
      def find_by_sql(*args)
        sql = nil
        query = nil
        params = []
        properties = nil
        do_reload = false
        repository_name = default_repository_name
        args.each do |arg|
          if arg.is_a?(String)
            sql = arg
          elsif arg.is_a?(Array)
            sql = arg.first
            params = arg[1..-1]
          elsif arg.is_a?(DataMapper::Query)
            query = arg
          elsif arg.is_a?(Hash)
            repository_name = arg.delete(:repository) if arg.include?(:repository)
            properties = Array(arg.delete(:properties)) if arg.include?(:properties)
            do_reload = arg.delete(:reload) if arg.include?(:reload)
            raise "unknown options to #find_by_sql: #{arg.inspect}" unless arg.empty?
          end
        end
 
        the_repository = repository(repository_name)
        raise "#find_by_sql only available for Repositories served by a DataObjectsAdapter" unless the_repository.adapter.is_a?(DataMapper::Adapters::DataObjectsAdapter)
 
        if query
          sql = the_repository.adapter.query_read_statement(query)
          params = query.fields
        end
 
        raise "#find_by_sql requires a query of some kind to work" unless sql
 
        properties ||= self.properties
 
        DataMapper.logger.debug("FIND_BY_SQL: #{sql} PARAMETERS: #{params.inspect}")
 
        repository.adapter.read_set_with_sql(repository, self, properties, sql, params, do_reload)
      end
    end
 
  end
 
  module Adapters
 
    # You must inherit from the DoAdapter, and implement the
    # required methods to adapt a database library for use with the DataMapper.
    #
    # NOTE: By inheriting from DataObjectsAdapter, you get a copy of all the
    # standard sub-modules (Quoting, Coersion and Queries) in your own Adapter.
    # You can extend and overwrite these copies without affecting the originals.
    class DataObjectsAdapter < AbstractAdapter
 
      def self.inherited(base)
        base.const_set('TYPES', TYPES.dup)
      end
 
      TYPES = {
        Fixnum => 'int'.freeze,
        String => 'varchar'.freeze,
        DataMapper::Types::Text => 'text'.freeze,
        Class => 'varchar'.freeze,
        BigDecimal => 'decimal'.freeze,
        Float => 'float'.freeze,
        DateTime => 'datetime'.freeze,
        Date => 'date'.freeze,
        TrueClass => 'boolean'.freeze,
        Object => 'text'.freeze
      }
 
      def begin_transaction
        raise NotImplementedError
      end
 
      def commit_transaction
        raise NotImplementedError
      end
 
      def rollback_transaction
        raise NotImplementedError
      end
 
      def within_transaction?
        !Thread.current["dm_doa_#{@uri.scheme}_transaction"].nil?
      end
 
      def create_connection
        if within_transaction?
          Thread.current["dm_doa_#{@uri.scheme}_transaction"]
        else
          # DataObjects::Connection.new(uri) will give you back the right
          # driver based on the Uri#scheme.
          DataObjects::Connection.new(@uri)
        end
      end
 
      def close_connection(connection)
        connection.close unless within_transaction?
      end
 
      def create_with_returning?
        false
      end
 
      # all of our CRUD
      # Methods dealing with a single resource object
      def create(repository, resource)
        properties = resource.dirty_attributes
 
        sql = send(create_with_returning? ? :create_statement_with_returning : :create_statement, resource.class, properties)
        values = properties.map { |property| resource.instance_variable_get(property.instance_variable_name) }
        DataMapper.logger.debug("CREATE: #{sql} PARAMETERS: #{values.inspect}")
 
        connection = create_connection
        command = connection.create_command(sql)
 
        result = command.execute_non_query(*values)
 
        close_connection(connection)
 
        if result.to_i == 1
          key = resource.class.key(name)
          if key.size == 1 && key.first.serial?
            resource.instance_variable_set(key.first.instance_variable_name, result.insert_id)
          end
          true
        else
          false
        end
      end
 
      def read(repository, resource, key)
        properties = resource.properties(repository.name).defaults
 
        properties_with_indexes = Hash[*properties.zip((0...properties.length).to_a).flatten]
        set = LoadedSet.new(repository, resource, properties_with_indexes)
 
        sql = read_statement(resource, key)
        DataMapper.logger.debug("READ: #{sql}")
 
        connection = create_connection
        command = connection.create_command(sql)
        command.set_types(properties.map { |property| property.primitive })
        reader = command.execute_reader(*key)
        while(reader.next!)
          set.add(reader.values)
        end
 
        reader.close
        close_connection(connection)
 
        set.first
      end
 
      def update(repository, resource)
        properties = resource.dirty_attributes
        
        if properties.empty?
          return false
        else
          sql = update_statement(resource.class, properties)
          values = properties.map { |property| resource.instance_variable_get(property.instance_variable_name) }
          parameters = (values + resource.key)
          DataMapper.logger.debug("UPDATE: #{sql} PARAMETERS: #{parameters.inspect}")
          
          connection = create_connection
          command = connection.create_command(sql)
          
          affected_rows = command.execute_non_query(*parameters).to_i
          
          close_connection(connection)
          
          affected_rows == 1
        end
      end
 
      def delete(repository, resource)
        key = resource.class.key(name).map { |property| resource.instance_variable_get(property.instance_variable_name) }
 
        connection = create_connection
        command = connection.create_command(delete_statement(resource.class))
 
        affected_rows = command.execute_non_query(*key).to_i
 
        close_connection(connection)
 
        affected_rows == 1
      end
 
      #
      # used by find_by_sql and read_set
      #
      # ==== Parameters
      # repository<DataMapper::Repository>:: The repository to read from.
      # model<Object>:: The class of the instances to read.
      # properties<Array>:: The properties to read. Must contain Symbols, Strings or DM::Properties.
      # sql<String>:: The query to execute.
      # parameters<Array>:: The conditions to the query.
      # do_reload<Boolean>:: Whether to reload objects already found in the identity map.
      #
      # ==== Returns
      # LoadedSet:: A set of the found instances.
      #
      def read_set_with_sql(repository, model, properties, sql, parameters, do_reload)
        properties_with_indexes = Hash[*properties.zip((0...properties.length).to_a).flatten]
        set = LoadedSet.new(repository, model, properties_with_indexes)
 
        DataMapper.logger.debug("READ_SET: #{sql} PARAMETERS: #{parameters.inspect}")
 
        connection = create_connection
        begin
          command = connection.create_command(sql)
          command.set_types(properties.map { |property| property.primitive })
          reader = command.execute_reader(*parameters)
 
          while(reader.next!)
            set.add(reader.values, do_reload)
          end
 
          reader.close
        rescue StandardError => se
          p se, sql
          raise se
        ensure
          close_connection(connection)
        end
 
        set
      end
 
      # Methods dealing with finding stuff by some query parameters
      def read_set(repository, query)
        read_set_with_sql(repository,
                          query.model,
                          query.fields,
                          query_read_statement(query),
                          query.parameters,
                          query.reload?)
      end
 
      def delete_set(repository, query)
        raise NotImplementedError
      end
 
      # Database-specific method
      def execute(sql, *args)
        DataMapper.logger.debug("EXECUTE: #{sql} PARAMETERS: #{args.inspect}")
 
        connection = create_connection
        command = connection.create_command(sql)
        return command.execute_non_query(*args)
      rescue => e
        DataMapper.logger.error(e) if DataMapper.logger
        raise e
      ensure
        connection.close if connection
      end
 
      def query(sql, *args)
        DataMapper.logger.debug("QUERY: #{sql} PARAMETERS: #{args.inspect}")
 
        connection = create_connection
        command = connection.create_command(sql)
 
        reader = command.execute_reader(*args)
        results = []
 
        if (fields = reader.fields).size > 1
          fields = fields.map { |field| DataMapper::Inflection.underscore(field).to_sym }
          struct = Struct.new(*fields)
 
          while(reader.next!) do
            results << struct.new(*reader.values)
          end
        else
          while(reader.next!) do
            results << reader.values.at(0)
          end
        end
 
        return results
      rescue => e
        DataMapper.logger.error(e) if DataMapper.logger
        raise e
      ensure
        reader.close if reader
        connection.close if connection
      end
 
      # This model is just for organization. The methods are included into the Adapter below.
      module SQL
        def create_statement(model, properties)
          <<-EOS.compress_lines
INSERT INTO #{quote_table_name(model.storage_name(name))}
(#{properties.map { |property| quote_column_name(property.field) }.join(', ')})
VALUES
(#{(['?'] * properties.size).join(', ')})
EOS
        end
 
        def create_statement_with_returning(model, properties)
          <<-EOS.compress_lines
INSERT INTO #{quote_table_name(model.storage_name(name))}
(#{properties.map { |property| quote_column_name(property.field) }.join(', ')})
VALUES
(#{(['?'] * properties.size).join(', ')})
RETURNING #{quote_column_name(model.key(name).first.field)}
EOS
        end
 
        def read_statement(model, key)
          properties = model.properties(name).defaults
          <<-EOS.compress_lines
SELECT #{properties.map { |property| quote_column_name(property.field) }.join(', ')}
FROM #{quote_table_name(model.storage_name(name))}
WHERE #{model.key(name).map { |key| "#{quote_column_name(key.field)} = ?" }.join(' AND ')}
EOS
        end
 
        def update_statement(model, properties)
          <<-EOS.compress_lines
UPDATE #{quote_table_name(model.storage_name(name))}
SET #{properties.map {|attribute| "#{quote_column_name(attribute.field)} = ?" }.join(', ')}
WHERE #{model.key(name).map { |key| "#{quote_column_name(key.field)} = ?" }.join(' AND ')}
EOS
        end
 
        def delete_statement(model)
          <<-EOS.compress_lines
DELETE FROM #{quote_table_name(model.storage_name(name))}
WHERE #{model.key(name).map { |key| "#{quote_column_name(key.field)} = ?" }.join(' AND ')}
EOS
        end
        
        
 
        def query_read_statement(query)
          qualify = query.links.any?
 
          sql = "SELECT "
 
          sql << query.fields.map do |property|
            # TODO Should we raise an error if there is no such property in the
            # repository of the query?
            #
            #if property.model.properties(query.repository.name)[property.name].nil?
            # raise "Property #{property.model.to_s}.#{property.name.to_s} not available in repository #{query.repository.name}."
            #end
            #
            model_name = property.model.storage_name(query.repository.name)
            property_to_column_name(model_name, property, qualify)
          end.join(', ')
 
          sql << " FROM " << quote_table_name(query.model_name)
 
          unless query.links.empty?
            joins = []
            query.links.each do |relationship|
              child_model = relationship.child_model
              parent_model = relationship.parent_model
              child_model_name = child_model.storage_name(child_model.repository.name)
              parent_model_name = parent_model.storage_name(parent_model.repository.name)
              child_keys = relationship.child_key.to_a
 
              # We only do LEFT OUTER JOIN for now
              s = ' LEFT OUTER JOIN '
              s << parent_model_name << ' ON '
              parts = []
              relationship.parent_key.zip(child_keys) do |parent_key,child_key|
                part = ' ('
                part << property_to_column_name(parent_model_name, parent_key, true)
                part << ' = '
                part << property_to_column_name(child_model_name, child_key, true)
                part << ')'
                parts << part
              end
              s << parts.join(' AND ')
              joins << s
            end
            sql << joins.join(' ')
          end
 
 
          unless query.conditions.empty?
            sql << " WHERE "
            sql << "(" << query.conditions.map do |operator, property, value|
              # TODO Should we raise an error if there is no such property in the
              # repository of the query?
              #
              #if property.model.properties(query.repository.name)[property.name].nil?
              # raise "Property #{property.model.to_s}.#{property.name.to_s} not available in repository #{query.repository.name}."
              #end
              #
              model_name = property.model.storage_name(query.repository.name)
              case operator
                when :eql, :in then equality_operator(query,model_name,operator, property, qualify, value)
                when :not then inequality_operator(query,model_name,operator, property, qualify, value)
                when :like then "#{property_to_column_name(model_name, property, qualify)} LIKE ?"
                when :gt then "#{property_to_column_name(model_name, property, qualify)} > ?"
                when :gte then "#{property_to_column_name(model_name, property, qualify)} >= ?"
                when :lt then "#{property_to_column_name(model_name, property, qualify)} < ?"
                when :lte then "#{property_to_column_name(model_name, property, qualify)} <= ?"
                else raise "CAN HAS CRASH?"
              end
            end.join(') AND (') << ")"
          end
 
          unless query.order.empty?
            parts = []
            query.order.each do |item|
              parts << item.name if DataMapper::Property === item
              parts << "#{item.property.name} #{item.direction}" if DataMapper::Query::Direction === item
            end
            sql << " ORDER BY #{parts.join(', ')}"
          end
 
          sql << " LIMIT #{query.limit}" if query.limit
          sql << " OFFSET #{query.offset}" if query.offset && query.offset > 0
 
          sql
        end
 
        def equality_operator(query, model_name, operator, property, qualify, value)
          case value
            when Array then "#{property_to_column_name(model_name, property, qualify)} IN ?"
            when NilClass then "#{property_to_column_name(model_name, property, qualify)} IS NULL"
            when DataMapper::Query then
              query.merge_sub_select_conditions(operator, property, value)
              "#{property_to_column_name(model_name, property, qualify)} IN (#{query_read_statement(value)}