visionmedia-san 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,10 @@
+=== 1.0.2 / 2008-10-21
+
+* 1 Minor Changes:
+
+  * Removed empty test file
+  * Code styling
+
 === 1.0.1 / 2008-10-03
 
 * 1 Minor Feature:

data/README.txt

@@ -4,22 +4,20 @@ http://vision-media.ca/resources/ruby/source-code-analysis-gem
 
 == DESCRIPTION:
 
-SAN or Source ANalyzer is an open source Ruby program for analyzing the contents
-of source code, such as line counts and comment ratios.
+  SAN or Source ANalyzer is an open source Ruby program for analyzing the contents
+  of source code, such as line counts and comment ratios.
 
-== SYNOPSIS:
+== TODO:
 
-lc [-hVr] [ dir | file ... ]
-
-== REQUIREMENTS:
-
-none
+  * Optionally blacklist or whitelist languages, extensions, etc
+  * More OO
+  * Use commander
 
 == AUTHOR:
 
-TJ Holowaychuk 
-tj@vision-media.ca
-http://vision-media.ca
+  TJ Holowaychuk 
+  tj@vision-media.ca
+  http://vision-media.ca
 
 == LICENSE:
 

data/lib/san.rb

@@ -1,33 +1,33 @@
 #!/usr/bin/env ruby
 
 # == Synopsis
-#   SAN is an open source Ruby program for analysing the contents
-#   of source code, such as line counts and comment ratios.
+#		SAN is an open source Ruby program for analysing the contents
+#		of source code, such as line counts and comment ratios.
 #
 # == Usage
-#   san [-hVr] [ dir | file ... ]
-#  
+#		san [-hVr] [ dir | file ... ]
+#	 
 # == Examples
-#   Analyse current directory 
-#     san
-#    
-#   Analyse current directory recursively
-#     san --recursive
-#    
-#   Analyse specific files and a directory recursively
-#     san -r ./index.php ./cron.php ./sites/all/modules/gui
-#    
+#		Analyse current directory 
+#			san
+#		 
+#		Analyse current directory recursively
+#			san --recursive
+#		 
+#		Analyse specific files and a directory recursively
+#			san -r ./index.php ./cron.php ./sites/all/modules/gui
+#		 
 # == Options
-#   -h, --help      Display this help information.
-#   -V, --version   Display version of lc.
-#   -r, --recurse   Scan directories recursively.
+#		-h, --help			Display this help information.
+#		-V, --version		Display version of lc.
+#		-r, --recurse		Scan directories recursively.
 # 
 # == Author
-#   TJ Holowaychuk 
+#		TJ Holowaychuk 
 #
 # == Copyright
-#   Copyright (c) 2008 TJ Holowaychuk. Licensed under the MIT License:
-#   http://www.opensource.org/licenses/mit-license.php
+#		Copyright (c) 2008 TJ Holowaychuk. Licensed under the MIT License:
+#		http://www.opensource.org/licenses/mit-license.php
 
 require 'optparse'
 require 'rdoc/usage'
@@ -78,15 +78,18 @@ $syntax = {
 
 class San 
 	
-	VERSION = '1.0.1'
+	MAJOR = 1
+	MINOR = 0
+	TINY = 2
+	VERSION = [MAJOR, MINOR, TINY].join('.')
 	
 	attr_reader :files, :reports
 	attr_accessor :options, :arguments
 	
 	# Initialize
-	def initialize()
-		self.initialize_options
-		self.initialize_reports
+	def initialize
+		initialize_options
+		initialize_reports
 	end
 	
 	# Initialize option defaults
@@ -100,8 +103,8 @@ class San
 		@reports = {}
 		@reports[:comment_ratio] = 0
 		@reports[:totals] = {
-		    'files' => 0,
-		    'lines' => 0,
+				'files' => 0,
+				'lines' => 0,
 				'lines blank' => 0,
 				'lines comments' => 0,
 				'lines todo' => 0,
@@ -119,7 +122,7 @@ class San
 	# Start analysis.
 	def run
 		# Parse options
-		self.parse_options
+		parse_options
 		
 		# Default files to cwd
 		@files = @arguments.empty? ? ['.'] : @arguments
@@ -130,16 +133,16 @@ class San
 			if File.directory?(file)
 				files = Dir[(@options[:recursive] ? '**/' : '') << file << '/*.{' + file_pattern + '}']
 				files.each do |file|
-					self.parse_script(file)
+					parse_script(file)
 				end			 
 			elsif File.file?(file)
-				self.parse_script(file)
+				parse_script(file)
 			end
 		end
 
 		# Report
-		self.prep_report
-		self.output_report
+		prep_report
+		output_report
 		exit
 	end
 	
@@ -147,14 +150,13 @@ class San
 	def parse_options
 		opts = OptionParser.new
 		opts.on('-h', '--help')				{ RDoc.usage(0) }
-		opts.on('-V', '--version')		{ self.output_version; exit 0 }
+		opts.on('-V', '--version')		{ output_version; exit 0 }
 		opts.on('-r', '--recursive')	{ @options[:recursive] = true }
 		begin
-		  opts.parse!(@arguments)
-	  rescue => e
-	    puts e
-	    exit 1
-    end
+			opts.parse!(@arguments)
+		rescue => e
+			abort e
+		end
 	end
 
 	# Get extension of filepath.
@@ -188,21 +190,21 @@ class San
 				@reports[:totals]['lines'] += 1
 				@reports[:totals]['lines blank'] += 1 if line.match(lang[:blank])
 				if !line.match(lang[:blank])
-				  @reports[:totals]['lines todo'] += 1 if line.match(lang[:todo])
-				  case 
-			      when line.match(lang[:comment]); @reports[:totals]['lines comments'] += 1 
-			      when line.match(lang[:comment_open]); @reports[:totals]['lines comments'] += 1; comment_open = true
-			      when line.match(lang[:comment_close]); @reports[:totals]['lines comments'] += 1; comment_open = false
-            else 
-						  if comment_open
-							  @reports[:totals]['lines comments'] += 1
-						  else
-						    @reports[:totals]['lines script'] += 1
-						    case
-					        when lang[:function] && line.match(lang[:function]); @reports[:totals]['declared functions'] += 1
-							    when lang[:class] && line.match(lang[:class]); @reports[:totals]['declared classes'] += 1
-							  end
-						  end
+					@reports[:totals]['lines todo'] += 1 if line.match(lang[:todo])
+					case 
+						when line.match(lang[:comment]); @reports[:totals]['lines comments'] += 1 
+						when line.match(lang[:comment_open]); @reports[:totals]['lines comments'] += 1; comment_open = true
+						when line.match(lang[:comment_close]); @reports[:totals]['lines comments'] += 1; comment_open = false
+						else 
+							if comment_open
+								@reports[:totals]['lines comments'] += 1
+							else
+								@reports[:totals]['lines script'] += 1
+								case
+									when lang[:function] && line.match(lang[:function]); @reports[:totals]['declared functions'] += 1
+									when lang[:class] && line.match(lang[:class]); @reports[:totals]['declared classes'] += 1
+								end
+							end
 					end
 				end
 			end
@@ -218,9 +220,9 @@ class San
 
 	# Output report.
 	def output_report
-	  @reports[:totals].keys.sort.each do |k|
-	    puts k + ' ' + @reports[:totals][k].to_s unless @reports[:totals][k] == 0
-    end
+		@reports[:totals].keys.sort.each do |k|
+			puts k + ' ' + @reports[:totals][k].to_s unless @reports[:totals][k] == 0
+		end
 		puts 'comment ratio ' << '%.2f' % @reports[:comment_ratio] unless @reports[:comment_ratio] == 0
 	end
 	

data/san.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "san"
-  s.version  = "1.0.1"
-  s.date     = "2008-10-03"
+  s.version  = "1.0.2"
+  s.date     = "2008-10-21"
   s.summary  = "Source code analysis script"
   s.email    = "tj@vision-media.ca"
   s.homepage = "http://vision-media.ca/resources/ruby/source-code-analysis-gem"
@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
 		"lib/san.rb", 
 		"bin/san"]
 	s.executables = ["san"]
-  s.test_files = ["test/test_san.rb"]
   s.rdoc_options = ["--main", "README.txt"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-san
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - tj@vision-media.ca
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-03 00:00:00 -07:00
+date: 2008-10-21 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -58,5 +58,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Source code analysis script
-test_files: 
-- test/test_san.rb
+test_files: []
+

data/test/test_san.rb

@@ -1 +0,0 @@
-