gitplate 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+v0.0.2
+======
+* Captures the plate repository url/sha in .gitplate/config.yml
+* Define tasks in plate file that can be called from the gitplate command line
+* gitplate init to setup an existing repository with gitplate
+
+v0.0.1
+======
+* install a new project from a git repository

data/README.md

@@ -0,0 +1,31 @@
+Gitplate is a templating solution using git repositories.
+
+Do you often create new projects and have a common repository structure you like to use, with a set of basic build
+scripts? Gitplate aims to make it quick and simple to get a new project up and running. Point gitplate at any git
+repository to have a new project created in its image. Gitplate will also run a 'plate' file on the new
+repository. This plate file can contain tasks to rename files as well as any extra actions you require.
+
+#### Installation:
+    gem install gitplate
+
+
+#### Example
+Initialize an existing git repository for gitplate. Creates a .gitplate directory with a sample plate file
+
+    gitplate init
+
+Install an existing repository to setup a new project
+
+    gitplate install myproject git://github.com/lukesmith/RepositoryTemplate
+
+
+#### Example plate file:
+    init do
+      rename 'SampleSolution.sln', "#{project_name}.sln"
+      rename 'SampleSolution.build.bat', "#{project_name}.build.bat"
+      rename 'SampleSolution.package.bat', "#{project_name}.package.bat"
+    end
+
+    task :dosomething do
+      # call via 'gitplate task dosomething'
+    end

data/bin/gitplate

@@ -42,6 +42,20 @@ command :install do |c|
   end
 end
 
+desc 'Initialize the current directory as a gitplate repository'
+command :init do |c|
+  c.action do |g, options, args|
+    Gitplate.init
+  end
+end
+
+desc 'Run task'
+command :task do |c|
+  c.action do |g, options, args|
+    Gitplate.task args[0], args[1..-1]
+  end
+end
+
 pre do |global,command,options,args|
   if (global[:v])
     puts Gitplate::VERSION

data/lib/gitplate/gitplate.rb

@@ -1,43 +1,139 @@
 require 'Git'
+require 'zip/zip'
 
 module Gitplate
 
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
-  def self.install(name, repository)
-    if (File.directory? name)
+  def self.config_file
+    '.gitplate/config.yml'
+  end
+
+  def self.plate_file
+    '.gitplate/plate'
+  end
+
+  def self.init
+    init_directory_for_gitplate
+
+    if (!File.exists?(plate_file))
+      debug_msg "Creating sample plate file"
+
+      # create the sample plate file
+      File.open(plate_file, "w") { |f|
+        f.write("init do\n")
+        f.write("  # add code to run when installing a new project\n")
+        f.write("end\n")
+      }
+    end
+  end
+
+  def self.get_plate_repository(project_name, repository)
+    source_repository_sha = ""
+
+    Dir.chdir project_name do
+      # create a gitplate directory structure for checking out the repository to
+      out_path = File.expand_path(File.join('.gitplate', 'tmp', 'checkout'))
+      FileUtils.mkdir_p out_path
+
+      archive_file = File.expand_path(File.join('.gitplate', 'tmp', "#{project_name}.zip"))
+
+      Dir.chdir out_path do
+        source_repository = Git.clone(repository, project_name)
+        source_repository_sha = source_repository.object('HEAD').sha
+
+        source_repository.archive(source_repository_sha, archive_file, :format => "zip")
+      end
+
+      unzip_file archive_file, Dir.pwd
+
+      # get rid of the temporary directory
+      clear_directory File.expand_path(File.join('.gitplate', 'tmp'))
+    end
+
+    source_repository_sha
+  end
+
+  def self.install(project_name, repository)
+    if (File.directory? project_name)
       fatal_msg_and_fail "Directory already exists"
     end
 
-    puts "creating #{name} based on #{repository}"
+    info_msg "creating #{project_name} based on #{repository}"
 
-    out_path = File.expand_path(File.join(name, 'tmp', 'checkout'))
-    FileUtils.mkdir_p out_path
+    FileUtils.mkdir_p project_name
     
-    Git.clone(repository, name, :path => out_path)
+    source_repository_sha = get_plate_repository(project_name, repository)
+
+    # we've got the repository cloned and cleaned up of existing git history
+    Dir.chdir project_name do
+      # Ensure the directory has been initialized with gitplate
+      init_directory_for_gitplate
+      
+      update_config_with({
+          :project => { :name => project_name },
+          :repository => { :url => repository, :sha => source_repository_sha },
+          :gitplate_version => Gitplate::VERSION
+        })
 
-    # move the repository files to the main directory
-    files = Dir.glob("#{out_path}/#{name}/*") - [name]
-    FileUtils.mkdir name unless File.directory? name
-    FileUtils.cp_r files, name
+      # pull in the plate file from the cloned repository
+      if (File.exists?(plate_file))
+        Gitplate::Plate.instance.run(
+            plate_file,
+            {
+              :project_name => project_name,
+              :project_dir => Dir.pwd
+            })
+      else
+        debug_msg "no plate file found in repository"
+      end
 
-    # get rid of the temporary checkout directory
-    clear_directory File.expand_path(File.join(name, 'tmp'))
+      g = Git.init
+      g.add
+      g.commit "Initial commit"
+    end
+  end
+
+  def self.task(task, args)
+    config = load_gitplate_file
+
+    Gitplate::Plate.instance.run_task(
+        plate_file,
+        task,
+        {
+          :project_name => config["project"]["name"],
+          :project_dir => Dir.pwd
+        })
+  end
 
-    Dir.chdir name do
-      Git.init
+  def self.init_directory_for_gitplate()
+    if (!File.directory? name)
+      FileUtils.mkdir_p '.gitplate'
     end
 
-    # pull in the plate file from the cloned repository
-    plate = File.expand_path(File.join(name, 'plate'))
-    if (File.exists?(plate))
-      Gitplate::Plate.instance.run(
-          plate,
-          :project_name => name,
-          :project_dir => File.expand_path(name))
-    else
-      debug_msg "no plate file found in repository"
+    if (!File.exists?(config_file))
+      debug_msg "Creating config file"
+      File.open(config_file, 'w') { |f| YAML.dump({}, f) }
+    end
+  end
+
+  def self.load_gitplate_file
+    YAML.load(File.open(config_file))
+  end
+
+  def self.update_config_with(values)
+    config = load_gitplate_file
+
+    formatted = format_hash_for_yaml values
+    formatted.each do |name, value|
+      config[name.to_s] = value
     end
+
+    File.open(config_file, 'w') { |f| YAML.dump(config, f) }
+  end
+
+  def self.info_msg(msg)
+    puts msg.color(:green).bright
   end
 
   def self.debug_msg(msg)
@@ -59,5 +155,29 @@ module Gitplate
       FileUtils.rm_rf full_path
     end
   end
+
+  def self.format_hash_for_yaml(hash)
+    result = Hash.new
+
+    hash.each do |name, value|
+      if (value.kind_of? Hash)
+        result[name.to_s] = format_hash_for_yaml value
+      else
+        result[name.to_s] = value
+      end
+    end
+
+    result
+  end
+
+  def self.unzip_file(file, destination)
+    Zip::ZipFile.open(file) { |zip_file|
+      zip_file.each { |f|
+        f_path=File.join(destination, f.name)
+        FileUtils.mkdir_p(File.dirname(f_path))
+        zip_file.extract(f, f_path) unless File.exist?(f_path)
+     }
+  }
+end
   
 end

data/lib/gitplate/plate.rb

@@ -3,13 +3,23 @@ module Gitplate
 
   class Plate
     include Singleton
-    
+
     def initialize
-      @actions = []
+      @tasks = Hash.new
+    end
+
+    def add_init(&block)
+      if (@init != nil)
+        Gitplate.fatal_msg_and_fail "Init can only be defined once"
+      end
+
+      Gitplate.debug_msg "  found init"
+      @init = block
     end
 
-    def self.actions
-      @actions
+    def add_task(task_name, &block)
+      Gitplate.debug_msg "  found task '#{task_name}'"
+      @tasks[task_name.to_s] = block
     end
 
     def output(type, msg)
@@ -30,13 +40,43 @@ module Gitplate
       @project_name
     end
 
+    def project_dir
+      @project_dir
+    end
+
     def run(file, args)
+      load_plate file, args
+
+      if (@init != nil)
+        Gitplate.debug_msg "running plate - start"
+        @init.call
+        Gitplate.debug_msg "running plate - completed"
+      end
+    end
+
+    def run_task(file, task_name, args)
+      load_plate file, args
+
+      task = @tasks[task_name]
+
+      if (task == nil)
+        Gitplate.fatal_msg_and_fail "Unable to find custom task '#{task_name}'"
+      end
+
+      Gitplate.debug_msg "running task '#{task_name}' - start"
+      task.call
+      Gitplate.debug_msg "running task '#{task_name}' - completed"
+    end
+
+    def load_plate(file, args)
       @project_name = args[:project_name]
       @project_dir = args[:project_dir]
+      
+      #file = "/Users/lukesmith/Projects/gitplate/tmp/plate"
 
-      Gitplate.debug_msg "running plate - start"
+      Gitplate.debug_msg "loading plate from '#{file}'"
       load file
-      Gitplate.debug_msg "running plate - completed"
+      Gitplate.debug_msg "loaded plate"
     end
 
     def to_class_name(type)
@@ -64,10 +104,18 @@ module Gitplate
 
 end
 
+def init(&block)
+  Gitplate::Plate.instance.add_init &block
+end
+
 def project_name
   Gitplate::Plate.instance.project_name
 end
 
+def project_dir
+  Gitplate::Plate.instance.project_dir
+end
+
 def output(type, msg)
   Gitplate::Plate.instance.output type, "  #{msg}"
 end
@@ -78,4 +126,8 @@ end
 
 def rename(from, to)
   Gitplate::Plate.instance.rename from, to
+end
+
+def task(task_name, &block)
+  Gitplate::Plate.instance.add_task task_name, &block
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitplate
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Luke Smith
@@ -46,7 +46,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: rubyzip
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -57,10 +57,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: rake
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -73,6 +73,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: Project templates from a git repository
 email: 
 - stuff@lukesmith.net
@@ -87,6 +101,8 @@ files:
 - lib/gitplate/plate.rb
 - bin/gitplate
 - LICENSE
+- CHANGELOG.md
+- README.md
 homepage: http://www.gitplate.com/
 licenses: []