falkorlib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07d829cbcd3226f0aaffc657d372f9d79c7f380f
+  data.tar.gz: c7f91a6b8511be9aa191b57c7642235e51e00cc4
+SHA512:
+  metadata.gz: 6fd0c8ebfeec617c3dc92067abde181dfb749961ee5d97e20e60bbc61e020287c136a9a0f65a05e708914616af500b6b34d04352a0429f572cd170fe8643f328
+  data.tar.gz: 8669e8dfc829ecc020ccb9d65a4b8a65c62bf7bf9668883e70156d34bab9d8fd5f89ecf540ef6923966c96c1027ac8bae42432945a44a538783486c5ca53a22a

data/.falkorlib.noespec

@@ -0,0 +1,321 @@
+#
+# This file provides a full specification for maintaining your ruby library using Noe.
+# It consists of two main sections: template-info and variables. The first one contains
+# meta-information about the skeleton itself while the second one provides information
+# about your library.
+#
+# Please update the first part with care, as it immediately affects the way Noe will
+# manage the files of your own project. The second part may be updated more freely.
+#
+# Remember that your project may use a shorter version of this file as it will be
+# automatically completed with default options when invoking 'noe go'. In particular,
+# the first section (under template-info) is only required to contain the name and
+# version of the template to use.
+#
+# Use 'noe prepare --template=ruby --layout=short' to generate a shorter
+# version of this file.
+#
+# See 'noe help prepare' and 'noe help show-spec' for more information.
+#
+template-info:
+
+  # Don't remove the name and version entries, which are ALWAYS required
+  name: "ruby"
+  version: 1.7.0
+
+  # The following entries are information about the template itself and can safely
+  # be removed on your own project.
+  summary: |
+    Template for creating a ruby gem following best ruby practices
+  description: |
+    This is a [Noe](https://github.com/blambeau/noe) template for creating a ruby gem
+    library. Generated project comes with rake tasks to support the lifecycle of the
+    library (testing, releasing, and so on). Following Noe philosophy this template
+    also helps you understanding the ruby ecosystem by providing a fully documented
+    project, rake tasks, and so on.
+  authors:
+    - {name: Bernard Lambeau, email: blambeau@gmail.com}
+  links:
+    source: https://github.com/blambeau/noe/tree/master/templates/ruby
+    documentation: https://github.com/blambeau/noe/blob/master/templates/ruby/README.md
+
+  #
+  # Below starts the template manifest.
+  #
+  # Each entry is related to a template file and may contain the following keys:
+  #   - description: short explanation of the role the file plays in your project
+  #   - safe-override: may the file be safely overrided by 'noe go --safe-override'?
+  #   - wlang-dialect: what dialect must be used for wlang instantiation. When no
+  #     dialect is specified, the dialect under main-wlang-dialect is used.
+  #
+  # You can safely remove the whole manifest or entries for which the default values
+  # are ok for your project. Otherwise, values defined below override the default ones
+  # provided by the template.
+  #
+  # An typical example for keeping an entry here is to set safe-override to false for
+  # specific project files you want to manage manually.
+  #
+  manifest:
+    .gitignore:
+      description: Files to be ignored by git or another version control system
+      safe-override: false
+    .travis.yml:
+      description: Build matrix for continuous integration on travis-ci.org
+      safe-override: false
+    __lower__.gemspec:
+      description: Gem specification file
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    CHANGELOG.md:
+      description: Information about library changes
+      safe-override: false
+    Gemfile:
+      description: Information used by Bundler, the Ruby dependency manager
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    lib/__lower__.rb:
+      description: Main file of the ruby library
+      safe-override: false
+    lib/__lower__/version.rb:
+      description: Handler for the version number for the library
+      safe-override: true
+    lib/__lower__/loader.rb:
+      description: Dependency loader for the ruby library
+      safe-override: true
+    LICENCE.md:
+      description: Licensing information
+      safe-override: false
+    Manifest.txt:
+      description: Information about the files that compose the package
+      safe-override: false
+    Rakefile:
+      description: Information for Ruby maker
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    README.md:
+      description: Starter documentation file
+      safe-override: false
+    spec/__lower__spec.rb:
+      description: Main test file of the ruby library
+      safe-override: false
+    spec/spec_helper.rb:
+      description: Helper for ruby spec tests
+      safe-override: false
+    tasks/debug_mail.rake:
+      description: configuration file for 'rake debug_mail'
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    tasks/debug_mail.txt:
+      description: mail template used by 'rake debug_mail'
+      safe-override: true
+      wlang-dialect: wlang/dummy
+    tasks/gem.rake:
+      description: configuration file for 'rake package', 'rake gem' and associated tasks
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    tasks/spec_test.rake:
+      description: configuration file for 'rake spec_test'
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    tasks/unit_test.rake:
+      description: configuration file for 'rake unit_test'
+      safe-override: true
+      wlang-dialect: wlang/ruby
+    tasks/yard.rake:
+      description: configuration file for 'rake yard'
+      safe-override: true
+      wlang-dialect: wlang/ruby
+
+# The following entries are template-related variables. Update to match your
+# own configuration.
+variables:
+  # A ruby lower case project name. This will become the name of the generated
+  # gem of the main ruby .rb start file and so on.
+  lower:
+    falkorlib
+
+  # A ruby upper case project name. This is used to generate the main namespacing
+  # module of your project and shoul be the CamelCase equivalent of your lower
+  # name.
+  upper:
+    FalkorLib
+
+  # Version of your library
+  version:
+    0.1.0
+
+  # Project summary (~ 1 line)
+  summary: |-
+    Sebastien Varrette aka Falkor's Common library to share Ruby code and {rake,cap} tasks
+
+  # Project description (~ 5 lines). Project description should be more complete
+  # than the summary and will be used to describe your gem on rubygems.org
+  description: |-
+    This is my personal library I use to share the Ruby tidbits, Rake and Capistrano tasks I made for my various projects. 
+    This is also my first gem so any comments on the code/organization are welcome, I'm a newbie in this domain. 
+    Note that I used [Noe](https://github.com/blambeau/noe) to bootstrap this project and get a fully documented environment.
+
+
+
+  # Authors of the project. Each author entry is a Hash and MUST at least have
+  # 'name' and 'email' keys. This is used to add meta information to your .gemspec
+  # file. Example:
+  #
+  # authors:
+  #  - name:  Bob
+  #    email: bob@gmail.com
+  #
+  authors: 
+    - name:  Sebastien Varrette
+      email: Sebastien.Varrette@uni.lu
+
+  # Web links for the project. You should typically include links to the sources
+  # (github), rubygems.org, documentation and so on. The first link will be used
+  # to fill the .gemspec file. Example:
+  #
+  # links:
+  #   - http://github.com/bob/hello_world
+  #   - http://rubygems.org/gems/hello_world
+  #
+  links: 
+    - https://github.com/Falkor/falkorlib
+
+  # Gem dependencies. Each entry is a Hash that MUST at least have 'name', 'version'
+  # and 'groups' keys. The later is an array of dependency groups and are used to
+  # generate Gemfile and .gemspec files. For now, only 'development' and 'runtime'
+  # values are supported.
+  #
+  # Example
+  #   # Rake is required for development only
+  #   - {name: rake, version: "~> 0.8.7", groups: [development]}
+  #   # HighLine is required at runtime
+  #   - {name: highline, version: ">= 0", groups: [runtime]}
+  #   # WLang is required for both development and runtime
+  #   - {name: wlang, version: ">= 0", groups: [runtime, development]}
+  #
+  dependencies:
+    # Rake is required for developers, as usual
+    - {name: rake,      version: "~> 0.9.2", groups: [development]}
+    # Bundler is required for developers and is used by the Rakefile
+    - {name: bundler,   version: "~> 1.0",   groups: [development]}
+    # RSpec is required to run 'rake spec'. See tasks/spec.rake
+    - {name: rspec,     version: "~> 2.7.0", groups: [development]}
+    # YARD and BlueCloth are required to run 'rake yard'. See tasks/yard.rake
+    - {name: yard,      version: "~> 0.7.2", groups: [development]}
+    - {name: bluecloth, version: "~> 2.2.0", groups: [development]}
+    # wlang is required to run 'rake debug_mail'. See tasks/debug_mail.rake
+    - {name: wlang,     version: "~> 0.10.2", groups: [development]}
+
+
+  # Below are defined a certain number of specific variables for the .gemspec file
+  # of your library. We'll include it here to keep .gemspec under Noe's control for
+  # simple yet flexible cases. If your gem configuration is really specific, you
+  # can always maintain the .gemspec manually by setting
+  # template-info/manifest/__lower__.gemspec/safe-override to false
+  gemspec:
+    # Paths in the gem to add to $LOAD_PATH when the gem is activated (required).
+    require_paths: [ lib ]
+    # The path in the gem for executable scripts
+    bindir: 'bin'
+    # Array containing the names of executables included in the gem,
+    # if any (Dir[...] patterns are supported).
+    executables: [ 'bin/*' ]
+    # Array of test files (Dir[...] patterns are supported).
+    test_files: ['test/**/*', 'spec/**/*']
+    # Array of options to use when invoking rdoc
+    rdoc_options: [ ]
+    # Array of extra files to give to rdoc (Dir[...] patterns are supported)
+    extra_rdoc_files: [ README.md, CHANGELOG.md, LICENCE.md ]
+    # Array of extensions to build when installing the gem.
+    extensions: []
+    # External (to RubyGems) requirements that must be met for this gem to work (informal)
+    requirements:
+    # A friendly message you would like to display when the user installs your gem
+    post_install_message: |
+      Thanks for installing !{upper}. 
+
+  # Below are defined a certain number of specific variables for each rake task.
+  # Have a look at tasks/*.rake for additional details on each one.
+  rake_tasks:
+    gem:
+      # Folder in which the packages are generated
+      package_dir: pkg
+      # Do you need a .tar package?
+      need_tar: false
+      # Do you need a .tar.gz package?
+      need_tar_gz: false
+      # Do you need a .tar.bz2 package?
+      need_tar_bz2: false
+      # Do you need a .zip package?
+      need_zip: false
+      # The shell command executed to build a .tar
+      tar_command: tar
+      # The shell command executed to build a .zip
+      zip_command: zip
+    debug_mail:
+      # Regular expression to detect change sections in
+      # the CHANGELOG file
+      rx_changelog_sections: '/^# /'
+      # Number of change sections to show in the mail
+      nb_changelog_sections: 1
+    spec_test:
+      # Pattern to find spec tests
+      pattern: spec/**/test_*.rb
+      # By default, if there is a Gemfile, the generated command will include
+      # 'bundle exec'. Set this to true to ignore the presence of a Gemfile,
+      # and not add 'bundle exec' to the command.
+      skip_bundler: false
+      # Name of Gemfile to use
+      gemfile: Gemfile
+      # Whether or not to fail Rake when an error occurs (typically when
+      # examples fail).
+      fail_on_error: true
+      # A message to print to stderr when there are failures.
+      failure_message:
+      # Use verbose output. If this is set to true, the task will print the
+      # executed spec command to stdout.
+      verbose: true
+      # Use rcov for code coverage?
+      rcov: false
+      # Path to rcov.
+      rcov_path: rcov
+      # Command line options to pass to rcov. See 'rcov --help' about this
+      rcov_opts: []
+      # Command line options to pass to ruby. See 'ruby --help' about this
+      ruby_opts: []
+      # Path to rspec
+      rspec_path: rspec
+      # Command line options to pass to rspec. See 'rspec --help' about this
+      rspec_opts: [--color, --backtrace]
+    unit_test:
+      # Glob pattern to match test files. (default is 'test/test*.rb')
+      pattern: test/test_*.rb
+      # Array of directories to added to $LOAD_PATH before running the tests.
+      libs: [ lib ]
+      # True if verbose test output desired.
+      verbose: false
+      # Test options passed to the test suite. An explicit TESTOPTS=opts
+      # on the command line will override this.
+      options:
+      # Request that the tests be run with the warning flag set.
+      # E.g. warning=true implies "ruby -w" used to run the tests.
+      warning: false
+      # Style of test loader to use. Options are:
+      #
+      # * :rake -- Rake provided test loading script (default).
+      # * :testrb -- Ruby provided test loading script.
+      # * :direct -- Load tests using command line loader.
+      #
+      loader: :rake
+      # Array of commandline options to pass to ruby when running test loader.
+      ruby_opts: []
+      # Explicitly define the list of test files to be included in a
+      # test.  +list+ is expected to be an array of file names (a
+      # FileList is acceptable).  If both +pattern+ and +test_files+ are
+      # used, then the list of test files is the union of the two.
+      test_files:
+    yard:
+      # Array of ruby source files
+      files: ['lib/**/*.rb']
+      # Array of options passed to yard commandline. See 'yardoc --help' about this
+      options: ['--output-dir', 'doc/api', '-', 'README.md', 'CHANGELOG.md', 'LICENCE.md']

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.1.0 / FIX ME
+
+* Enhancements
+
+  * Birthday!

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    falkorlib (0.1.0)
+      git (~> 1.2, >= 1.2.5)
+      git_remote_branch (~> 0)
+      rake (~> 10.1, >= 10.1.0)
+      term-ansicolor (~> 1.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (1.2.0)
+    coderay (1.1.0)
+    diff-lcs (1.1.3)
+    git (1.2.6)
+    git_remote_branch (0.3.8)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    slop (3.5.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    tins (1.3.0)
+    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)
+  yard (~> 0.8)

data/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.

data/README.md

@@ -0,0 +1,118 @@
+-*- mode: markdown; mode: auto-fill; fill-column: 80 -*-
+
+        Time-stamp: <Thu 2012-09-27 16:24 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`
+
+-------------------
+
+# FalkorLib
+
+Sebastien Varrette aka Falkor's Common library to share Ruby code and `{rake,cap}`
+tasks. 
+
+## Installation
+
+## Pre-requisite
+
+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
+
+Get the source of this library by cloning the repository as follows: 
+
+	$> git clone git://github.com/Falkor/falkorlib.git
+
+You'll end in the `devel` branch. The precise branching model is explained in
+the sequel. 
+
+If you use [RVM](http://beginrescueend.com/), you perhaps wants to create a
+separate gemset so that we can create and install this gem in a clean
+environment. To do that, proceed as follows:
+
+    $> rvm gemset create falkorlib
+    $> rvm gemset use falkorlib
+
+Install bundler if it's not yet done: 
+
+    $> gem install builder
+
+Then install the required dependent gems as follows: 
+
+    $> bundle install 
+
+### Gem installation 
+
+Add this line to your application's Gemfile:
+
+    gem 'falkorlib'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install falkorlib
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## 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: 
+
+* `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). 
+
+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:
+
+      $> rake setup # Not yet implemented!
+
+Note that it assumes you have installed `grb`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Directory Organization
+
+By default, the gem take all files included in the `.Manifest.txt` file on the
+root of the project. Entries of the manifest file are interpreted as `Dir[...]`
+patterns so that lazy people may use wilcards like `lib/**/*` 
+
+__IMPORTANT__ If you want to add a file/directory to this gem, remember to add
+the associated entry into the manifest file `.Manifest.txt`
+
+
+## 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/)
+
+### Links
+
+https://github.com/Falkor/falkorlib