flatfoot 0.0.3 → 0.0.4

data/README.md

@@ -42,9 +42,15 @@ After making changes deploying or just to clear out the Redis size you can clear
 
 	FLATFOOT.reset_recordings
 
-If you set the `FLATFOOT` constant in a initializer you can also use the included rake tasks.
+If you set the `FLATFOOT` constant in a initializer you can also use the included rake tasks. Edit your `Rakefile` and add
 
+    require 'flatfoot/tasks'
 
+Then you should have tasks to help view the flatfoot data
+
+    rake flatfoot:reset   # reset tracked views
+    rake flatfoot:unused  # report unused views
+    rake flatfoot:used    # report used views
 
 ## Contributing
 
@@ -53,3 +59,7 @@ If you set the `FLATFOOT` constant in a initializer you can also use the include
 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
+
+## MIT LICENSE
+
+view the LICENSE.txt for details

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+task :default => :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/flatfoot.gemspec

@@ -20,4 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "simplecov"
 end

data/lib/flatfoot/version.rb

@@ -1,3 +1,3 @@
 module Flatfoot
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/flatfoot.rb

@@ -1,4 +1,5 @@
 require "flatfoot/version"
+require 'timeout'
 
 module Flatfoot
   
@@ -13,23 +14,27 @@ module Flatfoot
     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)
+      begin
+        if file = payload[:identifier]
+          unless logged_views.include?(file)
+            logged_views << file
+            store.sadd(tracker_key, file)
+          end
         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)
+        ###
+        # 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
+      rescue Errno::EAGAIN, Timeout::Error
+        #we don't want to raise errors if flatfoot can't reach redis. This is a nice to have not a bring the system down
       end
     end
 

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+require 'test/unit'
+require 'shoulda'
+require 'mocha/setup'
+require 'ostruct'
+
+SimpleCov.start do
+  add_filter 'specs/ruby/1.9.1/gems/'
+  add_filter '/test/'
+  add_filter '/config/'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'flatfoot'

data/test/unit/flatfoot_test.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class ReporterTest < Test::Unit::TestCase
+
+  should "init correctly" do
+    tracker = Flatfoot::Tracker.new("store", {:roots => 'dir'})
+    assert_equal 'dir', tracker.roots.first
+    assert_equal 'store', tracker.store
+    assert_equal [], tracker.logged_views
+  end
+
+  should "track partials" do
+    store = fake_store
+    store.expects(:sadd).with('render_tracker', 'file')
+    tracker = Flatfoot::Tracker.new(store, {:roots => 'dir'})
+    tracker.track_views('name', 'start', 'finish', 'id', {:identifier => 'file'})
+    assert_equal ['file'], tracker.logged_views
+  end
+
+  should "track layouts" do
+    store = fake_store
+    store.expects(:sadd).with('render_tracker', 'layout')
+    tracker = Flatfoot::Tracker.new(store, {:roots => 'dir'})
+    tracker.track_views('name', 'start', 'finish', 'id', {:layout => 'layout'})
+    assert_equal ['layout'], tracker.logged_views
+  end
+
+  should "report used partials" do
+    store = fake_store
+    tracker = Flatfoot::Tracker.new(store, {:roots => 'dir'})
+    tracker.track_views('name', 'start', 'finish', 'id', {:identifier => 'file'})
+    assert_equal ['file'], tracker.used_views
+  end
+
+  should "report unused partials" do
+    store = fake_store
+    Dir.expects(:glob).returns(['file', 'not_used'])
+    tracker = Flatfoot::Tracker.new(store, {:roots => 'dir'})
+    tracker.track_views('name', 'start', 'finish', 'id', {:identifier => 'file'})
+    assert_equal ['not_used'], tracker.unused_views
+  end
+
+  should "reset store" do
+    store = fake_store
+    store.expects(:del).with('render_tracker')
+    tracker = Flatfoot::Tracker.new(store, {:roots => 'dir'})
+    tracker.track_views('name', 'start', 'finish', 'id', {:identifier => 'file'})
+    tracker.reset_recordings
+  end
+
+  protected
+
+  def fake_store
+    store = OpenStruct.new(:del => true)
+    store.data = []
+    def store.sadd(key, val)
+      data << val
+    end
+    def store.smembers(key)
+      data
+    end
+    store
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flatfoot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,70 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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
@@ -59,6 +123,8 @@ files:
 - lib/flatfoot.rb
 - lib/flatfoot/tasks.rb
 - lib/flatfoot/version.rb
+- test/test_helper.rb
+- test/unit/flatfoot_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -74,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3379319623788336714
+      hash: -445969606613763391
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -83,11 +149,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3379319623788336714
+      hash: -445969606613763391
 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: []
+test_files:
+- test/test_helper.rb
+- test/unit/flatfoot_test.rb