noe 1.1.0 → 1.2.0

data/tasks/spec_test.rake

@@ -1,15 +1,36 @@
+# Installs a rake task for for running examples written using rspec.
 #
-# Install a rake task for running examples written using rspec.
+# This file installs the 'rake spec_test' (aliased as 'rake spec') as well as
+# extends 'rake test' to run spec tests, if any. It is automatically generated 
+# by Noe from your .noespec file, and should therefore be configured there, 
+# under the variables/rake_tasks/spec_test entry, as illustrated below:
 #
-# More information about rspec: http://relishapp.com/rspec
-# This file has been written to conform to RSpec v2.4.0
+# variables:
+#   rake_tasks:
+#     spec_test:
+#       pattern: spec/**/*_spec.rb
+#       verbose: true
+#       rspec_opts: [--color, --backtrace]
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file, 
+# don't forget to set safe-override to false in your noe specification:
+# 
+# template-info:
+#   manifest:
+#     tasks/spec_test.rake:
+#       safe-override: false
+#
+# This file has been written to conform to RSpec v2.4.0. More information about 
+# rspec and options of the rake task defined below can be found on 
+# http://relishapp.com/rspec
 #
 begin
   require "rspec/core/rake_task"
   desc "Run RSpec code examples"
   RSpec::Core::RakeTask.new(:spec_test) do |t|
     # Glob pattern to match files.
-    t.pattern = 'spec/**/*_spec.rb'
+    t.pattern = "spec/**/*_spec.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, 
@@ -17,7 +38,7 @@ begin
     t.skip_bundler = false
 
     # Name of Gemfile to use
-    t.gemfile = 'Gemfile'
+    t.gemfile = "Gemfile"
 
     # Whether or not to fail Rake when an error occurs (typically when 
     # examples fail).
@@ -34,22 +55,19 @@ begin
     t.rcov = false
 
     # Path to rcov.
-    t.rcov_path = 'rcov'
+    t.rcov_path = "rcov"
 
-    # Command line options to pass to rcov.
-    # See 'rcov --help' about this
-    t.rcov_opts = %w{}
+    # Command line options to pass to rcov. See 'rcov --help' about this
+    t.rcov_opts = []
 
-    # Command line options to pass to ruby.
-    # See 'ruby --help' about this 
-    t.ruby_opts = %w{}
+    # Command line options to pass to ruby. See 'ruby --help' about this 
+    t.ruby_opts = []
 
     # Path to rspec
-    t.rspec_path = 'rspec'
+    t.rspec_path = "rspec"
 
-    # Command line options to pass to rspec.
-    # See 'rspec --help' about this
-    t.rspec_opts = %w{--color --backtrace}
+    # Command line options to pass to rspec. See 'rspec --help' about this
+    t.rspec_opts = ["--color", "--backtrace"]
   end
 rescue LoadError => ex
   task :spec_test do

data/tasks/unit_test.rake

@@ -1,8 +1,28 @@
+# Installs a rake task for for running unit tests.
 #
-# Install a rake task for running examples written using rspec.
+# This file installs the 'rake unit_test' and extends 'rake test' to run unit 
+# tests, if any. It is automatically generated by Noe from your .noespec file, 
+# and should therefore be configured there, under the variables/rake_tasks/unit_test 
+# entry, as illustrated below:
 #
-# More information about rspec: http://relishapp.com/rspec
-# This file has been written to conform to RSpec v2.4.0
+# variables:
+#   rake_tasks:
+#     unit_test:
+#       pattern: test/test*.rb
+#       verbose: false
+#       warning: false
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file, 
+# don't forget to set safe-override to false in your noe specification:
+# 
+# template-info:
+#   manifest:
+#     tasks/unit_test.rake:
+#       safe-override: false
+#
+# More info about the TestTask and its options can be found on 
+# http://rake.rubyforge.org/classes/Rake/TestTask.html
 #
 begin
   desc "Lauches unit tests"
@@ -11,21 +31,21 @@ begin
 
     # List of directories to added to $LOAD_PATH before running the
     # tests. (default is 'lib')
-    t.libs = %w{ lib }
+    t.libs = ["lib"]
 
     # True if verbose test output desired. (default is false)
     t.verbose = false
 
     # Test options passed to the test suite.  An explicit TESTOPTS=opts 
     # on the command line will override this. (default is NONE)
-    t.options = []
+    t.options = nil
 
     # Request that the tests be run with the warning flag set.
     # E.g. warning=true implies "ruby -w" used to run the tests.
     t.warning = false
 
     # Glob pattern to match test files. (default is 'test/test*.rb')
-    t.pattern = 'test/test*.rb'
+    t.pattern = "test/test*.rb"
 
     # Style of test loader to use.  Options are:
     #

data/tasks/yard.rake

@@ -1,22 +1,37 @@
+# Installs a rake task to generate API documentation using yard.
+#
+# This file installs the 'rake yard' task. It is automatically generated by Noe from 
+# your .noespec file, and should therefore be configured there, under the 
+# variables/rake_tasks/yard entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     yard:
+#       files: lib/**/*.rb
+#       options: []
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file, 
+# don't forget to set safe-override to false in your noe specification:
 # 
-# Install a rake task to generate API documentation using
-# yard.
+# template-info:
+#   manifest:
+#     tasks/yard.rake:
+#       safe-override: false
 #
-# More information about yard: http://yardoc.org/
-# This file has been written to conform to yard v0.6.4
+# This file has been written to conform to yard v0.6.4. More information about 
+# yard and the rake task installed below can be found on http://yardoc.org/
 #
-# About project documentation
 begin
   require "yard"
   desc "Generate yard documentation"
   YARD::Rake::YardocTask.new(:yard) do |t|
-    # Array of options passed to the commandline utility
-    # See 'yardoc --help' about this
-    t.options = %w{--output-dir doc/api - README.md CHANGELOG.md LICENCE.md}
+    # Array of options passed to yardoc commandline. See 'yardoc --help' about this
+    t.options = ["--output-dir", "doc/api", "-", "README.md", "CHANGELOG.md", "LICENCE.md"]
     
     # Array of ruby source files (and any extra documentation files 
     # separated by '-')
-    t.files = ['lib/**/*.rb']
+    t.files = ["lib/**/*.rb"]
     
     # A proc to call before running the task
     # t.before = proc{ }

data/templates/ruby/CHANGELOG.md

@@ -1,10 +1,26 @@
-# 1.1.0 / FIX ME
+# 1.2.0 / 2011-01-17
+
+  * A 'description' variable is introduced in .noespec and made mandatory to avoid weird results 
+    on rubygems.org when using the whole README.md file for project description.
+  * A 'version' variable is introduced in .noespec and made mandatory.
+  * Enhanced 'rake package/gem' to be configurable from .noespec under variables/rake_tasks/gem
+  * Enhanced 'rake unit_test' to be configurable from .noespec under variables/rake_tasks/unit_test
+  * Enhanced 'rake spec_test' to be configurable from .noespec under variables/rake_tasks/unit_test
+  * Enhanced 'rake yard' to be configurable from .noespec under variables/rake_tasks/yard
+  * Added 'rake debug_mail' which is configurable from .noespec under variables/rake_tasks/debug_mail
+  * lib/__lower__/loader.rb only use plain requires instead of a more complex algorithm. This follows
+    the discussion with Luis Lavena on ruby-talk (http://bit.ly/gqukPw)
+  * Added a proposal dependency (wlang ~> 0.10.1) required by the debug_mail task
+  * Fixed tasks/unit_test.rake under 1.9.2 (raised 'no such file to load -- []' with options=[] instead 
+    of nil)
+
+# 1.1.0 / 2011-01-11
 
   * Added the tasks folder with well documented rake tasks
   * Added a dependency loader in __lower__/loader.rb that helps requiring gems the good way
   * Added Bundler support to easy developer's job trough Gemfile and "require 'bundle/setup'" in Rakefile
   * LICENCE.txt -> LICENCE.md
-  * Follows a lot of changes in from Noe 1.0.0 -> 1.1.0
+  * Follows a lot of changes from Noe 1.0.0 -> 1.1.0
 
 # 1.0.0 / 2011-01-11
 

data/templates/ruby/noespec.yaml

@@ -30,7 +30,7 @@ template-info:
   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's philosophy this template 
+    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: 
@@ -95,6 +95,14 @@ template-info:
     spec/spec_helper.rb:
       description: Helper for ruby spec tests
       safe-override: true
+    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
@@ -125,10 +133,20 @@ variables:
   # name.
   upper:
     HelloWorld
+    
+  # Version of your library
+  version:
+    1.0.0
 
-  # Project summary. The summary should be a short project description (5 lines)
-  # and will be used to annotate your .gemspec file on rubygems.org.
-  summary: A simple "Hello World" example for Noe's skeleton for Ruby projects
+  # Project summary (~ 1 line)
+  summary: 
+    A simple "Hello World" example
+  
+  # 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 hello_world example provides you all you need to build a ruby gem library
+    while applying skeleton-driven coding with Noe (see http://revision-zero.org/noe)
     
   # 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 
@@ -173,6 +191,8 @@ variables:
     # YARD and BlueCloth are required to run 'rake yard'. See tasks/yard.rake 
     - {name: yard,      version: "~> 0.6.4", groups: [development]}
     - {name: bluecloth, version: "~> 2.0.9", groups: [development]}
+    # wlang is required to run 'rake debug_mail'. See tasks/debug_mail.rake
+    - {name: wlang, version: "~> 0.10.1", 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
@@ -199,3 +219,89 @@ variables:
     requirements:
     # A friendly message you would like to display when the user installs your gem
     post_install_message:
+    
+  # 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/**/*_spec.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/templates/ruby/short.yaml

@@ -19,10 +19,20 @@ variables:
   upper:
     HelloWorld
 
-  # Project summary (~= 5 lines).
-  summary: |
-    A simple "Hello World" example for Noe's skeleton for Ruby projects
+  # Version of your library
+  version:
+    1.0.0
+    
+  # Project summary (~ 1 line).
+  summary: |-
+    A simple "Hello World" example
 
+  # 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 hello_world example provides you all you need to build a ruby gem library
+    while applying skeleton-driven coding with Noe (see http://revision-zero.org/noe)
+      
   # Authors of the project (- {name: Bob, email: bob@gmail.com}, ...) 
   authors: []
 
@@ -30,4 +40,15 @@ variables:
   links: []
 
   # Gem dependencies. (- {name: ..., version: ..., groups: [...]}, ...)
-  dependencies: []
+  dependencies: 
+    # Rake is required for developers, as usual
+    - {name: rake,      version: "~> 0.8.7", 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.4.0", groups: [development]}
+    # YARD and BlueCloth are required to run 'rake yard'. See tasks/yard.rake 
+    - {name: yard,      version: "~> 0.6.4", groups: [development]}
+    - {name: bluecloth, version: "~> 2.0.9", groups: [development]}
+    # wlang is required to run 'rake debug_mail'. See tasks/debug_mail.rake
+    - {name: wlang, version: "~> 0.10.1", groups: [development]}

data/templates/ruby/src/Manifest.txt

@@ -1,9 +1,12 @@
 !{lower}.gemspec
+!{lower}.noespec
 CHANGELOG.md
 Gemfile
+Gemfile.lock
 bin/**/*
 lib/**/*
 LICENCE.md
+Manifest.txt
 Rakefile
 README.md
 spec/**/*

data/templates/ruby/src/Rakefile

@@ -1,8 +1,9 @@
 begin
   gem "bundler", "~> 1.0"
   require "bundler/setup"
-rescue LoadError
-  abord "This project requires bundler, try 'gem install bundler'"
+rescue LoadError => ex
+  puts ex.message
+  abort "Bundler failed to load, (did you run 'gem install bundler' ?)"
 end
 
 # Dynamically load the gem spec

data/templates/ruby/src/__lower__.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   #
   # The description should be more detailed than the summary.  For example,
   # you might wish to copy the entire README into the description.
-  s.description = File.read(File.expand_path('../README.md', __FILE__))
+  s.description = +{description}
   
   # The URL of this gem home page (optional)
   s.homepage = +{links.first}

data/templates/ruby/src/lib/__lower__.rb

@@ -3,7 +3,7 @@
 #
 module !{upper}
   
-  VERSION = "1.0.0".freeze
+  VERSION = "!{version}".freeze
   
 end # module !{upper}
 require "!{lower}/loader"

data/templates/ruby/src/lib/__lower__/loader.rb

@@ -1,65 +1 @@
-module !{upper}
-  #
-  # This module provides tools to load stdlib and gem dependencies.
-  #
-  module Loader
-    
-    #
-    # This method allows requiring dependencies with some flexibility.
-    #
-    # Implemented algorithm makes greedy choices about the environment:
-    # 1. It first attempts a simple <code>Kernel.require(name)</code> before 
-    #    anything else (even bypassing version requirement)
-    # 2. If step 1 fails with a LoadError then it falls back requiring the 
-    #    gem with specified version (defaults to >= 0) and retries step 1.
-    # 3. If step 2 fails with a NameError, 'rubygems' are required and step 
-    #    2 is retried.
-    # 4. If step 3. fails, the initial LoadError is reraised.
-    #
-    # Doing so ensures flexibility for the users of the library by not making
-    # wrong assumptions about their environment. Testing the library is also
-    # made easier, as illustrated in the examples below. Please note that this
-    # method is useful to load external dependencies of your code only, not 
-    # .rb files of your own library.
-    #
-    # Examples:
-    #
-    #   # Require something from the standard library
-    #   !{upper}::Loader.require('fileutils')
-    #
-    #   # Require a gem without specifing any particular version
-    #   !{upper}::Loader.require('highline')
-    #
-    #   # Require a gem, specifing a particular version
-    #   !{upper}::Loader.require('foo', "~> 1.6")
-    #
-    #   # Twist the load path to use version of foo you've recently 
-    #   # forked (bypass the version requirement)
-    #   $LOAD_PATH.unshift ...   # or ruby -I...
-    #   !{upper}::Loader.require('highline', "~> 1.6")
-    #
-    # Learn more about this pattern:
-    # - http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
-    # - https://gist.github.com/54177
-    #
-    def require(name, version = nil)
-      Kernel.require name.to_s
-    rescue LoadError
-      begin
-        gem name.to_s, version || ">= 0"
-      rescue NameError
-        if $VERBOSE
-          Kernel.warn "#{__FILE__}:#{__LINE__}: warning: requiring rubygems myself, "\
-                      " you should use 'ruby -rubygems' instead. "\
-                      "See https://gist.github.com/54177"
-        end
-        require "rubygems"
-        gem name.to_s, version || ">= 0"
-      end
-      Kernel.require name.to_s
-    end
-    module_function :require
-    
-  end # module Loader
-end # module !{upper}
-*{dependencies.select{|dep| dep.groups.include?('runtime')} as dep}{!{upper}::Loader.require(+{dep.name}, +{dep.version})}{!{"\n"}}
+*{dependencies.select{|dep| dep.groups.include?('runtime')} as dep}{require +{dep.name}}{!{"\n"}}