falkorlib 0.1.0 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d829cbcd3226f0aaffc657d372f9d79c7f380f
-  data.tar.gz: c7f91a6b8511be9aa191b57c7642235e51e00cc4
+  metadata.gz: 2b4d902ef27725191ab3ba66d8f69d3517910b80
+  data.tar.gz: 9c9aa7810bbab86718bea1388dab130ee7271ddf
 SHA512:
-  metadata.gz: 6fd0c8ebfeec617c3dc92067abde181dfb749961ee5d97e20e60bbc61e020287c136a9a0f65a05e708914616af500b6b34d04352a0429f572cd170fe8643f328
-  data.tar.gz: 8669e8dfc829ecc020ccb9d65a4b8a65c62bf7bf9668883e70156d34bab9d8fd5f89ecf540ef6923966c96c1027ac8bae42432945a44a538783486c5ca53a22a
+  metadata.gz: 207f58fd964609f15bbdaf1cc6c01bb257a4c24ba9d3a64363795505a5d0d6d9baddcdc9683e662f262b26346d42e76601de0d4d24a62723948e78f23d522f69
+  data.tar.gz: efae0b5b5367f13cf32f5dc237be05bab0a359e38299758cba64ab87bc8d2899d953a8366499e6731036a11f672211e35dcac2aea198878c4bf4ec14fad0d90d

data/Gemfile.lock

@@ -1,25 +1,56 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.1.0)
-      git (~> 1.2, >= 1.2.5)
+    falkorlib (0.2.8)
+      awesome_print (~> 1.2)
+      configatron (~> 3.2)
       git_remote_branch (~> 0)
+      minigit (~> 0)
       rake (~> 10.1, >= 10.1.0)
       term-ansicolor (~> 1.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.6)
     awesome_print (1.2.0)
+    backports (3.6.0)
     coderay (1.1.0)
+    configatron (3.2.0)
     diff-lcs (1.1.3)
-    git (1.2.6)
+    ethon (0.7.0)
+      ffi (>= 1.3.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    ffi (1.9.3)
+    gh (0.13.2)
+      addressable
+      backports
+      faraday (~> 0.8)
+      multi_json (~> 1.0)
+      net-http-persistent (>= 2.7)
+      net-http-pipeline
     git_remote_branch (0.3.8)
+    hashr (0.0.22)
+    highline (1.6.21)
+    json (1.8.1)
+    launchy (2.4.2)
+      addressable (~> 2.3)
     method_source (0.8.2)
+    minigit (0.0.4)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    net-http-persistent (2.9.4)
+    net-http-pipeline (1.0.1)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    pusher-client (0.6.0)
+      json
+      websocket (~> 1.0)
     rake (10.3.2)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
@@ -29,19 +60,40 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    rubygems-tasks (0.2.4)
+    safe_yaml (0.9.7)
     slop (3.5.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     tins (1.3.0)
+    travis (1.6.11)
+      addressable (~> 2.3)
+      backports
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      gh (~> 0.13)
+      highline (~> 1.6)
+      launchy (~> 2.1)
+      pry (~> 0.9)
+      pusher-client (~> 0.4)
+      typhoeus (~> 0.6, >= 0.6.8)
+    travis-lint (1.8.0)
+      hashr (~> 0.0.22)
+      safe_yaml (~> 0.9.0)
+    typhoeus (0.6.8)
+      ethon (>= 0.7.0)
+    websocket (1.1.4)
     yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print (~> 1.2)
   bundler (~> 1.0)
   falkorlib!
   pry (~> 0.9)
   rspec (~> 2.7, >= 2.7.0)
+  rubygems-tasks (~> 0.2)
+  travis (~> 1.6)
+  travis-lint (~> 1.8)
   yard (~> 0.8)

data/README.md

@@ -1,31 +1,129 @@
 -*- mode: markdown; mode: auto-fill; fill-column: 80 -*-
 
-        Time-stamp: <Thu 2012-09-27 16:24 svarrette>
+        Time-stamp: <Ven 2014-06-06 16:59 svarrette>
+                    _____     _ _              _     _ _
+                   |  ___|_ _| | | _____  _ __| |   (_) |__
+                   | |_ / _` | | |/ / _ \| '__| |   | | '_ \
+                   |  _| (_| | |   < (_) | |  | |___| | |_) |
+                   |_|  \__,_|_|_|\_\___/|_|  |_____|_|_.__/
 
--------------------------------------------
-* File:   	 `README.md`
-* Author:  	 Sebastien Varrette (<mailto:Sebastien.Varrette@uni.lu>)
-* Copyright: Copyright (c) 2012 [Sebastien Varrette](mailto:<Sebastien.Varrette@uni.lu>) [www](http://varrette.gforge.uni.lu) 
-* License:   MIT -- see `LICENCE.md`
+       
+        Copyright (c) 2012-2014 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+        https://github.com/Falkor/falkorlib
 
--------------------
 
 # FalkorLib
 
+[![Build Status](https://travis-ci.org/Falkor/falkorlib.png)](https://travis-ci.org/Falkor/falkorlib)
+
 Sebastien Varrette aka Falkor's Common library to share Ruby code and `{rake,cap}`
 tasks. 
 
+* [Official Gem site](https://rubygems.org/gems/falkorlib)
+* [GitHub](https://github.com/Falkor/falkorlib)
+
 ## Installation
 
-## Pre-requisite
+You'll typically want to install FalkorLib using [Bundler](http://bundler.io/).
+To do this, simply add this line to your application's `Gemfile`:
+
+	gem 'falkorlib'
+	
+And then execute:
+
+	$> bundle
+
+Or install it yourself as:
+
+	$> gem install falkorlib
+
+**Note** you probably wants to do the above within an isolated environment. See below for some explanation on this setup. 
+
+## Usage 
+
+This library features two aspect
+
+* A set of toolbox functions / components I'm using everywhere in my Ruby developments, more specifically a set of modules: 
+  * `FalkorLib::Common`: Recipe for all my toolbox and versatile Ruby functions I'm using everywhere. 
+    You'll typically want to include the `FalkorLib::Common` module to bring the corresponding definitions into your scope. Example:
+       
+			require 'falkorlib'
+			include FalkorLib::Common
+			
+			info 'exemple of information text'
+			really_continue?
+			run %{ echo 'this is an executed command' }
+			
+			Falkor.config.debug = true
+			run %{ echo 'this is a simulated command that *will not* be executed' }
+			error "that's an error text, let's exit with status code 1"all my toolbox printing functions I'm using everywhere 
+    
+    
+  * `FalkorLib::Config`: all configuration aspects, implemented using [configatron](https://github.com/Falkor/falkorlib). `FalkorLib.config` canbe used to customized the defaults settings, for instance by; 
+    
+    		FalkorLib.config do |c|
+            	c.debug = true
+        	end
+  	
+   	 
+  * `FalkorLib::Git`: all git operations
+  * `FalkorLib::Version`: versioning management 
+
+* Some [rake](https://github.com/jimweirich/rake) tasks to facilitate common operations.
+  In general you can simply embedded my tasks by adding the following header in your `Rakefile`:
+  
+  		# In Rakefile
+		require "falkorlib/<object>_tasks"
+  
+  or 
+  
+  		#In Rakefile 
+  		require "falkorlib/tasks/<object>"
+
+### `FalkorLib` Ruby Modules / Classes Documentation
+
+[Online documentation](https://rubygems.org/gems/falkorlib) is a available. 
+Yet to get the latest version, you might want to run 
+
+	$> rake yard:doc
+
+This will generate the documentation in `doc/api/` folder. 
+
+Statistics on the documentation generation (in particular *non*-documented components) can be obtained by 
+
+	$> rake yard:stats 
+
+
+### Overview of the implemented Rake tasks
+
+You can find the list of implemented Rake tasks (detailed below) in the `lib/falkorlib/*_tasks.rb` files
+
+For a given task object `<obj>` (*git* tasks for instance as proposed in `lib/falkorlib/git_tasks.rb`), you can specialize the corresponding configuration by using the block construction of `FalkorLib.config do |c| ... end` **before** requiring the task file:
+
+	# In Rakefile
+	require 'falkorlib'
+	
+	# Configuration for the 'toto' tasks
+	FalkorLib.config.toto do |c|
+		toto.foo = bar   # see `rake falkorlib:conf` to print the current configuration of FalkorLib
+	end 
+	
+	require "falkorlib/tasks/toto"    # OR require "falkorlib/toto_tasks"
+
+
+## Proposed Rake tasks
 
-The Git branching model for this repository follows the guidelines of
-[gitflow](http://nvie.com/posts/a-successful-git-branching-model/) and is
-detailed below. Therefore, you should have `git-flow` installed on your machine
-following the
-[git-flow installation guide](https://github.com/nvie/gitflow/wiki/Installation). 
 
-### Building the gem from the source
+* **Gem Management**: see `lib/falkorlib/tasks/gem.rake`
+* **Git Management**
+* ... TODO: complete list		
+
+
+## Implementation details
+
+If you want to contribute to the code, you shall be aware of the way I organize this gem and implementation details.   
+
+### [RVM](https://rvm.io/) setup
 
 Get the source of this library by cloning the repository as follows: 
 
@@ -49,41 +147,55 @@ Then install the required dependent gems as follows:
 
     $> bundle install 
 
-### Gem installation 
 
-Add this line to your application's Gemfile:
+### Git Branching Model
 
-    gem 'falkorlib'
+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: 
 
-And then execute:
+* `production`: the branch holding tags of the successive releases of this tutorial
+* `devel`: 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 repo, and the one on which developments will take places. 
 
-    $ bundle
+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). 
+Also, to facilitate the tracking of remote branches, you probably wants to install [grb](https://github.com/webmat/git_remote_branch) (typically via ruby gems). 
 
-Or install it yourself as:
+Then, to make your local copy of the repository ready to use my git-flow workflow, you have to run the following commands once you cloned it for the first time:
 
-    $ gem install falkorlib
+      $> rake setup # Not yet implemented!
 
-## Usage
+### Working in a separate project
 
-TODO: Write usage instructions here
+To illustrate the usage of the library as a regular user would do, you are advised to dedicate a directory for your tests. Here is for instance the layout of my testing directory:
 
+	$> cd FalkorLibTests
+	$> tree .
+	.
+	├── Gemfile
+	├── Gemfile.lock
+	├── Rakefile
+	└── test
+    	└── tester.rb  # in a subdirectory on purpose
 
-## Git Branching Model
+	$> cat cat Gemfile 
+	source "https://rubygems.org"
+	gem 'falkorlib', :path => '~/git/github.com/Falkor/falkorlib'   # or whichever path that works for you
 
-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: 
+Adapt the `Rakefile` and `tester.rb` file to reflect your tests.
 
-* `production`: the branch holding tags of the successive releases of this tutorial
-* `devel`: 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 repo, 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). 
-Also, to facilitate the tracking of remote branches, you probably wants to install [grb](https://github.com/webmat/git_remote_branch) (typically via ruby gems). 
+### RSpec tests
 
-Then, to make your local copy of the repository ready to use my git-flow workflow, you have to run the following commands once you cloned it for the first time:
+I try to define a set of unitary tests to validate the different function of my library using [Rspec](http://rspec.info/)
 
-      $> rake setup # Not yet implemented!
+You can run these tests by issuing:
+
+	$> rake rspec
+	
+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 (see `lib/falkorlib/tasks/rspec.rake`) for details.   
+
+
+**Important** Kindly stick to this convention, and feature tests for all definitions/classes/modules you might want to add to `FalkorLib`.
 
-Note that it assumes you have installed `grb`
 
 ## Contributing
 
@@ -115,4 +227,5 @@ You should become familiar (if not yet) with Git. Consider these resources:
 
 ### Links
 
-https://github.com/Falkor/falkorlib
+* [Official Gem site](https://rubygems.org/gems/falkorlib)
+* [GitHub](https://github.com/Falkor/falkorlib)

data/Rakefile

@@ -1,6 +1,6 @@
 ##############################################################################
 # Rakefile - Configuration file for rake (http://rake.rubyforge.org/)
-# Time-stamp: <Lun 2014-06-02 14:58 svarrette>
+# Time-stamp: <Jeu 2014-06-19 18:51 svarrette>
 #
 # Copyright (c) 2012 Sebastien Varrette <Sebastien.Varrette@uni.lu>
 # .             http://varrette.gforge.uni.lu
@@ -15,31 +15,50 @@
 # Resources:
 # * http://www.stuartellis.eu/articles/rake/
 ##############################################################################
-require "bundler/gem_tasks"
 
+task :default => [ :build, :rspec ]
+#.....................
+require 'rake/clean'
 
-# We run tests by default
-task :default => :test
+CLEAN.add   'pkg'
+CLOBBER.add 'doc'
 
-#
-# Install all tasks found in tasks folder
-#
-# See .rake files there for complete documentation.
-#
-RAKE_TASKS_TO_LOAD = [
-                      #'debug_mail.rake',
-                      'gem.rake',
-                      'spec_test.rake',
-                      #'unit_test.rake',
-                      'yard.rake'
-                     ] 
-
-Dir["tasks/*.rake"].each do |taskfile|
-	next unless RAKE_TASKS_TO_LOAD.include?(taskfile.gsub(/.*tasks\//, ''))
-	load taskfile
+#.....................
+#namespace :gem do
+require 'rubygems/tasks'
+Gem::Tasks.new do |tasks|
+    tasks.console.command = 'pry'
+    tasks.sign.checksum   = true
+    tasks.sign.pgp        = true
+end
+#end # namespace gem
+
+#__________________ My own rake tasks __________________
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "falkorlib"
+
+# Adapt the versioning aspects
+FalkorLib.config.versioning do |c|
+	c[:type] = 'gem'
+end
+
+# Adapt the Git flow aspects
+FalkorLib.config.gitflow do |c|
+	c[:branches] = { 
+		:master  => 'production',
+		:develop => 'devel'
+	} 
 end
 
-desc "clean the directory"
-task :clean => :clobber_package do
-	sh "rm -rf doc" if File.directory?("doc")
+
+
+[ 'rspec', 'yard', 'git', 'gitflow' ] .each do |tasks|
+    load "falkorlib/tasks/#{tasks}.rake"
 end
+
+# desc "clean the directory"
+# task :clean => :clobber_package do
+#   sh "rm -rf doc" if File.directory?("doc")
+# end

data/falkorlib.gemspec

@@ -94,9 +94,6 @@ Gem::Specification.new do |s|
 	#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) }
-  
-
-
 
     # The path in the gem for executable scripts (optional)
     #
@@ -128,9 +125,12 @@ Gem::Specification.new do |s|
 	#s.add_dependency("rake", ">= 10.1.0")
 	s.add_runtime_dependency 'rake', '~> 10.1', '>= 10.1.0'
 	s.add_runtime_dependency 'git_remote_branch', '~> 0'
-	#s.add_dependency("git_remote_branch")
-	s.add_runtime_dependency 'git', '~> 1.2', '>= 1.2.5'
-	s.add_dependency("term-ansicolor", "~> 1.3")
+	#s.add_runtime_dependency 'git', '~> 1.2', '>= 1.2.5'
+	s.add_runtime_dependency('minigit', '~> 0')
+	s.add_runtime_dependency("term-ansicolor", "~> 1.3")
+	s.add_runtime_dependency("configatron",    "~> 3.2")
+	s.add_runtime_dependency("awesome_print", "~> 1.2")
+
 
     #
     # One call to add_dependency('gem_name', 'gem version requirement') for each
@@ -143,7 +143,11 @@ Gem::Specification.new do |s|
 	s.add_development_dependency 'rspec', '~> 2.7', '>= 2.7.0'
 	s.add_development_dependency("pry",    "~> 0.9")
     s.add_development_dependency("yard",   "~> 0.8")
-	s.add_development_dependency("awesome_print", "~> 1.2")
+    #s.add_development_dependency("minitest",   "~> 5.3")
+    s.add_development_dependency("rubygems-tasks",   "~> 0.2")
+    s.add_development_dependency("travis",        "~> 1.6")
+    s.add_development_dependency("travis-lint",   "~> 1.8")
+	
     #s.add_development_dependency("bluecloth",      "~> 2.2.0")
     #s.add_development_dependency("wlang",          "~> 0.10.2")