falkorlib 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c3236e419d1298b136ca095a3281e55bbd95c24
-  data.tar.gz: 738b0c020f67cb4fe942c0d8f0b20152e08093d6
+  metadata.gz: 2174c9bbc6ebc626b201624fb6b26bb76e1eaadd
+  data.tar.gz: a129e47f1f9ec644481b772b10339477f79ee69a
 SHA512:
-  metadata.gz: 2ee4c52e5143aa60d36db2485f648232c7fce15103143f8b24fd375257ad177457677df4a8aea5497f6d9fab325cd98afe0ad24812ca46ee510f6205b6f7127c
-  data.tar.gz: 425cb5392539fef2b19386b2c59436495731719d879f1643e9cc1c940e12dc987597a2a75d2f70957613d2ea7051830bef2fb4ecfd36f6cbe803b418368c0f8c
+  metadata.gz: d42ce3ec359f2cda55cafdcd8b1b3c9e3b4cd9aa40207829bc67f72987c15e8406f4c9329a04668955d330d2ae3381c010dffac32996f3013cabfa27c3ab9ab8
+  data.tar.gz: 2dd4f397718652a00fc5ae35505102d7fa6f8d3ac0139d31edef029f6403d2facd7cf9475282232cfd9f10105b0ad2b5dc6b3b6cfc3f596618b9ffea1d6b5b2e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.7.2)
+    falkorlib (0.7.3)
       activesupport (~> 4.0)
       artii (>= 2.1)
       awesome_print (~> 1.2)

data/completion/_falkor

@@ -1,7 +1,7 @@
 #compdef falkor
 ########################################################################################
 # -*- mode:sh; -*-
-# Time-stamp: <Sun 2017-01-15 23:15 svarrette>
+# Time-stamp: <Mon 2017-01-16 12:24 svarrette>
 #
 # ZSH completion for [FalkorLib](https://github.com/Falkor/falkorlib)
 #
@@ -101,6 +101,7 @@ __falkor_new()
         'trash:Add a Trash directory for your LaTeX project'
         'rvm:Initialize RVM'
         'versionfile:initiate a VERSION file'
+        'license:Generate an Open-Source License for your project'
         'motd:Initiate a ''motd'' file - message of the day'
         'readme:Initiate a README file in the PATH directory (''./'' by default)'
         'help:Describe subcommands or one specific subcommand'
@@ -128,11 +129,19 @@ __falkor_new()
                                '(-n --name)'{-n,--name}'[Name of the LaTeX project]' \
                                '(-d --dir)'{-d,--dir}':Project directory (relative to the git root directory):_directories' && ret=0
                     ;;
+                (license)
+                    _arguments -C \
+                               '(-l --license)'{-l,--licence}'[Open Source License to use within your project]:lic:(none Apache-2.0 BSD CC-by-nc-sa GPL-2.0 GPL-3.0 LGPL-2.1 LGPL-3.0 MIT)' \
+                               '(-f --licensefile)'{-f,--licensefile}'[License Filename]:filename:(LICENSE)' && ret=0
+                               ;;
                 (repo)
                     _arguments -C \
                                '(--no-git-flow)--git-flow[Bootstrap the repository with Git-flow]' \
                                '--make[Use a Makefile to pilot the repository actions]' \
                                '--rake[Use a Rakefile (and FalkorLib) to pilot the repository actions]' \
+                               '--mkdocs[Initiate MkDocs within your project]' \
+                               '--license[Open Source License to use within your project]:lic:(none Apache-2.0 BSD CC-by-nc-sa GPL-2.0 GPL-3.0 LGPL-2.1 LGPL-3.0 MIT)' \
+                               '--licensefile[License Filename]:filename:(LICENSE)' \
                                '(-i --interactive)'{-i,--interactive}'[Interactive mode, in particular to confirm Gitflow branch names]' \
                                '(-r --remote-sync)'{-r,--remote-sync}'[Operate a git remote synchronization with remote. By default, all commits stay local]' \
                                '--master[Master Branch name for production releases]' \

data/lib/falkorlib/bootstrap/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sun 2017-01-15 22:52 svarrette>
+# Time-stamp: <Mon 2017-01-16 12:07 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -82,7 +82,7 @@ module FalkorLib #:nodoc:
               :url  => "http://www.linfo.org/bsdlicense.html",
               :logo => "http://upload.wikimedia.org/wikipedia/commons/thumb/b/bf/License_icon-bsd.svg/200px-License_icon-bsd.svg.png"
             },
-            "CC by-nc-sa" => {
+            "CC-by-nc-sa" => {
               :name => "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International",
               :url  => "http://creativecommons.org/licenses/by-nc-sa/4.0",
               :logo => "https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png"
@@ -235,6 +235,8 @@ module FalkorLib
     # Supported options:
     #  * :no_interaction [boolean]: do not interact
     #  * :force          [boolean] force overwritting
+    #  * :license     [string]  License to use
+    #  * :licensefile [string]  License filename (default: LICENSE)
     #  * :latex          [boolean] describe a LaTeX project
     #  * :octopress      [boolean] octopress site
     ##
@@ -253,6 +255,7 @@ module FalkorLib
         options[:make] = false
         options[:rvm]  = true
       end
+      config[:license] = options[:license] if options[:license]
       config[:type] << :rvm if options[:rake]
       # Type of project
       config[:type] << :latex if options[:latex]
@@ -264,7 +267,7 @@ module FalkorLib
         config[:type] << :python if t == :pyenv
       end
       config[:type].uniq!
-      ap config
+      #ap config
       config[:type] = config[:type].uniq.flatten
       # Apply options (if provided)
       [ :name, :forge ].each do |k|
@@ -327,6 +330,7 @@ module FalkorLib
       erbfiles << "readme_git.erb"     if FalkorLib::Git.init?(dir)
       erbfiles << "readme_gitflow.erb" if FalkorLib::GitFlow.init?(dir)
       erbfiles << "readme_rvm.erb"     if config[:type].include?(:rvm)
+      erbfiles << "readme_mkdocs.erb"  if options[:mkdocs]
       erbfiles << "footer_readme.erb"
 
       content = ""
@@ -336,9 +340,9 @@ module FalkorLib
       end
       show_diff_and_write(content, config[:filename], options)
 
-      # Eventually save/upgrade local config
+      # Force save/upgrade local config
       info "=> saving customization of the FalkorLib configuration in #{FalkorLib.config[:config_files][:local]}"
-      really_continue?
+      # really_continue?
       FalkorLib::Config::Bootstrap::DEFAULTS[:metadata].keys.each do |k|
         local_config[:project] = {} unless local_config[:project]
         local_config[:project][k.to_sym] = config[k.to_sym]
@@ -375,7 +379,7 @@ module FalkorLib
     ##
     def select_licence(default_licence = FalkorLib::Config::Bootstrap::DEFAULTS[:metadata][:license],
                        _options = {})
-      list_license = FalkorLib::Config::Bootstrap::DEFAULTS[:licenses].keys
+      list_license = FalkorLib::Bootstrap::DEFAULTS[:licenses].keys
       idx = list_license.index(default_licence) unless default_licence.nil?
       select_from(list_license,
                   'Select the license index for this project:',
@@ -383,6 +387,33 @@ module FalkorLib
       #licence
     end # select_licence
 
+    ###### license ######
+    # Generate the licence file
+    #
+    # Supported options:
+    #  * :force    [boolean] force action
+    #  * :filename [string]  License file name
+    #  * :organization [string]  Organization
+    ##
+    def license(dir = Dir.pwd,
+                license = FalkorLib::Config::Bootstrap::DEFAULTS[:metadata][:license],
+                authors = '',
+                options = {
+                  :filename     => 'LICENSE'
+                })
+      return if (license.empty? or license == :none or license =~ /^CC/)
+      return unless FalkorLib::Config::Bootstrap::DEFAULTS[:licenses].keys.include?( license )
+      info "Generate the licence file"
+      path = normalized_path(dir)
+      use_git = FalkorLib::Git.init?(path)
+      rootdir = (use_git) ? FalkorLib::Git.rootdir(path) : path
+      Dir.chdir( rootdir ) do
+        run %( licgen #{license.downcase} #{authors} )
+        run %( mv LICENSE #{options[:filename]} ) if( options[:filename] and options[:filename] != 'LICENSE')
+      end
+    end # license
+
+
     ###### guess_project_config ######
     # Guess the project configuration
     ##

data/lib/falkorlib/bootstrap/git.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Fri 2016-11-11 15:05 svarrette>
+# Time-stamp: <Mon 2017-01-16 11:52 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -26,17 +26,20 @@ module FalkorLib
     # Supported options:
     # * :no_interaction [boolean]: do not interact
     # * :gitflow     [boolean]: bootstrap with git-flow
+    # * :license     [string]  License to use
+    # * :licensefile [string]  License filename (default: LICENSE)
     # * :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
+    # * :latex       [boolean] Initiate a LaTeX project              **NOT YET IMPLEMENTED**
+    # * :gem         [boolean] Initiate a Ruby gem project           **NOT YET IMPLEMENTED**
+    # * :mkdocs      [boolean] Initiate MkDocs within your project
     # * :rvm         [boolean] Initiate a RVM-based Ruby project
-    # * :pyenv       [boolean] Initiate a pyenv-based Python project
-    # * :octopress   [boolean] Initiate an Octopress web site
+    # * :pyenv       [boolean] Initiate a pyenv-based Python project **NOT YET IMPLEMENTED**
+    # * :octopress   [boolean] Initiate an Octopress web site        **NOT YET IMPLEMENTED**
     ##
     def repo(name, options = {})
       ap options if options[:debug]
@@ -109,13 +112,26 @@ module FalkorLib
       end
 
       # === VERSION file ===
-      FalkorLib::Bootstrap.versionfile(path, :tag => 'v0.0.0')
+      FalkorLib::Bootstrap.versionfile(path, :tag => 'v0.0.0') unless options[:gem]
 
       # === RVM ====
       FalkorLib::Bootstrap.rvm(path, options) if options[:rvm]
 
       # === README ===
-      FalkorLib::Bootstrap.readme(path, options)
+      FalkorLib::Bootstrap.readme(path, options) # This should also save the project configuration
+      # collect the set options
+      local_config = FalkorLib::Config.get(path)
+
+      # === MkDocs ===
+      FalkorLib::Bootstrap.mkdocs(path, options) if options[:mkdocs]
+
+      # === Licence ===
+      if (local_config[:project] and local_config[:project][:license])
+        author  = local_config[:project][:author] ? local_config[:project][:author] : FalkorLib::Config::Bootstrap::DEFAULTS[:metadata][:author]
+        FalkorLib::Bootstrap.licence(path, local_config[:project][:license], author,  options)
+      end
+      #
+
 
       #===== remote synchro ========
       if options[:remote_sync]

data/lib/falkorlib/bootstrap/mkdocs.rb

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sun 2017-01-15 23:22 svarrette>
+# Time-stamp: <Mon 2017-01-16 10:13 svarrette>
 ################################################################################
-# Interface for the main Bootstrapping operations
+# Interface for Bootstrapping MkDocs
 #
 
 require "falkorlib"

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mon 2016-11-07 10:23 svarrette>
+# Time-stamp: <Mon 2017-01-16 12:20 svarrette>
 ################################################################################
 
 require 'thor'
@@ -51,8 +51,13 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
                               :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 => '2.1.10', :desc => "Ruby version to configure for RVM"
+      method_option :rvm,    :type => :boolean, :desc => "Initiate a RVM-based Ruby project"
+      method_option :mkdocs, :type => :boolean, :desc => "Initiate Mk Docs within your project"
+      method_option :license,     :default => 'none',    :desc => "Open Source License to use within your project"
+      method_option :licensefile, :default => 'LICENSE', :desc => "LICENSE File name"
+
+
       #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"
       #___________________
@@ -84,6 +89,15 @@ By default, NAME is '.' meaning that the repository will be initialized in the c
         FalkorLib::Bootstrap.latex(path, :letter, options)
       end # letter
 
+      ###### license ######
+      method_option :license,     :aliases => ['--lic' , '-l'], :desc => "Open Source License to use within your project"
+      method_option :licensefile, :aliases => ['-f' ], :default => 'LICENSE', :desc => "LICENSE File name"
+      #......................................
+      desc "license [options]", "Generate an Open-Source License for your project"
+      def license(path = Dir.pwd)
+        license = options[:license] ?  options[:license] : FalkorLib::Bootstrap.select_licence('none')
+        FalkorLib::Bootstrap.license(path, license, '', options)
+      end # license
 
 
       ###### 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, 2
+    MAJOR, MINOR, PATCH = 0, 7, 3
 
     module_function
 

data/spec/falkorlib/bootstrap_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Wed 2016-11-09 20:17 svarrette>
+# Time-stamp: <Mon 2017-01-16 11:30 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
@@ -127,6 +127,26 @@ describe FalkorLib::Bootstrap do
         end
       end
 
+      ### LICENSE file generation
+      it "#license -- don't generate LICENSE by default" do
+        license = File.join(dir, 'LICENSE')
+        FalkorLib::Bootstrap.license(dir)
+        expect(File).not_to exist( license )
+      end
+
+
+      it "#licence -- Generate LICENSE files for all supported licenses" do
+        FalkorLib::Config::Bootstrap::DEFAULTS[:licenses].keys.each do |lic|
+          # drop for some special cases
+          next if [ 'none', 'BSD', 'CC-by-nc-sa'].include?(lic)
+          authors = "Dummy Author"
+          license = File.join(dir, "LICENSE.#{lic.downcase}")
+          FalkorLib::Bootstrap.license(dir, lic, authors, { :filename => license })
+          expect(File).to exist( license )
+        end
+      end
+
+
     end # context "bootstrap/base"
   end # each
 

data/templates/README/footer_readme.erb

@@ -1,7 +1,7 @@
 <% unless (config[:license].empty? or config[:license] == "none") %>
 ## Licence
 
-This project is released under the terms of the [<%= config[:license] %>](LICENCE) licence. 
+This project is released under the terms of the [<%= config[:license] %>](<%= options[:licensefile] %>) licence.
 
 [![Licence](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:logo]  %>)](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:licenses][ config[:license] ][:url] %>)
 <% end %>

data/templates/README/readme_mkdocs.erb

@@ -0,0 +1,15 @@
+## Contribution
+
+See [`docs/contributing/`](docs/contributing/index.md).
+
+## Documentation
+
+See `docs/`.
+
+The documentation for this project is handled by [`mkdocs`](http://www.mkdocs.org/#installation).
+You might wish to generate locally the docs:
+
+* Install [`mkdocs`](http://www.mkdocs.org/#installation)
+* Preview your documentation from the project root by running `mkdocs serve` and visit with your favorite browser the URL `http://localhost:8000`
+     - Alternatively, you can run `make doc` at the root of the repository.
+* (eventually) build the full documentation locally (in the `site/` directory) by running `mkdocs build`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -474,6 +474,7 @@ files:
 - templates/README/readme_gitflow.erb
 - templates/README/readme_issues.erb
 - templates/README/readme_latex.erb
+- templates/README/readme_mkdocs.erb
 - templates/README/readme_rvm.erb
 - templates/Rakefile/footer_rakefile.erb
 - templates/Rakefile/header_rakefile.erb