falkorlib 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e14ab75d651ae33dfe78da74a5e623d6a23fd21
-  data.tar.gz: 7ff9f11d726cea70ad491d32e4386a8d62f5a92d
+  metadata.gz: b3016d72370c962b095a38b6c661376d8c5937f4
+  data.tar.gz: f7085f04b36a1da05630dedafd8ab66c51db9bc9
 SHA512:
-  metadata.gz: d6df092451077e14d6f4244fbf975bc8d9161be626c0cc889bab163fda1113065cd21178b4a6a4979df1b5ce44de5b73a590746755b5925fe502393ce32e9685
-  data.tar.gz: 67530e57d95dd6227bd01365b9f1dee063761fff27120b1f78a3e69c0fa99344daff3c213492820ac7f501a24aac629ca62e10274602374f03457fe1cd76f5c1
+  metadata.gz: 81b1c0874548dfe44c7a2f7a9485ccdf95b4d1e1b978d024570494c6a6a330f9ad3f3f749b480f7297778219465f39f401fbb6f19f7cbb151f2d2a337e2cfb13
+  data.tar.gz: 3ee861b38638d8138b190e4f2debc5949c0b918de6a6c10445f81a0b6dfe33dfd2ace0324bd8de2e43ca1a1b262bd5b818905917280ae54d01e8fa17a3d05937

data/.Manifest.txt

@@ -0,0 +1,15 @@
+falkorlib.gemspec
+.falkorlib.noespec
+.gemtest
+CHANGELOG.md
+Gemfile
+Gemfile.lock
+bin/**/*
+lib/**/*
+LICENCE.md
+Manifest.txt
+Rakefile
+README.md
+spec/**/*
+tasks/**/*
+test/**/*

data/.gitignore

@@ -0,0 +1,11 @@
+coverage/*
+*.DS_Store
+pkg
+doc/api
+.yardoc
+.bundle
+.rvmrc
+.ruby-*
+*~
+tmp/
+*.noespec

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+cache: bundler
+bundler_args: "--without=release doc"
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -y git-flow git-core
+rvm:
+ - 1.9.2
+ - 1.9.3
+ - 2.0.0
+ - 2.1.1
+ - 2.1.2
+ - rbx-2.2.7
+notifications:
+  hipchat:
+    rooms:
+      secure: E0V9xQtCyPSB+SZ5n+ztdM5tzJ7d1eR+XR1gIBfAwe0JYnRb735B1v0Z3CVBmosKpv16KEoKUDjum1vHGk8fnOOcxoHx+TtTCF1TVpuBtKzXqG6t4YZAYjkGSIBUM1Zd7kXLlsdmdwRToGmKRqblQHutnm0LkyII/CAwaO+UeY8=
+# addons:
+#   code_climate:
+#     repo_token: 
+#       secure: "ZBtaK84ZnjyT4X7mGSYDx31HgD94nZccxAzKA2SBjakW/hfsx9sBGOusxYN7EuC6JydjwLFN3MwLfEGMgjC1zxNwvLO9PGQbh52QawKBue09qouitJbOODwUfQgzNHj/Z0x3dMv3X1Qz31gbfDaC6DJsnTtG2q7R7Kni8hq4/FU="

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.3.6)
+    falkorlib (0.3.7)
       awesome_print (~> 1.2)
       configatron (~> 3.2)
       diffy (>= 3.0)

data/binscripts/bootstrap.sh

@@ -0,0 +1,47 @@
+#! /bin/bash
+################################################################################
+# bootstrap.sh - Bootstrap a fresh new directory for using FalkorLib and its
+#    associated Rake tasks. 
+# Creation : 26 Jun 2014
+# Time-stamp: <Jeu 2014-06-26 11:33 svarrette>
+#
+# Copyright (c) 2014 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+#               http://varrette.gforge.uni.lu
+################################################################################
+
+RUBY_VERSION='2.1.0' 
+GEMSET=`basename $PWD`
+
+echo "=> initialize RVM -- see http://rvm.io"
+[ ! -f .ruby-version ] && echo ${RUBY_VERSION} > .ruby-version
+rvm install `cat .ruby-version`
+[ ! -f .ruby-gemset ] && echo ${GEMSET} > .ruby-gemset
+
+echo "=> Force reloading RVM configuration within $PWD"
+cd .. && cd -
+
+echo "=> installing the Bundler gem -- see http://bundler.io"
+gem install bundler
+
+echo "=> setup the FalkorLib gem in the directory ${GEMSET}"
+bundle init
+if ! grep -Fq "falkorlib" Gemfile; then 
+    echo "gem 'falkorlib'" >> Gemfile
+fi
+bundle
+if [ ! -f Rakefile ]; then 
+cat > Rakefile <<EOF
+#
+# Rakefile - Configuration file for rake (http://rake.rubyforge.org/)
+#
+require 'falkorlib'
+
+## placeholder for custom configuration of FalkorLib.config.*
+## See https://github.com/Falkor/falkorlib
+   
+require 'falkorlib/tasks/git'
+EOF
+
+fi 
+
+#echo "=> That's all folks!"

data/falkorlib.gemspec

@@ -81,17 +81,17 @@ Gem::Specification.new do |s|
     # of the project. Entries of the manifest are interpreted as Dir[...]
     # patterns so that lazy people may use wilcards like lib/**/*
     #
-    here = File.expand_path(File.dirname(__FILE__))
-    s.files = File.readlines(File.join(here, '.Manifest.txt')).
-        inject([]){|files, pattern| files + Dir[File.join(here, pattern.strip)]}.
-        collect{|x| x[(1+here.size)..-1]}
+    # here = File.expand_path(File.dirname(__FILE__))
+    # s.files = File.readlines(File.join(here, '.Manifest.txt')).
+    #     inject([]){|files, pattern| files + Dir[File.join(here, pattern.strip)]}.
+    #     collect{|x| x[(1+here.size)..-1]}
 
     # Test files included in this gem.
     #
     s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
 
 	# Alternative: 
-	#s.files         = `git ls-files`.split("\n")
+	s.files         = `git ls-files`.split("\n")
 	#s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 	#s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 

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

data/templates/puppet/modules/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+.vagrant
+/.bundle/*
+.ruby-*
+.falkorlib.yaml
+/pkg/*

data/templates/puppet/modules/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+# gem "rails"
+gem 'falkorlib' #, :path => '~/git/github.com/Falkor/falkorlib'
+gem "puppet"

data/templates/puppet/modules/README.md.erb

@@ -0,0 +1,87 @@
+-*- mode: markdown; mode: auto-fill; fill-column: 80 -*-
+
+# <%= config[:name].gsub(/.*-/, '').capitalize %> Puppet Module 
+
+[![Puppet Forge](http://img.shields.io/puppetforge/v/<%= config[:name].gsub(/-/,"/") %>.svg)](<%= config[:forge_url] %>)
+[![License](http://img.shields.io/:license-<%= config[:license].gsub(/-/, '') %>-blue.svg)](LICENSE)
+![Supported Platforms](http://img.shields.io/badge/platform-<%= config[:platforms].join('|') %>-lightgrey.svg)
+
+<%= config[:summary] %>
+
+
+      Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
+      
+
+* [Online Project Page](<%= config[:project_page] %>)  -- [Sources](<%= config[:source] %>) -- [Issues](<%= config[:issues_url] %>)
+
+## Synopsis
+
+<%= config[:description] %>
+
+The various operations of this repository are piloted from a `Rakefile` which
+assumes that you have [RVM](https://rvm.io/) installed on your system.
+
+## Dependencies
+
+See `metadata.json`.
+
+## <%= config[:name].gsub(/.*-/, '') %> class parameters
+
+* `$ensure` [Default: 'present']: Ensure <%= config[:name].gsub(/^puppet-/,'')
+  %> is present, absent etc. 
+
+## Usage
+
+### class <%= config[:name].gsub(/.*-/, '') %>
+
+     include '<%= config[:name].gsub(/.*-/,'') %>'
+
+
+## Documentation
+
+Please refer to the header of each manifest files to understand the usage of
+classes and definitions associated to the '<%= config[:name] %>' module.
+ 
+Alternatively, generate automatically the documentation via
+[`puppet doc`](http://docs.puppetlabs.com/man/doc.html) as follows:  
+
+       $> rake doc   # Not yet implemented
+       
+For other information, please refer to the `metadata.json` file in this directory 
+
+## Librarian-Puppet / R10K Setup
+
+You can of course configure <%= config[:name] %> in your `Puppetfile` to make it 
+available with [Librarian puppet](http://librarian-puppet.com/) or
+[r10k](https://github.com/adrienthebo/r10k) by adding the following entry:
+
+     mod <%= config[:name] %>, 
+         :git => <%= config[:source] %>,
+         :ref => <%= FalkorLib.config[:gitflow][:branches][:master] %> 
+
+
+## Issues / Feature request
+
+You can submit bug / issues / feature request using the 
+[<%= config[:name] %> Tracker](<%= config[:issues_url] %>). 
+
+
+## Developments / Contributing to the code 
+
+If you want to contribute to the code, you shall be aware of the way this module
+is organized.
+These elements are detailed on [`doc/contributing.md`](doc/contributing.md)
+
+You are more than welcome to contribute to its development by 
+[sending a pull request](https://help.github.com/articles/using-pull-requests). 
+
+## Resources
+
+### Git 
+
+You should become familiar (if not yet) with Git. Consider these resources: 
+
+* [Git book](http://book.git-scm.com/index.html)
+* [Github:help](http://help.github.com/mac-set-up-git/)
+* [Git reference](http://gitref.org/)
+

data/templates/puppet/modules/Rakefile

@@ -0,0 +1,28 @@
+#
+# Rakefile - Configuration file for rake (http://rake.rubyforge.org/)
+#
+require 'falkorlib'
+
+## placeholder for custom configuration of FalkorLib.config.*
+## See https://github.com/Falkor/falkorlib
+
+# Adapt the versioning aspects
+FalkorLib.config.versioning do |c|
+	c[:type] = 'puppet_module'
+end
+
+# Adapt the Git flow aspects
+FalkorLib.config.gitflow do |c|
+	c[:branches] = { 
+		:master  => 'production',
+		:develop => 'devel'
+	} 
+end
+
+ 
+require 'falkorlib/tasks/git'
+require 'falkorlib/tasks/puppet'
+
+##############################################################################
+#TOP_SRCDIR = File.expand_path(File.join(File.dirname(__FILE__), "."))
+

data/templates/puppet/modules/doc/contributing.md.erb

@@ -0,0 +1,140 @@
+-*- mode: markdown; mode: auto-fill; fill-column: 80 -*-
+
+# <%= config[:name].gsub(/.*-/, '').capitalize %> Puppet Module Developments
+
+If you want to contribute to the code, you shall be aware of the way this module
+is organized.   
+
+### Directory Layout
+
+       <%= config[:name] %>/       # Main directory 
+           `-- metadata.json     # Module configuration - cf [here](https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file)
+           `-- README.md         # This file
+           `-- files/            # Contains static files, which managed nodes can download
+           `-- lib/              # custom facts/type/provider definitions
+           `-- manifests/
+                `-- init.pp      # Main manifests file
+                `-- classes/     # Hold manifest for <%= config[:name] %> classes/
+                     `-- <%= config[:name] %>.pp         # defines the <%= config[:name] %> class
+                     `-- <%= config[:name] %>-params.pp  # <%= config[:name] %> module variables 
+                `-- definitions/ # Hold manifest for <%= config[:name] %> definitions
+                     `-- <%= config[:name] %>-mydef.pp   # defines the <%= config[:name] %>::mydef definition   `-- templates/        # Module ERB template files
+           `-- tests/            # Contains examples showing how to declare the module’s classes and defined type
+           `-- spec/             # Contains spec tests for any plugins in the lib directory
+           `-- Rakefile          # Definition of the [rake](https://github.com/jimweirich/rake) tasks
+           `-- .ruby-{version,gemset}   # [RVM](https://rvm.io/) configuration
+           `-- Gemfile[.lock]    # [Bundler](http://bundler.io/) configuration
+           `-- .git/             # Hold git configuration
+
+### Git Branching Model
+
+The Git branching model for this repository follows the guidelines of
+[gitflow](http://nvie.com/posts/a-successful-git-branching-model/).  
+In particular, the central repository holds two main branches with an infinite
+lifetime:  
+
+* `<%= FalkorLib.config[:gitflow][:branches][:master] %>`: the branch holding
+  tags of the successive releases of this tutorial 
+* `<%= FalkorLib.config[:gitflow][:branches][:develop] %>`: the main branch
+  where the sources are in a state with the latest delivered development changes 
+  for the next release. This is the *default* branch you get when you clone the
+  repository, and the one on which developments will take places.  
+
+You should therefore install [git-flow](https://github.com/nvie/gitflow), and
+probably also its associated
+[bash completion](https://github.com/bobthecow/git-flow-completion).  
+
+### Ruby, [RVM](https://rvm.io/) and [Bundler](http://bundler.io/)
+
+The various operations that can be conducted from this repository are piloted
+from a `Rakefile` and assumes you have a running Ruby installation.
+
+The bootstrapping of your repository is based on [RVM](https://rvm.io/), **thus
+ensure this tools are installed on your system** -- see
+[installation notes](https://rvm.io/rvm/install).
+
+The ruby stuff part of this repository corresponds to the following files:
+
+* `.ruby-{version,gemset}`: [RVM](https://rvm.io/) configuration, use the name of the
+  project as [gemset](https://rvm.io/gemsets) name
+* `Gemfile[.lock]`: used by `[bundle](http://bundler.io/)`
+
+You should now be able to access the list of available tasks by running:
+
+	$> rake -T
+
+You probably wants to activate the bash-completion for rake tasks.
+I personnaly use the one provided [here](https://github.com/ai/rake-completion)
+
+Also, some of the tasks are hidden. Run `rake -T -A` to list all of them. 
+
+### Repository Setup
+
+Then, to make your local copy of the repository ready to use the
+[git-flow](https://github.com/nvie/gitflow) workflow and the local
+[RVM](https://rvm.io/)  setup, you have to run the following commands once you
+cloned it for the first time: 
+
+      $> rake setup 
+
+### RSpec tests
+
+A set of unitary tests are defined to validate the different function of my
+library using [Rspec](http://rspec.info/) 
+
+You can run these tests by issuing:
+
+	$> rake rspec  # NOT YET IMPLEMENTED
+	
+By conventions, you will find all the currently implemented tests in the `spec/`
+directory, in files having the `_spec.rb` suffix. This is expected from the
+`rspec` task of the `Rakefile`.    
+
+**Important** Kindly stick to this convention, and feature tests for all
+  definitions/classes/modules you might want to add. 
+
+### Releasing mechanism
+
+The operation consisting of releasing a new version of this repository is
+automated by a set of tasks within the `Rakefile`. 
+
+In this context, a version number have the following format:
+
+      <major>.<minor>.<patch>
+
+where:
+
+* `< major >` corresponds to the major version number
+* `< minor >` corresponds to the minor version number
+* `< patch >` corresponds to the patching version number
+
+Example: `1.2.0`
+
+The current version number is stored in the file `metadata.json`. 
+For more information on the version, run:
+
+     $> rake version:info
+
+If a new  version number such be bumped, you simply have to run:
+
+      $> rake version:bump:{major,minor,patch}
+
+This will start the release process for you using `git-flow`.
+Then, to make the release effective, just run:
+
+      $> rake version:release
+
+This will finalize the release using `git-flow`, create the appropriate tag and
+merge all things the way they should be. 
+
+# Contributing Notes
+
+This project is released under the terms of the [<%= config[:license] %> Licence](LICENSE). 
+So you are more than welcome to contribute to its development as follows: 
+
+1. Fork it
+2. Create your feature branch (`rake git:feature:start[<feature_name>]`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git flow feature publish <feature_name>`)
+5. Create new Pull Request
+

data/templates/puppet/modules/files/README.md

@@ -0,0 +1,21 @@
+Files
+=====
+
+Puppet comes with both a client and server for copying files around. The file
+serving function is provided as part of the central Puppet daemon,
+puppetmasterd, and the client function is used through the source attribute of
+file objects. Learn more [here](http://projects.puppetlabs.com/projects/puppet/wiki/File_Serving_Configuration)
+
+You can use managed files like this:
+
+    class <%= config[:name] %> {
+      package { <%= config[:name].gsub(/^puppet-/, '') %>: ensure => latest }
+      file { "/etc/<%= config[:name] %>.conf":
+        source => "puppet://$servername/modules/<%= config[:name] %>/myfile"
+      }
+    }
+
+The files are searched for in:
+	
+	$modulepath/<%= config[:name] %>/files/myfile
+