dumpable 0.1.2 → 0.2.0

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem "rails"
+gem "hashie"
 
 group :development do
   gem "shoulda", ">= 0"

data/README.rdoc

@@ -1,19 +1,54 @@
 = dumpable
 
-Description goes here.
-
-== Contributing to dumpable
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+Output all the sql commands necessary to generate a database row and its relationships.
+
+== Usage
+  class User < ActiveRecord::Base
+    has_many :posts
+    has_many :roles
+
+    dumpable [:roles, {:posts => :comments}]
+  end
+
+  class Role < ActiveRecord::Base
+    belongs_to :user
+  end
+
+  class Post < ActiveRecord::Base
+    has_many :comments
+  end
+
+  class Comments < ActiveRecord::Base
+    belongs_to :post
+  end
+
+Then, from the console, you can do something like:
+  User.first.dump
+This will spit out all the MySQL insertion code for the user, it's roles, it's posts, and each post's comments
+
+If you want all to pad the ids generated in the insertion code, this can be done as follows:
+  User.first.dump(:id_padding => 1000)
+This will ensure that the id of the above user is padded by 1000, so a user id of 1 will generate an insert statement with an id of 1001.
+
+You may wonder why the id is included as part of the insert statement. This is to ensure that all associations maintain their relations to one another.
+For example, if TODO
+
+All ActiveRecord models are dumpable automatically, so you could also call:
+  Post.dump
+
+You can also dump all the entries in the table by calling:
+  Post.dump
+  # or
+  Post.where(:published => true).dump
+
+== Gotchas
+At the moment, Dumpable will not work on any complex relationships. This includes has_many :through, and has_and_belongs_to_many.
+It also will not work on models that have a different primary key than id or on models with complex keys.
+
+It is also only setup to work with MySQL databases and is untested with any other databases.
+>>>>>>> Regenerate gemspec for version 0.2.0
 
 == Copyright
 
 Copyright (c) 2013 Andrew Hunter. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/dumpable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "dumpable"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Hunter"]
-  s.date = "2013-06-21"
+  s.date = "2013-11-06"
   s.description = "Generate the SQL to insert a single record and all of its dependencies"
   s.email = "andrew.hunter@livingsocial.com"
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".document",
     ".ruby-gemset",
     ".ruby-version",
+    "CHANGELOG.rdoc",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
@@ -27,8 +28,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "dumpable.gemspec",
     "lib/dumpable.rb",
-    "test/helper.rb",
-    "test/test_dumpable.rb"
+    "lib/dumpable/active_record_extensions.rb",
+    "lib/dumpable/dumper.rb",
+    "lib/dumpable/file_writer.rb",
+    "test/helper.rb"
   ]
   s.homepage = "http://github.com/hunterae/dumpable"
   s.licenses = ["MIT"]
@@ -41,12 +44,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
@@ -54,6 +59,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])

data/lib/dumpable/active_record_extensions.rb

@@ -0,0 +1,22 @@
+module Dumpable
+  module ActiveRecordExtensions
+    extend ActiveSupport::Concern
+
+    def dump(options={})
+      Dumpable::Dumper.dump(self, options)
+    end
+
+    module ClassMethods
+      def dumpable(options={})
+        class_eval do
+          cattr_accessor :dumpable_options
+        end
+        self.dumpable_options = Dumpable.config.merge(options)
+      end
+
+      def dump(options={})
+        Dumpable::Dumper.dump(self, options)
+      end
+    end
+  end
+end

data/lib/dumpable/dumper.rb

@@ -0,0 +1,96 @@
+module Dumpable
+  class Dumper
+    attr_accessor :dumpee, :options, :id_padding, :dumps
+
+    def initialize(dumpee, options)
+      @dumpee = dumpee
+      @options = options
+      @id_padding = @options[:id_padding] || (@dumpee.class.respond_to?(:dumpable_options) && @dumpee.class.dumpable_options[:id_padding]) || Dumpable.config.id_padding
+      @dumps = @options[:dumps] || (@dumpee.class.respond_to?(:dumpable_options) && @dumpee.class.dumpable_options[:dumps])
+      @lines = []
+    end
+
+    def dump
+      recursive_dump(@dumpee, @dumps)
+      @lines << generate_insert_query(@dumpee)
+    end
+
+    def self.dump(*records_and_collections)
+      options = records_and_collections.extract_options!
+      lines = []
+      records_and_collections.each do |record_or_collection|
+        if record_or_collection.is_a?(Array) || record_or_collection.is_a?(ActiveRecord::Relation) || (record_or_collection.is_a?(Class) && record_or_collection.ancestors.include?(ActiveRecord::Base))
+          record_or_collection = record_or_collection.all if record_or_collection.is_a?(Class) && record_or_collection.ancestors.include?(ActiveRecord::Base)
+          record_or_collection.each do |object|
+            lines << new(object, options).dump
+          end
+        else
+          lines << new(record_or_collection, options).dump
+        end
+      end
+      Dumpable::FileWriter.write(lines.flatten.compact, options)
+    end
+
+    private
+    def recursive_dump(object, dumps)
+      if dumps.nil?
+
+      elsif dumps.is_a?(Array)
+        dumps.each do |mini_dump|
+          recursive_dump(object, mini_dump)
+        end
+      elsif dumps.is_a?(Hash)
+        dumps.each do |key, value|
+          recursive_dump(object, key)
+          Array(object.send(key)).each { |child| recursive_dump(child, value) }
+        end
+      elsif dumps.is_a?(Symbol) || dumps.is_a?(String)
+        Array(object.send(dumps)).each do |child_object|
+          reflection = object.class.reflections[dumps]
+          if reflection.macro == :belongs_to
+            object.send("#{reflection.association_foreign_key}=", object.id + @id_padding)
+          elsif [:has_many, :has_one].include? reflection.macro
+            if reflection.respond_to?(:foreign_key)
+              child_object.send("#{reflection.foreign_key}=", object.id + @id_padding)
+            else
+              child_object.send("#{reflection.primary_key_name}=", object.id + @id_padding)
+            end
+          end
+          @lines << generate_insert_query(child_object)
+        end
+      end
+    end
+
+    # http://invisipunk.blogspot.com/2008/04/activerecord-raw-insertupdate.html
+    def generate_insert_query(object)
+      cloned_attributes = object.attributes.clone
+      return nil unless cloned_attributes["id"].present?
+      cloned_attributes["id"] += @id_padding
+      key_values = cloned_attributes.collect{ |key,value| [key, dump_value_string(value)] }
+      keys = key_values.collect{ |item| item[0].to_s }.join(", ")
+      values = key_values.collect{ |item| item[1].to_s }.join(", ")
+
+      "INSERT INTO #{object.class.table_name} (#{ keys }) VALUES (#{ values });"
+    end
+
+    # http://invisipunk.blogspot.com/2008/04/activerecord-raw-insertupdate.html
+    def dump_value_string(value)
+      case value.class.to_s
+        when "Time"
+          "'#{value.strftime("%Y-%m-%d %H:%M:%S")}'"
+        when "NilClass"
+          "NULL"
+        when "Fixnum"
+          value
+        when "String"
+          "'#{value.gsub(/'/, "\\\\'")}'"
+        when "FalseClass"
+          '0'
+        when "TrueClass"
+          '1'
+        else
+          "'#{value}'"
+      end
+    end
+  end
+end

data/lib/dumpable/file_writer.rb

@@ -0,0 +1,16 @@
+module Dumpable
+  class FileWriter
+    def self.write(lines, options)
+      if options[:file]
+        File.open(options[:file], "w") do |file|
+          file.puts lines
+        end
+      else
+        lines.each do |line|
+          puts line
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/dumpable.rb

@@ -1,90 +1,19 @@
 require 'active_support'
 require 'active_record'
+require 'hashie'
 
 module Dumpable
-  extend ActiveSupport::Concern
+  autoload :ActiveRecordExtensions, "dumpable/active_record_extensions"
+  autoload :Dumper,                 "dumpable/dumper"
+  autoload :FileWriter,             "dumpable/file_writer"
 
-  mattr_accessor :dumpable_id_padding
-  @@dumpable_id_padding = 0
+  mattr_accessor :config
+  @@config = Hashie::Mash.new
+  @@config.id_padding = 0
 
-  def dump(options={})
-    id_padding = options[:id_padding] || self.class.dumpable_id_padding
-
-    dumps = options[:dumps] || self.class.dumps
-
-    recursive_dump(self, id_padding, dumps)
-    puts generate_insert_query(id_padding)
-  end
-
-  # http://invisipunk.blogspot.com/2008/04/activerecord-raw-insertupdate.html
-  def generate_insert_query(id_padding)
-    cloned_attributes = self.attributes.clone
-    cloned_attributes["id"] += id_padding
-    key_vals = cloned_attributes.collect{ |key,value| [key, dump_value_string(value)] }
-    "INSERT INTO #{self.class.table_name} " +
-    "( #{key_vals.collect{ |item| item[0].to_s }.join(", ") } ) " + 
-    "VALUES( #{key_vals.collect{ |item| item[1].to_s }.join(", ") } );"
-  end
-
-  private
-  def recursive_dump(object, id_padding, dumps)
-    if dumps.nil?
-
-    elsif dumps.is_a?(Array)
-      dumps.each do |mini_dump|
-        recursive_dump(object, id_padding, mini_dump)
-      end
-    elsif dumps.is_a?(Hash)
-      dumps.each do |key, value|
-        recursive_dump(object, id_padding, key)
-        Array(object.send(key)).each { |child| recursive_dump(child, id_padding, value) }
-      end
-    elsif dumps.is_a?(Symbol) || dumps.is_a?(String)
-      Array(object.send(dumps)).each do |child_object|
-        reflection = object.class.reflections[dumps]
-        if reflection.macro == :belongs_to
-          object.send("#{reflection.association_foreign_key}=", object.id + id_padding)
-        elsif [:has_many, :has_one].include? reflection.macro
-          if reflection.respond_to?(:foreign_key)
-            child_object.send("#{reflection.foreign_key}=", object.id + id_padding)
-          else
-            child_object.send("#{reflection.primary_key_name}=", object.id + id_padding)
-          end
-        end
-        puts child_object.send(:generate_insert_query, id_padding)
-      end
-    end
-  end
-
-  # http://invisipunk.blogspot.com/2008/04/activerecord-raw-insertupdate.html
-  def dump_value_string(value)
-    case value.class.to_s
-      when "Time"
-        "'#{value.strftime("%Y-%m-%d %H:%M:%S")}'"
-      when "NilClass"
-        "NULL"
-      when "Fixnum"
-        value
-      when "String"
-        "'#{value.gsub(/'/, "\\\\'")}'"
-      when "FalseClass"
-        '0'
-      when "TrueClass"
-        '1'
-      else
-        "'#{value}'"
-    end
-  end
-
-  module ClassMethods
-    def dumpable(options={})
-      self.class_eval do
-        cattr_accessor :dumpable_id_padding, :dumps
-      end
-      self.dumpable_id_padding = options[:id_padding] || Dumpable.dumpable_id_padding
-      self.dumps = options[:dumps]
-    end
+  def self.dump(*records_and_collections)
+    Dumpable::Dumper.dump(*records_and_collections)
   end
 end
 
-ActiveRecord::Base.send :include, Dumpable
+ActiveRecord::Base.send :include, Dumpable::ActiveRecordExtensions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dumpable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +118,7 @@ files:
 - .document
 - .ruby-gemset
 - .ruby-version
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -109,8 +126,10 @@ files:
 - VERSION
 - dumpable.gemspec
 - lib/dumpable.rb
+- lib/dumpable/active_record_extensions.rb
+- lib/dumpable/dumper.rb
+- lib/dumpable/file_writer.rb
 - test/helper.rb
-- test/test_dumpable.rb
 homepage: http://github.com/hunterae/dumpable
 licenses:
 - MIT
@@ -126,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2248843498865931733
+      hash: -158942502906389966
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/test_dumpable.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDumpable < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end