attribute-stats 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02a8733b9a9fee7f8391d8855ee3d1a9106f1196
-  data.tar.gz: 2b07627c92d58fa5ac459ed1fbb8ab27493d1390
+  metadata.gz: 7c859c509e53910fa8ae29b43e7c34843a9da02f
+  data.tar.gz: 6355de45fcd0dea7370e39665d801b5a8bf79983
 SHA512:
-  metadata.gz: bcdfba6645eea57014decabf2e8ba5ee935cf6fa3285c545622a59b8e2c13c87512b628824d551b0be8bfc7f95e3fa113043facc720025084371f2a9676bdac0
-  data.tar.gz: f6f439d0aeac841c04846708bdd90a40550afeda98710a1d497f8f5a0ce9968f27a3f304c8ef24e8d15dd39647a9b45a2c51251322bee2459c7290a28ac280cb
+  metadata.gz: e97db1b7cf0a71d90f095e9922f4e1f1d0d801738e331f3f3c052fe5a44d118ca59521138d339b7bc203efcc9808fac1b0af39e50ee26dd4f7c0c78cb62dab7c
+  data.tar.gz: 0774b4ac6d48cfadeec8b8a807f06a87b462b16296967976a00bdaa607080f7dc9ad0589006bdcdfed59b854afd3fc0576cf43ffd8bd45f43c8ea6b10db422a0

data/README.md

@@ -1,10 +1,10 @@
 Attribute Stats gives you insight into which persisted attributes are actually used in your Rails models. Whether you're joining an existing project or have been using it for years, get a quick look at the landscape of the database.
 
 It helps you find smells in your project:
-- Attributes which have never had data set (indicates a potentially forgotten attribute)
-- Tables which haven't been updated for X years (indicates a potentially unused or legacy model)
-- Attributes used by very few objects in your table (is this being used? Should it be an attribute?)
-- Attributes which are all set to the default value (if they're all default, is this really being used?)
+- **Attributes are completely empty in the database** (smells like a potentially unused attribute)
+- **Tables which haven't been updated for X years** (smells like a potentially unused or legacy model)
+- **Attributes used by very few objects in your table** (smells like something that maybe shouldn't be an attribute)
+- **Attributes which are all set to the default value** (if they're all default, is this really being used?)
 
 ## Installation
 
@@ -12,8 +12,6 @@ It helps you find smells in your project:
 
 Add `gem 'attribute-stats'` to your Gemfile, bundle, and follow the Usage instructions below.
 
-View [attribute-stats on RubyGems](https://rubygems.org/gems/attribute-stats) for more info, or just read the [gemspec](attribute-stats.gemspec).
-
 ## Usage
 
 ### Programmatic
@@ -22,11 +20,11 @@ You can use `AttributeStats` from within Rails (or a Rails console):
 
     irb:1> stats = AttributeStats::StatsGenerator.new()
     irb:2> stats.attribute_usage
-    => # a list of your attributes and what % of records have a value set
+    => {...} # a list of your attributes and what % of records have a value set
     irb:3> stats.unused_attributes
-    => # a list of your attributes which have no value set in the database
+    => {...} # a list of your attributes which have no value set in the database
     irb:4> stats.dormant_tables
-    => # a list of your tables which have not been updated in awhile
+    => [...] # a list of your tables which have not been updated in awhile
     irb:5> stats.migration
     => # sample migration up/down to remove your unused attributes
     irb:6> stats.set_formatter :json
@@ -94,7 +92,6 @@ Generates a sample migration syntax to remove all unused attributes. (This is ju
 The gem does not support:
 
 1. Detection of unset encrypted attributes. `attribute-stats` works by searching for empty values using SQL. If you are encrypting data before storing it in the database, a value of `nil` might have a value in the database which, decrypted, equals `nil`.
-1. Custom table names. If you are defining a model called House, and configure the model to use the table 'domiciles' instead of 'houses', `attribute-stats` skips analysis of the table. *(TODO: fix)*
 1. Tables not associated with a model. If your database has tables which do not correspond with a model (see point #2), `attribute-stats` skips analysis of that table. *(TODO: fix)*
 
 ## Compatability
@@ -117,6 +114,6 @@ Or, you can run tests for all supported Rails versions and supported databases:
 1. `bundle exec appraisal install` *(this Generates gemfiles for all permutations of our dependencies, so you'll see lots of bundler output))*
 1. `bundle exec appraisal rspec`. *(This runs rspec for each dependency permutation. If one fails, appraisal exits immediately and does not test permutations it hasn't gotten to yet. Tests are not considered passing until all 12 permutations are passing)*
 
-If you only want to test a certain dependency set, such as Rails 5.2 for MySQL: `bundle exec appraisals rails-5-2-mysql`. In this case, you would *not* need to configure postgresql in your database.yml, nor have postgres running on your machine.
+If you only want to test a certain dependency set, such as Rails 5.2 for MySQL: `bundle exec appraisals rails-5-2-mysql rspec`. In this case, you would *not* need to configure postgresql in your database.yml, nor have postgres running on your machine.
 
 You can view all available dependency sets in [Appraisals](Appraisals)

data/lib/attribute-stats/tasks/list_models.rake

@@ -0,0 +1,10 @@
+require 'attribute-stats'
+namespace :db do
+  namespace :stats do
+    desc "list all models"
+    task :list_models => :environment do
+      # puts Rails.application.eager_load!
+      puts ActiveRecord::Base.descendants.inspect
+    end
+  end
+end

data/lib/attribute-stats/version.rb

@@ -1,3 +1,3 @@
 module AttributeStats
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/stats_generation/stats_generator.rb

@@ -116,7 +116,9 @@ module AttributeStats
     end
 
     def setup_table_and_model(table)
-      @table_info << TableData.new(table.classify.constantize)
+      ar_class = ActiveRecord::Base.descendants.detect{|klass| klass.table_name == table }
+      return if ar_class.name == 'ActiveRecord::InternalMetadata' # Table for Rails 5 internal use only
+      @table_info << TableData.new(ar_class || table.classify.constantize)
     rescue NameError => ex
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribute-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steve Hodges
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-08 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -134,6 +134,7 @@ files:
 - lib/attribute-stats/railtie.rb
 - lib/attribute-stats/tasks/attribute_usage.rake
 - lib/attribute-stats/tasks/dormant.rake
+- lib/attribute-stats/tasks/list_models.rake
 - lib/attribute-stats/tasks/migration.rake
 - lib/attribute-stats/tasks/unused_attributes.rake
 - lib/attribute-stats/version.rb
@@ -160,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="