noe 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,4 +1,39 @@
-# 1.1.0 / FIX ME
+# 1.2.0 / 2011-01-17
+
+* Broken things
+
+  * Arrays are not union-merged anymore during YAML merging between .noespec and template's noespec.yaml. 
+    This may introduce small problems on existing projects that use the default ruby skeleton while 
+    specifying additional dependencies. Users have to copy default dependencies in their own .noespec 
+    file.
+  * Noe does not contain its loader anymore. As a side effect, it does not require rubygems anymore
+    and 'noe' binary relies on the gem installer to meet its dependencies.
+
+* Minor enhancements
+
+  * Fixed 'noe --backtrace go', which didn't print the ruby backtrace.
+
+* Bug fixes
+
+  * A nil value on right of YAML merging (.noespec) correctly overrides the value specified on left
+    (typically template's noespec.yaml)
+
+* Default ruby skeleton
+
+  * 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.
+  * 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-14
 
 * Template specification/instantiation enhancements
 

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    noe (1.2.0)
+      highline (~> 1.6.0)
+      quickl (~> 0.2.0)
+      wlang (~> 0.10.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.0.9)
+    diff-lcs (1.1.2)
+    highline (1.6.1)
+    quickl (0.2.0)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    wlang (0.10.1)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth (~> 2.0.9)
+  bundler (~> 1.0)
+  highline (~> 1.6.0)
+  noe!
+  quickl (~> 0.2.0)
+  rake (~> 0.8.7)
+  rspec (~> 2.4.0)
+  wlang (~> 0.10.1)
+  yard (~> 0.6.4)

data/Manifest.txt

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

data/README.md

@@ -1,14 +1,14 @@
 # Noe - A simple and extensible project generator
 
-Noe is a tool that generates projects from predefined skeletons (aka project/application 
-templates). Skeletons are designed for building specific products (a ruby library, a static 
-or dynamic web site, ...). Noe instantiates them and helps you maintaining your product 
-via meta-information provided by a .noespec yaml file. 
+Noe is a tool that generates project skeletons from predefined templates. A template is designed 
+for a specific product (a ruby library, a static or dynamic web site, ...). Noe instantiates 
+templates and helps you maintaining your product via meta-information provided by a .noespec yaml 
+file. In contrast to other tools, Noe is not specific to certain kinds of products. Writing your
+own template is possible and even simple!
 
-Noe comes bundled with a skeleton for creating and maintaining a ruby gem. This skeleton 
-is written and maintained to follow ruby best practices and may also be tuned for your own 
-needs. Read more about it and related projects as well as the underlying philosophy in the 
-sections below.
+Noe comes bundled with a skeleton for creating and maintaining a ruby gem. This skeleton is written 
+and maintained to follow ruby best practices and may also be tuned for your own needs. Read more 
+about it and related projects as well as the underlying philosophy in the sections below.
 
 ## Getting started
 
@@ -31,7 +31,8 @@ instantiate a ruby project simply execute the following commands in turn:
     noe go
   
 That's it! But also have a look at 'noe help prepare' and 'not help go' for additional
-options.
+options. Also have a look at [http://revision-zero.org/noe](http://revision-zero.org/noe) 
+for a blog post about basic usage.
 
 ## Philosophy
 

data/Rakefile

@@ -1,8 +1,9 @@
 begin
   gem "bundler", "~> 1.0"
   require "bundler/setup"
-rescue LoadError
-  abort "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/lib/noe.rb

@@ -1,7 +1,7 @@
 module Noe
   
   # Noe's version
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
   
   class Error < StandardError; end
 

data/lib/noe/ext/array.rb

@@ -11,8 +11,4 @@ class Array
     end
   end
   
-  def noe_merge(right)
-    (self + right).uniq
-  end
-  
 end # class Array

data/lib/noe/ext/hash.rb

@@ -18,7 +18,7 @@ class Hash
   # Makes a fully recursive merge
   def noe_merge(right)
     self.merge(right) do |key,oldval,newval|
-      if oldval.nil?
+      if oldval.nil? or newval.nil?
         newval
       elsif oldval.class != newval.class
         raise Noe::Error, "Conflict on #{key} has to be resolved manually, sorry.\n"\

data/lib/noe/loader.rb

@@ -1,67 +1,3 @@
-module Noe
-  #
-  # 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
-    #   Noe::Loader.require('fileutils')
-    #
-    #   # Require a gem without specifing any particular version
-    #   Noe::Loader.require('highline')
-    #
-    #   # Require a gem, specifing a particular version
-    #   Noe::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...
-    #   Noe::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 Noe
-Noe::Loader.require("wlang", "~> 0.10.0")
-Noe::Loader.require("quickl", "~> 0.2.0")
-Noe::Loader.require("highline", "~> 1.6.0")
+require "wlang"
+require "quickl"
+require "highline"

data/lib/noe/main.rb

@@ -64,6 +64,7 @@ module Noe
       puts "#{ex.class}: #{ex.message}"
       back = ex.wlang_backtrace || ex.backtrace
       puts back.join("\n")
+      puts ex.backtrace.join("\n") if @backtrace
     rescue Quickl::Error => ex
       raise
     rescue Noe::Error => ex

data/noe.gemspec

@@ -21,13 +21,13 @@ Gem::Specification.new do |s|
   # A short summary of this gem
   #
   # This is displayed in `gem list -d`.
-  s.summary = "Noe is a tool that generates projects from predefined skeletons (aka project/application templates). Skeletons are designed for building specific products (a ruby library, a static or dynamic web site, ...). Noe instantiates them and helps you maintaining your product via meta-information provided by a .noespec yaml file."
+  s.summary = "Noe is a simple, general-purpose and extensible skeleton generator from project templates"
 
   # A long description of this gem (required)
   #
   # 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 = "Noe is a tool that generates project skeletons from predefined templates. A template is designed for a specific product (a ruby library, a static or dynamic web site, ...). Noe instantiates templates and helps you maintaining your product via meta-information provided by a .noespec yaml file. In contrast to other tools, Noe is not specific to certain kinds of products. Writing your own template is possible and even simple!"
   
   # The URL of this gem home page (optional)
   s.homepage = "http://github.com/blambeau/noe"
@@ -129,7 +129,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rspec", "~> 2.4.0")
   s.add_development_dependency("yard", "~> 0.6.4")
   s.add_development_dependency("bluecloth", "~> 2.0.9")
-  s.add_dependency("wlang", "~> 0.10.0")
+  s.add_development_dependency("wlang", "~> 0.10.1")
+  s.add_dependency("wlang", "~> 0.10.1")
   s.add_dependency("quickl", "~> 0.2.0")
   s.add_dependency("highline", "~> 1.6.0")
 

data/noe.noespec

@@ -0,0 +1,44 @@
+template-info:
+  name: ruby
+  version: 1.2.0
+  author: Bernard Lambeau <blambeau@gmail.com>
+variables:
+  lower: noe
+  upper: Noe
+  version: 1.2.0
+  summary: 
+    Noe is a simple, general-purpose and extensible skeleton generator from project templates
+  description:
+    Noe is a tool that generates project skeletons from predefined templates. A template is designed 
+    for a specific product (a ruby library, a static or dynamic web site, ...). Noe instantiates 
+    templates and helps you maintaining your product via meta-information provided by a .noespec yaml 
+    file. In contrast to other tools, Noe is not specific to certain kinds of products. Writing your
+    own template is possible and even simple!
+  authors: 
+    - {name: Bernard Lambeau, email: blambeau@gmail.com}
+  links:
+    - http://github.com/blambeau/noe
+    - http://rubygems.org/gems/noe
+    - http://revision-zero.org/noe
+  dependencies: 
+    - {name: rake,      version: "~> 0.8.7",  groups: [development]}
+    - {name: bundler,   version: "~> 1.0",    groups: [development]}
+    - {name: rspec,     version: "~> 2.4.0",  groups: [development]}
+    - {name: yard,      version: "~> 0.6.4",  groups: [development]}
+    - {name: bluecloth, version: "~> 2.0.9",  groups: [development]}
+    #
+    - {name: wlang,     version: "~> 0.10.1", groups: [development, runtime]}
+    - {name: quickl,    version: "~> 0.2.0",  groups: [runtime]}
+    - {name: highline,  version: "~> 1.6.0",  groups: [runtime]}
+  gemspec: 
+    post_install_message: |
+      Noe successfully installed!
+      
+      What's next?
+        - 'noe help install' for configuration and default templates
+        - 'noe prepare --template=ruby hello_world'
+      
+      Thank you for using Noe, enjoy!
+  rake_tasks:
+    debug_mail: 
+      nb_changelog_sections: 2

data/tasks/debug_mail.rake

@@ -0,0 +1,77 @@
+# Installs a rake task for debuging the announcement mail.
+#
+# This file installs the 'rake debug_mail' that flushes an announcement mail
+# for your library on the standard output. It is automatically generated 
+# by Noe from your .noespec file, and should therefore be configured there, 
+# under the variables/rake_tasks/debug_mail entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     debug_mail:
+#       rx_changelog_sections: /^#/
+#       nb_changelog_sections: 1
+#       ...
+#
+# 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/debug_mail.rake:
+#       safe-override: false
+#
+# The mail template used can be found in debug_mail.txt. That file may be
+# changed to tune the mail you want to send. If you do so, don't forget to
+# add a manifest entry in your .noespec file to avoid overriding you 
+# changes. The mail template uses wlang, with parentheses for block 
+# delimiters.
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.txt:
+#       safe-override: false
+#
+begin
+  require 'wlang'
+  require 'yaml'
+  
+  task :debug_mail do 
+    # Check that a .noespec file exists
+    noespec_file = File.expand_path('../../noe.noespec', __FILE__)
+    unless File.exists?(noespec_file)
+      raise "Unable to find .noespec project file, sorry."
+    end
+    
+    # Load it as well as variables and options
+    noespec = YAML::load(File.read(noespec_file))
+    vars = noespec['variables'] || {}
+
+    # Changes are taken from CHANGELOG 
+    logs = Dir[File.expand_path("../../CHANGELOG.*", __FILE__)]
+    unless logs.size == 1
+      abort "Unable to find a changelog file"
+    end
+
+    # Load interesting changesets
+    changes, end_found = [], 0
+    File.readlines(logs.first).select{|line|
+      if line =~ /^#/
+        break if end_found >= 2
+        end_found += 1
+      end
+      changes << line
+    }
+    vars['changes'] = changes.join
+    
+    # WLang template
+    template = File.expand_path('../debug_mail.txt', __FILE__)
+    
+    # Let's go!
+    $stdout << WLang::file_instantiate(template, vars, "wlang/active-text")
+  end
+
+rescue LoadError 
+  task :debug_mail do
+    abort "wlang is not available. Try 'gem install wlang'"
+  end
+end

data/tasks/debug_mail.txt

@@ -0,0 +1,13 @@
+Subject: [ANN] !{lower} !{version} Released
+
+!{lower} version !{version} has been released!
+
+!{summary}
+
+*{links as l}{* <!{l}>}{!{"\n"}}
+
+!{description}
+
+Changes:
+
+!{changes}

data/tasks/gem.rake

@@ -1,4 +1,28 @@
-# Install .gem project packaging
+# Installs rake tasks for gemming and packaging
+#
+# This file installs the 'rake package', 'rake gem' tasks and associates 
+# (clobber_package, repackage, ...). It is automatically generated by Noe 
+# from your .noespec file, and should therefore be configured there, under 
+# the variables/rake_tasks/gem entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     gem:
+#       package_dir: pkg
+#       need_tar: false
+#       need_tar_gz: false
+#       need_tar_bz2: false
+#       need_zip: 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/gem.rake:
+#       safe-override: false
+#
 begin
   require 'rubygems/package_task'
   Gem::PackageTask.new($gemspec) do |t|
@@ -10,28 +34,28 @@ begin
     t.version = $gemspec.version
     
     # Directory used to store the package files
-    t.package_dir = 'pkg'
+    t.package_dir = "pkg"
     
     # True if a gzipped tar file (tgz) should be produced
     t.need_tar = false
     
     # True if a gzipped tar file (tar.gz) should be produced
-    t.need_tar_gz = true
+    t.need_tar_gz = false
     
     # True if a bzip2'd tar file (tar.bz2) should be produced
     t.need_tar_bz2 = false
     
     # True if a zip file should be produced (default is false)
-    t.need_zip = true
+    t.need_zip = false
     
     # List of files to be included in the package.
     t.package_files = $gemspec.files
     
     # Tar command for gzipped or bzip2ed archives.
-    t.tar_command = 'tar'
+    t.tar_command = "tar"
     
     # Zip command for zipped archives.
-    t.zip_command = 'zip'
+    t.zip_command = "zip"
 
   end
 rescue LoadError