licence_injector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a2d0ade97b6f04f72393ed9b973b8dbd3c268b7
+  data.tar.gz: 48ab7cf802630e2f43f576dbc08eeaa9066a2826
+SHA512:
+  metadata.gz: f6888bbf88f5d993ef828c78452db4f8c40efcfffe67242f3c469711f3d4097570a6dcd2210911cfec7e32e812929e17655e5a8f927a434e3d6ef8e7bb7c5a1b
+  data.tar.gz: 830d258291126c58013524194c56089e4a00892ac80fab03f3633d9444c9039c6d6b453d2c3a56bf52f2271477007d216a2e727137cba8cae0fc4d6c3d43b63b

data/bin/licence_injector

@@ -0,0 +1,86 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/LicenceInjector.rb'
+
+commands = [:inject, :replace]
+options = {:list=>false, :old_licence=>"", :overwrite=>false}
+
+option_parser = OptionParser.new do |opts|
+	executable_name = File.basename($PROGRAM_NAME)
+	opts.banner = "\tInject licence into src files, or replace current licence with new licence. Requires <command> - either 'inject' or 'replace'
+	
+	Usage: #{executable_name} <command> [options]"
+	
+	opts.on("--list", "output changed files as a list") do
+		options[:list] = true
+	end
+	
+	opts.on("-o OLDLICENCE", "--old_licence OLDLICENCE", "the path to the file containing the old licence - used only with the replace command") do |old_licence|
+		options[:old_licence] = old_licence
+	end
+	
+	opts.on("-l LICENCE", "--licence LICENCE", "the path to the file containing the licence") do |licence|
+		options[:licence] = licence
+	end
+	
+	opts.on("-s SRCPATH", "--src_path SRCPATH", "path to the folder containing the src files to be processed. SRCPATH will be searched and all of its sub-folders") do |src_path|
+		options[:src_path] = src_path.gsub("\\", "/")
+	end
+
+	opts.on("-e EXTENSIONS", "--extensions EXTENSIONS", Array, "the list of file extensions to be searched for, comma separated. E.g. cpp,h,java") do |extensions|
+		options[:extensions] = extensions
+	end
+
+	opts.on("--overwrite", "makes the changes to the source files as opposed to the default of just reporting the number of src file discovered") do
+		options[:overwrite] = true
+	end	
+end
+
+option_parser.parse!
+
+def file_doesnt_exist file
+	!File.exist? file
+end
+
+if ARGV.empty?
+	puts "\tError: you must supply a command, path to licence file, path to src and some extensions"
+	puts
+	puts option_parser.help
+	STDERR.puts "ERROR: There are missing arguments"
+	exit 1
+end
+
+commands = [:inject, :replace]
+command = ARGV.shift.to_sym
+
+if options[:licence].nil? || options[:src_path].nil? || options[:extensions].nil?
+	STDERR.puts "ERROR: There are missing arguments"
+	raise OptionParser::MissingArgument
+end
+
+if file_doesnt_exist(options[:licence])
+	STDERR.puts "ERROR: The licence file #{options[:licence]} doesn't exist"
+	raise OptionParser::InvalidArgument 
+end
+
+unless commands.include? command
+	STDERR.puts "ERROR: There are missing arguments"
+	raise OptionParser::MissingArgument
+end
+
+if command == :replace
+	if options[:old_licence].empty?
+		STDERR.puts "ERROR: Need an old licence when using 'replace'"
+		raise OptionParser::MissingArgument 
+	end
+	if file_doesnt_exist(options[:old_licence])
+		STDERR.puts "ERROR: The old licence file #{options[:old_licence]} doesn't exist"
+		raise OptionParser::InvalidArgument 
+	end
+end
+
+#puts options.inspect
+
+licence_injector = LicenceInjector.new command, options[:licence], options[:src_path], options[:extensions], options[:old_licence], options[:list], options[:overwrite]
+licence_injector.inject_licence

data/lib/LicenceInjector.rb

@@ -0,0 +1,119 @@
+class LicenceInjector
+
+attr_accessor :licence_file_path, :old_licence_file_path, :src_path, :extensions
+attr_reader :changed_files_count
+
+	def initialize(command, licence_file_path, src_path, file_extensions, old_licence_file_path = "", list = false, overwrite = true)
+		@licence_file_path = licence_file_path
+		@old_licence_file_path = old_licence_file_path
+		@src_path = src_path
+		@extensions = file_extensions
+		@changed_files_count = 0
+		@command = command
+		@list = list
+		@overwrite = overwrite
+	end
+	
+	def read_file file_path
+		File.open file_path, "r"  do | file |
+			file.read
+		end
+	end
+	
+	def inject_licence
+		@changed_files_count = 0
+		@extensions.each do | extension |
+			unless @list
+				puts "\tprocessing #{extension} files in #{@src_path}"
+				print "\t"
+			end
+			Dir.glob(@src_path + "/**/*.#{extension}") do |file|	#find src files in current folder and all subfolders
+				case  
+					when @command == :inject
+						inject_licence_into_file file
+					when @command == :replace
+						replace_old_licence file
+				end
+			end
+			unless @list
+				puts
+			end
+		end
+		unless @list
+			puts
+		end
+		unless @list
+			if @overwrite
+				puts "There were #{@changed_files_count} changes made"
+			else
+				puts "#{@changed_files_count} file(s) were found. Use the --overwrite flag to make changes to the files"
+			end
+		end
+	end
+	
+	def replace_old_licence file
+		src = read_file file
+		
+		src = src.sub(read_file(@licence_file_path), read_file(@old_licence_file_path))
+			
+		if @overwrite
+			begin
+				output = File.new(file, "w")
+				output.write src
+				output.close
+			rescue
+				puts
+				STDERR.puts "ERROR: There was a problem writing to '#{file}"
+				exit 1
+			end
+		end
+		
+		if @list
+			puts File.absolute_path(file)
+		else
+			print "."
+		end
+		@changed_files_count += 1
+	end
+	
+	def inject_licence_into_file file
+		# possible refactor here - using an array to read the src so we can easily check the 
+		# first line for special content. If we used a string we could reuse the read file method 
+		# but lose the nice array methods... Instinct is to use array
+		old_content = []
+		newcontent = []
+		File.open(file, "r") do | f |
+			old_content = f.readlines
+		end
+
+		#some files need to have their first lines maintained such as xml files and files using a shebang
+		unless old_content.first.nil? # empty file
+			if old_content.first.start_with?("#!") || old_content.first.start_with?("<?xml")
+				newcontent.push old_content.first
+				old_content.shift
+			end
+		end
+		
+		newcontent.push read_file @licence_file_path
+		newcontent = newcontent + old_content
+		
+		if @overwrite
+			begin
+				output = File.new(file, "w")
+				newcontent.each { |line| output.write line }
+				output.close
+			rescue
+				puts
+				STDERR.puts "ERROR: There was a problem writing to '#{file}"
+				exit 1
+			end
+		end
+		
+		if @list
+			puts File.absolute_path(file)
+		else
+			print "."
+		end
+		@changed_files_count += 1
+	end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: licence_injector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Barry Drinkwater
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-13 00:00:00.000000000 Z
+dependencies: []
+description: licence_injector injects text from the given licence file into each source
+  file found at the given source path whose extension is one of those in the given
+  list of extensions. licence_injector also allows a previously injected licence to
+  be replaced with a new licence
+email:
+- barry@penrillian.com
+executables:
+- licence_injector
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/LicenceInjector.rb
+- bin/licence_injector
+homepage: http://www.penrillian.com
+licenses:
+- BSD Clause 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Injects licence text into source files
+test_files: []