discover-unused-partials 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 PotHix and ViniBaggio
+
+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.rdoc

@@ -0,0 +1,17 @@
+== 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.
+
+
+== Usage
+
+To use this script, simply run it in your RAILS_ROOT. It will return a list of 
+unmentioned partials. It supports detection of Haml and Erb (both .erb and
+.rhtml) templates.
+
+=== Thanks
+Special thanks goes to Willian Molinari (PotHix) and Mateus Linhares
+(mateuslinhares) that helped me writing this little script.

data/Rakefile

@@ -0,0 +1,31 @@
+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

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/discover-unused-partials

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'discover-unused-partials'
+require 'optparse'
+
+options = Hash.new
+OptionParser.new do |opts|
+  opts.banner = "Usage: discover-unused-partials [options]"
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.parse!
+end
+
+DiscoverUnusedPartials::find_in options

data/discover-unused-partials.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{discover-unused-partials}
+  s.version = "0.0.2"
+
+  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 = [
+    "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
+end
+

data/lib/discover-unused-partials.rb

@@ -0,0 +1,83 @@
+module DiscoverUnusedPartials
+
+  def self.find_in directory
+    worker = PartialWorker.new
+
+    existent = worker.existent_partials("app").sort
+    used = worker.used_partials("app").sort
+
+    unless (existent & used) == existent
+      unused = (existent - used)
+      puts unused * "\n"
+    end
+  end
+
+  class PartialWorker
+
+    def existent_partials root
+      partials = []
+      each_file(root) do |file|
+        if file =~ /^.*\/_.*$/
+          partials << file.strip
+        end
+      end
+
+      partials.sort
+    end
+
+    def used_partials root
+      partials = []
+      each_file(root) do |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 match.index("/")
+
+                path = match.split('/')[0...-1].join('/')
+                file_name = "_#{match.split('/')[-1]}"
+
+                full_path = "app/views/#{path}/#{file_name}"
+              else
+                if file =~ /app\/controllers\/(.*)_controller.rb/
+                  full_path = "app/views/#{$1}/_#{match}"
+                else
+                  full_path = "#{file.split('/')[0...-1].join('/')}/_#{match}"
+                end
+              end
+              partials << check_extension_path(full_path)
+            end
+          end
+        end
+      end
+      partials.uniq.sort
+    end
+
+    def check_extension_path(file)
+      if File.exists? file + ".html.erb"
+        file += ".html.erb"
+      elsif File.exists? file + ".html.haml"
+        file += ".html.haml"
+      else
+        file += ".rhtml"
+      end
+      file
+    end
+
+    def each_file(root, &block)
+      files = Dir.glob("#{root}/*")
+      files.each do |file|
+        if File.directory? file
+          each_file(file) {|file| yield file}
+        else
+          yield file
+        end
+      end
+    end
+  end
+end

data/spec/discover-unused-partials_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DiscoverUnusedPartials" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: discover-unused-partials
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Vinicius Baggio
+- Willian Molinari (a.k.a PotHix)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-17 00:00:00 -02:00
+default_executable: discover-unused-partials
+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: 
+- discover-unused-partials
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- 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
+has_rdoc: true
+homepage: http://github.com/vinibaggio/discover-unused-partials
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Discover your unused partials
+test_files: 
+- spec/spec_helper.rb
+- spec/discover-unused-partials_spec.rb