discover-unused-partials 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a28d1e85118c3214475e30a0fa2124e2124ff0e
+  data.tar.gz: ce4ac735dc68cc482c5fd43ba5590f8e555d22be
+SHA512:
+  metadata.gz: 8177575c1c4c9cc9e66eb8085bc903c814fb7caea6a917dfae57ac6bc209573f83764fef6d0bf7bd73925b6e516d1c2fba8f062b6fdd4aad8e322b602e02ca7c
+  data.tar.gz: ce3cb5a10dc4416de7d3fb7211b45ecc9bed987120df8d44316ce62bd1c240224ff2f520ad90d2d4a1cc06b1ff7c6e06673ca3bc7d95641710a73faebf0f2026

data/README.rdoc

@@ -3,13 +3,35 @@
 This utility script (which someday will be a Rails plug-in) was made in order to 
 help developers to find out unused partials.
 
-
 == 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.
+=== Install the gem
+  gem install discover-unused-partials
+
+=== Run the script
+To use this script, simply run
+
+  discover-unused-partials path/to/your/rails_root
+
+If path is not provided, script is executed in the current directory
+
+It will return a list of unmentioned partials. 
+It supports detection of Haml and Erb (both .erb and .rhtml) templates.
+
+=== Configuration
+To fine-tune script behavior, you can add discover-unused-partials.yml to your app config directory.
+Content of such file:
+
+  # List of files that are not reported
+  keep:
+    - app/views/my/partial/_to_keep.html.erb
 
-=== Thanks
+  # List of dynamically generated partials and their sources
+  dynamic:
+    app/controllers/user_controller.rb:
+      - app/views/user/_first_dynamic_partial.html.erb
+      - app/views/user/_second_dynamic_partial.text.haml
+      
+== Thanks
 Special thanks goes to Willian Molinari (PotHix) and Mateus Linhares
 (mateuslinhares) that helped me writing this little script.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/bin/discover-unused-partials

@@ -4,7 +4,7 @@
 require 'discover-unused-partials'
 require 'optparse'
 
-options = Hash.new
+options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: discover-unused-partials [options]"
 
@@ -15,5 +15,9 @@ OptionParser.new do |opts|
 
   opts.parse!
 end
+options[:root] = ARGV.first || '.'
 
-DiscoverUnusedPartials::find_in options
+config = File.join(options[:root], 'config', 'discover-unused-partials.yml')
+options.merge!(YAML.load_file(config)) if File.exist?(config)
+
+DiscoverUnusedPartials::find(options)

data/lib/discover-unused-partials.rb

@@ -1,10 +1,9 @@
 # -*- 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")
+  def self.find options={}
+    worker = PartialWorker.new options
+    tree, dynamic = Dir.chdir(options[:root]){ worker.used_partials("app") }
 
     tree.each do |idx, level|
       indent = " " * idx*2
@@ -35,6 +34,10 @@ module DiscoverUnusedPartials
     @@extension = /\.\w+/
     @@partial = /:partial\s*=>\s*|partial:\s*/
     @@render = /\brender\s*(?:\(\s*)?/
+    
+    def initialize options
+      @options = options
+    end
 
     def existent_partials root
       partials = []
@@ -48,6 +51,7 @@ module DiscoverUnusedPartials
     end
 
     def used_partials root
+      raise "#{Dir.pwd} does not have '#{root}' directory" unless File.directory? root
       files = []
       each_file(root) do |file|
         files << file
@@ -76,10 +80,9 @@ module DiscoverUnusedPartials
     end
 
     def process_partials(files)
-      partials = []
+      partials = @options['keep'] || []
       dynamic = {}
       files.each do |file|
-        #next unless FileTest.exists?(file)
         File.open(file) do |f|
           f.each do |line|
             line.strip!
@@ -100,8 +103,12 @@ module DiscoverUnusedPartials
               end
               partials << check_extension_path(full_path)
             elsif line =~ /#@@partial|#@@render["']/
-              dynamic[file] ||= []
-              dynamic[file] << line
+              if @options["dynamic"] && @options["dynamic"][file]
+                partials += @options["dynamic"][file]
+              else
+                dynamic[file] ||= []
+                dynamic[file] << line
+              end
             end
           end
         end
@@ -109,16 +116,10 @@ module DiscoverUnusedPartials
       partials.uniq!
       [partials, dynamic]
     end
-
+    
+    EXT = %w(.html.erb .text.erb .html.haml .text.haml .rhtml)
     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
+      "#{file}#{EXT.find{ |e| File.exists? file + e }}"
     end
 
     def each_file(root, &block)
@@ -128,7 +129,6 @@ module DiscoverUnusedPartials
           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

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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discover-unused-partials
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Willian Molinari (a.k.a PotHix)
@@ -10,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2013-08-12 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
@@ -37,27 +36,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/vinibaggio/discover-unused-partials
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 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.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A script to help you finding out unused partials. Good for big projects or
   projects under heavy refactoring
 test_files: