snip_snip 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1db377244c92bb3ad11cd32325360adae82845f4
-  data.tar.gz: e3c3d7ff1afcdc0df5de5b13bd599d6004f82351
+  metadata.gz: 062261f05f636bb28b9196d5c084d17cfa4b31c6
+  data.tar.gz: 10bca413ac95b6bcf7fb6b6b7fddf9f01ed04e88
 SHA512:
-  metadata.gz: e9b20a7fe43cd61f7532a6ea81a71b6d9b42370cc103c5366668fa10e5573a374d9dd595bfa0b149fd5ed67f1ab410c1aadce8fed8081551b38c6d0d22149eb4
-  data.tar.gz: 03d5eaac57e21cb5c0f48de1423ad332791756d2b3ae3eac3935cd86267d60a35f23a5d327abecbfbfa9392b8238ca92280d94eaf369408f499e0681acf67847
+  metadata.gz: 8fdaf95d1674c764032cad5706d195c8842b19badf348fa16d81ca1edeed25beaed99fa881eefc56692c3be566e8cca84b12f53a4c6bbbc1cf61af68717c595d
+  data.tar.gz: 7911d7040597f852ca55a1c6b74e48f68b19a58c0d8fd0ee4c0987145300183f32cbb0d87190b6492726cb21809db7a4e6d599634740900b4a2723bc650394b3

data/Rakefile

@@ -1,23 +1,11 @@
-# frozen_string_literal: true
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SnipSnip'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
+require 'bundler/setup'
 require 'bundler/gem_tasks'
-
 require 'rake/testtask'
+require 'yard'
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.stats_options = ['--list-undoc']
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'

data/lib/snip_snip.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-require 'forwardable'
 require 'logger'
 
 require 'snip_snip/filter'
@@ -7,7 +5,9 @@ require 'snip_snip/railtie'
 require 'snip_snip/registry'
 require 'snip_snip/reporter'
 
+# Top-level wrapper module.
 module SnipSnip
+  # The logger object used to report unused columns.
   def self.logger
     @logger ||= Logger.new(Rails.root.join('log', 'snip-snip.log'))
   end

data/lib/snip_snip/filter.rb

@@ -1,26 +1,22 @@
-# frozen_string_literal: true
 module SnipSnip
+  # Classes to filter out of the tracking when looking at which columns were
+  # selected.
   class Filter
-
-    attr_accessor :filtered
+    attr_reader :filtered
 
     def initialize(filtered = [])
-      filtered << ActiveRecord::InternalMetadata if ActiveRecord.const_defined?(:InternalMetadata)
-      self.filtered = filtered
+      @filtered = filtered
+
+      return unless ActiveRecord.const_defined?(:InternalMetadata)
+      @filtered << ActiveRecord::InternalMetadata
     end
 
     def filtered?(record)
       filtered.any? { |filter| record.is_a?(filter) }
     end
 
-    class << self
-      def filtered?(record)
-        instance.filtered?(record)
-      end
-
-      def instance
-        @instance ||= new
-      end
+    def self.filtered?(record)
+      (@instance ||= new).filtered?(record)
     end
   end
 end

data/lib/snip_snip/railtie.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
 module SnipSnip
+  # Hooks into Rails to track when columns are selected but not necessary.
   class Railtie < Rails::Railtie
-
     initializer 'snip_snip.load_extensions' do
       ActiveSupport.on_load(:action_controller) do
+        before_action { Registry.clear }
         after_action { Reporter.report(self) }
       end
 

data/lib/snip_snip/registry.rb

@@ -1,33 +1,47 @@
-# frozen_string_literal: true
 module SnipSnip
+  # A list of records that were found during the course of the last request
+  # on which we are tracking columns.
   class Registry
-
-    attr_accessor :records
+    attr_reader :records
 
     def initialize
       clear
     end
 
+    # Wipe the registry clear of found objects so that we don't report on them
+    # twice.
     def clear
-      self.records = []
+      @records = []
     end
 
+    # Loop through each record that was found during the lifespan of this
+    # registry
     def each_record(&block)
       return to_enum(:each_record) unless block_given?
       records.each(&block)
     end
 
+    # Add a record to this registry
     def register(record)
       records << record
     end
 
     class << self
-      extend Forwardable
-      def_delegators :instance, :clear, :each_record, :register
-
+      # The singleton instance of this registry.
       def instance
         @instance ||= new
       end
+
+      # Delegate all missing methods to the singleton instance.
+      def method_missing(method, *args, &block)
+        return super unless respond_to_missing?(method)
+        instance.public_send(method, *args, &block)
+      end
+
+      # Respond to all of the missing methods on the singleton instance.
+      def respond_to_missing?(method)
+        instance.respond_to?(method)
+      end
     end
   end
 end

data/lib/snip_snip/reporter.rb

@@ -1,22 +1,29 @@
-# frozen_string_literal: true
 module SnipSnip
+  # Handles outputting unnecessarily selected columns to the logs.
   class Reporter
-    Result = Struct.new(:class_name, :primary_key, :unused) do
-      def report
-        @report ||= "#{class_name} #{primary_key}: #{unused.sort.join(', ')}"
+    # Represents a result that has unused columns.
+    Result =
+      Struct.new(:class_name, :primary_key, :unused) do
+        # A string representing the unused columns for the given record.
+        def report
+          @report ||= "#{class_name} #{primary_key}: #{unused.sort.join(', ')}"
+        end
       end
-    end
 
-    attr_accessor :results
+    attr_reader :results
 
     def initialize
-      self.results = find_results
+      @results = find_results
     end
 
+    # Report on the unused columns that were selected during the course of the
+    # processing the action on the given controller.
     def report(controller)
       return if results.empty?
 
-      SnipSnip.logger.info("#{controller.controller_name}##{controller.action_name}")
+      action_display = "#{controller.controller_name}##{controller.action_name}"
+      SnipSnip.logger.info(action_display)
+
       results.sort_by(&:report).each do |result|
         SnipSnip.logger.info("  #{result.report}")
       end
@@ -24,6 +31,7 @@ module SnipSnip
       Registry.clear
     end
 
+    # Report on the specified controller.
     def self.report(controller)
       new.report(controller)
     end
@@ -34,11 +42,13 @@ module SnipSnip
       Registry.each_record.each_with_object([]) do |record, records|
         accessed = record.accessed_fields
         unused = (record.attributes.keys - accessed)
-        next if unused.empty?
-
-        primary_key = record.class.primary_key
-        records << Result.new(record.class.name, record.send(primary_key), unused)
+        records << result_from(record, unused) if unused.any?
       end
     end
+
+    def result_from(record, unused)
+      primary_key = record.class.primary_key
+      Result.new(record.class.name, record.public_send(primary_key), unused)
+    end
   end
 end

data/lib/snip_snip/version.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
 module SnipSnip
-  VERSION = '0.0.1'
+  # The current version of the gem.
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,37 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: snip_snip
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.beta4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.beta4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: SnipSnip cuts the deadweight