data_active 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (184) hide show
  1. data/.gitignore +35 -0
  2. data/.rvmrc +1 -0
  3. data/Gemfile +4 -0
  4. data/README.rdoc +275 -0
  5. data/Rakefile +2 -0
  6. data/data_active.gemspec +28 -0
  7. data/features/remove_records_missing_in_xml.feature +30 -0
  8. data/features/step_definitions/remove_records_missing_in_xml.rb +85 -0
  9. data/features/step_definitions/step_helper.rb +15 -0
  10. data/features/step_definitions/sync_books_with_xml.rb +224 -0
  11. data/features/step_definitions/update_database_with_xml.rb +158 -0
  12. data/features/step_definitions/web_steps.rb +211 -0
  13. data/features/support/env.rb +50 -0
  14. data/features/support/fixtures/fresh/book_prices.yml +6 -0
  15. data/features/support/fixtures/fresh/books.yml +7 -0
  16. data/features/support/fixtures/fresh/chapters.yml +35 -0
  17. data/features/support/fixtures/fresh/pages.yml +149 -0
  18. data/features/support/fixtures/no_matching_records/book_prices.yml +6 -0
  19. data/features/support/fixtures/no_matching_records/books.yml +7 -0
  20. data/features/support/fixtures/no_matching_records/chapters.yml +35 -0
  21. data/features/support/fixtures/no_matching_records/pages.yml +149 -0
  22. data/features/support/fixtures/without_chapters/books.yml +7 -0
  23. data/features/support/fixtures/without_one_to_one/books.yml +7 -0
  24. data/features/support/fixtures/without_one_to_one/chapters.yml +35 -0
  25. data/features/support/fixtures/without_one_to_one/pages.yml +149 -0
  26. data/features/support/fixtures/xml/books_changed.xml +173 -0
  27. data/features/support/fixtures/xml/books_fresh.xml +173 -0
  28. data/features/support/fixtures/xml/books_one_to_one_changed.xml +173 -0
  29. data/features/support/fixtures/xml/books_one_to_one_mismatch.xml +173 -0
  30. data/features/support/fixtures/xml/books_one_to_one_removed.xml +167 -0
  31. data/features/support/fixtures/xml/books_simple.xml +15 -0
  32. data/features/support/fixtures/xml/books_with_changed_chapters.xml +40 -0
  33. data/features/support/fixtures/xml/books_with_chapters.xml +45 -0
  34. data/features/support/fixtures/xml/books_with_many_one_to_one_records.xml +179 -0
  35. data/features/support/fixtures/xml/books_with_mismatched_chapters.xml +173 -0
  36. data/features/support/fixtures/xml/books_with_moved_chapters.xml +173 -0
  37. data/features/support/fixtures/xml/books_with_one_to_one.xml +167 -0
  38. data/features/support/fixtures/xml/books_with_removed_chapters.xml +113 -0
  39. data/features/support/fixtures/xml/books_without_chapters.xml +11 -0
  40. data/features/support/fixtures/xml/books_without_one_to_one.xml +167 -0
  41. data/features/support/fixtures/xml/ms_access/book.xml +201 -0
  42. data/features/support/fixtures/xml/ms_access/book.xsd +425 -0
  43. data/features/support/fixtures/xml/ms_access/books_changed.xml +158 -0
  44. data/features/support/fixtures/xml/ms_access/books_fresh.xml +173 -0
  45. data/features/support/fixtures/xml/ms_access/books_one_to_one_changed.xml +173 -0
  46. data/features/support/fixtures/xml/ms_access/books_one_to_one_mismatch.xml +173 -0
  47. data/features/support/fixtures/xml/ms_access/books_one_to_one_removed.xml +167 -0
  48. data/features/support/fixtures/xml/ms_access/books_simple.xml +15 -0
  49. data/features/support/fixtures/xml/ms_access/books_with_changed_chapters.xml +40 -0
  50. data/features/support/fixtures/xml/ms_access/books_with_chapters.xml +45 -0
  51. data/features/support/fixtures/xml/ms_access/books_with_many_one_to_one_records.xml +179 -0
  52. data/features/support/fixtures/xml/ms_access/books_with_mismatched_chapters.xml +173 -0
  53. data/features/support/fixtures/xml/ms_access/books_with_moved_chapters.xml +173 -0
  54. data/features/support/fixtures/xml/ms_access/books_with_one_to_one.xml +167 -0
  55. data/features/support/fixtures/xml/ms_access/books_with_removed_chapters.xml +113 -0
  56. data/features/support/fixtures/xml/ms_access/books_without_chapters.xml +11 -0
  57. data/features/support/fixtures/xml/ms_access/books_without_one_to_one.xml +167 -0
  58. data/features/support/paths.rb +33 -0
  59. data/features/support/selectors.rb +39 -0
  60. data/features/sync_database_with_xml.feature +34 -0
  61. data/features/sync_one_to_many.feature +34 -0
  62. data/features/sync_one_to_one.feature +33 -0
  63. data/features/update_database_with_xml.feature +30 -0
  64. data/lib/data_active.rb +309 -0
  65. data/lib/data_active/version.rb +3 -0
  66. data/test_apps/book_store_rails_31x/.gitignore +15 -0
  67. data/test_apps/book_store_rails_31x/.rvmrc +1 -0
  68. data/test_apps/book_store_rails_31x/Gemfile +53 -0
  69. data/test_apps/book_store_rails_31x/README +261 -0
  70. data/test_apps/book_store_rails_31x/Rakefile +7 -0
  71. data/test_apps/book_store_rails_31x/app/assets/images/rails.png +0 -0
  72. data/test_apps/book_store_rails_31x/app/assets/javascripts/application.js +9 -0
  73. data/test_apps/book_store_rails_31x/app/assets/stylesheets/application.css +7 -0
  74. data/test_apps/book_store_rails_31x/app/controllers/application_controller.rb +3 -0
  75. data/test_apps/book_store_rails_31x/app/helpers/application_helper.rb +2 -0
  76. data/test_apps/book_store_rails_31x/app/mailers/.gitkeep +0 -0
  77. data/test_apps/book_store_rails_31x/app/models/.gitkeep +0 -0
  78. data/test_apps/book_store_rails_31x/app/models/book.rb +4 -0
  79. data/test_apps/book_store_rails_31x/app/models/book_price.rb +3 -0
  80. data/test_apps/book_store_rails_31x/app/models/chapter.rb +4 -0
  81. data/test_apps/book_store_rails_31x/app/models/page.rb +3 -0
  82. data/test_apps/book_store_rails_31x/app/views/layouts/application.html.erb +14 -0
  83. data/test_apps/book_store_rails_31x/config.ru +4 -0
  84. data/test_apps/book_store_rails_31x/config/application.rb +48 -0
  85. data/test_apps/book_store_rails_31x/config/boot.rb +6 -0
  86. data/test_apps/book_store_rails_31x/config/database.yml +28 -0
  87. data/test_apps/book_store_rails_31x/config/environment.rb +5 -0
  88. data/test_apps/book_store_rails_31x/config/environments/development.rb +30 -0
  89. data/test_apps/book_store_rails_31x/config/environments/production.rb +60 -0
  90. data/test_apps/book_store_rails_31x/config/environments/test.rb +39 -0
  91. data/test_apps/book_store_rails_31x/config/initializers/backtrace_silencers.rb +7 -0
  92. data/test_apps/book_store_rails_31x/config/initializers/inflections.rb +10 -0
  93. data/test_apps/book_store_rails_31x/config/initializers/mime_types.rb +5 -0
  94. data/test_apps/book_store_rails_31x/config/initializers/secret_token.rb +7 -0
  95. data/test_apps/book_store_rails_31x/config/initializers/session_store.rb +8 -0
  96. data/test_apps/book_store_rails_31x/config/initializers/wrap_parameters.rb +14 -0
  97. data/test_apps/book_store_rails_31x/config/locales/en.yml +5 -0
  98. data/test_apps/book_store_rails_31x/config/routes.rb +58 -0
  99. data/test_apps/book_store_rails_31x/db/migrate/20120422053943_create_books.rb +9 -0
  100. data/test_apps/book_store_rails_31x/db/migrate/20120422054008_create_chapters.rb +11 -0
  101. data/test_apps/book_store_rails_31x/db/migrate/20120422054033_create_pages.rb +11 -0
  102. data/test_apps/book_store_rails_31x/db/migrate/20120422054123_create_book_prices.rb +12 -0
  103. data/test_apps/book_store_rails_31x/db/schema.rb +47 -0
  104. data/test_apps/book_store_rails_31x/db/seeds.rb +7 -0
  105. data/test_apps/book_store_rails_31x/lib/assets/.gitkeep +0 -0
  106. data/test_apps/book_store_rails_31x/lib/tasks/.gitkeep +0 -0
  107. data/test_apps/book_store_rails_31x/log/.gitkeep +0 -0
  108. data/test_apps/book_store_rails_31x/public/404.html +26 -0
  109. data/test_apps/book_store_rails_31x/public/422.html +26 -0
  110. data/test_apps/book_store_rails_31x/public/500.html +26 -0
  111. data/test_apps/book_store_rails_31x/public/favicon.ico +0 -0
  112. data/test_apps/book_store_rails_31x/public/index.html +241 -0
  113. data/test_apps/book_store_rails_31x/public/robots.txt +5 -0
  114. data/test_apps/book_store_rails_31x/script/rails +6 -0
  115. data/test_apps/book_store_rails_31x/test/fixtures/.gitkeep +0 -0
  116. data/test_apps/book_store_rails_31x/test/functional/.gitkeep +0 -0
  117. data/test_apps/book_store_rails_31x/test/integration/.gitkeep +0 -0
  118. data/test_apps/book_store_rails_31x/test/performance/browsing_test.rb +12 -0
  119. data/test_apps/book_store_rails_31x/test/test_helper.rb +13 -0
  120. data/test_apps/book_store_rails_31x/test/unit/.gitkeep +0 -0
  121. data/test_apps/book_store_rails_31x/vendor/assets/stylesheets/.gitkeep +0 -0
  122. data/test_apps/book_store_rails_31x/vendor/plugins/.gitkeep +0 -0
  123. data/test_apps/book_store_rails_32x/.gitignore +15 -0
  124. data/test_apps/book_store_rails_32x/.rvmrc +1 -0
  125. data/test_apps/book_store_rails_32x/Gemfile +47 -0
  126. data/test_apps/book_store_rails_32x/README.rdoc +261 -0
  127. data/test_apps/book_store_rails_32x/Rakefile +14 -0
  128. data/test_apps/book_store_rails_32x/app/assets/images/rails.png +0 -0
  129. data/test_apps/book_store_rails_32x/app/assets/javascripts/application.js +15 -0
  130. data/test_apps/book_store_rails_32x/app/assets/stylesheets/application.css +13 -0
  131. data/test_apps/book_store_rails_32x/app/controllers/application_controller.rb +3 -0
  132. data/test_apps/book_store_rails_32x/app/helpers/application_helper.rb +2 -0
  133. data/test_apps/book_store_rails_32x/app/mailers/.gitkeep +0 -0
  134. data/test_apps/book_store_rails_32x/app/models/.gitkeep +0 -0
  135. data/test_apps/book_store_rails_32x/app/models/book.rb +4 -0
  136. data/test_apps/book_store_rails_32x/app/models/book_price.rb +3 -0
  137. data/test_apps/book_store_rails_32x/app/models/chapter.rb +4 -0
  138. data/test_apps/book_store_rails_32x/app/models/page.rb +3 -0
  139. data/test_apps/book_store_rails_32x/app/views/layouts/application.html.erb +14 -0
  140. data/test_apps/book_store_rails_32x/config.ru +4 -0
  141. data/test_apps/book_store_rails_32x/config/application.rb +59 -0
  142. data/test_apps/book_store_rails_32x/config/boot.rb +6 -0
  143. data/test_apps/book_store_rails_32x/config/cucumber.yml +8 -0
  144. data/test_apps/book_store_rails_32x/config/database.yml +28 -0
  145. data/test_apps/book_store_rails_32x/config/environment.rb +5 -0
  146. data/test_apps/book_store_rails_32x/config/environments/development.rb +37 -0
  147. data/test_apps/book_store_rails_32x/config/environments/production.rb +67 -0
  148. data/test_apps/book_store_rails_32x/config/environments/test.rb +37 -0
  149. data/test_apps/book_store_rails_32x/config/initializers/backtrace_silencers.rb +7 -0
  150. data/test_apps/book_store_rails_32x/config/initializers/inflections.rb +15 -0
  151. data/test_apps/book_store_rails_32x/config/initializers/mime_types.rb +5 -0
  152. data/test_apps/book_store_rails_32x/config/initializers/secret_token.rb +7 -0
  153. data/test_apps/book_store_rails_32x/config/initializers/session_store.rb +8 -0
  154. data/test_apps/book_store_rails_32x/config/initializers/wrap_parameters.rb +14 -0
  155. data/test_apps/book_store_rails_32x/config/locales/en.yml +5 -0
  156. data/test_apps/book_store_rails_32x/config/routes.rb +58 -0
  157. data/test_apps/book_store_rails_32x/db/migrate/20120422043253_create_books.rb +9 -0
  158. data/test_apps/book_store_rails_32x/db/migrate/20120422043434_create_chapters.rb +11 -0
  159. data/test_apps/book_store_rails_32x/db/migrate/20120422043553_create_pages.rb +11 -0
  160. data/test_apps/book_store_rails_32x/db/migrate/20120422043700_create_book_prices.rb +12 -0
  161. data/test_apps/book_store_rails_32x/db/schema.rb +47 -0
  162. data/test_apps/book_store_rails_32x/db/seeds.rb +7 -0
  163. data/test_apps/book_store_rails_32x/lib/assets/.gitkeep +0 -0
  164. data/test_apps/book_store_rails_32x/lib/tasks/.gitkeep +0 -0
  165. data/test_apps/book_store_rails_32x/lib/tasks/cucumber.rake +65 -0
  166. data/test_apps/book_store_rails_32x/log/.gitkeep +0 -0
  167. data/test_apps/book_store_rails_32x/public/404.html +26 -0
  168. data/test_apps/book_store_rails_32x/public/422.html +26 -0
  169. data/test_apps/book_store_rails_32x/public/500.html +25 -0
  170. data/test_apps/book_store_rails_32x/public/favicon.ico +0 -0
  171. data/test_apps/book_store_rails_32x/public/index.html +241 -0
  172. data/test_apps/book_store_rails_32x/public/robots.txt +5 -0
  173. data/test_apps/book_store_rails_32x/script/cucumber +10 -0
  174. data/test_apps/book_store_rails_32x/script/rails +6 -0
  175. data/test_apps/book_store_rails_32x/test/fixtures/.gitkeep +0 -0
  176. data/test_apps/book_store_rails_32x/test/functional/.gitkeep +0 -0
  177. data/test_apps/book_store_rails_32x/test/integration/.gitkeep +0 -0
  178. data/test_apps/book_store_rails_32x/test/performance/browsing_test.rb +12 -0
  179. data/test_apps/book_store_rails_32x/test/test_helper.rb +13 -0
  180. data/test_apps/book_store_rails_32x/test/unit/.gitkeep +0 -0
  181. data/test_apps/book_store_rails_32x/vendor/assets/javascripts/.gitkeep +0 -0
  182. data/test_apps/book_store_rails_32x/vendor/assets/stylesheets/.gitkeep +0 -0
  183. data/test_apps/book_store_rails_32x/vendor/plugins/.gitkeep +0 -0
  184. metadata +452 -0
@@ -0,0 +1,30 @@
1
+ Feature: Update database with XML
2
+ As a Developer
3
+ I need to update the my database with an XML document
4
+ So that records in my database that share the same identify features as those in the XML are updated
5
+
6
+ Scenario: Attempting to update when some records have the same identifying features as those in teh XML Document
7
+ Given I have a fresh set of books
8
+ And I have the "features/support/fixtures/xml/books_changed.xml" file
9
+ When I update with "features/support/fixtures/xml/books_changed.xml"
10
+ Then the books with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
11
+ And the chapters with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
12
+ And the pages with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
13
+
14
+
15
+ Scenario: Update when no records exist in the database
16
+ Given I have no books
17
+ And I have the "features/support/fixtures/xml/books_changed.xml" file
18
+ When I update with "features/support/fixtures/xml/books_changed.xml"
19
+ Then the books with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
20
+ And the chapters with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
21
+ And the pages with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
22
+
23
+
24
+ Scenario: Update when records exist but there are no matching records in the database
25
+ Given I have no matching books
26
+ And I have the "features/support/fixtures/xml/books_changed.xml" file
27
+ When I update with "features/support/fixtures/xml/books_changed.xml"
28
+ Then the books with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
29
+ And the chapters with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
30
+ And the pages with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
@@ -0,0 +1,309 @@
1
+ require "data_active/version"
2
+
3
+ module DataActive
4
+ def self.included(base)
5
+ base.extend ClassMethods
6
+ end
7
+
8
+ def ensure_unique(name)
9
+ begin
10
+ self[name] = yield
11
+ end while self.class.exists?(name => self[name])
12
+ end
13
+
14
+ VALID_FROM_XML_OPTIONS = [:sync, :create, :update, :destroy]
15
+
16
+ module ClassMethods
17
+ def many_from_xml(source_xml, options = [])
18
+ @data_active_options = options
19
+ many_from root_node_in source_xml
20
+ end
21
+
22
+ def many_from(current_node)
23
+ case
24
+ when self.name.pluralize.underscore.eql?(current_node.name.underscore)
25
+ many_from_rails_xml current_node
26
+
27
+ when (current_node.name.eql?('dataroot') \
28
+ and current_node.namespace_definitions.map { |ns| ns.href }.include?('urn:schemas-microsoft-com:officedata'))
29
+ # Identified as data generated from Microsoft Access
30
+ many_from_ms_xml current_node
31
+
32
+ when self.name.underscore.eql?(current_node.name.underscore)
33
+ raise "The supplied XML (#{current_node.name}) is a single instance of '#{self.name}'. Please use one_from_xml"
34
+
35
+ else
36
+ raise "The supplied XML (#{current_node.name}) cannot be mapped to this class (#{self.name})"
37
+
38
+ end
39
+ end
40
+
41
+ def many_from_ms_xml(current_node)
42
+ records = []
43
+ recorded_ids = []
44
+
45
+ current_node.element_children.each do |node|
46
+ if self.name.underscore.eql?(node.name.underscore)
47
+ record = self.one_from_xml(node, @data_active_options)
48
+ if record
49
+ recorded_ids << record[primary_key.to_sym]
50
+ records << record
51
+ end
52
+ end
53
+ end
54
+
55
+ remove_records_not_in recorded_ids
56
+
57
+ records
58
+ end
59
+
60
+ def many_from_rails_xml(current_node)
61
+ records = []
62
+ recorded_ids = []
63
+
64
+ current_node.element_children.each do |node|
65
+ record = self.one_from_xml(node, @data_active_options)
66
+ if record
67
+ recorded_ids << record[primary_key.to_sym]
68
+ records << record
69
+ end
70
+ end
71
+
72
+ remove_records_not_in recorded_ids
73
+
74
+ records
75
+ end
76
+
77
+ def remove_records_not_in(recorded_ids)
78
+ if @data_active_options.include?(:sync)
79
+ if recorded_ids.length > 0
80
+ self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
81
+ end
82
+ elsif @data_active_options.include?(:destroy)
83
+ if recorded_ids.length > 0
84
+ self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
85
+ else
86
+ self.destroy_all
87
+ end
88
+ end
89
+ end
90
+
91
+ def root_node_in(source_xml)
92
+ if source_xml.is_a?(String)
93
+ doc = Nokogiri::XML(source_xml)
94
+ doc.children.first
95
+ else
96
+ source_xml
97
+ end
98
+ end
99
+
100
+ def one_from_xml(source_xml, options = [])
101
+ @data_active_options = options
102
+
103
+ current_node = root_node_in source_xml
104
+
105
+ if current_node.name.underscore.eql?(self.name.underscore)
106
+ # Load or create a new record
107
+ pk_node = current_node.xpath self.primary_key.to_s
108
+
109
+ active_record = find_record_based_on(pk_node)
110
+
111
+
112
+ unless active_record.nil?
113
+ # Check through associations and apply sync appropriately
114
+ self.reflect_on_all_associations.each do |association|
115
+ foreign_key = foreign_key_from(association)
116
+ klass = association.klass
117
+
118
+ case
119
+ when association.macro == :has_many, association.macro == :has_and_belongs_to_many
120
+ instances = instances_for association, :from => current_node, :for => active_record
121
+
122
+ child_ids = []
123
+ instances.each do |instance|
124
+ new_record = klass.one_from_xml(instance, options)
125
+ if new_record != nil
126
+ child_ids << new_record[klass.primary_key]
127
+ active_record.__send__(klass.name.underscore.pluralize.to_sym) << new_record
128
+ end
129
+ end
130
+
131
+ unless active_record.new_record?
132
+ if options.include?(:sync) or options.include?(:destroy)
133
+ if child_ids.length > 0
134
+ klass.destroy_all [klass.primary_key.to_s + " not in (?) and #{foreign_key} = ?", child_ids.collect, active_record.attributes[self.primary_key.to_s]]
135
+ else
136
+ klass.destroy_all
137
+ end
138
+ end
139
+ end
140
+
141
+ when association.macro == :has_one
142
+ pk_value = active_record.new_record? ? 0 : active_record.attributes[self.primary_key.to_s]
143
+ single_objects = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{pk_value}]/#{association.name}")
144
+ klass = association.klass
145
+ record = klass.where(foreign_key => active_record.attributes[self.primary_key.to_s]).all
146
+ if single_objects.count == 1
147
+ # Check to see if the already record exists
148
+ if record.count == 1
149
+ db_pk_value = record[0][klass.primary_key]
150
+ xml_pk_value = Integer(single_objects[0].element_children.xpath("//#{self.name.underscore}/#{klass.primary_key}").text)
151
+
152
+ if db_pk_value != xml_pk_value
153
+ # Different record in xml
154
+ if options.include?(:sync) or options.include?(:destroy)
155
+ # Delete the one in the database
156
+ klass.destroy(record[0][klass.primary_key])
157
+ end
158
+ end
159
+ elsif record.count > 1
160
+ raise "Too many records for one to one association in the database. Found #{record.count} records of '#{association.name}' for association with '#{self.name}'"
161
+ end
162
+
163
+ if options.include?(:create) or options.include?(:update) or options.include?(:sync)
164
+ new_record = klass.one_from_xml(single_objects[0], options)
165
+ if new_record != nil
166
+ new_record[foreign_key.to_sym] = active_record[self.primary_key.to_s]
167
+ new_record.save!
168
+ end
169
+ end
170
+ elsif single_objects.count > 1
171
+ # There are more than one associations
172
+ raise "Too many records for one to one association in the provided XML. Found #{single_objects.count} records of '#{association.name}' for association with '#{self.name}'"
173
+ else
174
+ # There are no records in the XML
175
+ if record.count > 0 and options.include?(:sync) or options.include?(:destroy)
176
+ # Found some in the database: destroy then
177
+ klass.destroy_all("#{foreign_key} = #{active_record.attributes[self.primary_key.to_s]}")
178
+ end
179
+ end
180
+
181
+ when association.macro == :belongs_to
182
+
183
+ else
184
+ raise "unsupported association #{association.macro} for #{association.name } on #{self.name}"
185
+ end
186
+ end
187
+
188
+ # Process the attributes
189
+ if options.include? :update or options.include? :sync or options.include? :create
190
+ assign_attributes_from current_node, :to => active_record
191
+ end
192
+
193
+ # Save the record
194
+ if options.include? :sync
195
+ # Doing complete synchronisation with XML
196
+ active_record.save
197
+ elsif options.include?(:create) and active_record.new_record?
198
+ active_record.save
199
+ elsif options.include?(:update) and not active_record.new_record?
200
+ active_record.save
201
+ end
202
+ end
203
+
204
+ active_record
205
+ else
206
+ raise "The supplied XML (#{current_node.name}) cannot be mapped to this class (#{self.name})"
207
+ end
208
+ end
209
+
210
+ def foreign_key_from(association)
211
+ if ActiveRecord::Reflection::AssociationReflection.method_defined? :foreign_key
212
+ # Support for Rails 3.1 and later
213
+ foreign_key = association.foreign_key
214
+ elsif ActiveRecord::Reflection::AssociationReflection.method_defined? :primary_key_name
215
+ # Support for Rails earlier than 3.1
216
+ foreign_key = association.primary_key_name
217
+ else
218
+ raise "Unsupported version of ActiveRecord. Unable to identify the foreign key."
219
+ end
220
+ foreign_key
221
+ end
222
+
223
+ def instances_for(association, options)
224
+ current_node = options[:from]
225
+ active_record = options[:for]
226
+
227
+ # Attempt to find instances which are in the following format
228
+ # <books>
229
+ # <book>
230
+ # ...
231
+ # </book>
232
+ # <book>
233
+ # ...
234
+ # </book>
235
+ # </books>
236
+ if active_record.new_record?
237
+ results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{current_node.xpath(self.primary_key.to_s).text}]/#{association.name}")
238
+ else
239
+ results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{active_record.attributes[self.primary_key.to_s]}]/#{association.name}")
240
+ end
241
+
242
+
243
+ if results.count.eql? 0
244
+ # Attempt to find instances which are in the following format
245
+ # <book>
246
+ # ...
247
+ # </book>
248
+ if active_record.new_record?
249
+ results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{current_node.xpath(self.primary_key.to_s).text}]/#{association.name.to_s.singularize}")
250
+ else
251
+ results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{active_record.attributes[self.primary_key.to_s]}]/#{association.name.to_s.singularize}")
252
+ end
253
+ else
254
+ results = results.first.element_children
255
+ end
256
+
257
+ results
258
+ end
259
+
260
+ def assign_attributes_from(current_node, options)
261
+ record = options[:to]
262
+
263
+ record.attributes.each do |name, value|
264
+ attribute_nodes = current_node.xpath name.to_s
265
+ if attribute_nodes.count == 1
266
+ if attribute_nodes[0].attributes['nil'].try(:value)
267
+ record[name] = nil
268
+ else
269
+ record[name] = attribute_nodes[0].text
270
+ end
271
+ elsif attribute_nodes.count > 1
272
+ raise "Found duplicate elements in xml for active record attribute '#{name}'"
273
+ end
274
+ end
275
+ end
276
+
277
+ def find_record_based_on(pk_node)
278
+ ar = nil
279
+ if pk_node
280
+ begin
281
+ ar = find pk_node.text
282
+ rescue
283
+ # No record exists, create a new one
284
+ if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
285
+ ar = self.new
286
+ end
287
+ end
288
+ else
289
+ # No primary key value, must be a new record
290
+ if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
291
+ ar = self.new
292
+ end
293
+ end
294
+ ar
295
+ end
296
+
297
+ def xml_node_matches_class(xml_node)
298
+ if xml_node.attributes['type'].blank?
299
+ xml_node.name.underscore == self.name.underscore
300
+ else
301
+ xml_node.attributes['type'].value.underscore == self.name.underscore
302
+ end
303
+ end
304
+ end
305
+ end
306
+
307
+ class ActiveRecord::Base
308
+ include DataActive
309
+ end
@@ -0,0 +1,3 @@
1
+ module DataActive
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,15 @@
1
+ # See http://help.github.com/ignore-files/ for more about ignoring files.
2
+ #
3
+ # If you find yourself ignoring temporary files generated by your text editor
4
+ # or operating system, you probably want to add a global ignore instead:
5
+ # git config --global core.excludesfile ~/.gitignore_global
6
+
7
+ # Ignore bundler config
8
+ /.bundle
9
+
10
+ # Ignore the default SQLite database.
11
+ /db/*.sqlite3
12
+
13
+ # Ignore all logfiles and tempfiles.
14
+ /log/*.log
15
+ /tmp
@@ -0,0 +1 @@
1
+ rvm ruby-1.9.3-p125@book_store_rails_31x --create
@@ -0,0 +1,53 @@
1
+ source 'http://rubygems.org'
2
+
3
+ gem 'rails', '3.1.4'
4
+
5
+ # Bundle edge Rails instead:
6
+ # gem 'rails', :git => 'git://github.com/rails/rails.git'
7
+
8
+ gem 'sqlite3'
9
+ gem 'data_active', '0.0.1'
10
+
11
+ group :test do
12
+ gem 'cucumber'
13
+ gem 'cucumber-rails'
14
+ end
15
+
16
+ group :test, :development do
17
+ gem 'database_cleaner'
18
+ gem 'guard-cucumber'
19
+ gem 'growl_notify'
20
+ end
21
+
22
+
23
+
24
+ # Gems used only for assets and not required
25
+ # in production environments by default.
26
+ group :assets do
27
+ gem 'sass-rails', '~> 3.1.5'
28
+ gem 'coffee-rails', '~> 3.1.1'
29
+
30
+ # See https://github.com/sstephenson/execjs#readme for more supported runtimes
31
+ # gem 'therubyracer'
32
+
33
+ gem 'uglifier', '>= 1.0.3'
34
+ end
35
+
36
+ gem 'jquery-rails'
37
+
38
+ # To use ActiveModel has_secure_password
39
+ # gem 'bcrypt-ruby', '~> 3.0.0'
40
+
41
+ # Use unicorn as the web server
42
+ # gem 'unicorn'
43
+
44
+ # Deploy with Capistrano
45
+ # gem 'capistrano'
46
+
47
+ # To use debugger
48
+ # gem 'ruby-debug19', :require => 'ruby-debug'
49
+
50
+ group :test do
51
+ # Pretty printed test output
52
+ gem 'turn', '~> 0.8.3', :require => false
53
+ end
@@ -0,0 +1,261 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.all
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.org/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- assets
160
+ | |-- images
161
+ | |-- javascripts
162
+ | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | `-- tasks
177
+ |-- log
178
+ |-- public
179
+ |-- script
180
+ |-- test
181
+ | |-- fixtures
182
+ | |-- functional
183
+ | |-- integration
184
+ | |-- performance
185
+ | `-- unit
186
+ |-- tmp
187
+ | |-- cache
188
+ | |-- pids
189
+ | |-- sessions
190
+ | `-- sockets
191
+ `-- vendor
192
+ |-- assets
193
+ `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.