orphan_records 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'activesupport'
+

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    i18n (0.6.1)
+    multi_json (1.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport

data/LICENSE.txt

@@ -0,0 +1,60 @@
+Ruby License
+http://www.ruby-lang.org/en/LICENSE.txt
+
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.md

@@ -0,0 +1,12 @@
+OrphanRecords
+===============
+This program is based on the Annotate Models plugin written by Dave Thomas and VisualizeModels plugin by Nils Franzen.
+<br/>For more information about Annotate Models, see http://blogs.pragprog.com/cgi-bin/pragdave.cgi/Tech/Ruby/AnnotateModels.rdoc
+<br/>For more information about Visualize Models, see http://visualizemodels.rubyforge.org/
+
+Authors:
+> Abhilash M A
+<br/> Nils Franzen (Visualize Models)
+<br/> Dave Thomas (Annotate Models)
+
+Released under the same license as Ruby. No Support. No Warranty.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end

data/lib/orphan_records.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'active_support/all'
+
+TableInfo = Struct.new(:name, :attributes)
+Attribute = Struct.new(:name, :type, :default, :isnull)
+Association = Struct.new(:attr, :node1, :node2)
+
+module OrphanRecords
+
+  # Use the column information in an ActiveRecord class
+  # to create an 'Attribute' for each column.
+  # The line contains the column name, the type
+  # (and length), and any optional attributes
+  def self.get_schema_info(table_name)
+    attrs = []
+    ActiveRecord::Base.connection.columns(table_name).each do |col|
+      col_type = col.type.to_s
+      col_type << "(#{col.limit})" if col.limit
+    
+      attrs << Attribute.new(col.name, col_type, col.default, !col.null)
+    end
+
+    return TableInfo.new(ActiveSupport::Inflector.classify(table_name), attrs)
+  end
+
+
+  def self.create_association_info(tableInfos)
+    assocs = []
+    # Draw the tables as boxes
+    tableInfos.each do |table |
+      attrs = ""
+      table.attributes.each do | attr |
+        if attr.name =~ /\_id$/
+          # Create an association to other table
+          table_name = ActiveSupport::Inflector.camelize(attr.name.sub(/\_id$/, ''))
+          other_table = tableInfos.find { | other | other.name == table_name }
+          assocs << Association.new(attr, table, other_table) if other_table != nil
+        end
+        attrs << "#{attr.name} : #{attr.type}"
+        attrs << ", default: \\\"#{attr.default}\\\"" if attr.default
+        attrs << "\\n"
+      end
+    end
+
+    assocs
+  end
+
+  # We're passed a name of things that might be 
+  # ActiveRecord models. If we can find the class, and
+  # if its a subclass of ActiveRecord::Base,
+  # then pass it to the associated block
+  def self.get_associations
+    tableInfos = []
+    configurations = YAML::load(File.open(File.join(Rails.root, "config/database.yml")))
+    ActiveRecord::Base.establish_connection configurations[Rails.env]
+    ActiveRecord::Base.connection.tables.each do |table_name|
+      # puts "Looking at table: #{table_name}"
+      tableInfos << get_schema_info(table_name)
+    end
+    
+    create_association_info(tableInfos)
+  end
+
+  def self.find_orphan_records(options = {:delete => false})
+    require File.join(Rails.root, "config/environment")
+    associations = get_associations
+    associations.each do | assoc |
+      # puts "\t\"#{assoc.node1.name}\" -> \"#{assoc.node2.name}\" [label=\"#{assoc.attr.name}\"]\n"
+      begin
+        model = eval(assoc.node1.name)
+        model.all.each do |obj|
+          id = obj.send(assoc.attr.name)
+          record = eval(assoc.node2.name).find_by_id(id)
+          if(record.nil?)
+            puts "\t\"#{assoc.node1.name} ID: #{obj.id} associated with #{assoc.node2.name} ID: #{id} which doesn't exist"
+            if(options[:delete])
+              obj.delete
+              puts "\t\"#{assoc.node1.name} ID: #{obj.id} deleted"
+            end
+          end
+        end
+      rescue Exception => e
+        # puts "\t\t\"#{e.message}"
+      end
+    end
+  end
+
+  def self.delete_orphan_records
+    find_orphan_records({:delete => true})
+  end
+
+end
+
+require File.join(File.dirname(__FILE__), "orphan_records/railtie") if defined?(Rails)
+

data/lib/orphan_records/railtie.rb

@@ -0,0 +1,9 @@
+require 'orphan_records'
+require 'rails'
+module OrphanRecords
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "../tasks/orphan_records_tasks.rake")
+    end
+  end
+end

data/lib/tasks/orphan_records_tasks.rake

@@ -0,0 +1,14 @@
+desc "Orphan Records"
+namespace :orphan_records do
+  desc "Show the orphan records"
+  task :show do
+   require File.join(File.dirname(__FILE__), "../orphan_records.rb")
+   OrphanRecords.find_orphan_records
+  end
+
+  desc "Delete the orphan records"
+  task :delete do
+   require File.join(File.dirname(__FILE__), "../orphan_records.rb")
+   OrphanRecords.delete_orphan_records
+  end
+end

data/orphan_records.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name = 'orphan_records'
+  s.version = "0.0.1"
+
+  s.authors = [%q{abhilash}]
+  s.date = %q{2013-04-07}
+  s.description = %q{Show/Delete Orphan Records in your Rails application}
+  s.email = %q{abhidsm@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/orphan_records.rb",
+    "lib/orphan_records/railtie.rb",
+    "lib/tasks/orphan_records_tasks.rake",
+    "test/test_helper.rb",
+    "test/test_orphan_records.rb",
+    "orphan_records.gemspec"
+  ]
+  s.homepage = %q{https://github.com/abhidsm/OrphanRecords}
+  s.licenses = [%q{Ruby}]
+  s.require_paths = [%q{lib}]
+  s.summary = %q{Show/Delete Orphan Records in your Rails application}
+  s.test_files = [
+    "test/test_helper.rb",
+    "test/test_orphan_records.rb"
+  ]
+end

data/test/test_helper.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'bundler'
+require 'active_support'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+module Rails
+  def self.env
+    ActiveSupport::StringInquirer.new("test")
+  end
+
+  def self.root
+    "test"
+  end
+end
+
+class File
+  def self.join(first, second)
+    "minitest/spec"
+  end
+end
+
+module ActiveRecord
+  class Column
+    def type
+      "type"
+    end
+    def limit
+      12
+    end
+    def name
+      "asd"
+    end
+    def default
+      "default"
+    end
+    def null
+    end
+  end
+  
+  class Table
+    def tables
+      [Table.new, Table.new]
+    end
+    def columns(name)
+      [Column.new, Column.new]
+    end
+  end
+  
+  class Base
+    def self.connection
+      Table.new
+    end
+  end
+end
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require_relative "../lib/orphan_records"
+

data/test/test_orphan_records.rb

@@ -0,0 +1,28 @@
+require_relative 'test_helper.rb'
+
+describe "when asked for get_schema_info" do
+  it "must create and return the TableInfo values" do
+    OrphanRecords.get_schema_info("table_name").must_be_instance_of(TableInfo)
+  end
+end  
+
+describe "when asked for create_association_info" do
+  it "must create and return the associations details" do
+    attrs = []
+    table_infos = []
+    attrs << Attribute.new("title", "asd", "qwe", true)
+    table_infos << TableInfo.new("Table1", attrs)
+    attrs = []
+    attrs << Attribute.new("table1_id", "asd", "qwe", true)
+    table_infos << TableInfo.new("Table2", attrs)
+    associations = OrphanRecords.create_association_info(table_infos)
+    associations.count.must_equal(1)
+    attributes = associations.first.attr
+    assert_equal attributes.name, 'table1_id'
+    assert_equal attributes.type, 'asd'
+    assert_equal attributes.default, 'qwe'
+    assert_equal associations.first.node1, table_infos.last
+    assert_equal associations.first.node2, table_infos.first
+  end
+end
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: orphan_records
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- abhilash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies: []
+description: Show/Delete Orphan Records in your Rails application
+email: abhidsm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/orphan_records.rb
+- lib/orphan_records/railtie.rb
+- lib/tasks/orphan_records_tasks.rake
+- test/test_helper.rb
+- test/test_orphan_records.rb
+- orphan_records.gemspec
+homepage: https://github.com/abhidsm/OrphanRecords
+licenses:
+- Ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Show/Delete Orphan Records in your Rails application
+test_files:
+- test/test_helper.rb
+- test/test_orphan_records.rb