klipp 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ad411833795ad014a927e4dc6851f5d4c2630d6
-  data.tar.gz: 85ae4b599bf421be5ec49b50ff4f9b7bc699585b
+  metadata.gz: 65f854ee8a77a48f90783f08804f8e9f98d854fd
+  data.tar.gz: b361e5e190a5cd52039de0f5fd470ca193808944
 SHA512:
-  metadata.gz: d3ef430e9e4110b425a3da45dfef5ab577e65d7c24f73aac7ca6c32c8c97beb4deb5b9956731bf9affd09d50788b5b090724633fa5862ff51fb89a2643dfc350
-  data.tar.gz: df73b6338e8583b51dc78a855b532eb5e429eada147258db201b3b4b12d3e4b3c7a71fe75e267e3ec36221c985a727d23d032a1783599fd1c5c6bf54fd234d4b
+  metadata.gz: 78cbc60461c33266df988e6786016ff039f8c3a4d0aec50dccf0541568cc7cac322459f649ba351f63db223a604c960784ecdff51681a6912e239649832925b3
+  data.tar.gz: de1ddee465b7b099eb8196c8286dfc38445aad486b06d831d91e4e4fa765fe315ce4a6c3bf9aacc66665e53770cf82746e2a2dc50df593b719b068eaf88c0e32

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea
+.idea
+Sandbox

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+
+script: bundle exec rspec spec

data/README.md

@@ -1,7 +1,9 @@
-# Klipp
-## Xcode templates for the rest of us.
+# Klipp [![Build Status](https://travis-ci.org/epologee/klipp.png)](https://travis-ci.org/epologee/klipp) [![Coverage Status](https://coveralls.io/repos/epologee/klipp/badge.png)](https://coveralls.io/r/epologee/klipp)
+## Code templates for the rest of us.
 
-Klipp is a command line gem for creating new (Xcode) projects from existing templates. Unlike Apple's private plist-based templating system, Klipp takes an existing Xcode project and creates a new project by copying and modifying an existing template project by your own specifications.
+Klipp is a ruby gem with a command line interface for creating new programming projects from existing templates. It was originally designed to create Xcode projects. However, there are no Apple or Xcode specific features in Klipp, so you can use it for pretty much any textfile-and-directory-based template.
+
+When compared to Xcode's plist-based templating system, Klipp takes an existing Xcode project and creates a new project by copying and modifying an existing template project by your own specifications.
 
 ## Installation
 
@@ -13,31 +15,16 @@ Execute and read the usage instructions:
 
     $ klipp
 
-## Usage
-
-Klipp creates a template repository in your home directory, at ~/.klipp/templates
-A template consists of a directory and an accompanying Yaml file, e.g.:
-
-    TemplateA
-	TemplateA.yml
-
-Once you have templates like these present, you can prepare a new instance of that project by executing:
-
-    $ klipp prepare TemplateA
-
-This will create a TemplateA.klippfile in your current directory, for you to edit with your favorite text editor.
-From there, customize your project and when happy with the results, run:
-
-    $ klipp create
+## CLI under construction ...
 
-This will create a new directory called TemplateA, that contains your new project.
-	
-## Known issues
+Klipp is still in the early development stage. When 0.1 ships, the CLI will feature:
 
-* Creating templates is done manually, this will be automated
-* Errors while parsing the .klippfile are not yet handled gracefully
-* Highline support for on-the-fly creation of new projects is not yet enabled
-* The root of newly created projects carries the same name as the template, this will be adjustable.
+* `klipp repo add <repo-name> [<repo-url>]` - git init [or clone] template repositories in the `~/.klipp` directory
+* `klipp template spec <template-name>` - creates a new template specificiation called `<template-name>.klippspec`, for you to configure your template's properties.
+* `klipp template push <repo-name>` - push a new template to one of your template repositories.
+* `klipp template list [<repo-name>]` - list all available templates on your machine [per repository]
+* `klipp prepare <template-name>` - prepare the creation of files from a new template, by authoring a `Klippfile`
+* `klipp create [<template-name>]` - create files based on the prepared `Klippfile` [or interactively from the terminal].
 
 ## Contributing
 

data/bin/klipp

@@ -3,4 +3,4 @@
 require 'klipp'
 
 Klipp::Configuration.auto_create_dirs = true
-Klipp.route(*ARGV)
+exit Klipp.route(*ARGV)

data/klipp.gemspec

@@ -13,14 +13,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/epologee/klipp'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/).map
+  #do |f|
+  #  f unless f.include?('spec/fixtures') || f.include?("_spec.rb")
+  #end
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'highline'
-  spec.add_development_dependency 'ptools'
-  spec.add_development_dependency 'colored'
+  spec.add_runtime_dependency 'bundler', '~> 1.3'
+  spec.add_runtime_dependency 'rake'
+  spec.add_runtime_dependency 'ptools'
+  spec.add_runtime_dependency 'formatador'
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'grit'
+  spec.add_runtime_dependency 'highline'
 end

data/lib/klipp/configuration.rb

@@ -22,10 +22,6 @@ module Klipp
       auto_create File.join(Dir.home, '.klipp')
     end
 
-    def self.templates_dir
-      auto_create File.join(root_dir, 'templates')
-    end
-
   end
 
 end

data/lib/klipp/creator.rb

@@ -0,0 +1,78 @@
+module Klipp
+
+  class Creator
+    attr_reader :identifier, :tokens
+
+    def self.from_file(path)
+      raise "Klippfile not found in directory #{File.dirname path}. Run `klipp prepare`." unless File.exists? path
+      string = IO.read path
+      creator = Klipp::Creator.new
+      creator.eval_string(string, path)
+    end
+
+    def self.from_user_input(template_identifier, highline)
+      creator = Klipp::Creator.new
+      creator.ask_user_input(template_identifier, highline)
+    end
+
+    def initialize
+      @tokens = Hash.new
+    end
+
+    def eval_string(string, path)
+      begin
+        eval(string, nil, path)
+      rescue Exception => e
+        raise "Error evaluating klippfile: #{File.basename(path)}: #{e.message}\n  #{e.backtrace.join("\n  ")}"
+      end
+      validate
+    end
+
+    def ask_user_input(identifier, highline = HighLine.new)
+      @identifier = identifier
+      spec_path = Template::Spec.spec_path_for_identifier(identifier)
+      template = Template::Spec.from_file(spec_path)
+      template.each do |name, token|
+        self.tokens[name] = highline.ask("#{token.comment}?") { |q|
+          q.validate = token.validation if token.validation
+          q.responses[:not_valid] = token.validation_hint if token.validation_hint
+        } unless token.hidden
+      end
+      validate
+    end
+
+    def validate
+      msg = 'Klippfile invalid: '
+      invalidate msg+'missing name' unless @identifier && @identifier.length > 0
+      matching_specs = Template::Spec.specs_matching_identifier(@identifier)
+
+      case
+        when matching_specs.count == 0
+          msg += "Unknown template name `#{@identifier}`. "
+          msg += "Run `klipp template list` to see your options."
+          invalidate msg+msg
+        when matching_specs.count > 1
+          msg += "Found multiple templates named `#{@identifier}`. "
+          msg += "Use a full template identifier to pick one. "
+          msg += "Run `klipp template list` to see your options."
+          hint msg+msg
+        else
+          self
+      end
+    end
+
+    def invalidate(message)
+      raise message
+    end
+
+    def hint(message)
+      raise Klipp::Hint.new(message)
+    end
+
+    def create(template_identifier, &config)
+      @identifier = template_identifier
+      config.yield(@tokens) if block_given?
+    end
+  end
+
+end

data/lib/klipp/parameter_list.rb

@@ -8,9 +8,9 @@ module Klipp
       self - options
     end
 
-    #def splice_option(name)
-    #  !!delete(name)
-    #end
+    def splice_option(name)
+      !!delete(name)
+    end
 
     def shift_argument
       (arg = arguments[0]) && delete(arg)

data/lib/klipp/version.rb

@@ -1,3 +1,3 @@
 module Klipp
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/klipp.rb

@@ -1,135 +1,191 @@
-require 'klipp/buffered_output'
-require 'klipp/version'
+require 'ptools'
+require 'formatador'
+require 'colorize'
+require 'fileutils'
+require 'grit'
+require 'highline/import'
+
+require 'template'
 require 'klipp/configuration'
-require 'klipp/token'
-require 'klipp/template'
+require 'klipp/version'
 require 'klipp/parameter_list'
-require 'klipp/project'
-require 'colorize'
+require 'klipp/creator'
 
 module Klipp
-  extend BufferedOutput::ClassMethods
 
-  def self.display_exception exception
-    if exception.is_a? HelpRequest
-      help = exception
-    else
-      help = HelpRequest.new exception.message, true
-      help.set_backtrace(exception.backtrace)
-    end
+  class Hint < StandardError
+  end
+
+  def self.env
+    @@env ||= StringInquirer.new('prod')
+  end
 
-    buffer_puts help.message
-    exit help.exit_status
+  def self.env=(env)
+    @@env = env
   end
 
   def self.route(*argv)
-    @params = Klipp::ParameterList.new(argv)
-    command = @params.shift_argument
+    params = Klipp::ParameterList.new(argv)
+    command = params.shift_argument;
+    commands = {
+        prepare: lambda { cli_prepare(params) },
+        create: lambda { cli_create(params) },
+        template: lambda { Template.route(*params) }
+    }
     case command
-      when 'version'
-        version
-      when 'list'
-        list
-      when 'prepare'
-        prepare @params.first
-      when 'create'
-        create @params.first
       when nil
-        raise HelpRequest.new('Use one of the commands below to start with klipp.', false, true)
+        raise Klipp::Hint.new "Add a command to `klipp [#{commands.keys.join('|')}]`"
       else
-        raise "Unknown command: #{command}"
+        if commands[command.to_sym]
+          commands[command.to_sym].call
+        else
+          raise "Unknown command `klipp #{command}`"
+        end
     end
-
+    0 # exit code
   rescue Exception => e
-    display_exception e
+    case e
+      when Klipp::Hint
+        Formatador.display_line("[yellow][?] #{e.message}[/]")
+      else
+        Formatador.display_line("[red][!] #{e.message}[/]")
+        Formatador.display_line(e.backtrace[0..10].join("\n"))
+    end
+    1 # exit code
   end
 
-  def self.version
-    buffer_puts Klipp::VERSION
-  end
+  def self.cli_prepare(params=[])
+    params = Klipp::ParameterList.new(params)
+    template = params.shift_argument
+    raise Klipp::Hint.new("Add a template name to `klipp prepare [template]`. Use `klipp template list` to see your options.") unless template
 
-  def self.list
-    files = template_files
+    spec = Template::Spec.from_file Template::Spec.spec_path_for_identifier(template)
+    filename = 'Klippfile'
 
-    raise "No templates found. Create a template directory and .yml file in #{Klipp::Configuration.templates_dir}" unless files.length > 0
+    force = params.splice_option('-f')
+    will_overwrite = File.exists?(filename) && force
 
-    buffer_puts("Available templates for use with #{'klipp prepare'.yellow} or #{'klipp create'.yellow}:\n\n")
-    files.each do |file|
-      buffer_puts("  * #{File.basename(file, '.*').green}")
-    end
-  end
+    raise "#{filename} already exists, not overwriting. Use -f to force overwriting." if File.exists?(filename) && !force
+
+    File.write('Klippfile', spec.klippfile)
 
-  def self.prepare(template_name)
-    raise HelpRequest.new 'Add a template name to the `prepare` command.' unless template_name
+    Formatador.display_line("[green][√] Prepared #{filename} #{'again' if will_overwrite}.[/]")
 
-    template = Klipp::Template.new(Klipp::Configuration.templates_dir, template_name)
-    raise "#{template.klippfile} already exists. Delete it if you want to prepare a new template." if File.exists? template.klippfile
-    IO.write(template.klippfile, template.generated_klippfile)
+    capture_stdout {
+      `open -a TextMate #{filename} 2>&1` if File.exists?(filename)
+    }
+
+    if $? && $?.exitstatus > 0
+      `open -t #{filename}` if File.exists?(filename)
+    end
   end
 
-  def self.create(template_name)
-    if template_name
-      klippfile = File.join(Dir.pwd, "#{template_name}.klippfile")
+  def self.cli_create(params, highline = nil)
+    params = Klipp::ParameterList.new(params)
+    if (interactive_identifier = params.shift_argument)
+      creator = Klipp::Creator.from_user_input(interactive_identifier, highline)
+      puts()
     else
-      klippfile = Dir.glob(File.join(Dir.pwd, '*.klippfile')).first
-      template_name = File.basename(klippfile, File.extname(klippfile)) if klippfile
+      creator = Klipp::Creator.from_file File.join(Dir.pwd, 'Klippfile')
+    end
+    spec_path = Template::Spec.spec_path_for_identifier creator.identifier
+    spec = Template::Spec.from_file spec_path
+    spec.set_token_values(creator.tokens, params.splice_option('-v'))
+
+    block_actions = spec.block_actions_under_git && git_repository?
+    if spec.pre_actions.count > 0
+      if block_actions
+        Formatador.display_line("[yellow][i][/] Git repository found, not running pre-actions (see .klippspec).")
+        puts()
+      else
+        run_actions(spec.pre_actions) if Klipp.env.prod?
+        Formatador.display_line("[green][√] Pre-actions complete.[/]")
+        puts()
+      end
     end
 
-    template = Klipp::Template.new(Klipp::Configuration.templates_dir, template_name)
+    force = params.splice_option('-f')
 
-    if klippfile
-      # load token values from klippfile
-      template.load_klippfile klippfile
-    elsif template_name
-      # ask for token values with highline
-      raise "Direct user input not yet supported. Use #{'klipp prepare'.yellow} to prepare a .klippfile"
-    else
-      raise "Add a template name to the `create` command, or use #{'klipp prepare'.yellow} to prepare a .klippfile"
+    source_dir = File.dirname(Template::Spec.spec_path_for_identifier creator.identifier)
+    target_dir = Dir.pwd
+
+    source_files = Dir.glob(File.join(source_dir, '**', '*'), File::FNM_DOTMATCH).reject { |f| f == spec_path }
+
+    result = source_files.map do |source_file|
+      spec.transfer_file source_file, spec.target_file(source_dir, source_file, target_dir), force
     end
 
-    project = Klipp::Project.new(template)
-    project.create
-  end
+    verbose = params.splice_option '-v'
 
-  private
+    Formatador.display_line("[green][√] Creation completed using template #{Template::Spec.expand_identifier creator.identifier}. #{'Run `klipp create -v` to see what files were created.' unless verbose}[/]")
+    puts()
 
-  def self.template_files
-    Dir.glob File.join(Klipp::Configuration.templates_dir, '*.yml')
-  end
+    if (verbose)
+      strip = File.dirname(Dir.pwd)+File::SEPARATOR
+      result.each { |r| Formatador.display_line(r.gsub(strip, '')) unless File.directory? r }
+      puts()
+    end
 
-end
+    if spec.post_actions.count > 0
+      if block_actions
+        Formatador.display_line("[yellow][i][/] Git repository found, not running post-actions (see .klippspec).")
+        puts()
+      else
+        run_actions(spec.post_actions) if Klipp.env.prod?
+        Formatador.display_line("[green][√] Post-actions complete.[/]")
+        puts()
+      end
+    end
 
-class HelpRequest < StandardError
-  def initialize(msg, unknown=false, show_title=false)
-    @unknown = unknown
-    @show_title = show_title
-    super(msg)
+    Formatador.display_line("[green][√] Done.[/]")
   end
 
-  def message
-    if @unknown
-      "[!] #{super.to_s}".red+"\n\n#{commands}\n\n#{self.backtrace.join("\n")}"
-    else
-      "#{@show_title ? title+"\n\n" : ''}"+"[?] #{super.to_s}".yellow+"\n\n#{commands}"
-    end
+  def self.git_repository?
+    `git rev-parse --is-inside-work-tree 2>&1`.match /true/
   end
 
-  def title
-    "\033[1mKlipp\033[22m, Xcode templates for the rest of us. Version: #{Klipp::VERSION}"
+  def self.run_actions(actions)
+    count = actions.count()
+    puts()
+    actions.each do |action|
+      Formatador.display_line("[yellow][i][/] Running `#{action}`...")
+      puts()
+      system(action) if Klipp.env.prod?
+      puts()
+      #IO.popen(action, :err=>[:child, :out]) { |f| puts '  '+f.read.gsub("\n", "\n  ") }
+      raise "Error running action `#{action}`." if $? && $?.exitstatus > 0
+    end
   end
+end
 
-  def commands
-    commands = [
-        version: 'Display the Klipp version number.',
-        list: "List all available klipp templates in #{Klipp::Configuration.templates_dir}",
-        prepare: 'Prepare a .klippfile to edit in your favorite text editor.',
-        create: 'Create a project based on the template name or .klippfile in the current directory'
-    ]
-    command_list = commands.map { |cmd| cmd.map { |key, summary| "  * klipp #{key.to_s.ljust(10).green} #{summary}" } }.join("\n")
-    "Commands:\n\n#{command_list}"
+class StringInquirer < String
+  def method_missing(method_name, *arguments)
+    if method_name.to_s[-1,1] == '?'
+      self == method_name.to_s[0..-2]
+    else
+      super
+    end
   end
+end
 
-  def exit_status
-    @unknown ? 2 : 1
+def capture_stdout
+  old_stdout = STDOUT.clone
+  pipe_r, pipe_w = IO.pipe
+  pipe_r.sync = true
+  output = ''
+  reader = Thread.new do
+    begin
+      loop do
+        output << pipe_r.readpartial(1024)
+      end
+    rescue EOFError
+    end
   end
+  STDOUT.reopen pipe_w
+  yield
+ensure
+  STDOUT.reopen old_stdout
+  pipe_w.close
+  reader.join
+  return output
 end