falkorlib 0.8.5 → 0.8.6

data/lib/falkorlib/cli/link.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Tue 2017-04-04 11:00 svarrette>
+# Time-stamp: <Mon 2020-04-20 17:12 svarrette>
 ################################################################################
 
 require 'thor'
@@ -26,6 +26,9 @@ module FalkorLib
       #......................................
       desc "rootdir [options]", "Create a symlink '.root' which targets the root of the repository"
       def rootdir(dir = Dir.pwd)
+        # TODO: find a generic way to handle help in subcommands
+        # -- see https://github.com/erikhuda/thor/issues/532
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap::Link.root(dir, options)
       end # rootdir
 
@@ -49,6 +52,7 @@ module FalkorLib
       #......................................
       desc "make [options]", "Create a symlink to one of Falkor's Makefile, set as Git submodule"
       def make(dir = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap::Link.makefile(dir, options)
       end # make
 

data/lib/falkorlib/cli/make.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Thu 2018-11-08 16:50 svarrette>
+# Time-stamp: <Mon 2020-04-20 17:11 svarrette>
 ################################################################################
 
 require 'thor'
@@ -14,6 +14,7 @@ module FalkorLib
     class Make < ::Thor
 
       include FalkorLib::Common
+      class_option :help, :aliases => ['-h', '--help'], type: :boolean
 
       ###### commands ######
       desc "commands", "Lists all available commands", :hide => true
@@ -29,6 +30,9 @@ module FalkorLib
       #......................................
       desc "repo", "Create a root Makefile piloting repository operations"
       def repo(dir = Dir.pwd)
+        # TODO: find a generic way to handle help in subcommands
+        # -- see https://github.com/erikhuda/thor/issues/532
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.makefile(dir, options)
       end # repo
 
@@ -36,18 +40,28 @@ module FalkorLib
       ###### latex ######
       desc "latex", "Symlink to a Makefile to compile LaTeX documents"
       def latex(dir = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
          FalkorLib::Bootstrap::Link.makefile(dir, :latex => true)
       end # latex
 
+      ###### src ######
+      desc "src", "Symlink to a Makefile to recursively compile anything under src/"
+      def src(dir = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
+         FalkorLib::Bootstrap::Link.makefile(dir, :src => true)
+      end # latex_src
+
       ##### gnuplot #####
       desc "gnuplot", "Symlink to a Makefile to compile GnuPlot scripts"
       def gnuplot(dir = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
          FalkorLib::Bootstrap::Link.makefile(dir, :gnuplot => true)
       end # gnuplot
 
       ##### generic #####
       desc "generic", "Symlink to Generic Makefile for sub directory"
       def generic(dir = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap::Link.makefile(dir, :generic => true)
       end # generic
 

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Wed 2018-11-21 11:45 svarrette>
+# Time-stamp: <Mon 2020-04-20 17:12 svarrette>
 ################################################################################
 
 require 'thor'
@@ -15,18 +15,21 @@ module FalkorLib
 
       package_name "Falkor[Lib] 'new'"
       namespace :new
+      map %w[--help -h] => :help
 
       def self.banner(task, _namespace = true, subcommand = false)
         "#{basename} #{task.formatted_usage(self, true, subcommand)}"
       end
 
+      class_option :help, :aliases => ['-h', '--help'], type: :boolean
+
       ###### commands ######
       desc "commands", "Lists all available commands", :hide => true
       def commands
         puts New.all_commands.keys.sort - [ 'commands' ]
       end
 
-      #map %w[--help -h] => :help
+      map %w[--help -h] => :help
 
       ###### repo ######
       desc "repo NAME [options]", "Bootstrap a Git Repository"
@@ -56,12 +59,17 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
       method_option :mkdocs, :type => :boolean, :desc => "Initiate Mk Docs within your project"
       method_option :license,     :default => 'none',    :desc => "Open Source License to use within your project"
       method_option :licensefile, :default => 'LICENSE', :desc => "LICENSE File name"
-
-
-      #method_option :pyenv, :type => :boolean, :desc => "Initiate a pyenv-based Python project"
+      method_option :pyenv, :type => :boolean, :desc => "Initiate a pyenv-based Python project"
+      method_option :python, :banner => 'VERSION', :aliases => [ '--pyenv', '-p' ],
+                    :desc => 'Python version to configure / install for pyenv'
+      method_option :virtualenv, :aliases => [ '--env', '-e' ],
+                    :desc => 'Python virtualenv name to configure for this directory'
       #method_option :octopress, :aliases => ['-o', '--www'], :type => :boolean, :desc => "Initiate an Octopress web site"
       #___________________
       def repo(name = '.')
+        # TODO: find a generic way to handle help in subcommands
+        # -- see https://github.com/erikhuda/thor/issues/532
+        (help(__method__) and exit 0) if options[:help]
         options[:rvm] = true if options[:rake] || options[:gem]
         # _newrepo(name, options)
         FalkorLib::Bootstrap.repo(name, options)
@@ -77,6 +85,7 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
       desc "article [options]", "Bootstrap a LaTeX Article"
       #___________________
       def article(path = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.latex(path, :article, options)
       end # article
 
@@ -88,6 +97,7 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
       desc "letter [options]", "LaTeX-based letter"
       #___________________
       def letter(path = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.latex(path, :letter, options)
       end # letter
 
@@ -97,6 +107,7 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
       #......................................
       desc "license [options]", "Generate an Open-Source License for your project"
       def license(path = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         license = options[:license] ?  options[:license] : FalkorLib::Bootstrap.select_licence('none')
         FalkorLib::Bootstrap.license(path, license, '', options)
       end # license
@@ -117,6 +128,7 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
       #......................................
       desc "make [options]", "Initiate one of Falkor's Makefile"
       def make(dir = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         if options[:repo]
           FalkorLib::Bootstrap.makefile(dir)
         elsif (options[:latex] or options[:gnuplot] or options[:generic] or options[:images] or options[:src])
@@ -156,6 +168,7 @@ PYENV_LONG_DESC
                     :default => true, :desc => 'Force overwritting the  pyenv/direnv config'
       #____________________
       def pyenv(path = '.')
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.pyenv(path, options)
       end # pyenv
 
@@ -167,6 +180,7 @@ PYENV_LONG_DESC
       #method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
       #___________________
       def slides(path = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.latex(path, :beamer, options)
       end # slides
 
@@ -174,6 +188,7 @@ PYENV_LONG_DESC
       desc "trash PATH", "Add a Trash directory"
       #________________________
       def trash(path = Dir.pwd)
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.trash(path)
       end # trash
 
@@ -198,6 +213,7 @@ RVM_LONG_DESC
                     :default => FalkorLib.config[:rvm][:gemsetfile], :desc => 'RVM gemset file'
       #____________________
       def rvm(path = '.')
+        (help(__method__) and exit 0) if options[:help]
         FalkorLib::Bootstrap.rvm(path, options)
       end # rvm
 
@@ -228,6 +244,7 @@ RVM_LONG_DESC
       #......................................
       desc "readme PATH [options]", "Initiate a README file in the PATH directory ('./' by default)"
       def readme(path = '.')
+        (help(__method__) and exit 0) if options[:help]  # pas boooooo
         FalkorLib::Bootstrap.readme(path, options)
       end # readme
 

data/lib/falkorlib/tasks/rspec.rake

@@ -52,13 +52,33 @@ begin
       namespace :suite do
         specsuite.each do |name, _files|
           ###########   #{name}   ###########
-          desc "Run all specs in #{name} spec suite"
-          RSpec::Core::RakeTask.new(name.to_sym) do |t|
-            t.pattern = "spec/**/#{name}_*spec.rb"
-            #t.pattern = "spec/**/git_*spec.rb"
-            t.verbose = false
-            t.rspec_opts = rspec_opts
-          end # task #{name}
+          if _files.count == 1
+            desc "Run all specs in #{name} spec suite"
+            RSpec::Core::RakeTask.new(name.to_sym) do |t|
+              t.pattern = "spec/**/#{name}_*spec.rb"
+              #t.pattern = "spec/**/git_*spec.rb"
+              t.verbose = false
+              t.rspec_opts = rspec_opts
+            end # task #{name}
+          else
+            namespace "#{name.to_sym}" do
+              desc "Run all specs in #{name} spec suite"
+              RSpec::Core::RakeTask.new(:all) do |t|
+                t.pattern = "spec/**/#{name}_*spec.rb"
+                t.verbose = false
+                t.rspec_opts = rspec_opts
+              end # task rspec:suite:#{name}:all
+              _files.map { |f| File.basename(f, '_spec.rb').gsub("#{name}_", '') }.each do |subname|
+                next if subname == name
+                desc "Run the '#{subname}' specs in the #{name} spec suite"
+                RSpec::Core::RakeTask.new(subname.to_sym) do |t|
+                  t.pattern = "spec/**/#{name}_#{subname}*spec.rb"
+                  t.verbose = false
+                  t.rspec_opts = rspec_opts
+                end # task rspec:suite:#{name}:#{subname}
+              end
+            end # namespace #{name}
+          end # id
         end
       end # namespace suite
     end # namespace rspec
@@ -121,8 +141,8 @@ namespace :setenv do
   #desc "Set Code Climate token to report rspec results"
   task :code_climate do |_t|
     unless FalkorLib.config[:tokens].nil? ||
-           FalkorLib.config[:tokens][:code_climate].nil? ||
-           FalkorLib.config[:tokens][:code_climate].empty?
+        FalkorLib.config[:tokens][:code_climate].nil? ||
+        FalkorLib.config[:tokens][:code_climate].empty?
       ans = ask(cyan("A Code Climate token is set - Do you want to report on Code Climate the result of the process? (y|N)"), 'No')
       ENV['CODECLIMATE_REPO_TOKEN'] = FalkorLib.config[:tokens][:code_climate] if ans =~ /y.*/i
     end

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, 5
+    MAJOR, MINOR, PATCH = 0, 8, 6
 
     module_function
 

data/spec/falkorlib/bootstrap_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Fri 2018-11-09 09:43 svarrette>
+# Time-stamp: <Mon 2020-04-20 09:58 svarrette>
 #
 # @description Check the basic Bootstrapping operations
 #
@@ -135,6 +135,31 @@ describe FalkorLib::Bootstrap do
         end
       end
 
+      it "#readme rvm/mkdocs/pyenv" do
+        readme = File.join(dir, 'README.md')
+        #Array.new(6).each { |e|  STDIN.should_receive(:gets).and_return('') }
+        #STDIN.should_receive(:gets).and_return('')
+        #STDIN.should_receive(:gets).and_return('1')
+        FalkorLib::Bootstrap.readme(dir,
+                                    {
+                                      :no_interaction => true,
+                                      :rvm            => true,
+                                      :mkdocs         => true,
+                                      :pyenv          => true
+                                    })
+        expect(File).to exist( readme )
+        File.read(File.realpath( readme )) do |f|
+          [
+            "## Ruby stuff",          # from readme_rvm.erb
+            "## Documentation",       # from readme_mkdocs.erb
+            "## Python Virtualenv",   # from readme_pyenv.erb
+          ].each do |pattern|
+            f.should include "#{pattern}"
+          end
+        end
+      end
+
+
       ### LICENSE file generation
       it "#license -- don't generate LICENSE by default" do
         license = File.join(dir, 'LICENSE')

data/spec/falkorlib/bootstrap_vagrant_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_vagrant_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Sun 2020-04-12 16:46 svarrette>
+# Time-stamp: <Mon 2020-04-20 10:10 svarrette>
 #
 # @description Check the Bootstrapping operations for Vagrant
 #
@@ -58,24 +58,24 @@ describe FalkorLib::Bootstrap do
       it "#vagrant -- #{ctx}" do
         c = FalkorLib::Bootstrap.vagrant(dir)
         expect(c).to eq(0)
-        confdir = File.join(dir, 'vagrant')
         conffile = File.join(dir, 'Vagrantfile')
-        expect(File.directory?(confdir)).to be true
         expect(File.exists?(conffile)).to be true
-        bootstrap = File.join(confdir, 'bootstrap.sh')
+        confdir      = File.join(dir, 'vagrant')
+        puppetdir    = File.join(confdir, 'puppet')
+        scriptsdir   = File.join(confdir, 'scripts')
+        [ confdir, puppetdir, scriptsdir ].each do |d|
+          expect(File.directory?(d)).to be true
+        end
+        bootstrap = File.join(scriptsdir, 'bootstrap.sh')
         expect(File.exists?(bootstrap)).to be true
-
-        # File.read(File.realpath(conffile)) do |f|
-        #   [
-        #     "site_name: #{File.basename(dir)}",
-        #     "nav:"
-        #   ].each do |pattern|
-        #     f.should include "#{pattern}"
-        #   end
-        # end
+        hiera_config = File.join(puppetdir, 'hiera.yaml')
+        expect(File.exists?(hiera_config)).to be true
+        [ 'hieradata', 'manifests', 'modules', 'site/profiles' ].each do |d|
+          expect(File.directory?(File.join(puppetdir, d))).to be true
+        end
       end
 
-    end # context "bootstrap/mkdocs"
+    end # context "bootstrap/vagrant"
   end # each
 
 end

data/templates/README/header_readme.erb

@@ -1,18 +1,11 @@
--*- mode: markdown; mode: visual-line; fill-column: 80 -*-
-
 <% unless (config[:license].empty? or config[:license] == "none") %>
 [![Licence](<%= FalkorLib::Bootstrap::get_badge("license", config[:license], 'blue') %>)](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:url] %>)
 <% end %>
 ![By <%= config[:by] %>](https://img.shields.io/badge/by-<%= config[:by] %>-blue.svg) [![<%= config[:forge] %>](https://img.shields.io/badge/git-<%= config[:forge] %>-lightgray.svg)](<%= config[:source] %>) [![Issues](https://img.shields.io/badge/issues-<%= config[:forge] %>-green.svg)](<%= config[:issues_url] %>)
 
-       Time-stamp: <Tue 2017-04-04 12:01 svarrette>
-
        <%= ::Artii::Base.new().asciify( config[:name] ).split("\n").join("\n       ") %>
        Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
 
-
-## Synopsis
-
 <%= config[:description] %>
 
 
@@ -26,9 +19,11 @@ This repository is hosted on [<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge]
 <% end %>
 * To clone this repository, proceed as follows (adapt accordingly):
 
-        $> mkdir -p ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
-        $> cd ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
-        $> git clone <%= config[:origin] %>
+```bash
+$> mkdir -p ~/<%= config[:rootdir].gsub(ENV['HOME'] + '/', '').gsub(File.basename(config[:rootdir]), '') %>
+$> cd ~/<%= config[:rootdir].gsub(ENV['HOME'] + '/', '').gsub(File.basename(config[:rootdir]), '') %>
+$> git clone <%= config[:origin] %>
+```
 
 <% end %>
 <% if config[:type].include?( :rvm ) %>
@@ -45,27 +40,29 @@ Configure the dependencies detailed in the [`Gemfile`](Gemfile) through the [Bun
 
 **`/!\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running:
 
-    $> cd <%= name.downcase %>
+```bash
+$> cd <%= name.downcase %>
 <% if options[:make] %>
-    $> make setup
+$> make setup
 <% else %>
-    $> rake setup
+$> rake setup
 <% end %>
+```
 
-This will initiate the [Git submodules of this repository](.gitmodules) and setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository.
-
-Later on, you can upgrade the [Git submodules](.gitmodules) to the latest version by running:
+This will initiate the [Git submodules of this repository](.gitmodules) and setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository. Later on, you can update your local branches by running:
 
 <% if options[:make] %>
-    $> make upgrade
+     $> make up
 <% else %>
-    $> rake git:submodules:upgrade
+     $> rake up
 <% end %>
 
-If upon pulling the repository, you end in a state where another collaborator have upgraded the Git submodules for this repository, you'll end in a dirty state (as reported by modifications within the `.submodules/` directory). In that case, just after the pull, you **have to run** the following to ensure consistency with regards the Git submodules:
+If upon pulling the repository, you end in a state where another collaborator have upgraded the Git submodules for this repository, you'll end in a dirty state (as reported by modifications within the `.submodules/` directory). In that case, just after the pull, you **have to run** `make up` to ensure consistency with regards the Git submodules:
+
+Finally, you can upgrade the [Git submodules](.gitmodules) to the latest version by running:
 
 <% if options[:make] %>
-    $> make update
+    $> make upgrade
 <% else %>
-    $> rake git:submodules:update
+    $> rake git:submodules:upgrade
 <% end %>

data/templates/README/readme_pyenv.erb

@@ -0,0 +1,44 @@
+## Python Virtualenv / Pyenv and Direnv
+
+You will have to ensure you have installed [direnv](https://direnv.net/) (configured by [`.envrc`](.envrc)), [pyenv](https://github.com/pyenv/pyenv) and [`pyenv-virtualenv`](https://github.com/pyenv/pyenv-virtualenv). This assumes also the presence of `~/.config/direnv/direnvrc` from [this page](https://github.com/Falkor/dotfiles/blob/master/direnv/direnvrc) - for more details, see [this blog post](https://varrette.gforge.uni.lu/blog/2019/09/10/using-pyenv-virtualenv-direnv/).
+
+You can run the following command to setup your local machine in a compliant way:
+
+```
+make setup-pyenv   # AND/OR 'make setup-direnv'
+```
+
+Running `direnv allow` (this will have to be done only once), you should automatically enable the virtualenv `<%= name.downcase %>` based on the python version specified in [`.python-version`](.python-version). You'll eventually need to install the appropripriate Python version with `pyenv`:
+
+```bash
+pyenv versions   # Plural: show all versions
+pyenv install $(head .python-version)
+# Activate the virtualenv by reentering into the directory
+cd ..
+cd -
+```
+
+From that point, you should install the required packages using:
+
+    pip install -r requirements.txt
+
+Alternatively, you can use `make setup-python`
+
+## Python Code Development
+
+The Python code for `<%= name.downcase %>` is developed as a Python package, i.e. following the [official guidelines](https://packaging.python.org/overview/).
+
+To play in live with the code while developing it, install it in "_editable_" mode by running:
+
+    pip install -e ./
+
+In practice:
+
+    cd src
+    make
+
+Later on, you can clean the directory using
+
+    make clean
+
+Now you can enjoy live runs.