templatron 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca21f5aac9c3bd51b3316ef87238c19832833ab8
-  data.tar.gz: 1b2cfa06b0f856fc2d7c504e8f40bee95ef26720
+  metadata.gz: 00b8850a510c189094e5761a68649d231319d9ec
+  data.tar.gz: 8736415297d84d92655d62e5e881d256e5eddb59
 SHA512:
-  metadata.gz: 485ecfdd834358e64fad9ee80fe73a4f1d0c31dfa63454a5a1382e661c833a2c46d6dfc6f8352892e73f76a3cc6e47de083711a2ef4c6214d410ad665490ef65
-  data.tar.gz: 30a4f9bd4718346ce401e68ab8391bee40b6b68c111f2e119f0f6a63f609a40e1ea741222105511c97c524ee8a0a5c4648b0e58ce7ebca58801e943d1c318b40
+  metadata.gz: f6b63bf41e826cf3862b3f4031bc5b74484bb16d8e7f168136b86a16ed32277b5437e73e1eee19bd356f9d3d98d8034948b80a4672061580719fdd5256a8af69
+  data.tar.gz: d70378ea9c97efff778e180e9e3272686b43acb022060a3745cdd0044e18f29254ccf2d2cba29fc6feea39b7877fc5fb0481f2b8dff2c912c28b0bdb4f40dc0a

data/lib/templatron/cli.rb

@@ -1,80 +1,71 @@
 # -*- encoding: utf-8 -*-
+require 'clamp'
 require 'templatron/version'
 require 'templatron/config'
 require 'templatron/generator'
-require 'optparse'
-require 'ostruct'
+require 'templatron/collector'
 
 module Templatron
 
-  # Public: CLI Stuff, parse command line inputs to determine what to do
-  def self.execute
-
-    usage = 'Usage: templatron TEMPLATE_NAME [args] [-o output_dir]'
-
-    # If no argument has been given, print usage
-    if ARGV.length == 0
-      puts usage
-      exit
+  # Represents a base class with command flags
+  class AbstractCommand < Clamp::Command
+    option ['-v', '--verbose'], :flag, 'Enable verbose mode', :default => false
+    option '--version', :flag, 'Show the current version' do
+      puts Templatron::VERSION
+      exit(0)
     end
+  end
 
-    # Defines the structure and default values
-    options = OpenStruct.new
-    options.output_dir = Dir.pwd
-    options.verbose = false
-    options.delete_dir = false
-
-    # Defines options parser
-    opt_parser = OptionParser.new do |opts|
-      opts.banner = usage
-      opts.default_argv = '-h'
-
-      opts.separator ''
-      opts.separator 'Features:'
-
-      # Defines where to put generated files
-      opts.on('-o', '--output PATH', 'Where to put the generated files') do |dir|
-        options.output_dir = dir
-      end
-
-      # Should we remove the output directory first
-      opts.on('-d', '--delete', 'If set, clear the output directory first') do
-        options.delete_dir = true
-      end
-
-      opts.separator ''
-      opts.separator 'Common options:'
+  # Use to list the template dir
+  class ListCommand < AbstractCommand
+    parameter '[SUB_PATH]', 'Relative path to list from',
+      :attribute_name => :subpath,
+      :default => ''
+    option ['-a', '--all'], :flag, 'Also show files', :default => false
 
-      # Verbose mode
-      opts.on('-v', '--verbose', 'Verbose mode') do
-        options.verbose = true
-      end
+    def execute
+      col = Collector.new(subpath, all?, false, verbose?)
+      entries = col.list
 
-      # Print the help
-      opts.on_tail('-h', '--help', 'Show this message') do
-        puts opts
-        puts ''
-        puts "Templates path: #{Templatron::templates_path}"
-        exit
-      end
+      entries.each { |e| puts e.sub(col.full_path, '') }
+    end
+  end
 
-      # Print version number
-      opts.on_tail('--version', 'Show version') do
-        puts Templatron::VERSION
-        exit
-      end
+  # Use to build stuff!
+  class BuildCommand < AbstractCommand
+    parameter 'TEMPLATE_NAME', 'Template to generate from',
+      :attribute_name => :template
+    parameter '[ARGS] ...', 'Template arguments',
+      :attribute_name => :arguments
+    option ['-o', '--output'], 'OUTPUT_DIR', 'Where to put the generated files',
+      :default => Dir.pwd
+    option ['-d', '--delete'], :flag, 'Clear the output folder first', 
+      :default => false
+
+    def execute
+      # Instantiate the generator and build the stuff
+      gen = Generator.new(
+        template, 
+        arguments, 
+        output,
+        delete?, 
+        verbose?)
+      t_start = Time.now      
+      gen.build
+      t_end = Time.now
+      puts "BUILT in #{t_end - t_start} seconds"
     end
+  end
 
-    opt_parser.parse!(ARGV)
+  # Entry point of the cli
+  class MainCommand < AbstractCommand
+    subcommand 'build', 'Build from templates', BuildCommand
+    subcommand 'list', 'List available templates', ListCommand
+  end
 
-    # Instantiate the generator and build the stuff
-    gen = Generator.new(
-      ARGV[0], 
-      ARGV[1..ARGV.length], 
-      options.output_dir,
-      options.delete_dir, 
-      options.verbose)
-    gen.build
+  # Public: CLI Stuff, parse command line inputs to determine what to do
+  def self.execute
+    MainCommand.run
   end
 
 end

data/lib/templatron/collector.rb

@@ -0,0 +1,96 @@
+# -*- encoding: utf-8 -*-
+require 'templatron/config'
+
+module Templatron
+
+  # Collector stuff
+  # Show templates and related informations
+  class Collector
+
+    attr_accessor :full_path
+
+    # Public: Initialize the collector instance
+    # 
+    # path - Relative path of a template
+    # include_files - Also include files or not
+    # include_sub - Incluse subfolders?
+    # verbose - Verbose mode?
+    def initialize(path, include_files, include_sub, verbose = false)
+      @full_path = File.join(Templatron::templates_path, expand_path(path))
+      @verbose = verbose
+      @include_files = include_files
+      @include_subfolders = include_sub
+    end
+
+    # Public: List the content of this template
+    # 
+    # Returns the list of entries for this instance
+    def list
+      puts "Listing content: of directory #{@full_path}" if @verbose
+
+      v = ['**']
+      v << '*' if @include_subfolders
+
+      entries = Dir.glob(escape_glob(File.join(@full_path, v)))
+      entries.map! { |e| e if File.directory?(e) }.compact! if !@include_files
+
+      entries
+    end
+
+    protected
+
+    # Internal: Escape special characters, needed for glob to work
+    # 
+    # str - String to escape
+    # 
+    # Returns an escaped string
+    def escape_glob(str)
+      str.gsub(/[\\\{\}\[\]\?]/) { |x| "\\"+x }
+    end
+
+    # Internal: Expand the path by looking in each subfolders and replacing default
+    # placeholder values with their real names
+    # 
+    # Notes
+    #   It may need a little refactoring
+    # 
+    # path - Path to expand
+    # 
+    # Examples
+    # 
+    #   Given base/profile/authors, it will returns base/profile/{$1 authors}
+    # 
+    # Returns the real path
+    def expand_path(path)
+      tmp = path
+      final_path_components = []
+
+      until (p = File.split(tmp)).first == '.'
+        tmp = p.first
+        component = p.last
+
+        # Gets all entries in this folder
+        base_path = File.join(Templatron::templates_path, tmp)
+
+        Dir.glob(escape_glob(File.join(base_path, '*'))).each do |e|
+          next if !File.directory?(e) # Only process folders
+
+          e.scan(Templatron::PLACEHOLDER_REG).each do |match|
+            # Replace this component if it matches the user input
+            if component.include?(match[1])
+              component.sub!(match[1], e.match(Templatron::placeholder_block_reg(match[1])).to_s)
+            end
+          end
+        end
+
+        final_path_components << component
+      end
+
+      final_path_components << p.last
+
+      File.join(final_path_components.reverse)
+    end
+
+  end
+
+end

data/lib/templatron/config.rb

@@ -4,8 +4,29 @@ module Templatron
   # This part will be joined to the user Dir.home
   PREFIX = '.templatron'
 
+  PLACEHOLDER_REG = /{\$(\d*)\W?([\w\s]*)}/
+
   # Public: Retrieve the full path which stores templates
   def self.templates_path
     File.join(Dir.home, PREFIX)
   end
+
+  # Public: Retrieve the placeholder reg for replacement
+  # 
+  # match_i - Match key
+  # 
+  # Returns the regex for replacement
+  def self.placeholder_reg(match_i)
+    /{\$#{match_i}\W?([\w\s]*)}/
+  end
+
+  # Public: Retrieve the placeholder reg block which contains
+  # the whole placeholder markup
+  # 
+  # key - Key to look for
+  # 
+  # Returns the regex needed to retrieve the whole placeholder markup
+  def self.placeholder_block_reg(key)
+    /({\$\d*\W?[#{key}]*})/
+  end
 end

data/lib/templatron/generator.rb

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
-require 'FileUtils'
+require 'fileutils'
 require 'templatron/config'
+require 'templatron/collector'
 
 module Templatron
 
@@ -20,7 +21,8 @@ module Templatron
       @output = File.expand_path(output_dir)
       @verbose = verbose
       @clear = delete_dir
-      @full_template_path = File.join(Templatron::templates_path, @template)
+
+      @collector = Collector.new(@template, true, true)
 
       process_raw_arguments(args)
     end
@@ -28,7 +30,7 @@ module Templatron
     # Public: Effectively process a template to generate it
     def build
       # Check template existence
-      if !check_template_dir(@full_template_path)
+      if !check_template_dir(@collector.full_path)
         puts "The template #{@template} does not appear to exist in #{@full_template_path}"
         exit
       end
@@ -36,28 +38,45 @@ module Templatron
       # If sets, remove the output folder first
       if @clear
         puts "Clearing #{@output}" if @verbose
-        FileUtils.remove_dir(@output, true)
+        begin
+          FileUtils.remove_dir(@output)
+        rescue => ex
+          puts """Could not clear the folder, maybe someone is accessing it?
+  
+  #{ex.message}
+"""
+          exit(1)
+        end
       end
 
       # Print details if verbose is on
       if @verbose
-        puts "Starting building #{@full_template_path} to #{@output}"
-        puts "With:"
+        puts "Starting building #{@collector.full_path} to #{@output}"
+        puts "With:" if !@arguments.empty?
         @arguments.each_with_index do |arg, i|
           puts "\t{$#{i}} => #{arg}" if !arg.nil?
         end
       end
 
-      # And then process each files/folder
-      collect_str = File.join(@full_template_path, '**', '*')
-      # At this point, all file entries have been collected
-      entries = Dir[collect_str].map { |p| p if File.file?(p) }.compact
       # So process them right now
-      process_files(entries)
+      process_files(@collector.list)
     end
 
     protected
 
+    # Internal: Try to create a directory and fails gracefuly
+    def create_directory(path)
+      begin
+        FileUtils.mkdir_p(path)
+      rescue => ex
+        puts """Error while creating the directory #{path}
+
+  #{ex.message}
+"""
+        exit(1)
+      end
+    end
+
     # Internal: Process each entries, copy the files and replaces variables
     # 
     # entries - An array of files to process
@@ -65,23 +84,30 @@ module Templatron
       entries.each do |path|
 
         # Get base path
-        new_path = path.gsub(@full_template_path, '')
+        new_path = path.sub(@collector.full_path, '')
         
+        is_dir = File.directory?(path)
+
         # Apply arguments to the path
         apply_arguments!(new_path)
 
-        # Now we can copy the entry
         full_new_path = File.join(@output, new_path)
 
-        puts "Copying #{path} to #{full_new_path}" if @verbose
+        if is_dir
+          puts "Creating directory #{path} to #{full_new_path}" if @verbose
+          create_directory(full_new_path)
+        else
+          # Now we can copy the entry
+          puts "Copying #{path} to #{full_new_path}" if @verbose
 
-        FileUtils.mkdir_p(File.dirname(full_new_path))
-        FileUtils.copy(path, full_new_path)
+          create_directory(File.dirname(full_new_path))
+          FileUtils.copy(path, full_new_path)
 
-        file_content = File.read(full_new_path)
-        apply_arguments!(file_content)
-        File.open(full_new_path, 'w') do |f|
-          f.puts file_content
+          file_content = File.read(full_new_path)
+          apply_arguments!(file_content)
+          File.open(full_new_path, 'w') do |f|
+            f.puts file_content
+          end
         end
       end
     end
@@ -109,17 +135,20 @@ module Templatron
     # 
     # str - Where to look & replace
     def apply_arguments!(str)
-      str.scan(/{\$(\d*)\W?([\w\s]*)}/).each do |match|
+      str.scan(Templatron::PLACEHOLDER_REG).each do |match|
         match_i = match[0].to_i
         arg_value = @arguments[match_i]
         arg_value = match[1] if arg_value.nil?
-        str.gsub!(/{\$#{match_i}\W?([\w\s]*)}/, arg_value)
+
+        str.gsub!(Templatron::placeholder_reg(match_i), arg_value)
       end
     end
 
     # Internal: Check if the template directory exists
     # 
     # dir - Where to look
+    # 
+    # Returns true if the directory exists, false otherwise
     def check_template_dir(dir)
       Dir.exist?(dir)
     end

data/lib/templatron/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Templatron
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: templatron
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Julien Leicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies: []
 description: Defines templates with variables and generates whatever you want
 email:
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - bin/templatron
 - lib/templatron/cli.rb
+- lib/templatron/collector.rb
 - lib/templatron/config.rb
 - lib/templatron/generator.rb
 - lib/templatron/version.rb