falkorlib 0.6.19 → 0.7.0

data/lib/falkorlib/bootstrap/git.rb

@@ -0,0 +1,137 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Fri 2016-11-11 15:05 svarrette>
+################################################################################
+# Interface for the main Bootstrapping operations
+#
+
+require "falkorlib"
+require "falkorlib/common"
+require "falkorlib/bootstrap"
+
+require 'erb' # required for module generation
+require 'artii'
+require 'facter'
+
+include FalkorLib::Common
+
+
+module FalkorLib
+  module Bootstrap #:nodoc:
+
+    module_function
+
+    ###### repo ######
+    # Initialize a Git repository for a project with my favorite layout
+    # Supported options:
+    # * :no_interaction [boolean]: do not interact
+    # * :gitflow     [boolean]: bootstrap with git-flow
+    # * :interactive [boolean] Confirm Gitflow branch names
+    # * :master      [string]  Branch name for production releases
+    # * :develop     [string]  Branch name for development commits
+    # * :make        [boolean] Use a Makefile to pilot the repository actions
+    # * :rake        [boolean] Use a Rakefile (and FalkorLib) to pilot the repository action
+    # * :remote_sync [boolean] Operate a git remote synchronization
+    # * :latex       [boolean] Initiate a LaTeX project
+    # * :gem         [boolean] Initiate a Ruby gem project
+    # * :rvm         [boolean] Initiate a RVM-based Ruby project
+    # * :pyenv       [boolean] Initiate a pyenv-based Python project
+    # * :octopress   [boolean] Initiate an Octopress web site
+    ##
+    def repo(name, options = {})
+      ap options if options[:debug]
+      path    = normalized_path(name)
+      project = File.basename(path)
+      use_git = FalkorLib::Git.init?(path)
+      if options[:rake]
+        options[:make] = false
+        options[:rvm]  = true
+      end
+      info "Bootstrap a [Git] repository for the project '#{project}'"
+      if use_git
+        warning "Git is already initialized for the repository '#{name}'"
+        really_continue? unless options[:force]
+      end
+      if options[:git_flow]
+        info " ==> initialize Git flow in #{path}"
+        FalkorLib::GitFlow.init(path, options)
+        gitflow_branches = {}
+        [ :master, :develop ].each do |t|
+          gitflow_branches[t.to_sym] = FalkorLib::GitFlow.branches(t, path)
+        end
+      else
+        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'
+        }
+      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
+      if options[:rake]
+        info " ==> prepare Root Rakefile"
+        rakefile = File.join(path, "Rakefile")
+        unless File.exist?( rakefile )
+          templatedir = File.join( FalkorLib.templates, 'Rakefile')
+          erbfiles = [ 'header_rakefile.erb' ]
+          erbfiles << 'rakefile_gitflow.erb' if FalkorLib::GitFlow.init?(path)
+          erbfiles << 'footer_rakefile.erb'
+          write_from_erb_template(erbfiles, rakefile, {}, :srcdir => templatedir.to_s)
+        end
+      end
+
+      # === VERSION file ===
+      FalkorLib::Bootstrap.versionfile(path, :tag => 'v0.0.0')
+
+      # === RVM ====
+      FalkorLib::Bootstrap.rvm(path, options) if options[:rvm]
+
+      # === README ===
+      FalkorLib::Bootstrap.readme(path, options)
+
+      #===== remote synchro ========
+      if options[:remote_sync]
+        remotes = FalkorLib::Git.remotes(path)
+        if remotes.include?( 'origin' )
+          info "perform remote synchronization"
+          [ :master, :develop ].each do |t|
+            FalkorLib::Git.publish(gitflow_branches[t.to_sym], path, 'origin')
+          end
+        else
+          warning "no Git remote  'origin' found, thus no remote synchronization performed"
+        end
+      end
+    end # repo
+
+
+
+  end # module Bootstrap
+end # module FalkorLib

data/lib/falkorlib/bootstrap/latex.rb

@@ -0,0 +1,186 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Sat 2016-11-12 12:18 svarrette>
+################################################################################
+# Interface for the main Bootstrapping operations
+#
+
+require "falkorlib"
+require "falkorlib/common"
+require "falkorlib/bootstrap"
+
+require 'erb' # required for module generation
+require 'artii'
+require 'facter'
+
+include FalkorLib::Common
+
+
+module FalkorLib
+  module Bootstrap #:nodoc:
+
+    module_function
+
+    ###### latex ######
+    # Bootstrap a LaTeX sub-project of type <type> within a given repository <dir>.
+    #  * :beamer    LaTeX Beamer Slides
+    #  * :article   LaTeX article
+    #  * :ieee      LaTeX IEEE conference article
+    #  * :ieee_jnl  LaTeX IEEE journal
+    #  * :acm       LaTeX ACM conference article
+    #  * :letter    LaTeX Letter
+    # Supported options:
+    #  * :force [boolean] force action
+    #  * :no_interaction [boolean]: do not interact
+    ##
+    def latex(dir = Dir.pwd, type = :beamer, options = {})
+      ap options if options[:debug]
+      error "Unsupported type" unless [ :beamer, :article, :ieee, :letter ].include?( type )
+      path   = normalized_path(dir)
+      config = FalkorLib::Config::Bootstrap::DEFAULTS[:latex].clone
+      if type == :letter
+        config.merge!(FalkorLib::Config::Bootstrap::DEFAULTS[:letter].clone)
+        [ :title, :subtitle, :image ].each { |k| config.delete k }
+      end
+      config.deep_merge!(FalkorLib::Config::Bootstrap::DEFAULTS[:letter].clone) if type == :letter
+      # initiate the repository if needed
+      unless File.directory?( path )
+        warn "The directory '#{path}' does not exists and will be created"
+        really_continue? unless options[:no_interaction]
+        run %( mkdir -p #{path} )
+      end
+      repo(path, options) unless FalkorLib::Git.init?(path)
+      rootdir = FalkorLib::Git.rootdir(path)
+      info "Initiate a LaTeX #{type} project from the Git root directory: '#{rootdir}'"
+      really_continue? unless options[:no_interaction]
+      relative_path_to_root = (Pathname.new( FalkorLib::Git.rootdir(dir) ).relative_path_from Pathname.new( File.realpath(path))).to_s
+      config[:name] = (options[:name]) ? options[:name] : ask("\tEnter the name of the #{type} LaTeX project: ", File.basename(path))
+      raise FalkorLib::ExecError "Empty project name" if config[:name].empty?
+      default_project_dir = (Pathname.new( File.realpath(path) ).relative_path_from Pathname.new( FalkorLib::Git.rootdir(dir))).to_s
+      if relative_path_to_root == '.'
+        default_project_dir = case type
+                              when :article, :ieee
+                                "articles/#{Time.now.year}/#{config[:name]}"
+                              when :beamer
+                                "slides/#{Time.now.year}/#{config[:name]}"
+                              when :bookchapter
+                                "chapters/#{config[:name]}"
+                              when :letter
+                                "letters/#{Time.now.year}/#{config[:name]}"
+                              else
+                                (config[:name]).to_s
+                              end
+      else
+        default_project_dir += "/#{config[:name]}" unless default_project_dir =~ /#{config[:name]}$/
+      end
+      project_dir = (options[:dir]) ? options[:dir] : default_project_dir
+      project_dir = ask("\tLaTeX Sources directory (relative to the Git root directory)", project_dir.to_s) unless options[:no_interaction]
+      raise FalkorLib::ExecError "Empty project directory" if project_dir.empty?
+      src_project_dir = File.join(project_dir, 'src')
+      srcdir = File.join(rootdir, src_project_dir)
+      if File.exist?(File.join(srcdir, '.root'))
+        warn "The directory '#{project_dir}' seems to have been already initialized"
+        really_continue? unless options[:no_interaction]
+      end
+      FalkorLib::GitFlow.start('feature', config[:name], rootdir) if FalkorLib::GitFlow.init?(rootdir)
+      # === prepare Git submodules ===
+      info " ==> prepare the relevant Git submodules"
+      submodules = {}
+      if [ :article, :beamer, :bookchapter].include?(type)
+        submodules['Makefiles'] = { :url => 'https://github.com/Falkor/Makefiles.git',
+                                    :branch => 'devel' }
+      end
+      submodules['beamerthemeFalkor'] = { :url => 'https://github.com/Falkor/beamerthemeFalkor' } if type == :beamer
+      FalkorLib::Git.submodule_init(rootdir, submodules)
+      info "bootstrapping the #{type} project sources in '#{src_project_dir}'"
+      # Create the project directory
+      Dir.chdir( rootdir ) do
+        run %( mkdir -p #{src_project_dir}/images ) unless File.directory?("#{srcdir}/images")
+      end
+      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|
+        Dir.chdir( srcdir ) do
+          dst = ".makefile.d/latex/#{f}"
+          run %( ln -s #{dst} #{f} ) unless File.exist?( File.join(srcdir, f) )
+        end
+      end
+      if type == :beamer
+        f = 'beamerthemeFalkor.sty'
+        dst = "#{FalkorLib.config[:git][:submodulesdir]}/beamerthemeFalkor/#{f}"
+        Dir.chdir( srcdir ) do
+          run %( ln -s .root/#{dst} #{f} ) unless File.exist?( File.join(srcdir, f) )
+        end
+      end
+
+      # Bootstrap the directory
+      src_templatedir = File.join( FalkorLib.templates, 'latex')
+      unless File.exist?( File.join(srcdir, "#{config[:name]}.tex"))
+        info "gathering information for the LaTeX templates"
+        prefix = case type
+                 when :article, :ieee, :acm
+                   'Article '
+                 when :ieee_journal
+                   'IEEE Journal '
+                 when :beamer
+                   'Slides '
+                 when :bookchapter
+                   'Book Chapter '
+                 when :letter
+                   'Letter '
+                 else
+                   ''
+                 end
+        config.each do |k, v|
+          next if k == :name
+          config[k.to_sym] = ask( "\t" + Kernel.format("%-20s", "#{prefix}#{k.capitalize}"), v) unless options[:no_interaction]
+        end
+        templates = [ File.join(src_templatedir, type.to_s) ]
+        if [ :ieee, :ieee_journal, :acm].include?( type )
+          templates << File.join(src_templatedir, 'article')
+          templates << File.join(src_templatedir, "article-#{type}")
+        end
+        if type == :article
+          templates << File.join(src_templatedir, 'ieee')
+          templates << File.join(src_templatedir, 'article-ieee')
+        end
+        templates.each do |templatedir|
+          info "**** using templatedir = #{templatedir}"
+          init_from_template(templatedir, srcdir, config, :no_interaction => true,
+                             :no_commit => true)
+        end
+        # Rename the main file
+        Dir.chdir( srcdir ) do
+          run %( mv main.tex #{config[:name]}.tex )
+        end
+      end
+      # Create the trash directory
+      trash(srcdir)
+
+      # populate the images/ directory
+      baseimages = File.join( FalkorLib.templates, 'latex', 'images')
+      #images_makefile_src = "#{FalkorLib.config[:git][:submodulesdir]}/Makefiles/generic/Makefile.insrcdir"
+      images = File.join(srcdir, 'images')
+      info "populating the image directory"
+      Dir.chdir( images ) do
+        run %( rsync -avzu #{baseimages}/ . )
+        run %( ln -s ../.root .root ) unless File.exist?(File.join(images, '.root'))
+        #run %{ ln -s .root/#{images_makefile_src} Makefile } unless File.exists?(File.join(images, 'Makefile'))
+      end
+      FalkorLib::Bootstrap::Link.makefile(images, :images => true, :no_interaction => true )
+
+      # Prepare the src/ directory
+      FalkorLib::Bootstrap::Link.makefile(File.join(rootdir, project_dir), :src => true, :no_interaction => true )
+
+
+      # default_project_dir = case type
+      #               when :beamer
+      #                   "slides/#{Time.new.yea}"
+      #               end
+    end # project
+
+
+
+  end # module Bootstrap
+end # module FalkorLib

data/lib/falkorlib/bootstrap/link.rb

@@ -1,12 +1,14 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sat 2016-10-15 22:55 svarrette>
+# Time-stamp: <Sun 2016-11-13 06:44 svarrette>
 ################################################################################
 # Interface for Bootstrapping various symlinks within your project
 #
 require "falkorlib"
 require "falkorlib/common"
-require 'erb'      # required for module generation
+require "falkorlib/bootstrap"
+
+require 'erb' # required for module generation
 require 'artii'
 require 'facter'
 
@@ -14,103 +16,113 @@ include FalkorLib::Common
 
 
 module FalkorLib
-    module Bootstrap
-        module Link
+  module Bootstrap
+    # Hold [sim]link fonction creations
+    module Link
 
-            module_function
+      module_function
 
-            ###### makefile ######
-            # Create a symlink to the one of Falkor's Makefile, typically bring as a Git submodule
-            # Supported options:
-            #  * :force    [boolean] force action
-            #  * :latex    [boolean] Makefile to compile LaTeX documents
-            #  * :gnuplot  [boolean] Makefile to compile GnuPlot scripts
-            #  * :markdown [boolean] Makefile to convert Markdown files to HTML
-            #  * :refdir   [string]  Path to Falkor's Makefile repository
-            #  * :src      [boolean] Path to latex_src
-            #  * :no_interaction [boolean] do not interact
-            ##
-            def makefile(dir = Dir.pwd,
-                         options = {
-                           :no_interaction => false
-                         })
-                path   = normalized_path(dir)
-                rootdir = FalkorLib::Git.rootdir(path)
-                info "Create a symlink to one of Falkor's Makefile"
-                # Add Falkor's Makefiles
-                submodules = FalkorLib.config[:git][:submodules]
-                submodules['Makefiles'] = {
-                    :url   => 'https://github.com/Falkor/Makefiles.git',
-                    :branch => 'devel'
-                } if submodules['Makefiles'].nil?
-                FalkorLib::Git.submodule_init(rootdir, submodules)
-                FalkorLib::Bootstrap::Link.root(dir)
-                refdir = File.join(FalkorLib.config[:git][:submodulesdir], 'Makefiles')
-                refdir = options[:refdir] unless options[:refdir].nil?
-                dst        = File.join('.root', refdir)
-                makefile_d = '.makefile.d'
-                unless File.exists?(File.join(path, makefile_d))
-                    Dir.chdir( path ) do
-                        run %{ ln -s #{dst} #{makefile_d} }
-                        FalkorLib::Git.add(File.join(path, makefile_d), "Add symlink '#{makefile_d}' to Falkor's Makefile directory")
-                    end
-                end
-                #ap options
-                makefile = 'Makefile'
-                type     = 'latex'
-                # recall to place the default option (--latex) at the last position
-                [ :gnuplot, :images, :generic, :markdown] .each do |e|
-                    if options[e.to_sym]
-                        type = e.to_s
-                        break
-                    end
-                end
-                type = 'latex_src' if options[:src]
-                makefile = 'Makefile.insubdir' if options[:generic]
-                makefile = 'Makefile.to_html'  if options[:markdown]
-                dst = File.join(makefile_d, type, makefile)
-                unless File.exists?( File.join(path, 'Makefile'))
-                    info "Bootstrapping #{type.capitalize} Makefile (as symlink to Falkor's Makefile)"
-                    really_continue? unless options[:no_interaction]
-                    Dir.chdir( path ) do
-                        run %{ ln -s #{dst} Makefile }
-                    end
-                    #ap File.join(path, 'Makefile')
-                    FalkorLib::Git.add(File.join(path, 'Makefile'), "Add symlink to the #{type.capitalize} Makefile")
-                else
-                    puts "  ... Makefile already setup"
-                end
-            end # makefile_link
+      ###### makefile ######
+      # Create a symlink to the one of Falkor's Makefile, typically bring as a Git submodule
+      # Supported options:
+      #  * :force    [boolean] force action
+      #  * :latex    [boolean] Makefile to compile LaTeX documents
+      #  * :gnuplot  [boolean] Makefile to compile GnuPlot scripts
+      #  * :markdown [boolean] Makefile to convert Markdown files to HTML
+      #  * :refdir   [string]  Path to Falkor's Makefile repository
+      #  * :src      [boolean] Path to latex_src
+      #  * :no_interaction [boolean] do not interact
+      ##
+      def makefile(dir = Dir.pwd,
+                   options = {
+                     :no_interaction => false
+                   })
+        raise FalkorLib::ExecError "Not used in a Git repository" unless FalkorLib::Git.init?
+        exit_status = 0
+        path = normalized_path(dir)
+        rootdir = FalkorLib::Git.rootdir(path)
+        info "Create a symlink to one of Falkor's Makefile"
+        # Add Falkor's Makefiles
+        submodules = FalkorLib.config[:git][:submodules]
+        if submodules['Makefiles'].nil?
+          submodules['Makefiles'] = {
+            :url => 'https://github.com/Falkor/Makefiles.git',
+            :branch => 'devel'
+          }
+        end
+        FalkorLib::Git.submodule_init(rootdir, submodules)
+        FalkorLib::Bootstrap::Link.root(dir)
+        refdir = File.join(FalkorLib.config[:git][:submodulesdir], 'Makefiles')
+        refdir = options[:refdir] unless options[:refdir].nil?
+        dst        = File.join('.root', refdir)
+        makefile_d = '.makefile.d'
+        unless File.exist?(File.join(path, makefile_d))
+          Dir.chdir( path ) do
+            run %( ln -s #{dst} #{makefile_d} )
+            FalkorLib::Git.add(makefile_d, "Add symlink '#{makefile_d}' to Falkor's Makefile directory")
+          end
+        end
+        #ap options
+        makefile = 'Makefile'
+        type     = 'latex'
+        # recall to place the default option (--latex) at the last position
+        [ :gnuplot, :images, :generic, :markdown, :repo] .each do |e|
+          if options[e.to_sym]
+            type = e.to_s
+            break
+          end
+        end
+        type = 'latex_src' if options[:src]
+        makefile = 'Makefile.insubdir' if options[:generic]
+        makefile = 'Makefile.to_html'  if options[:markdown]
+        dst = File.join(makefile_d, type, makefile)
+        if File.exist?( File.join(path, 'Makefile'))
+          puts "  ... Makefile already setup"
+          exit_status = 1
+        else
+          info "Bootstrapping #{type.capitalize} Makefile (as symlink to Falkor's Makefile)"
+          really_continue? unless options[:no_interaction]
+          Dir.chdir( path ) do
+            exit_status = run %( ln -s #{dst} Makefile )
+            exit_status = FalkorLib::Git.add('Makefile', "Add symlink to the #{type.capitalize} Makefile")
+          end
+        end
+        exit_status.to_i
+      end # makefile_link
 
-            ###### rootlink ######
-            # Create a symlink '.root' targeting the relative path to the git root directory
-            # Supported options:
-            #  * :name [string] name of the symlink ('.root' by default)
-            ##
-            def root(dir = Dir.pwd, options = {})
-                raise FalkorLib::ExecError "Not used in a Git repository" unless FalkorLib::Git.init?
-                path  = normalized_path(dir)
-                relative_path_to_root = (Pathname.new( FalkorLib::Git.rootdir(dir) ).relative_path_from Pathname.new( File.realpath(path)))
-                if "#{relative_path_to_root}" == "."
-                    FalkorLib::Common.warning "Already at the root directory of the Git repository"
-                    FalkorLib::Common.really_continue? unless options[:no_interaction]
-                end
-                target = options[:name] ? options[:name] : '.root'
-                puts "Entering '#{relative_path_to_root}'"
-                unless File.exists?( File.join(path, target))
-                    warning "creating the symboling link '#{target}' which points to '#{relative_path_to_root}'" if options[:verbose]
-                    # Format: ln_s(old, new, options = {}) -- Creates a symbolic link new which points to old.
-                    #FileUtils.ln_s "#{relative_path_to_root}", "#{target}"
-                    Dir.chdir( path ) do
-                        run %{ ln -s #{relative_path_to_root} #{target} }
-                    end
-                    FalkorLib::Git.add(File.join(path, target), "Add symlink to the root directory as .root")
-                else
-                    puts "  ... the symbolic link '#{target}' already exists"
-                end
-            end # rootlink
+      ###### rootlink ######
+      # Create a symlink '.root' targeting the relative path to the git root directory
+      # Supported options:
+      #  * :name [string] name of the symlink ('.root' by default)
+      ##
+      def root(dir = Dir.pwd, options = {})
+        raise FalkorLib::ExecError "Not used in a Git repository" unless FalkorLib::Git.init?
+        exit_status = 0
+        path = normalized_path(dir)
+        relative_path_to_root = (Pathname.new( FalkorLib::Git.rootdir(dir) ).relative_path_from Pathname.new( File.realpath(path)))
+        if relative_path_to_root.to_s == "."
+          FalkorLib::Common.warning "Already at the root directory of the Git repository"
+          FalkorLib::Common.really_continue? unless options[:no_interaction]
+        end
+        target = (options[:name]) ? options[:name] : '.root'
+        puts "Entering '#{relative_path_to_root}'"
+        if File.exist?( File.join(path, target))
+          puts "  ... the symbolic link '#{target}' already exists"
+          exit_status = 1
+        else
+          warning "creating the symboling link '#{target}' which points to '#{relative_path_to_root}'" if options[:verbose]
+          # Format: ln_s(old, new, options = {}) -- Creates a symbolic link new which points to old.
+          #FileUtils.ln_s "#{relative_path_to_root}", "#{target}"
+          Dir.chdir( path ) do
+            exit_status = run %( ln -s #{relative_path_to_root} #{target} )
+          end
+          exit_status = FalkorLib::Git.add(File.join(path, target),
+                                           "Add symlink to the root directory as .root")
+        end
+        exit_status.to_i
+      end # rootlink
 
 
-        end # module Link
-    end # module Bootstrap
+    end # module Link
+  end # module Bootstrap
 end # module FalkorLib