visionmedia-san 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2008-09-28
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/san
+lib/san.rb

data/README.txt

@@ -0,0 +1,51 @@
+= san
+
+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.
+
+== SYNOPSIS:
+
+lc [-hVr] [ dir | file ... ]
+
+== REQUIREMENTS:
+
+none
+
+== INSTALL:
+
+sudo gem install san
+
+== AUTHOR:
+
+TJ Holowaychuk 
+tj@vision-media.ca
+http://vision-media.ca
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require File.dirname(__FILE__) + '/lib/san'
+
+desc 'Build and install ruby gem.'
+task :build do
+  sh "gem build ./san.gemspec"
+  sh "gem install san-#{San::VERSION}.gem"
+end
+
+desc 'Remove ruby gem build data.'
+task :remove_build do
+  sh "gem uninstall san"
+  sh "rm san-#{San::VERSION}.gem"
+end
+
+# vim: syntax=Ruby

data/bin/san

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'san'
+counter = San.new
+counter.arguments = ARGV
+counter.run
+

data/lib/san.rb

@@ -0,0 +1,238 @@
+#!/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.
+#
+# == Usage
+#   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
+#    
+# == Options
+#   -h, --help      Display this help information.
+#   -V, --version   Display version of lc.
+#   -r, --recurse   Scan directories recursively.
+# 
+# == Author
+#   TJ Holowaychuk 
+#
+# == Copyright
+#   Copyright (c) 2008 TJ Holowaychuk. Licensed under the MIT License:
+#   http://www.opensource.org/licenses/mit-license.php
+
+require 'optparse'
+require 'rdoc/usage'
+
+# TODO use seperators from /Library/Ruby/Gems/1.8/gems/rails-2.1.1/lib/ with optional --raw-output
+# TODO remove 'and' from Shard
+# TODO pick proper license, and use this RDoc as default for Shard
+# TODO submit on resources.. gem? 
+# TODO list todo's line.match??? matches?
+# TODO get gem help working...
+	
+$syntax = {
+		'rb' => {																																						
+				:name => 'Ruby',																																
+				:blank => /^\s*$/,																															
+				:comment => /^[\s]*#/,																													
+				:comment_open => /[\s]*=begin/,																									
+				:comment_close => /[\s]*=end/,																									
+				:function => /def[\s]+[\w]+/,																										
+				:class => /(class|module)[\s]+[\w]+/,			
+				:todo => /@?todo/,																							
+				:associations => ['rb', 'erb']																									
+			},																																								
+		'php' => {																																					
+				:name => 'PHP',																																	
+				:blank => /^\s*$/,																															
+				:comment => /^[\s]*\/\//,																												
+				:comment_open => /^[\s]*\/\*/,																									
+				:comment_close => /[\s]*\*\//,																									
+				:function => /^[\s]*function[\s]+[\w]+[\s]*\(/,																				
+				:class => /class[\s]+[\w]+/,												
+				:todo => /@?todo/,														
+				:associations => ['php', 'inc', 'module', 'install']														
+			},																																								
+		'js' => {																																						
+				:name => 'JavaScript',																													
+				:blank => /^\s*$/,																															
+				:comment => /^[\s]*\/\//,																												
+				:comment_open => /^[\s]*\/\*/,																									
+				:comment_close => /[\s]*\*\//,																									
+				:function => /^[\s]*(?:function[\s][\w]+|(var)?[\s]*[\w\.]+[\s]+=[\s]+function)[\s]*\(/,	
+				:todo => /@?todo/,
+				:associations => ['js']																													
+			},																																								
+		'css' => {																																					
+				:name => 'CSS',																																	
+				:blank => /^\s*$/,																															
+				:comment => /^[\s]*\/\//,																												
+				:comment_open => /^[\s]*\/\*/,																									
+				:comment_close => /[\s]*\*\//,						
+				:todo => /@?todo/,																																			
+				:associations => ['css']																												
+			}																																									
+	}																																											
+
+class San 
+	
+	VERSION = '1.0.0'
+	
+	attr_reader :files, :reports
+	attr_accessor :options, :arguments
+	
+	# Initialize
+	def initialize()
+		self.initialize_options
+		self.initialize_reports
+	end
+	
+	# Initialize option defaults
+	def initialize_options
+		@options = {}
+		@options[:recursive] = false		
+	end
+	
+	# Initialize reports, create defaults
+	def initialize_reports
+		@reports = {}
+		@reports[:comment_ratio] = 0
+		@reports[:totals] = {
+		    'files' => 0,
+		    'lines' => 0,
+				'lines blank' => 0,
+				'lines comments' => 0,
+				'lines todo' => 0,
+				'declared functions' => 0,
+				'declared classes' => 0,			 
+			}
+		$syntax.each do |lang|
+			lang[1][:associations].each do |association|
+				@reports[:totals]['files ' << association] = 0
+			end
+		end		 
+	end
+	
+	# Start analysis.
+	def run
+		# Parse options
+		self.parse_options
+		
+		# Default files to cwd
+		@files = @arguments.empty? ? ['.'] : @arguments
+
+		# Parse files and directories
+		file_pattern = $syntax.collect{|lang| lang[1][:associations].join(',')}.join(',')
+		@files.each do |file|
+			if File.directory?(file)
+				files = Dir[(@options[:recursive] ? '**/' : '') << file << '/*.{' + file_pattern + '}']
+				files.each do |file|
+					self.parse_script(file)
+				end			 
+			elsif File.file?(file)
+				self.parse_script(file)
+			end
+		end
+
+		# Report
+		self.prep_report
+		self.output_report
+		exit
+	end
+	
+	# Parse options
+	def parse_options
+		opts = OptionParser.new
+		opts.on('-h', '--help')				{ RDoc.usage(0) }
+		opts.on('-V', '--version')		{ self.output_version; exit 0 }
+		opts.on('-r', '--recursive')	{ @options[:recursive] = true }
+		begin
+		  opts.parse!(@arguments)
+	  rescue => e
+	    puts e
+	    exit 1
+    end
+	end
+
+	# Get extension of filepath.
+	def get_extension(filepath) 
+		File.extname(filepath).reverse.chop.reverse
+	end
+
+	# Get syntax based on a filenames extension.
+	def get_syntax(filepath)
+		extension = get_extension(filepath)
+		$syntax.each_pair do |lang, info|
+			return $syntax[lang] if info[:associations].include?(extension)
+		end
+	end
+
+	# Parse a script and report on findings.
+	def parse_script(filepath)
+		lang = get_syntax(filepath)
+		comment_open = false
+		extension = get_extension(filepath)
+
+		# Ensure syntax was found
+		if lang.kind_of? NilClass
+			return
+		end
+
+		File.open(filepath) do |file| 
+			@reports[:totals]['files'] += 1
+			@reports[:totals]['files ' << extension] += 1
+			file.each_line do |line|
+				@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
+						    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
+		end
+	end
+
+	# Prepare output of report.
+	def prep_report
+		if @reports[:totals]['lines comments'] > 0 and @reports[:totals]['lines'] > 0
+			@reports[:comment_ratio] = @reports[:totals]['lines comments'].to_f / @reports[:totals]['lines'].to_f 
+		end
+	end
+
+	# Output report.
+	def output_report
+	  for k in @reports[:totals].keys.sort
+	    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
+	
+	# Output version information.
+	def output_version
+		puts "Version #{VERSION}"
+	end
+end
+
+

data/san.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name     = "san"
+  s.version  = "1.0.0"
+  s.date     = "2008-09-29"
+  s.summary  = "Source code analysis script"
+  s.email    = "tj@vision-media.ca"
+  s.homepage = "http://vision-media.ca/resources/ruby/source-code-analysis-gem"
+  s.description = "Small ruby gem used to analyze the source code of projects or single scripts."
+  s.require_path = "lib"
+  s.has_rdoc = true
+  s.authors  = ["tj@vision-media.ca"]
+  s.files    = ["History.txt", 
+		"Manifest.txt", 
+		"README.txt", 
+		"Rakefile", 
+		"san.gemspec", 
+		"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

data/test/test_san.rb

@@ -0,0 +1 @@
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: visionmedia-san
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- tj@vision-media.ca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Small ruby gem used to analyze the source code of projects or single scripts.
+email: tj@vision-media.ca
+executables: 
+- san
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- san.gemspec
+- lib/san.rb
+- bin/san
+has_rdoc: true
+homepage: http://vision-media.ca/resources/ruby/source-code-analysis-gem
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Source code analysis script
+test_files: 
+- test/test_san.rb