Merge branch 'release/0404'

Author: rm-code

CHANGELOG.md

@@ -1,3 +1,14 @@
+# Version 0404 - 2015/11/24
+
+### Additions
+- Added option to add a repository by dropping its folder onto LoGiVi (Closes [#46](https://github.com/rm-code/logivi/issues/46))
+- Added automatic camera zoom (Closes [#47](https://github.com/rm-code/logivi/issues/47))
+- Added fading of deleted files. They will no longer be removed instantly, but instead fade out until they are invisible (Closes [#49](https://github.com/rm-code/logivi/issues/49))
+- Added animation of files when they are rearranged around their parent nodes
+
+### Fixes
+- Fixed [#44](https://github.com/rm-code/logivi/issues/44) - File paths are validated after the config has been validated
+- Fixed direction of camera rotation
 
 # Version 0375 - 2015/11/11
 

README.md

@@ -1,6 +1,6 @@
 # LoGiVi
 
-LoGiVi is a git-repository visualisation tool inspired by [Gource](http://gource.io/) and __currently in development__. It was written from scratch using [Lua](http://www.lua.org/) and the [LÖVE](https://love2d.org/) framework.
+LoGiVi is a git-repository visualisation tool inspired by [Gource](http://gource.io/) and __currently in development__. It was written from scratch using [Lua](http://www.lua.org/) and the [LÖVE](https://love2d.org/) framework. Note: Since version [0375](https://github.com/rm-code/logivi/releases/tag/0375) LoGiVi uses version [0.10.0](https://love2d.org/wiki/0.10.0) of the LÖVE framework. 
 
 ![Example Visualization](https://github.com/rm-code/logivi/wiki/media/logivi_0312.gif)
 

conf.lua

@@ -1,6 +1,6 @@
 local PROJECT_TITLE = "LoGiVi";
 
-local PROJECT_VERSION = "0375";
+local PROJECT_VERSION = "0404";
 
 local PROJECT_IDENTITY = "rmcode_LoGiVi";
 

main.lua

@@ -15,7 +15,7 @@ local showDebug = false;
 --
 local function checkSupport()
     print("\n---- RENDERER  ---- ");
-    local name, version, vendor, device = love.graphics.getRendererInfo()
+    local name, version, vendor, device = love.graphics.getRendererInfo();
     print(string.format("Name: %s \nVersion: %s \nVendor: %s \nDevice: %s", name, version, vendor, device));
 
     print("\n----  SYSTEM   ---- ");
@@ -86,9 +86,8 @@ function love.resize(x, y)
 end
 
 function love.keypressed(key)
-    if key == ' ' then
-        key = 'space';
-    elseif tonumber(key) then
+    -- Transform strings to numbers to fit the control values we read from the config file.
+    if tonumber(key) then
         key = tonumber(key);
     end
 
@@ -114,3 +113,7 @@ end
 function love.wheelmoved(x, y)
     ScreenManager.wheelmoved(x, y);
 end
+
+function love.directorydropped(path)
+    ScreenManager.directorydropped(path);
+end

src/FileManager.lua

@@ -59,7 +59,7 @@ function FileManager.draw(x, y)
     love.graphics.print(totalFiles, x + FRST_OFFSET, y + 10);
     love.graphics.print('Files', x + SCND_OFFSET, y + 10);
     for i, tbl in ipairs(sortedList) do
-        love.graphics.setColor(tbl.color);
+        love.graphics.setColor(tbl.color.r, tbl.color.g, tbl.color.b);
         love.graphics.print(tbl.amount, x + FRST_OFFSET, y + 10 + i * 20);
         love.graphics.print(tbl.extension, x + SCND_OFFSET, y + 10 + i * 20);
         love.graphics.setColor(255, 255, 255);
@@ -80,7 +80,11 @@ function FileManager.add(fileName)
         extensions[ext] = {};
         extensions[ext].extension = ext;
         extensions[ext].amount = 0;
-        extensions[ext].color = colors[ext] or { love.math.random(0, 255), love.math.random(0, 255), love.math.random(0, 255) };
+        extensions[ext].color = colors[ext] or {
+            r = love.math.random(0, 255),
+            g = love.math.random(0, 255),
+            b = love.math.random(0, 255)
+        };
     end
     extensions[ext].amount = extensions[ext].amount + 1;
     totalFiles = totalFiles + 1;

src/Resources.lua

@@ -18,7 +18,6 @@ local fonts  = {
     }
 };
 
-
 -- ------------------------------------------------
 -- Public Functions
 -- ------------------------------------------------

src/conf/ConfigReader.lua

@@ -7,6 +7,10 @@ local ConfigReader = {};
 local FILE_NAME = 'settings.cfg';
 local TEMPLATE_PATH = 'res/templates/settings.cfg';
 
+local INVALID_CONFIG_HEADER   = 'Invalid config file';
+local MISSING_SECTION_WARNING = 'Seems like the loaded configuration file is missing the [%s] section. The default settings will be used instead.';
+local MISSING_VALUE_WARNING   = 'Seems like the loaded configuration file is missing the [%s] value in the [%s] section. The default settings will be used instead.';
+
 -- ------------------------------------------------
 -- Local Variables
 -- ------------------------------------------------
@@ -18,16 +22,28 @@ local config;
 -- Local Functions
 -- ------------------------------------------------
 
+---
+-- Checks if the settings file exists on the user's system.
+--
 local function hasConfigFile()
     return love.filesystem.isFile(FILE_NAME);
 end
 
+---
+-- Creates a new settings file on the user's system based on the default template.
+-- @param name - The file name to use for the config file.
+-- @param default - The path to the default settings file.
+--
 local function createConfigFile(name, default)
     for line in love.filesystem.lines(default) do
         love.filesystem.append(name, line .. '\r\n');
     end
 end
 
+---
+-- Tries to transform strings to their actual types if possible.
+-- @param value - The value to transform.
+--
 local function toType(value)
     value = value:match('^%s*(.-)%s*$');
     if value == 'true' then
@@ -44,6 +60,7 @@ end
 local function loadFile(file)
     local config = {};
     local section;
+
     for line in love.filesystem.lines(file) do
         if line == '' or line:find(';') == 1 then
             -- Ignore comments and empty lines.
@@ -68,31 +85,31 @@ local function loadFile(file)
         end
     end
 
-    -- Validate file paths.
-    for project, path in pairs(config.repositories) do
-        config.repositories[project] = path:gsub('\\+', '/');
-    end
-
     return config;
 end
 
+---
+-- Validates a loaded config file by comparing it to the default config file.
+-- It checks if the file contains all the necessary sections and values. If it
+-- doesn't a warning is displayed and the default config will be used.
+-- @param default - The default file to use for comparison.
+-- @param loaded - The settings file loaded from the user's system.
+--
 local function validateFile(default, loaded)
     print('Validating configuration file ... ');
     for skey, section in pairs(default) do
 
         -- If loaded config file doesn't contain section return default.
         if loaded[skey] == nil then
-            love.window.showMessageBox('Invalid config file', 'Seems like the loaded configuration file is missing the "' ..
-                    skey .. '" section. The default settings will be used instead.', 'warning', false);
+            love.window.showMessageBox(INVALID_CONFIG_HEADER, string.format(MISSING_SECTION_WARNING, skey), 'warning', false);
             return default;
         end
 
+        -- If the loaded config file is missing a value, display warning and return default.
         if type(section) == 'table' then
             for vkey, _ in pairs(section) do
                 if loaded[skey][vkey] == nil then
-                    love.window.showMessageBox('Invalid config file',
-                        'Seems like the loaded configuration file is missing the "' ..
-                                vkey .. '" value in the "' .. skey .. '" section. The default settings will be used instead.', 'warning', false);
+                    love.window.showMessageBox(INVALID_CONFIG_HEADER, string.format(MISSING_VALUE_WARNING, vkey, skey), 'warning', false);
                     return default;
                 end
             end
@@ -103,6 +120,17 @@ local function validateFile(default, loaded)
     return loaded;
 end
 
+---
+-- Replaces backslashes in paths with forwardslashes.
+-- @param The loaded config.
+--
+local function validateRepositoryPaths(config)
+    for project, path in pairs(config.repositories) do
+        config.repositories[project] = path:gsub('\\+', '/');
+    end
+    return config;
+end
+
 -- ------------------------------------------------
 -- Public Functions
 -- ------------------------------------------------
@@ -118,6 +146,7 @@ function ConfigReader.init()
     if not config then
         config = loadFile(FILE_NAME);
         config = validateFile(default, config);
+        config = validateRepositoryPaths(config);
     end
 
     return config;