dread 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58f1d635f7dd155d80768ba4bc69cbf6a878b2c0
-  data.tar.gz: 431970c23d2bb44ac58ea49e5e71cad7405aa7b1
+  metadata.gz: ec0d3b7679358d3f9941777420ff7a2792dfd32c
+  data.tar.gz: 39291b385b9ab7bc5f316505e4c449b82044371d
 SHA512:
-  metadata.gz: 6bfc68d886b19950e957aaa4f5e8a0fc745d1d71c00a580d78a55863240e7e7b2fed650de5a8578429f35d0a1602e0f1018b041b69de80b59a057cb2270b3d7d
-  data.tar.gz: d897893f97a001b18db6bbf198eed05e6366de58c9582893439d29a405afedc65d0d189ceeef8c2a6823c3d8babaad6d616f96e3bc02fb24c708f8cd0b81fe94
+  metadata.gz: 178d16acc3ead4591374a46ddda024abfab3de1a57748837def29a9d584fd37cf3006cb1d9db396343f4acc40b22bbed6818401502eb1e44270d8bff63f5ec14
+  data.tar.gz: ba0265f2cf871ab1f7425e2983a7e00e3253c72b9b4366c415d8f172c923d8960a9ba0cf74b5aecddb7ba93d2d8519ba262be450f296942db1a9c3ee2f17cb80

data/README.md

@@ -1,4 +1,105 @@
 # Dread
 
+// missing_dependents
+
 [![Build Status](https://travis-ci.org/DamirSvrtan/dread.svg?branch=master)](https://travis-ci.org/DamirSvrtan/dread)
-[![Code Climate](https://codeclimate.com/github/DamirSvrtan/dread/badges/gpa.svg)](https://codeclimate.com/github/DamirSvrtan/dread)
+[![Code Climate](https://codeclimate.com/github/DamirSvrtan/dread/badges/gpa.svg)](https://codeclimate.com/github/DamirSvrtan/dread)
+
+Never dread about (not) destroying your records again!
+
+Dread provides ways to:
+  1. Draw a graph of dependently destroyable associations
+  2. Find associations with missing depenent destroys/delets/nullifies
+
+Supports Rails 3.2+ and Ruby 1.9.3+.
+
+## Installation
+
+Add the Dread gem to your Gemfile:
+
+```ruby
+group :development do
+  gem 'dread', '>= 0.0.7'
+end
+```
+
+And run `bundle install` within your app's directory.
+
+## Usage
+
+The Dread gem provides a rake task for drawing all dependently destroyable associations.
+
+```bash
+$ rake dread class=user
+
+user
+    tweets
+        comments
+            pictures
+        pictures
+    comments
+        pictures
+    avatar
+```
+
+#### Self joins
+
+```ruby
+class Employee < ActiveRecord::Base
+  has_many :subordinates, class_name: Employee,
+                          foreign_key: "manager_id",
+                          dependent: :destroy
+
+  belongs_to :manager, class_name: Employee
+end
+```
+
+```shell
+$ rake dread class=employee
+
+employee
+    subordinates
+        ...
+```
+
+#### Circular dependent destroys
+
+```ruby
+class Supplier < ActiveRecord::Base
+  has_one :account, dependent: :destroy
+end
+
+class Account < ActiveRecord::Base
+  belongs_to :supplier, dependent: :destroy
+end
+```
+
+```shell
+$ rake dread class=supplier
+
+supplier
+    account
+        supplier
+            ...
+```
+
+
+### Development
+
+Dread uses [appraisals](https://github.com/thoughtbot/appraisal) to test the code base against multiple versions of Rails.
+
+When first developing, you should run `bundle install` and `appraisal install` to install the all dependencies accross different gemfiles.
+
+Run `appraisal rake` to roll the tests on multiple versions or just run a specific set with `appraisal rails-4.0 rake`.
+
+### Bug reports
+
+If you find a problem with the Dread gem, please submit an [issue](https://github.com/DamirSvrtan/dread/issues), along with the version of Rails you're using and the set of associations that are causing the trouble.
+
+### Contributing
+
+1. Fork it ( http://github.com/DamirSvrtan/dread/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -m 'Add new feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/dread.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Damir Svrtan"]
   s.email       = ["damir.svrtan@gmail.com"]
   s.homepage    = "https://github.com/DamirSvrtan/dread"
-  s.summary     = "Summary of Dread."
-  s.description = "Description of Dread."
+  s.summary     = "Draw a graph of dependently destroyable associations."
+  s.description = "Draw a graph of dependently destroyable associations and never dread about destroying your records again!"
   s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")

data/lib/dread.rb

@@ -1,5 +1,8 @@
 require 'pry'
-require 'dread/graph'
+require 'dread/association_graph'
+require 'dread/missing_graph'
+require 'dread/missing_graphs'
+
 
 module Dread
   class Railtie < ::Rails::Railtie
@@ -7,4 +10,8 @@ module Dread
       load File.join(File.dirname(__FILE__), 'tasks/dread.rake')
     end
   end
-end
+
+  def self.ar_models
+    ActiveRecord::Base.descendants
+  end
+end

data/lib/dread/{graph.rb → association_graph.rb}

@@ -1,7 +1,7 @@
 require 'dread/error'
 require 'dread/console_output'
 module Dread
-  class Graph
+  class AssociationGraph
 
     attr_reader :clazz, :dependable_collection, :collected_clazzes
 
@@ -60,11 +60,11 @@ module Dread
               relation_hash[assoc_name] = {}
             when :destroy
               relation_hash.merge!(
-                Graph.new(assoc_data, assoc_data.macro == :has_many, collected_clazzes + [self.clazz]).dependable_collection)
+                AssociationGraph.new(assoc_data, assoc_data.macro == :has_many, collected_clazzes + [self.clazz]).dependable_collection)
             end
           end
         end
       end
 
   end
-end
+end

data/lib/dread/console_output.rb

@@ -12,6 +12,15 @@ module Dread
         end
       end
 
+      def generate_missing(klasses_with_missing_dependables)
+        klasses_with_missing_dependables.each do |klass, missing_dependables|
+          puts klass
+          missing_dependables.each do |missing_dependable|
+            puts "  #{missing_dependable}"
+          end
+        end
+      end
+
     end
   end
-end
+end

data/lib/dread/missing_graph.rb

@@ -0,0 +1,41 @@
+module Dread
+  class MissingGraph
+    attr_reader :clazz
+
+    def initialize(clazz)
+      @clazz = clazz.classify.constantize
+    end
+
+    def missing_dependables
+      possesionable_associations.map do |assoc_name, assoc_data|
+        assoc_name if direct_association_with_no_dependents?(assoc_data)
+      end.compact
+    end
+
+    private
+
+    def direct_association_with_no_dependents?(assoc_data)
+      assoc_data.options[:through].nil? && assoc_data.options[:dependent].nil?
+    end
+
+    def possesionable_associations
+      has_many_associations.merge(has_one_associations)
+    end
+
+    def has_many_associations
+      @has_many_associations ||= begin
+        clazz.reflections.select do |assoc_name, assoc_data|
+          assoc_data.macro == :has_many
+        end
+      end
+    end
+
+    def has_one_associations
+      @has_one_associations ||= begin
+        clazz.reflections.select do |assoc_name, assoc_data|
+          assoc_data.macro == :has_one
+        end
+      end
+    end
+  end
+end

data/lib/dread/missing_graphs.rb

@@ -0,0 +1,21 @@
+module Dread
+  class MissingGraphs
+
+    def initialize
+      Rails.application.eager_load!
+    end
+
+    def all_missing_dependables
+      Dread.ar_models.map do |active_record_model|
+        missing_dependables = Dread::MissingGraph.new(active_record_model.to_s)
+                                                 .missing_dependables
+
+        { active_record_model => missing_dependables } if missing_dependables.any?
+      end.compact.inject {|element, all| all.merge(element)}
+    end
+
+    def draw
+      ConsoleOutput.generate_missing(all_missing_dependables)
+    end
+  end
+end

data/lib/dread/version.rb

@@ -1,3 +1,3 @@
 module Dread
-  VERSION = "0.0.7"
-end
+  VERSION = "0.1.0"
+end

data/lib/tasks/dread.rake

@@ -1,10 +1,15 @@
 require 'colorize'
 desc 'list destroyable/deletable dependencies of your ActiveRecord class'
-task dread: :environment do
+task association_graph: :environment do
   begin
-    dread_graph = Dread::Graph.new(ENV['class'])
-    dread_graph.draw
+    association_graph = Dread::AssociationGraph.new(ENV['class'])
+    association_graph.draw
   rescue Dread::Error => e
     puts e.message.colorize(:red)
   end
-end
+end
+
+desc 'list ActiveRecord relationships with missing dependent destroys/deletes..'
+task missing_dependables: :environment do
+  Dread::MissingGraphs.new.draw
+end

data/test/{dread_test.rb → association_graph_test.rb}

@@ -1,16 +1,16 @@
 require 'test_helper'
 
-class DreadTest < ActiveSupport::TestCase
+class AssociationGraphTest < ActiveSupport::TestCase
 
   test 'initialization' do
     assert_nothing_raised do
-      dread_graph = Dread::Graph.new('user')
+      dread_graph = Dread::AssociationGraph.new('user')
     end
   end
 
   test 'initialization with missing constant' do
     assert_raises Dread::Error do
-      dread_graph = Dread::Graph.new('uzer')
+      dread_graph = Dread::AssociationGraph.new('uzer')
     end
   end
 
@@ -19,17 +19,26 @@ class DreadTest < ActiveSupport::TestCase
        AccountSetting
        account_settings
        AccountSettings).each do |model_name|
-      assert_equal AccountSetting, Dread::Graph.new(model_name).clazz
+      assert_equal AccountSetting, Dread::AssociationGraph.new(model_name).clazz
+    end
+  end
+
+  test 'various namespaced clazz names' do
+    %w(Wtf::Ashtray
+       Wtf::Ashtrays
+       wtf/ashtray
+       wtf/ashtrays).each do |model_name|
+      assert_equal Wtf::Ashtray, Dread::AssociationGraph.new(model_name).clazz
     end
   end
 
   test 'drawing' do
-    dread_graph = Dread::Graph.new('user')
+    dread_graph = Dread::AssociationGraph.new('user')
     dread_graph.draw
   end
 
   test 'collecting' do
-    dread_graph = Dread::Graph.new('user')
+    dread_graph = Dread::AssociationGraph.new('user')
     dependable_collection = dread_graph.dependable_collection
     dependable_collection.assert_valid_keys(:user)
     dependable_collection[:user].assert_valid_keys(:tweets, :comments, :setting, :avatar)
@@ -37,7 +46,7 @@ class DreadTest < ActiveSupport::TestCase
   end
 
   test 'self-join' do
-    dread_graph = Dread::Graph.new('employee')
+    dread_graph = Dread::AssociationGraph.new('employee')
     dependable_collection = dread_graph.dependable_collection
     dependable_collection.assert_valid_keys(:employee)
     dependable_collection[:employee].assert_valid_keys(:subordinates)
@@ -46,12 +55,12 @@ class DreadTest < ActiveSupport::TestCase
   end
 
   test 'self-join drawing' do
-    dread_graph = Dread::Graph.new('employee')
+    dread_graph = Dread::AssociationGraph.new('employee')
     dread_graph.draw
   end
 
   test 'circular dependent destroy has one' do
-    dread_graph = Dread::Graph.new('supplier')
+    dread_graph = Dread::AssociationGraph.new('supplier')
     dependable_collection = dread_graph.dependable_collection
     dependable_collection.assert_valid_keys(:supplier)
     dependable_collection[:supplier].assert_valid_keys(:account)
@@ -60,7 +69,7 @@ class DreadTest < ActiveSupport::TestCase
   end
 
   test 'circular dependent destroy belongs_to' do
-    dread_graph = Dread::Graph.new('account')
+    dread_graph = Dread::AssociationGraph.new('account')
     dependable_collection = dread_graph.dependable_collection
     dependable_collection.assert_valid_keys(:account)
     dependable_collection[:account].assert_valid_keys(:supplier)
@@ -69,9 +78,9 @@ class DreadTest < ActiveSupport::TestCase
   end
 
   test 'namespaced associations' do
-    dread_graph = Dread::Graph.new('Wtf::Ashtray')
+    dread_graph = Dread::AssociationGraph.new('Wtf::Ashtray')
     dependable_collection = dread_graph.dependable_collection
     dependable_collection.assert_valid_keys(:'wtf/ashtray')
     dependable_collection[:'wtf/ashtray'].assert_valid_keys(:cigarettes)
   end
-end
+end

data/test/dummy/app/models/company.rb

@@ -0,0 +1,6 @@
+class Company < ActiveRecord::Base
+  has_many :company_organizations
+  has_many :organizations, through: :company_organizations
+  has_one :headquarter
+  has_many :users, dependent: :nullify
+end

data/test/dummy/app/models/company_organization.rb

@@ -0,0 +1,4 @@
+class CompanyOrganization < ActiveRecord::Base
+  belongs_to :company
+  belongs_to :organization
+end

data/test/dummy/app/models/headquarter.rb

@@ -0,0 +1,3 @@
+class Headquarter < ActiveRecord::Base
+  belongs_to :company
+end

data/test/dummy/app/models/organization.rb

@@ -0,0 +1,4 @@
+class Organization < ActiveRecord::Base
+  has_many :company_organizations
+  has_many :companies, through: :company_organizations
+end

data/test/dummy/app/models/user.rb

@@ -3,4 +3,5 @@ class User < ActiveRecord::Base
   has_many :comments, dependent: :destroy
   has_one :avatar,    dependent: :destroy,  class_name: 'Picture',        as: :imageable
   has_one :setting,   dependent: :destroy,  class_name: 'AccountSetting'
-end
+  belongs_to :company
+end

data/test/dummy/db/migrate/20151013210055_create_companies.rb

@@ -0,0 +1,9 @@
+class CreateCompanies < ActiveRecord::Migration
+  def change
+    create_table :companies do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20151013210139_create_organizations.rb

@@ -0,0 +1,9 @@
+class CreateOrganizations < ActiveRecord::Migration
+  def change
+    create_table :organizations do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20151013210204_create_company_organizations.rb

@@ -0,0 +1,10 @@
+class CreateCompanyOrganizations < ActiveRecord::Migration
+  def change
+    create_table :company_organizations do |t|
+      t.references :company, index: true
+      t.references :organization, index: true
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20151013210550_create_headquarters.rb

@@ -0,0 +1,9 @@
+class CreateHeadquarters < ActiveRecord::Migration
+  def change
+    create_table :headquarters do |t|
+      t.references :company, index: true
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20151013211307_add_company_id_to_users.rb

@@ -0,0 +1,5 @@
+class AddCompanyIdToUsers < ActiveRecord::Migration
+  def change
+    add_reference :users, :company, index: true
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140918223342) do
+ActiveRecord::Schema.define(version: 20151013211307) do
 
   create_table "account_settings", force: true do |t|
     t.string   "time_zone"
@@ -35,6 +35,22 @@ ActiveRecord::Schema.define(version: 20140918223342) do
     t.datetime "updated_at"
   end
 
+  create_table "companies", force: true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "company_organizations", force: true do |t|
+    t.integer  "company_id"
+    t.integer  "organization_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "company_organizations", ["company_id"], name: "index_company_organizations_on_company_id"
+  add_index "company_organizations", ["organization_id"], name: "index_company_organizations_on_organization_id"
+
   create_table "countries", force: true do |t|
     t.string   "name"
     t.datetime "created_at"
@@ -48,6 +64,20 @@ ActiveRecord::Schema.define(version: 20140918223342) do
     t.datetime "updated_at"
   end
 
+  create_table "headquarters", force: true do |t|
+    t.integer  "company_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "headquarters", ["company_id"], name: "index_headquarters_on_company_id"
+
+  create_table "organizations", force: true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
   create_table "pictures", force: true do |t|
     t.string   "url"
     t.integer  "imageable_id"
@@ -74,8 +104,11 @@ ActiveRecord::Schema.define(version: 20140918223342) do
     t.string   "email"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.integer  "company_id"
   end
 
+  add_index "users", ["company_id"], name: "index_users_on_company_id"
+
   create_table "wtf_ashtrays", force: true do |t|
     t.string   "color"
     t.datetime "created_at"

data/test/missing_graph_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class Dread::MissingGraphTest < ActiveSupport::TestCase
+
+  test 'initializaties with no problems' do
+    assert_nothing_raised do
+      Dread::MissingGraph.new('user')
+    end
+  end
+
+  test 'user class has no missing dependables' do
+    missing_dependables = Dread::MissingGraph.new('user').missing_dependables
+    assert_equal [], missing_dependables
+  end
+
+  test 'account settings class has no missing dependables' do
+    missing_dependables = Dread::MissingGraph.new('account_setting').missing_dependables
+    assert_equal [], missing_dependables
+  end
+
+  test 'can find the model for multiple kinds of notations' do
+    %w(account_setting
+       AccountSetting).each do |model_name|
+      assert_equal AccountSetting, Dread::MissingGraph.new(model_name).clazz
+    end
+  end
+
+  test 'can find the model for various namespaced clazz names' do
+    %w(Wtf::Ashtray
+       wtf/ashtray).each do |model_name|
+      assert_equal Wtf::Ashtray, Dread::MissingGraph.new(model_name).clazz
+    end
+  end
+
+  test 'company class has missing dependables on company_organization and headquarter' do
+    missing_dependables = Dread::MissingGraph.new('company').missing_dependables
+    assert_equal [:company_organizations, :headquarter], missing_dependables
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dread
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Damir Svrtan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of Dread.
+description: Draw a graph of dependently destroyable associations and never dread
+  about destroying your records again!
 email:
 - damir.svrtan@gmail.com
 executables: []
@@ -99,18 +100,24 @@ files:
 - gemfiles/rails_4.0.gemfile
 - gemfiles/rails_4.1.gemfile
 - lib/dread.rb
+- lib/dread/association_graph.rb
 - lib/dread/console_output.rb
 - lib/dread/error.rb
-- lib/dread/graph.rb
+- lib/dread/missing_graph.rb
+- lib/dread/missing_graphs.rb
 - lib/dread/version.rb
 - lib/tasks/dread.rake
-- test/dread_test.rb
+- test/association_graph_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/models/account.rb
 - test/dummy/app/models/account_setting.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/company.rb
+- test/dummy/app/models/company_organization.rb
 - test/dummy/app/models/country.rb
 - test/dummy/app/models/employee.rb
+- test/dummy/app/models/headquarter.rb
+- test/dummy/app/models/organization.rb
 - test/dummy/app/models/picture.rb
 - test/dummy/app/models/supplier.rb
 - test/dummy/app/models/tweet.rb
@@ -151,7 +158,13 @@ files:
 - test/dummy/db/migrate/20140918220929_create_accounts.rb
 - test/dummy/db/migrate/20140918223314_create_wtf_ashtrays.rb
 - test/dummy/db/migrate/20140918223342_create_wtf_cigarettes.rb
+- test/dummy/db/migrate/20151013210055_create_companies.rb
+- test/dummy/db/migrate/20151013210139_create_organizations.rb
+- test/dummy/db/migrate/20151013210204_create_company_organizations.rb
+- test/dummy/db/migrate/20151013210550_create_headquarters.rb
+- test/dummy/db/migrate/20151013211307_add_company_id_to_users.rb
 - test/dummy/db/schema.rb
+- test/missing_graph_test.rb
 - test/test_helper.rb
 homepage: https://github.com/DamirSvrtan/dread
 licenses:
@@ -173,18 +186,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Summary of Dread.
+summary: Draw a graph of dependently destroyable associations.
 test_files:
-- test/dread_test.rb
+- test/association_graph_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/models/account.rb
 - test/dummy/app/models/account_setting.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/company.rb
+- test/dummy/app/models/company_organization.rb
 - test/dummy/app/models/country.rb
 - test/dummy/app/models/employee.rb
+- test/dummy/app/models/headquarter.rb
+- test/dummy/app/models/organization.rb
 - test/dummy/app/models/picture.rb
 - test/dummy/app/models/supplier.rb
 - test/dummy/app/models/tweet.rb
@@ -225,5 +242,11 @@ test_files:
 - test/dummy/db/migrate/20140918220929_create_accounts.rb
 - test/dummy/db/migrate/20140918223314_create_wtf_ashtrays.rb
 - test/dummy/db/migrate/20140918223342_create_wtf_cigarettes.rb
+- test/dummy/db/migrate/20151013210055_create_companies.rb
+- test/dummy/db/migrate/20151013210139_create_organizations.rb
+- test/dummy/db/migrate/20151013210204_create_company_organizations.rb
+- test/dummy/db/migrate/20151013210550_create_headquarters.rb
+- test/dummy/db/migrate/20151013211307_add_company_id_to_users.rb
 - test/dummy/db/schema.rb
+- test/missing_graph_test.rb
 - test/test_helper.rb