fidius-common 0.0.3 → 0.0.4beta0

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 doc/
 .yardoc/
+coverage/

data/CREDITS.md

@@ -3,3 +3,12 @@ Third-party tools
 * `lib/fidius-common/ip-helper.rb`: `get_my_ip` methods
   * Credit goes to Coderr
   * https://coderrr.wordpress.com/2008/05/28/get-your-local-ip-address/
+
+* `lib/fidius-common/yamldb/serialization_helper.rb` and
+  `lib/fidius-common/yamldb/yaml_db.rb`
+  * Copied and modified from yamldb-gem
+  * Credits:
+    * Created by Orion Henry and Adam Wiggins.
+    * Major updates by Ricardo Chimal, Jr.
+    * Patches contributed by Michael Irwin, Tom Locke, and Tim Galeckas.
+  * https://github.com/ludicast/yaml_db

data/Rakefile

@@ -20,7 +20,9 @@ begin
       '--private',   # include private methods
       '--protected', # include protected methods
       '--files', static_files,
-      '--readme', 'README.md'
+      '--readme', 'README.md',
+      '--exclude', 'lib/fidius-common/yamldb/serialization_helper.rb',
+      '--exclude', 'lib/fidius-common/yamldb/yaml_db.rb'
     ]
   end
 rescue LoadError

data/fidius-common.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+  s.add_development_dependency 'simplecov', '>= 0.4.0'
   s.add_runtime_dependency 'activesupport', '>= 3.0.0'
 
   s.rdoc_options << '--title' << s.name <<

data/lib/fidius-common/version.rb

@@ -2,7 +2,7 @@ module FIDIUS
   module Common
 
     # Current version number
-    VERSION = "0.0.3"
+    VERSION = "0.0.4beta0"
 
   end # module Common
 end # module FIDIUS

data/lib/fidius-common/yamldb/serialization_helper.rb

@@ -0,0 +1,255 @@
+# Copied and modified from yamldb gem (https://github.com/ludicast/yaml_db)
+#
+# Credits:
+# Created by Orion Henry and Adam Wiggins.
+# Major updates by Ricardo Chimal, Jr.
+# Patches contributed by Michael Irwin, Tom Locke, and Tim Galeckas.
+#
+#This module deals with the serialization of the database schema and
+#tables. It was extended by the establishment of the ActiveRecord
+#connection to use the module without a Rails environment.
+#
+# dump_schema and load-schema are modified ActiveRecord rake-tasks.
+
+module SerializationHelper
+
+  class Base
+    attr_reader :extension
+
+    def initialize(helper, config_filename, db_entry)
+      @dumper = helper.dumper
+      @loader = helper.loader
+      @extension = helper.extension
+
+      establish_connection(config_filename, db_entry)
+    end
+
+    # Set configuration for the ActiveRecord connection.
+    #
+    # @param [String] path to yaml configuration file
+    # @param [String] name of the db entry in the configuration file
+    def establish_connection(yml_file, db_entry)
+      if yml_file.class == String
+        raise "#{yml_file} does not exist" unless File.exists? File.expand_path(yml_file)
+        yml_config = YAML.load(File.read(yml_file))
+        db_config = yml_config[db_entry]
+      elsif yml_file.class == Hash
+        # also react on connection settings given as hash
+        db_config = yml_file
+      else
+        raise "please input string or hash"
+      end
+      unless db_config
+        raise "No entry '#{db_entry}' found in #{yml_file}"
+      else
+        @db_entry = db_entry
+        ActiveRecord::Base.establish_connection db_config
+        ActiveRecord::Base.connection
+      end
+    end
+
+    # copied and modified activerecord-3.0.6/lib/active_record/railties/database.rake
+    def dump_schema
+      require 'active_record/schema_dumper'
+      File.open(File.join(@data_dir ,'schema.rb'), "w") do |file|
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+
+    def load_schema
+      file = File.join(@data_dir ,'schema.rb')
+      if File.exists?(file)
+        ActiveSupport::Dependencies::Loadable.load(file)
+      else
+        puts "#{file} does not exist"
+      end
+    end
+
+    # Added creation of directories with timestamps.
+    # @param [String] path to target dir
+    # @param [Boolean] true, if timestamp should be added
+    def dump(target_dir, timestamp)
+      unless target_dir.empty? and !Dir.exists?(target_dir)
+        target_dir += '/'
+      end
+      dir = target_dir + @db_entry
+      if timestamp
+        timestamp = Time.now
+        dir += "_#{timestamp.strftime("%Y-%m-%d_%H%M%S")}"
+      end
+
+      Dir.mkdir dir
+      @data_dir = File.expand_path(dir)
+      @data_filename = "#{@data_dir}/#{@db_entry}.#{@extension}"
+
+      disable_logger
+      dump_schema
+      @dumper.dump(File.new(@data_filename, "w"))
+      reenable_logger
+      @data_dir
+    end
+
+    def load(import_dir ,truncate = true)
+      if Dir.exists? import_dir
+        @data_dir = import_dir
+        disable_logger
+        load_schema
+        @loader.load(File.new("#{@data_dir}/#{@db_entry}.#{@extension}", "r"), truncate)
+        reenable_logger
+      else
+        puts "#{import_dir} does not exist!"
+      end
+    end
+
+    def disable_logger
+      @@old_logger = ActiveRecord::Base.logger
+      ActiveRecord::Base.logger = nil
+    end
+
+    def reenable_logger
+      ActiveRecord::Base.logger = @@old_logger
+    end
+  end
+
+  class Load
+    def self.load(io, truncate = true)
+      ActiveRecord::Base.connection.transaction do
+        load_documents(io, truncate)
+      end
+    end
+
+    def self.truncate_table(table)
+      begin
+        ActiveRecord::Base.connection.execute("TRUNCATE #{SerializationHelper::Utils.quote_table(table)}")
+      rescue Exception
+        ActiveRecord::Base.connection.execute("DELETE FROM #{SerializationHelper::Utils.quote_table(table)}")
+      end
+    end
+
+    def self.load_table(table, data, truncate = true)
+      column_names = data['columns']
+      if truncate
+        truncate_table(table)
+      end
+      load_records(table, column_names, data['records'])
+      reset_pk_sequence!(table)
+    end
+
+    def self.load_records(table, column_names, records)
+      if column_names.nil?
+        return
+      end
+      columns = column_names.map{|cn| ActiveRecord::Base.connection.columns(table).detect{|c| c.name == cn}}
+      quoted_column_names = column_names.map { |column| ActiveRecord::Base.connection.quote_column_name(column) }.join(',')
+      quoted_table_name = SerializationHelper::Utils.quote_table(table)
+      records.each do |record|
+        quoted_values = record.zip(columns).map{|c| ActiveRecord::Base.connection.quote(c.first, c.last)}.join(',')
+        ActiveRecord::Base.connection.execute("INSERT INTO #{quoted_table_name} (#{quoted_column_names}) VALUES (#{quoted_values})")
+      end
+    end
+
+    def self.reset_pk_sequence!(table_name)
+      if ActiveRecord::Base.connection.respond_to?(:reset_pk_sequence!)
+        ActiveRecord::Base.connection.reset_pk_sequence!(table_name)
+      end
+    end
+
+
+  end
+
+  module Utils
+
+    def self.unhash(hash, keys)
+      keys.map { |key| hash[key] }
+    end
+
+    def self.unhash_records(records, keys)
+      records.each_with_index do |record, index|
+        records[index] = unhash(record, keys)
+      end
+
+      records
+    end
+
+    def self.convert_booleans(records, columns)
+      records.each do |record|
+        columns.each do |column|
+          next if is_boolean(record[column])
+          record[column] = (record[column] == 't' or record[column] == '1')
+        end
+      end
+      records
+    end
+
+    def self.boolean_columns(table)
+      columns = ActiveRecord::Base.connection.columns(table).reject { |c| silence_warnings { c.type != :boolean } }
+      columns.map { |c| c.name }
+    end
+
+    def self.is_boolean(value)
+      value.kind_of?(TrueClass) or value.kind_of?(FalseClass)
+    end
+
+    def self.quote_table(table)
+      ActiveRecord::Base.connection.quote_table_name(table)
+    end
+
+  end
+
+  class Dump
+    def self.before_table(io, table)
+
+    end
+
+    def self.dump(io)
+      tables.each do |table|
+        before_table(io, table)
+        dump_table(io, table)
+        after_table(io, table)
+      end
+    end
+
+    def self.after_table(io, table)
+
+    end
+
+    def self.tables
+      ActiveRecord::Base.connection.tables.reject { |table| ['schema_info', 'schema_migrations'].include?(table) }
+    end
+
+    def self.dump_table(io, table)
+      return if table_record_count(table).zero?
+
+      dump_table_columns(io, table)
+      dump_table_records(io, table)
+    end
+
+    def self.table_column_names(table)
+      ActiveRecord::Base.connection.columns(table).map { |c| c.name }
+    end
+
+
+    def self.each_table_page(table, records_per_page=1000)
+      total_count = table_record_count(table)
+      pages = (total_count.to_f / records_per_page).ceil - 1
+      id = table_column_names(table).first
+      boolean_columns = SerializationHelper::Utils.boolean_columns(table)
+      quoted_table_name = SerializationHelper::Utils.quote_table(table)
+
+      (0..pages).to_a.each do |page|
+        sql = ActiveRecord::Base.connection.add_limit_offset!("SELECT * FROM #{quoted_table_name} ORDER BY #{id}",
+                                                              :limit => records_per_page, :offset => records_per_page * page
+                                                              )
+        records = ActiveRecord::Base.connection.select_all(sql)
+        records = SerializationHelper::Utils.convert_booleans(records, boolean_columns)
+        yield records
+      end
+    end
+
+    def self.table_record_count(table)
+      ActiveRecord::Base.connection.select_one("SELECT COUNT(*) FROM #{SerializationHelper::Utils.quote_table(table)}").values.first.to_i
+    end
+
+  end
+
+end

data/lib/fidius-common/yamldb/yaml_db.rb

@@ -0,0 +1,72 @@
+#Copied and modified from yamldb gem (https://github.com/ludicast/yaml_db)
+#
+# Credits:
+# Created by Orion Henry and Adam Wiggins.
+# Major updates by Ricardo Chimal, Jr.
+# Patches contributed by Michael Irwin, Tom Locke, and Tim Galeckas.
+
+require 'yaml'
+require 'active_record'
+require 'fidius-common/yamldb/serialization_helper'
+require 'active_support/core_ext/kernel/reporting'
+
+module YamlDb
+  module Helper
+    def self.loader
+      YamlDb::Load
+    end
+
+    def self.dumper
+      YamlDb::Dump
+    end
+
+    def self.extension
+      "yml"
+    end
+  end
+
+
+  module Utils
+    def self.chunk_records(records)
+      yaml = [ records ].to_yaml
+      yaml.sub!("--- \n", "")
+      yaml.sub!('- - -', '  - -')
+      yaml
+    end
+  end
+
+  class Dump < SerializationHelper::Dump
+
+    def self.dump_table_columns(io, table)
+      io.write("\n")
+      io.write({ table => { 'columns' => table_column_names(table) } }.to_yaml)
+    end
+
+    def self.dump_table_records(io, table)
+      table_record_header(io)
+
+      column_names = table_column_names(table)
+
+      each_table_page(table) do |records|
+        rows = SerializationHelper::Utils.unhash_records(records, column_names)
+        io.write(YamlDb::Utils.chunk_records(records))
+      end
+    end
+
+    def self.table_record_header(io)
+      io.write("  records: \n")
+    end
+
+  end
+
+  class Load < SerializationHelper::Load
+    def self.load_documents(io, truncate = true)
+      YAML.load_documents(io) do |ydoc|
+        ydoc.keys.each do |table_name|
+          next if ydoc[table_name].nil?
+          load_table(table_name, ydoc[table_name], truncate)
+        end
+      end
+    end
+  end
+end

data/lib/fidius-common/yamldb.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+require "fidius-common/yamldb/yaml_db"
+
+module FIDIUS
+  module Common
+    # Provides methods for the export/import of database dumps to/from YAML.
+    module Db
+      # Exports database schema and content to yml file. This should work
+      # for all ActiveRecord database adapters.
+      #
+      # @param [String] path to yml file with database configuration
+      # @param [String] name of the db to export, must match an entry in the yml configuration file.
+      # @param [String] target dir where the exported data should be stored
+      # @param [Boolean] create target dir with timestamp in the dirname
+      def self.export(config_filename, db_entry, target_dir = "", timestamp = true)
+        dumper = SerializationHelper::Base.new(YamlDb::Helper, config_filename, db_entry)
+        dumper.dump(target_dir, timestamp)
+      end
+
+      # Imports the content of a previously exported yml file.
+      #
+      # @param [String] path to yml file with database configuration
+      # @param [String] name of the db to export, must match an entry in the yml configuration file.
+      # @param [String] dir to the previously exported yml file
+      def self.import(config_filename, db_entry, import_dir)
+        loader = SerializationHelper::Base.new(YamlDb::Helper, config_filename, db_entry)
+        loader.load(import_dir)
+      end
+    end
+  end
+end

data/lib/fidius-common.rb

@@ -7,9 +7,10 @@ module FIDIUS
   # non-FIDIUS context, since there are no other FIDIUS-related
   # dependencies.
   module Common
-  
-    autoload :VERSION, './fidius-common/version'
-    
+
+    autoload :VERSION, 'fidius-common/version'
+    autoload :Db,      'fidius-common/yamldb'
+
     # Since this addon changes behaviour of +to_json+, you have to
     # require it explicitly either with this helper method or manually
     # with
@@ -24,6 +25,6 @@ module FIDIUS
     def self.install_json_symbol_addon
       require 'fidius-common/json_symbol_addon'
     end
-  
+
   end # module Common
 end # module FIDIUS

data/test/t_helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.start
+require 'test/unit'
+

data/test/test_iphelper.rb

@@ -1,5 +1,5 @@
+require 't_helper'
 require 'fidius-common/ip-helper'
-require 'test/unit'
 
 class IPHelperTest < Test::Unit::TestCase
   def test_get_localhost

data/test/test_json_addon.rb

@@ -1,5 +1,5 @@
+require 't_helper'
 require 'fidius-common/json_symbol_addon'
-require 'test/unit'
 
 
 class JSONSymbolAddonTest < Test::Unit::TestCase

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: fidius-common
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4beta0
+  version: 0.0.4beta0
 platform: ruby
 authors: 
 - Dominik Menke
@@ -15,13 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 +01:00
+date: 2011-04-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: simplecov
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,7 +47,7 @@ dependencies:
         - 0
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 description: |-
   Common useful libraries and methods for the FIDIUS C&C server, the FIDIUS 'architecture' and maybe other components.
   
@@ -59,6 +74,10 @@ files:
 - lib/fidius-common/ip-helper.rb
 - lib/fidius-common/json_symbol_addon.rb
 - lib/fidius-common/version.rb
+- lib/fidius-common/yamldb.rb
+- lib/fidius-common/yamldb/serialization_helper.rb
+- lib/fidius-common/yamldb/yaml_db.rb
+- test/t_helper.rb
 - test/test_iphelper.rb
 - test/test_json_addon.rb
 has_rdoc: true
@@ -76,6 +95,9 @@ rdoc_options:
   - lib/fidius-common/ip-helper.rb
   - lib/fidius-common/json_symbol_addon.rb
   - lib/fidius-common/version.rb
+  - lib/fidius-common/yamldb.rb
+  - lib/fidius-common/yamldb/serialization_helper.rb
+  - lib/fidius-common/yamldb/yaml_db.rb
 - README.md
 - LICENSE
 - CREDITS.md
@@ -92,11 +114,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: ""