discover-unused-partials 0.1.0 → 0.2.0

data/Gemfile

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

data/README.rdoc

@@ -1,9 +1,7 @@
 == Description
 
 This utility script (which someday will be a Rails plug-in) was made in order to 
-help developers to find out unused partials. Beware that dynamic named partials 
-(such as +render @post+ or render :partial => my_var) are NOT detected, so
-you need to be careful while checking that list.
+help developers to find out unused partials.
 
 
 == Usage

data/Rakefile

@@ -1,31 +1,2 @@
-require 'jeweler'
-require 'rubygems'
-require 'rake'
-require 'spec/rake/spectask'
-require 'rake/rdoctask'
-
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-task :spec => :check_dependencies
-task :default => :spec
-
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "discover-unused-partials #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-Jeweler::Tasks.new do |gemspec|
-  gemspec.name = "discover-unused-partials"
-  gemspec.summary = "Discover your unused partials"
-  gemspec.description = "A script to help you finding out unused partials. Good for big projects or projects under heavy refactoring"
-  gemspec.email = "vinibaggio@gmail.com"
-  gemspec.homepage = "http://github.com/vinibaggio/discover-unused-partials"
-  gemspec.authors = ["Vinicius Baggio", "Willian Molinari (a.k.a PotHix)"]
-end
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/discover-unused-partials

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# -*- coding: UTF-8 -*-
 
 require 'discover-unused-partials'
 require 'optparse'

data/discover-unused-partials.gemspec

@@ -1,54 +1,17 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/discover-unused-partials/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{discover-unused-partials}
-  s.version = "0.1.0"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Willian Molinari (a.k.a PotHix)", "Vinicius Baggio"]
+  gem.email         = ["pothix@pothix.com", "vinibaggio@gmail.com"]
+  gem.description   = %q{A script to help you finding out unused partials. Good for big projects or projects under heavy refactoring}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/vinibaggio/discover-unused-partials"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Vinicius Baggio", "Willian Molinari (a.k.a PotHix)"]
-  s.date = %q{2009-12-17}
-  s.default_executable = %q{discover-unused-partials}
-  s.description = %q{A script to help you finding out unused partials. Good for big projects or projects under heavy refactoring}
-  s.email = %q{vinibaggio@gmail.com}
-  s.executables = ["discover-unused-partials"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/discover-unused-partials",
-     "discover-unused-partials.gemspec",
-     "lib/discover-unused-partials.rb",
-     "spec/discover-unused-partials_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/vinibaggio/discover-unused-partials}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Discover your unused partials}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/discover-unused-partials_spec.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "discover-unused-partials"
+  gem.require_paths = ["lib"]
+  gem.version       = DiscoverUnusedPartials::VERSION
 end
-

data/lib/discover-unused-partials.rb

@@ -1,18 +1,40 @@
+# -*- coding: UTF-8 -*-
 module DiscoverUnusedPartials
 
+  #TODO: Prepare to give directory by argument
   def self.find_in directory
     worker = PartialWorker.new
+    tree, dynamic = worker.used_partials("app")
 
-    existent = worker.existent_partials("app").sort
-    used = worker.used_partials("app").sort
+    tree.each do |idx, level|
+      indent = " " * idx*2
+      h_indent = idx == 1 ? "" : "\n" + " "*(idx-1)*2
 
-    unless (existent & used) == existent
-      unused = (existent - used)
-      puts unused * "\n"
+      if idx == 1
+        puts "#{h_indent}The following partials are not referenced directly by any code:"
+      else
+        puts "#{h_indent}The following partials are only referenced directly by the partials above:"
+      end
+      level[:unused].sort.each do |partial|
+        puts "#{indent}#{partial}"
+      end
+    end
+
+    unless dynamic.empty?
+      puts "\n\nSome of the partials above (at any level) might be referenced dynamically by the following lines of code:"
+      dynamic.sort.map do |file, lines|
+        lines.each do |line|
+          puts "  #{file}:#{line}"
+        end
+      end
     end
   end
 
   class PartialWorker
+    @@filename = /[a-zA-Z\d_\/]+?/
+    @@extension = /\.\w+/
+    @@partial = /:partial\s*=>\s*|partial:\s*/
+    @@render = /\brender\s*(?:\(\s*)?/
 
     def existent_partials root
       partials = []
@@ -22,21 +44,47 @@ module DiscoverUnusedPartials
         end
       end
 
-      partials.sort
+      partials
     end
 
     def used_partials root
-      partials = []
+      files = []
       each_file(root) do |file|
+        files << file
+      end
+      tree = {}
+      level = 1
+      existent = existent_partials(root)
+      top_dynamic = nil
+      loop do
+        used, dynamic = process_partials(files)
+        break if level > 1 && used.size == tree[level-1][:used].size
+        tree[level] = {
+          used: used,
+        }
+        if level == 1
+          top_dynamic = dynamic
+          tree[level][:unused] = existent - used
+        else
+          tree[level][:unused] = tree[level-1][:used] - used
+        end
+        break unless (files - tree[level][:unused]).size < files.size
+        files -= tree[level][:unused]
+        level += 1
+      end
+      [tree, top_dynamic]
+    end
+
+    def process_partials(files)
+      partials = []
+      dynamic = {}
+      files.each do |file|
+        #next unless FileTest.exists?(file)
         File.open(file) do |f|
           f.each do |line|
             line.strip!
-            if line =~ /:partial\s+=>\s+[\"\']([a-zA-Z_\/]+)[\"\']/
-              match = $1
-              if match[0] == ?/ or match[0] == '/'
-                match = match[1..-1]
-              end
-
+            if line =~ %r[(?:#@@partial|#@@render)(['"])/?(#@@filename)#@@extension*\1]
+              match = $2
               if match.index("/")
 
                 path = match.split('/')[0...-1].join('/')
@@ -51,11 +99,15 @@ module DiscoverUnusedPartials
                 end
               end
               partials << check_extension_path(full_path)
+            elsif line =~ /#@@partial|#@@render["']/
+              dynamic[file] ||= []
+              dynamic[file] << line
             end
           end
         end
       end
-      partials.uniq.sort
+      partials.uniq!
+      [partials, dynamic]
     end
 
     def check_extension_path(file)
@@ -73,8 +125,10 @@ module DiscoverUnusedPartials
       files = Dir.glob("#{root}/*")
       files.each do |file|
         if File.directory? file
+          next if file =~ %r[^app/assets]
           each_file(file) {|file| yield file}
         else
+          next if file =~ /\.js\b/
           yield file
         end
       end

data/lib/discover-unused-partials/version.rb

@@ -0,0 +1,3 @@
+module DiscoverUnusedPartials
+  VERSION = "0.2.0"
+end

data/spec/discover-unused-partials_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: UTF-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "DiscoverUnusedPartials" do

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
+# -*- coding: UTF-8 -*-
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'discover-unused-partials'
-require 'spec'
-require 'spec/autorun'
+require 'rspec'
 
-Spec::Runner.configure do |config|
-  
+RSpec.configure do |config|
 end

metadata

@@ -1,30 +1,29 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: discover-unused-partials
-version: !ruby/object:Gem::Version 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
-- Vinicius Baggio
+authors:
 - Willian Molinari (a.k.a PotHix)
+- Vinicius Baggio
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-12-17 00:00:00 -02:00
-default_executable: discover-unused-partials
+date: 2012-08-28 00:00:00.000000000 Z
 dependencies: []
-
-description: A script to help you finding out unused partials. Good for big projects or projects under heavy refactoring
-email: vinibaggio@gmail.com
-executables: 
+description: A script to help you finding out unused partials. Good for big projects
+  or projects under heavy refactoring
+email:
+- pothix@pothix.com
+- vinibaggio@gmail.com
+executables:
 - discover-unused-partials
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -32,37 +31,36 @@ files:
 - bin/discover-unused-partials
 - discover-unused-partials.gemspec
 - lib/discover-unused-partials.rb
+- lib/discover-unused-partials/version.rb
 - spec/discover-unused-partials_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/vinibaggio/discover-unused-partials
+homepage: https://github.com/vinibaggio/discover-unused-partials
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Discover your unused partials
-test_files: 
-- spec/spec_helper.rb
+summary: A script to help you finding out unused partials. Good for big projects or
+  projects under heavy refactoring
+test_files:
 - spec/discover-unused-partials_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb