klipp 0.0.1 → 0.2.0

data/lib/template/spec.rb

@@ -0,0 +1,231 @@
+module Template
+
+  class Spec
+    require 'date'
+
+    attr_accessor :identifier, :block_actions_under_git
+    attr_reader :post_actions
+
+    def self.identifier_is_ambiguous(identifier)
+      specs_matching_identifier(identifier).count == 1
+    end
+
+    def self.specs_matching_identifier(identifier)
+      chunks = identifier.split(File::SEPARATOR)
+      name = chunks.pop
+      repo = chunks.count > 0 ? File.join(chunks.pop, '**') : '**'
+      Dir.glob(File.join(Klipp::Configuration.root_dir, repo, "#{name}.klippspec"))
+    end
+
+    def self.spec_path_for_identifier(identifier)
+      specs = specs_matching_identifier identifier
+      raise "Unknown template: #{identifier}. Use `klipp template list` to see your options" unless specs && specs.count > 0
+      raise "Found multiple templates named #{identifier}, use a full template identifier to pick one. Run `klipp template list` to see your options" if specs && specs.count > 1
+      specs.first
+    end
+
+    def self.hash_for_spec_path(spec_path)
+      relative_spec = spec_path.gsub(Klipp::Configuration.root_dir, '')
+      {
+          name: File.basename(spec_path, '.klippspec'),
+          repo: relative_spec.split(File::SEPARATOR).map { |x| x=="" ? File::SEPARATOR : x }[1..-1].first
+      }
+    end
+
+    def self.hash_to_identifier(template_hash)
+      "#{template_hash[:repo]}/#{template_hash[:name]}"
+    end
+
+    def self.expand_identifier(template_identifier)
+      path = spec_path_for_identifier template_identifier
+      hash = hash_for_spec_path path
+      hash_to_identifier hash
+    end
+
+    def self.from_file(path)
+      string = IO.read path
+      spec = Template::Spec.new
+      spec.from_string(string, path)
+    end
+
+    def initialize
+      @tokens = Hash[]
+
+      self[:BLANK] = Template::Token.new('', true)
+      self[:DATE] = Template::Token.new(DateTime.now.strftime('%F'), true)
+      self[:YEAR] = Template::Token.new(DateTime.now.strftime('%Y'), true)
+    end
+
+    def post_action=(action)
+      post_actions << action
+    end
+
+    def post_actions
+      @post_actions ||= []
+    end
+
+    def post_actions=(post_actions)
+      @post_actions = post_actions.is_a?(Array) ? post_actions : [post_actions.to_s]
+    end
+
+    def pre_action=(action)
+      pre_actions << action
+    end
+
+    def pre_actions
+      @pre_actions ||= []
+    end
+
+    def pre_actions=(pre_actions)
+      @pre_actions = pre_actions.is_a?(Array) ? pre_actions : [pre_actions.to_s]
+    end
+
+    def from_string(string, path)
+      begin
+        eval(string, nil, path)
+      rescue Exception => e
+        raise "Error evaluating spec: #{File.basename(path)}: #{e.message}\n  #{e.backtrace.join("\n  ")}"
+      end
+      validate_spec
+    end
+
+    # This method is called from the klippspec
+    def spec identifier, &config
+      self.identifier = identifier
+      begin
+        config.yield(self) if (block_given?)
+      rescue Exception => e
+        raise "Invalid klippspec configuration: #{e.message}\n  #{e.backtrace.join("\n  ")}"
+      end
+      validate_spec
+    end
+
+    def token identifier, &config
+      token = Template::Token.new
+      raise 'Incomplete token configuration' unless block_given?
+      config.yield(token)
+      self[identifier] = token
+    end
+
+    def [](name)
+      @tokens[name]
+    end
+
+    def []=(name, token)
+      raise "Redeclaring tokens not allowed: #{name}" if @tokens[name]
+      @tokens[name] = token
+    end
+
+    def validate_spec
+      msg = 'Template configuration invalid: '
+      invalidate msg+'missing name' unless @identifier && @identifier.length > 0
+      self
+    end
+
+    def set_token_values(tokens, verbose=false)
+      msg = 'Token configuration error: '
+      puts() if verbose
+      tokens.each do |name, value|
+        token = self[name]
+        invalidate msg+"unknown token :#{name}" unless token
+        begin
+          Formatador.display_line("#{name}: [bold]#{value}[/]") if verbose
+          token.value = value
+        rescue Exception => e
+          invalidate msg+"token :#{name}. #{e.message}"
+        end
+      end
+      puts() if verbose
+      @tokens.each do |name, token|
+        invalidate msg+"missing value for token :#{name}" if token.value == nil
+      end
+    end
+
+    def invalidate(message)
+      raise message
+    end
+
+    def each
+      @tokens.each { |name, token| yield(name, token) }
+    end
+
+    def klippfile
+      kf = "create '#{self.class.expand_identifier(self.identifier)}' do |tokens|\n\n"
+      @tokens.each do |name, token|
+        unless token.hidden
+          kf += "  # #{token.comment}\n" if token.comment
+          kf += "  # #{token.validation_hint}\n" if token.validation_hint
+          kf += "  tokens[:#{name}] = #{token.type == :bool ? 'false' : "\"\""}\n"
+          kf += "\n"
+        end
+      end
+      kf += "end"
+    end
+
+    def klippspec
+      ks = "spec '#{identifier}' do |s|\n"
+      ks += "  s.block_actions_under_git = true\n"
+      ks += "  # s.pre_actions = ['echo \"Hello klipp!\"']\n"
+      ks += "  # s.post_actions = ['pod install']\n"
+      ks += "\n"
+      ks += "  s.token :REPLACEABLE do |t|\n"
+      ks += "    t.comment = \"Replaceable value (to insert in any filename or string containing 'XXREPLACEABLEXX')\"\n"
+      ks += "    t.validation = /^[A-Z][A-Za-z0-9 ]{2,}$/\n"
+      ks += "    t.validation_hint = 'At least three characters long, start with a capital character, may contain spaces'\n"
+      ks += "  end\n"
+      ks += "\n"
+      ks += "  s.token :TOGGLE do |t|\n"
+      ks += "    t.comment = \"Toggle value (to insert in any filename or string containing 'XXTOGGLEXX')\"\n"
+      ks += "    t.type = :bool\n"
+      ks += "    # t.bool_strings = ['NO','YES']\n"
+      ks += "  end\n"
+      ks += "\n"
+      ks += "  # ...\n"
+      ks += "\n"
+      ks += "end"
+    end
+
+    def target_file(source_dir, source_file, target_dir)
+      stripped_path = source_file.gsub(source_dir, '')
+      customizable_path = replace_tokens(stripped_path)
+      File.join(target_dir, customizable_path)
+    end
+
+    def transfer_file(source_file, target_file, overwrite)
+      FileUtils.mkdir_p File.dirname(target_file)
+
+      if File.directory? source_file
+        FileUtils.mkdir_p target_file
+      elsif !File.exists?(target_file) || overwrite
+        if File.binary? source_file
+          FileUtils.cp(source_file, target_file)
+        else
+          begin
+            IO.write target_file, replace_tokens(File.read(source_file))
+          rescue
+            FileUtils.cp(source_file, target_file)
+          end
+        end
+      else
+        raise "#{target_file} already exists, not overwriting. Use -f to force overwriting."
+      end
+
+      target_file
+    end
+
+    def replace_tokens(string_with_tokens, delimiter='XX')
+      unless string_with_tokens.valid_encoding?
+        raise "Invalid string encoding #{string_with_tokens.encoding}"
+      end
+
+      replaced = string_with_tokens
+      @tokens.each do |name, token|
+        needle = delimiter+name.to_s+delimiter
+        replacement = token.to_s
+        replaced.gsub!(needle, replacement)
+      end
+      replaced
+    end
+  end
+
+end

data/lib/template/token.rb

@@ -0,0 +1,81 @@
+class String
+  def matches_true?
+    Regexp.new('y|yes|true', Regexp::IGNORECASE).match(self)
+  end
+
+  def matches_false?
+    Regexp.new('n|no|false', Regexp::IGNORECASE).match(self)
+  end
+end
+
+module Template
+
+  class Token
+    attr_accessor :hidden, :value, :type, :bool_strings
+    attr_accessor :comment, :validation, :validation_hint
+
+    def initialize(value = nil, hidden = false)
+      self.value = value if value
+      @hidden = hidden
+    end
+
+    def type=(type)
+      allowed_types = [:string, :bool]
+      raise "Invalid type '#{type}'. Allowed types are: #{allowed_types.join(', ')}" unless allowed_types.include?(type)
+      @type = type
+    end
+
+    def type
+      @type || :string
+    end
+
+    def value=(value)
+      if (self.type == :bool) && value.is_a?(String)
+        value = if value.matches_true?
+                  true
+                elsif value.matches_false?
+                  false
+                end
+      end
+      raise "Invalid value '#{value.to_s}'. #{validation_hint}" unless validate?(value)
+      @value = value
+    end
+
+    def bool_strings
+      %w(NO YES)
+    end
+
+    def validation
+      self.type == :bool ? Regexp.new('([yn])|yes|no', Regexp::IGNORECASE) : @validation
+    end
+
+    def validation_hint
+      case
+        when self.type == :string then
+          @validation_hint || (validation ? "Match /#{validation.to_s}/ (no custom validation_hint given)." : "Text required")
+        when self.type == :bool then
+          "Boolean value, either 'true' or 'false'"
+      end
+    end
+
+    def validate?(value)
+      case
+        when self.type == :string then
+          value.is_a?(String) && (validation.nil? || validation.match(value))
+        when self.type == :bool then
+          value.is_a?(TrueClass) or value.is_a?(FalseClass)
+      end
+    end
+
+    def to_s
+      case
+        when self.type == :bool then
+          bool_strings[value ? 1 : 0]
+        else
+          value
+      end
+    end
+
+  end
+
+end

data/lib/template.rb

@@ -0,0 +1,59 @@
+require 'template/spec'
+require 'template/token'
+
+module Template
+
+  def self.route(*argv)
+    params = Klipp::ParameterList.new(argv)
+    command = params.shift_argument
+    commands = {
+        list: lambda { cli_list },
+        spec: lambda { cli_spec(params) }
+    }
+    case command
+      when nil
+        raise Klipp::Hint.new "Add a command to `klipp template [#{commands.keys.join('|')}]`"
+      else
+        if commands[command.to_sym]
+          commands[command.to_sym].call
+        else
+          raise "Unknown command `klipp template #{command}`"
+        end
+    end
+  end
+
+  def self.cli_list
+    l = list
+    l.each do |template|
+      Formatador.display_line "* #{template[:repo]}/[green]#{template[:name].ljust(16)}[/]"
+    end
+
+    Formatador.display_line "You can use just the name in commands `#{l.first[:name]}`, as long as it's unambiguous."
+    Formatador.display_line "Otherwise include the repository, e.g. `#{l.first[:repo]+'/'+l.first[:name]}`"
+  end
+
+  def self.list
+    specs = Dir.glob(File.join(Klipp::Configuration.root_dir, '**', '*.klippspec'))
+    specs.map do |spec|
+      Template::Spec.hash_for_spec_path spec
+    end
+  end
+
+  def self.cli_spec(params)
+    params = Klipp::ParameterList.new(params)
+    identifier = params.shift_argument
+    raise Klipp::Hint.new("Add a new template name, like `klipp template spec AwesomeTemplate`") unless identifier && identifier.length > 0
+    raise "Invalid template name `#{identifier}`. Stick to simple characters and spaces." unless identifier.match(/^[ A-Za-z0-9_-]+$/)
+
+    spec = Template::Spec.new
+    spec.identifier = identifier.strip
+    file = File.join(Dir.pwd, "#{spec.identifier}.klippspec")
+    force = params.splice_option('-f')
+
+    file_existed = File.exists?(file)
+    allow_write = force || !file_existed
+
+    File.write(file, spec.klippspec) if allow_write
+  end
+
+end

data/spec/fixtures/ambiguous-repo/Ambiguous/Ambiguous.klippspec

@@ -0,0 +1,5 @@
+spec 'Ambiguous' do |s|
+
+  # Ambiguous in B
+
+end

data/spec/fixtures/projects/Klippfile

@@ -0,0 +1,26 @@
+create 'template-repository/Example' do |tokens|
+
+  # Project title (e.g. 'Amazing Application')
+  # At least three characters long, start with a capital character, may contain spaces
+  tokens[:PROJECT_TITLE] = "Amazing Application"
+
+  # Project id (e.g. 'AmazingApp')
+  # At least three characters long, no spaces, start with a capital character
+  tokens[:PROJECT_ID] = "AmazingApp"
+
+  # Bundle id (e.g. 'com.acme.amazingapp')
+  # Reverse domain notation, lower case, no spaces
+  tokens[:BUNDLE_ID] = "com.acme.amazingapp"
+
+  # Organization name (e.g. 'ACME')
+  # At least two characters long, may contain spaces
+  tokens[:ORGANIZATION_NAME] = "ACME"
+
+  # Class prefix (e.g. 'AMZ')
+  # All caps, at least three, starting with an alphabetical character
+  tokens[:CLASS_PREFIX] = "AMZ"
+
+  tokens[:SECRET_TOGGLE] = true
+
+
+end

data/spec/fixtures/projects/Klippfile-after-prepare

@@ -0,0 +1,27 @@
+create 'template-repository/Example' do |tokens|
+
+  # Project title (e.g. 'Amazing Application')
+  # At least three characters long, start with a capital character, may contain spaces
+  tokens[:PROJECT_TITLE] = ""
+
+  # Project id (e.g. 'AmazingApp')
+  # At least three characters long, no spaces, start with a capital character
+  tokens[:PROJECT_ID] = ""
+
+  # Bundle id (e.g. 'com.acme.amazingapp')
+  # Reverse domain notation, lower case, no spaces
+  tokens[:BUNDLE_ID] = ""
+
+  # Organization name (e.g. 'ACME')
+  # At least two characters long, may contain spaces
+  tokens[:ORGANIZATION_NAME] = ""
+
+  # Class prefix (e.g. 'AMZ')
+  # All caps, at least three, starting with an alphabetical character
+  tokens[:CLASS_PREFIX] = ""
+
+  # Secret toggle (to enable/disable that amazing feature)
+  # Boolean value, either 'true' or 'false'
+  tokens[:SECRET_TOGGLE] = false
+
+end

data/spec/fixtures/projects/Klippfile-ambiguous

@@ -0,0 +1 @@
+create 'template-repository/Ambiguous'

data/spec/fixtures/projects/Klippfile-bad-ruby

@@ -0,0 +1,3 @@
+create 'template-repository/FCUtrechtFancal' do
+  lalala
+end

data/spec/fixtures/projects/Klippfile-minimal

@@ -0,0 +1 @@
+create 'template-repository/Example'

data/spec/fixtures/projects/Klippfile-unambiguous

@@ -0,0 +1 @@
+create 'Ambiguous'

data/spec/fixtures/template-repository/Ambiguous/Ambiguous.klippspec

@@ -0,0 +1,5 @@
+spec 'Ambiguous' do |s|
+
+  # Ambiguous in A
+
+end

data/spec/fixtures/template-repository/Another-Template/Another-Template.klippspec

@@ -0,0 +1,20 @@
+spec 'Another-Template' do |s|
+  s.block_actions_under_git = true
+  # s.pre_actions = ['echo "Hello klipp!"']
+  # s.post_actions = ['pod install']
+
+  s.token :REPLACEABLE do |t|
+    t.comment = "Replaceable value (to insert in any filename or string containing 'XXREPLACEABLEXX')"
+    t.validation = /^[A-Z][A-Za-z0-9 ]{2,}$/
+    t.validation_hint = 'At least three characters long, start with a capital character, may contain spaces'
+  end
+
+  s.token :TOGGLE do |t|
+    t.comment = "Toggle value (to insert in any filename or string containing 'XXTOGGLEXX')"
+    t.type = :bool
+    # t.bool_strings = ['NO','YES']
+  end
+
+  # ...
+
+end

data/spec/fixtures/template-repository/BadExample/BadExample.klippspec

@@ -0,0 +1,35 @@
+Template::Spec.new do |s|
+  s.name = 'BadExample'
+  s.lalala = 'pod install'
+
+  s.token :PROJECT_TITLE do |t|
+    t.comment = "Project title (e.g. 'Amazing Application')"
+    t.validation = /^[A-Z][A-Za-z0-9 ]{2,}$/
+    t.validation_hint = 'At least three characters long, start with a capital character, may contain spaces'
+  end
+
+  s.token :PROJECT_ID do |t|
+    t.comment = "Project id (e.g. 'AmazingApp')"
+    t.validation = /^[A-Z][A-Za-z0-9]{2,}$/
+    t.validation_hint = 'At least three characters long, no spaces, start with a capital character'
+  end
+
+  s.token :BUNDLE_ID do |t|
+    t.comment = "Bundle id (e.g. 'com.acme.amazingapp')"
+    t.validation = /^[a-z0-9.]{3,}$/
+    t.validation_hint = 'Reverse domain notation, lower case, no spaces'
+  end
+
+  s.token :ORGANIZATION_NAME do |t|
+    t.comment = "Organization name (e.g. 'ACME')"
+    t.validation = /^[A-Z][A-Za-z0-9 ]{2,}$/
+    t.validation_hint = 'At least three characters long, start with a capital character, may contain spaces'
+  end
+
+  s.token :CLASS_PREFIX do |t|
+    t.comment = "Class prefix (e.g. 'AMZ')"
+    t.validation = /^[A-Z][A-Z0-9]{2,}$/
+    t.validation_hint = 'All caps, at least three, starting with an alphabetical character'
+  end
+  
+end

data/spec/fixtures/template-repository/Empty/Empty.klippspec

@@ -0,0 +1,20 @@
+spec 'Empty' do |s|
+  s.block_actions_under_git = true
+  # s.pre_actions = ['echo "Hello klipp!"']
+  # s.post_actions = ['pod install']
+
+  s.token :REPLACEABLE do |t|
+    t.comment = "Replaceable value (to insert in any filename or string containing 'XXREPLACEABLEXX')"
+    t.validation = /^[A-Z][A-Za-z0-9 ]{2,}$/
+    t.validation_hint = 'At least three characters long, start with a capital character, may contain spaces'
+  end
+
+  s.token :TOGGLE do |t|
+    t.comment = "Toggle value (to insert in any filename or string containing 'XXTOGGLEXX')"
+    t.type = :bool
+    # t.bool_strings = ['NO','YES']
+  end
+
+  # ...
+
+end

data/spec/fixtures/template-repository/Example/.gitignore

@@ -0,0 +1,10 @@
+# OS X noise
+.DS_Store
+
+# Xcode noise
+xcuserdata
+.xccheckout
+/Build
+
+# AppCode noise
+.idea

data/spec/fixtures/template-repository/Example/Example.klippspec

@@ -0,0 +1,40 @@
+spec 'Example' do |s|
+  s.block_actions_under_git = true
+  s.pre_actions = ['git init', 'git add .', 'git commit -m "Initial commit."']
+  s.post_actions = ['git add .', 'git commit -m "Klipp project"', 'pod install', 'git add .', 'git commit -m "Installed cocoapods"']
+
+  s.token :PROJECT_TITLE do |t|
+    t.comment = "Project title (e.g. 'Amazing Application')"
+    t.validation = /^[A-Z][A-Za-z0-9 ]{2,}$/
+    t.validation_hint = 'At least three characters long, start with a capital character, may contain spaces'
+  end
+
+  s.token :PROJECT_ID do |t|
+    t.comment = "Project id (e.g. 'AmazingApp')"
+    t.validation = /^[A-Z][A-Za-z0-9]{2,}$/
+    t.validation_hint = 'At least three characters long, no spaces, start with a capital character'
+  end
+
+  s.token :BUNDLE_ID do |t|
+    t.comment = "Bundle id (e.g. 'com.acme.amazingapp')"
+    t.validation = /^[a-z0-9.-]{3,}$/
+    t.validation_hint = 'Reverse domain notation, lower case, no spaces'
+  end
+
+  s.token :ORGANIZATION_NAME do |t|
+    t.comment = "Organization name (e.g. 'ACME')"
+    t.validation = /^[\p{L}0-9 -]{2,}$/
+    t.validation_hint = 'At least two characters long, may contain spaces'
+  end
+
+  s.token :CLASS_PREFIX do |t|
+    t.comment = "Class prefix (e.g. 'AMZ')"
+    t.validation = /^[A-Z][A-Z0-9]{2,}$/
+    t.validation_hint = 'All caps, at least three, starting with an alphabetical character'
+  end
+
+  s.token :SECRET_TOGGLE do |t|
+    t.comment = 'Secret toggle (to enable/disable that amazing feature)'
+    t.type = :bool
+  end
+end

data/spec/fixtures/template-repository/Example/Podfile

@@ -0,0 +1,10 @@
+platform :ios, "6.0"
+
+target "XXPROJECT_TITLEXX" do
+	pod 'AFNetworking'
+end
+
+target "XXPROJECT_TITLEXXTests" do
+	pod 'OCMockito'
+end
+

data/spec/fixtures/template-repository/Example/XXBLANKXX.hidden

@@ -0,0 +1,10 @@
+# OS X noise
+.DS_Store
+
+# Xcode noise
+xcuserdata
+.xccheckout
+/Build
+
+# AppCode noise
+.idea

data/spec/fixtures/template-repository/Example/XXPROJECT_IDXX/Config/Base.xcconfig

@@ -0,0 +1,8 @@
+//
+//  XXPROJECT_TITLEXX
+//
+//  Copyright (c) XXYEARXX XXORGANIZATION_NAMEXX. All rights reserved.
+//
+
+BUNDLE_ID=XXBUNDLE_IDXX
+BUNDLE_SUFFIX=.develop

data/spec/fixtures/template-repository/Example/XXPROJECT_IDXX/Source/XXCLASS_PREFIXXXAppDelegate.h

@@ -0,0 +1,13 @@
+//
+//  XXPROJECT_TITLEXX
+//
+//  Copyright (c) XXYEARXX XXORGANIZATION_NAMEXX. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+@interface XXCLASS_PREFIXXXAppDelegate : UIResponder <UIApplicationDelegate>
+
+@property (strong, nonatomic) UIWindow *window;
+
+@end

data/spec/fixtures/template-repository/Example/XXPROJECT_IDXX/Source/XXCLASS_PREFIXXXAppDelegate.m

@@ -0,0 +1,30 @@
+//
+//  XXPROJECT_TITLEXX
+//
+//  Copyright (c) XXYEARXX XXORGANIZATION_NAMEXX. All rights reserved.
+//
+
+#import "XXCLASS_PREFIXXXAppDelegate.h"
+#import "XXCLASS_PREFIXXXRootViewController.h"
+
+@interface  XXCLASS_PREFIXXXAppDelegate ()
+
+@property (nonatomic, strong) XXCLASS_PREFIXXXRootViewController *rootViewController;
+
+@end
+
+@implementation XXCLASS_PREFIXXXAppDelegate
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+    self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
+
+    self.rootViewController = [[XXCLASS_PREFIXXXRootViewController alloc] init];
+    self.window.rootViewController = self.rootViewController;
+    
+    self.window.backgroundColor = [UIColor whiteColor];
+    [self.window makeKeyAndVisible];
+    return YES;
+}
+
+@end

data/spec/fixtures/template-repository/Example/XXPROJECT_IDXX/Source/XXCLASS_PREFIXXXRootViewController.h

@@ -0,0 +1,11 @@
+//
+//  XXPROJECT_TITLEXX
+//
+//  Copyright (c) XXYEARXX XXORGANIZATION_NAMEXX. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+@interface XXCLASS_PREFIXXXRootViewController : UIViewController
+
+@end