rsutphin-cf_case_check 0.0.1 → 0.1.2

data/History.txt

@@ -1,3 +1,25 @@
+0.1.2 / 2009-09-23
+==================
+* Ignore createObject("java", ...) calls (instead of warning about them)
+
+0.1.1 / 2009-09-23
+==================
+* Support unquoted attributes in tags
+* Do not abort on an analysis exception -- print the exception and continue 
+  with the next file
+
+0.1.0 / 2008-12-15
+==================
+* Add support for configurable substitutions for, e.g., application variable 
+  use in references
+* Include 'tem' (along with 'cfm' and 'cfc') in the list of extensions to use
+  when looking for CF source
+* Ensure that source filenames are globbed case-insensitively
+
+0.0.2 / 2008-12-15
+==================
+* Resolve CFCs in the same directory as the source
+
 0.0.1 / 2008-12-14
 ==================
 * Fix recursion bug in CaseCheck::exit

data/Rakefile

@@ -22,7 +22,7 @@ PROJ.url = 'http://github.com/rsutphin/cf_case_check'
 PROJ.version = CaseCheck::VERSION
 # PROJ.rubyforge.name = 'cf_case_check'
 PROJ.description = "A utility which walks a ColdFusion application's source and determines which includes, custom tags, etc, will not work with a case-sensitive filesystem"
-PROJ.exclude << "gem$" << "gemspec$"
+PROJ.exclude << "gem$" << "gemspec$" << ".DS*" << '.git*'
 
 PROJ.ruby_opts = [] # There are a bunch of warnings in rspec, so setting -w isn't useful
 PROJ.spec.opts << '--color'
@@ -33,6 +33,7 @@ PROJ.gem.dependencies << 'activesupport'
 desc 'Regenerate the gemspec for github'
 task :'gem:spec' => 'gem:prereqs' do
   PROJ.gem._spec.files = PROJ.gem._spec.files.reject { |f| f =~ /^tasks/ }
+  PROJ.gem._spec.rubyforge_project = nil
   File.open("#{PROJ.name}.gemspec", 'w') do |gemspec|
     gemspec.puts PROJ.gem._spec.to_ruby
   end

data/lib/case_check.rb

@@ -1,7 +1,7 @@
 
 module CaseCheck
   # :stopdoc:
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.2'.freeze
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/case_check/coldfusion_source.rb

@@ -16,8 +16,13 @@ class ColdfusionSource
   end
   
   def analyze
-    [CustomTag, Cfmodule, Cfinclude, Cfc].each do |reftype|
-      internal_references.concat reftype.search(self)
+    begin
+      [CustomTag, Cfmodule, Cfinclude, Cfc].each do |reftype|
+        internal_references.concat reftype.search(self)
+      end
+    rescue => e
+      $stderr.puts "Analyzing #{filename} failed: #{e}"
+      e.backtrace.each { |l| $stderr.puts "  #{l}" }
     end
   end
   
@@ -72,16 +77,24 @@ class ColdfusionSource
   # attributes, and the line number back to the provided block.
   def scan_for_tag(tag, &block)
     scan(/<#{tag}(.*?)>/mi) do |md, l|
-      attributes = %w(' ").collect do |q|
-        /(\w+)\s*=\s*#{q}([^#{q}]*?)#{q}/.scan(md[1].gsub(%r(/$), ''))
-      end.flatten.inject({}) do |attrs, amd|
+      attributes = ['"', "'", nil].collect { |q|
+        attribute_re(q).scan(md[1].gsub(%r(/$), ''))
+      }.flatten.inject({}) { |attrs, amd|
         attrs[normalize_attribute_key(amd[1])] = amd[2]
         attrs
-      end
+      }
       yield md[0], attributes, l
     end
   end
   
+  def attribute_re(q)
+    if q
+      /(\w+)\s*=\s*#{q}([^#{q}]*?)#{q}/
+    else
+      /(\w+)\s*=\s*([^'"\s]+)/
+    end
+  end
+  
   private
   
   def normalize_attribute_key(key)

data/lib/case_check/commands.rb

@@ -64,10 +64,15 @@ module CaseCheck
     def initialize(params)
       @params = params
       CaseCheck.status_stream.print "Reading source files "
-      @sources = Dir["#{params.directory}/**/*.cf[mc]"].collect do |f|
-        CaseCheck.status_stream.print '.'
-        ColdfusionSource.create(f)
-      end
+      @sources = extensions.collect { 
+        |ext| [ext, Dir.glob("#{params.directory}/**/*.#{ext}", File::FNM_CASEFOLD)]
+      }.collect do |ext, files|
+        CaseCheck.status_stream.print "#{ext}: " unless files.empty?
+        files.collect do |f|
+          CaseCheck.status_stream.print '.'
+          ColdfusionSource.create(f)
+        end
+      end.flatten
       CaseCheck.status_stream.puts
       CaseCheck.status_stream.print "Analyzing "
       @sources.each do |s|
@@ -85,6 +90,10 @@ module CaseCheck
     def reference_count
       sources.inject(0) { |c, s| c + s.internal_references.size }
     end
+    
+    def extensions
+      %w(cfm cfc tem)
+    end
   end
   
   class FilteredSource

data/lib/case_check/configuration.rb

@@ -10,15 +10,12 @@ class Configuration
     apply
   end
   
-  def [](k)
-    @doc[k]
-  end
-  
   private
   
   def apply
     read_custom_tag_dirs
     read_cfc_dirs
+    read_substitutions
   end
   
   def read_custom_tag_dirs
@@ -29,6 +26,14 @@ class Configuration
     Cfc.directories = absolutize_directories(@doc['cfc_directories'] || [])
   end
   
+  def read_substitutions
+    if @doc['substitutions']
+      @doc['substitutions'].each_pair do |re, repl|
+        CaseCheck::Reference.substitutions << [Regexp.new(re, Regexp::IGNORECASE), repl]
+      end
+    end
+  end
+  
   private
   
   def absolutize_directories(dirs)

data/lib/case_check/reference.rb

@@ -5,8 +5,14 @@ require 'activesupport'
 
 module CaseCheck
 
-# base class
+# abstract base class
 class Reference < Struct.new(:source, :text, :line)
+  class << self
+    def substitutions
+      @substitutions ||= []
+    end
+  end
+  
   # abstract methods
   # - expected_path
   #   returns the exact relative path to which this reference refers
@@ -43,6 +49,15 @@ class Reference < Struct.new(:source, :text, :line)
     self.class.name.split('::').last.underscore.gsub('_', ' ')
   end
   
+  def substituted_text
+    re, sub = CaseCheck::Reference.substitutions.detect { |expr, _| expr =~ text }
+    if re
+      text.sub(re, sub)
+    else
+      text
+    end
+  end
+  
   protected
   
   def case_sensitive_match?

data/lib/case_check/references/cfc.rb

@@ -14,24 +14,32 @@ module CaseCheck
       def search(source)
         source.scan(/createObject\((.*?)\)/mi) do |match, l|
           args = match[1].split(/\s*,\s*/).collect { |a| a.gsub(/['"]/, '') }
-          unless args.size == 2 && args.first =~ /component/i
+          if args.size == 2 && args.first =~ /component/i
+            new(source, args.last, l)
+          elsif args.first =~ /java/
+            # quietly skip
+          else
+            # loudly skip
             $stderr.puts "Non-CFC call on line #{l} of #{source.filename}: #{match[0]}"
           end
-          new(source, args.last, l)
-        end
+        end.compact
       end
     end
     
     def initialize(source, text, line_number)
       super
-      @expected_path = text.gsub('.', '/') + ".cfc"
-      @resolved_to = self.class.directories.inject(nil) do |resolved, dir|
+      @expected_path = substituted_text.gsub('.', '/') + ".cfc"
+      @resolved_to = search_path.inject(nil) do |resolved, dir|
         resolved || resolve_in(dir)
       end
     end
     
     protected
     
+    def search_path
+      [File.dirname(source.filename)] + self.class.directories
+    end
+    
     def case_sensitive_match?
       return true if super
       # According to the CF docs:

data/lib/case_check/references/cfinclude.rb

@@ -12,7 +12,7 @@ module CaseCheck
 
     def initialize(source, text, line)
       super
-      @expected_path = text
+      @expected_path = substituted_text
       @resolved_to = resolve_in(File.dirname(source.filename))
     end
   end

data/lib/case_check/references/cfmodule.rb

@@ -21,7 +21,7 @@ module CaseCheck
     class Name < Cfmodule
       def initialize(source, text, line)
         super
-        @expected_path = text.gsub('.', '/') + ".cfm"
+        @expected_path = substituted_text.gsub('.', '/') + ".cfm"
         @resolved_to = CustomTag.directories.inject(nil) do |resolved, dir|
           resolved || resolve_in(dir)
         end
@@ -35,7 +35,7 @@ module CaseCheck
     class Template < Cfmodule
       def initialize(source, text, line)
         super
-        @expected_path = text
+        @expected_path = substituted_text
         @resolved_to = resolve_in(File.dirname(source.filename))
       end
       

data/spec/coldfusion_source_spec.rb

@@ -137,11 +137,22 @@ describe ColdfusionSource do
       actual = perform_scan(<<-CFM, "cfparam")
         <cfparam name ="foo" default= "42">
         <cfparam name="bar" default = "11">
+        <cfparam name= baz default = 19>
       CFM
-      actual.should have(2).matches
+      actual.should have(3).matches
       actual[0][:attributes].should == { :name => 'foo', :default => '42' }
       actual[1][:attributes].should == { :name => 'bar', :default => '11' }
-      actual[1][:line_number].should == 2
+      actual[2][:attributes].should == { :name => 'baz', :default => '19' }
+    end
+    
+    it "matches unquoted attributes" do
+      actual = perform_scan(<<-CFM, "cfinclude")
+        <cfinclude template=GetAccountIDStringMatch.cfm >
+        <cfinclude template=alpha option=beta>
+      CFM
+      actual.should have(2).matches
+      actual[0][:attributes].should == { :template => 'GetAccountIDStringMatch.cfm' }
+      actual[1][:attributes].should == { :template => 'alpha', :option => 'beta' }
     end
     
     it "downcases attribute keys" do

data/spec/configuration_spec.rb

@@ -39,4 +39,23 @@ describe CaseCheck::Configuration do
     read_config
     CaseCheck::CustomTag.directories.should == %w(/tmp/cf_case_check/zappo/customtags)
   end
+  
+  it "reads substitutions" do
+    config_file <<-YAML
+      substitutions:
+        '#application.cfcPath#': /var/www/cfcs
+    YAML
+    read_config
+    CaseCheck::Reference.should have(1).substitutions
+  end
+  
+  it "interprets substitution patterns as case insensitive REs" do
+    config_file <<-YAML
+      substitutions:
+        '#application.cfcPath#': /var/www/cfcs
+    YAML
+    read_config
+    CaseCheck::Reference.substitutions.first.should == [/#application.cfcPath#/i, '/var/www/cfcs']
+    CaseCheck::Reference.substitutions.first.first.should be_casefold
+  end
 end

data/spec/core_ext_spec.rb

@@ -68,5 +68,32 @@ describe File, ' extensions ' do
       touch("baz/bar/foo/quux")
       File.case_insensitive_canonical_name(testfile("baz/bar/quod/../fOO/quux")).should == testfile("baz/bar/foo/quux")
     end
+    
+    describe "with symlinks" do
+      before do
+        @actual_dir = File.join(@tmpdir, "A")
+        FileUtils.mkdir_p @actual_dir
+        @linked_dir = File.join(@tmpdir, "B")
+        FileUtils.ln_s(@actual_dir, @linked_dir)
+      end
+      
+      it "finds exact matches" do
+        expected = File.join(@linked_dir, "foo.cfm")
+        FileUtils.touch expected
+        File.case_insensitive_canonical_name(expected).should == expected
+      end
+      
+      it "finds case-insensitive matches where the filename case differs" do
+        expected = File.join(@linked_dir, "Foo.cfm")
+        FileUtils.touch expected
+        File.case_insensitive_canonical_name(File.join(@linked_dir, "foo.cfm")).should == expected
+      end
+      
+      it "finds case-insensitive matches where the symlink case differs" do
+        expected = File.join(@linked_dir, "foo.cfm")
+        FileUtils.touch expected
+        File.case_insensitive_canonical_name(File.join(@tmpdir, 'b', "foo.cfm")).should == expected
+      end
+    end
   end
 end

data/spec/reference_spec.rb

@@ -32,6 +32,21 @@ describe CaseCheck::Reference do
     end
   end
   
+  describe "text substitution" do
+    it "has none by default" do
+      CaseCheck::Reference.substitutions.should == []
+    end
+    
+    it "subs in the first matching option" do
+      CaseCheck::Reference.substitutions << [/#application#/i, 'foo'] << [/#app.*?#/i, 'bar']
+      SampleReference.new(nil, nil, 0, "#application#/quux").substituted_text.should == "foo/quux"
+    end
+    
+    it "returns the original text if there are no matching subs" do
+      SampleReference.new(nil, nil, 0, "#application#/quux").substituted_text.should == "#application#/quux"
+    end
+  end
+  
   describe 'default message' do
     it "indicates when it is unresolved" do
       SampleReference.new("/foo/patient.cfm", nil, 11, "FOO_Patient").message.should == 

data/spec/references/cfc_spec.rb

@@ -11,6 +11,7 @@ describe CaseCheck::Cfc do
       <cfscript>
               utilsObj = CreateObject("component","bspore.Utils").init(datasource=application.personnel_db,username=session.netid,userIP=cgi.remote_addr);
               summaryObj = createObject("component","bspore.Summary").init(datasource=application.db,username=session.netid,userIP=cgi.remote_addr);
+              color = createObject("java","org.apache.poi.hssf.util.HSSFColor$CORAL");
       </cfscript>
     CFM
   end
@@ -31,6 +32,10 @@ describe CaseCheck::Cfc do
     actual_search.should have(2).references
   end
   
+  it "ignores java invocations" do
+    actual_search.detect { |s| s.expected_path =~ /CORAL/ }.should be_nil
+  end
+  
   it "finds lower case createObject style" do
     actual_search.last.expected_path.should == "bspore/Summary.cfc"
   end
@@ -59,4 +64,19 @@ describe CaseCheck::Cfc do
     actual_search.first.resolved_to.should == expected_file
     actual_search.first.resolution.should == :case_insensitive
   end
+  
+  it "resolves against a match in the same directory as the file" do
+    expected_file = File.join(File.dirname(@source.filename), 'bspore/Utils.cfc')
+    touch expected_file
+    actual_search.first.resolved_to.should == expected_file
+    actual_search.first.resolution.should == :exact
+  end
+  
+  it "performs substitutions before attempting to resolve" do
+    @source.content = <<-CFM
+      CreateObject("component", application.pathToComponents&"Personnel")
+    CFM
+    CaseCheck::Reference.substitutions << [/application.pathToComponents&/i, "pipes."]
+    actual_search.first.expected_path.should == "pipes/Personnel.cfc"
+  end
 end

data/spec/references/cfinclude_spec.rb

@@ -63,4 +63,12 @@ describe CaseCheck::Cfinclude do
     CFM
     actual_search.should have(1).reference
   end
+  
+  it "performs substitutions before resolving" do
+    @source.content = <<-CFM
+      <cfinclude template="#application.myroot#whatever.cfm">
+    CFM
+    CaseCheck::Reference.substitutions << [/#application.myroot#/, 'etc/']
+    actual_search.first.expected_path.should == 'etc/whatever.cfm'
+  end
 end

data/spec/references/cfmodule_spec.rb

@@ -76,6 +76,14 @@ describe CaseCheck::Cfmodule::Name do
     CFM
     actual_search.should have(1).reference
   end
+  
+  it "performs substitutions before resolving" do
+    @source.content = <<-CFM
+      <cfmodule name="#application.myroot#whatever">
+    CFM
+    CaseCheck::Reference.substitutions << [/#application.myroot#/, 'etc.']
+    actual_search.first.expected_path.should == 'etc/whatever.cfm'
+  end
 end
 
 describe CaseCheck::Cfmodule::Template do
@@ -136,4 +144,13 @@ describe CaseCheck::Cfmodule::Template do
     CFM
     actual_search.should have(1).reference
   end
+
+  
+  it "performs substitutions before resolving" do
+    @source.content = <<-CFM
+      <cfmodule template="#application.somePath#whatever.cfm">
+    CFM
+    CaseCheck::Reference.substitutions << [/#application.somePath#/, 'etc/']
+    actual_search.first.expected_path.should == 'etc/whatever.cfm'
+  end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ Spec::Runner.configure do |config|
   
   config.after do
     CaseCheck.status_stream = nil
+    CaseCheck::Reference.substitutions.clear
   end
 
   # == Mock Framework

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rsutphin-cf_case_check
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Rhett Sutphin
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-14 00:00:00 -08:00
+date: 2009-09-23 00:00:00 -07:00
 default_executable: cf_case_check
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,12 +24,13 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: bones
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.0
+        version: 2.5.0
     version: 
 description: A utility which walks a ColdFusion application's source and determines which includes, custom tags, etc, will not work with a case-sensitive filesystem
 email: rhett@detailedbalance.net
@@ -38,13 +40,11 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- README.txt
+- Manifest.txt
 - bin/cf_case_check
 files: 
-- .gitignore
 - History.txt
 - Manifest.txt
-- README.txt
 - Rakefile
 - bin/cf_case_check
 - lib/case_check.rb
@@ -67,8 +67,9 @@ files:
 - spec/references/cfmodule_spec.rb
 - spec/references/custom_tag_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/rsutphin/cf_case_check
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -89,12 +90,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: !binary |
-  AA==
-
-rubygems_version: 1.2.0
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A utility which walks a ColdFusion application's source and determines which includes, custom tags, etc, will not work with a case-sensitive filesystem
 test_files: []
 

data/.gitignore

@@ -1,3 +0,0 @@
-pkg
-coverage
-*.gem

data/README.txt

@@ -1,75 +0,0 @@
-`cf_case_check`
-===============
-http://github.com/rsutphin/cf_case_check
-    
-Description
------------
-
-`cf_case_check` is a utility which walks a ColdFusion application's source and 
-determines which references to other files will not work with a case-sensitive
-filesystem.  Its intended audience is developers/sysadmins who are migrating
-a CF application from Windows hosting to Linux or another UNIX.
-
-`cf_case_check` was developed at the [Northwestern University Biomedical
-Informatics Center][NUBIC].
-
-[NUBIC]: http://www.nucats.northwestern.edu/centers/nubic/index.html
-
-Features
---------
-
-* Resolves references of the following types:
-  - `CF_`-style custom tags
-  - `cfinclude`
-  - `cfmodule` (both `template` and `name`)
-  - `createObject` (for CFCs only)
-* Prints report to stdout
-* Allows for designation of custom tag & CFC search paths outside the 
-  application root
-
-Synopsis
---------
-
-    myapp$ cf_case_check
-
-For command-line options, do:
-
-    $ cf_case_check --help
-
-Requirements
-------------
-
-* Ruby 1.8.6 or later (may work with earlier, but not tested)
-
-Install
--------
-
-Follow the GitHub rubygems [setup directions](http://gems.github.com/), then
-
-    $ sudo gem install rsutphin-cf_case_check
-
-License
--------
-
-(The MIT License)
-
-Copyright (c) 2008 Rhett Sutphin
-
-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.