noe 1.0.0 → 1.1.0

data/templates/ruby/short.yaml

@@ -0,0 +1,33 @@
+# Noe template for ruby gem libraries (https://github.com/blambeau/noe) - short version
+# Run 'noe show-spec' and 'noe help show-spec' for additional details.
+
+# Don't remove this entry!
+template-info:
+  name: "!{template_name}"
+  version: 1.1.0
+  links:
+    source: https://github.com/blambeau/noe/tree/master/templates/ruby
+    documentation: https://github.com/blambeau/noe/blob/master/templates/ruby/README.md
+
+# Update to match your own configuration.
+variables:
+  # A ruby lower case project name.
+  lower: 
+    hello_world
+
+  # A ruby upper case project name. 
+  upper:
+    HelloWorld
+
+  # Project summary (~= 5 lines).
+  summary: |
+    A simple "Hello World" example for Noe's skeleton for Ruby projects
+
+  # Authors of the project (- {name: Bob, email: bob@gmail.com}, ...) 
+  authors: []
+
+  # Web links for the project (- http://..., - http://...). 
+  links: []
+
+  # Gem dependencies. (- {name: ..., version: ..., groups: [...]}, ...)
+  dependencies: []

data/templates/ruby/src/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec :name => +{lower}

data/templates/ruby/src/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) !{Time.now.strftime('%Y')} - *{authors as a}{!{a.name}}{, }
+
+    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/templates/ruby/src/Manifest.txt

@@ -0,0 +1,11 @@
+!{lower}.gemspec
+CHANGELOG.md
+Gemfile
+bin/**/*
+lib/**/*
+LICENCE.md
+Rakefile
+README.md
+spec/**/*
+tasks/**/*
+test/**/*

data/templates/ruby/src/README.md

@@ -1,3 +1,8 @@
 # !{upper}
 
-!{description}
+!{summary}
+
+## Links
+
+!{links.join("\n")}
+

data/templates/ruby/src/Rakefile

@@ -1,42 +1,22 @@
-# We run tests by default
-task :default => :spec
-
-### About project tests
 begin
-  require "rspec/core/rake_task"
-
-  desc "Run all examples"
-  RSpec::Core::RakeTask.new(:spec) do |t|
-  	t.rspec_opts = %w[--color]
-  	t.verbose = false
-  end
+  gem "bundler", "~> 1.0"
+  require "bundler/setup"
 rescue LoadError
+  abord "This project requires bundler, try 'gem install bundler'"
 end
 
-# About project documentation
-begin
-  require "yard"
-  
-  desc "Generate yard documentation"
-  YARD::Rake::YardocTask.new do |t|
-    t.files   = ['lib/**/*.rb']
-    t.options = ['--output-dir', 'doc/api', '-', "README.md", "CHANGELOG.md"]
-  end
-rescue LoadError
-end
+# Dynamically load the gem spec
+$gemspec_file = File.expand_path('../!{lower}.gemspec', __FILE__)
+$gemspec      = Kernel.eval(File.read($gemspec_file))
 
-# About project packaging
-begin
-  require "rake/gempackagetask"
-  
-  # Dynamically load the gem spec
-  spec_file = File.expand_path('../!{lower}.gemspec', __FILE__)
-  spec = Kernel.eval(File.read(spec_file))
+# We run tests by default
+task :default => :test
 
-  # Everything looks fine, add the gem task
-  desc "Create the .gem package"
-  Rake::GemPackageTask.new(spec) do |pkg|
-  	pkg.need_tar = true
-  end
-rescue LoadError
-end
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  instance_eval File.read(taskfile), taskfile
+end

data/templates/ruby/src/__lower__.gemspec

@@ -1,31 +1,186 @@
-require File.expand_path('../lib/!{lower}', __FILE__)
-spec = Gem::Specification.new do |s|
-  s.name = %q{!{lower}}
-  s.version = !{upper}::VERSION.dup
-  s.date = Time.now.strftime('%Y-%m-%d')
+# We require your library, mainly to have access to the VERSION number. 
+# Feel free to set $version manually.
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require +{lower}
+$version = !{upper}::VERSION.dup
 
-  s.author = %q{!{author}}
-  s.email = %q{!{email}}
+#
+# This is your Gem specification. Default values are provided so that your library
+# should be correctly packaged given what you have described in the .noespec file.
+#
+Gem::Specification.new do |s|
+  
+  ################################################################### ABOUT YOUR GEM
+  
+  # Gem name (required) 
+  s.name = +{lower}
+  
+  # Gem version (required)
+  s.version = $version
+  
+  # A short summary of this gem
+  #
+  # This is displayed in `gem list -d`.
+  s.summary = +{summary}
 
-  s.description = %q{!{description}}
+  # 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__))
+  
+  # The URL of this gem home page (optional)
+  s.homepage = +{links.first}
 
-  s.require_paths = ["lib"]
-  s.bindir = 'bin'
-  s.executables = []
+  # Gem publication date (required but auto)
+  #
+  # Today is automatically used by default, uncomment only if
+  # you know what you do!
+  #
+  # s.date = Time.now.strftime('%Y-%m-%d')
+  
+  # The license(s) for the library.  Each license must be a short name, no
+  # more than 64 characters.
+  #
+  # s.licences = %w{}
 
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.md", "CHANGELOG.md"]
+  # The rubyforge project this gem lives under (optional)
+  #
+  # s.rubyforge_project = nil
 
-  s.files = 
-    Dir['lib/**/*'] +
-    Dir['spec/**/*'] +
-    %w{ !{lower}.gemspec Rakefile README.md CHANGELOG.md LICENCE.txt}
+  ################################################################### ABOUT THE AUTHORS
+  
+  # The list of author names who wrote this gem.
+  #
+  # If you are providing multiple authors and multiple emails they should be
+  # in the same order.
+  # 
+  s.authors = +{authors.collect{|a| a.name}}
+  
+  # Contact emails for this gem
+  #
+  # If you are providing multiple authors and multiple emails they should be
+  # in the same order.
+  #
+  # NOTE: Somewhat strangly this attribute is always singular! 
+  #       Don't replace by s.emails = ...
+  s.email  = +{authors.collect{|a| a.email}}
 
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec', ">= 2.4.0")
-  s.add_development_dependency('yard', ">= 0.6.4")
-  s.add_development_dependency('bluecloth', ">= 0.6.4")
+  ################################################################### PATHS, FILES, BINARIES
+  
+  # Paths in the gem to add to $LOAD_PATH when this gem is 
+  # activated (required).
+  #
+  # The default 'lib' is typically sufficient.
+  s.require_paths = +{gemspec.require_paths}
+  
+  # Files included in this gem.
+  #
+  # By default, we take all files included in the Manifest.txt file on root
+  # of the project. Entries of the manifest are interpreted as Dir[...] 
+  # patterns so that lazy people may use wilcards like lib/**/*
+  #
+  here = File.dirname(__FILE__)
+  s.files = File.readlines(File.join(here, 'Manifest.txt')).
+                 inject([]){|files, pattern| 
+    files + Dir[File.join(here, pattern.strip)]
+  }
 
-  s.homepage = %q{!{homepage}}
-end
+  # Test files included in this gem.
+  #
+  s.test_files = *{gemspec.test_files as t}{Dir[+{t}]}{ + }
+
+  # The path in the gem for executable scripts (optional)
+  #
+  s.bindir = +{gemspec.bindir}
+
+  # Executables included in the gem.
+  #
+  s.executables = (*{gemspec.executables as t}{Dir[+{t}]}{ + }).collect{|f| File.basename(f)}
+
+  ################################################################### REQUIREMENTS & INSTALL
+  # Remember the gem version requirements operators and schemes:
+  #   =  Equals version
+  #   != Not equal to version
+  #   >  Greater than version
+  #   <  Less than version
+  #   >= Greater than or equal to
+  #   <= Less than or equal to
+  #   ~> Approximately greater than
+  #
+  # Don't forget to have a look at http://lmgtfy.com/?q=Ruby+Versioning+Policies 
+  # for setting your gem version.
+  #
+  # For your requirements to other gems, remember that
+  #   ">= 2.2.0"              (optimistic:  specify minimal version)
+  #   ">= 2.2.0", "< 3.0"     (pessimistic: not greater than the next major)
+  #   "~> 2.2"                (shortcut for ">= 2.2.0", "< 3.0")
+  #   "~> 2.2.0"              (shortcut for ">= 2.2.0", "< 2.3.0")
+  #
+
+  #
+  # One call to add_dependency('gem_name', 'gem version requirement') for each
+  # runtime dependency. These gems will be installed with your gem. 
+  # One call to add_development_dependency('gem_name', 'gem version requirement')
+  # for each development dependency. These gems are required for developers
+  #
+  *{dependencies.select{|dep| dep.groups.include?('development')} as dep}{s.add_development_dependency(+{dep.name}, +{dep.version})}{!{"\n  "}}
+  *{dependencies.select{|dep| dep.groups.include?('runtime')} as dep}{s.add_dependency(+{dep.name}, +{dep.version})}{!{"\n  "}}
+
+  # The version of ruby required by this gem
+  #
+  # Uncomment and set this if your gem requires specific ruby versions.
+  #
+  # s.required_ruby_version = ">= 0"
+
+  # The RubyGems version required by this gem
+  #
+  # s.required_rubygems_version = ">= 0"
+
+  # The platform this gem runs on.  See Gem::Platform for details.
+  #
+  # s.platform = nil
 
+  # Extensions to build when installing the gem.  
+  #
+  # Valid types of extensions are extconf.rb files, configure scripts 
+  # and rakefiles or mkrf_conf files.
+  #
+  s.extensions = +{gemspec.extensions}
+  
+  # External (to RubyGems) requirements that must be met for this gem to work. 
+  # It’s simply information for the user.
+  #
+  s.requirements = +{gemspec.requirements}
+  
+  # A message that gets displayed after the gem is installed
+  #
+  # Uncomment and set this if you want to say something to the user
+  # after gem installation
+  #
+  s.post_install_message = +{gemspec.post_install_message}
+
+  ################################################################### SECURITY
+
+  # The key used to sign this gem.  See Gem::Security for details.
+  #
+  # s.signing_key = nil
+
+  # The certificate chain used to sign this gem.  See Gem::Security for
+  # details.
+  #
+  # s.cert_chain = []
+  
+  ################################################################### RDOC
+
+  # An ARGV style array of options to RDoc
+  #
+  # See 'rdoc --help' about this
+  #
+  s.rdoc_options = +{gemspec.rdoc_options}
+
+  # Extra files to add to RDoc such as README
+  #
+  s.extra_rdoc_files = *{gemspec.extra_rdoc_files as t}{Dir[+{t}]}{ + }
+
+end

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

@@ -1,6 +1,9 @@
+#
+# !{summary}
+#
 module !{upper}
   
   VERSION = "1.0.0".freeze
   
-end
-
+end # module !{upper}
+require "!{lower}/loader"

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

@@ -0,0 +1,65 @@
+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"}}

data/templates/ruby/src/spec/spec_helper.rb

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

data/templates/ruby/src/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