falkorlib 0.6.17 → 0.6.18

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Wed 2016-06-29 14:47 svarrette>
+# Time-stamp: <Sat 2016-10-15 18:45 svarrette>
 ################################################################################
 
 require 'thor'
@@ -9,23 +9,28 @@ require 'falkorlib'
 require "falkorlib/bootstrap"
 
 module FalkorLib
-    module CLI
+  module CLI
 
-        # Thor class for all bootstrapping / initialization
-        class New < ::Thor
+    # Thor class for all bootstrapping / initialization
+    class New < ::Thor
 
+      ###### 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
 
-            ###### commands ######
-            # desc "commands", "Lists available commands" #, :hide => true
-            # def commands
-            #     puts App.all_commands.to_yaml #.keys - ["commands", "completions"]
-            # end
+      ###### 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
+      ###### 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
@@ -33,74 +38,74 @@ Initiate a Git repository according to my classical layout.
 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 :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 repo(name = '.')
-                options[:rvm] = true if options[:rake] or options[:gem]
-                # _newrepo(name, options)
-                FalkorLib::Bootstrap.repo(name, options)
-            end # repo
-
-            ###### articles ######
-            #......................................
-            # desc "article [options]", "Bootstrap LaTeX Article"
-            # method_option :name, :aliases => '-n', :desc => 'Name of the LaTeX project'
-            # method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
-            # method_option :type, :default => 'ieee', :aliases => '-t', :desc => 'LaTeX Style to apply'
-            # #___________________
-            # def article(path = Dir.pwd)
-            #     FalkorLib::Bootstrap.latex(path, :article, options)
-            # end # article
-
-
-            ###### letter ######
-            method_option :name, :aliases => '-n', :desc => 'Name of the LaTeX project'
-            method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
-            #......................................
-            desc "letter [options]", "LaTeX-based letter"
-            #___________________
-            def letter(path = Dir.pwd)
-                FalkorLib::Bootstrap.latex(path, :letter, options)
-            end # letter
-
-
-
-            ###### slides ######
-            #......................................
-            desc "slides [options]", "Bootstrap LaTeX Beamer slides"
-            method_option :name, :aliases => '-n', :desc => 'Name of the LaTeX project'
-            #method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
-            #___________________
-            def slides(path = Dir.pwd)
-                FalkorLib::Bootstrap.latex(path, :beamer, options)
-            end # slides
-
-            ###### 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
+      #......................................................
+      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 repo(name = '.')
+        options[:rvm] = true if options[:rake] or options[:gem]
+        # _newrepo(name, options)
+        FalkorLib::Bootstrap.repo(name, options)
+      end # repo
+
+      ###### articles ######
+      #......................................
+      # desc "article [options]", "Bootstrap LaTeX Article"
+      # method_option :name, :aliases => '-n', :desc => 'Name of the LaTeX project'
+      # method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
+      # method_option :type, :default => 'ieee', :aliases => '-t', :desc => 'LaTeX Style to apply'
+      # #___________________
+      # def article(path = Dir.pwd)
+      #     FalkorLib::Bootstrap.latex(path, :article, options)
+      # end # article
+
+
+      ###### letter ######
+      method_option :name, :aliases => '-n', :desc => 'Name of the LaTeX project'
+      method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
+      #......................................
+      desc "letter [options]", "LaTeX-based letter"
+      #___________________
+      def letter(path = Dir.pwd)
+        FalkorLib::Bootstrap.latex(path, :letter, options)
+      end # letter
+
+
+
+      ###### slides ######
+      #......................................
+      desc "slides [options]", "Bootstrap LaTeX Beamer slides"
+      method_option :name, :aliases => '-n', :desc => 'Name of the LaTeX project'
+      #method_option :dir,  :aliases => '-d', :desc => 'Project directory (relative to the git root directory)'
+      #___________________
+      def slides(path = Dir.pwd)
+        FalkorLib::Bootstrap.latex(path, :beamer, options)
+      end # slides
+
+      ###### 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
@@ -108,64 +113,64 @@ 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'
-            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
-
-            ###### 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'
-            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"
-            method_option :gem,   :type => :boolean, :desc => "Describe a Ruby gem project"
-            method_option :rvm,   :type => :boolean, :desc => "Describe a RVM-based Ruby project"
-            method_option :pyenv, :type => :boolean, :desc => "Describe a pyenv-based Python project"
-            method_option :octopress, :aliases => '--www', :type => :boolean, :desc => "Describe an Octopress web site"
-            #......................................
-            desc "readme PATH [options]", "Initiate a README file in the PATH directory ('./' by default)"
-            def readme(path = '.')
-                FalkorLib::Bootstrap.readme(path, options)
-            end # readme
-
-        end # class New
-    end # module CLI
+      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
+
+      ###### 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'
+      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"
+      method_option :gem,   :type => :boolean, :desc => "Describe a Ruby gem project"
+      method_option :rvm,   :type => :boolean, :desc => "Describe a RVM-based Ruby project"
+      method_option :pyenv, :type => :boolean, :desc => "Describe a pyenv-based Python project"
+      method_option :octopress, :aliases => '--www', :type => :boolean, :desc => "Describe an Octopress web site"
+      #......................................
+      desc "readme PATH [options]", "Initiate a README file in the PATH directory ('./' by default)"
+      def readme(path = '.')
+        FalkorLib::Bootstrap.readme(path, options)
+      end # readme
+
+    end # class New
+  end # module CLI
 end # module FalkorLib

data/lib/falkorlib/cli.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Wed 2016-06-29 14:41 svarrette>
+# Time-stamp: <Sat 2016-10-15 18:27 svarrette>
 ################################################################################
 # Interface for the CLI
 #
@@ -8,6 +8,8 @@
 require 'thor'
 require 'thor/actions'
 require 'thor/group'
+require 'thor/zsh_completion'
+
 require "falkorlib"
 
 require "falkorlib/cli/new"
@@ -29,6 +31,7 @@ module FalkorLib
 
       include Thor::Actions
       include FalkorLib::Common
+      include ZshCompletion::Command
 
       #default_command :info
 
@@ -36,23 +39,23 @@ module FalkorLib
         :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
+      class_option :dry_run, :aliases => '-n', :desc => "Perform a trial run with (normally) no changes made",  :type => :boolean
 
       ###### commands ######
-      # desc "commands", "Lists all available commands", :hide => true
-      # def commands
-      #   puts App.all_commands.keys - ["commands", "completions"]
-      # end
+      desc "commands", "Lists all available commands"
+      def commands
+        puts App.all_commands.keys.sort - [ "zsh-completions"]
+      end
 
       ###### config ######
       desc "config [option] [KEY]", "Print the current configuration of FalkorLib" #, :hide => true
       long_desc <<-CONFIG_LONG_DESC
 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 (~/.falkor/config), in that order of priority.
+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 (in ~/.falkor/config)'
-      method_option :local,  :aliases => '-l', :type => :boolean, :desc => 'Operate on the local configuration of the repository (in <git_rootdir>/.falkor/config)'
+      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
@@ -79,10 +82,10 @@ CONFIG_LONG_DESC
         say "Falkor[Lib] version " + FalkorLib::VERSION, :yellow # + "on ruby " + `ruby --version`
       end
 
+    end # class App
 
+    #puts Thor::ZshCompletion::Generator.new(App, "falkor").generate
 
-
-    end # class App
   end # module CLI
 
 end

data/lib/falkorlib/common.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Tue 2015-06-16 09:33 svarrette>
+# Time-stamp: <Sat 2016-10-15 22:49 svarrette>
 ################################################################################
 
 require "falkorlib"
@@ -307,7 +307,7 @@ module FalkorLib #:nodoc:
             warning "about to initialize/update the directory #{rootdir}"
             really_continue?
             run %{ mkdir -p #{rootdir} } unless File.directory?( rootdir )
-            run %{ rsync --exclude '*.erb' -avzu #{templatedir}/ #{rootdir}/ }
+            run %{ rsync --exclude '*.erb' --exclude '.texinfo*' -avzu #{templatedir}/ #{rootdir}/ }
             Dir["#{templatedir}/**/*.erb"].each do |erbfile|
                 relative_outdir = Pathname.new( File.realpath( File.dirname(erbfile) )).relative_path_from Pathname.new(templatedir)
                 filename = File.basename(erbfile, '.erb')
@@ -349,7 +349,7 @@ module FalkorLib #:nodoc:
                     warning "Unable to find the template ERBfile '#{erb}'"
                     really_continue? unless options[:no_interaction]
                     next
-                end 
+                end
                 content += ERB.new(File.read("#{erb}"), nil, '<>').result(binding)
             end
             # error "Unable to find the template file #{erbfile}" unless File.exists? (erbfile )

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

data/templates/gems/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/templates/gems/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2012 - Sebastien Varrette
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.