noe 1.0.0 → 1.1.0

data/lib/noe/main.rb

@@ -12,8 +12,11 @@ module Noe
   # #{summarized_subcommands}
   #
   # DESCRIPTION
-  #   Noe helps development via support for well-designed templates. See
-  #   https://github.com/blambeau/noe for more information.
+  #   Noe is a tool that generates projects from predefined skeletons (aka project 
+  #   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. See https://github.com/blambeau/noe for more information.
   #
   # See '#{program_name} help COMMAND' for more information on a specific command.
   #
@@ -27,8 +30,10 @@ module Noe
     
     # Returns Noe's configuration, loading it if required
     def config
-      @config_file ||= find_config_file
-      Config.new(@config_file)
+      @config ||= begin
+        @config_file ||= find_config_file
+        Config.new(@config_file)
+      end
     end
 
     # Finds the configuration file and loads automatically
@@ -49,22 +54,17 @@ module Noe
                   "Show backtrace on error") do
         @backtrace = true
       end
-      # Show the help and exit
-      opt.on_tail("--help", 
-                  "Show help") do
-        raise Quickl::Help
-      end
-      # Show version and exit
-      opt.on_tail("--version", 
-                  "Show version") do
-        raise Quickl::Exit, "#{program_name} #{Noe::VERSION} (c) 2011, Bernard Lambeau"
-      end
+      Commons.add_common_options(opt)
     end
     
     # Runs the command
     def run(argv, requester = nil)
       super
-    rescue Quickl::Error
+    rescue WLang::Error => ex
+      puts "#{ex.class}: #{ex.message}"
+      back = ex.wlang_backtrace || ex.backtrace
+      puts back.join("\n")
+    rescue Quickl::Error => ex
       raise
     rescue Noe::Error => ex
       puts "#{ex.class}: #{ex.message}"

data/lib/noe/prepare.rb

@@ -0,0 +1,121 @@
+require 'fileutils'
+module Noe
+  class Main
+    #
+    # Prepare the generation of a new project
+    #
+    # SYNOPSIS
+    #   #{program_name} #{command_name} [options] [PROJECT_NAME]
+    #
+    # OPTIONS
+    # #{summarized_options}
+    #
+    # DESCRIPTION
+    #   This command prepares the generation of a fresh new project according to 
+    #   its first argument:
+    #
+    #   - With a project name given as first argument, a new folder is created and 
+    #     a .noespec file is generated in it for the selected template (see below). 
+    #
+    #   - Without project name, Noe assumes that you want the current folder to
+    #     be upgraded to follow the template conventions. In that case, a fresh 
+    #     new .noespec file is simply generated in the current folder.
+    #
+    #   The template specified in ~/.noerc under :default is used by default. 
+    #   Use --template=xxx to override this. 
+    #
+    #   After creation, you'll have to edit the generated .noespec file then run
+    #   'noe go'.
+    #
+    # TYPICAL USAGE
+    #
+    #   To create a fresh new project for a given template (ruby here), play the 
+    #   following scenario:
+    #
+    #     # start creation of a fresh new ruby project
+    #     noe prepare [--template=ruby] [--layout=short] foo
+    #     cd foo
+    #  
+    #     # edit the configuration
+    #     edit foo.noespec
+    #
+    #     # launch template generation
+    #     noe go
+    #
+    #   To upgrade an existing project to follow a template (ruby here), the following 
+    #   scenario is worth considering:
+    #
+    #     # generate a .noespec file in the current folder (let assume 'foo')
+    #     noe prepare [--template=ruby] [--layout=short]
+    #  
+    #     # edit the configuration
+    #     edit foo.noespec
+    #
+    #     # launch template generation in interactive mode
+    #     noe go --interactive
+    #
+    class Prepare < Quickl::Command(__FILE__, __LINE__)
+      include Noe::Commons
+      
+      # Force mode?
+      attr_reader :force
+      
+      # Install options
+      options do |opt|
+        opt.on('--template=TEMPLATE_NAME',
+               "Set the template to use (try 'noe list' to see what exists)") do |name|
+          config.default = name
+        end
+        @layout = "noespec"
+        opt.on('--layout=LAYOUT',
+               "Set the specification layout to use (idem)") do |l|
+          @layout = l
+        end
+        @force = false
+        opt.on('--force', '-f',
+               "Force overriding of existing .noespec file"){ 
+          @force = true
+        }
+        Commons.add_common_options(opt)
+      end
+      
+      def generate_noespec_file(where)
+        if File.exists?(where) and not(force)
+          raise Noe::Error, "File #{where} already exists, remove it first or set --force."
+        else
+          tpl = template
+          File.open(where, 'w') do |out|
+            context = {'template_name' => tpl.name}
+            out << WLang::file_instantiate(tpl.spec_layout_file(@layout), context, "wlang/active-text")
+          end 
+        end
+        where
+      end
+      
+      def execute(args)
+        pname, where = nil, nil
+        case args.size
+        when 0
+          pname = File.basename(File.expand_path('.'))
+          where = generate_noespec_file("#{pname}.noespec")
+        when 1
+          pname = args.first
+          FileUtils.mkdir(pname) unless File.exists?(pname)
+          where = generate_noespec_file(File.join(pname, "#{pname}.noespec"))
+        else
+          raise Quickl::Help unless args.size > 1
+        end
+
+        # what's next
+        puts "Project successfully started !"
+        puts 
+        puts "What's next?"
+        puts " * edit #{where}"
+        puts " * noe go"
+        puts
+        puts "Thank you for using Noe (v#{Noe::VERSION}), enjoy!"
+      end
+
+    end # class Create
+  end # class Main
+end # module Noe

data/lib/noe/show_spec.rb

@@ -0,0 +1,45 @@
+module Noe
+  class Main
+    #
+    # Show the actual noe specification that would be used by 'noe go'
+    #
+    # SYNOPSIS
+    #   #{program_name} #{command_name} [SPEC_FILE]
+    #
+    # OPTIONS
+    # #{summarized_options}
+    #
+    # DESCRIPTION
+    #   This command merges the .noespec file given as first parameter (or found in 
+    #   the current folder) with the noespec.yaml file of the template and prints 
+    #   the result on the standard output.
+    #
+    #   When 'noe go' is invoked, the actual specification it works with is the 
+    #   merging of what you specify in your .noespec file with default values 
+    #   provided by the template specification itself. In other words, your .noespec
+    #   file simply overrides the default values provided in the template itself.
+    #
+    #   Therefore, you can always keep your .noespec files simple by not specifying
+    #   entries for which the default value is ok. However, making so could lead you
+    #   to forget about some template options and this command is useful is such 
+    #   situations.
+    #
+    class ShowSpec < Quickl::Command(__FILE__, __LINE__)
+      include Noe::Commons
+      
+      options do |opt|
+        Commons.add_common_options(opt)
+      end
+      
+      def execute(args)
+        raise Quickl::Help if args.size > 1
+        spec_file = find_noespec_file(args)
+        spec = YAML::load(File.read(spec_file))
+        template = template(spec['template-info']['name'])
+        template.merge_spec(spec)
+        puts template.to_yaml
+      end
+
+    end # class ShowSpec
+  end # class Main
+end # module Noe

data/lib/noe/template.rb

@@ -23,9 +23,30 @@ module Noe
       end
     end
     
-    # Returns path to the spec file
-    def spec_file
-      File.join(folder, "noespec.yaml")
+    def spec_layout_file(layout = 'noespec')
+      file = File.join(folder, "#{layout}.yaml")
+      if File.exists?(file)
+        file
+      else
+        puts "On #{file}"
+        raise Noe::Error, "Unknown specification layout: #{layout}, try 'noe list'"
+      end
+    end
+    alias :spec_file :spec_layout_file
+    
+    # Returns an array with available layout names
+    def layouts
+      Dir[File.join(folder, '*.yaml')].collect{|f| File.basename(f, '.yaml')}
+    end
+    
+    # Merges another spec file inside this template
+    def merge_spec_file(file)
+      merge_spec YAML::load(File.read(spec_file))
+    end
+    
+    # Merges template spec with another spec given from a Hash
+    def merge_spec(hash)
+      @spec = @spec.noe_merge(hash)
     end
     
     # Returns template name  
@@ -33,6 +54,11 @@ module Noe
       File.basename(folder)
     end
     
+    # Returns template summary
+    def summary
+      spec['template-info']['summary'] || description
+    end
+    
     # Returns template description
     def description
       spec['template-info']['description']
@@ -43,6 +69,15 @@ module Noe
       spec['template-info']['version']
     end
     
+    # Returns the template variables entry
+    def variables
+      spec['variables']
+    end
+    
+    def main_wlang_dialect
+      spec['template-info']['main-wlang-dialect']
+    end
+    
     # Returns path to the sources folder
     def src_folder
       File.join(folder, "src")
@@ -58,6 +93,15 @@ module Noe
       Entry.new(self, paths.join(File::PATH_SEPARATOR))
     end
     
+    # Returns manifest Hash for a given entry
+    def manifest_for(entry)
+      manifest = spec['template-info']['manifest'] || {}
+      manifest[entry.path] || {
+        'description'   => "No description for #{entry.path}",
+        'safe-override' => false
+      } 
+    end
+    
     # Visit the template
     def visit(entry = src_folder, &block)
       if entry.is_a?(Entry)
@@ -76,6 +120,11 @@ module Noe
     end
     alias :each :visit
     
+    # Delegated to spec
+    def to_yaml(*args)
+      spec.to_yaml(*args)
+    end
+  
     private :__load
     
     # Entry inside a template structure
@@ -104,7 +153,7 @@ module Noe
       end
       
       # Relocate the path according to variables
-      def relocate(variables)
+      def relocate(variables = template.variables)
         path.split(File::PATH_SEPARATOR).
              collect{|v| rename_one(variables, v)}.
              join(File::PATH_SEPARATOR)
@@ -137,6 +186,37 @@ module Noe
       def child_entry(name)
         template.entry(path.nil? ? name : File.join(path, name))
       end
+      
+      # Returns the hash with the manifest for this entry
+      def manifest
+        template.manifest_for(self)
+      end
+      
+      # Returns wlang dialect to use
+      def wlang_dialect
+        @wlang_dialect ||= begin
+          default = template.main_wlang_dialect
+          manifest['wlang-dialect'] || self.class.infer_wlang_dialect(relocate, default)
+        end
+      end
+      
+      # Infers the wlang dialect to use for the entry
+      def self.infer_wlang_dialect(uri, default = nil)
+        res = case d = WLang::infer_dialect(uri)
+          when nil
+            nil
+          when /^wlang/
+            d
+          else
+            WLang::dialect("wlang/#{d}").qualified_name
+        end
+        res ? res : (default || 'wlang/active-text')
+      end
+      
+      # Is this entry safe to override
+      def safe_override?
+        manifest['safe-override']
+      end
 
     end # class Entry
     

data/noe.gemspec

@@ -1,36 +1,192 @@
-require File.expand_path('../lib/noe', __FILE__)
-spec = Gem::Specification.new do |s|
-  s.name = %q{noe}
-  s.version = Noe::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 "noe"
+$version = Noe::VERSION.dup
 
-  s.author = %q{Bernard Lambeau}
-  s.email = %q{blambeau@gmail.com}
+#
+# 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 = "noe"
+  
+  # Gem version (required)
+  s.version = $version
+  
+  # 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.description = %q{A simple and extensible project generator}
-  s.summary = %q{Noe helps development by providing support for project templates and instantiation.}
+  # 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 = "http://github.com/blambeau/noe"
 
+  # 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{}
+
+  # The rubyforge project this gem lives under (optional)
+  #
+  # s.rubyforge_project = nil
+
+  ################################################################### 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 = ["Bernard Lambeau"]
+  
+  # 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  = ["blambeau@gmail.com"]
+
+  ################################################################### 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 = ["lib"]
+  
+  # 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)]
+  }
+
+  # Test files included in this gem.
+  #
+  s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
+
+  # The path in the gem for executable scripts (optional)
+  #
   s.bindir = "bin"
-  s.executables = ["noe"]
-
-  s.extra_rdoc_files = ["README.md", "CHANGELOG.md"]
-
-  s.files = 
-    Dir['bin/**/*'] +
-    Dir['lib/**/*'] +
-    Dir['spec/**/*'] +
-    Dir['templates/**/*'] +
-    %w{ noe.gemspec Rakefile README.md CHANGELOG.md LICENCE.txt}
-    
-  s.add_dependency('wlang',  '>= 0.9.2')
-  s.add_dependency('quickl', '>= 0.2.0')
-
-  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")
-
-  s.homepage = %q{http://github.com/blambeau/noe}
-end
 
+  # Executables included in the gem.
+  #
+  s.executables = (Dir["bin/*"]).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
+  #
+  s.add_development_dependency("rake", "~> 0.8.7")
+  s.add_development_dependency("bundler", "~> 1.0")
+  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_dependency("quickl", "~> 0.2.0")
+  s.add_dependency("highline", "~> 1.6.0")
+
+  # 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 = []
+  
+  # External (to RubyGems) requirements that must be met for this gem to work. 
+  # It’s simply information for the user.
+  #
+  s.requirements = nil
+  
+  # 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 = "Noe successfully installed!\n\nWhat's next?\n  - 'noe help install' for configuration and default templates\n  - 'noe prepare --template=ruby hello_world'\n\nThank you for using Noe, enjoy!\n"
+
+  ################################################################### 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 = []
+
+  # Extra files to add to RDoc such as README
+  #
+  s.extra_rdoc_files = Dir["README.md"] + Dir["CHANGELOG.md"] + Dir["LICENCE.md"]
+
+end