xolti 0.0.0 → 0.1.0

data/test/tc_config.rb

@@ -0,0 +1,40 @@
+# tc_config.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 "test/unit"
+
+require_relative "../lib/config"
+
+class TestConfig < Test::Unit::TestCase
+
+	def test_default_comment
+		sut = XoltiConfig.new({
+			"project_info" => {
+				"project_name" => "Xolti",
+				"author" => "Rémi Even"
+			},
+			"template" => "Header",
+			"comment" => {
+				"tex" => "% "
+			}
+		})
+		assert_equal(sut.get_comment("someUnknownExtension"), ["/*", " * ", " */"])
+		assert_equal(sut.get_comment("rb"), "# ")
+		assert_equal(sut.get_comment("tex"), "% ")
+		assert_equal(sut.get_comment(".tex"), "% ")
+	end
+end

data/test/tc_header_validator.rb

@@ -0,0 +1,54 @@
+# tc_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/>.
+require "test/unit"
+
+require_relative "../lib/header_validator"
+
+class TestHeaderValidator < Test::Unit::TestCase
+
+	def test_diff
+		actual_file_name = "awesme.txt"
+		actual_year = "2017"
+		actual_author = "Remi E"
+		actual_project_name = "Xolti"
+		detected = {
+			start: 2,
+			matches: [
+				"# #{actual_file_name}".match(/^(# )(?<file_name>.*)$/),
+				"# ".match(/^(# )$/),
+				"# (C) #{actual_year} #{actual_author}".match(/^(# \(C\) )(?<year>[[:digit:]]{4})( )(?<author>.*)$/),
+				"# Project #{actual_project_name}".match(/^(# Project )(?<project_name>.*)/)
+			]
+		}
+		expected_file_name = "awesome.txt"
+		expected_year = "2016"
+		expected_author = "Rémi Even"
+		expected_project_name = actual_project_name
+		info = {
+			file_name: expected_file_name,
+			year: expected_year,
+			author: expected_author,
+			project_name: expected_project_name
+		}
+		diff = HeaderValidator.diff(detected, info)
+		assert_equal(diff.length, 3)
+		assert_equal(diff[0], {line: 3, expected: expected_file_name, actual: actual_file_name})
+		assert_equal(diff[1], {line: 5, expected: expected_year, actual: actual_year})
+		assert_equal(diff[2], {line: 5, expected: expected_author, actual: actual_author})
+	end
+end

data/test/tc_template_utils.rb

@@ -0,0 +1,58 @@
+# tc_template_utils.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 "test/unit"
+
+require_relative "../lib/template_utils"
+
+class TestTemplateUtils < Test::Unit::TestCase
+
+	def test_find_template_tokens_indexes
+		assert_equal([], TemplateUtils.find_template_tokens_indexes(""))
+		assert_equal([], TemplateUtils.find_template_tokens_indexes("ee"))
+		assert_equal([2, 5], TemplateUtils.find_template_tokens_indexes("ee%{r}"))
+		assert_equal([2, 5, 7, 12], TemplateUtils.find_template_tokens_indexes("ee%{r} %{abc}fe"))
+	end
+
+	def test_split_template_tokens_from_line
+		assert_equal(["ee"], TemplateUtils.split_template_tokens_from_line("ee"))
+		assert_equal(["ee", "%{coucou}"], TemplateUtils.split_template_tokens_from_line("ee%{coucou}"))
+		assert_equal(["%{coucou}"], TemplateUtils.split_template_tokens_from_line("%{coucou}"))
+		assert_equal(["ee", "%{coucou}", "ee"], TemplateUtils.split_template_tokens_from_line("ee%{coucou}ee"))
+		assert_equal(["ee", "%{coucou}", "ee", "%{coucou}"], TemplateUtils.split_template_tokens_from_line("ee%{coucou}ee%{coucou}"))
+		assert_equal(["ee", "%{coucou}", "%{coucou}"], TemplateUtils.split_template_tokens_from_line("ee%{coucou}%{coucou}"))
+	end
+
+	def test_create_detection_regexp_for_line
+		assert_match(TemplateUtils.create_detection_regexp_for_line("e"), "e")
+		assert_match(TemplateUtils.create_detection_regexp_for_line("."), ".")
+		assert_no_match(TemplateUtils.create_detection_regexp_for_line("."), "a")
+		assert_match(TemplateUtils.create_detection_regexp_for_line("%{r}"), "azer")
+		assert_match(TemplateUtils.create_detection_regexp_for_line(""), "")
+		assert_match(TemplateUtils.create_detection_regexp_for_line("a%{r}r"), "azer")
+		assert_no_match(TemplateUtils.create_detection_regexp_for_line("z%{r}f"), "azer")
+	end
+
+	def test_extract_tag_type
+		assert_equal(TemplateUtils.extract_tag_type("%{coucou}"), "coucou")
+	end
+
+	def test_tag?
+		assert(TemplateUtils.tag?("%{coucou}"))
+		refute(TemplateUtils.tag?("blabla"))
+	end
+end

data/test/ts_xolti.rb

@@ -17,5 +17,7 @@
 # along with Xolti. If not, see <http://www.gnu.org/licenses/>.
 require "test/unit"
 
-require_relative "tc_header_detection"
+require_relative "tc_template_utils"
 require_relative "tc_comment"
+require_relative "tc_config"
+require_relative "tc_header_validator"

data/xolti.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
 	spec.name = "xolti"
-	spec.version = "0.0.0"
+	spec.version = "0.1.0"
 	spec.summary = "A gem to manage license headers"
-	spec.description = "A gem to manage license headers"
+	spec.description = "A gem to manage license headers, providing a simple CLI."
 	spec.authors = ["Rémi Even"]
 	spec.homepage = "https://github.com/RemiEven/xolti"
 	spec.license = "GPL-3.0"

data/xolti.yml

@@ -2,22 +2,4 @@
 project_info:
   project_name: Xolti
   author: "Rémi Even"
-comment: "# "
-template: |
-    %{file_name}
-    Copyright (C) %{author} %{year}
-
-    This file is part of %{project_name}.
-
-    %{project_name} 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.
-
-    %{project_name} 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 %{project_name}. If not, see <http://www.gnu.org/licenses/>.
+license: GPL3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xolti
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Rémi Even
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,7 +30,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
-description: A gem to manage license headers
+description: A gem to manage license headers, providing a simple CLI.
 email: 
 executables:
 - xolti
@@ -40,17 +40,28 @@ files:
 - ".travis.yml"
 - ".xoltignore"
 - Gemfile
+- LICENSE
 - Rakefile
 - exe/xolti
 - lib/comment.rb
 - lib/config.rb
 - lib/core.rb
+- lib/default_comment_tokens.rb
 - lib/file_finder.rb
-- lib/header_detection.rb
+- lib/file_modification.rb
+- lib/header_detector.rb
+- lib/header_generator.rb
+- lib/header_validator.rb
+- lib/resources.rb
+- lib/template_utils.rb
 - lib/xolti.rb
 - readme.md
+- resources/headers/GPL3.0
+- resources/licenses/GPL3.0
 - test/tc_comment.rb
-- test/tc_header_detection.rb
+- test/tc_config.rb
+- test/tc_header_validator.rb
+- test/tc_template_utils.rb
 - test/ts_xolti.rb
 - xolti.gemspec
 - xolti.yml

data/test/tc_header_detection.rb

@@ -1,58 +0,0 @@
-# tc_header_detection.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 "test/unit"
-
-require_relative "../lib/header_detection"
-
-class TestHeaderDetection < Test::Unit::TestCase
-
-	def test_find_template_tokens_indexes
-		assert_equal([], HeaderDetection.find_template_tokens_indexes(""))
-		assert_equal([], HeaderDetection.find_template_tokens_indexes("ee"))
-		assert_equal([2, 5], HeaderDetection.find_template_tokens_indexes("ee%{r}"))
-		assert_equal([2, 5, 7, 12], HeaderDetection.find_template_tokens_indexes("ee%{r} %{abc}fe"))
-	end
-
-	def test_split_template_tokens_from_line
-		assert_equal(["ee"], HeaderDetection.split_template_tokens_from_line("ee"))
-		assert_equal(["ee", "%{coucou}"], HeaderDetection.split_template_tokens_from_line("ee%{coucou}"))
-		assert_equal(["%{coucou}"], HeaderDetection.split_template_tokens_from_line("%{coucou}"))
-		assert_equal(["ee", "%{coucou}", "ee"], HeaderDetection.split_template_tokens_from_line("ee%{coucou}ee"))
-		assert_equal(["ee", "%{coucou}", "ee", "%{coucou}"], HeaderDetection.split_template_tokens_from_line("ee%{coucou}ee%{coucou}"))
-		assert_equal(["ee", "%{coucou}", "%{coucou}"], HeaderDetection.split_template_tokens_from_line("ee%{coucou}%{coucou}"))
-	end
-
-	def test_create_detection_regexp_for_line
-		assert_match(HeaderDetection.create_detection_regexp_for_line("e"), "e")
-		assert_match(HeaderDetection.create_detection_regexp_for_line("."), ".")
-		assert_no_match(HeaderDetection.create_detection_regexp_for_line("."), "a")
-		assert_match(HeaderDetection.create_detection_regexp_for_line("%{r}"), "azer")
-		assert_match(HeaderDetection.create_detection_regexp_for_line(""), "")
-		assert_match(HeaderDetection.create_detection_regexp_for_line("a%{r}r"), "azer")
-		assert_no_match(HeaderDetection.create_detection_regexp_for_line("z%{r}f"), "azer")
-	end
-
-	def test_extract_tag_type
-		assert_equal(HeaderDetection.extract_tag_type("%{coucou}"), "coucou")
-	end
-
-	def test_tag?
-		assert(HeaderDetection.tag?("%{coucou}"))
-		refute(HeaderDetection.tag?("blabla"))
-	end
-end