xolti 0.0.0 → 0.1.0

data/exe/xolti

@@ -1,4 +1,4 @@
-#!/user/bin/env ruby
+#!/usr/bin/env ruby
 
 # xolti
 # Copyright (C) Rémi Even 2016

data/lib/config.rb

@@ -17,29 +17,44 @@
 # along with Xolti. If not, see <http://www.gnu.org/licenses/>.
 require "yaml"
 require "pathname"
+require "date"
 
-def extract_project_info(raw_project_info)
-	{
-		author: raw_project_info["author"],
-		project_name: raw_project_info["project_name"],
-		year: raw_project_info["year"] || Date.today().year
-	}
-end
+require_relative "default_comment_tokens"
+require_relative "resources"
+
+class XoltiConfig
 
-module XoltiConfig
-	def XoltiConfig.find_config_file(path = Pathname.getwd)
-		return nil if path.root?
+	def self.find_config_file(path = Pathname.getwd)
 		potential_config_file = (path + "xolti.yml")
-		potential_config_file.file? ? potential_config_file.to_s : find_config_file(path.parent)
+		return potential_config_file.to_s if potential_config_file.file?
+		raise "No xolti.yml found" if path.root?
+		find_config_file(path.parent)
 	end
 
-	def XoltiConfig.load_config()
+	def self.load_config()
 		raw_config = YAML.load(IO.binread(find_config_file()))
+		XoltiConfig.new(raw_config)
+	end
+
+	attr_reader :project_info, :template, :offset, :license
+
+	def initialize(raw_config)
+		@project_info = extract_project_info(raw_config["project_info"])
+		@comment = DefaultComment::HASH.merge!(raw_config["comment"] || {})
+		@license = raw_config["license"]
+		@template = raw_config.include?("template") ? raw_config["template"] : IO.binread(Resources.get_template_path(@license))
+		@offset = raw_config["offset"] || 0
+	end
+
+	def get_comment(ext)
+		@comment[ext.delete('.')]
+	end
+
+	private def extract_project_info(raw_project_info)
 		{
-			project_info: extract_project_info(raw_config["project_info"]),
-			comment: raw_config["comment"] || ["/*", " * ", " */"],
-			template: raw_config["template"] || "header.txt",
-			offset: raw_config["offset"] || 0
+			author: raw_project_info["author"],
+			project_name: raw_project_info["project_name"],
+			year: raw_project_info["year"] || Date.today().year.to_s
 		}
 	end
 end

data/lib/core.rb

@@ -17,85 +17,35 @@
 # along with Xolti. If not, see <http://www.gnu.org/licenses/>.
 require "tempfile"
 
-require_relative "header_detection"
-require_relative "comment"
-
-def complete_template(path, info, template)
-	template %= info.merge({:file_name => File.basename(path)})
-	template
-end
-
-def create_header_for(path, config)
-	bare_header = complete_template(path, config[:project_info], config[:template])
-	Comment.comment(bare_header, config[:comment])
-end
-
-def insert_with_offset(path, text, offset)
-	file = Tempfile.new("xolti")
-	begin
-		File.open(path, "r") do |source_file|
-			i = 0
-			source_file.each_line do |line|
-				file.write(text) if i == offset
-				i += 1
-				file.write(line)
-			end
-		end
-		file.close()
-		FileUtils.cp(file, path)
-	ensure
-		file.close()
-		file.unlink()
-	end
-end
-
-def delete_lines_from_file(path, start, length)
-	file = Tempfile.new("xolti")
-	begin
-		File.open(path, "r").each_with_index do |line, index|
-			file.write(line) if index < start || index >= start + length
-		end
-		file.close()
-		FileUtils.cp(file, path)
-	ensure
-		file.close()
-		file.unlink()
-	end
-end
-
-def detect_header_position(path, template, comment_tokens)
-	template_lines = Comment.comment(template, comment_tokens).lines("\n")
-	template_regexp_lines = template_lines.map do |line|
-		HeaderDetection.create_detection_regexp_for_line(line)
-	end
-	potential_header_start = 0
-	i = 0
-	File.open(path, "r").each do |line|
-		if template_regexp_lines[i].match(line)
-			i += 1
-			return potential_header_start if i == template_regexp_lines.length
-		else
-			potential_header_start += i + 1
-			i = 0
-		end
-	end
-	-1
-end
+require_relative "file_modification"
+require_relative "header_detector"
+require_relative "header_generator"
+require_relative "header_validator"
 
 module Core
 	def Core.licensify(path, config)
-		header = create_header_for(path, config)
-		insert_with_offset(path, header, config[:offset])
+		header = HeaderGenerator.create_for(path, config)
+		FileModification.insert_lines_with_offset(path, header, config.offset)
 	end
 
 	def Core.delete_header(path, config)
-		template = config[:template]
-		start = detect_header_position(path, template, config[:comment])
-		delete_lines_from_file(path, start, Comment.comment(template, config[:comment]).lines.length) if start >= 0
+		template = config.template
+		ext = File.extname(path)
+		detected = HeaderDetector.detect(path, template, config.get_comment(ext))
+		FileModification.delete_lines(path, detected[:start], detected[:matches].length) if detected
 	end
 
 	def Core.has_header(path, config)
-		template = config[:template]
-		detect_header_position(path, template, config[:comment]) >= 0
+		template = config.template
+		ext = File.extname(path)
+		HeaderDetector.detect(path, template, config.get_comment(ext))
+	end
+
+	def Core.validate_header(path, config)
+		template = config.template
+		ext = File.extname(path)
+		detected = HeaderDetector.detect(path, template, config.get_comment(ext))
+		return [{type: "no_header_found"}] if !detected
+		HeaderValidator.diff(detected, config.project_info.merge({file_name: File.basename(path)}))
 	end
 end

data/lib/default_comment_tokens.rb

@@ -0,0 +1,72 @@
+# default_comment_tokens.rb
+# Copyright (C) Rémi Even 2016
+#
+# This file is part of Xolti.
+#
+# Xolti is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Xolti is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Xolti. If not, see <http://www.gnu.org/licenses/>.
+
+class DefaultComment
+	HASH = Hash.new(["/*", " * ", " */"]).merge!({
+		"adb" => ["--", "-- ", "--"],
+		"ads" => ["--", "-- ", "--"],
+		"apt" => "~~ ",
+		"asm" => [";", "; ", ";"],
+		"asp" => ["<%", "' ", "%>"],
+		"bas" => ["'", "' ", "'"],
+		"bat" => "@REM",
+		"cfc" => ["<!---", " ", "--->"],
+		"cfm" => ["<!---", " ", "--->"],
+		"cls" => "% ",
+		"cmd" => "@REM",
+		"dtd" => ["<!--", " ", "-->"],
+		"e" => ["--", "-- ", "--"],
+		"el" => ["!!!", "!!! ", "!!!"],
+		"erl" => ["%%%", "%%% ", "%%%"],
+		"f" => ["!", "! ", "!"],
+		"fml" => ["<!--", " ", "-->"],
+		"ftl" => ["<#--", " ", "-->"],
+		"ftl" => ["<#--", " ", "-->"],
+		"gsp" => ["<!--", " ", "-->"],
+		"haml" => "-# ",
+		"hrl" => ["%%%", "%%% ", "%%%"],
+		"htm" => ["<!--", " ", "-->"],
+		"html" => ["<!--", " ", "-->"],
+		"jsp" => ["<%--", " ", "--%>"],
+		"jspx" => ["<!--", " ", "-->"],
+		"kml" => ["<!--", " ", "-->"],
+		"lol" => ["OBTW", "", "TLDR"],
+		"lua" => ["--[[", "", "]]"],
+		"mxml" => ["<!--", " ", "-->"],
+		"pas" => ["{*", " * ", " *}"],
+		"pl" => "# ",
+		"pm" => "# ",
+		"pom" => ["<!--", " ", "-->"],
+		"properties" => "# ",
+		"py" => "# ",
+		"rb" => "# ",
+		"sh" => "# ",
+		"sql" => ["--", "-- ", "--"],
+		"sty" => "% ",
+		"tex" => "% ",
+		"tld" => ["<!--", " ", "-->"],
+		"txt" => ["====", "\t", "===="],
+		"vm" => ["#*", " ", "*#"],
+		"xhtml" => ["<!--", " ", "-->"],
+		"xml" => ["<!--", " ", "-->"],
+		"xsd" => ["<!--", " ", "-->"],
+		"xsl" => ["<!--", " ", "-->"],
+		"yaml" => "# ",
+		"yml" => "# "
+	});
+end

data/lib/file_finder.rb

@@ -23,7 +23,7 @@ def parse_xoltignore(path)
 end
 
 module FileFinder
-	def FileFinder.explore_folder(folder, ignoreRules=[])
+	def FileFinder.explore_folder(folder=Dir.pwd, ignoreRules=[])
 		fileAcc = []
 		ignoredPaths = [".", "..", ".git", ".xoltignore", "xolti.yml", "header.txt"]
 		ignoreRules += parse_xoltignore(folder)

data/lib/file_modification.rb

@@ -0,0 +1,51 @@
+# file_modification.rb
+# Copyright (C) Rémi Even 2016
+#
+# This file is part of Xolti.
+#
+# Xolti is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Xolti is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Xolti. If not, see <http://www.gnu.org/licenses/>.
+module FileModification
+	def FileModification.insert_lines_with_offset(path, text, offset)
+		file = Tempfile.new("xolti")
+		begin
+			File.open(path, "r") do |source_file|
+				i = 0
+				source_file.each_line do |line|
+					file.write(text) if i == offset
+					i += 1
+					file.write(line)
+				end
+			end
+			file.close()
+			FileUtils.cp(file, path)
+		ensure
+			file.close()
+			file.unlink()
+		end
+	end
+
+	def FileModification.delete_lines(path, start, length)
+		file = Tempfile.new("xolti")
+		begin
+			File.open(path, "r").each_with_index do |line, index|
+				file.write(line) if index < start || index >= start + length
+			end
+			file.close()
+			FileUtils.cp(file, path)
+		ensure
+			file.close()
+			file.unlink()
+		end
+	end
+end

data/lib/header_detector.rb

@@ -0,0 +1,46 @@
+# header_detector.rb
+# Copyright (C) Rémi Even 2016
+#
+# This file is part of Xolti.
+#
+# Xolti is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Xolti is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Xolti. If not, see <http://www.gnu.org/licenses/>.
+require_relative "comment"
+require_relative "template_utils"
+
+module HeaderDetector
+	def HeaderDetector.detect(path, template, comment_tokens)
+		template_lines = Comment.comment(template, comment_tokens).lines("\n")
+		template_regexp_lines = template_lines.map do |line|
+			TemplateUtils.create_detection_regexp_for_line(line)
+		end
+		potential_header_start = 0
+		matches = []
+		File.open(path, "r").each do |line|
+			match = template_regexp_lines[matches.length].match(line)
+			if match
+				matches << match
+				if matches.length == template_regexp_lines.length
+					return {
+						start: potential_header_start,
+						matches: matches
+					}
+				end
+			else
+				potential_header_start += matches.length + 1
+				matches = []
+			end
+		end
+		nil
+	end
+end

data/lib/header_generator.rb

@@ -0,0 +1,30 @@
+# header_generator.rb
+# Copyright (C) Rémi Even 2016
+#
+# This file is part of Xolti.
+#
+# Xolti is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Xolti is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Xolti. If not, see <http://www.gnu.org/licenses/>.
+require_relative "comment"
+
+def complete_template(path, info, template)
+	template %= info.merge({file_name: File.basename(path)})
+	template
+end
+
+module HeaderGenerator
+	def HeaderGenerator.create_for(path, config)
+		bare_header = complete_template(path, config.project_info, config.template)
+		Comment.comment(bare_header, config.get_comment(File.extname(path)))
+	end
+end

data/lib/header_validator.rb

@@ -0,0 +1,34 @@
+# header_validator.rb
+# Copyright (C) Rémi Even 2016
+#
+# This file is part of Xolti.
+#
+# Xolti is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Xolti is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Xolti. If not, see <http://www.gnu.org/licenses/>.
+module HeaderValidator
+	def HeaderValidator.diff(detected, info)
+		diff = []
+		detected[:matches].each_with_index do |match, i|
+			line = detected[:start] + i + 1
+			match.names.each do |name|
+				name_sym = name.to_sym
+				diff << {
+					line: line,
+					expected: info[name_sym],
+					actual: match[name_sym]
+				} if info[name_sym] != match[name_sym]
+			end
+		end
+		diff
+	end
+end

data/lib/resources.rb

@@ -0,0 +1,33 @@
+# resources.rb
+# Copyright (C) Rémi Even 2016
+#
+# This file is part of Xolti.
+#
+# Xolti is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Xolti is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Xolti. If not, see <http://www.gnu.org/licenses/>.
+module Resources
+
+	# If xolti is not installed as a gem, assume that pwd is the root of the project
+	# Needed to fix travis integration.
+	Resources_dir = Gem::Specification.all_names.select { |name| name.match(/xolti/) }.length >= 1 ?
+		File.join(Gem::Specification.find_by_name("xolti").gem_dir, "resources") :
+		File.join(Dir.pwd, "resources")
+
+	def Resources.get_template_path(license)
+		File.join(Resources_dir, "headers", license)
+	end
+
+	def Resources.get_full_license_path(license)
+		File.join(Resources_dir, "licenses", license)
+	end
+end