relational_exporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 812375c407e516d9335f9de5ef56b1472bd67e2a
+  data.tar.gz: 05079ba3387f1a94910da2d2e9338883156e3bbf
+SHA512:
+  metadata.gz: bec4595a08715fb900cf95e6c3b7b647b8b5a3e996068e75aa9f19d39d06c00857a1af22480c45f230e103e892efadaba06349d8147872b2b5af7fe43a0cbdba
+  data.tar.gz: 70b0fe2eebfc33cfef4d5ceb2096a20a0dd7f03af68e9f51a117228a886940d05bd27ff5f536c1e2971f9337d2d5e3e072e46cb52ffcf5fbb86bcd67b3d57940

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in relational_exporter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Hammond
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# relational_exporter
+
+A gem to make it easy to export data from relational databases. RelationalExporter shines when your intended output is a "flat" CSV file, but your data is relational (each record can have multiple associated sub-records). Define your schema (once) in a familiar ActiveRecord-y way and leverage the robust model featureset. Once your schema is defined, define one or more output configurations which can be re-used to generate an export file.
+
+## TODO
+
+* Support multiple formats (currently only CSV)
+* Integrate serializers of some sort
+* Improve DSL
+* Clean up the code
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'relational_exporter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relational_exporter
+
+## Usage
+
+```ruby
+  # Define schemas
+  my_schema = {
+  	person: {
+  	  table_name: :person,
+  	  primary_key: :id,
+  	  has_many: {
+  	    addresses: nil,
+  	    emails: nil
+  	  },
+  	  has_one: {
+  	    avatar: [{ foreign_key: :ref_id }]
+  	  }
+  	},
+  	avatar: {
+  	  table_name: :avatar,
+  	  belongs_to: {
+  	    person: [{ foreign_key: :ref_id }]
+  	  }
+  	}
+  }
+
+  # Define output
+  my_output_config = {
+    format: :csv,
+    output: {
+      model: :person,
+      scope: {
+        where: "person.status = 'active'"
+      },
+      associations: {
+        emails: {},
+        avatar: {
+          scope: {
+            where: "ref_type like 'person'",
+            limit: 1,
+            order: "id desc"
+          }
+        }
+      }
+    }
+  }
+
+  # Define DB connection info
+  my_conn = {
+  	adapter: 'mysql2',
+  	host: ENV['DB_HOST'],
+  	username: ENV['DB_USER'],
+  	password: ENV['DB_PASS'],
+  	database: 'my_database'
+  }
+
+  # Run the export!
+  r = RelationalExporter::Runner.new schema: my_schema, connection_config: my_conn
+  r.export(my_output_config) do |record|
+    # modify the record and it's models/associations
+  end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/relational_exporter/active_record_extension.rb

@@ -0,0 +1,38 @@
+module ActiveRecordExtension
+  extend ActiveSupport::Concern
+
+  def find_all_by_scope(scope_hash={})
+    scope_hash = { where: {} } if scope_hash.nil?
+    the_scope = nil
+    scope_hash.each do |method, scoping|
+      if the_scope.nil?
+        the_scope = send method.to_sym, scoping
+      else
+        the_scope.send method.to_sym, scoping
+      end
+    end
+    the_scope
+  end
+
+  def set_scope_from_hash(scope_hash={}, clear_default_scope=false)
+    scope_hash = {} if scope_hash.nil?
+    clear_default_scopes if clear_default_scope
+
+    result = nil
+    scope_hash.each do |method, scoping|
+      if result.nil?
+        result = send method.to_sym, scoping
+      else
+        result.send method.to_sym, scoping
+      end
+    end
+
+    default_scope { result }
+  end
+
+  def clear_default_scopes
+    self.default_scopes = []
+  end
+end
+
+ActiveRecord::Base.send(:extend, ActiveRecordExtension)

data/lib/relational_exporter/version.rb

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

data/lib/relational_exporter.rb

@@ -0,0 +1,147 @@
+require 'byebug'
+require 'csv'
+require 'hashie'
+require 'relational_exporter/version'
+require 'relational_exporter/active_record_extension'
+
+module RelationalExporter
+  class Runner
+    attr_accessor :schema
+
+    def initialize(options={})
+      # TODO - disable when not byebugging!!!
+      ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+      @connection_config = options[:connection_config]
+      begin
+        ActiveRecord::Base.establish_connection @connection_config
+        ActiveRecord::Base.connection.active?
+      rescue Exception => e
+        raise "Database connection failed: #{e.message}"
+      end
+
+      @schema = Hashie::Mash.new(options[:schema] || YAML.load_file(options[:schema_file]))
+
+      load_models
+    end
+
+    def export(output_config, &block)
+      output_config = Hashie::Mash.new output_config
+
+      main_klass = output_config.output.model.to_s.classify.constantize
+
+      main_klass.set_scope_from_hash output_config.output.scope.as_json
+
+      header_row = []
+      max_associations = {}
+
+      ::CSV.open('/tmp/test.csv', 'wb', headers: true) do |csv|
+        main_klass.all.find_in_batches do |batch|
+          batch.each do |single|
+            if block_given?
+              yield single
+            end
+
+            row = []
+
+            # Add main record headers
+            single.attributes.each do |field, value|
+              header_row << [main_klass.to_s.underscore, field].join('_').classify if csv.header_row?
+              row << value
+            end
+
+            output_config.output.associations.each do |association_accessor, association_options|
+              association_accessor = association_accessor.to_s.to_sym
+              association_klass = association_accessor.to_s.classify.constantize
+              scope = symbolize_options association_options.scope
+
+              associated = single.send association_accessor
+              # TODO - this might suck for single associations (has_one) because they don't return an ar::associations::collectionproxy
+              associated = associated.find_all_by_scope(scope) unless scope.blank? || !associated.respond_to?(:find_all_by_scope)
+
+              if associated.is_a? Hash
+                associated = [ associated ]
+              elsif associated.blank?
+                associated = []
+              end
+
+              foreign_key = main_klass.reflections[association_accessor].foreign_key rescue nil
+
+              fields = association_klass.first.attributes.keys
+
+              fields.reject! {|v| v == foreign_key } if foreign_key
+
+              if csv.header_row?
+                case main_klass.reflections[association_accessor].macro
+                when :has_many
+                  max_associated = association_klass.find_all_by_scope(scope)
+                                                    .joins(main_klass.table_name.to_sym)
+                                                    .order('count_all desc')
+                                                    .group(foreign_key)
+                                                    .limit(1).count.flatten[1]
+                when :has_one
+                  max_associated = 1
+                end
+
+                max_associations[association_accessor] = max_associated
+
+                max_associated.times do |i|
+                  fields.each do |field|
+                    header_row << [association_klass.to_s.underscore, i+1, field].join('_').classify
+                  end
+                end
+              end
+
+              get_row_arr(associated, fields, max_associations[association_accessor]) {|field| row << field}
+            end
+
+            csv << header_row if csv.header_row?
+            if row.count != header_row.count
+              puts "OH SHIT, this row is not right!"
+              byebug
+            end
+            csv << row
+          end
+        end
+      end
+    end
+
+    private
+
+    def get_row_arr(records, fields, max_count=1, &block)
+      max_count.times do |i|
+        fields.each do |field|
+          val = records[i][field] rescue nil
+          yield val
+        end
+      end
+    end
+
+    def symbolize_options(options)
+      options = options.as_json
+      if options.is_a? Hash
+        options.deep_symbolize_keys!
+      elsif options.is_a? Array
+        options.map { |val| symbolize_options val }
+      end
+    end
+
+    def load_models
+      @schema.each do |model, options|
+        klass = Object.const_set model.to_s.classify, Class.new(ActiveRecord::Base)
+        # klass.extend ActiveRecordExtension
+        options.each do |method, calls|
+          method = "#{method}=".to_sym if klass.respond_to?("#{method}=")
+          if calls.respond_to? :each_pair
+            calls.each do |association, association_options|
+              association_options = symbolize_options association_options
+              klass.send method, association.to_sym, *association_options
+            end
+          else
+            klass.send method, *calls
+          end
+        end
+      end
+    end
+  end
+end

data/relational_exporter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relational_exporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'relational_exporter'
+  spec.version       = RelationalExporter::VERSION
+  spec.authors       = ['Andrew Hammond']
+  spec.email         = ['andrew@tremorlab.com']
+  spec.description   = %q{Export relational databases as flat files}
+  spec.summary       = %q{Export relational databases as flat files}
+  spec.homepage      = 'http://github.com/andrhamm'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'byebug'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: relational_exporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Hammond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Export relational databases as flat files
+email:
+- andrew@tremorlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/relational_exporter.rb
+- lib/relational_exporter/active_record_extension.rb
+- lib/relational_exporter/version.rb
+- relational_exporter.gemspec
+homepage: http://github.com/andrhamm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Export relational databases as flat files
+test_files: []
+has_rdoc: