falkorlib 0.6.19 → 0.7.0

data/spec/falkorlib/bootstrap_helpers_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Sun 2016-10-16 22:02 svarrette>
+# Time-stamp: <Thu 2016-11-03 21:38 svarrette>
 #
 # @description Check the Bootstrapping operations
 #
@@ -16,69 +16,119 @@ require 'fileutils'
 
 describe FalkorLib::Bootstrap do
 
-    include FalkorLib::Common
+  include FalkorLib::Common
 
-    dir = Dir.mktmpdir
+  dir = Dir.mktmpdir
 
-    before :all do
-        $stdout.sync = true
-        #FalkorLib.config[:no_interaction] = true
+  before :all do
+    $stdout.sync = true
+    #FalkorLib.config[:no_interaction] = true
+  end
+
+  after :all do
+    FileUtils.remove_entry_secure dir
+    #FalkorLib.config[:no_interaction] = false
+  end
+
+  context 'helper functions' do
+    it "#select_forge - none" do
+      expect(STDIN).to receive(:gets).and_return('1')
+      t = FalkorLib::Bootstrap.select_forge()
+      expect(t).to eq(:none)
     end
 
-    after :all do
-        FileUtils.remove_entry_secure dir
-        FalkorLib.config[:no_interaction] = false
+    it "#select_forge -- default to github" do
+      expect(STDIN).to receive(:gets).and_return('')
+      t = FalkorLib::Bootstrap.select_forge(:github)
+      expect(t).to eq(:github)
     end
 
-    context 'helper functions' do
-        it "#select_forge - none" do
-            expect(STDIN).to receive(:gets).and_return('1')
-            t = FalkorLib::Bootstrap.select_forge()
-            expect(t).to eq(:none)
-        end
-
-        it "#select_forge -- default to github" do
-            expect(STDIN).to receive(:gets).and_return('')
-            t = FalkorLib::Bootstrap.select_forge(:github)
-            expect(t).to eq(:github)
-        end
-
-        FalkorLib::Config::Bootstrap::DEFAULTS[:licenses].keys.each do |lic|
-            it "#select_licence -- default to #{lic}" do
-                expect(STDIN).to receive(:gets).and_return('')
-                t = FalkorLib::Bootstrap.select_licence(lic)
-                expect(t).to eq(lic)
-            end
-        end
-
-        ### Badges
-        it "#get_badge " do
-            subject = 'licence'
-            status  = 'GPL-2.0'
-            t = FalkorLib::Bootstrap.get_badge(subject, status)
-            expect(t).to match(/#{subject}/)
-            expect(t).to match(/#{status.sub(/-/, '--')}/)
-        end
-    end # context
-
-
-    ############################################
-    context 'boostrap repo' do
-        it '#repo' do
-            FalkorLib.config[:no_interaction] = true
-            FalkorLib::Bootstrap.repo(dir, { :no_interaction => true, :git_flow => false })
-            FalkorLib.config[:no_interaction] = false
-        end
+    FalkorLib::Config::Bootstrap::DEFAULTS[:licenses].keys.each do |lic|
+      it "#select_licence -- default to #{lic}" do
+        expect(STDIN).to receive(:gets).and_return('')
+        t = FalkorLib::Bootstrap.select_licence(lic)
+        expect(t).to eq(lic)
+      end
     end
 
-    ############################################
-    context 'boostrap motd' do
-        it "#motd" do
-            motdfile = File.join(dir, 'motd1')
-            FalkorLib::Bootstrap.motd(dir, { :file => "#{motdfile}", :no_interaction => true })
-            t = File.exists?(motdfile)
-            expect(t).to be true
-        end
+    ### Badges
+    it "#get_badge " do
+      subject = 'licence'
+      status  = 'GPL-2.0'
+      t = FalkorLib::Bootstrap.get_badge(subject, status)
+      expect(t).to match(/#{subject}/)
+      expect(t).to match(/#{status.sub(/-/, '--')}/)
     end
+  end # context
+
+  ############################################
+  #context 'bootstrap/base' do
+    # it "#trash " do
+    #   FalkorLib.config[:no_interaction] = true
+    #   FalkorLib::Bootstrap.trash(dir)
+    #   default_trashdir = File.join(dir, FalkorLib.config[:templates][:trashdir])
+    #   t = File.directory?( default_trashdir )
+    #   expect(t).to be true
+    #   t = File.exist?(File.join(default_trashdir, '.gitignore'))
+    #   expect(t).to be true
+    # end
+
+    # it "#trash -- with non standard trash dir (dir = '#{dir}')" do
+    #   trash = '.trashtoto'
+    #   FalkorLib::Bootstrap.trash(dir, trash)
+    #   trashdir = File.join(dir, trash)
+    #   t = File.directory?( trashdir )
+    #   expect(t).to be true
+    #   t = File.exist?(File.join(trashdir, '.gitignore'))
+    #   expect(t).to be true
+    # end
+
+    # it "#versionfile" do
+    #   f = File.join(dir, 'VERSION')
+    #   FalkorLib::Bootstrap.versionfile(dir)
+    #   t = File.exist?(f)
+    #   expect(t).to be true
+    #   content = `cat #{f}`.chomp
+    #   expect(content).to eq('0.0.0')
+    # end
+
+    # it "#versionfile -- non standard file and version" do
+    #   opts = {
+    #     :file    => 'version.txt',
+    #     :version => '1.2.3'
+    #   }
+    #   f = File.join(dir, opts[:file])
+    #   FalkorLib::Bootstrap.versionfile(dir, opts)
+    #   t = File.exist?(f)
+    #   expect(t).to be true
+    #   content = `cat #{f}`.chomp
+    #   expect(content).to eq(opts[:version])
+    # end
+
+
+
+
+
+  # end
+
+
+  # ############################################
+  # context 'boostrap repo' do
+  #     it '#repo' do
+  #         FalkorLib.config[:no_interaction] = true
+  #         FalkorLib::Bootstrap.repo(dir, { :no_interaction => true, :git_flow => false })
+  #         FalkorLib.config[:no_interaction] = false
+  #     end
+  # end
+
+  # ############################################
+  # context 'boostrap motd' do
+  #     it "#motd" do
+  #         motdfile = File.join(dir, 'motd1')
+  #         FalkorLib::Bootstrap.motd(dir, { :file => "#{motdfile}", :no_interaction => true })
+  #         t = File.exists?(motdfile)
+  #         expect(t).to be true
+  #     end
+  # end
 
 end

data/spec/falkorlib/bootstrap_latex_spec.rb

@@ -0,0 +1,145 @@
+#!/usr/bin/ruby
+# coding: utf-8
+#########################################
+# bootstrap_latex_spec.rb
+# @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# Time-stamp: <Sun 2016-11-13 21:37 svarrette>
+#
+# @description Check the Bootstrapping operations for LaTeX-based projects
+#
+# Copyright (c) 2013 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# .             http://varrette.gforge.uni.lu
+##############################################################################
+
+require 'spec_helper'
+require 'tmpdir'
+require 'fileutils'
+
+describe FalkorLib::Bootstrap do
+
+  include FalkorLib::Common
+
+  dir = Dir.mktmpdir
+  supported_latex_types = [ :article ]
+  # I give up on making the compilation working on travis (it currently fails
+  # with the message 'LaTeX Error: There's no line here to end. l.57') -- see build
+  # [#326.1](https://travis-ci.org/Falkor/falkorlib/jobs/175603403) for instance.
+  # not figure out the problem as it works fine on vagrant/ubuntu-precise and mac.
+  supported_latex_types << :beamer unless ENV['TRAVIS_CI_RUN']
+
+  #_____________
+  before :all do
+    $stdout.sync = true
+    FalkorLib.config[:no_interaction] = true
+  end
+
+  #____________
+  after :all do
+    FileUtils.remove_entry_secure dir
+    FalkorLib.config[:no_interaction] = false
+  end
+
+  ########################################################################
+  context "bootstrap/latex within temporary directory '#{dir}'" do
+
+    it "#latex -- unsupported type" do
+      expect { FalkorLib::Bootstrap::latex(dir, :toto) }.to raise_error (SystemExit)
+    end
+
+    ###### LaTeX slides
+    supported_latex_types.each do |type|
+      it "#latex(#{type})" do
+        name = "latex-#{type}"
+        projectdir = case type
+                     when :beamer
+                       'slides'
+                     when :article
+                       'articles'
+                     end
+        subdirname = File.join(projectdir, "#{Time.now.year}", name)
+        subdir     = File.join(dir, subdirname)
+        srcdir     = File.join(subdir, 'src')
+        trashdir   = File.join(srcdir, FalkorLib.config[:templates][:trashdir])
+        imagedir   = File.join(srcdir, 'images')
+        c = FalkorLib::Bootstrap::latex(dir, type, {
+                                          :name => name
+                                        })
+        # check that everything was set accordingly
+        expect(FalkorLib::Git.init?(dir)).to be true
+
+        # check expected git submodules
+        submodules = [ 'Makefiles' ]
+        submodules << 'beamerthemeFalkor' if type == :beamer
+        submodules.each do |d|
+          expect(Dir.exist?( File.join(dir, FalkorLib.config.git[:submodulesdir], d))).to be true
+        end
+
+        # check main files at the root directory
+        main_root_files = [ '.gitmodules', 'VERSION', 'README.md' ]
+        main_root_files.each do |f|
+          expect(File.exist?(File.join(dir, f))).to be true
+        end
+
+        # check main LaTeX project directory
+        expect(Dir.exist?(subdir)).to be true
+        main_files = [ '.root', '.makefile.d', 'Makefile']
+        main_files.each do |f|
+          file = File.join(subdir, f)
+          expect(File.exist?(file)).to be true
+        end
+        v = File.readlink(File.join(subdir, 'Makefile'))
+        expect(v).to include '.makefile.d/latex_src'
+
+        # check src directory
+        expect(Dir.exist?(srcdir)).to be true
+        src_latex_symlinks = [ 'Makefile', '_style.sty', '.gitignore' ]
+        src_latex_symlinks.each do |f|
+          file = File.join(srcdir, f)
+          expect(File.exist?(file)).to be true
+          expect(File.readlink(file)).to include '.makefile.d/latex'
+        end
+
+        src_latex_files = [ "#{name}.tex" ]
+        src_latex_files  << '_content.md' if type == :beamer
+        src_latex_files = [ '_abstract.tex', '_conclusion.tex', '_experiments.tex', '_introduction.tex', 'biblio.bib', '_related_works.tex' ] if type == :article
+        src_latex_files.each do |f|
+          file = File.join(srcdir, f)
+          expect(File.exist?(file)).to be true
+        end
+        if type == :beamer
+          [ 'beamerthemeFalkor' ].each do |f|
+            file = File.join(srcdir, "#{f}.sty")
+            expect(File.exist?(file)).to be true
+            expect(File.readlink(file)).to include File.join(FalkorLib.config[:git][:submodulesdir], f)
+          end
+        end
+        # trash dir
+        expect(Dir.exist?(trashdir)).to be true
+        # check images dir
+        expect(Dir.exist?(imagedir)).to be true
+        main_files.each do |f|
+          file = File.join(imagedir, f)
+          expect(File.exist?(file)).to be true
+        end
+        image_makefile = File.join(imagedir, 'Makefile')
+        expect(File.readlink(image_makefile)).to include '.makefile.d/images'
+
+        # Finally try to compile it
+        if command?('make') && command?('pandoc')
+          [ "#{srcdir}", "#{subdir}" ].each do |d|
+            t = run %( make -C #{d} )
+            expect(t).to eq(0)
+            pdf = File.join(srcdir, "#{name}.pdf")
+            expect(File.exist?(pdf)).to be true
+          end
+        end
+      end
+    end
+
+
+
+
+
+  end # context "bootstrap/latex"
+
+end

data/spec/falkorlib/bootstrap_link_spec.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby
+#########################################
+# bootstrap_link_spec.rb
+# @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# Time-stamp: <Sun 2016-11-13 06:46 svarrette>
+#
+# @description Check the Bootstrapping operations for [sym]link
+#
+# Copyright (c) 2013 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# .             http://varrette.gforge.uni.lu
+##############################################################################
+
+require 'spec_helper'
+require 'tmpdir'
+require 'fileutils'
+
+describe FalkorLib::Bootstrap::Link do
+
+  include FalkorLib::Common
+
+  dir        = Dir.mktmpdir
+  subdirname = 'sub/dir'
+  supported_makefiles = [
+    :repo, :generic, :latex, :src, :gnuplot, :images, :markdown
+  ]
+  makefile_d = '.makefile.d'
+
+  #_____________
+  before :all do
+    $stdout.sync = true
+    FalkorLib.config[:no_interaction] = true
+  end
+
+  #____________
+  after :all do
+    FileUtils.remove_entry_secure dir
+    FalkorLib.config[:no_interaction] = false
+  end
+
+  ########################################################################
+  context "bootstrap/link within temporary directory '#{dir}'" do
+
+    subdir  = File.join(dir, subdirname)
+    dotroot = File.join(subdir, '.root')
+
+    it "initialize Git in the temporary directory #{dir}" do
+      c = FalkorLib::Git.init(dir)
+      expect(c).to eq(0)
+      t = FalkorLib::Git.init?(dir)
+      expect(t).to be true
+    end
+
+    ### '.root' symlink
+    it "#root" do
+      FileUtils.mkdir_p( subdir )
+      c = FalkorLib::Bootstrap::Link.root(subdir)
+      expect(c).to eq(0)
+      t = File.exists?(dotroot)
+      expect(t).to be true
+      v = File.readlink(dotroot)
+      expect(v).to eq('../..')
+    end
+
+    it "#root again, link already existing" do
+      t = FalkorLib::Bootstrap::Link.root(subdir)
+      expect(t).to eq(1)
+      c = capture(:stdout) { FalkorLib::Bootstrap::Link.root(subdir) }
+      expect(c).to include "the symbolic link '.root' already exists"
+    end
+
+    it "#root -- different symlink name" do
+      linkname       = '.custom-root'
+      custom_dotroot = File.join(subdir, linkname)
+      c = FalkorLib::Bootstrap::Link.root(subdir, { :name => linkname })
+      expect(c).to eq(0)
+      t = File.exists?(custom_dotroot)
+      expect(t).to be true
+      v = File.readlink(custom_dotroot)
+      expect(v).to eq('../..')
+    end
+
+    it "#root -- at git rootdir" do
+      c = capture(:stdout) { FalkorLib::Bootstrap::Link.root(dir) }
+      expect(c).to include 'Already at the root directory of the Git repository'
+    end
+
+    ###### My favorite Makefiles
+    supported_makefiles.each do |type|
+
+      workdir       = File.join(dir, "#{type}")
+      makefile      = File.join(workdir, 'Makefile')
+      dotmakefile_d = File.join(workdir, makefile_d)
+
+      it "#makefile -- type '#{type}'" do
+        FileUtils.mkdir_p(workdir)
+        c = FalkorLib::Bootstrap::Link.makefile(workdir, { type.to_sym => true })
+        expect(c).to eq(0)
+
+        # check existence of symlinks
+        d = File.exists?(dotmakefile_d)
+        expect(d).to be true
+        t = File.exists?(makefile)
+        expect(t).to be true
+
+        # check targets of symlinks
+        vd = File.readlink(dotmakefile_d)
+        expect(vd).to include File.join(FalkorLib.config[:git][:submodulesdir], 'Makefiles')
+
+        v = File.readlink(makefile)
+        expect(v).to include "#{type}"
+      end
+    end
+
+    type = 'latex'
+    it "#makefile -- again (type #{type}), links already existing" do
+      workdir = File.join(dir, type)  # for instance
+      makefile      = File.join(workdir, 'Makefile')
+      pre_check = File.exists?(makefile)
+      expect(pre_check).to be true
+
+      t = FalkorLib::Bootstrap::Link.makefile(workdir, { type.to_sym => true })
+      expect(t).to eq(1)
+      c = capture(:stdout) {
+        FalkorLib::Bootstrap::Link.makefile(workdir, { type.to_sym => true })
+      }
+      [
+        "the git submodule 'Makefiles' is already setup",
+        "the symbolic link '.root' already exists",
+        "Makefile already setup"
+      ].each do |pattern|
+        expect(c).to include pattern
+      end
+    end
+
+  end # context "bootstrap/link"
+
+end