noe 1.0.0 → 1.1.0

data/lib/noe/go.rb

@@ -1,10 +1,10 @@
 module Noe
   class Main
     #
-    # Instantiate a project template using a .noespec file.
+    # Instantiate a project template using a .noespec file
     #
     # SYNOPSIS
-    #   #{program_name} #{command_name} [options] [SPEC_FILE]
+    #   #{program_name} #{command_name} [--dry-run] [--force|--interactive|--add-only|--safe-override] [SPEC_FILE]
     #
     # OPTIONS
     # #{summarized_options}
@@ -14,18 +14,18 @@ module Noe
     #   given as first argument. If no spec file is specified, Noe expects 
     #   one .noespec file to be present in the current directory and uses it.
     # 
-    #   This command is generally used immediately after invoking 'create',
+    #   This command is generally used immediately after invoking 'prepare',
     #   on an almost empty directory. By default it safely fails if any file
-    #   or directory would be overriden by the instantiation process. This
-    #   safe behavior can be bypassed through the --force and --add-only 
-    #   options.
+    #   would be overriden by the instantiation process. This safe behavior 
+    #   can be bypassed through the --force, --add-only, --interactive and
+    #   --safe-override options.
     #
     # TYPICAL USAGE
     #
     #   When a fresh new project is created, this command is typically used
-    #   with the following scenario
+    #   within the following scenario
     #
-    #     noe create --ruby hello_world
+    #     noe prepare --template=ruby hello_world
     #     cd hello_world
     #     edit hello_world.noespec
     #     noe go
@@ -41,17 +41,29 @@ module Noe
     #     rm README.md hello_world.gemspec
     #     noe go --add-only
     #
+    #   If you want to regenerate some files by controlling what will be 
+    #   overriden:
+    #
+    #     noe go --interactive
+    #
+    #   If you want to regenerate some files according to the template 
+    #   manifest:
+    #
+    #     noe go --safe-override
+    #
     class Go < Quickl::Command(__FILE__, __LINE__)
       include Noe::Commons
 
-      # Dry-run mode ?
       attr_reader :dry_run
       
-      # Force mode ?
       attr_reader :force
+      alias :force? :force
 
-      # Only make additions ?
       attr_reader :adds_only
+      alias :adds_only? :adds_only
+
+      attr_reader :safe_override
+      alias :safe_override? :safe_override
 
       # Install options
       options do |opt|
@@ -60,70 +72,171 @@ module Noe
                "Say what would be done but don't do it"){ 
           @dry_run = true
         }
+        opt.separator ""
+        opt.separator "File overriding control: "
         @force = false
         opt.on('--force', '-f',
                "Force overriding on all existing files"){ 
           @force = true
         }
+        @interactive = false
+        opt.on('--interactive', '-i',
+               "Request the user to take a decision"){ 
+          @interactive = true
+          @highline = HighLine.new
+        }
         @adds_only = false
         opt.on('--add-only', '-a',
                "Only make additions, do not override any existing file"){ 
           @adds_only = true
         }
+        @safe_override = false
+        opt.on('--safe-override', '-s',
+               "Follow safe-override information provided by the manifest"){ 
+          @safe_override = true
+        }
+        Commons.add_common_options(opt)
+      end
+      
+      # Checks if the interactive mode is enabled. If yes, highline is prepared
+      # as a side effect.
+      def interactive?
+        if @interactive and not(@highline)
+          begin
+            require "highline"
+            @highline = HighLine.new
+          rescue LoadError
+            raise Quickl::Exit.new(1), "Highline is required for interactive mode, try 'gem install highline'"
+          end
+        else
+          @interactive
+        end
       end
       
-      def build_one(entry, variables)
+      def say(what, color)
+        if @highline
+          @highline.say(@highline.color(what, color))
+        else
+          puts what
+        end
+      end
+      
+      def choose(&block)
+        @highline.choose(&block)
+      end
+      
+      # Checks if one is a file and the other a directory or the inverse
+      def kind_clash?(entry, relocated)
+        (entry.file? and File.directory?(relocated)) or
+        (entry.directory? and File.file?(relocated))
+      end
+      
+      def build_one_directory(entry, variables)
         relocated = entry.relocate(variables)
         todo = []
         
-        # The file already exists, we should maybe do something
+        skipped = false
+        if File.exists?(relocated) 
+          # file exists already exists, check what can be done!
+          if kind_clash?(entry, relocated)
+            if interactive?
+              say("File #{relocated} conflicts with directory to create", :red)
+              choose do |menu|
+                menu.prompt = "What do we do?"
+                menu.index = :letter
+                menu.choice(:abord) { raise Quickl::Exit.new(1), "Noe aborted!" }
+                menu.choice(:remove){ todo << Rm.new(entry, variables)          }
+              end 
+            elsif force?
+              todo << Rm.new(entry, variables)
+            else
+              raise Quickl::Exit.new(2), "Noe aborted: file #{relocated} already exists.\n"\
+                                         "Use --force to override or --interactive for more options."
+            end
+          else
+            # file exists and is already a folder; we simply do nothing 
+            # because there is no dangerous action here
+            skipped = true
+          end
+        end 
+        
+        # Create the directory unless it has been explicitely skipped
+        unless skipped
+          todo << MkDir.new(entry, variables)
+        end
+        
+        todo
+      end
+
+      def build_one_file(entry, variables)
+        relocated = entry.relocate(variables)
+        todo = []
+        
+        skipped = false
         if File.exists?(relocated)
-          if force
-            unless entry.directory? and File.directory?(relocated)
+          # name clash, the file exists
+          if adds_only?
+            # file exists and we are only allowed to add new things
+            # we just do nothing
+            skipped = true
+          elsif interactive? and kind_clash?(entry, relocated)
+            say("Directory #{relocated} conflicts with file to create", :red)
+            choose do |menu|
+              menu.prompt = "What do we do?"
+              menu.index = :letter
+              menu.choice(:abord) { raise Quickl::Exit.new(1), "Noe aborted!" }
+              menu.choice(:remove){ todo << Rm.new(entry, variables)          }
+              menu.choice(:skip)  { skipped = true                            }
+            end 
+          elsif interactive?
+            say("File #{relocated} already exists", :red)
+            choose do |menu|
+              would = entry.safe_override? ? :override : :skip
+              menu.prompt = "What do we do? (safe-override would #{would})"
+              menu.index = :letter
+              menu.choice(:abord)   { raise Quickl::Exit.new(1), "Noe aborted!" }
+              menu.choice(:override){ todo << Rm.new(entry, variables)          }
+              menu.choice(:skip)    { skipped = true                            }
+            end
+          elsif safe_override?
+            if entry.safe_override?
               todo << Rm.new(entry, variables)
+            else
+              skipped = true
             end
-          elsif adds_only
-            return todo
+          elsif force?
+            todo << Rm.new(entry, variables)
           else
-            raise Noe::Error, "Noe aborted: file #{relocated} already exists.\n"\
-                              "Use --force to override."
+            raise Quickl::Exit.new(2), "Noe aborted: file #{relocated} already exists.\n"\
+                                       "Use --force to override or --interactive for more options."
           end
         end
         
-        # Create directories
-        if entry.directory? and not(File.exists?(relocated))
-          todo << MkDir.new(entry, variables)
-          
-        # Create files  
-        elsif entry.file?
+        # Add file instantiation unless skipped
+        unless skipped
           todo << FileInstantiate.new(entry, variables)
-
         end
+        
         todo
       end
       
       def execute(args)
         raise Quickl::Help if args.size > 1
         
-        # Find spec file
-        spec_file = if args.size == 1
-          valid_read_file!(args.first)
-        else
-          spec_files = Dir['*.noespec']
-          if spec_files.size > 1
-            raise Noe::Error, "Ambiguous request, multiple specs: #{spec_files.join(', ')}"
-          end
-          spec_files.first
-        end
-        
         # Load spec now
+        spec_file = find_noespec_file(args)
         spec = YAML::load(File.read(spec_file))
         template = template(spec['template-info']['name'])
-        variables = spec['variables']
+        template.merge_spec(spec)
+        variables = template.variables
         
         # Build what has to be done
         commands = template.collect{|entry|
-          build_one(entry, variables)
+          if entry.file?
+            build_one_file(entry, variables)
+          elsif entry.directory?
+            build_one_directory(entry, variables)
+          end
         }.flatten
         
         # let's go now
@@ -144,6 +257,10 @@ module Noe
           @entry, @variables = entry, variables
         end
         
+        def template
+          entry.template
+        end
+        
         def relocated
           entry.relocate(variables)
         end
@@ -178,7 +295,8 @@ module Noe
         
         def run
           File.open(relocated, 'w') do |out|
-            dialect = "wlang/active-string"
+            dialect = entry.wlang_dialect
+            variables.methodize!
             out << WLang::file_instantiate(entry.realpath, variables, dialect)
           end
         end

data/lib/noe/install.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 module Noe
   class Main
     #
-    # Install default configuration and template.
+    # Install default configuration and template (not required).
     #
     # SYNOPSIS
     #   #{program_name} #{command_name} [--force] [FOLDER]
@@ -11,12 +11,17 @@ module Noe
     # #{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.
+    #   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. 
+    #   If FOLDER/.noerc already exists, the comand safely fails. Use --force to 
+    #   override existing configuration. 
+    #
+    # TIP
+    #   Installing default templates and configuration is NOT required. Noe uses
+    #   their internal representation by default. Use 'noe install' only if you
+    #   plan to create your own templates or want to tune default ones.
     #
     class Install < Quickl::Command(__FILE__, __LINE__)
       include Noe::Commons
@@ -31,6 +36,7 @@ module Noe
                "Force overriding on all existing files"){ 
           @force = true
         }
+        Commons.add_common_options(opt)
       end
 
       def execute(args)
@@ -79,7 +85,7 @@ module Noe
         puts " * cat #{noerc_file}"
         puts " * ls -lA #{noe_folder}"
         puts " * noe list"
-        puts " * noe create hello_world"
+        puts " * noe prepare hello_world"
         puts
         puts "Thank you for using Noe (v#{Noe::VERSION}), enjoy!"
       end

data/lib/noe/list.rb

@@ -1,13 +1,13 @@
 module Noe
   class Main
     #
-    # List available templates.
+    # List available templates
     #
     # SYNOPSIS
     #   #{program_name} #{command_name} 
     #
     # DESCRIPTION
-    #   This command list project templates found in the templates folder. 
+    #   This command lists project templates found in the templates folder. 
     #   The later is checked as a side effect. 
     #
     # TIP
@@ -16,20 +16,44 @@ module Noe
     class List < Quickl::Command(__FILE__, __LINE__)
       include Noe::Commons
       
+      options do |opt|
+        Commons.add_common_options(opt)
+      end
+      
+      def max(i,j)
+        i > j ? i : j
+      end
+      
       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|
+        tpls = Dir[File.join(templates_dir, '**')].collect{|tpldir| Template.new(tpldir)}
+        columns = [:name, :version, :layouts, :summary]
+        data = [ columns ] + tpls.collect{|tpl|
           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
+            columns.collect{|col| 
+              if col == :layouts
+                (tpl.send(col) - ["noespec"]).to_a.join(',')
+              else
+                tpl.send(col).to_s.strip
+              end
+            }
+          rescue Exception => ex
+            [ tpl.name, "", "", "Template error: #{ex.message}" ]
+          end
+        }
+        lengths = data.inject([0,0,0,0]){|memo,columns|
+          (0..3).collect{|i| max(memo[i], columns[i].to_s.length)}
+        }
+        puts "Templates available in #{templates_dir}"
+        data.each_with_index do |line,i|
+          current = (config.default == line[0])
+          puts (current ? " -> " : "    ") +
+               "%-#{lengths[0]}s   %-#{lengths[1]}s   %-#{lengths[2]}s   %-#{lengths[3]}s" % line
+          if i==0
+            puts "-"*lengths.inject(0){|memo,i| memo+i+3}
           end
         end
       end

data/lib/noe/loader.rb

@@ -0,0 +1,67 @@
+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")