controller-usage 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,15 @@
+# Controller Usage
+
+Track usage of Rails 3.x controller actions and identify unused code.
+
+## Synopsis
+
+    echo 'gem "controller_usage"' >> Gemfile
+    bundle install
+    rake -T cu
+    
+## Warning
+
+ * Writes one line to `#{RAILS_ROOT}/log/controller-usage.log` for every page hit.
+ * Has not been extensively tested.
+ 

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ControllerUsage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_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/controller-usage.rb

@@ -0,0 +1,7 @@
+module ControllerUsage
+end
+
+require 'controller-usage/config'
+require 'controller-usage/report'
+require 'controller-usage/subscriber'
+require 'controller-usage/railtie'

data/lib/controller-usage/config.rb

@@ -0,0 +1,7 @@
+module ControllerUsage
+  module Config
+    def log_file
+      Rails.root.join('log', 'controller-usage.log')
+    end
+  end
+end

data/lib/controller-usage/railtie.rb

@@ -0,0 +1,15 @@
+module ControllerUsage
+  class Railtie < Rails::Railtie
+    
+    initializer "controller-usage.initialize" do |app|
+      ActiveSupport.on_load :action_controller do
+        Subscriber.attach
+      end
+    end
+    
+    rake_tasks do
+      load File.expand_path('../tasks.rb', __FILE__)
+    end
+  end
+end
+      

data/lib/controller-usage/report.rb

@@ -0,0 +1,27 @@
+module ControllerUsage
+  class Report
+    include ControllerUsage::Config
+    
+    def available_actions
+      @available_actions ||= begin
+        controllers = Dir[Rails.root.join('app', 'controllers', '*_controller.rb')].map { |filename|
+          File.basename(filename).gsub(/.rb$/, '').camelcase
+        }.uniq.sort
+
+        controllers.map { |controller|  
+          controller.constantize.action_methods.reject { |method|
+            method =~ /^_/
+          }.map do |method|
+            "#{controller}##{method}"
+          end
+        }.flatten.sort
+      end
+    end
+
+    def used_actions
+      @used_actions ||= File.read(log_file).split("\n").map { |line|
+        line.split(' ')[1]
+      }.reject(&:blank?).sort.uniq
+    end
+  end
+end

data/lib/controller-usage/subscriber.rb

@@ -0,0 +1,22 @@
+module ControllerUsage
+  class Subscriber < ActiveSupport::LogSubscriber
+    include ControllerUsage::Config
+    
+    def self.attach
+      attach_to :action_controller
+    end
+    
+    def logger
+      @logger ||= ActiveSupport::BufferedLogger.new(log_file)
+    end
+  
+    def start_processing event
+      begin
+        payload = event.payload
+        logger.info "#{Time.now.tv_sec} #{payload[:controller]}##{payload[:action]}"
+      rescue => e
+        Rails.logger.warn "ControllerUsage Error: " + e.inspect
+      end
+    end
+  end
+end

data/lib/controller-usage/tasks.rb

@@ -0,0 +1,34 @@
+namespace :cu do
+  
+  desc "controllers/actions combinations in this application"
+  task :available do
+    present report.available_actions
+  end
+  
+  desc "controllers/actions found in the log file"
+  task :used do
+    present report.used_actions
+  end
+  
+  desc "controllers/actions in your application that have not been used"
+  task :unused do
+    present report.available_actions.reject { |action| 
+      report.used_actions.include? action
+    }
+  end 
+  
+  desc "controllers/actions found in the log file but not found in your application"
+  task :missing do
+    present report.used_actions.reject { |action|
+      report.available_actions.include? action
+    }
+  end
+  
+  def report
+    @report ||= ControllerUsage::Report.new
+  end
+  
+  def present collection
+    puts collection.join("\n")
+  end
+end

data/lib/controller-usage/version.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: controller-usage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70285346405800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285346405800
+description: Track usage of controllers and actions.
+email:
+- mipearson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/controller-usage/config.rb
+- lib/controller-usage/railtie.rb
+- lib/controller-usage/report.rb
+- lib/controller-usage/subscriber.rb
+- lib/controller-usage/tasks.rb
+- lib/controller-usage/version.rb
+- lib/controller-usage.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/mipearson/controller-usage
+licenses: []
+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: 176627699327490862
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 176627699327490862
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Track usage of controllers and actions.
+test_files: []