falkorlib 0.8.10 → 0.9.1

data/lib/falkorlib/bootstrap/git.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2020-04-20 16:13 svarrette>
+# Time-stamp: <Sat 2024-08-31 16:34 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -215,11 +215,26 @@ module FalkorLib
           run %( git crypt add-gpg-user #{k} )
         end
       end
+    end # gitcrypt
 
+    ###### gitignore ######
+    # Initialize .gitignore in the [current] directory
+    def gitignore(dir = Dir.pwd, options = {})
+      path = normalized_path(dir)
+      unless File.directory?(path)
+        warning "The directory '#{path}' does not exist yet."
+        warning 'Do you want to create (and git init) this directory?'
+        really_continue?
+        run %(mkdir -p #{path})
+      end
+      templatedir = File.join( FalkorLib.templates, 'gitignore')
+      src_gitignore = 'All.gitignore'    # Default without any option
+      src_gitignore = 'TeX.gitignore'    if options[:latex]
+      src_gitignore = 'Python.gitignore' if options[:python]
+      src_gitignore = 'All.gitignore'    if options[:all]
+      run %(cp #{templatedir}/#{src_gitignore} #{path}/.gitignore)
+    end # gitignore
 
 
-
-    end # gitcrypt
-
   end # module Bootstrap
 end # module FalkorLib

data/lib/falkorlib/bootstrap/latex.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2017-01-16 23:15 svarrette>
+# Time-stamp: <Thu 2023-11-23 18:13 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -100,12 +100,17 @@ module FalkorLib
       info "populating '#{src_project_dir}'"
       #FalkorLib::Bootstrap::Link.root(srcdir, { :verbose => true} )
       FalkorLib::Bootstrap::Link.makefile(srcdir, :no_interaction => true)
-      [ '_style.sty', '.gitignore' ].each do |f|
+      [ '_style.sty' ].each do |f|
         Dir.chdir( srcdir ) do
           dst = ".makefile.d/latex/#{f}"
           run %( ln -s #{dst} #{f} ) unless File.exist?( File.join(srcdir, f) )
         end
       end
+      [ '.gitignore' ].each do |f|   # .gitignore no longer accepted as symlink
+        Dir.chdir( srcdir ) do
+          run %( cp .makefile.d/latex/#{f} #{f} ) unless File.exist?( File.join(srcdir, f) )
+        end
+      end
       if type == :beamer
         f = 'beamerthemeFalkor.sty'
         dst = "#{FalkorLib.config[:git][:submodulesdir]}/beamerthemeFalkor/#{f}"

data/lib/falkorlib/bootstrap/vagrant.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2020-04-20 10:23 svarrette>
+# Time-stamp: <Mon 2023-12-04 16:37 svarrette>
 ################################################################################
 # Interface for Bootstrapping MkDocs
 #
@@ -39,9 +39,23 @@ module FalkorLib
                     "Select OS to configure within your vagrant boxes by default",
                     (config[:boxes].keys.find_index(config[:os]) + 1))
       end
+      # Eventually adapt default provider and IP range
+      providers = ['virtualbox', 'libvirt']
+      default_provider = (config[:os] =~ /_uefi$/) ? 'libvirt': 'virtualbox'
+      info "OS selected: #{config[:os]} (thus with default provider: #{default_provider})"
+      config[:provider] = select_from(providers,
+        "Confirm vagrant hypervisor provider:",
+        providers.find_index(default_provider)+1)
+      config[:range] = case config[:provider]
+                       when 'libvirt'
+                         '192.168.122.1/24'
+                       else
+                         '192.168.56.0/21'
+                       end
       [ :ram, :vcpus, :domain, :range ].each do |k|
         config[k.to_sym] = ask("\tDefault #{k.capitalize}:", config[k.to_sym])
       end
+
       puts config.to_yaml
       FalkorLib::GitFlow.start('feature', 'vagrant', rootdir) if (use_git && FalkorLib::GitFlow.init?(rootdir))
       init_from_template(templatedir, rootdir, config,
@@ -55,15 +69,8 @@ module FalkorLib
       [ 'bootstrap.sh'].each do |f|
         FalkorLib::Git.add(File.join(scriptsdir, "#{f}")) if use_git
       end
-      #puppetdir  = File.join(confdir, 'puppet')
-      Dir.chdir( rootdir ) do
-        run %(git ignore '.vagrant/' ) if command?('git-ignore')
-        #   run %(ln -s README.md index.md )
-      #   run %(ln -s README.md contributing/index.md )
-      #   run %(ln -s README.md setup/index.md )
-      end
-      if File.exist?(File.join(rootdir, '.gitignore'))
-        FalkorLib::Git.add(File.join(rootdir, '.gitignore')) if use_git
+      [ '.gitignore', '.ruby-version' ].each do |f|
+        FalkorLib::Git.add(File.join(rootdir, "#{f}")) if (use_git && File.exist?(File.join(rootdir, "#{f}")))
       end
       return 0
       #exit_status.to_i

data/lib/falkorlib/cli.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2020-04-20 17:04 svarrette>
+# Time-stamp: <Sat 2024-08-31 16:30 svarrette>
 ################################################################################
 # Interface for the CLI
 #
@@ -93,6 +93,21 @@ CONFIG_LONG_DESC
         FalkorLib::Bootstrap.gitcrypt(path, options)
       end # gitcrypt
 
+      ###### gitignore ######
+      method_option :all, :aliases => ['--all', '-a' ], :type => :boolean, :default => true,
+                    :desc => "Ignore all files (except .gitignore)"
+      method_option :latex, :aliases => ['--latex', '--tex', '-l' ], :type => :boolean, :default => false,
+                    :desc => "Setup .gitignore for LaTeX sources"
+      method_option :python, :aliases => '-p', :type => :boolean, :default => false,
+                    :desc => "Setup .gitignore for Python project"
+      #......................................
+      desc "gitignore <PATH> [options]", "Initialize .gitignore for the [current] directory (by default, ignore all files but .gitignore"
+      def gitignore(path = '.')
+        FalkorLib::Bootstrap.gitignore(path, options)
+      end # gitignore
+
+
+
       ###### init ######
       desc "init <PATH> [options]", "Bootstrap a Git Repository"
       long_desc <<-INIT_LONG_DESC

data/lib/falkorlib/common.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sun 2020-04-12 14:38 svarrette>
+# Time-stamp: <Thu 2023-11-23 23:06 svarrette>
 ################################################################################
 
 require "falkorlib"
@@ -66,7 +66,7 @@ module FalkorLib #:nodoc:
     def warning(str)
       puts cyan("/!\\ WARNING: " + str)
     end
-    alias_method :warn, :warning
+    # alias_method :warn, :warning  # FIXME erb invokes also its own warn method
 
     ## Print an error message and abort
     def error(str)
@@ -375,7 +375,7 @@ module FalkorLib #:nodoc:
           next
         end
         #puts config.to_yaml
-        content += ERB.new(File.read(erb.to_s), nil, '<>').result(binding)
+        content += ERB.new(File.read(erb.to_s), trim_mode: '<>').result(binding)
       end
       # error "Unable to find the template file #{erbfile}" unless File.exists? (erbfile )
       # template = File.read("#{erbfile}")

data/lib/falkorlib/config.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Thu 2022-06-02 19:14 svarrette>
+# Time-stamp: <Tue 2023-11-21 17:21 svarrette>
 ################################################################################
 # FalkorLib Configuration
 #
@@ -56,8 +56,8 @@ module FalkorLib #:nodoc:
       #:custom_cfg   => '.falkorlib.yaml',
       :rvm => {
         # See https://www.ruby-lang.org/en/downloads/branches/ for stable branches
-        :rubies      => [ '3.1.2', '3.0.4', '2.7.6'],
-        :version     => '3.1.2',
+        :rubies      => [ '3.2.2', '3.1.4', '3.0.6', '2.7.8'],
+        :version     => '3.1.4',
         :versionfile => '.ruby-version',
         :gemsetfile  => '.ruby-gemset'
       },

data/lib/falkorlib/gem_tasks.rb

@@ -1 +1 @@
-lib/falkorlib/tasks/gem.rb
+tasks/gem.rb

data/lib/falkorlib/git_tasks.rb

@@ -1 +1 @@
-lib/falkorlib/tasks/git.rb
+tasks/git.rb

data/lib/falkorlib/puppet_tasks.rb

@@ -1 +1 @@
-lib/falkorlib/tasks/puppet.rb
+tasks/puppet.rb

data/lib/falkorlib/version.rb

@@ -19,7 +19,7 @@ module FalkorLib #:nodoc:
     # MAJOR: Defines the major version
     # MINOR: Defines the minor version
     # PATCH: Defines the patch version
-    MAJOR, MINOR, PATCH = 0, 8, 10
+    MAJOR, MINOR, PATCH = 0, 9, 1
 
     module_function
 
@@ -75,3 +75,4 @@ module FalkorLib #:nodoc:
 end
 
 
+

data/spec/falkorlib/bootstrap_latex_spec.rb

@@ -3,7 +3,7 @@
 #########################################
 # bootstrap_latex_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Thu 2017-08-17 22:28 svarrette>
+# Time-stamp: <Thu 2023-11-23 18:18 svarrette>
 #
 # @description Check the Bootstrapping operations for LaTeX-based projects
 #
@@ -92,17 +92,18 @@ describe FalkorLib::Bootstrap do
 
         # check src directory
         expect(Dir.exist?(srcdir)).to be true
-        src_latex_symlinks = [ 'Makefile', '_style.sty', '.gitignore' ]
+        src_latex_symlinks = [ 'Makefile', '_style.sty' ]
         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 = [ "#{name}.tex", '.gitignore' ]
+        src_latex_files += [ '_content.md', '.Makefile.local' ] 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|
+          # $stderr.puts "=> checking file: #{f}"
           file = File.join(srcdir, f)
           expect(File.exist?(file)).to be true
         end

data/spec/falkorlib/bootstrap_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Mon 2020-04-20 09:58 svarrette>
+# Time-stamp: <Sat 2024-08-31 16:18 svarrette>
 #
 # @description Check the basic Bootstrapping operations
 #
@@ -186,6 +186,50 @@ describe FalkorLib::Bootstrap do
             expect(File).to exist( File.join(dir, f))
           end
         end
+
+        it "#gitignore -- git ignore population from default templates (ignore all)" do
+          c = FalkorLib::Bootstrap.gitignore(dir, { :no_interaction => true })
+          gitignore = File.join(dir, '.gitignore')
+          expect(File).to exist( gitignore )
+          # Default .gitignore should ignore itself
+          File.read(File.realpath( gitignore )) do |f|
+            f.should include "!.gitignore"
+          end
+        end
+
+        it "#gitignore -- git ignore population from LaTeX templates" do
+          c = FalkorLib::Bootstrap.gitignore(dir, { :latex => true, :no_interaction => true })
+          gitignore = File.join(dir, '.gitignore')
+          expect(File).to exist( gitignore )
+          # Default .gitignore should ignore itself
+          File.read(File.realpath( gitignore )) do |f|
+            [
+              "*.aux",
+              "*.synctex",
+              "/*.pdf",       # ignore local PDF
+            ].each do |pattern|
+              f.should include "#{pattern}"
+            end
+          end
+        end
+
+        it "#gitignore -- git ignore population from Python templates" do
+          c = FalkorLib::Bootstrap.gitignore(dir, { :python => true, :no_interaction => true })
+          gitignore = File.join(dir, '.gitignore')
+          expect(File).to exist( gitignore )
+          # Default .gitignore should ignore itself
+          File.read(File.realpath( gitignore )) do |f|
+            [
+              "__pycache__/",
+              "*.egg-info",
+              "*.nox",
+            ].each do |pattern|
+              f.should include "#{pattern}"
+            end
+          end
+        end
+
+
       end
 
       if (ctx == :with_git and !ENV['TRAVIS_CI_RUN'])

data/spec/falkorlib/git_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # git_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Sun 2022-06-05 17:15 svarrette>
+# Time-stamp: <Wed 2023-11-22 17:21 svarrette>
 #
 # @description Check the Git operations
 #
@@ -316,7 +316,7 @@ describe FalkorLib::Git do
 
         [ :subtrees, :submodules ].each do |type|
           it "#config_warn(#{type})" do
-            t = capture(:stdout) { FalkorLib::Git.config_warn(type) }
+            t = capture(:stderr) { FalkorLib::Git.config_warn(type) }
             expect(t).to include "FalkorLib.config.git"
             expect(t).to include "FalkorLib.config.git.submodulesdir" if type == :submodules
           end

data/spec/falkorlib/gitflow_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # gitflow_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Sun 2020-04-12 15:15 svarrette>
+# Time-stamp: <Wed 2023-11-22 09:52 svarrette>
 #
 # @description Check the Git Flow operations -- see https://github.com/nvie/gitflow
 #
@@ -50,7 +50,7 @@ describe FalkorLib::GitFlow do
       it "#branch" do
         expected = {
           :master  => 'production',
-          :develop => 'devel'
+          :develop => 'master'
         }
         expected.each do |type,v|
           b = FalkorLib::GitFlow.branches(type.to_sym, dir)
@@ -82,9 +82,10 @@ describe FalkorLib::GitFlow do
         c = FalkorLib::GitFlow.guess_gitflow_config(dir)
         {
           :master  => 'production',
-          :develop => 'devel'
+          :develop => 'master'
         }.each do |type,v|
-          expect(c[:branches][type.to_sym]).to eq(v)
+          expect(c[:branches][type.to_sym]).to eq(v)      if v.is_a? String
+          expect(v).to include(c[:branches][type.to_sym]) if v.is_a? Array
         end
         {
           :feature    => 'feature/',

data/templates/gitignore/All.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/templates/gitignore/Python.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/