xolti 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2149450fe72b054a8f677791feaa457def62598e
-  data.tar.gz: 6c513ac14f888b04fb05a1c0672b292d5c4d4837
+  metadata.gz: 2f1e8d541abaefba1d4ecb131cbd52b1c4b2f31c
+  data.tar.gz: d7ffe751314f6c5d7ba065ade21037d99e2488e9
 SHA512:
-  metadata.gz: ec1776900de5c30d513f1f2d9dc2272a4fad94aaac9de69c9a3fffd0898787049539e86b555c4dbce32b22c5e637f83f23f92ccb798493d5a42516b8812dd5ba
-  data.tar.gz: 9fe6b19b8f78acd4931f844669052daeb8f0f439b40ffa7ed3b48b6f2b9da50e15e4dfc3183d68ffe2661c243be7cb6af8d6ea61d92b2f0bdb015380ec2a308e
+  metadata.gz: 461fdc119faae937058798c78507206bc2d15820032113d0f34fa03011329e365ad86bb23771fa6a3fe00612dab946cd39f8262d8f3d1ecf339b90bcefa154a5
+  data.tar.gz: e89ab42c45a166ea8340508b5f193d2dce70beefb57ea84f5f07302880479612ffa10f1353732c873a73f27e6ff39ebaf39f70b709d71c5a37bb9f0369695943

data/.xoltignore

@@ -1,6 +1,3 @@
 *
-.*
-!lib
-!test
-!*.rb
-!exe
+!lib/**/*.rb
+!test/**/*.rb

data/LICENSE

@@ -641,7 +641,7 @@ the Free Software Foundation, either version 3 of the License, or
 
 This program 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
+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

data/docs/getting_started.rst

@@ -74,13 +74,7 @@ would be :
 
 .. tip::
 
-	You can invert a rule by prefixing it with ``!``. You can create one ``.xoltignore``
-	in each directory of your project. Globing (ie use of the ``*`` wildcard) is supported.
-
-.. note::
-
-	Like in a ``.gitignore`` file, rules are read line by line, from top to bottom; lower rules
-	override higher ones, and rules from a deeper folder override rules from higher folders.
+	More details on ``.xoltignore`` files can be found :doc:`in the dedicated documentation page </xoltignore>`
 
 Checking which files are missing headers
 ----------------------------------------
@@ -94,7 +88,7 @@ We can either use the dedicated command:
 	Files missing (proper) header:
 	app.js
 
-... or use ``xolti status``, which will tell you the state of each of your files.
+... or use ``xolti status``, which will report the files without correct headers.
 
 .. code-block:: bash
 
@@ -105,7 +99,7 @@ We can either use the dedicated command:
 Adding the header to your files
 -------------------------------
 
-Looks like ``app.js`` is missing a header. Xolti can create and insert one for you, with the
+Looks like ``app.js`` is missing a header... Xolti can create and insert one for you, with the
 ``add`` command:
 
 .. code-block:: bash
@@ -127,11 +121,11 @@ Verifying the result
 --------------------
 
 Of course, you can verify that Xolti have actually added the header by simply opening the
-file, but you can also use the ``check`` command:
+file, but you can also use once again the ``status`` command:
 
 .. code-block:: bash
 
-	remi ~/myAwesomeProject]$ xolti check app.js
+	remi ~/myAwesomeProject]$ xolti status app.js
 	Correct header.
 
 That's it ! Your project is correctly licensed :).
@@ -143,17 +137,17 @@ Now that we think of it, ``myAwesomeProject`` is not such a good name. ``myFanta
 is way better ! To let xolti know of our change of mind, we can edit the ``xolti.yml`` file,
 and replace the value of the key ``project_name`` by ``myFantasticProject``.
 
-If we ``check`` again the ``app.js`` file, xolti warns us about its now incorrect header:
+When we ask xolti once again about the status of the ``app.js`` file, it warns us about the now incorrect header:
 
 .. code-block:: bash
 
-	xolti check app.js
+	remi ~/myAwesomeProject]$ xolti status app.js
 	Line 5: expected "myFantasticProject" but got "myAwesomeProject".
 	Line 7: expected "myFantasticProject" but got "myAwesomeProject".
 	Line 12: expected "myFantasticProject" but got "myAwesomeProject".
 	Line 18: expected "myFantasticProject" but got "myAwesomeProject".
 
-You can then correct this outdated header.
+You can then manually correct this outdated header.
 
 Deleting the header in a file
 -----------------------------

data/docs/index.rst

@@ -9,3 +9,4 @@ Contents:
     intro
     installation
     getting_started
+    xoltignore

data/docs/installation.rst

@@ -1,7 +1,7 @@
 Installation
 ============
 
-Xolti being available on `RubyGems.org`_ makes it fairly easy to be installed :
+Xolti is available on `RubyGems.org`, the Ruby community's gem hosting service. Assuming you have already installed Ruby, this makes Xolti fairly easy to install :
 
 .. code-block:: bash
 

data/docs/xoltignore.rst

@@ -0,0 +1,65 @@
+Xoltignore reference
+====================
+
+In the same fashion git uses ``.gitignore`` files to know which files to track or not, xolti uses ``.xoltignore`` files to detect which files needs a header or not.
+
+You can create one ``.xoltignore`` in each directory of your project.
+
+Syntax
+------
+
+``.xoltignore`` files are plain text files, using a sub-set of the syntax of ``.gitignore`` :
+
+- Each line specifies a pattern used to ignore or not a path
+- A line is ignored if it is blank or starts with ``#```
+- Globing (use of ``*`` and/or ``**`` wildcards) is supported
+- A pattern can be inverted by prefixing it with ``!``
+- Pattern are read line by line, from top to bottom; lower rules override higher ones, and rules from a deeper folder override rules from higher folders
+- A pattern ending with ``/`` matches only directories
+
+Example : js project
+--------------------
+
+Folders/files structure :
+
+.. code-block:: text
+
+	|- Javascript_Project
+    	|- app.js
+    	|- package.json
+    	|- node_modules
+        	|- ...
+
+Possible ``.xoltignore`` :
+
+.. code-block:: text
+
+	# Ignore files installed by npm
+	node_modules
+
+	# Ignore package.json
+	package.json
+
+Example : java maven project
+----------------------------
+
+Folders/files structure :
+
+.. code-block:: text
+
+	|- Java_Maven_Project
+    	|- pom.xml
+    	|- readme
+    	|- src
+        	|- main
+                |- java
+		            |- App.java
+
+Possible ``.xoltignore`` :
+
+.. code-block:: text
+
+	# Ignore all files but pom.xml and java sources
+	*
+	!pom.xml
+	!src/**/*.java

data/exe/xolti

@@ -12,7 +12,7 @@
 #
 # 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
+# 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

data/lib/comment.rb

@@ -10,7 +10,7 @@
 #
 # 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
+# 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

data/lib/config.rb

@@ -10,7 +10,7 @@
 #
 # 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
+# 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
@@ -42,7 +42,7 @@ class XoltiConfig
 		@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))
+		@template = extract_template_if_present(raw_config)
 		@offset = raw_config["offset"] || 0
 	end
 
@@ -57,4 +57,11 @@ class XoltiConfig
 			year: raw_project_info["year"] || Date.today().year.to_s
 		}
 	end
+
+	private def extract_template_if_present(raw_config)
+		return raw_config["template"] if raw_config.include?("template")
+		default_template_path = Resources.get_template_path(@license)
+		return IO.binread(default_template_path) if File.exists?(default_template_path)
+		nil
+	end
 end

data/lib/core.rb

@@ -10,7 +10,7 @@
 #
 # 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
+# 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
@@ -45,7 +45,7 @@ module Core
 		template = config.template
 		ext = File.extname(path)
 		detected = HeaderDetector.detect(path, template, config.get_comment(ext))
-		return [{type: "no_header_found"}] if !detected
+		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

@@ -1,5 +1,5 @@
 # default_comment_tokens.rb
-# Copyright (C) Rémi Even 2016
+# Copyright (C) Rémi Even 2016-2017
 #
 # This file is part of Xolti.
 #
@@ -10,7 +10,7 @@
 #
 # 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
+# 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
@@ -33,6 +33,7 @@ class DefaultComment
 		"e" => ["--", "-- ", "--"],
 		"el" => ["!!!", "!!! ", "!!!"],
 		"erl" => ["%%%", "%%% ", "%%%"],
+		"elm" => ["{-", "  ", "-}"],
 		"f" => ["!", "! ", "!"],
 		"fml" => ["<!--", " ", "-->"],
 		"ftl" => ["<#--", " ", "-->"],

data/lib/file_finder.rb

@@ -10,46 +10,46 @@
 #
 # 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
+# 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/>.
-# TODO : handle "folder/file" patterns
+
+require_relative "path_rule"
+
 def parse_xoltignore(path)
-	xoltignorePath = "#{path}/.xoltignore"
-	return [] if !File.file?(xoltignorePath)
-	File.readlines(xoltignorePath).reject {|line| line == "" || line[0] == "#"}.map {|line| line.chomp}
+	xoltignore_path = "#{path}/.xoltignore"
+	return [] if !File.file?(xoltignore_path)
+	File.readlines(xoltignore_path)
+		.reject {|line| line == "" || line[0] == "#"}
+		.map {|line| line.chomp}
+		.map {|line| PathRule.new(path, line)}
 end
 
 module FileFinder
-	def FileFinder.explore_folder(folder=Dir.pwd, ignoreRules=[])
-		fileAcc = []
-		ignoredPaths = [".", "..", ".git", ".xoltignore", "xolti.yml", "LICENSE"]
-		ignoreRules += parse_xoltignore(folder)
+	def FileFinder.explore_folder(folder=Dir.pwd, ignore_rules=[])
+		files = []
+		ignored_paths = [".", "..", ".git", ".xoltignore", "xolti.yml", "LICENSE"]
+		ignore_rules += parse_xoltignore(folder)
 
 		Dir.glob("#{folder}/{*,.*}")
-			.delete_if {|x| ignoredPaths.include?(File.basename(x))}
-			.delete_if do |x|
-				basename = File.basename(x)
-				toIgnore = false
-				ignoreRules.each do |rule|
-					if (rule[0] == "!" && File.fnmatch(rule[1..-1], basename))
-						toIgnore = false
-					elsif (File.fnmatch(rule, basename))
-						toIgnore = true
-					end
-				end
-				toIgnore
-			end
+			.delete_if {|x| ignored_paths.include?(File.basename(x))}
 			.each do |path|
+				# Do NOT ignore by default
+				ignore = :exclude
 				if File.directory?(path)
-					fileAcc += explore_folder(path, ignoreRules)
+					ignore_rules.each do |rule|
+						ignore = rule.effect if rule.folder_match(path)
+					end
+					files += explore_folder(path, ignore_rules) if ignore == :exclude
 				else
-					fileAcc << path
+					ignore_rules.each do |rule|
+						ignore = rule.effect if rule.file_match(path)
+					end
+					files << path if ignore == :exclude
 				end
 			end
-
-		fileAcc
+		files
 	end
 end

data/lib/file_modification.rb

@@ -10,7 +10,7 @@
 #
 # 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
+# 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

data/lib/header_detector.rb

@@ -10,7 +10,7 @@
 #
 # 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
+# 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

data/lib/header_generator.rb

@@ -10,21 +10,17 @@
 #
 # 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
+# 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)
+		info = config.project_info.merge({file_name: File.basename(path)})
+		bare_header = config.template % info
 		Comment.comment(bare_header, config.get_comment(File.extname(path)))
 	end
 end

data/lib/header_validator.rb

@@ -10,7 +10,7 @@
 #
 # 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
+# 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

data/lib/path_rule.rb

@@ -0,0 +1,70 @@
+# path_rule.rb
+# Copyright (C) Rémi Even 2017
+#
+# 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 PathRule
+
+	attr_reader :effect
+
+	def initialize(path, pattern)
+		if pattern.start_with?("!") then
+			@effect = :exclude
+			pattern = pattern[1..-1]
+		else
+			@effect = :include
+		end
+		@file_regexp = pattern_to_file_regexp(path, pattern)
+		@folder_regexp = pattern_to_folder_regexp(path, pattern)
+	end
+
+	def file_match(path)
+		@file_regexp =~ path
+	end
+
+	def folder_match(path)
+		@folder_regexp =~ path
+	end
+
+	private def pattern_to_file_regexp(path, pattern)
+		return nil if concern_only_folders(pattern)
+		Regexp.new(glob_to_regexp(pattern).unshift(Regexp.escape(path)).join())
+	end
+
+	private def pattern_to_folder_regexp(path, pattern)
+		pattern = pattern.chomp("/")
+		prefix_detector_regexp = glob_to_regexp(pattern)
+			.reverse()
+			.reduce do |acc, s|
+				"#{s}(#{acc})?"
+			end
+		Regexp.new(path + prefix_detector_regexp)
+	end
+
+	private def concern_only_folders(pattern)
+		pattern.end_with?("/") || pattern.end_with?("**")
+	end
+
+	private def glob_to_regexp(pattern)
+		pattern.split("/")
+			.map do |e|
+				if e == "**" then
+					"(/.*)?"
+				else
+					Regexp.escape("/" + e).gsub("\\*", "[^/]*")
+				end
+			end
+	end
+end