data_active 0.0.1

data/features/update_database_with_xml.feature

@@ -0,0 +1,30 @@
+Feature: Update database with XML
+  As a Developer
+  I need to update the my database with an XML document
+  So that records in my database that share the same identify features as those in the XML are updated
+
+  Scenario: Attempting to update when some records have the same identifying features as those in teh XML Document
+    Given I have a fresh set of books
+    And I have the "features/support/fixtures/xml/books_changed.xml" file
+    When I update with "features/support/fixtures/xml/books_changed.xml"
+    Then the books with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+    And the chapters with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+    And the pages with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+
+
+  Scenario: Update when no records exist in the database
+    Given I have no books
+    And I have the "features/support/fixtures/xml/books_changed.xml" file
+    When I update with "features/support/fixtures/xml/books_changed.xml"
+    Then the books with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+    And the chapters with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+    And the pages with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+
+
+  Scenario: Update when records exist but there are no matching records in the database
+    Given I have no matching books
+    And I have the "features/support/fixtures/xml/books_changed.xml" file
+    When I update with "features/support/fixtures/xml/books_changed.xml"
+    Then the books with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+    And the chapters with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated
+    And the pages with the same identifying features as those in "features/support/fixtures/xml/books_changed.xml" will be updated

data/lib/data_active.rb

@@ -0,0 +1,309 @@
+require "data_active/version"
+
+module DataActive
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def ensure_unique(name)
+    begin
+      self[name] = yield
+    end while self.class.exists?(name => self[name])
+  end
+
+  VALID_FROM_XML_OPTIONS = [:sync, :create, :update, :destroy]
+
+  module ClassMethods
+    def many_from_xml(source_xml, options = [])
+      @data_active_options = options
+      many_from root_node_in source_xml
+    end
+
+    def many_from(current_node)
+      case
+        when self.name.pluralize.underscore.eql?(current_node.name.underscore)
+          many_from_rails_xml current_node
+
+        when (current_node.name.eql?('dataroot') \
+          and current_node.namespace_definitions.map { |ns| ns.href }.include?('urn:schemas-microsoft-com:officedata'))
+          # Identified as data generated from Microsoft Access
+          many_from_ms_xml current_node
+
+        when self.name.underscore.eql?(current_node.name.underscore)
+          raise "The supplied XML (#{current_node.name}) is a single instance of '#{self.name}'. Please use one_from_xml"
+
+        else
+          raise "The supplied XML (#{current_node.name}) cannot be mapped to this class (#{self.name})"
+
+      end
+    end
+
+    def many_from_ms_xml(current_node)
+      records = []
+      recorded_ids = []
+
+      current_node.element_children.each do |node|
+        if self.name.underscore.eql?(node.name.underscore)
+          record = self.one_from_xml(node, @data_active_options)
+          if record
+            recorded_ids << record[primary_key.to_sym]
+            records << record
+          end
+        end
+      end
+
+      remove_records_not_in recorded_ids
+
+      records
+    end
+
+    def many_from_rails_xml(current_node)
+      records = []
+      recorded_ids = []
+
+      current_node.element_children.each do |node|
+        record = self.one_from_xml(node, @data_active_options)
+        if record
+          recorded_ids << record[primary_key.to_sym]
+          records << record
+        end
+      end
+
+      remove_records_not_in recorded_ids
+
+      records
+    end
+
+    def remove_records_not_in(recorded_ids)
+      if @data_active_options.include?(:sync)
+        if recorded_ids.length > 0
+          self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
+        end
+      elsif @data_active_options.include?(:destroy)
+        if recorded_ids.length > 0
+          self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
+        else
+          self.destroy_all
+        end
+      end
+    end
+
+    def root_node_in(source_xml)
+      if source_xml.is_a?(String)
+        doc = Nokogiri::XML(source_xml)
+        doc.children.first
+      else
+        source_xml
+      end
+    end
+
+    def one_from_xml(source_xml, options = [])
+      @data_active_options = options
+
+      current_node = root_node_in source_xml
+
+      if current_node.name.underscore.eql?(self.name.underscore)
+        # Load or create a new record
+        pk_node = current_node.xpath self.primary_key.to_s
+
+        active_record = find_record_based_on(pk_node)
+
+
+        unless active_record.nil?
+          # Check through associations and apply sync appropriately
+          self.reflect_on_all_associations.each do |association|
+            foreign_key = foreign_key_from(association)
+            klass = association.klass
+
+            case
+              when association.macro == :has_many, association.macro == :has_and_belongs_to_many
+                instances = instances_for association, :from => current_node, :for => active_record
+
+                child_ids = []
+                instances.each do |instance|
+                  new_record = klass.one_from_xml(instance, options)
+                  if new_record != nil
+                    child_ids << new_record[klass.primary_key]
+                    active_record.__send__(klass.name.underscore.pluralize.to_sym) << new_record
+                  end
+                end
+
+                unless active_record.new_record?
+                  if options.include?(:sync) or options.include?(:destroy)
+                    if child_ids.length > 0
+                      klass.destroy_all [klass.primary_key.to_s + " not in (?) and #{foreign_key} = ?", child_ids.collect, active_record.attributes[self.primary_key.to_s]]
+                    else
+                      klass.destroy_all
+                    end
+                  end
+                end
+
+              when association.macro == :has_one
+                pk_value = active_record.new_record? ? 0 : active_record.attributes[self.primary_key.to_s]
+                single_objects = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{pk_value}]/#{association.name}")
+                klass = association.klass
+                record = klass.where(foreign_key => active_record.attributes[self.primary_key.to_s]).all
+                if single_objects.count == 1
+                  # Check to see if the already record exists
+                  if record.count == 1
+                    db_pk_value = record[0][klass.primary_key]
+                    xml_pk_value = Integer(single_objects[0].element_children.xpath("//#{self.name.underscore}/#{klass.primary_key}").text)
+
+                    if db_pk_value != xml_pk_value
+                      # Different record in xml
+                      if options.include?(:sync) or options.include?(:destroy)
+                        # Delete the one in the database
+                        klass.destroy(record[0][klass.primary_key])
+                      end
+                    end
+                  elsif record.count > 1
+                    raise "Too many records for one to one association in the database. Found #{record.count} records of '#{association.name}' for association with '#{self.name}'"
+                  end
+
+                  if options.include?(:create) or options.include?(:update) or options.include?(:sync)
+                    new_record = klass.one_from_xml(single_objects[0], options)
+                    if new_record != nil
+                      new_record[foreign_key.to_sym] = active_record[self.primary_key.to_s]
+                      new_record.save!
+                    end
+                  end
+                elsif single_objects.count > 1
+                  # There are more than one associations
+                  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}'"
+                else
+                  # There are no records in the XML
+                  if record.count > 0 and options.include?(:sync) or options.include?(:destroy)
+                    # Found some in the database: destroy then
+                    klass.destroy_all("#{foreign_key} = #{active_record.attributes[self.primary_key.to_s]}")
+                  end
+                end
+
+              when association.macro == :belongs_to
+
+              else
+                raise "unsupported association #{association.macro} for #{association.name  } on #{self.name}"
+            end
+          end
+
+          # Process the attributes
+          if options.include? :update or options.include? :sync or options.include? :create
+            assign_attributes_from current_node, :to => active_record
+          end
+
+          # Save the record
+          if options.include? :sync
+            # Doing complete synchronisation with XML
+            active_record.save
+          elsif options.include?(:create) and active_record.new_record?
+            active_record.save
+          elsif options.include?(:update) and not active_record.new_record?
+            active_record.save
+          end
+        end
+
+        active_record
+      else
+        raise "The supplied XML (#{current_node.name}) cannot be mapped to this class (#{self.name})"
+      end
+    end
+
+    def foreign_key_from(association)
+      if ActiveRecord::Reflection::AssociationReflection.method_defined? :foreign_key
+        # Support for Rails 3.1 and later
+        foreign_key = association.foreign_key
+      elsif ActiveRecord::Reflection::AssociationReflection.method_defined? :primary_key_name
+        # Support for Rails earlier than 3.1
+        foreign_key = association.primary_key_name
+      else
+        raise "Unsupported version of ActiveRecord. Unable to identify the foreign key."
+      end
+      foreign_key
+    end
+
+    def instances_for(association, options)
+      current_node = options[:from]
+      active_record = options[:for]
+
+      # Attempt to find instances which are in the following format
+      # <books>
+      #   <book>
+      #     ...
+      #   </book>
+      #   <book>
+      #     ...
+      #   </book>
+      # </books>
+      if active_record.new_record?
+        results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{current_node.xpath(self.primary_key.to_s).text}]/#{association.name}")
+      else
+        results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{active_record.attributes[self.primary_key.to_s]}]/#{association.name}")
+      end
+
+
+      if results.count.eql? 0
+        # Attempt to find instances which are in the following format
+        # <book>
+        #   ...
+        # </book>
+        if active_record.new_record?
+          results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{current_node.xpath(self.primary_key.to_s).text}]/#{association.name.to_s.singularize}")
+        else
+          results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{active_record.attributes[self.primary_key.to_s]}]/#{association.name.to_s.singularize}")
+        end
+      else
+        results = results.first.element_children
+      end
+
+      results
+    end
+
+    def assign_attributes_from(current_node, options)
+      record = options[:to]
+
+      record.attributes.each do |name, value|
+        attribute_nodes = current_node.xpath name.to_s
+        if attribute_nodes.count == 1
+          if attribute_nodes[0].attributes['nil'].try(:value)
+            record[name] = nil
+          else
+            record[name] = attribute_nodes[0].text
+          end
+        elsif attribute_nodes.count > 1
+          raise "Found duplicate elements in xml for active record attribute '#{name}'"
+        end
+      end
+    end
+
+    def find_record_based_on(pk_node)
+      ar = nil
+      if pk_node
+        begin
+          ar = find pk_node.text
+        rescue
+          # No record exists, create a new one
+          if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
+            ar = self.new
+          end
+        end
+      else
+        # No primary key value, must be a new record
+        if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
+          ar = self.new
+        end
+      end
+      ar
+    end
+
+    def xml_node_matches_class(xml_node)
+      if xml_node.attributes['type'].blank?
+        xml_node.name.underscore == self.name.underscore
+      else
+        xml_node.attributes['type'].value.underscore == self.name.underscore
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include DataActive
+end

data/lib/data_active/version.rb

@@ -0,0 +1,3 @@
+module DataActive
+  VERSION = "0.0.1"
+end

data/test_apps/book_store_rails_31x/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/test_apps/book_store_rails_31x/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p125@book_store_rails_31x --create

data/test_apps/book_store_rails_31x/Gemfile

@@ -0,0 +1,53 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.4'
+
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+gem 'data_active', '0.0.1'
+
+group :test do
+  gem 'cucumber'
+  gem 'cucumber-rails'
+end
+
+group :test, :development do
+  gem 'database_cleaner'
+  gem 'guard-cucumber'
+  gem 'growl_notify'
+end
+
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.1.5'
+  gem 'coffee-rails', '~> 3.1.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer'
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+group :test do
+  # Pretty printed test output
+  gem 'turn', '~> 0.8.3', :require => false
+end

data/test_apps/book_store_rails_31x/README

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.