snip_snip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1db377244c92bb3ad11cd32325360adae82845f4
+  data.tar.gz: e3c3d7ff1afcdc0df5de5b13bd599d6004f82351
+SHA512:
+  metadata.gz: e9b20a7fe43cd61f7532a6ea81a71b6d9b42370cc103c5366668fa10e5573a374d9dd595bfa0b149fd5ed67f1ab410c1aadce8fed8081551b38c6d0d22149eb4
+  data.tar.gz: 03d5eaac57e21cb5c0f48de1423ad332791756d2b3ae3eac3935cd86267d60a35f23a5d327abecbfbfa9392b8238ca92280d94eaf369408f499e0681acf67847

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Kevin Deisz
+
+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,22 @@
+# SnipSnip
+
+[![Build Status](https://travis-ci.org/kddeisz/snip_snip.svg?branch=master)](https://travis-ci.org/kddeisz/snip_snip)
+[![Coverage Status](https://coveralls.io/repos/github/kddeisz/snip_snip/badge.svg?branch=master)](https://coveralls.io/github/kddeisz/snip_snip?branch=master)
+
+SnipSnip tells you what you selected that you shouldn't have in a Rails controller action.
+
+## Usage
+
+Add `SnipSnip` to your Gemfile:
+
+    $ gem 'snip_snip', group: %i[test development]
+
+Open `snip-snip.log`:
+
+    $ tail -f log/snip-snip.log
+
+Hit a controller action and see the output.
+
+## 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,29 @@
+# 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/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/snip_snip.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'forwardable'
+require 'logger'
+
+require 'snip_snip/filter'
+require 'snip_snip/railtie'
+require 'snip_snip/registry'
+require 'snip_snip/reporter'
+
+module SnipSnip
+  def self.logger
+    @logger ||= Logger.new(Rails.root.join('log', 'snip-snip.log'))
+  end
+end

data/lib/snip_snip/filter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module SnipSnip
+  class Filter
+
+    attr_accessor :filtered
+
+    def initialize(filtered = [])
+      filtered << ActiveRecord::InternalMetadata if ActiveRecord.const_defined?(:InternalMetadata)
+      self.filtered = filtered
+    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
+    end
+  end
+end

data/lib/snip_snip/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module SnipSnip
+  class Railtie < Rails::Railtie
+
+    initializer 'snip_snip.load_extensions' do
+      ActiveSupport.on_load(:action_controller) do
+        after_action { Reporter.report(self) }
+      end
+
+      ActiveSupport.on_load(:active_record) do
+        after_find { Registry.register(self) unless Filter.filtered?(self) }
+      end
+    end
+  end
+end

data/lib/snip_snip/registry.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module SnipSnip
+  class Registry
+
+    attr_accessor :records
+
+    def initialize
+      clear
+    end
+
+    def clear
+      self.records = []
+    end
+
+    def each_record(&block)
+      return to_enum(:each_record) unless block_given?
+      records.each(&block)
+    end
+
+    def register(record)
+      records << record
+    end
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :clear, :each_record, :register
+
+      def instance
+        @instance ||= new
+      end
+    end
+  end
+end

data/lib/snip_snip/reporter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module SnipSnip
+  class Reporter
+    Result = Struct.new(:class_name, :primary_key, :unused) do
+      def report
+        @report ||= "#{class_name} #{primary_key}: #{unused.sort.join(', ')}"
+      end
+    end
+
+    attr_accessor :results
+
+    def initialize
+      self.results = find_results
+    end
+
+    def report(controller)
+      return if results.empty?
+
+      SnipSnip.logger.info("#{controller.controller_name}##{controller.action_name}")
+      results.sort_by(&:report).each do |result|
+        SnipSnip.logger.info("  #{result.report}")
+      end
+    ensure
+      Registry.clear
+    end
+
+    def self.report(controller)
+      new.report(controller)
+    end
+
+    private
+
+    def find_results
+      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)
+      end
+    end
+  end
+end

data/lib/snip_snip/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module SnipSnip
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: snip_snip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-11 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'
+  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::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lets you know what you selected that you shouldn't have
+email:
+- kevin.deisz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/snip_snip.rb
+- lib/snip_snip/filter.rb
+- lib/snip_snip/railtie.rb
+- lib/snip_snip/registry.rb
+- lib/snip_snip/reporter.rb
+- lib/snip_snip/version.rb
+homepage: https://github.com/kddeisz/snip_snip
+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.5.1
+signing_key: 
+specification_version: 4
+summary: SnipSnip cuts the deadweight
+test_files: []