falkorlib 0.7.16 → 0.7.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5357864bd82cefc2a1c4f104374275a3ab7094c9
-  data.tar.gz: 00a2932ff2fe26c8d60b36a6573b506e8f682016
+  metadata.gz: 603782c1cf39fcfe8dc3e2ce0a8163feb6f46ded
+  data.tar.gz: 5c4a70beeacca4445e86fac8768fd75bd354d6a2
 SHA512:
-  metadata.gz: 40c6b160ea3cea3ae23916c5273312805633134f4795f90c9d6c482dbde39836046196d1831e18a358e4d1bb4d37d7387fd17a470cae9138b2e873ad55fea65c
-  data.tar.gz: cef36b07f6538759a1973d1152b30349b393cb1da652ef785db092e254397098e676c2647d27b28680d563b8163664640b5055f8186625f77d83b7bace308936
+  metadata.gz: 4aa8e8563852b17a9d4dbf7e09bd430c3c18a3d0681df652ac2c4d03d412009364ea95259e4fb316a9f0ef0d321fa6f1e35d55395d1f51e66e022c9cebcc5e21
+  data.tar.gz: 15952d0e647dccf036b4d0db8b7829180ead265af2291535338d9de6f7c437b69dae1e15bc9e0bf4e6241dae7bc7475df6d9fcbe9562befc462b79f743cdc3bb

data/.travis.yml

@@ -23,6 +23,7 @@ addons:
     - unzip
     - git
     - git-flow
+    - git-crypt
   hosts:
     - travis.dev
 before_install:

data/Gemfile

@@ -8,7 +8,8 @@ end
 
 group :test do
   gem "simplecov", :require => false
-  gem "rubocop",   :require => false
+  gem "rubocop",   ">= 0.49.0", :require => false
+  gem "ffi",        ">= 1.9.24", :require => false
 end
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.7.16)
+    falkorlib (0.7.17)
       activesupport (~> 4.0)
       artii (>= 2.1)
       awesome_print (~> 1.2)
@@ -31,7 +31,7 @@ GEM
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
     artii (2.1.2)
-    ast (2.3.0)
+    ast (2.4.0)
     awesome_print (1.7.0)
     backports (3.6.8)
     codeclimate-test-reporter (0.3.0)
@@ -49,7 +49,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.10.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.14)
+    ffi (1.9.25)
     gh (0.14.0)
       addressable
       backports
@@ -61,6 +61,7 @@ GEM
     hashr (0.0.22)
     highline (1.7.8)
     i18n (0.7.0)
+    jaro_winkler (1.5.1)
     json (1.8.6)
     launchy (2.4.3)
       addressable (~> 2.3)
@@ -74,9 +75,10 @@ GEM
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
-    parser (2.3.1.4)
-      ast (~> 2.2)
-    powerpack (0.1.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -85,7 +87,7 @@ GEM
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
-    rainbow (2.1.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -100,13 +102,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.45.0)
-      parser (>= 2.3.1.1, < 3.0)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
+    ruby-progressbar (1.10.0)
     rubygems-tasks (0.2.4)
     safe_yaml (0.9.7)
     simplecov (0.8.2)
@@ -138,7 +142,7 @@ GEM
       ethon (>= 0.8.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unicode-display_width (1.1.1)
+    unicode-display_width (1.4.0)
     websocket (1.2.3)
     yard (0.9.12)
 
@@ -150,10 +154,11 @@ DEPENDENCIES
   bundler
   codeclimate-test-reporter (~> 0)
   falkorlib!
+  ffi (>= 1.9.24)
   pry
   rake
   rspec (~> 3.0)
-  rubocop
+  rubocop (>= 0.49.0)
   rubygems-tasks (~> 0.2)
   simplecov
   travis (~> 1.6)

data/lib/falkorlib/bootstrap/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Fri 2018-04-27 16:58 svarrette>
+# Time-stamp: <Thu 2018-11-08 17:47 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -22,6 +22,22 @@ module FalkorLib #:nodoc:
 
       DEFAULTS =
         {
+          :gitcrypt => {
+            :owner    => `git config user.signingKey`.chomp,
+            :subkeys  => [],
+            :hooksdir => 'config/hooks',
+            :hook     => 'pre-commit.git-crypt.sh',
+            :ulhpc    => [
+              #'Ox5D08BCDD4F156AD7',  # S. Varrette
+              '0x3F3242C5B34D98C2',   # V. Plugaru
+              '0x6429C2514EBC4737',   # S. Peter
+              '0x07FEA8BA69203C2D',   # C. Parisot
+              '0x37183CEF550DF40B',   # H. Cartiaux
+            ],
+            # :hooks    => {
+            #   :precommit => 'https://gist.github.com/848c82daa63710b6c132bb42029b30ef.git',
+            # },
+          },
           :motd => {
             :file     => 'motd',
             :hostname => `hostname -f`.chomp,
@@ -140,6 +156,55 @@ module FalkorLib
 
     module_function
 
+    ###### makefile ######
+    # Supported options:
+    # * :master  [string] git flow master/production branch
+    # * :develop [string] git flow development branch
+    # * :force   [boolean] for overwritting
+    #......................................
+    def makefile(dir = Dir.pwd, options = {})
+      path = normalized_path(dir)
+      path = FalkorLib::Git.rootdir(path) if FalkorLib::Git.init?(path)
+      info "=> Setup a root repository makefile in '#{dir}'"
+      # Preparing submodule
+      submodules = {}
+      submodules['Makefiles'] = {
+        :url    => 'https://github.com/Falkor/Makefiles.git',
+        :branch => 'devel'
+      }
+      FalkorLib::Git.submodule_init(path, submodules)
+      makefile = File.join(path, "Makefile")
+      if File.exist?( makefile )
+        puts "  ... not overwriting the root Makefile which already exists"
+      else
+        src_makefile = File.join(path, FalkorLib.config.git[:submodulesdir],
+                                 'Makefiles', 'repo', 'Makefile')
+        FileUtils.cp src_makefile, makefile
+        gitflow_branches = FalkorLib::Config::GitFlow::DEFAULTS[:branches]
+        if FalkorLib::GitFlow.init?(path)
+          [ :master, :develop ].each do |b|
+            gitflow_branches[t.to_sym] = FalkorLib::GitFlow.branches(b.to_sym)
+          end
+        end
+        unless options.nil?
+          [ :master, :develop ].each do |b|
+            gitflow_branches[b.to_sym] = options[b.to_sym] if options[b.to_sym]
+          end
+        end
+        info "adapting Makefile to the gitflow branches"
+        Dir.chdir( path ) do
+          run %(
+   sed -i '' \
+        -e \"s/^GITFLOW_BR_MASTER=production/GITFLOW_BR_MASTER=#{gitflow_branches[:master]}/\" \
+        -e \"s/^GITFLOW_BR_DEVELOP=devel/GITFLOW_BR_DEVELOP=#{gitflow_branches[:develop]}/\" \
+        Makefile
+                        )
+        end
+        FalkorLib::Git.add(makefile, 'Initialize root Makefile for the repo')
+      end
+    end # makefile
+
+
     ###
     # Initialize a trash directory in path
     ##

data/lib/falkorlib/bootstrap/git.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2017-01-16 14:16 svarrette>
+# Time-stamp: <Thu 2018-11-08 18:27 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -66,39 +66,14 @@ module FalkorLib
         FalkorLib::Git.init(path, options)
       end
       # === prepare Git submodules ===
-      info " ==> prepare the relevant Git submodules"
       submodules = {}
       #'gitstats' => { :url => 'https://github.com/hoxu/gitstats.git' }
-      #             }
-      if options[:make]
-        submodules['Makefiles'] = {
-          :url    => 'https://github.com/Falkor/Makefiles.git',
-          :branch => 'devel'
-        }
+      unless submodules.empty?
+        info " ==> prepare the relevant Git submodules"
+        FalkorLib::Git.submodule_init(path, submodules)
       end
-      FalkorLib::Git.submodule_init(path, submodules)
       # === Prepare root [M|R]akefile ===
-      if options[:make]
-        info " ==> prepare Root Makefile"
-        makefile = File.join(path, "Makefile")
-        if File.exist?( makefile )
-          puts "  ... not overwriting the root Makefile which already exists"
-        else
-          src_makefile = File.join(path, FalkorLib.config.git[:submodulesdir],
-                                   'Makefiles', 'repo', 'Makefile')
-          FileUtils.cp src_makefile, makefile
-          info "adapting Makefile to the gitflow branches"
-          Dir.chdir( path ) do
-            run %(
-   sed -i '' \
-        -e \"s/^GITFLOW_BR_MASTER=production/GITFLOW_BR_MASTER=#{gitflow_branches[:master]}/\" \
-        -e \"s/^GITFLOW_BR_DEVELOP=devel/GITFLOW_BR_DEVELOP=#{gitflow_branches[:develop]}/\" \
-        Makefile
-                        )
-          end
-          FalkorLib::Git.add(makefile, 'Initialize root Makefile for the repo')
-        end
-      end
+      FalkorLib::Bootstrap.makefile(path, gitflow_branches) if options[:make]
       if options[:rake]
         info " ==> prepare Root Rakefile"
         rakefile = File.join(path, "Rakefile")
@@ -147,7 +122,100 @@ module FalkorLib
       end
     end # repo
 
+    ###### gitcrypt ######
+    # Initialize git-crypt in the current directory
+    # Supported options:
+    #  * :force       [boolean] force overwritting
+    #  * :owner       [string]  owner (GPG ID or email)
+    #  * :keys        [array]   List of GPG IDs allowed to unlock the repository
+    #  * :ulhpc       [boolean] setup the repository for the ULHPC team
+    ##
+    def gitcrypt(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})
+        FalkorLib::Git.init(path)
+      end
+      error "Not a git-ready directory" unless FalkorLib::Git.init?(path)
+      rootdir = FalkorLib::Git.rootdir(path)
+      config =  FalkorLib::Config::Bootstrap::DEFAULTS[:gitcrypt].clone
+      info "about to initialize Git crypt for the repository '#{rootdir}'"
+      really_continue?
+      config[:owner] = (options[:owner]) ? options[:owner] :  ask("\tEmail or (better) GPG ID of the owner of the git-crypt (root) vault", config[:owner])
+      [ :hooksdir ].each do |k|
+        config[k] = (options[k]) ? options[k] : ask("\t#{k.capitalize}", config[k])
+      end
+      #puts config.to_yaml
+      if File.exists?(File.join(rootdir, '.git/git-crypt/keys/default'))
+        warning "git-crypt has already been initialised in '#{rootdir}'"
+      else
+        Dir.chdir( rootdir ) do
+          run %( git crypt init )
+          if config[:owner]
+            info "setup owner of the git-crypt vault to '#{config[:owner]}'"
+            run %( gpg --list-key  #{config[:owner]} | grep uid| head -n1)
+            run %( git crypt add-gpg-user #{config[:owner]} )
+          end
+        end
+      end
+      # Bootstrap the directory
+      gitattributes = File.join(rootdir, '.gitattributes')
+      if File.exists?(gitattributes)
+        puts "  ... '.gitattributes' file already exists"
+      else
+        templatedir = File.join( FalkorLib.templates, 'git-crypt')
+        init_from_template(templatedir, rootdir, {},
+                           :no_interaction => true,
+                           :no_commit => false)
+        FalkorLib::Git.add(gitattributes, 'Initialize .gitattributes for git-crypt')
+      end
+
+      git_hooksdir       = File.join(rootdir, '.git', 'hooks')
+      precommit_hook     = File.join(git_hooksdir, 'pre-commit')
+      src_git_hooksdir   = File.join(rootdir, config[:hooksdir])
+      src_precommit_hook = File.join(src_git_hooksdir, config[:hook])
+      if File.exists?(File.join(rootdir, config[:hook]))
+        Dir.chdir( rootdir ) do
+          run %(mkdir -p #{config[:hooksdir]} )
+          unless File.exists?(src_precommit_hook)
+            run %(mv #{config[:hook]} #{config[:hooksdir]}/ )
+            run %(chmod +x #{config[:hooksdir]}/#{config[:hook]})
+            FalkorLib::Git.add(src_precommit_hook, 'pre-commit hook for git-crypt')
+          end
+          run %(rm -f #{config[:hook]} ) if File.exists?(File.join(rootdir, config[:hook]))
+        end
+      end
+      # Pre-commit hook
+      unless File.exist?(precommit_hook)
+        info "=> bootstrapping special Git pre-commit hook for git-crypt"
+        relative_src_hooksdir = Pathname.new( File.realpath( src_git_hooksdir )).relative_path_from Pathname.new( git_hooksdir )
+        Dir.chdir( git_hooksdir ) do
+          run %(ln -s #{relative_src_hooksdir}/#{config[:hook]} pre-commit)
+        end
+      end
+      gpgkeys = []
+      gpgkeys = config[:ulhpc] if options[:ulhpc]
+      gpgkeys = options[:keys] if options[:keys]
+      unless gpgkeys.empty?
+        warning "About to allow the following GPG IDs to unlock the git-crypt vault"
+        puts gpgkeys.to_yaml
+        really_continue?
+      end
+      gpgkeys.each do |k|
+        Dir.chdir( rootdir ) do
+          info "allow GPG ID '#{k}' to unlock the git-crypt vault"
+          run %( gpg --list-key  #{k} | grep uid| head -n1)
+          run %( git crypt add-gpg-user #{k} )
+        end
+      end
+
+
+
 
+    end # gitcrypt
 
   end # module Bootstrap
 end # module FalkorLib

data/lib/falkorlib/cli.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Fri 2018-04-27 13:39 svarrette>
+# Time-stamp: <Thu 2018-11-08 17:28 svarrette>
 ################################################################################
 # Interface for the CLI
 #
@@ -14,6 +14,7 @@ require 'falkorlib'
 
 require 'falkorlib/cli/new'
 require 'falkorlib/cli/link'
+require 'falkorlib/cli/make'
 
 
 
@@ -67,6 +68,19 @@ CONFIG_LONG_DESC
 
       #map %w[--help -h] => :help
 
+      ###### gitcrypt ######
+      method_option :owner, :aliases => '-o',
+                    :desc => "Email or (better) GPG ID of the owner of the git-crypt (root) vault"
+      method_option :ulhpc, :aliases => '-u', :type => :boolean,
+                    :desc => "Bootstrap git-crypt for the UL HPC team"
+      method_option :keys, :type => :array, :aliases => [ '--gpgkeys', '-k' ],
+                    :desc => "(space separated) List of GPG IDs allowed to unlock the repository"
+      #......................................
+      desc "gitcrypt <PATH> [options]", "Initialize git-crypt for the current repository"
+      def gitcrypt(path = '.')
+        FalkorLib::Bootstrap.gitcrypt(path, options)
+      end # gitcrypt
+
       ###### init ######
       desc "init <PATH> [options]", "Bootstrap a Git Repository"
       long_desc <<-INIT_LONG_DESC

data/lib/falkorlib/cli/make.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Thu 2018-11-08 16:50 svarrette>
+################################################################################
+
+require 'thor'
+require 'falkorlib'
+#require 'falkorlib/cli/init/repo'
+#require "falkorlib/bootstrap"
+
+module FalkorLib
+  module CLI
+    # Thor class for symlink creation
+    class Make < ::Thor
+
+      include FalkorLib::Common
+
+      ###### commands ######
+      desc "commands", "Lists all available commands", :hide => true
+      def commands
+        puts Make.all_commands.keys.sort - [ 'commands' ]
+      end
+
+      ###### repo  ######
+      method_option :master, :aliases => ['--production', '-m', '-p'],
+                    :desc => 'Git flow master/production branch'
+      method_option :develop, :aliases => ['--devel', '-d'],
+                    :desc => 'Git flow development branch'
+      #......................................
+      desc "repo", "Create a root Makefile piloting repository operations"
+      def repo(dir = Dir.pwd)
+        FalkorLib::Bootstrap.makefile(dir, options)
+      end # repo
+
+
+      ###### latex ######
+      desc "latex", "Symlink to a Makefile to compile LaTeX documents"
+      def latex(dir = Dir.pwd)
+         FalkorLib::Bootstrap::Link.makefile(dir, :latex => true)
+      end # latex
+
+      ##### gnuplot #####
+      desc "gnuplot", "Symlink to a Makefile to compile GnuPlot scripts"
+      def gnuplot(dir = Dir.pwd)
+         FalkorLib::Bootstrap::Link.makefile(dir, :gnuplot => true)
+      end # gnuplot
+
+      ##### generic #####
+      desc "generic", "Symlink to Generic Makefile for sub directory"
+      def generic(dir = Dir.pwd)
+        FalkorLib::Bootstrap::Link.makefile(dir, :generic => true)
+      end # generic
+
+    end # class Make
+  end # module CLI
+end # module FalkorLib

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2017-01-16 23:52 svarrette>
+# Time-stamp: <Thu 2018-11-08 17:01 svarrette>
 ################################################################################
 
 require 'thor'
@@ -101,6 +101,31 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
         FalkorLib::Bootstrap.license(path, license, '', options)
       end # license
 
+      ##### make ######
+      method_option :repo, :type => :boolean, :aliases => '-r',
+                            :desc => "Create a root Makefile piloting repository operations"
+      method_option :latex, :type => :boolean, :aliases => '-l',
+                            :desc => "Makefile to compile LaTeX documents"
+      method_option :gnuplot, :type => :boolean, :aliases => ['--plot', '-p'],
+                              :desc => "Makefile to compile GnuPlot scripts"
+      method_option :generic, :type => :boolean, :aliases => '-g',
+                              :desc => "Generic Makefile for sub directory"
+      method_option :images, :type => :boolean, :aliases => [ '-i', '--img' ],
+                             :desc => "Makefile to optimize images"
+      method_option :src, :type => :boolean, :aliases => [ '--src', '-s' ],
+                          :desc => "Path to Falkor's Makefile for latex_src"
+      #......................................
+      desc "make [options]", "Initiate one of Falkor's Makefile"
+      def make(dir = Dir.pwd)
+        if options[:repo]
+          FalkorLib::Bootstrap.makefile(dir)
+        elsif (options[:latex] or options[:gnuplot] or options[:generic] or options[:images] or options[:src])
+          FalkorLib::Bootstrap::Link.makefile(dir, options)
+        else
+          FalkorLib::Common.error 'Kindly precize the type of Makefile you which to create'
+        end
+      end # make
+
 
       ###### slides ######
       #......................................

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, 7, 16
+    MAJOR, MINOR, PATCH = 0, 7, 17
 
     module_function
 

data/spec/falkorlib/bootstrap_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Mon 2017-01-16 11:30 svarrette>
+# Time-stamp: <Thu 2018-11-08 16:26 svarrette>
 #
 # @description Check the basic Bootstrapping operations
 #
@@ -37,7 +37,7 @@ describe FalkorLib::Bootstrap do
   end
 
   [ :without_git, :with_git ].each do |ctx|
-#  [ :with_git ].each do |ctx|
+  # [ :with_git ].each do |ctx|
     dir = dirs[ctx]
     #############################################################
     context "bootstrap/base (#{ctx}) within temporary directory '#{dir}'" do
@@ -49,8 +49,16 @@ describe FalkorLib::Bootstrap do
           t = FalkorLib::Git.init?(dir)
           expect(t).to be true
         end
+
+        #### root Makefile creation  #########
+        it "#makefile -- bootstrap root makefile" do
+          c = FalkorLib::Bootstrap.makefile(dir)
+          t = File.exists?( File.join(dir, 'Makefile'))
+        end
+
       end
 
+
       #### Trash creation  #########
       it "#trash" do
         c = FalkorLib::Bootstrap.trash(dir)
@@ -146,6 +154,36 @@ describe FalkorLib::Bootstrap do
         end
       end
 
+      if ctx == :without_git
+        it "#repo -- bootstrap a new repository" do
+          c = FalkorLib::Bootstrap.repo(dir, { :no_interaction => true, :make => true, :git_flow => false })
+          [ 'Makefile', 'VERSION', 'README.md' ].each do |f|
+            expect(File).to exist( File.join(dir, f))
+          end
+        end
+      end
+
+      if ctx == :with_git
+        it "#gitcrypt -- owner is empty" do
+          c = FalkorLib::Bootstrap.gitcrypt(dir, { :owner => '', :no_interaction => true })
+          [ '.git-crypt' ].each do |d|
+            expect(File.directory?(File.join(dir, d))).to be false
+          end
+          expect(File).to exist( File.join(dir, '.gitattributes'))
+          expect(File).to exist( File.join(dir, '.git', 'git-crypt', 'keys', 'default'))
+          expect(File).to exist( File.join(dir, FalkorLib::Config::Bootstrap::DEFAULTS[:gitcrypt][:hooksdir], FalkorLib::Config::Bootstrap::DEFAULTS[:gitcrypt][:hook]))
+          expect(File).to exist( File.join(dir, '.git','hooks','pre-commit'))
+        end
+        # it "#gitcrypt -- owner" do
+        #   c = FalkorLib::Bootstrap.gitcrypt(dir, { :no_interaction => true })
+        #   [ '.git-crypt' ].each do |d|
+        #     expect(File.directory?(File.join(dir, d))).to be true
+        #   end
+        #   #expect(File).to exist( File.join(dir, '.git-crypt', 'keys', 'default', '0', '*.gpg'))
+        #   # TODO check gpg file
+        # end
+      end
+
 
     end # context "bootstrap/base"
   end # each

data/templates/git-crypt/.gitattributes

@@ -0,0 +1,10 @@
+# -*- mode: conf -*-
+#
+# specify which files to encrypt using [git-crypt](https://www.agwa.name/projects/git-crypt/)
+#
+
+# Certificate private keys
+# *.key               filter=git-crypt diff=git-crypt
+# Private document/folders
+# *PRIVATE*           filter=git-crypt diff=git-crypt
+# subfolder/**/*      filter=git-crypt diff=git-crypt

data/templates/git-crypt/pre-commit.git-crypt.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+################################################################################
+# See <https://gist.github.com/Falkor/848c82daa63710b6c132bb42029b30ef>
+# Pre-commit hook to avoid accidentally adding unencrypted files with [git-crypt](https://www.agwa.name/projects/git-crypt/)
+# Fix to [Issue #45](https://github.com/AGWA/git-crypt/issues/45)
+#
+# Usage:
+#    $> cd /path/to/repository
+#    $> git-crypt init
+#    $> curl <url/to/this/raw/gist> -o .git/hooks/pre-commit
+#    $> chmod +x .git/hooks/pre-commit
+#
+# Otherwise, you might want to add it as a git submodule, using:
+#    $> git submodule add https://gist.github.com/848c82daa63710b6c132bb42029b30ef.git config/hooks/pre-commit.git-crypt
+#    $> cd .git/hooks
+#    $> ln -s ../../config/hooks/pre-commit.git-crypt/pre-commit.git-crypt.sh pre-commit
+#
+
+if [ -d .git-crypt ]; then
+    STAGED_FILES=$(git diff --cached --name-status | awk '$1 != "D" { print $2 }' | xargs echo)
+    if [ -n "${STAGED_FILES}" ]; then
+        git-crypt status ${STAGED_FILES} &>/dev/null
+        if [[ $? -ne 0  ]]; then
+            git-crypt status -e ${STAGED_FILES}
+            echo '/!\ You should have first unlocked your repository BEFORE staging the above file(s)'
+            echo '/!\ Proceed now as follows:'
+            echo -e "\t git unstage ${STAGED_FILES}"
+            echo -e "\t git crypt unlock"
+            echo -e "\t git add ${STAGED_FILES}"
+            exit 1
+        fi
+    fi
+fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.7.16
+  version: 0.7.17
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -422,6 +422,7 @@ files:
 - lib/falkorlib/cli.rb
 - lib/falkorlib/cli/config.rb
 - lib/falkorlib/cli/link.rb
+- lib/falkorlib/cli/make.rb
 - lib/falkorlib/cli/new.rb
 - lib/falkorlib/common.rb
 - lib/falkorlib/config.rb
@@ -484,6 +485,8 @@ files:
 - templates/gems/lib/sysadmin-warrior/loader.rb
 - templates/gems/lib/sysadmin-warrior/version.rb
 - templates/gems/sysadmin-warrior.gemspec
+- templates/git-crypt/.gitattributes
+- templates/git-crypt/pre-commit.git-crypt.sh
 - templates/latex/.gitignore
 - templates/latex/acm/ACM-Reference-Format.bst
 - templates/latex/acm/acmart.cls