xolti 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de048a0ae89d250f210aa13d068c83a52affdf86
-  data.tar.gz: 55328550e499b26ba9545d4b20968a52b63a681f
+  metadata.gz: 2149450fe72b054a8f677791feaa457def62598e
+  data.tar.gz: 6c513ac14f888b04fb05a1c0672b292d5c4d4837
 SHA512:
-  metadata.gz: ce6cc5f27e5df590b245c300932407c4b8de3b479185c0919837cb6be6b875330c8e3d037c20031b8dabaa2043257f20079fe19385d9d0425819dbf9ec17688f
-  data.tar.gz: bc3d590a1a8dfeab0d7cc724a7ce95e43dfc849ebc049aa0d2482cd3de16a2572559b2be68685f88e7ef8695f23c70ef8e7017442b4a2df0fe2dbf5122d7e1a3
+  metadata.gz: ec1776900de5c30d513f1f2d9dc2272a4fad94aaac9de69c9a3fffd0898787049539e86b555c4dbce32b22c5e637f83f23f92ccb798493d5a42516b8812dd5ba
+  data.tar.gz: 9fe6b19b8f78acd4931f844669052daeb8f0f439b40ffa7ed3b48b6f2b9da50e15e4dfc3183d68ffe2661c243be7cb6af8d6ea61d92b2f0bdb015380ec2a308e

data/docs/getting_started.rst

@@ -0,0 +1,166 @@
+Getting started with a simple example
+=====================================
+
+Let's suppose you have a project, for example in NodeJS, with files organized like this :
+
+.. code-block:: text
+
+	|- myAwesomeProject
+    	|- app.js
+    	|- package.json
+    	|- node_modules
+        	|- ...
+
+Now, how do you use Xolti to manage your license ?
+
+Installation
+------------
+
+If not done already, this is the time to install Xolti. You can find detailed explanations in the
+installation section of this documentation, but running this command is probably sufficient:
+
+.. code-block:: bash
+
+	gem install xolti
+
+Initiating the project
+----------------------
+
+Then it's time to create the xolti configuration file, named ``xolti.yml``. This file will contain
+information for Xolti such as the name of your project and the license you have chosen.
+
+You can do this by running this command:
+
+.. code-block:: bash
+
+	xolti init
+
+This will trigger a command line utility asking you some information, and will create a ``xolti.yml``
+for your project based on what you answered.
+
+.. code-block:: bash
+
+	remi ~/myAwesomeProject]$ xolti init
+	Initiating xolti project
+	name (myAwesomeProject):
+	author: Rémi Even
+	license (GPL3.0):
+
+Values between parenthesis will be selected if you do not type anything.
+
+Creating a LICENSE file
+-----------------------
+
+Before adding license headers to your source file, you probably want to generate a ``LICENSE`` file,
+which will be in the root of your project, and will contain the complete text of the license you have
+chosen. To do so, use the following command :
+
+.. code-block:: bash
+
+	remi ~/myAwesomeProject]$ xolti generate-license
+	Created the LICENSE file (GPL3.0)
+
+Telling Xolti which files to modify (or not)
+--------------------------------------------
+
+Similarly to git and the ``.gitignore`` file, you can create a ``.xoltignore`` file to indicate
+xolti files to ignore. The syntax is the same; for this project, the content of the xoltignore
+would be :
+
+.. code-block:: text
+
+	node_modules
+	package.json
+
+.. 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.
+
+Checking which files are missing headers
+----------------------------------------
+
+Now that xolti knows which files to handle, we can ask it which ones are missing headers.
+We can either use the dedicated command:
+
+.. code-block:: bash
+
+	[22:14 remi ~/myAwesomeProject]$ xolti list-missing
+	Files missing (proper) header:
+	app.js
+
+... or use ``xolti status``, which will tell you the state of each of your files.
+
+.. code-block:: bash
+
+	xolti status
+	-- ./app.js
+	No header found.
+
+Adding the header to your files
+-------------------------------
+
+Looks like ``app.js`` is missing a header. Xolti can create and insert one for you, with the
+``add`` command:
+
+.. code-block:: bash
+
+	xolti add app.js
+
+.. tip::
+
+	We could have also used ``.`` instead of specifying ``app.js``; xolti would have add a
+	header in each file (recursively) from the current folder.
+
+.. note::
+
+	Xolti detects, based on its extension, that the ``app.js`` file contains Javascript.
+	This allows Xolti to know how to create a comment in this file (in this case,
+	with ``/*``, ``*`` and ``*/``).
+
+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:
+
+.. code-block:: bash
+
+	remi ~/myAwesomeProject]$ xolti check app.js
+	Correct header.
+
+That's it ! Your project is correctly licensed :).
+
+Detecting incorrect headers
+---------------------------
+
+Now that we think of it, ``myAwesomeProject`` is not such a good name. ``myFantasticProject``
+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:
+
+.. code-block:: bash
+
+	xolti check 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.
+
+Deleting the header in a file
+-----------------------------
+
+What if you decide that you no longer needs a header in your ``app.js`` ? Simply use the
+``delete`` command:
+
+.. code-block:: bash
+
+	xolti delete app.js

data/docs/index.rst

@@ -0,0 +1,11 @@
+Welcome to Xolti's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+    :maxdepth: 2
+
+    intro
+    installation
+    getting_started

data/docs/installation.rst

@@ -0,0 +1,50 @@
+Installation
+============
+
+Xolti being available on `RubyGems.org`_ makes it fairly easy to be installed :
+
+.. code-block:: bash
+
+    gem install xolti
+
+Once the installation completes, ``xolti`` is added to your ``$PATH``, so you can access it from everywhere.
+
+Requirements
+------------
+
+In order to properly work, Xolti requires Ruby to be installed. It has been tested with Ruby >= 2.1, but probably works with slightly older versions too.
+In addition, and as stated in its GemFile, Xolti requires Thor, a ruby gem used to easily create command line interfaces.
+
+Building from sources
+---------------------
+
+You can also create the gem from the source files, using the following commands (assuming you are in the project root):
+
+.. code-block:: bash
+
+    gem build xolti.gemspec
+
+You can then install it with :
+
+.. code-block:: bash
+
+    gem install xolti-[VERSION].gem
+
+where [VERSION] must be replaced by the current version of Xolti.
+
+Running the tests
+~~~~~~~~~~~~~~~~~
+
+Running the tests requires the gem ``test-unit``, and can be achieved with the command :
+
+.. code-block:: bash
+
+    ruby test/ts_suite.rb
+
+Alternatively, if you have installed ``rake`` in addition to ``test-unit``, you can use the command :
+
+.. code-block:: bash
+
+	rake test
+
+.. _`RubyGems.org`:     https://rubygems.org/gems/xolti

data/docs/intro.rst

@@ -0,0 +1,20 @@
+Introduction
+============
+
+Xolti is a tool assisting you to manage license headers in source files, powered by Ruby.
+
+Xolti is licensed under the terms of the GNU-GPL3, meaning it's free software.
+
+
+You can find the source code in the `Github repository`_
+
+`Xolti is still in developer preview.`
+
+Purpose
+-------
+
+If you ever had to manage the license of a project, you probably know how much a burden this task can become, especially if you try to keep it accurate among numerous files!
+
+Xolti is a piece of software aiming to assist the management of license-related information in a project. Its main functionality is to add and maintain license headers at the top of source files. Moreover, Xolti can also generate ``LICENSE`` files.
+
+.. _`Github repository`:   https://github.com/RemiEven/xolti

data/lib/default_comment_tokens.rb

@@ -36,7 +36,6 @@ class DefaultComment
 		"f" => ["!", "! ", "!"],
 		"fml" => ["<!--", " ", "-->"],
 		"ftl" => ["<#--", " ", "-->"],
-		"ftl" => ["<#--", " ", "-->"],
 		"gsp" => ["<!--", " ", "-->"],
 		"haml" => "-# ",
 		"hrl" => ["%%%", "%%% ", "%%%"],

data/lib/file_finder.rb

@@ -25,7 +25,7 @@ end
 module FileFinder
 	def FileFinder.explore_folder(folder=Dir.pwd, ignoreRules=[])
 		fileAcc = []
-		ignoredPaths = [".", "..", ".git", ".xoltignore", "xolti.yml", "header.txt"]
+		ignoredPaths = [".", "..", ".git", ".xoltignore", "xolti.yml", "LICENSE"]
 		ignoreRules += parse_xoltignore(folder)
 
 		Dir.glob("#{folder}/{*,.*}")

data/lib/version.rb

@@ -0,0 +1,5 @@
+module XoltiVersion
+	def XoltiVersion.get()
+		"0.1.1"
+	end
+end

data/lib/xolti.rb

@@ -24,6 +24,7 @@ require_relative "core"
 require_relative "config"
 require_relative "file_finder"
 require_relative "resources"
+require_relative "version"
 
 Signal.trap("INT") do
 	puts "\nCancelling..."
@@ -117,6 +118,25 @@ class XoltiCLI < Thor
 			end
 	end
 
+	map ["--version", "-v"] => :__print_version
+
+	desc "--version, -v", "Print version of xolti"
+	def __print_version()
+		puts XoltiVersion.get
+	end
+
+	map ["--license", "-l"] => :__print_license
+
+	desc "--license, -l", "Print licensing information of xolti"
+	def __print_license()
+		puts "Xolti version #{XoltiVersion.get}, Copyright (C) 2016 Rémi Even"
+		puts "Xolti comes with ABSOLUTELY NO WARRANTY."
+		puts "This is free software, and you are welcome to redistribute it"
+		puts "under the terms of the GPLv3."
+		puts "The complete license can be found at \"https://www.gnu.org/licenses/gpl.txt\"."
+		puts "The source code of xolti can be found at \"https://github.com/RemiEven/xolti\"."
+	end
+
 	no_commands {
 		def ask_for_name(config)
 			default_name = Pathname.getwd.basename.to_s
@@ -131,6 +151,13 @@ class XoltiCLI < Thor
 			config["project_info"]["author"] = typed_author
 		end
 
+		def ask_for_license(config)
+			default_license = "GPL3.0"
+			print "license (#{default_license}): "
+			typed_license = STDIN.gets.chomp
+			config["license"] = (typed_license == "") ? default_license : typed_license
+		end
+
 		def load_config()
 			begin
 				return XoltiConfig.load_config
@@ -148,6 +175,7 @@ class XoltiCLI < Thor
 		config = {"project_info" => {}}
 		self.ask_for_name(config)
 		self.ask_for_author(config)
+		self.ask_for_license(config)
 		File.write("xolti.yml", config.to_yaml)
 	end
 end

data/readme.md

@@ -3,6 +3,8 @@
 > Tool assisting developers to manage license headers in source files, powered by Ruby.
 
 [![Build Status](https://secure.travis-ci.org/RemiEven/xolti.svg?branch=master)](http://travis-ci.org/RemiEven/xolti)
+[![Gem Version](https://badge.fury.io/rb/xolti.svg)](https://badge.fury.io/rb/xolti)
+[![Documentation Status](http://readthedocs.org/projects/xolti/badge/?version=latest)](http://xolti.readthedocs.io/en/latest/?badge=latest)
 [![License](https://img.shields.io/badge/license-GPL3-19c6ff.svg)](http://www.gnu.org/licenses/gpl-3.0.en.html)
 
 ## Purpose

data/xolti.gemspec

@@ -1,6 +1,8 @@
+require_relative "lib/version"
+
 Gem::Specification.new do |spec|
 	spec.name = "xolti"
-	spec.version = "0.1.0"
+	spec.version = XoltiVersion.get
 	spec.summary = "A gem to manage license headers"
 	spec.description = "A gem to manage license headers, providing a simple CLI."
 	spec.authors = ["Rémi Even"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xolti
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rémi Even
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -42,6 +42,10 @@ files:
 - Gemfile
 - LICENSE
 - Rakefile
+- docs/getting_started.rst
+- docs/index.rst
+- docs/installation.rst
+- docs/intro.rst
 - exe/xolti
 - lib/comment.rb
 - lib/config.rb
@@ -54,6 +58,7 @@ files:
 - lib/header_validator.rb
 - lib/resources.rb
 - lib/template_utils.rb
+- lib/version.rb
 - lib/xolti.rb
 - readme.md
 - resources/headers/GPL3.0
@@ -85,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A gem to manage license headers