attribute-stats 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc768178279a193172676127468cc10c3f9ee32
-  data.tar.gz: bdef7d993c67edcf4e8b7ca07fa6f9ac13820eba
+  metadata.gz: d3eb42d4e6bfaa776c008a282bff30bc5a7c2d8b
+  data.tar.gz: fdfc70d6b97178fef60d2591f5306f9c9c8de366
 SHA512:
-  metadata.gz: 542a32dfb641a8e486c4310249b46403f22c322d39cdbdaeabfdba468ef238e72b009275dd4f7bbe8fe04e7b777abb0612654ca3d2d0da4837b3800615c57c50
-  data.tar.gz: 7d75586f3939d08b5939b6edbf7807c7eeccb3a98c275f3d6b0ef89a5cdf0692d710d452b81c00273cbe6ae2b050cc7c98403b77cd02606ee50599c39aa9d32d
+  metadata.gz: 808e7afbeb002cfc3f895f054f476a82bf20a653d0a324a4aab0cef53af9088e870264c82a7ca232344bd32291a6dcb1298a7cc274d4bc0cea4a8959a5c0dc97
+  data.tar.gz: 57253da7c993ea883cc6024b15c03f3e7e9d6f21689858dab24076df494ad6146650f8c19da7ef06587720c7a65c6db31a36aee013dc344c7f179be7458171f8

data/README.md

@@ -18,17 +18,26 @@ Add `gem 'attribute-stats'` to your Gemfile, bundle, and follow the Usage instru
 
 You can use `AttributeStats` from within Rails (or a Rails console):
 
-    irb:1> stats = AttributeStats::StatsGenerator.new()
+    irb:1> stats = AttributeStats::StatsGenerator.new
+
     irb:2> stats.attribute_usage
     => {...} # 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
-    irb:4> stats.dormant_tables
+
+    irb:4> stats.unused_attribute_references
+    => [...] # a list counts of references to unused attributes in application code
+
+    irb:5> stats.dormant_tables
     => [...] # a list of your tables which have not been updated in awhile
-    irb:5> stats.migration
+
+    irb:6> stats.migration
     => # sample migration up/down to remove your unused attributes
-    irb:6> stats.set_formatter :json
-    irb:7> stats.migration # returns json instead of a hash
+
+    irb:7> stats.set_formatter :json
+
+    irb:8> stats.migration # returns json instead of a hash
 
 ### Rake Tasks
 
@@ -37,6 +46,7 @@ Rake tasks are available once you've installed the gem in your Gemfile and bundl
 * rake db:stats:dormant_tables
 * rake db:stats:attribute_usage
 * rake db:stats:unused_attributes
+* rake db:stats:unused_attribute_references
 * rake attribute-stats:generate_migration
 
 Each allows you to change the output to JSON if you'd like to pipe it into another application.
@@ -55,6 +65,18 @@ i.e. `rake db:stats:unused_attributes[true,json,false]`
 
 ---
 
+#### rake db:stats:unused_attribute_references
+For all unused attributes, outputs the number of times the attribute name is referenced in repo's app, views, config, and spec folders (except app/assets). This finds references which are symbols, wrapped in quotes, or accessed via dot notation. It is imprecise but gives you an idea of attributes may be used in the application code.
+
+**Argument Options:**
+1. consider_defaults_unused: true or false (default: false). This option considers attributes set to the databse default value to be unused.
+2. format: tabular, json  (default: tabular)
+3. verbose: true, false (default: true)
+
+i.e. `rake db:stats:unused_attribute_references[true,json,false]`
+
+---
+
 #### rake db:stats:attribute_usage
 Lists usage statistics for all attributes (count and percent which are unused). Note: this does a full scan of your tables, so it will be slow for tables with a lot of data.
 
@@ -96,8 +118,6 @@ The gem does not support:
 
 The gem is tested and works with Rails version 4.2 through 5.2, with `mysql2`, `sqlite3`, and `postgresql` database adapters. You can view all tested dependency sets in [Appraisals](Appraisals)
 
-*Due to changes in ActiveRecord between 4.1 and 4.2, the gem breaks in versions below 4.2. In a future version of `attribute-stats`, I intend to add support to previous versions of Rails (at least back to 4.0).*
-
 ## Testing the gem
 
 To test the gem against the current version of Rails (in [Gemfile.lock](Gemfile.lock)) and sqlite:

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

@@ -0,0 +1,15 @@
+require 'attribute-stats'
+namespace :db do
+	namespace :stats do
+		desc "Count source code references to unused attributes [options CONSIDER_DEFAULTS_UNUSED: false, FORMAT: json, tabular, VERBOSE: false]"
+		task :unused_attribute_references, [:consider_defaults_unused,:format,:verbose] => :environment do |task, args|
+			args.with_defaults(consider_defaults_unused: 'false', format: 'tabular', verbose: 'true')
+      options = {
+        consider_defaults_unused: args[:consider_defaults_unused].downcase != 'false',
+                       formatter: args[:format],
+                         verbose: args[:verbose].downcase != 'false',
+                          source: :cli }
+      AttributeStats::StatsGenerator.new(options).unused_attribute_references
+		end
+	end
+end

data/lib/attribute-stats/version.rb

@@ -1,3 +1,3 @@
 module AttributeStats
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/entities/attribute_info.rb

@@ -1,9 +1,10 @@
 module AttributeStats
   class AttributeInfo
-    attr_reader :count, :usage_percent, :name, :empty
+    attr_reader :count, :usage_percent, :name, :empty, :references
 
     def initialize(attribute_name)
       @name = attribute_name
+      @references = Hash.new(0)
     end
 
     def set_usage(record_count, table_total_record_count)
@@ -19,5 +20,13 @@ module AttributeStats
     def empty?
       @empty
     end
+
+    def set_reference(reference_type, count)
+      references[reference_type] += count
+    end
+
+    def total_references
+      references.values.sum
+    end
   end
-end
+end

data/lib/entities/table_data.rb

@@ -37,14 +37,18 @@ module AttributeStats
       attribute
     end
 
-    def unused_attributes
-      @unused_attributes ||= begin
+    def unused_attribute_info
+      @unused_attribute_info ||= begin
         attrs = []
         @attributes.each do |attribute|
-          attrs << attribute.name if attribute.empty?
+          attrs << attribute if attribute.empty?
         end
         attrs
       end
     end
+
+    def unused_attributes
+      @unused_attributes ||= unused_attribute_info.map(&:name)
+    end
   end
 end

data/lib/formatters/hash_formatter.rb

@@ -5,6 +5,24 @@ module AttributeStats
       @options, @table_info, @migration = options, table_info, migration
     end
 
+    def output_attribute_references
+      output = []
+      @table_info.each do |table_info|
+        table_info.attributes.each do |attribute|
+          next unless attribute.empty?
+          output << {
+                      model: table_info.name,
+                  attribute: attribute.name,
+             all_references: attribute.total_references,
+            code_references: attribute.references['app'],
+            spec_references: attribute.references['spec'],
+            view_references: attribute.references['views']
+          } 
+        end
+      end
+      output.sort!{|a,b| a[:all_references] <=> b[:all_references]}
+    end
+
     def output_all_attributes
       output = []
       @table_info.each do |table_info|

data/lib/formatters/json_formatter.rb

@@ -1,6 +1,10 @@
 module AttributeStats
   class JSONFormatter < HashFormatter
 
+    def output_attribute_references
+      super.to_json
+    end
+
     def output_all_attributes
       super.to_json
     end

data/lib/formatters/tabular_formatter.rb

@@ -28,6 +28,30 @@ module AttributeStats
       @buffer
     end
 
+    def output_attribute_references
+      output = []
+      @table_info.each do |table_info|
+        table_info.attributes.each do |attribute|
+          next unless attribute.empty?
+          output << {
+                      model: table_info.name,
+             attribute_name: attribute.name,
+             all_references: attribute.total_references,
+                       code: attribute.references['app'],
+                      specs: attribute.references['spec'],
+                      views: attribute.references['views']
+          } 
+        end
+      end
+      output.sort!{|a,b| a[:all_references] <=> b[:all_references]}
+      if output.empty?
+        puts "No unused attributes found"
+      else
+        print_table output, title: ['Attribute Code References', 'Mentions of the attribute name in app/ (except assets), lib/, config/, and spec/', '(symbol or dot notation, or wrapped in quotes)']
+      end
+      @buffer
+    end
+
     def output_dormant_tables
       output = []
       @table_info.each do |table_info|
@@ -106,7 +130,8 @@ module AttributeStats
 
     def header_order(column_names)
       [:model, :table_name, :attribute_name,
-        :last_updated, :set_count, :set_percent] & column_names
+        :last_updated, :set_count, :set_percent,
+        :code, :views, :specs] & column_names
     end
 
     def formatted_headers(column_names)

data/lib/migration_generator/generate_migration.rb

@@ -1,8 +1,7 @@
 module AttributeStats
   class GenerateMigration
-    def initialize(table_info: nil, options: {})
+    def initialize(table_info: [], options: {})
       @table_info, @options = table_info, options
-      @table_info || set_table_info
     end
 
     def output_migration
@@ -13,12 +12,6 @@ module AttributeStats
       migration_file_path
     end
 
-    def set_table_info
-      stats_generator = AttributeStats::StatsGenerator.new(@options)
-      stats_generator.send(:fetch_empty_attributes)
-      @table_info = stats_generator.table_info
-    end
-
     private
 
     def migration_file_path

data/lib/migration_generator/migration_template_contents.rb

@@ -1,9 +1,7 @@
 module AttributeStats
   class MigrationTemplateContents
-    def initialize(table_info: nil, migration_class_suffix: nil)
-      @table_info = table_info
-      @table_info || set_table_info
-      @migration_class_suffix = migration_class_suffix
+    def initialize(table_info: [], migration_class_suffix: nil)
+      @table_info, @migration_class_suffix = table_info, migration_class_suffix
       @migration_buffer = ''
       @table_info.each do |table_info|
         add_migrations_for_table_to_buffer(table_info)
@@ -24,12 +22,6 @@ end
       output
     end
 
-    def set_table_info
-      stats_generator = AttributeStats::StatsGenerator.new
-      stats_generator.send(:fetch_empty_attributes)
-      @table_info = stats_generator.table_info
-    end
-
     private
 
     # This is a modified version of the ActiveRecord::SchemaDumper#table method.

data/lib/stats_generation/set_attribute_references.rb

@@ -0,0 +1,105 @@
+require_relative 'terminal'
+module AttributeStats
+  class SetAttributeReferences
+    include Terminal
+    attr_reader :table_info
+
+    def initialize(table_info: [], options: {})
+      @table_info, @options = table_info, options
+    end
+
+    def execute
+      @executed ||= begin
+        lookup_and_set_attribute_counts
+        true
+      end
+    end
+
+    private
+
+    def lookup_and_set_attribute_counts
+      @table_info.each_with_index do |t,index|
+        @table_count = index
+        @current_table = t
+        fetch_table_stats
+      end
+      erase_line if @options[:verbose]
+      true
+    end
+
+    private
+
+    def fetch_table_stats
+      print("Finding Code References #{in_color(@current_table.name,@table_count)} ") if @options[:verbose]
+      set_reference_counts
+      erase_line if @options[:verbose]
+    end
+
+    def set_reference_counts
+      @current_table.unused_attribute_info.each do |attribute_info|
+        count = set_attribute_reference_count(attribute_info)
+        next unless @options[:verbose]
+        print count.zero? ? green('✓') : red('x')
+      end
+    end
+
+    def set_attribute_reference_count(attribute_info)
+      files = `grep -rcE "#{regexes(attribute_info).join('|')}" --exclude-dir={#{regex_exclude_paths.join(',')}} #{regex_target_paths.join(' ')}`
+      attribute_total = 0
+      files.scan(/(.*):(\d+)(?:\n|\z)/).each do |matches|
+        next if matches[0].nil?
+        filename, count = matches[0], matches[1].to_i
+        next if count == 0
+        attribute_total += count
+        attribute_info.set_reference section(filename), count
+      end
+      attribute_total
+    end
+
+    def regexes(attribute_info)
+      [
+        "\\\"#{attribute_info.name}\\\"",                # "my_attribute_name"
+        "'#{attribute_info.name}'",                      # 'my_attribute_name'
+        "\\:#{attribute_info.name}[^A-Za-z_]?",           # :my_attribute_name
+        "\\.#{attribute_info.name}[^A-Za-z_]?",           # .my_attribute_name
+        # "[^A-Za-z_]#{attribute_info.name}[^A-Za-z_]",  #  my_attribute_name (standalone word)
+      ]
+    end
+
+    def regex_target_paths
+      directories = @options[:include_directories] || %w(app lib config spec)
+      if regex_base_path
+        directories.map do |directory|
+          File.join regex_base_path, directory
+        end
+      else
+        directories
+      end
+    end
+
+    def regex_exclude_paths
+      directories = @options[:exclude_directories] || %w(app/assets db public)
+      if regex_base_path
+        directories.map do |directory|
+          File.join regex_base_path, directory
+        end
+      else
+        directories
+      end
+    end
+
+    def section(filename)
+      if filename =~ /\A#{regex_base_path}\/spec\//
+        'spec'
+      elsif filename =~ /\A#{regex_base_path}\/app\/views\//
+        'views'
+      else
+        'app'
+      end
+    end
+
+    def regex_base_path
+      @options[:rails_root]
+    end
+  end
+end

data/lib/stats_generation/stats_generator.rb

@@ -34,6 +34,12 @@ module AttributeStats
       GenerateMigration.new(table_info: table_info, options: options).output_migration
     end
 
+    def unused_attribute_references
+      fetch_empty_attributes
+      SetAttributeReferences.new(table_info: table_info, options: options).execute
+      output formatter.output_attribute_references
+    end
+
     def set_formatter(formatter_type)
       formatter_was = options[:formatter]
       case formatter_type.to_s.downcase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribute-stats
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Hodges
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,6 +136,7 @@ files:
 - lib/attribute-stats/tasks/dormant.rake
 - lib/attribute-stats/tasks/list_models.rake
 - lib/attribute-stats/tasks/migration.rake
+- lib/attribute-stats/tasks/unused_attribute_references.rake
 - lib/attribute-stats/tasks/unused_attributes.rake
 - lib/attribute-stats/version.rb
 - lib/entities/attribute_info.rb
@@ -145,6 +146,7 @@ files:
 - lib/formatters/tabular_formatter.rb
 - lib/migration_generator/generate_migration.rb
 - lib/migration_generator/migration_template_contents.rb
+- lib/stats_generation/set_attribute_references.rb
 - lib/stats_generation/set_attribute_stats.rb
 - lib/stats_generation/set_dormant_tables.rb
 - lib/stats_generation/stats_generator.rb