flatfoot 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flatfoot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dan Mayer
+
+MIT License
+
+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,51 @@
+# Flatfoot
+
+[Flatfoot is a synonym for tracker](http://thesaurus.com/browse/tracker). As the name RenderTracker seemed generic, and gumshoe my favorite was taken.
+
+This gem will help you track unused views in your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flatfoot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flatfoot
+
+## Usage
+
+To use this gem, just initialize it in some initializer like `config/initializers/notifications.rb`
+
+then create an instance and subscribe it to `ActiveSupport::Notifications` events.
+
+    FLATFOOT = Flatfoot::Tracker.new(Redis.new)
+
+	ActiveSupport::Notifications.subscribe /render_partial.action_view|render_template.action_view/ do |name, start, finish, id, payload|
+	  FLATFOOT.track_views(name, start, finish, id, payload) unless name.include?('!') 
+    end
+
+Start up your app and then in console you can check used views or unused views
+
+	FLATFOOT.used_views
+	=> ["app/views/layouts/_old_layout.html.erb",...
+	
+	FLATFOOT.unused_views
+    => ["app/views/something/_old_partial.html.erb",...
+
+After making changes deploying or just to clear out the Redis size you can clear the saved data.
+
+	FLATFOOT.reset_recordings
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/flatfoot.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flatfoot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flatfoot"
+  spec.version       = Flatfoot::VERSION
+  spec.authors       = ["Dan Mayer"]
+  spec.email         = ["dan.mayer@livingsocial.com"]
+  spec.description   = %q{Discover dead view files in your app. Track view layer render usage}
+  spec.summary       = %q{Discover dead view files in your app. Track view layer render usage}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/flatfoot/version.rb

@@ -0,0 +1,3 @@
+module Flatfoot
+  VERSION = "0.0.1"
+end

data/lib/flatfoot.rb

@@ -0,0 +1,68 @@
+require "flatfoot/version"
+
+module Flatfoot
+  
+  class Tracker
+
+    attr_accessor :store, :logged_views, :roots
+
+    def initialize(store, options = {})
+      @store = store
+      @logged_views = []
+      @roots = options.fetch(:roots){ "#{Rails.root.to_s}/" }.split(',')
+    end
+    
+    def track_views(name, start, finish, id, payload)
+      if file = payload[:identifier]
+        unless logged_views.include?(file)
+          logged_views << file
+          store.sadd(tracker_key, file)
+        end
+      end
+      ###
+      # Annoyingly while you get full path for templates
+      # notifications only pass part of the path for layouts dropping any format info
+      # such as .html.erb or .js.erb
+      # http://edgeguides.rubyonrails.org/active_support_instrumentation.html#render_partial-action_view
+      ###
+      if layout_file = payload[:layout]
+        unless logged_views.include?(layout_file)
+          logged_views << layout_file
+          store.sadd(tracker_key, layout_file)
+        end
+      end
+    end
+
+    def used_views
+      views = store.smembers(tracker_key)
+      normalized_views = []
+      views.each do |view|
+             roots.each do |root|
+                    view = view.gsub(/#{root}/,'')
+                  end
+             normalized_views << view
+           end
+      normalized_views
+    end
+
+    def unused_views
+      all_views = Dir.glob('app/views/**/*.html.erb').reject{|file| file.match(/(_mailer)/)}
+      recently_used_views = used_views
+      all_views = all_views.reject{ |view| recently_used_views.include?(view) }
+      # since layouts don't include format we count them used if they match with ANY formats
+      all_views = all_views.reject{ |view| view.match(/\/layouts\//) && recently_used_views.any?{|used_view| view.include?(used_view)} }
+    end
+
+    def reset_recordings
+      store.del(tracker_key)
+    end
+
+    private
+
+    def tracker_key
+      'render_tracker'
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: flatfoot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Mayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Discover dead view files in your app. Track view layer render usage
+email:
+- dan.mayer@livingsocial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flatfoot.gemspec
+- lib/flatfoot.rb
+- lib/flatfoot/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -649716077801071903
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -649716077801071903
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Discover dead view files in your app. Track view layer render usage
+test_files: []