directory_template 1.0.0

data/README.markdown

@@ -0,0 +1,100 @@
+README
+======
+
+
+Summary
+-------
+Lets you generate directory structures from a template, optionally processing paths
+(variables in the path) and contents (e.g., render ERB templates).
+
+Features
+--------
+
+* Generate directories and files
+* Use a directory structure as template, or store the template in a YAML file
+* Interpolate variables in directory- and filenames
+* Render ERB and Markdown templates
+* Write & use your own processors
+
+
+Installation
+------------
+`gem install directory_template`
+
+
+Usage
+-----
+
+The examples given below are working examples. The templates are part of the gem and can
+be found in the directory 'examples'.
+
+Create a template from an existing structure and materialize it (create directories &
+files):
+
+    require 'directory_template'
+    variables = {
+      namespace:    'Namespace',
+      version:      '1.2.3',
+      gem_name:     'gem-name',
+      require_name: 'require_name',
+      description:  "The description",
+      summary:      "The summary"
+    }
+    template = DirectoryTemplate.directory('examples/dir_gem_template')
+    template.materialize('new_project', variables: variables)
+
+Create a template from a YAML file:
+
+    require 'directory_template'
+    variables = {
+      namespace:    'Namespace',
+      version:      '1.2.3',
+      gem_name:     'gem-name',
+      require_name: 'require_name',
+      description:  "The description",
+      summary:      "The summary"
+    }
+    template = DirectoryTemplate.yaml_file('examples/yaml_gem_template.yaml')
+    template.materialize('new_project', variables: variables)
+
+
+Description
+-----------
+DirectoryTemplate is a library which lets you generate directory structures and files
+from a template structure. The template structure can be a real directory structure on
+the filesystem, or it can be stored in a yaml file. Take a look at the examples directory
+in the gem to get an idea, how a template can look.
+
+When generating a new directory structure from a template, DirectoryTemplate will process
+the pathname of each directory and file using the DirectoryTemplate#path_processor.
+It will also process the contents of each file with all processors that apply to a given
+file.
+The standard path processor allows you to use `%{variables}` in pathnames. The gem comes
+with a .erb (renders ERB templates) and .html.markdown processor (renders markdown to
+html).
+You can use the existing processors or define your own ones.
+
+Also take a look at the {file:documentation/ContentProcessors.markdown Content Processors Guide}
+and the {file:documentation/ContentProcessors.markdown Path Processors Guide}.
+
+
+Links
+-----
+
+* [Online API Documentation](http://rdoc.info/github/apeiros/directory_template/)
+* [Public Repository](https://github.com/apeiros/directory_template)
+* [Bug Reporting](https://github.com/apeiros/directory_template/issues)
+* [RubyGems Site](https://rubygems.org/gems/directory_template)
+
+
+Credits
+-------
+
+* Daniel Schärli, for proofreading the docs
+
+
+License
+-------
+
+You can use this code under the {file:LICENSE.txt BSD-2-Clause License}, free of charge.
+If you need a different license, please ask the author.

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.expand_path('../rake/lib', __FILE__))
+Dir.glob(File.expand_path('../rake/tasks/**/*.{rake,task,rb}', __FILE__)) do |task_file|
+  begin
+    import task_file
+  rescue LoadError => e
+    warn "Failed to load task file #{task_file}"
+    warn "  #{e.class} #{e.message}"
+    warn "  #{e.backtrace.first}"
+  end
+end

data/directory_template.gemspec

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name                      = "directory_template"
+  s.version                   = "1.0.0"
+  s.authors                   = "Stefan Rusterholz"
+  s.homepage                  = "https://github.com/apeiros/directory_template"
+  s.description               = <<-DESCRIPTION.gsub(/^    /, '').chomp
+    Create directories from templates.
+    Existing directory structures, yaml files and ruby datastructures can all serve as
+    sources of a template.
+    Can preprocess pathnames and content.
+    Path- and ContentProcessors are exchangeable.
+  DESCRIPTION
+  s.summary                   = <<-SUMMARY.gsub(/^    /, '').chomp
+    Create directories from templates, optionally preprocessing paths and contents.
+  SUMMARY
+  s.email                     = "stefan.rusterholz@gmail.com"
+
+  s.files                     =
+    Dir['bin/**/*'] +
+    Dir['lib/**/*'] +
+    Dir['rake/**/*'] +
+    Dir['examples/**/*'] +
+    Dir['documentation/**/*'] +
+    Dir['test/**/*'] +
+    Dir['*.gemspec'] +
+    %w[
+      Rakefile
+      README.markdown
+    ]
+
+  if File.directory?('bin') then
+    executables = Dir.chdir('bin') { Dir.glob('**/*').select { |f| File.executable?(f) } }
+    s.executables = executables unless executables.empty?
+  end
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1")
+  s.rubygems_version          = "1.3.1"
+  s.specification_version     = 3
+end

data/documentation/ContentProcessors.markdown

@@ -0,0 +1,19 @@
+CONTENT PROCESSORS
+==================
+
+
+Included Processors
+-------------------
+
+DirectoryTemplate comes with the following content processors:
+
+* :erb - Renders files with the '.erb' Suffix as ERB Templates.
+* :html\_to\_markdown - Renders markdown files to html. It is applied to all files which
+  have .html.markdown as suffix (only the .markdown will be dropped).
+
+
+Rolling your own
+----------------
+
+See {DirectoryTemplate::Processor} for informations on how to create a content processor.
+

data/documentation/PathProcessors.markdown

@@ -0,0 +1,17 @@
+PATH PROCESSORS
+===============
+
+
+Included Processors
+-------------------
+
+DirectoryTemplate comes with a simple path processor, it just replaces variables in the
+form of `%{variable_name}` within paths with the value in `variable_name`. It takes the
+variables from :path_variables and :variables in the env (in that order).
+
+
+Rolling your own
+----------------
+
+See {DirectoryTemplate::Processor} for informations on how to create a path processor.
+For a path processor, you'll leave the pattern argument to nil.

data/examples/dir_gem_template/%{gem_name}/%{gem_name}.gemspec.stop.erb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name                      = <%= gem_name.inspect %>
+  s.version                   = <%= version.to_s.inspect %>
+  s.authors                   = <%= author.inspect %>
+  s.description               = <<-DESCRIPTION.gsub(/^    /, '').chomp
+<%= description && description.gsub(/^/,'    ').sub(/\n*\z/, "\n") %>
+  DESCRIPTION
+  s.summary                   = <<-SUMMARY.gsub(/^    /, '').chomp
+<%= summary && summary.gsub(/^/,'    ').sub(/\n*\z/, "\n") %>
+  SUMMARY
+  s.email                     = <%= email.inspect %>
+
+  s.files                     =
+    Dir['bin/**/*'] +
+    Dir['lib/**/*'] +
+    Dir['rake/**/*'] +
+    Dir['test/**/*'] +
+    Dir['*.gemspec'] +
+    %w[
+      Rakefile
+      README.markdown
+    ]
+  if File.directory?('bin') then
+    executables = Dir.chdir('bin') { Dir.glob('**/*').select { |f| File.executable?(f) } }
+    s.executables = executables unless executables.empty?
+  end
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1")
+  s.rubygems_version          = "1.3.1"
+  s.specification_version     = 3
+end

data/examples/dir_gem_template/%{gem_name}/README.markdown.stop.erb

@@ -0,0 +1,21 @@
+README
+======
+
+
+Summary
+-------
+<%= summary %>
+
+
+Installation
+------------
+`gem install <%= gem_name %>`
+
+
+Usage
+-----
+
+
+Description
+-----------
+<%= description %>

data/examples/dir_gem_template/%{gem_name}/README_DIRECTORIES.stop

@@ -0,0 +1,9 @@
+This readme informs you about the purpose of the directories
+
+PROJECT/bin:            Executable files
+PROJECT/documentation:  Prosa documentation of your project
+PROJECT/development:    Ideas and other things relevant for developing
+PROJECT/lib:            Your ruby library files
+PROJECT/rake/lib:       Libraries that are not part of your library, but used by your rake tasks
+PROJECT/rake/tasks:     Your rake tasks, using either .rb, .task or .rake as suffix
+PROJECT/test:           The tests for your library

data/examples/dir_gem_template/%{gem_name}/Rakefile.stop

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.expand_path('../rake/lib', __FILE__))
+Dir.glob(File.expand_path('../rake/tasks/**/*.{rake,task,rb}', __FILE__)) do |task_file|
+  begin
+    import task_file
+  rescue LoadError => e
+    warn "Failed to load task file #{task_file}"
+    warn "  #{e.class} #{e.message}"
+    warn "  #{e.backtrace.first}"
+  end
+end

data/examples/dir_gem_template/%{gem_name}/lib/%{require_name}/version.rb.stop.erb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+begin
+  require 'rubygems/version' # newer rubygems use this
+rescue LoadError
+  require 'gem/version' # older rubygems use this
+end
+
+module <%= namespace %>
+  Version = Gem::Version.new(<%= version.to_s.inspect %>)
+end

data/examples/dir_gem_template/%{gem_name}/lib/%{require_name}.rb.stop.erb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+
+
+require '<%= require_name %>/version'
+
+
+
+# <%= namespace.chomp %>
+<%= description.gsub(/\n*\z/, '').gsub(/^/, '# ')+"\n" %>
+module <%= namespace %>
+end

data/examples/yaml_gem_template.yaml

@@ -0,0 +1,110 @@
+'%{gem_name}':
+  'bin':
+    '%{gem_name}.stop': ~
+  'development': {}
+  'documentation': {}
+  'lib':
+    '%{require_name}':
+      'version.rb.stop.erb': |
+        # encoding: utf-8
+        
+        begin
+          require 'rubygems/version' # newer rubygems use this
+        rescue LoadError
+          require 'gem/version' # older rubygems use this
+        end
+        
+        module <%= namespace %>
+          Version = Gem::Version.new(<%= version.to_s.inspect %>)
+        end
+    '%{require_name}.rb.stop.erb': |
+      # encoding: utf-8
+      
+      
+      
+      require '<%= require_name %>/version'
+      
+      
+      
+      # <%= namespace.chomp %>
+      <%= description.gsub(/\n*\z/, '').gsub(/^/, '# ')+"\n" %>
+      module <%= namespace %>
+      end
+  '%{gem_name}.gemspec.stop.erb': |
+      # encoding: utf-8
+      
+      Gem::Specification.new do |s|
+        s.name                      = <%= gem_name.inspect %>
+        s.version                   = <%= version.to_s.inspect %>
+        s.authors                   = <%= author.inspect %>
+        s.description               = <<-DESCRIPTION.gsub(/^    /, '').chomp
+      <%= description && description.gsub(/^/,'    ').sub(/\n*\z/, "\n") %>
+        DESCRIPTION
+        s.summary                   = <<-SUMMARY.gsub(/^    /, '').chomp
+      <%= summary && summary.gsub(/^/,'    ').sub(/\n*\z/, "\n") %>
+        SUMMARY
+        s.email                     = <%= email.inspect %>
+
+        s.files                     =
+          Dir['bin/**/*'] +
+          Dir['lib/**/*'] +
+          Dir['rake/**/*'] +
+          Dir['test/**/*'] +
+          Dir['*.gemspec'] +
+          %w[
+            Rakefile
+            README.markdown
+          ]
+        if File.directory?('bin') then
+          executables = Dir.chdir('bin') { Dir.glob('**/*').select { |f| File.executable?(f) } }
+          s.executables = executables unless executables.empty?
+        end
+
+        s.required_rubygems_version = Gem::Requirement.new("> 1.3.1")
+        s.rubygems_version          = "1.3.1"
+        s.specification_version     = 3
+      end
+  'Rakefile.stop': |
+    $LOAD_PATH.unshift(File.expand_path('../rake/lib', __FILE__))
+    Dir.glob(File.expand_path('../rake/tasks/**/*.{rake,task,rb}', __FILE__)) do |task_file|
+      begin
+        import task_file
+      rescue LoadError => e
+        warn "Failed to load task file #{task_file}"
+        warn "  #{e.class} #{e.message}"
+        warn "  #{e.backtrace.first}"
+      end
+    end
+  'README_DIRECTORIES.stop': |
+    This readme informs you about the purpose of the directories
+    
+    PROJECT/bin:            Executable files
+    PROJECT/documentation:  Prosa documentation of your project
+    PROJECT/development:    Ideas and other things relevant for developing
+    PROJECT/lib:            Your ruby library files
+    PROJECT/rake/lib:       Libraries that are not part of your library, but used by your rake tasks
+    PROJECT/rake/tasks:     Your rake tasks, using either .rb, .task or .rake as suffix
+    PROJECT/test:           The tests for your library
+  'README.markdown.stop.erb': |
+    README
+    ======
+    
+    
+    Summary
+    -------
+    <%= summary %>
+    
+    
+    Installation
+    ------------
+    `gem install <%= gem_name %>`
+    
+    
+    Usage
+    -----
+    
+    
+    Description
+    -----------
+    <%= description %>
+  'test': {}

data/lib/directory_template/blank_slate.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+
+
+
+require 'stringio'
+
+
+
+class DirectoryTemplate
+
+  # BlankSlate provides an abstract base class with no predefined
+  # methods (except for <tt>\_\_send__</tt> and <tt>\_\_id__</tt>).
+  # BlankSlate is useful as a base class when writing classes that
+  # depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
+  #
+  # === Copyright
+  #
+  # Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
+  # All rights reserved.
+  # Permission is granted for use, copying, modification, distribution,
+  # and distribution of modified versions of this work as long as the
+  # above copyright notice is included.
+  #
+  # Modified by Stefan Rusterholz (stefan.rusterholz@gmail.com)
+  class BlankSlate
+
+    # Hide the method named +name+ in the BlankSlate class.  Don't
+    # hide +instance_eval+ or any method beginning with "__".
+    #
+    # @return [self]
+    def self.hide(name)
+      verbosity = $VERBOSE
+      stderr    = $stderr
+      $VERBOSE  = nil
+      $stderr   = StringIO.new
+
+      methods = instance_methods.map(&:to_sym)
+      if methods.include?(name.to_sym) and
+        name !~ /^(__|instance_eval)/
+        @hidden_methods ||= {}
+        @hidden_methods[name.to_sym] = instance_method(name)
+        undef_method name
+      end
+
+      self
+    ensure
+      $VERBOSE = verbosity
+      $stderr  = stderr
+    end
+
+    # @return [UnboundMethod] The method that was hidden.
+    def self.find_hidden_method(name)
+      @hidden_methods ||= {}
+      @hidden_methods[name] || superclass.find_hidden_method(name)
+    end
+
+    # Redefine a previously hidden method so that it may be called on a blank
+    # slate object.
+    #
+    # @return [self]
+    def self.reveal(name)
+      hidden_method = find_hidden_method(name)
+      fail "Don't know how to reveal method '#{name}'" unless hidden_method
+      define_method(name, hidden_method)
+
+      self
+    end
+
+    instance_methods.each { |m| hide(m) }
+  end
+end
+
+
+
+# @private
+# Extensions to Object for DirectoryTemplate::BlankSlate.
+# Since Ruby is very dynamic, methods added to the ancestors of
+# {DirectoryTemplate::BlankSlate} after BlankSlate is defined will show up in the
+# list of available BlankSlate methods.  We handle this by defining a hook in the Object
+# and Kernel classes that will hide any method defined after BlankSlate has been loaded.
+#
+module Kernel
+  class << self
+    # Preserve the original method
+    alias template_directory_blank_slate_method_added method_added
+  end
+
+  # @private
+  # Detect method additions to Kernel and remove them in the
+  # BlankSlate class.
+  def self.method_added(name)
+    result = template_directory_blank_slate_method_added(name)
+    return result if self != ::Kernel
+    DirectoryTemplate::BlankSlate.hide(name)
+    result
+  end
+end
+
+# @private
+# Extensions to Object for DirectoryTemplate::BlankSlate.
+# Since Ruby is very dynamic, methods added to the ancestors of
+# {DirectoryTemplate::BlankSlate} after BlankSlate is defined will show up in the
+# list of available BlankSlate methods.  We handle this by defining a hook in the Object
+# and Kernel classes that will hide any method defined after BlankSlate has been loaded.
+#
+class Object
+  class << self
+    # Preserve the original method
+    alias template_directory_blank_slate_method_added method_added
+  end
+
+  # @private
+  # Detect method additions to Object and remove them in the
+  # BlankSlate class.
+  def self.method_added(name)
+    result = template_directory_blank_slate_method_added(name)
+    return result if self != Object
+    DirectoryTemplate::BlankSlate.hide(name)
+    result
+  end
+
+  # @private
+  # See DirectoryTemplate::BlankSlate::find_hidden_method
+  # This just serves as a stopper/terminator of the lookup chain.
+  def self.find_hidden_method(name)
+    nil
+  end
+end
+
+# @private
+# Extensions to Module for DirectoryTemplate::BlankSlate.
+# Modules included into Object need to be scanned and have their instance methods removed
+# from {DirectoryTemplate::BlankSlate}. In theory, modules included into Kernel would have
+# to be removed as well, but a "feature" of Ruby prevents late includes into modules from
+# being exposed in the first place.
+#
+class Module
+
+  # @private
+  # Preserve the original method
+  alias template_directory_blank_slate_method_added append_features
+
+  # @private
+  # Monkey patch to the append_features callback of Module, used to update the BlankSlate.
+  def append_features(mod)
+    result = template_directory_blank_slate_method_added(mod)
+    return result if mod != Object
+    instance_methods.each do |name|
+      DirectoryTemplate::BlankSlate.hide(name)
+    end
+    result
+  end
+end