clean_associations 0.0.1.alpha

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in clean_associations.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Manish Puri
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # CleanAssociations
2
+
3
+ This is a gem to find or delete an invalid record in your activerecord object based on belongs_to association
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'clean_associations'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install clean_associations
18
+
19
+ ## Usage
20
+
21
+ This is a gem to find or delete an invalid record in your activerecord object. Lets say you have a Post model with user_id and some users are deleted 'Accidentally'. Even worse, you did not add a dependent destroy..(OMG..!).
22
+
23
+
24
+ Now when you display Post.all, you will get Record not found error.To avoid this, you may want to delete or find such records for which the associated record is missing. 'clean_associations' is for you.
25
+
26
+
27
+ Once, you install the gem, you can do
28
+
29
+ Post.get_invalid_records_for(:user)
30
+
31
+ This will return an array of invalid ids in your Post model for which associated User record is missing.
32
+
33
+
34
+ You may want to delete them too.. ! So we have a method for that.
35
+
36
+ Post.destroy_invalid_records_for(:user)
37
+
38
+
39
+
40
+ ## Contributing
41
+
42
+ 1. Fork it ( http://github.com/Manik-Ratnas/clean_associations/fork )
43
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
44
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
45
+ 4. Push to the branch (`git push origin my-new-feature`)
46
+ 5. Create new Pull Request
47
+
48
+
49
+ #Todo
50
+
51
+ Specs
52
+
53
+ :collision: :collision: collision:
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'clean_associations/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "clean_associations"
8
+ spec.version = CleanAssociations::VERSION
9
+ spec.authors = ["Manish Puri"]
10
+ spec.email = ["manishspuri@gmail.com"]
11
+ spec.summary = %q{A simple cleaner script for your activerecord models.}
12
+ spec.description = %q{A simple cleaner script for your activerecord models.}
13
+ spec.homepage = ""
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.5"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_dependency 'activerecord'
24
+ end
@@ -0,0 +1,71 @@
1
+
2
+ module CleanAssociations
3
+ module Base
4
+ def self.included(base)
5
+ base.extend ClassMethods
6
+ end
7
+
8
+ module ClassMethods
9
+
10
+ def get_invalid_records_for(association_name, options={})
11
+ invalid_ids = get_invalid_ids(association_name,options)
12
+ if invalid_ids.count > 0
13
+ p "There are #{invalid_ids.count} invalid records in your #{self.model_name} model."
14
+ p "Here are the ids:", invalid_ids
15
+ invalid_ids
16
+ else
17
+ p 'No Invalid Records.!'
18
+ []
19
+ end
20
+ end
21
+
22
+ def destroy_invalid_records_for(association_name, options={})
23
+ invalid_ids = get_invalid_ids(association_name, options)
24
+ if invalid_ids.count > 0
25
+ p "There are #{invalid_ids.count} in your #{self.model_name} model. Deleting the same"
26
+ self.destroy_all(:id=>invalid_ids)
27
+ else
28
+ p 'No Invalid Records.!'
29
+ end
30
+ end
31
+
32
+ private
33
+
34
+ def get_invalid_ids(association_name, options={})
35
+ invalid_records=[]
36
+ assoc_name_sym= association_name.to_sym
37
+ associations = self.reflect_on_all_associations(:belongs_to)
38
+ main_assoc=self.reflections[assoc_name_sym]
39
+ if main_assoc.present?
40
+ self.includes(assoc_name_sym).find_in_batches do |group|
41
+ group.each do |rec|
42
+ invalid_records << rec.id if rec.send(assoc_name_sym).nil?
43
+ end
44
+ end
45
+
46
+ else
47
+ raise "ArgumentError: Invalid Association name."
48
+ end
49
+ invalid_records
50
+ end
51
+
52
+ def get_attr_array(main_assoc)
53
+
54
+ [self.table_name + "." + self.primary_key,
55
+
56
+ main_assoc.association_foreign_key,
57
+
58
+ main_assoc.table_name + '.*']
59
+ end
60
+
61
+ end
62
+ class ActiveRecord::Base
63
+ include CleanAssociations::Base
64
+ end
65
+
66
+ end
67
+ end
68
+
69
+
70
+
71
+
@@ -0,0 +1,3 @@
1
+ module CleanAssociations
2
+ VERSION = "0.0.1.alpha"
3
+ end
@@ -0,0 +1,2 @@
1
+ require "clean_associations/version"
2
+ require "clean_associations/base"
metadata ADDED
@@ -0,0 +1,103 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: clean_associations
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1.alpha
5
+ prerelease: 6
6
+ platform: ruby
7
+ authors:
8
+ - Manish Puri
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2014-02-24 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: bundler
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: '1.5'
22
+ type: :development
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: '1.5'
30
+ - !ruby/object:Gem::Dependency
31
+ name: rake
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: '0'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ - !ruby/object:Gem::Dependency
47
+ name: activerecord
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ! '>='
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ! '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ description: A simple cleaner script for your activerecord models.
63
+ email:
64
+ - manishspuri@gmail.com
65
+ executables: []
66
+ extensions: []
67
+ extra_rdoc_files: []
68
+ files:
69
+ - .gitignore
70
+ - Gemfile
71
+ - LICENSE.txt
72
+ - README.md
73
+ - Rakefile
74
+ - clean_associations.gemspec
75
+ - lib/clean_associations.rb
76
+ - lib/clean_associations/base.rb
77
+ - lib/clean_associations/version.rb
78
+ homepage: ''
79
+ licenses:
80
+ - MIT
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ none: false
87
+ requirements:
88
+ - - ! '>='
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ required_rubygems_version: !ruby/object:Gem::Requirement
92
+ none: false
93
+ requirements:
94
+ - - ! '>'
95
+ - !ruby/object:Gem::Version
96
+ version: 1.3.1
97
+ requirements: []
98
+ rubyforge_project:
99
+ rubygems_version: 1.8.23
100
+ signing_key:
101
+ specification_version: 3
102
+ summary: A simple cleaner script for your activerecord models.
103
+ test_files: []