db_to_file 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5be7f37b637cad13b6c873c22fd7513697f39c9
+  data.tar.gz: bb24640e221dfd4bb0bc126e312181279b11f91b
+SHA512:
+  metadata.gz: ac169b0f083355209e9f2d4281fc5b9b57e3ab4d34dd50d8caafa1a3f5152937416e153ecf6ee635f8f51e2e9372eb099ec1d6fa2a031b2ac244b0725a08cb27
+  data.tar.gz: 8d56efd2cad35ed1a07f8457845274719c11353bd7608baaa0100fd79c0af337e252e0db44250a17b4da04aaf7a48394f8cbec5ffef1decc46379f55d0312ee1

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 db_to_file.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ewout Quax
+
+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,29 @@
+# DbToFile
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'db_to_file'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install db_to_file
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/db_to_file/fork )
+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,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/db_to_file'
+  t.test_files = FileList[
+    'test/lib/db_to_file/**/*_test.rb'
+  ]
+  t.verbose = true
+end
+

data/db/database.yml

@@ -0,0 +1,2 @@
+adapter: 'sqlite3'
+database: 'db/test.sqlite3'

data/db_to_file.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_to_file/version'
+Gem::Specification.new do |spec|
+  spec.name          = "db_to_file"
+  spec.version       = DbToFile::VERSION
+  spec.authors       = ["Ewout Quax"]
+  spec.email         = ["ewout.quax@quicknet.nl"]
+  spec.summary       = %q{Unload and upload database-tables to a file-system}
+  spec.description   = %q{Unload and upload database-tables to a file-system}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'activerecord', '> 3.2.0'
+  spec.add_dependency 'activesupport', '> 3.2.0'
+  spec.add_dependency 'git', '> 1.2.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "minitest", "~> 4.7.3"
+  spec.add_development_dependency 'minitest-reporters', '>= 0.5.0'
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'turn'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/db_to_file.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'active_support/inflector'
+require 'git'
+require 'db_to_file/config'
+require 'db_to_file/version'
+require 'db_to_file/version_controller'
+require 'db_to_file/unloader'
+require 'db_to_file/uploader'
+require 'db_to_file/values_normalizer/object_to_hash'
+require 'db_to_file/values_normalizer/value_into_object'
+require 'db_to_file/system_executer'
+
+module DbToFile
+  if defined?(Rails)
+    require 'db_to_file/railtie'
+  else
+    require 'yaml'
+    dbconfig = YAML::load(File.open('db/database.yml'))
+    ActiveRecord::Base.establish_connection(dbconfig)
+  end
+end

data/lib/db_to_file/config.rb

@@ -0,0 +1,56 @@
+require 'singleton'
+
+module DbToFile
+  class Config
+    include Singleton
+
+    def self.instance
+      @@instance ||= new
+    end
+
+    def initialize
+      @data = load_config
+    end
+
+    def tables
+      data['tables'].keys
+    end
+
+    def field_extension(table_name, field_name)
+      begin
+        data['tables'][table_name]['field_extensions'][field_name]
+      rescue NoMethodError
+        nil
+      end
+    end
+
+    def ignore_columns(table_name)
+      begin
+        data['tables'][table_name]['ignore_columns']
+      rescue NoMethodError
+        nil
+      end
+    end
+
+    def directory_prefix(table_name)
+      begin
+        data['tables'][table_name]['directory_prefix']
+      rescue NoMethodError
+        nil
+      end
+    end
+
+    def data
+      @data
+    end
+
+    private
+      def load_config
+        YAML::load(File.read(config_file))
+      end
+
+      def config_file
+        'config/db_to_file.yml'
+      end
+  end
+end

data/lib/db_to_file/railtie.rb

@@ -0,0 +1,12 @@
+require 'db_to_file'
+require 'rails'
+module DbToFile
+  class Railtie < Rails::Railtie
+    railtie_name :db_to_file
+
+    rake_tasks do
+      load "tasks/unloader.rake"
+      load "tasks/uploader.rake"
+    end
+  end
+end

data/lib/db_to_file/system_executer.rb

@@ -0,0 +1,16 @@
+module DbToFile
+  class SystemExecuter
+    def initialize(command)
+      self.command = command
+    end
+
+    def command=(command)
+      @command = command
+    end
+
+    def execute
+      puts "Execute command: #{@command}"
+      `#{@command}`
+    end
+  end
+end

data/lib/db_to_file/unloader.rb

@@ -0,0 +1,151 @@
+module DbToFile
+  class Unloader
+    def initialize
+      # Load config and build database connection, before stashing possible changes
+      @config ||= config
+      ActiveRecord::Base.connection.tables
+    end
+
+    def unload
+      prepare_code_version
+      unload_tables
+      update_code_version
+      restore_local_stash
+    end
+
+    private
+      def prepare_code_version
+        version_controller.prepare_code_version
+      end
+
+      def unload_tables
+        puts 'Start downloading tables'
+        tables.each do |table_name|
+          puts "Downloading table '#{table_name}'"
+          Table.new(table_name, self).unload
+        end
+        puts 'Done downloading tables'
+      end
+
+      def update_code_version
+        puts 'Start updating code version'
+        version_controller.update_code_version
+        puts 'Done updating code version'
+      end
+
+      def restore_local_stash
+        version_controller.restore_local_stash
+      end
+
+      def version_controller
+        @version_controller ||= VersionController.new
+      end
+
+      def tables
+        config.tables
+      end
+
+      def config
+        Config.instance
+      end
+
+      class Table
+        def initialize(table_name, unloader)
+          @table    = table_name.singularize.classify.constantize
+          @unloader = unloader
+        end
+
+        def unload
+          @table.all.each do |row|
+            Record.new(row, self).fields_to_files
+          end
+        end
+
+        private
+          class Record
+            def initialize(row, table)
+              @row   = row
+              @table = table
+            end
+
+            def fields_to_files
+              build_directory
+
+              normalized_hash = DbToFile::ValuesNormalizer::ObjectToHash.new(@row).normalize
+              normalized_hash.except(*ignore_columns).each_pair do |field_name, value|
+                Field.new(field_name, self).write_value(value)
+              end
+            end
+
+            private
+              def build_directory
+                FileUtils.mkdir_p(base_dir)
+              end
+
+              def ignore_columns
+                config.ignore_columns(table_name)
+              end
+
+              def base_dir
+                "db/db_to_file/#{table_name}/#{row_name}"
+              end
+
+              def row_name
+                [directory_prefix, @row.id.to_s].compact.reject(&:empty?).join('_')
+              end
+
+              def directory_prefix
+                if config_directory_prefix.present?
+                  (@row.send(config_directory_prefix) || '').parameterize
+                end
+              end
+
+              def config_directory_prefix
+                config.directory_prefix(table_name)
+              end
+
+              def table_name
+                @row.class.table_name
+              end
+
+              def config
+                Config.instance
+              end
+
+              class Field
+                def initialize(field_name, record)
+                  @field_name = field_name
+                  @record     = record
+                end
+
+                def write_value(value)
+                  handle = File.open(full_file_path, 'w')
+                  handle.write(value)
+                  handle.close
+                end
+
+                private
+                  def full_file_path
+                    File.join(@record.send(:base_dir), file_with_extension)
+                  end
+
+                  def file_with_extension
+                    if (extension = config_field_extension).present?
+                      "#{@field_name}.#{extension}"
+                    else
+                      @field_name
+                    end
+                  end
+
+                  def config_field_extension
+                    config.field_extension(@record.send(:table_name), @field_name)
+                  end
+
+                  def config
+                    Config.instance
+                  end
+              end
+          end
+      end
+  end
+end

data/lib/db_to_file/uploader.rb

@@ -0,0 +1,128 @@
+module DbToFile
+  class Uploader
+    def upload(commit_message)
+      if can_continue?
+        invoke_unloader
+      end
+      if can_continue?
+        write_objects_to_db
+        update_code_version(commit_message)
+      end
+    end
+
+    def force_upload
+      write_objects_to_db
+    end
+
+    def force_changed
+      write_changed_objects_to_db
+    end
+
+    private
+    def invoke_unloader
+      Unloader.new.unload
+    end
+
+    def can_continue?
+      !merge_conflicts_present?
+    end
+
+    def merge_conflicts_present?
+      version_controller.merge_conflicts_present?
+    end
+
+    def write_objects_to_db
+      objects.each(&:save!)
+    end
+
+    def write_changed_objects_to_db
+      changed_objects.each(&:save!)
+    end
+
+    def update_code_version(commit_message)
+      version_controller.update_code_version(commit_message)
+    end
+
+    def objects
+      @objects ||= build_objects
+    end
+
+    def changed_objects
+      @changed_objects ||= build_objects(true)
+    end
+
+    def build_objects(changed_only = false)
+      objects = []
+      files = changed_only ? (version_controller.get_modified_file_list & read_files) : read_files
+      files.each do |model_field_file|
+        data_segments = extract_data_segments(model_field_file)
+        model = data_segments[:model]
+        # find existing object
+        object = objects.detect do |existing_object|
+          existing_object.class == model && existing_object.id == data_segments[:id]
+        end
+        # build new object
+        unless object
+          object = model.find_by_id(data_segments[:id]) || model.new(id: data_segments[:id])
+          objects << object
+        end
+        # set field-value to model
+        update_object_with_field_value(object, data_segments[:field], model_field_file)
+      end
+
+      objects
+    end
+
+    def update_object_with_field_value(object, field, model_field_file)
+      value = file_value(model_field_file)
+      DbToFile::ValuesNormalizer::ValueIntoObject.new(object).normalize(field, value)
+    end
+
+    def file_value(model_field_file)
+      File.read(model_field_file)
+    end
+
+    def extract_data_segments(model_field_file)
+      matches = model_field_file.split('/').last(3)
+
+      {
+          model: matches[0].singularize.classify.constantize,
+          id:    matches[1].split('_').last.to_i,
+          field: strip_extension(matches[2])
+      }
+    end
+
+    def read_files
+      files_in_dir(File.join('db', 'db_to_file'))
+    end
+
+    def files_in_dir(folder)
+      files = Dir.entries(folder)
+
+      found_files = []
+      files.each do |file|
+        full_file = File.join([folder, file])
+        if File.directory?(full_file) && file[0] != '.'
+          subdir = File.join(folder, file)
+          files_in_dir(subdir).each do |subdirfile|
+            found_files << subdirfile
+          end
+        end
+        if File.file?(full_file)
+          found_files << full_file
+        end
+      end
+
+      found_files
+    end
+
+    def version_controller
+      @version_controller ||= VersionController.new
+    end
+
+    private
+      def strip_extension(file_with_extension)
+        file_with_extension.split('.')[0]
+      end
+  end
+end