arin 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b10ee0ba80cabed89245ed72f491f0bbbc73196
+  data.tar.gz: 11962da1cfa1b6c7cf488268d72878955eb3a08d
+SHA512:
+  metadata.gz: 0a2f393223c258d6d5b6c670f5fd17ccad39324c721a5c8eab9d083e0d91d99f135f13c71fc5d3d0b920444fb62598bce5a018c6ac5a22f7e380c506a5a37e3c
+  data.tar.gz: 4850e75ea2a42fea3a6ff67f51d2cce4cfe1581126ea53f57b5b6486a5be5a9420dac1791e226f5b7ac2cbc69241043911e4f0794418f70fb12394bd6378a74f

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 fmnoise@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Arin
+
+Arin - ActiveRecord integrity checking tool
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arin', github: 'fmnoise/arin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arin
+
+## Usage
+
+Consider the example: Order belongs to User which doesn't exist anymore.
+
+In order to find models of certain class which points to non-existant entities we need to pass class contant to constructor
+```ruby
+Arin::Check.new(Order).issues
+
+# callable object style
+Arin::Check.(Order)
+```
+Multiple classes should be passed as array
+```ruby
+Arin::Check.new([Payment, Order]).issues
+
+# callable object style
+Arin::Check.([Payment, Order])
+```
+Omit parameters to check all loaded models
+```ruby
+Rails.application.eager_load!
+Arin::Check.new.issues
+
+# callable object style
+Arin::Check.()
+```
+
+Working with found issues collection which is simple array of `Arin::Issue` instances
+```ruby
+issue = Arin::Check.().first
+=> #<Arin::Issue:0x007f9fe2823af0
+ @class_name="Order",
+ @id=6789,
+ @relation_class="User",
+ @relation_id=4567>
+
+issue.class_name
+=> "Order"
+
+issue.id
+=> 6789
+
+issue.relation_class
+=> "User"
+
+issue.relation_id
+=> 4567
+
+issue.object
+=> #<Order:0x007f9fdfbd9af8
+  id: 6789,
+  user_id: 4567
+  created_at: Tue, 15 Dec 2016 01:45:37 UTC +00:00,
+  updated_at: Sun, 20 Jun 2017 20:06:36 UTC +00:00>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+*The main idea behind Arin development is to stay as small and unopinionated as possible*
+Bug reports and pull requests are welcome on GitHub at https://github.com/fmnoise/arin.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/arin/check.rb

@@ -0,0 +1,68 @@
+require_relative './issue'
+
+module Arin
+  class Check
+    attr_reader :classes
+
+    def self.call(classes = [])
+      self.new(classes).issues
+    end
+
+    def initialize(classes = [])
+      @classes = Array(classes).presence || all_classes
+    end
+
+    def issues
+      @issues ||= raw_results.map do |entry|
+        Arin::Issue.new \
+          class_name: entry['class_name'],
+          id: entry['id'],
+          relation_class: entry['relation_class'],
+          relation_id: entry['relation_id']
+      end
+    end
+
+    private
+
+      def raw_results
+        query.present? ? ActiveRecord::Base.connection.select_all(query) : []
+      end
+
+      def all_classes
+        ActiveRecord::Base.descendants
+      end
+
+      def query
+        subqueries = []
+        classes.each do |klass|
+          klass.reflect_on_all_associations(:belongs_to).each do |relation|
+            q = relation_query(klass, relation) rescue nil
+            subqueries << q if q && processable?(klass, relation)
+          end
+        end
+        subqueries.join <<-SQL
+          UNION ALL
+        SQL
+      end
+
+      def processable?(klass, relation)
+        klass.table_exists? &&
+        klass.primary_key &&
+        klass.column_names.include?(relation.foreign_key)
+      end
+
+      def relation_query(klass, relation)
+        <<-SQL
+          SELECT "#{klass.name}" AS class_name,
+            t.#{klass.primary_key} AS id,
+            "#{relation.class_name}" AS relation_class,
+            t.#{relation.foreign_key} AS relation_id
+          FROM #{klass.table_name} AS t
+          LEFT JOIN #{relation.table_name} AS r
+            ON t.#{relation.foreign_key} = r.#{relation.association_primary_key}
+          WHERE r.#{relation.association_primary_key} IS NULL
+            AND t.#{relation.foreign_key} IS NOT NULL
+        SQL
+      end
+  end
+end

data/lib/arin/issue.rb

@@ -0,0 +1,16 @@
+module Arin
+  class Issue
+    attr_reader :class_name, :id, :relation_class, :relation_id
+
+    def initialize(class_name:, id:, relation_class:, relation_id:)
+      @class_name = class_name
+      @id = id
+      @relation_class = relation_class
+      @relation_id = relation_id
+    end
+
+    def object
+      @object ||= class_name.constantize.find(id)
+    end
+  end
+end

data/lib/arin/version.rb

@@ -0,0 +1,3 @@
+module Arin
+  VERSION = "0.1.1"
+end

data/lib/arin.rb

@@ -0,0 +1,5 @@
+require "arin/version"
+require "arin/check"
+
+module Arin
+end

data/spec/arin_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Arin do
+  it "has a version number" do
+    expect(Arin::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "arin"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: arin
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- fmnoise@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- fmnoise@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/arin.rb
+- lib/arin/check.rb
+- lib/arin/issue.rb
+- lib/arin/version.rb
+- spec/arin_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord Integrity checking tool
+test_files: []