falkorlib 0.3.14 → 0.4.0

data/lib/falkorlib/cli.rb

@@ -0,0 +1,230 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Mar 2015-01-20 23:25 svarrette>
+################################################################################
+# Interface for the CLI
+#
+
+require 'thor'
+require 'thor/actions'
+require "falkorlib"
+
+require "falkorlib/cli/new"
+
+
+
+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"
+
+      namespace :falkor
+
+      include Thor::Actions
+      include FalkorLib::Common
+
+      #default_command :info
+
+      class_option :verbose, :aliases => "-v",
+        :type => :boolean, :desc => "Enable verbose output mode"
+      class_option :debug, :aliases => "-d",
+        :type => :boolean, :default => FalkorLib.config[:debug], :desc => "Enable debug output mode"
+      class_option :dry_run, :aliases => '-n', :type => :boolean
+
+      ###### commands ######
+      desc "commands", "Lists all available commands", :hide => true
+      def commands
+        puts App.all_commands.keys - ["commands", "completions"]
+      end
+
+      ###### config ######
+      desc "config", "Print the current configuration of FalkorLib", :hide => true
+      def config
+        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 "new TYPE", "Initialize the directory PATH with FalkorLib's template(s)"
+      subcommand "new", FalkorLib::CLI::New
+
+
+
+      map %w[--version -V] => :version
+      ###### version ######
+      desc "--version, -V", "Print the version number"
+      def version
+        say "Falkor[Lib] version " + FalkorLib::VERSION, :yellow # + "on ruby " + `ruby --version`
+      end
+
+
+
+
+    end # class App
+  end # module CLI
+
+end
+
+
+
+
+
+# require_relative "commands/init"
+
+# module FalkorLib
+#   module CLI
+#     def self.const_missing(c)
+#       Object.const_get(c)
+#     end
+#   end
+# end
+
+# require 'falkorlib'
+
+
+# require 'thor'
+# require "thor/group"
+
+
+#require "falkorlib/commands/init"
+
+# require 'logger'
+
+# # Declare a logger to log messages:
+# LOGGER       = Logger.new(STDERR)
+# LOGGER.level = Logger::INFO
+
+
+# module FalkorLib
+#   # Falkor CLI Application, based on [Thor](http://whatisthor.com)
+
+#   require_relative "commands/init"
+
+#   module CLI
+
+#     def self.const_missing(c)
+#       Object.const_get(c)
+#     end
+
+
+# # Main CLI command for FalkorLib
+# class Command < Thor
+
+#   class_option :verbose, :type => :boolean
+
+#   require "falkorlib/commands/init"
+
+#   # ----------
+#   # desc "init <PATH> [options]", "Initialize the directory PATH with FalkorLib's template(s)"
+#   # subcommand "init", FalkorLib::CLI::Init
+
+# end # class FalkorLib::CLI::Command
+#   end
+# end
+
+
+
+
+# # Mercenary version
+
+# module FalkorLib
+
+#   # Falkor CLI Application, based on (finally) [Mercenary](http://www.rubydoc.info/gems/mercenary)
+#   # instead of [Thor](http://whatisthor.com)
+#   class Command
+
+#     # Keep a list of subclasses of FalkorLib::Command every time it's inherited
+#     # Called automatically.
+#     #
+#     # base - the subclass
+#     #
+#     # Returns nothing
+#     def self.inherited(base)
+#       subclasses << base
+#     end
+
+#     # A list of subclasses of FalkorLib::Command
+#     def self.subclasses
+#       @subclasses ||= []
+#     end
+
+#     def init_with_program(p)
+#       raise NotImplementedError.new("")
+#     end
+#   end
+# end
+
+
+
+
+
+
+
+
+
+
+
+# module FalkorLib  #:nodoc:
+#   module Config
+
+#     # Default configuration for FalkorLib::App
+#     module CLI
+#       # App defaults for FalkorLib
+#       DEFAULTS = {
+#                   # command-line options
+#                   :options   => {},
+#                   #:type      => "latex"
+#                  }
+#     end
+#   end
+# end
+
+
+# # ---------------------------
+# #    Command line parsing
+# # ---------------------------
+# module FalkorCLI
+#   class Init < Thor
+#     # # exit if bad parsing happen
+#     # def self.exit_on_failure?
+#     #   true
+#     # end
+
+#     class_option :verbose,
+#       :type    => :boolean,
+#       :default => false,
+#       :aliases => "-v",
+#       :desc    => "Verbose  mode"
+#     class_option :debug,
+#       :type    => :boolean,
+#       :default => false,
+#       :aliases => "-d",
+#       :desc    => "Debug  mode"
+
+
+#     desc "init", "Initialise a given template"
+#     long_desc <<-LONGDESC
+# Initialize a new directory according to <type> of template
+#     LONGDESC
+#     option :type,
+#       :required => true,
+#       :default  => 'repo',
+#       :type     => :string,
+#       :desc     => "Type of template to use to initialize this repository"
+#     def init(type)
+#       LOGGER.level = Logger::DEBUG if options[:verbose]
+#       puts "Hello, world!"
+
+#     end
+#   end
+# end # module FalkorLib

data/lib/falkorlib/cli/new.rb

@@ -0,0 +1,94 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Ven 2015-01-23 00:00 svarrette>
+################################################################################
+
+require 'thor'
+require 'falkorlib'
+#require 'falkorlib/cli/init/repo'
+require "falkorlib/bootstrap"
+
+module FalkorLib
+  module CLI
+
+    # Thor class for all bootstrapping / initialization
+    class New < ::Thor
+
+      ###### repo ######
+      desc "repo NAME [options]", "Bootstrap a Git Repository"
+      long_desc <<-REPO_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, NAME is '.' meaning that the repository will be initialized in the current directory.
+\x5Otherwise, the NAME subdirectory will be created and bootstraped accordingly.
+      REPO_LONG_DESC
+      #......................................................
+      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',
+        :type => :boolean, :desc => "Interactive mode"
+      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"
+      #___________________
+      def repo(name = '.')
+       # _newrepo(name, options)
+        FalkorLib::Bootstrap.repo(name, options)
+      end # repo
+
+
+      ###### trash ######
+      desc "trash PATH", "Add a Trash directory"
+      #________________________
+      def trash(path = Dir.pwd)
+        FalkorLib::Bootstrap.trash(path)
+      end # trash
+
+      ###### rvm ######
+      desc "rvm PATH [options]", "Initialize RVM"
+      long_desc <<-RVM_LONG_DESC
+Initialize Ruby Version Manager (RVM) for the current directory (or at the root directory of the Git repository).
+It consists of two files:
+\x5 * `.ruby-version`: Project file hosting a single line for the ruby version
+\x5 * `.ruby-gemset`:  Gemset file hosting a single line for the gemset to use for this project
+
+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'
+      method_option :ruby, :banner => 'VERSION',
+        :desc => 'Ruby version to configure / install for RVM'
+      method_option :versionfile, :banner => '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'
+      #____________________
+      def rvm(path = '.')
+        FalkorLib::Bootstrap.rvm(path, options)
+      end # rvm
+
+      ###### versionfile ######
+      desc "versionfile PATH [options]", "initiate a VERSION file"
+      method_option :file, :aliases => '-f',
+        :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"
+      #_______________
+      def versionfile(path = '.')
+          FalkorLib::Bootstrap.versionfile(path, options)
+      end # versionfile
+
+      
+    end # class Init
+  end # module CLI
+end # module FalkorLib

data/lib/falkorlib/common.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Ven 2014-12-05 15:41 svarrette>
+# Time-stamp: <Mer 2015-01-21 22:36 svarrette>
 ################################################################################
 
 require "falkorlib"
@@ -8,6 +8,7 @@ require 'open3'
 require 'erb'      # required for module generation
 require 'diffy'
 require 'json'
+require "pathname"
 
 module FalkorLib #:nodoc:
 
@@ -406,6 +407,24 @@ module FalkorLib #:nodoc:
 
         end
 
+        ###### normalize_path ######
+        # Normalize a path and return the absolute path foreseen
+        # Ex: '.' return Dir.pwd
+        # Supported options:
+        #  * :relative   [boolean] return relative path to the root dir
+        ##
+        def normalized_path(dir = Dir.pwd, options = {})
+          rootdir = FalkorLib::Git.init?(dir) ? FalkorLib::Git.rootdir(dir) : dir
+          path = dir
+          path = Dir.pwd if dir == '.'
+          path = File.join(Dir.pwd,  dir) unless (dir =~ /^\// or dir == '.')
+          if (options[:relative] or options[:relative_to])
+            root = options[:relative_to] ? options[:relative_to] : rootdir
+            relative_path_to_root = Pathname.new( File.realpath(path) ).relative_path_from Pathname.new(root)
+            path = relative_path_to_root.to_s
+          end
+          return path
+        end # normalize_path
 
     end
 end

data/lib/falkorlib/config.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Lun 2014-09-01 09:37 svarrette>
+# Time-stamp: <Mer 2015-01-21 09:25 svarrette>
 ################################################################################
 # FalkorLib Configuration
 #
@@ -44,10 +44,13 @@ module FalkorLib #:nodoc:
             :root       => Dir.pwd,
 		    :custom_cfg => '.falkorlib.yaml',
 		    :rvm => {
-			    :rubies => [ '1.9.3', '2.0.0', '2.1.0']
+               :rubies => [ '1.9.3', '2.0.0', '2.1.0'],
+               :versionfile => '.ruby-version',
+               :gemsetfile  => '.ruby-gemset'
 		    },
 		    :templates => {
-			    :puppet => {}
+                     :trashdir => '.Trash',
+                     :puppet   => {}
 		    },
 		    :tokens => {
 			    :code_climate => ''

data/lib/falkorlib/git/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Ven 2014-12-05 22:43 svarrette>
+# Time-stamp: <Jeu 2015-01-22 17:57 svarrette>
 ################################################################################
 # Interface for the main Git operations
 #
@@ -82,8 +82,10 @@ module FalkorLib  #:nodoc:
             subl.any? { |i| l[i].split.include?(cmd) }
         end
 
-        ## Initialize a git repository
-        def init(path = Dir.pwd)
+        ###
+        # Initialize a git repository
+        ## 
+        def init(path = Dir.pwd, options = {})
             # FIXME for travis test: ensure the global git configurations
             # 'user.email' and 'user.name' are set
             [ 'user.name', 'user.email' ].each do |userconf|
@@ -100,9 +102,9 @@ module FalkorLib  #:nodoc:
                 end
             end
 	        exit_status = 1
-	        #info "Initialize "
-	        Dir.chdir( path ) do 
-		        execute "git init" unless FalkorLib.config.debug 
+            Dir.mkdir( path ) unless Dir.exist?( path )
+	        Dir.chdir( path ) do
+		        execute "git init" unless FalkorLib.config.debug
 		        exit_status = $?.to_i
 	        end
             # #puts "#init #{path}"
@@ -139,6 +141,30 @@ module FalkorLib  #:nodoc:
 	        g.branch (opts[:force] ? :D : :d) => "#{branch}"
         end
 
+        ###### config ######
+        # Retrieve the Git configuration
+        # You can propose a pattern as key
+        # Supported options:
+        #  * :list [boolean] list all configutations
+        #  * :hash [boolean] return a Hash
+        ##
+        def config(key, dir = Dir.pwd, options = {})
+          #info "Retrieve the Git configuration"
+          res = nil
+          if (options[:list] or (key.is_a? Regexp) or (key =~ /\*/))
+            cg  = MiniGit::Capturing.new(dir)
+            res = (cg.config :list => true).split("\n")
+            res.select! { |e| e.match(key) } unless key =='*'
+            res = res.map { |e| e.split('=') }.to_h if options[:hash]
+          else
+            g = MiniGit.new(dir)
+            res = g[key]
+          end
+          #ap res
+          res
+        end
+
+        
         ## Fetch the latest changes
         def fetch(path = Dir.pwd)
             Dir.chdir( path ) do
@@ -204,22 +230,25 @@ module FalkorLib  #:nodoc:
             exit_status
         end
 
-        ## List the files currently version
+        ## List the files currently under version
         def list_files(path = Dir.pwd)
 	        g = MiniGit.new(path)
 	        g.capturing.ls_files.split
         end 
 
         ## Add a file/whatever to Git and commit it
-        def add(path, msg = "")
+        # Supported options:
+        # * :force [boolean]: force the add
+        def add(path, msg = "", options = {})
 	        exit_status = 0
             dir  = File.realpath File.dirname(path)
             root = rootdir(path)
             relative_path_to_root = Pathname.new( File.realpath(path) ).relative_path_from Pathname.new(root)
             real_msg = (msg.empty? ? "add '#{relative_path_to_root}'" : msg)
+            opts = '-f' if options[:force]
             Dir.chdir( dir ) do
 		        exit_status = run %{
-                  git add #{path}
+                  git add #{opts} #{path}
                   git commit -s -m "#{real_msg}" #{path}
                 }
             end
@@ -241,7 +270,7 @@ module FalkorLib  #:nodoc:
 	        g = MiniGit.new(path)
 	        # git rev-list --tags --max-count=1)
             a = g.capturing.rev_list :tags => true, :max_count => 1
-	        a	        
+	        a
         end # last_tag_commit
 
         ## List of Git remotes
@@ -255,25 +284,29 @@ module FalkorLib  #:nodoc:
 	        return ! remotes(path).empty?
         end 
 
-        ## Initialize git subtrees from the configuration
-        def submodule_init(path = Dir.pwd)
+        ###
+        # Initialize git submodule from the configuration
+        ##
+        def submodule_init(path = Dir.pwd, submodules = FalkorLib.config.git[:submodules], options = {})
             exit_status  = 1
             git_root_dir = rootdir(path)
             if File.exists?("#{git_root_dir}/.gitmodules")
-                unless FalkorLib.config.git[:submodules].empty?
+                unless submodules.empty?
                     # TODO: Check if it contains all submodules of the configuration
                 end
             end
             #ap FalkorLib.config.git
             Dir.chdir(git_root_dir) do
                 exit_status = FalkorLib::Git.submodule_update( git_root_dir )
-                FalkorLib.config.git[:submodules].each do |subdir,conf|
+                submodules.each do |subdir,conf|
                     next if conf[:url].nil?
                     url = conf[:url]
                     dir = "#{FalkorLib.config.git[:submodulesdir]}/#{subdir}"
                     branch = conf[:branch].nil? ? 'master' : conf[:branch]
-                    unless File.directory?( dir )
-                        info "Adding Git submodule '#{dir}' from '#{url}'"
+                    if File.directory?( dir )
+                      puts "  ... the git submodule '#{subdir}' is already setup."
+                    else
+                      info "adding Git submodule '#{dir}' from '#{url}'"
                         exit_status = run %{
                            git submodule add -b #{branch} #{url} #{dir}
                            git commit -s -m "Add Git submodule '#{dir}' from '#{url}'" .gitmodules #{dir}
@@ -289,6 +322,7 @@ module FalkorLib  #:nodoc:
 	        execute_in_dir(rootdir(path), 
 	                       %{
                    git submodule init
+                   git submodule foreach git fetch
                    git submodule update
             })
         end