association-reporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b63e95394a41821ded5e277c6d34edec80de0ad1
+  data.tar.gz: 6d368760d3fb6d645dc60b09244681925d046c9c
+SHA512:
+  metadata.gz: 906fcd7a3d40e04c5822d449fed3e342b9d9ea265133d8f3b162739c8a8e37f3c4f16eecdcfc30ea68dcf7d0a3ce3ee66d7572ba6f52707f2dc672db9378f1dc
+  data.tar.gz: b91e691ed08fd9b4472560bf56935545fcbc60e184498eaa459ab548ee2240bfd3d514461fd7bb03bea5da92c30ace8bef5ab1c3f4d058d699cad4304f1bfd4e

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.irb-history
+repl.db
+test.db
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matt Baker
+
+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,3 @@
+# Association Reporter
+
+Hella WIP

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |task_config|
+    task_config.verbose = false
+  end
+
+  task :default => :spec
+rescue LoadError
+end
+
+
+desc 'Play with the spec database'
+task "play" do
+  exec "irb -r./repl/config"
+end

data/association-reporter.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'association-reporter'
+  spec.version     = '0.0.1'
+  spec.date        = '2016-04-01'
+  spec.summary     = "Tell me about your has_many"
+  spec.description = "Detailed reports for Active Record Associations"
+  spec.authors     = ["Matt Baker"]
+  spec.email       = 'mbaker.pdx@gmail.com'
+  spec.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^spec|repl})
+  end
+  spec.homepage    = 'https://github.com/mattbaker/association-reporter'
+  spec.license     = 'MIT'
+
+  spec.add_development_dependency 'bundler', '~>1.9'
+  spec.add_development_dependency 'rake', '~>10.5'
+  spec.add_development_dependency 'rspec', '~>3.4'
+  spec.add_development_dependency 'sqlite3', '~>1.3'
+  spec.add_development_dependency 'activerecord','~>4.2'
+  spec.add_runtime_dependency 'colorize', '~>0.7'
+end

data/lib/association-reporter.rb

@@ -0,0 +1,4 @@
+module AssociationReporter
+  PROJECT_ROOT = File.expand_path('../../', __FILE__)
+  TEMPLATES = File.join(PROJECT_ROOT, "templates")
+end

data/lib/association-reporter/assumption.rb

@@ -0,0 +1,126 @@
+require 'association-reporter'
+require 'singleton'
+
+module AssociationReporter
+  class Assumption
+    def initialize(reflection)
+      @reflection = reflection
+    end
+
+    private
+    attr_reader :reflection
+
+    def labelize(str, cond)
+      str && str.to_s.colorize(cond ? :green : :red)
+    end
+  end
+
+
+  class HasManyThroughAssociationAssumption < Assumption
+    def through_name
+      reflection.options[:through].to_s
+    end
+
+    def valid_through_method?
+      reflection.active_record.method_defined?(through_name)
+    end
+
+    def through_name_label
+      labelize(reflection.options[:through], valid_through_method?)
+    end
+
+    def through_assumption
+      reflection.through_reflection &&
+      AssociationAssumption.new(reflection.through_reflection)
+    end
+
+    def source_name
+      reflection.source_reflection_names.first.to_s
+    end
+
+    def source_label
+      labelize(source_name, reflection.source_reflection)
+    end
+
+    def source_assumption
+      reflection.source_reflection &&
+      AssociationAssumption.new(reflection.source_reflection)
+    end
+
+    def valid?
+      through_assumption.try(:valid?) && source_assumption.try(:valid?)
+    end
+  end
+
+  class AssociationAssumption < Assumption
+    def assoc_klass_name
+      reflection.class_name
+    end
+
+    def assoc_klass
+      begin
+        return reflection.klass
+      rescue NameError => e
+        raise e if assoc_klass_name && !e.name.include?(assoc_klass_name)
+      end
+      nil
+    end
+
+    def assoc_klass_label
+      labelize(assoc_klass_name, assoc_klass)
+    end
+
+    def assoc_table
+      assoc_klass.try(:table_name) || assoc_klass_name.underscore.downcase.pluralize
+    end
+
+    def assoc_table_label
+      labelize(assoc_table, valid_table?)
+    end
+
+    def valid_table?
+      ActiveRecord::Base.connection.table_exists?(assoc_table)
+    end
+
+    def valid?
+      valid_table? && assoc_klass
+    end
+
+    private
+    attr_reader :reflection
+  end
+
+  class OneToManyAssociationAssumption < AssociationAssumption
+    def fkey_table
+      if reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+        table_name = reflection.active_record.table_name
+      else
+        table_name = assoc_table
+      end
+    end
+
+    def fkey_table_label
+      labelize(fkey_table, valid_fkey_table?)
+    end
+
+    def fkey_column
+      reflection.foreign_key
+    end
+
+    def fkey_column_label
+      labelize(fkey_column, valid_fkey_table? && valid_fkey_column?)
+    end
+
+    def valid_fkey_table?
+      ActiveRecord::Base.connection.table_exists?(fkey_table)
+    end
+
+    def valid_fkey_column?
+      ActiveRecord::Base.connection.column_exists?(fkey_table, fkey_column)
+    end
+
+    def valid?
+      super && valid_fkey_table? && valid_fkey_column?
+    end
+  end
+end

data/lib/association-reporter/reporter.rb

@@ -0,0 +1,38 @@
+require 'colorize'
+require 'association-reporter'
+require 'association-reporter/template'
+require 'association-reporter/assumption'
+
+module AssociationReporter
+  module Reporter
+
+    def describe(association)
+      reflection = self.reflect_on_association(association)
+      raise "Can't find an association #{self.name}##{association}" if reflection.nil?
+
+      if reflection.is_a? ActiveRecord::Reflection::ThroughReflection
+        puts many_to_many_description(reflection)
+      else
+        puts one_to_many_description(reflection)
+      end
+    end
+
+    def many_to_many_description(reflection)
+      template_vars = {
+        reflection: reflection,
+        assumption: AssociationReporter::HasManyThroughAssociationAssumption.new(reflection)
+      }
+      AssociationReporter::Template.render('many_to_many.erb', template_vars)
+    end
+
+    def one_to_many_description(reflection)
+      template_vars = {
+        reflection: reflection,
+        assumption: AssociationReporter::OneToManyAssociationAssumption.new(reflection)
+      }
+
+      AssociationReporter::Template.render('one_to_many.erb', template_vars)
+    end
+
+  end
+end

data/lib/association-reporter/template.rb

@@ -0,0 +1,16 @@
+require 'association-reporter'
+require 'ostruct'
+require 'erb'
+
+module AssociationReporter
+  class Template < OpenStruct
+    def render(template, template_directory=AssociationReporter::TEMPLATES)
+      templ_string = File.read(File.join(template_directory, template))
+      ERB.new(templ_string, 0, '-').result(binding)
+    end
+
+    def self.render(template, locals)
+      Template.new(locals).render(template)
+    end
+  end
+end

data/templates/many_to_many.erb

@@ -0,0 +1,19 @@
+Describing the association <%= reflection.active_record %>#<%= reflection.name %>:
+
+This '<%= reflection.macro %>' association is looking for another association called <%= reflection.active_record %>#<%= assumption.through_name_label %> to jump through.
+
+<% if assumption.through_assumption -%>
+It will go through the association <%= reflection.active_record %>#<%= assumption.through_name_label %> to the model <%= assumption.through_assumption.assoc_klass_label %>.
+<%   if assumption.through_assumption.assoc_klass -%>
+When it gets to <%= assumption.through_assumption.assoc_klass_label %> it <%#
+%><%  if assumption.source_assumption -%>
+will jump through a source association called <%= assumption.through_assumption.assoc_klass_label %>#<%= assumption.source_label %>.
+
+<%= assumption.through_assumption.assoc_klass_label %>#<%= assumption.source_label %> is an association that returns <%= assumption.source_assumption.assoc_klass_label %> objects from the <%= assumption.source_assumption.assoc_table_label %> table.
+<% else -%>
+will try to jump through an association called <%= assumption.through_assumption.assoc_klass_label%>#<%= assumption.source_label %>.
+<% end -%>
+<% end -%>
+<% end -%>
+
+This association is feeling <%= assumption.valid? ? '😃' : '😢' %>

data/templates/one_to_many.erb

@@ -0,0 +1,6 @@
+Describing the association <%= reflection.active_record %>#<%= reflection.name %>:
+
+  This '<%= reflection.macro %>' association is looking for a column called '<%= assumption.fkey_column_label %>' on the table '<%= assumption.fkey_table_label %>'.
+  It's expecting to return <%= reflection.collection? ? "a collection of" : "a"%> <%= assumption.assoc_klass_label %> object<%= reflection.collection? ? "s" : "" %> from the <%= assumption.assoc_table_label %> table.
+
+  This association is feeling <%= assumption.valid? ? '😃' : '😢' %>

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: association-reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Detailed reports for Active Record Associations
+email: mbaker.pdx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- association-reporter.gemspec
+- lib/association-reporter.rb
+- lib/association-reporter/assumption.rb
+- lib/association-reporter/reporter.rb
+- lib/association-reporter/template.rb
+- templates/many_to_many.erb
+- templates/one_to_many.erb
+homepage: https://github.com/mattbaker/association-reporter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Tell me about your has_many
+test_files: []