noe 1.0.0

data/lib/noe/help.rb

@@ -0,0 +1,26 @@
+module Noe
+  class Main
+    # 
+    # Show help about a specific command
+    #
+    # SYNOPSIS
+    #   #{program_name} #{command_name} COMMAND
+    #
+    class Help < Quickl::Command(__FILE__, __LINE__)
+      
+      # Let NoSuchCommandError be passed to higher stage
+      no_react_to Quickl::NoSuchCommand
+      
+      # Command execution
+      def execute(args)
+        if args.size != 1
+          puts super_command.help
+        else
+          cmd = has_command!(args.first, super_command)
+          puts cmd.help
+        end
+      end
+      
+    end # class Help
+  end # class Main
+end # module Noe

data/lib/noe/install.rb

@@ -0,0 +1,89 @@
+require 'fileutils'
+module Noe
+  class Main
+    #
+    # Install default configuration and template.
+    #
+    # SYNOPSIS
+    #   #{program_name} #{command_name} [--force] [FOLDER]
+    #
+    # OPTIONS
+    # #{summarized_options}
+    #
+    # DESCRIPTION
+    #   This command will install Noe's default configuration under 
+    #   FOLDER/.noerc and a default ruby template under FOLDER/.noe.
+    #   Unless stated otherwise, FOLDER is user's home.
+    #
+    #   If FOLDER/.noerc already exists, the comand safely fails. 
+    #   Use --force to override existing configuration. 
+    #
+    class Install < Quickl::Command(__FILE__, __LINE__)
+      include Noe::Commons
+      
+      # Force mode ?
+      attr_reader :force
+
+      # Install options
+      options do |opt|
+        @force = false
+        opt.on('--force', '-f',
+               "Force overriding on all existing files"){ 
+          @force = true
+        }
+      end
+
+      def execute(args)
+        if args.size > 1
+          raise Quickl::InvalidArgument, "Needless arguments: #{args[1..-1].join(' ')}"
+        end
+        folder = args.first || ENV['HOME']
+        
+        noerc_file = File.join(folder, '.noerc')
+        noe_folder = File.join(folder, '.noe')
+
+        # generate .noerc
+        if File.exists?(noerc_file) and not(force)
+          raise Noe::Error, "#{noerc_file} already exists, use --force to override"
+        end
+        File.open(noerc_file, 'w') do |out|
+          def_config = File.join(File.dirname(__FILE__), 'config.yaml')
+          context = { :templates_dir => noe_folder}
+          out << WLang::file_instantiate(def_config, context, 'wlang/active-string')
+        end
+        
+        # generate .noe folder
+        unless File.exists?(noe_folder)
+          FileUtils.mkdir(noe_folder)
+        end
+        
+        # copy default templates
+        tdir = File.expand_path('../../../templates', __FILE__)
+        Dir[File.join(tdir, '*')].each do |tpl|
+          target = File.join(noe_folder, File.basename(tpl))
+          if File.exists?(target)
+            if force 
+              FileUtils.rm_rf target
+            else
+              puts "#{target} already exists, use --force to override"
+              next
+            end
+          end
+          FileUtils.cp_r tpl, noe_folder
+        end
+        
+        # say something!
+        puts "Noe successfully installed !"
+        puts 
+        puts "What's next?"
+        puts " * cat #{noerc_file}"
+        puts " * ls -lA #{noe_folder}"
+        puts " * noe list"
+        puts " * noe create hello_world"
+        puts
+        puts "Thank you for using Noe (v#{Noe::VERSION}), enjoy!"
+      end
+
+    end # class Install
+  end # class Main
+end # module Noe

data/lib/noe/list.rb

@@ -0,0 +1,39 @@
+module Noe
+  class Main
+    #
+    # List available templates.
+    #
+    # SYNOPSIS
+    #   #{program_name} #{command_name} 
+    #
+    # DESCRIPTION
+    #   This command list project templates found in the templates folder. 
+    #   The later is checked as a side effect. 
+    #
+    # TIP
+    #   Run this command to know where templates are located!
+    #
+    class List < Quickl::Command(__FILE__, __LINE__)
+      include Noe::Commons
+      
+      def execute(args)
+        unless args.empty?
+          raise Quickl::InvalidArgument, "Needless argument: #{args.join(', ')}"
+        end
+
+        puts "Templates located in: #{templates_dir}"
+        Dir[File.join(templates_dir, '**')].collect do |tpl_dir|
+          begin
+            tpl = Template.new(tpl_dir)
+            puts "  * %-#{25}s    %s" % [ "#{tpl.name} (v#{tpl.version})" , tpl.description ]
+            tpl
+          rescue => ex
+            puts "  * %-#{25}s    %s" % [File.basename(tpl_dir), ex.message]
+            nil
+          end
+        end
+      end
+
+    end # class List
+  end # class Main
+end # module Noe

data/lib/noe/main.rb

@@ -0,0 +1,79 @@
+module Noe
+  #
+  # Noe - A simple and extensible project generator
+  #
+  # SYNOPSIS
+  #   #{program_name} [--version] [--help] COMMAND [cmd opts] ARGS...
+  #
+  # OPTIONS
+  # #{summarized_options}
+  #
+  # COMMANDS
+  # #{summarized_subcommands}
+  #
+  # DESCRIPTION
+  #   Noe helps development via support for well-designed templates. See
+  #   https://github.com/blambeau/noe for more information.
+  #
+  # See '#{program_name} help COMMAND' for more information on a specific command.
+  #
+  class Main < Quickl::Delegate(__FILE__, __LINE__)
+    
+    # Configuration instance
+    attr_reader :config_file
+    
+    # Show backtrace on error?
+    attr_reader :backtrace
+    
+    # Returns Noe's configuration, loading it if required
+    def config
+      @config_file ||= find_config_file
+      Config.new(@config_file)
+    end
+
+    # Finds the configuration file and loads automatically
+    def find_config_file
+      in_home = File.join(ENV['HOME'], '.noerc')
+      File.file?(in_home) ? in_home : nil
+    end
+    
+    # Install options
+    options do |opt|
+      # Set a specific configuration file to use
+      opt.on('--config=FILE',
+             'Use a specific config file (defaults to ~/.noerc)') do |f|
+        @config_file = valid_read_file!(f)
+      end
+      # Show backtrace on error
+      opt.on_tail("--backtrace", 
+                  "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
+    end
+    
+    # Runs the command
+    def run(argv, requester = nil)
+      super
+    rescue Quickl::Error
+      raise
+    rescue Noe::Error => ex
+      puts "#{ex.class}: #{ex.message}"
+      puts ex.backtrace.join("\n") if backtrace
+    rescue StandardError => ex
+      puts "Oups, Noe encountered a serious problem! Please report if a bug."
+      puts "#{ex.class}: #{ex.message}"
+      puts ex.backtrace.join("\n")
+    end
+
+  end # class Main
+end # module Noe

data/lib/noe/template.rb

@@ -0,0 +1,144 @@
+module Noe
+  class Template
+    include Enumerable
+    
+    # Main folder of the template
+    attr_reader :folder
+    
+    # Loaded specification
+    attr_reader :spec
+    
+    # Creates a template instance
+    def initialize(folder)
+      @folder = folder
+      __load
+    end
+  
+    # Loads the template from its folder
+    def __load
+      if File.file?(spec_file) and File.readable?(spec_file)
+        @spec = YAML::load(File.read(spec_file))
+      else
+        raise Noe::Error, "Unable to find template: #{spec_file}"
+      end
+    end
+    
+    # Returns path to the spec file
+    def spec_file
+      File.join(folder, "noespec.yaml")
+    end
+    
+    # Returns template name  
+    def name
+      File.basename(folder)
+    end
+    
+    # Returns template description
+    def description
+      spec['template-info']['description']
+    end
+    
+    # Returns template version
+    def version
+      spec['template-info']['version']
+    end
+    
+    # Returns path to the sources folder
+    def src_folder
+      File.join(folder, "src")
+    end
+    
+    # Ignore some file?
+    def ignore?(file)
+      ['.', '..'].include? File.basename(file)
+    end
+    
+    # Returns an entry for a given relative path
+    def entry(*paths)
+      Entry.new(self, paths.join(File::PATH_SEPARATOR))
+    end
+    
+    # Visit the template
+    def visit(entry = src_folder, &block)
+      if entry.is_a?(Entry)
+        block.call(entry) 
+      else
+        entry = Entry.new(self, nil)
+      end  
+      if entry.directory?
+        Dir.foreach(entry.realpath) do |child|
+          childentry = entry.child_entry(child)
+          unless ignore?(childentry.realpath)
+            visit(childentry, &block)
+          end
+        end
+      end
+    end
+    alias :each :visit
+    
+    private :__load
+    
+    # Entry inside a template structure
+    class Entry
+      
+      # Template where this entry is located
+      attr_reader :template
+      
+      # Relative path of the entry inside the template
+      attr_reader :path
+      
+      # Creates an entry instance
+      def initialize(template, path)
+        @template = template
+        @path = path
+      end
+      
+      # Returns real absolute path of the entry
+      def realpath
+        path.nil? ? template.src_folder : File.join(template.src_folder, path)
+      end
+      
+      # Returns entry name
+      def name
+        File.basename(realpath)
+      end
+      
+      # Relocate the path according to variables
+      def relocate(variables)
+        path.split(File::PATH_SEPARATOR).
+             collect{|v| rename_one(variables, v)}.
+             join(File::PATH_SEPARATOR)
+      end
+      
+      # Returns the target name, according to some variables
+      def rename_one(variables, name = self.name)
+        if name =~ /__([a-z]+)__/
+          if x = variables[$1]
+            name.gsub(/__([a-z]+)__/, x)
+          else
+            raise Noe::Error, "Missing variable #{$1}"
+          end
+        else
+          name
+        end
+      end
+      
+      # Is the entry a file?
+      def file?
+        File.file?(realpath)
+      end
+      
+      # Is the entry a directory?
+      def directory?
+        File.directory?(realpath)
+      end
+      
+      # Builds an child entry for a given name
+      def child_entry(name)
+        template.entry(path.nil? ? name : File.join(path, name))
+      end
+
+    end # class Entry
+    
+  end # class Template
+end # module Noe

data/noe.gemspec

@@ -0,0 +1,36 @@
+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')
+
+  s.author = %q{Bernard Lambeau}
+  s.email = %q{blambeau@gmail.com}
+
+  s.description = %q{A simple and extensible project generator}
+  s.summary = %q{Noe helps development by providing support for project templates and instantiation.}
+
+  s.require_paths = ["lib"]
+  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
+

data/spec/noe_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../spec_helper', __FILE__)
+describe Noe do
+  
+  it "should have a version number" do
+    Noe.const_defined?(:VERSION).should be_true
+  end
+  
+end

data/spec/spec_helper.rb

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

data/spec/template/entry/relocate_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+module Noe
+  describe "Template::Entry#relocate" do
+    
+    let(:template){ 
+      Template.new(File.expand_path('../../../../templates/ruby', __FILE__)) 
+    }
+    let(:vars){ 
+      {"lower" => "project"} 
+    }
+    subject{ 
+      entry.relocate(vars) 
+    }
+    
+    describe "when nothing has to change" do
+      let(:entry){ template.entry('.gitignore') }
+      it{ should == ".gitignore" }
+    end
+
+    describe "when exactly a replacement" do
+      let(:entry){ template.entry("__lower__") }
+      it { should == "project" }
+    end
+    
+    describe "when a replacement inside something else" do
+      let(:entry){ template.entry("__lower___spec.rb") }
+      it { should == "project_spec.rb" }
+    end
+    
+    describe "when no replace and sub file" do
+      let(:entry){ template.entry("lib", "README.md") }
+      it { should == ["lib", "README.md"].join(File::PATH_SEPARATOR)  }
+    end
+    
+    describe "when no replace and sub file with replacement" do
+      let(:entry){ template.entry("lib", "__lower__.rb") }
+      it { should == ["lib", "project.rb"].join(File::PATH_SEPARATOR)  }
+    end
+
+  end 
+end # module Noe