filter_decrufter 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd9c4f9c59da12771bbf12d09fadb5ce6fe282a3
+  data.tar.gz: 115f66febd38a0cefc999919eccb2ae03a2f09af
+SHA512:
+  metadata.gz: 25fa82579c3e2c0daf3b620b1fd1800632cc20a1108dac15bc359e7d38a0082b40dd49aa3ca8a8e068bebdbdb0de274e59005d0d1fb2620888378a8059bdf4ca
+  data.tar.gz: a469df57be33490c3dcc4ea499085a3f61b215815a6859b8954da39d38f73e7c04382360599594ee64188de23636a4bee50f55ff0105d124f2f2aab2a407a4bd

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.3 (2015-02-18)
+
+* [FIXED] No longer reports all violations as being for before_filters
+* [NEW] Rake tasks are required automatically now
+
+## 0.0.2 (2015-02-17)
+
+* [NEW] Works fine with Ruby 1.9.3
+
+## 0.0.1 (2015-02-16)
+
+* [NEW] Initial release

data/README.md

@@ -0,0 +1,29 @@
+# FilterDecrufter
+
+FilterDecrufter is a little utility for cleaning up before_filters.
+
+Suppose you have a Rails controller with a before_filter:
+
+    before_filter :load_widget, :only => [:show, :frobnicate]
+
+If you've deleted the frobnicate action, Rails won't complain.  But FilterDecrufter will!
+
+# Usage
+
+Add it to your Gemfile in the development group:
+
+    # In your Gemfile
+    gem 'filter_decrufter'
+
+Run the task!
+
+    $ bundle exec rake filter_decrufter:check 
+    Api::V1::WidgetsController before_filter 'find_widget' has an :only constraint with a non-existent action name 'show'
+    EmployeesController after_filter 'set_name' has an :only constraint with a non-existent action name 'frobnicate'
+
+Tested with Rails 3.2.
+
+# Credits
+
+* Tom Copeland - author
+* John Moon - design discussions

data/lib/filter_decrufter.rb

@@ -0,0 +1,2 @@
+require 'filter_decrufter/checker'
+require 'filter_decrufter/tasks'

data/lib/filter_decrufter/checker.rb

@@ -0,0 +1,103 @@
+module FilterDecrufter
+
+  class Hit
+
+    attr_accessor :controller_class, :before_filter_name, :options, :filter_type
+
+    def initialize(controller_class, before_filter_name, options, filter_type)
+      @controller_class = controller_class
+      @before_filter_name = before_filter_name
+      @options = options
+      @filter_type = filter_type
+    end
+
+    def actions_include?(action_name)
+      action_methods.include?(action_name)
+    end
+
+    def populated_only_except_options
+      options.select {|opt_name,opt_value| [:only,:except].include?(opt_name) && !opt_value.empty? }
+    end
+
+    private
+
+    def action_methods
+      controller_class.action_methods.map &:to_sym
+    end
+
+  end
+
+  class Report
+
+    attr_accessor :hits
+
+    def self.instance
+      @instance ||= Report.new
+    end
+
+    def initialize
+     @hits = []
+    end
+
+    def add(hit)
+      raise "Oops filter_decrufter can't handle this version of Rails" unless hit.controller_class.respond_to?(:action_methods)
+      hits << hit
+    end
+
+    def find_problems
+      hits.each do |hit|
+        hit.populated_only_except_options.each do |k,v|
+          [:only, :except].each do |constraint_name|
+            check_constraint(constraint_name, hit) if hit.populated_only_except_options[constraint_name].present?
+          end
+        end
+      end
+    end
+
+    def check_constraint(name, hit)
+      [hit.populated_only_except_options[name]].flatten.each do |action_syms|
+        [action_syms].flatten.each do |action_name|
+          if !hit.actions_include?(action_name)
+            puts "#{hit.controller_class} #{hit.filter_type} '#{hit.before_filter_name}' has an :#{name} constraint with a non-existent action name '#{action_name}'"
+          end
+        end
+      end
+    end
+
+  end
+
+  class Checker
+
+    def initialize
+      raise "This is a Rails utility" unless defined?(Rails)
+      raise "Oops filter_decrufter can't handle this version of Rails" unless Rails.respond_to?(:application)
+    end
+
+    def check
+      [:before_filter, :around_filter, :after_filter].each {|s| patch_method(s) }
+      load_all_controllers
+      show_report
+      nil
+    end
+
+    private
+
+    def show_report
+      Report.instance.find_problems
+    end
+
+    def patch_method(filter_sym)
+      ApplicationController.define_singleton_method(filter_sym) do |*args, &blk|
+        if args.many? && (args[1][:only].present? || args[1][:except].present?)
+          Report.instance.add(FilterDecrufter::Hit.new(self, args[0], args[1], filter_sym))
+        end
+        super(*args, &blk)
+      end
+    end
+
+    def load_all_controllers
+      Rails.application.eager_load!
+    end
+
+  end
+end

data/lib/filter_decrufter/tasks.rb

@@ -0,0 +1,8 @@
+namespace :filter_decrufter do
+  
+  desc "Find the cruft"
+  task :check => :environment do
+    FilterDecrufter::Checker.new.check
+  end
+
+end

data/lib/filter_decrufter/version.rb

@@ -0,0 +1,3 @@
+module FilterDecrufter
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: filter_decrufter
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Tom Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Finds old action symbols in Rails before / after / around filters
+email: tom@thomasleecopeland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/filter_decrufter.rb
+- lib/filter_decrufter/checker.rb
+- lib/filter_decrufter/tasks.rb
+- lib/filter_decrufter/version.rb
+homepage: https://github.com/tcopeland/filter_decrufter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: none
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Finds cruft in Rails filters
+test_files: []