falkorlib 0.6.19 → 0.7.0

data/lib/falkorlib/bootstrap/ruby.rb

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Sat 2016-11-12 02:32 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
+
+    ###### rvm ######
+    # Initialize RVM in the current directory
+    # Supported options:
+    #  * :force       [boolean] force overwritting
+    #  * :ruby        [string]  Ruby version to configure for RVM
+    #  * :versionfile [string]  Ruby Version file
+    #  * :gemset      [string]  RVM Gemset to configure
+    #  * :gemsetfile  [string]  RVM Gemset file
+    #  * :commit      [boolean] Commit the changes NOT YET USED
+    ##
+    def rvm(dir = Dir.pwd, options = {})
+      info "Initialize Ruby Version Manager (RVM)"
+      ap options if options[:debug]
+      path = normalized_path(dir)
+      use_git = FalkorLib::Git.init?(path)
+      rootdir = (use_git) ? FalkorLib::Git.rootdir(path) : path
+      files = {}
+      exit_status = 1
+      [:versionfile, :gemsetfile].each do |type|
+        f = (options[type.to_sym].nil?) ? FalkorLib.config[:rvm][type.to_sym] : options[type.to_sym]
+        if File.exist?( File.join( rootdir, f ))
+          content = `cat #{File.join( rootdir, f)}`.chomp
+          warning "The RVM file '#{f}' already exists (and contains '#{content}')"
+          next unless options[:force]
+          warning "... and it WILL BE overwritten"
+        end
+        files[type.to_sym] = f
+      end
+      # ==== Ruby version ===
+      unless files[:versionfile].nil?
+        file = File.join(rootdir, files[:versionfile])
+        v = FalkorLib.config[:rvm][:version]
+        if options[:ruby]
+          v = options[:ruby]
+        else
+          select_from(FalkorLib.config[:rvm][:rubies],
+                      "Select RVM ruby to configure for this directory",
+                      (FalkorLib.config[:rvm][:rubies].find_index(FalkorLib.config[:rvm][:version]) + 1))
+        end
+        info " ==>  configuring RVM version file '#{files[:versionfile]}' for ruby version '#{v}'"
+        File.open(file, 'w') do |f|
+          f.puts v
+        end
+        exit_status = (File.exist?(file) && (`cat #{file}`.chomp == v)) ? 0 : 1
+        FalkorLib::Git.add(File.join(rootdir, files[:versionfile])) if use_git
+      end
+      # === Gemset ===
+      if files[:gemsetfile]
+        file = File.join(rootdir, files[:gemsetfile])
+        default_gemset = File.basename(rootdir)
+        default_gemset = `cat #{file}`.chomp if File.exist?( file )
+        g = (options[:gemset]) ? options[:gemset] : ask("Enter RVM gemset name for this directory", default_gemset)
+        info " ==>  configuring RVM gemset file '#{files[:gemsetfile]}' with content '#{g}'"
+        File.open( File.join(rootdir, files[:gemsetfile]), 'w') do |f|
+          f.puts g
+        end
+        exit_status = (File.exist?(file) && (`cat #{file}`.chomp == g)) ? 0 : 1
+        FalkorLib::Git.add(File.join(rootdir, files[:gemsetfile])) if use_git
+      end
+      # ==== Gemfile ===
+      gemfile = File.join(rootdir, 'Gemfile')
+      unless File.exist?( gemfile )
+        # Dir.chdir(rootdir) do
+        #     run %{ bundle init }
+        # end
+        info " ==>  configuring Gemfile with Falkorlib"
+        File.open( gemfile, 'a') do |f|
+          f.puts "source 'https://rubygems.org'"
+          f.puts ""
+          f.puts "gem 'falkorlib' #, :path => '~/git/github.com/Falkor/falkorlib'"
+        end
+        FalkorLib::Git.add(gemfile) if use_git
+      end
+      exit_status.to_i
+    end # rvm
+
+  end # module Bootstrap
+end # module FalkorLib

data/lib/falkorlib/cli.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sat 2016-10-15 18:27 svarrette>
+# Time-stamp: <Mon 2016-11-07 22:42 svarrette>
 ################################################################################
 # Interface for the CLI
 #
@@ -10,22 +10,21 @@ require 'thor/actions'
 require 'thor/group'
 require 'thor/zsh_completion'
 
-require "falkorlib"
+require 'falkorlib'
 
-require "falkorlib/cli/new"
-require "falkorlib/cli/link"
+require 'falkorlib/cli/new'
+require 'falkorlib/cli/link'
 
 
 
 module FalkorLib
-
   # Falkor CLI Application, based on [Thor](http://whatisthor.com)
   module CLI
-
     # Main Application
     class App < ::Thor
-      package_name "Falkor[Lib]"
-      map "-V" => "version"
+
+      package_name 'Falkor[Lib]'
+      map %w(--version -V) => :version
 
       namespace :falkor
 
@@ -35,11 +34,12 @@ module FalkorLib
 
       #default_command :info
 
-      class_option :verbose, :aliases => "-v",
-        :type => :boolean, :desc => "Enable verbose output mode"
-      class_option :debug,
-        :type => :boolean, :default => FalkorLib.config[:debug], :desc => "Enable debug output mode"
-      class_option :dry_run, :aliases => '-n', :desc => "Perform a trial run with (normally) no changes made",  :type => :boolean
+      class_option :verbose, :aliases => '-v', :type => :boolean,
+                             :desc => "Enable verbose output mode"
+      class_option :debug,   :type => :boolean, :default => FalkorLib.config[:debug],
+                             :desc => "Enable debug output mode"
+      class_option :dry_run, :aliases => '-n', :type => :boolean,
+                             :desc => "Perform a trial run with (normally) no changes made"
 
       ###### commands ######
       desc "commands", "Lists all available commands"
@@ -54,28 +54,86 @@ This command allows you to interact with FalkorLib's configuration system.
 FalkorLib retrieves its configuration from the local repository (in '<git_rootdir>/.falkor/config'),
 environment variables (NOT YET IMPLEMENTED), and the user's home directory (<home>/.falkor/config), in that order of priority.
 CONFIG_LONG_DESC
-      method_option :global, :aliases => '-g', :type => :boolean, :desc => 'Operate on the global configuration'
-      method_option :local,  :aliases => '-l', :type => :boolean, :desc => 'Operate on the local configuration of the repository'
-      def config(key = '')
+      method_option :global, :aliases => '-g', :type => :boolean,
+                             :desc => 'Operate on the global configuration'
+      method_option :local,  :aliases => '-l', :type => :boolean,
+                             :desc => 'Operate on the local configuration of the repository'
+      def config(_key = '')
         info "Thor options:"
         puts options.to_yaml
         info "FalkorLib internal configuration:"
         puts FalkorLib.config.to_yaml
       end # config
 
+      #map %w[--help -h] => :help
+
+      ###### init ######
+      desc "init <PATH> [options]", "Bootstrap a Git Repository"
+      long_desc <<-INIT_LONG_DESC
+Initiate a Git repository according to my classical layout.
+\x5 * the repository will be configured according to the guidelines of Git Flow
+\x5 * the high-level operations will be piloted either by a Makefile (default) or a Rakefile
+
+By default, <PATH> is '.' meaning that the repository will be initialized in the current directory.
+\x5Otherwise, the NAME subdirectory will be created and bootstraped accordingly.
+      INIT_LONG_DESC
+      #......................................................
+      method_option :git_flow, :default => true, :type => :boolean,
+                               :desc => 'Bootstrap the repository with Git-glow'
+      method_option :make, :default => true,     :type => :boolean,
+                           :desc => 'Use a Makefile to pilot the repository actions'
+      method_option :rake, :type => :boolean,
+                           :desc => 'Use a Rakefile (and FalkorLib) to pilot the repository actions'
+      method_option :interactive, :aliases => '-i', :default => true, :type => :boolean,
+                                  :desc => "Interactive mode, in particular to confirm Gitflow branch names"
+      method_option :remote_sync, :aliases => '-r', :type => :boolean,
+                                  :desc => "Operate a git remote synchronization with remote. By default, all commits stay local"
+      method_option :master, :default => 'production', :banner => 'BRANCH',
+                             :desc => "Master Branch name for production releases"
+      method_option :develop, :aliases => [ '-b', '--branch', '--devel'],
+                              :default => 'devel', :banner => 'BRANCH',
+                              :desc => "Branch name for development commits"
+      # method_option :latex, :aliases => '-l', :type => :boolean, :desc => "Initiate a LaTeX project"
+      # #method_option :gem,   :type => :boolean, :desc => "Initiate a Ruby gem project"
+      # method_option :rvm,   :type => :boolean, :desc => "Initiate a RVM-based Ruby project"
+      # method_option :ruby, :default => '1.9.3', :desc => "Ruby version to configure for RVM"
+      # method_option :pyenv, :type => :boolean, :desc => "Initiate a pyenv-based Python project"
+      # method_option :octopress, :aliases => ['-o', '--www'], :type => :boolean, :desc => "Initiate an Octopress web site"
+      #___________________
+      def init(name = '.')
+        #options[:rvm] = true if options[:rake] or options[:gem]
+        # _newrepo(name, options)
+        FalkorLib::Bootstrap.repo(name, options)
+      end # repo
+
+      ###### link <subcommand>  ######
+      desc "link <TYPE> [<path>]", "Initialize a special symlink in <path> (the current directory by default)"
+      subcommand "link", FalkorLib::CLI::Link
 
-      # map %w[--help -h] => :help
 
-      ###### new ######
-      desc "new <type> [<path>]", "Initialize the directory PATH with FalkorLib's template(s)"
+      ###### motd ######
+      method_option :file,     :aliases => '-f', :default => '/etc/motd',
+                               :desc => "File storing the message of the day"
+      method_option :width,    :aliases => '-w', :default => 80, :type => :numeric,
+                               :desc => "Width for the text"
+      method_option :title,    :aliases => '-t',
+                               :desc => "Title to be placed in the motd (using asciify/figlet)"
+      method_option :subtitle, :desc => "Eventual subtitle to place below the title"
+      method_option :hostname, :desc => "Hostname"
+      method_option :support,  :aliases => '-s', :desc => "Support/Contact mail"
+      method_option :desc,     :aliases => '-d', :desc => "Short Description of the host"
+      method_option :nodemodel, :aliases => '-n', :desc => "Node Model"
+      #......................................
+      desc "motd <PATH> [options]", "Initiate a 'motd' file - message of the day"
+      def motd(path = '.')
+        FalkorLib::Bootstrap.motd(path, options)
+      end # motd
+
+      ###### new <subcommand> ######
+      desc "new <type> [<path>]", "Initialize the directory PATH with one of FalkorLib's template(s)"
       subcommand "new", FalkorLib::CLI::New
 
-      ###### link  ######
-      desc "link <type> [<path>]", "Initialize a special symlink in <path> (the current directory by default)"
-      subcommand "link", FalkorLib::CLI::Link
-
 
-      map %w[--version -V] => :version
       ###### version ######
       desc "--version, -V", "Print the version number"
       def version
@@ -85,9 +143,7 @@ CONFIG_LONG_DESC
     end # class App
 
     #puts Thor::ZshCompletion::Generator.new(App, "falkor").generate
-
   end # module CLI
-
 end
 
 

data/lib/falkorlib/cli/config.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Ven 2015-02-27 20:59 svarrette>
+# Time-stamp: <Fri 2016-11-11 15:11 svarrette>
 ################################################################################
 # Management of the configuration specializations
 #
@@ -9,14 +9,14 @@ require 'thor'
 require 'falkorlib'
 
 module FalkorLib
-    module CLI
-        class Config #< ::Thor
-            
+  module CLI
+    class Config #< ::Thor
 
-            
 
 
-            
-        end # class Config
-    end # module CLI
+
+
+
+    end # class Config
+  end # module CLI
 end # module FalkorLib

data/lib/falkorlib/cli/link.rb

@@ -10,7 +10,6 @@ require 'falkorlib'
 
 module FalkorLib
   module CLI
-
     # Thor class for symlink creation
     class Link < ::Thor
 
@@ -33,19 +32,19 @@ module FalkorLib
 
       ###### make ######
       method_option :latex, :default => true, :type => :boolean, :aliases => '-l',
-                    :desc => "Makefile to compile LaTeX documents"
+                            :desc => "Makefile to compile LaTeX documents"
       method_option :gnuplot, :type => :boolean, :aliases => ['--plot', '-p'],
-                    :desc => "Makefile to compile GnuPlot scripts"
+                              :desc => "Makefile to compile GnuPlot scripts"
       method_option :generic, :type => :boolean, :aliases => '-g',
-                    :desc => "Generic Makefile for sub directory"
+                              :desc => "Generic Makefile for sub directory"
       method_option :markdown, :type => :boolean, :aliases => '-m',
-                    :desc => "Makefile to convert Markdown files to HTML"
+                               :desc => "Makefile to convert Markdown files to HTML"
       method_option :images, :type => :boolean, :aliases => [ '-i', '--img' ],
-                    :desc => "Makefile to optimize images"
+                             :desc => "Makefile to optimize images"
       method_option :refdir, :default => "#{FalkorLib.config[:git][:submodulesdir]}/Makefiles",
-                    :aliases => '-d', :desc => "Path to Falkor's Makefile repository (Relative to Git root dir)"
-      method_option :src,  :type => :boolean, :aliases => [ '--src', '-s' ],
-                    :desc => "Path to Falkor's Makefile for latex_src"
+                             :aliases => '-d', :desc => "Path to Falkor's Makefile repository (Relative to Git root dir)"
+      method_option :src, :type => :boolean, :aliases => [ '--src', '-s' ],
+                          :desc => "Path to Falkor's Makefile for latex_src"
       #......................................
       desc "make [options]", "Create a symlink to one of Falkor's Makefile, set as Git submodule"
       def make(dir = Dir.pwd)

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sat 2016-10-15 18:45 svarrette>
+# Time-stamp: <Mon 2016-11-07 10:23 svarrette>
 ################################################################################
 
 require 'thor'
@@ -10,10 +10,16 @@ require "falkorlib/bootstrap"
 
 module FalkorLib
   module CLI
-
     # Thor class for all bootstrapping / initialization
     class New < ::Thor
 
+      package_name "Falkor[Lib] 'new'"
+      namespace :new
+
+      def self.banner(task, _namespace = true, subcommand = false)
+        "#{basename} #{task.formatted_usage(self, true, subcommand)}"
+      end
+
       ###### commands ######
       desc "commands", "Lists all available commands", :hide => true
       def commands
@@ -22,12 +28,6 @@ module FalkorLib
 
       #map %w[--help -h] => :help
 
-      ###### commands ######
-      # desc "commands", "Lists available commands" #, :hide => true
-      # def commands
-      #     puts App.all_commands.to_yaml #.keys - ["commands", "completions"]
-      # end
-
       ###### repo ######
       desc "repo NAME [options]", "Bootstrap a Git Repository"
       long_desc <<-REPO_LONG_DESC
@@ -41,23 +41,23 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
       #......................................................
       method_option :git_flow, :default => true, :type => :boolean, :desc => 'Bootstrap the repository with Git-glow'
       method_option :make, :default => true,     :type => :boolean, :desc => 'Use a Makefile to pilot the repository actions'
-      method_option :rake,       :type => :boolean, :desc => 'Use a Rakefile (and FalkorLib) to pilot the repository actions'
+      method_option :rake, :type => :boolean, :desc => 'Use a Rakefile (and FalkorLib) to pilot the repository actions'
       method_option :interactive, :aliases => '-i', :default => true,
-                    :type => :boolean, :desc => "Interactive mode, in particular to confirm Gitflow branch names"
+                                  :type => :boolean, :desc => "Interactive mode, in particular to confirm Gitflow branch names"
       method_option :remote_sync, :aliases => '-r',
-                    :type => :boolean, :desc => "Operate a git remote synchronization with remote. By default, all commits stay local"
+                                  :type => :boolean, :desc => "Operate a git remote synchronization with remote. By default, all commits stay local"
       method_option :master, :default => 'production', :banner => 'BRANCH', :desc => "Master Branch name for production releases"
       method_option :develop, :aliases => [ '-b', '--branch', '--devel'],
-                    :default => 'devel', :banner => 'BRANCH', :desc => "Branch name for development commits"
-      method_option :latex, :aliases => '-l', :type => :boolean, :desc => "Initiate a LaTeX project"
+                              :default => 'devel', :banner => 'BRANCH', :desc => "Branch name for development commits"
+      #method_option :latex, :aliases => '-l', :type => :boolean, :desc => "Initiate a LaTeX project"
       #method_option :gem,   :type => :boolean, :desc => "Initiate a Ruby gem project"
-      method_option :rvm,   :type => :boolean, :desc => "Initiate a RVM-based Ruby project"
-      method_option :ruby, :default => '1.9.3', :desc => "Ruby version to configure for RVM"
+      method_option :rvm, :type => :boolean, :desc => "Initiate a RVM-based Ruby project"
+      method_option :ruby, :default => '2.1.10', :desc => "Ruby version to configure for RVM"
       #method_option :pyenv, :type => :boolean, :desc => "Initiate a pyenv-based Python project"
       #method_option :octopress, :aliases => ['-o', '--www'], :type => :boolean, :desc => "Initiate an Octopress web site"
       #___________________
       def repo(name = '.')
-        options[:rvm] = true if options[:rake] or options[:gem]
+        options[:rvm] = true if options[:rake] || options[:gem]
         # _newrepo(name, options)
         FalkorLib::Bootstrap.repo(name, options)
       end # repo
@@ -114,14 +114,14 @@ It consists of two files:
 These files will be committed in Git to ensure a consistent environment for the project.
 RVM_LONG_DESC
       method_option :force, :aliases => '-f',
-                    :type => :boolean, :desc => 'Force overwritting the RVM config'
+                            :type => :boolean, :desc => 'Force overwritting the RVM config'
       method_option :ruby, :banner => 'VERSION',
-                    :desc => 'Ruby version to configure / install for RVM'
+                           :desc => 'Ruby version to configure / install for RVM'
       method_option :versionfile, :banner => 'FILE',
-                    :default => FalkorLib.config[:rvm][:versionfile], :desc => 'RVM ruby version file'
+                                  :default => FalkorLib.config[:rvm][:versionfile], :desc => 'RVM ruby version file'
       method_option :gemset, :desc => 'RVM gemset to configure for this directory'
       method_option :gemsetfile, :banner => 'FILE',
-                    :default => FalkorLib.config[:rvm][:gemsetfile], :desc => 'RVM gemset file'
+                                 :default => FalkorLib.config[:rvm][:gemsetfile], :desc => 'RVM gemset file'
       #____________________
       def rvm(path = '.')
         FalkorLib::Bootstrap.rvm(path, options)
@@ -130,34 +130,20 @@ RVM_LONG_DESC
       ###### versionfile ######
       desc "versionfile PATH [options]", "initiate a VERSION file"
       method_option :file, :aliases => '-f',
-                    :desc => "Set the VERSION filename"
+                           :desc => "Set the VERSION filename"
       method_option :tag,  :aliases => '-t',
-                    :desc => "Git tag to use"
-      method_option :version,  :aliases => '-v',
-                    :desc => "Set the version to initialize in the version file"
+                           :desc => "Git tag to use"
+      method_option :version, :aliases => '-v',
+                              :desc => "Set the version to initialize in the version file"
       #_______________
       def versionfile(path = '.')
         FalkorLib::Bootstrap.versionfile(path, options)
       end # versionfile
 
-      ###### motd ######
-      method_option :file,     :aliases => '-f', :default => '/etc/motd', :desc => "File storing the message of the day"
-      method_option :width,    :aliases => '-w', :default => 80, :type => :numeric, :desc => "Width for the text"
-      method_option :title,    :aliases => '-t', :default => "Title", :desc => "Title to place in the motd"
-      method_option :subtitle, :desc => "Eventual subtitle to place below the title"
-      method_option :hostname, :aliases => '-h', :default => `hostname -f`, :desc => "Hostname"
-      method_option :support,  :aliases => '-s', :default => "#{ENV['GIT_AUTHOR_EMAIL']}", :desc => "Support/Contact mail"
-      method_option :desc,     :aliases => '-d', :desc => "Short Description of the host"
-      method_option :nodemodel,:aliases => '-n', :desc => "Node Model"
-      #......................................
-      desc "motd PATH [options]", "Initiate a 'motd' file - message of the day"
-      def motd(path = '.')
-        FalkorLib::Bootstrap.motd(path, options)
-      end # motd
 
       ###### readme ######
       method_option :make, :default => true,
-                    :type => :boolean, :desc => 'Use a Makefile to pilot the repository actions'
+                           :type => :boolean, :desc => 'Use a Makefile to pilot the repository actions'
       method_option :rake,
                     :type => :boolean, :desc => 'Use a Rakefile (and FalkorLib) to pilot the repository actions'
       method_option :latex, :aliases => '-l', :type => :boolean, :desc => "Describe a LaTeX project"