noe 1.0.0 → 1.1.0

data/spec/ext/hash/methodize_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+module Noe
+  describe "Hash#methodize!" do
+    
+    let(:thehash){ 
+      { 'name'     => "Noe", 
+        :version   => Noe::VERSION,
+        'subhash'  => { 'entry' => 12 },
+        'subarray' => [ { 'entry' => 12 } ]
+      }
+    }
+    
+    it "should be recursive by default" do
+      thehash.methodize!
+      thehash.name.should == "Noe"
+      thehash.version.should == Noe::VERSION
+      thehash.subhash.entry.should == 12
+      thehash.subarray[0].entry.should == 12
+    end
+    
+    it "should noe recursive if explicitely said" do
+      thehash.methodize!(false)
+      thehash.name.should == "Noe"
+      thehash.version.should == Noe::VERSION
+      thehash.subhash.should == {'entry' => 12}
+      lambda{ thehash.subhash.entry }.should raise_error
+    end
+    
+  end
+end # module Noe

data/spec/noe_spec.rb

@@ -5,4 +5,8 @@ describe Noe do
     Noe.const_defined?(:VERSION).should be_true
   end
   
+  it "should rely on Kernel.warn, that should exists" do
+    Kernel.respond_to?(:warn).should be_true
+  end
+  
 end

data/spec/spec_helper.rb

@@ -1,4 +1,2 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'rubygems'
-require 'rspec'
 require 'noe'

data/spec/template/entry/infer_wlang_dialect_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+module Noe
+  describe "Template::Entry#infer_wlang_dialect" do
+    
+    subject{ Template::Entry.infer_wlang_dialect(uri, default) }
+    let(:default){ nil }
+    
+    context "when invoked on explicit wlang dialects extensions" do
+      let(:uri){ "test.wtpl" }
+      it{ should == "wlang/xhtml" }
+    end
+    
+    context "when invoked on implicit wlang dialects extensions" do
+      let(:uri){ "test.rb" }
+      it{ should == "wlang/ruby" }
+    end
+    
+    context "when invoked on something else and a default value" do
+      let(:uri){ "test.notanextension" }
+      let(:default){ "hello" }
+      it{ should == "hello" }
+    end
+    
+    context "when invoked on something else and no default value" do
+      let(:uri){ "test.notanextension" }
+      let(:default){ nil }
+      it{ should == "wlang/active-text" }
+    end
+    
+  end 
+end

data/tasks/gem.rake

@@ -0,0 +1,44 @@
+# Install .gem project packaging
+begin
+  require 'rubygems/package_task'
+  Gem::PackageTask.new($gemspec) do |t|
+
+    # Name of the package
+    t.name = $gemspec.name
+
+    # Version of the package
+    t.version = $gemspec.version
+    
+    # Directory used to store the package files
+    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
+    
+    # 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
+    
+    # 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'
+    
+    # Zip command for zipped archives.
+    t.zip_command = 'zip'
+
+  end
+rescue LoadError
+  task :gem do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+  task :package do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+end

data/tasks/spec_test.rake

@@ -0,0 +1,61 @@
+#
+# Install a rake task for running examples written using rspec.
+#
+# More information about rspec: http://relishapp.com/rspec
+# This file has been written to conform to RSpec v2.4.0
+#
+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'
+
+    # 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.
+    t.skip_bundler = false
+
+    # Name of Gemfile to use
+    t.gemfile = 'Gemfile'
+
+    # Whether or not to fail Rake when an error occurs (typically when 
+    # examples fail).
+    t.fail_on_error = true
+
+    # A message to print to stderr when there are failures.
+    t.failure_message = nil
+
+    # Use verbose output. If this is set to true, the task will print the
+    # executed spec command to stdout.
+    t.verbose = true
+
+    # Use rcov for code coverage?
+    t.rcov = false
+
+    # Path to 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 ruby.
+    # See 'ruby --help' about this 
+    t.ruby_opts = %w{}
+
+    # Path to rspec
+    t.rspec_path = 'rspec'
+
+    # Command line options to pass to rspec.
+    # See 'rspec --help' about this
+    t.rspec_opts = %w{--color --backtrace}
+  end
+rescue LoadError => ex
+  task :spec_test do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+ensure
+  task :spec => [:spec_test]
+  task :test => [:spec_test]
+end

data/tasks/unit_test.rake

@@ -0,0 +1,56 @@
+#
+# Install a rake task for running examples written using rspec.
+#
+# More information about rspec: http://relishapp.com/rspec
+# This file has been written to conform to RSpec v2.4.0
+#
+begin
+  desc "Lauches unit tests"
+  require 'rake/testtask'
+  Rake::TestTask.new(:unit_test) do |t|
+
+    # List of directories to added to $LOAD_PATH before running the
+    # tests. (default is 'lib')
+    t.libs = %w{ 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 = []
+
+    # 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'
+
+    # 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.
+    # 
+    t.loader = :rake
+
+    # Array of commandline options to pass to ruby when running test 
+    # loader.
+    t.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.
+    t.test_files = nil
+
+  end
+rescue LoadError => ex
+  task :unit_test do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+ensure
+  task :test => [:unit_test]
+end
+

data/tasks/yard.rake

@@ -0,0 +1,36 @@
+# 
+# Install a rake task to generate API documentation using
+# yard.
+#
+# More information about yard: http://yardoc.org/
+# This file has been written to conform to yard v0.6.4
+#
+# 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 ruby source files (and any extra documentation files 
+    # separated by '-')
+    t.files = ['lib/**/*.rb']
+    
+    # A proc to call before running the task
+    # t.before = proc{ }
+    
+    # A proc to call after running the task
+    # r.after = proc{ }
+    
+    # An optional lambda to run against all objects being generated. 
+    # Any object that the lambda returns false for will be excluded 
+    # from documentation. 
+    # t.verifier = lambda{|obj| true}
+  end
+rescue LoadError
+  task :yard do
+    abort 'yard is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/templates/ruby/CHANGELOG.md

@@ -1,3 +1,11 @@
-# 1.0.0 / FIX ME
+# 1.1.0 / FIX ME
+
+  * 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
+
+# 1.0.0 / 2011-01-11
 
   * Birthday

data/templates/ruby/README.md

@@ -1,24 +1,61 @@
 # Noe template for ruby projects
 
-This is my Noe template for ruby projects. Once generated you'll have a fresh new ruby project
-that works, supports unit and spec tests and so on!
+This project provides 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 
+also helps you understanding the ruby ecosystem by providing a fully documented project,
+rake tasks, and so on.
 
 ## Install
 
-* copy the whole folder in ~/.noe
+* You'll need Noe to use this template, see: https://github.com/blambeau/noe
+* You'll also need bundler, see http://gembundler.com/
+* Copy the whole folder in your noe skeleton folder (defaults to ~/.noe)
 
-## Instantiation
+In other words
 
-    noe create --ruby foo
+    [sudo] gem install noe bundler
+    cp {this whole folder} ~/.noe
+
+### Creating a ruby project
+
+    # Prepare generation
+    noe prepare --template=ruby foo
     cd foo
+    
+    # Edit specific information about your project
     edit foo.noespec
+    
+    # Let Noe generate your project
     noe go
     
-## Usage
+    # Install your ruby dependencies then run rake 
+    bundle install
+    rake
+    
+## Rake tasks installed by this template
+
+The following rake tasks are provided to your Rakefile by this template. Have a look at the 
+_tasks_ folder for specific configuration additional information. 
 
-    # Run spec tests
-    rake spec
+    # Running tests
+    rake spec_test        # Run RSpec code examples
+    rake unit_test        # Run unit tests
+    rake test             # spec_test & unit_test
+    
+    # Generating documentation
+    rake yard             # Generate YARD Documentation
+    
+    # Releasing and packaging
+    rake gem              # Build the gem file
+    rake package          # Build all the packages
+    rake repackage        # Force a rebuild of the package files
+    rake clobber_package  # Remove package products
     
-    # Generate gem
-    rake gem
+## External dependencies
 
+* This template requires [bundler, >= 1.0](http://gembundler.com/)
+* The _spec_ tasks requires [rspec, >= v2.4.0](http://relishapp.com/rspec)
+* The _yard_ tasks requires [yard,  >= v0.6.4](http://yardoc.org/) which itself relies on
+  [bluecloth, >= 2.0.9](http://deveiate.org/projects/BlueCloth)
+* All _package_-related tasks require [rubygems, >= 1.3.8](http://docs.rubygems.org/)

data/templates/ruby/noespec.yaml

@@ -1,32 +1,201 @@
-# Following entries are maintained by Noe itself. Do not touch if not sure!
+#
+# 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=!{template_name} --layout=short' to generate a shorter
+# version of this file.
+#
+# See 'noe help prepare' and 'noe help show-spec' for more information.
+#
 template-info:
-  name:
-    !{template_name}
-  description: 
-    Noe spec for small ruby projects
-  version: 
-    1.0.0
-  author: 
-    Bernard Lambeau <blambeau@gmail.com>
-  
-# The following entries are template-related variables. Update
-# to match your own configuration.
+
+  # Don't remove the name and version entries, which are ALWAYS required 
+  name: "!{template_name}"
+  version: 1.1.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's 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
+    __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__/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: true
+    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
+  # 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: 
     hello_world
-  # A ruby upper case project name
+
+  # 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:
     HelloWorld
-  # Author of the project
-  author: 
-    Bernard Lambeau
-  # Email of the author
-  email: 
-    blambeau@gmail.com
-  # Project's homepage
-  homepage:
-    http://github.com/blambeau/noe
-  # Project description
-  description: 
-    HelloWorld - A simple example for Noe project generator
+
+  # 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
+    
+  # 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: []
+
+  # 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: []
+
+  # 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.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]}
+  
+  # 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: