klipp 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 392a938e7875756b189025a720be1883cfa03a39
-  data.tar.gz: c5a1494aef85c779577bf6763590b26b8b73d1f5
+  metadata.gz: d1614564fed67e3a011845b9b346acf78db4f099
+  data.tar.gz: 8c6d33936676f31382a901fc8b7df203d2de5689
 SHA512:
-  metadata.gz: 360cb7ba0a1df9d580656bb97190fc3f8affb7360f3c6a373356a91970e7d117b7df0ae0f5678d3b6079537911c545fc044fdd1094fed204d802c3bf06909140
-  data.tar.gz: 097d223744f66e7693ebb88b8009710aeb02ba95a01969d045b5f27c0bc5c32cd5309a7500220a54f2680bf058a3026c95368da1100414e5105ed646f28844ef
+  metadata.gz: 61cc131c53da984262157a9acfc2002d278ac3afce1bc1ce0fe094c5614d2e979523a6617149c41cd8a6c225a2b3c58d327bca06598f099553946d078c5e88c4
+  data.tar.gz: a22297e52cc98ed4c3ae60797cddba52f666779d4a028fd8c0ef28a028849ba195683773a8d97e2fec22c5a9fd4873b4974f0e734fe6bfaedfaac0f13b27edcb

data/klipp.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
 
   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'
+  spec.add_runtime_dependency 'rake', '~> 10.1'
+  spec.add_runtime_dependency 'ptools', '~> 1.2'
+  spec.add_runtime_dependency 'formatador', '~> 0.2'
+  spec.add_runtime_dependency 'colorize', '~> 0.6'
+  spec.add_runtime_dependency 'grit', '~> 2.5'
+  spec.add_runtime_dependency 'highline', '~> 1.6'
+  spec.add_runtime_dependency 'zaru', '~> 0'
 end

data/lib/klipp.rb

@@ -16,6 +16,10 @@ module Klipp
   class Hint < StandardError
   end
 
+  class ClusterError < StandardError
+    attr_accessor :messages
+  end
+
   def self.env
     @@env ||= StringInquirer.new('prod')
   end
@@ -47,9 +51,11 @@ module Klipp
     case e
       when Klipp::Hint
         Formatador.display_line("[yellow][?] #{e.message}[/]")
+      when Klipp::ClusterError
+        e.messages.each { |msg| Formatador.display_line("[red][!] #{msg}[/]\n") }
       else
-        Formatador.display_line("[red][!] #{e.message}[/]")
-        Formatador.display_line(e.backtrace[0..10].join("\n"))
+        Formatador.display_line("[red][!] #{e.message}[/]\n")
+        Formatador.display_line(e.backtrace.first)
     end
     1 # exit code
   end
@@ -90,7 +96,26 @@ module Klipp
     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'))
+
+    validation_errors = Array.new
+
+    begin
+      spec.set_token_values(creator.tokens, params.splice_option('-v'))
+    rescue Exception => e
+      validation_errors << e.message
+    end
+
+    begin
+      spec.confirm_required_files
+    rescue Exception => e
+      validation_errors << e.message
+    end
+
+    if validation_errors.length > 0
+      e = Klipp::ClusterError.new
+      e.messages = validation_errors
+      raise e
+    end
 
     block_actions = spec.block_actions_under_git && git_repository?
     if spec.pre_actions.count > 0
@@ -160,7 +185,7 @@ end
 
 class StringInquirer < String
   def method_missing(method_name, *arguments)
-    if method_name.to_s[-1,1] == '?'
+    if method_name.to_s[-1, 1] == '?'
       self == method_name.to_s[0..-2]
     else
       super

data/lib/klipp/version.rb

@@ -1,3 +1,3 @@
 module Klipp
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/template.rb

@@ -1,5 +1,6 @@
 require 'template/spec'
 require 'template/token'
+require 'template/required_file'
 
 module Template
 

data/lib/template/required_file.rb

@@ -0,0 +1,16 @@
+require 'zaru'
+
+module Template
+
+  class RequiredFile
+    attr_accessor :name, :directory # :default_value, :type, :bool_strings
+    attr_accessor :comment # , :validation, :validation_hint
+
+    def initialize(name)
+      raise 'File name required' unless name.length > 0
+      raise "Invalid characters found in file name (try #{Zaru.sanitize!(name)})" unless Zaru.sanitize!(name) == name
+      self.name = name if name
+      self.directory = '.'
+    end
+  end
+end

data/lib/template/spec.rb

@@ -4,7 +4,7 @@ module Template
     require 'date'
 
     attr_accessor :identifier, :block_actions_under_git
-    attr_reader :post_actions
+    attr_reader :post_actions, :required_files
 
     def self.identifier_is_ambiguous(identifier)
       specs_matching_identifier(identifier).count == 1
@@ -50,6 +50,7 @@ module Template
 
     def initialize
       @tokens = Hash[]
+      @required_files = Array.new
 
       self[:BLANK] = Template::Token.new('', true)
       self[:DATE] = Template::Token.new(DateTime.now.strftime('%F'), true)
@@ -123,21 +124,49 @@ module Template
     end
 
     def set_token_values(tokens, verbose=false)
-      msg = 'Token configuration error: '
+      token_errors = Hash[]
       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
+          if token
+            Formatador.display_line("#{name}: [bold]#{value}[/]") if verbose
+            token.value = value
+          else
+            token_errors[name] = "unknown token :#{name}"
+          end
         rescue Exception => e
-          invalidate msg+"token :#{name}. #{e.message}"
+          token_errors[name] = "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
+        token_errors[name] = "missing value for token :#{name}" if token.value == nil && token_errors[name] == nil
+      end
+
+      if token_errors.length > 0
+        msg = "Token configuration error:\n\n\t"
+        msg << token_errors.map { |name, error_message| error_message }.join("\n\t")
+        invalidate msg
+      end
+
+      puts() if verbose
+    end
+
+    def confirm_required_files()
+      missing_files = Array.new
+      self.required_files.each do |required_file|
+        file_path = File.join(required_file.directory, required_file.name)
+        missing_files << required_file unless File.exists? file_path
+      end
+
+      if missing_files.length > 0
+        message = "Required file#{missing_files.length > 1 ? 's' : ''} not found:\n\n"
+        missing_files.each do |missing_file|
+          file_path = File.join(missing_file.directory, missing_file.name)
+          message << "\t#{file_path} - #{missing_file.comment ? "#{missing_file.comment}" : ''}\n"
+        end
+        raise message
       end
     end
 
@@ -149,6 +178,13 @@ module Template
       @tokens.each { |name, token| yield(name, token) }
     end
 
+    def required_file name, &config
+      required_file = Template::RequiredFile.new name
+      raise 'Incomplete file configuration' unless block_given?
+      config.yield(required_file)
+      @required_files << required_file
+    end
+
     def klippfile
       kf = "create '#{self.class.expand_identifier(self.identifier)}' do |tokens|\n\n"
       @tokens.each do |name, token|

data/lib/template/token.rb

@@ -46,7 +46,7 @@ module Template
     end
 
     def bool_strings
-      %w(NO YES)
+      @bool_strings ? @bool_strings : %w(NO YES)
     end
 
     def validation

data/spec/fixtures/complex-projects/file-requirement/Klippfile-file-requirement

@@ -0,0 +1,8 @@
+create 'template-repository/FileRequirement' do |tokens|
+
+  # Required files:
+  #
+  # images/icon.png
+  #   72 x 72 pixels icon, used for the iOS 7 springboard on iPad
+
+end

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

@@ -0,0 +1,10 @@
+spec 'FileRequirement' do |s|
+  s.block_actions_under_git = true
+  # s.pre_actions = ['echo "Hello klipp!"']
+  # s.post_actions = ['pod install']
+
+  s.required_file 'icon.png' do |f|
+    f.comment = '72 x 72 pixels icon, used for the iOS 7 springboard on iPad'
+    f.directory = 'images'
+  end
+end

data/spec/klipp_spec.rb

@@ -65,7 +65,7 @@ describe Klipp do
         File.stubs(:exists?).returns(false)
       end
 
-      it 'write a new Klippfile' do
+      it 'writes a new Klippfile' do
         klippfile = read_fixture 'Klippfile-after-prepare'
         File.expects(:write).with('Klippfile', klippfile)
         Klipp.cli_prepare(%w[Example])
@@ -131,4 +131,22 @@ describe Klipp do
 
   end
 
+  context 'with required file' do
+
+    before do
+      Klipp::Configuration.stubs(:root_dir).returns(File.join(__dir__, 'fixtures'))
+      Dir.stubs(:pwd).returns(Dir.mktmpdir)
+
+      maker = Klipp::Creator.new
+      maker.eval_string(read_fixture('Klippfile-file-requirement'), fixture_path('Klippfile-file-requirement'))
+      Klipp::Creator.stubs(:from_file).returns(maker)
+    end
+
+    it 'fails without the required files' do
+
+      expect { Klipp.cli_create([]) }.to raise_error Klipp::ClusterError
+
+    end
+
+  end
 end

data/spec/template/required_file_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Template::RequiredFile do
+
+  it 'initializes with a file name' do
+    file = Template::RequiredFile.new 'file.txt'
+    file.should_not be_nil
+  end
+
+  it 'requires a file name' do
+    expect { file = Template::RequiredFile.new }.to raise_error ArgumentError
+  end
+
+  it 'requires the file name to not be empty' do
+    expect { file = Template::RequiredFile.new '' }.to raise_error RuntimeError
+  end
+
+  it 'requires the file name to be sanitized' do
+    expect { Template::RequiredFile.new '.what&up'}.to raise_error RuntimeError
+    expect { Template::RequiredFile.new 'not/a/file'}.to raise_error RuntimeError
+  end
+
+  context 'with file.txt' do
+
+    before do
+      @file = Template::RequiredFile.new 'file.txt'
+    end
+
+    it 'has a name' do
+      @file.name.should eq 'file.txt'
+    end
+
+    it 'has a comment' do
+      @file.comment = 'Comment'
+      @file.comment.should eq 'Comment'
+    end
+
+    it 'takes a directory' do
+      @file.directory = 'images'
+      @file.directory.should eq 'images'
+    end
+
+    it 'has a default directory' do
+      @file.directory.should eq '.'
+    end
+  end
+
+end

data/spec/template/spec_spec.rb

@@ -114,30 +114,47 @@ describe Template::Spec do
       @template.post_actions = ['git init', 'git add .', 'git commit -m "Initial commit."', 'pod install']
       @template.post_actions.should eq ['git init', 'git add .', 'git commit -m "Initial commit."', 'pod install']
     end
+
     it 'has a token hash' do
       @template[:PROJECT_ID] = Template::Token.new
       @template[:PROJECT_ID].should be_an_instance_of(Template::Token)
     end
 
-    it 'creates a token' do
-      yielded_token = :not_a_token
-      @template.token(:PROJECT_ID) { |t| yielded_token = t }
-      yielded_token.should be_an_instance_of Template::Token
-    end
+    describe 'token support' do
+      it 'creates a token' do
+        yielded_token = :not_a_token
+        @template.token(:PROJECT_ID) { |t| yielded_token = t }
+        yielded_token.should be_an_instance_of Template::Token
+      end
 
-    it 'has a blank token' do
-      @template[:BLANK].hidden.should eq true
-      @template[:BLANK].value.should eq ''
-    end
+      it 'has a blank token' do
+        @template[:BLANK].hidden.should eq true
+        @template[:BLANK].value.should eq ''
+      end
+
+      it 'has a date token' do
+        @template[:DATE].hidden.should eq true
+        @template[:DATE].value.should eq DateTime.now.strftime('%F')
+      end
 
-    it 'has a date token' do
-      @template[:DATE].hidden.should eq true
-      @template[:DATE].value.should eq DateTime.now.strftime('%F')
+      it 'has a year token' do
+        @template[:YEAR].hidden.should eq true
+        @template[:YEAR].value.should eq '2014'
+      end
     end
 
-    it 'has a year token' do
-      @template[:YEAR].hidden.should eq true
-      @template[:YEAR].value.should eq '2013'
+    describe 'required file support' do
+
+      it 'creates a required file instance' do
+        yielded_file = :not_a_file
+        @template.required_file('file.txt') { |f| yielded_file = f }
+        yielded_file.should be_an_instance_of Template::RequiredFile
+      end
+
+      it 'has no files at the beginning' do
+        @template.required_files.length.should eq 0
+      end
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klipp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Eric-Paul Lecluse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,84 +28,98 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: ptools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: formatador
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: grit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: zaru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: Klipp, Xcode templates for the rest of us.
@@ -131,9 +145,11 @@ files:
 - lib/klipp/parameter_list.rb
 - lib/klipp/version.rb
 - lib/template.rb
+- lib/template/required_file.rb
 - lib/template/spec.rb
 - lib/template/token.rb
 - spec/fixtures/ambiguous-repo/Ambiguous/Ambiguous.klippspec
+- spec/fixtures/complex-projects/file-requirement/Klippfile-file-requirement
 - spec/fixtures/projects/Klippfile
 - spec/fixtures/projects/Klippfile-after-prepare
 - spec/fixtures/projects/Klippfile-ambiguous
@@ -164,12 +180,14 @@ files:
 - spec/fixtures/template-repository/Example/XXPROJECT_IDXX/main.m
 - spec/fixtures/template-repository/Example/XXPROJECT_IDXX/nl.lproj/Localizable.strings
 - spec/fixtures/template-repository/Example/XXPROJECT_IDXXTests/XXPROJECT_TITLEXXTests.m
+- spec/fixtures/template-repository/FileRequirement/FileRequirement.klippspec
 - spec/fixtures/template-repository/Interactive/Interactive.klippspec
 - spec/fixtures/template-repository/Interactive/XXSUBJECT_UNDER_TESTXXTests.m
 - spec/klipp/configuration_spec.rb
 - spec/klipp/creator_spec.rb
 - spec/klipp_spec.rb
 - spec/spec_helper.rb
+- spec/template/required_file_spec.rb
 - spec/template/spec_spec.rb
 - spec/template/token_spec.rb
 - spec/template_spec.rb
@@ -193,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Klipp is a command line gem for creating new (Xcode) projects from existing
@@ -202,6 +220,7 @@ summary: Klipp is a command line gem for creating new (Xcode) projects from exis
   template project by your own specifications.
 test_files:
 - spec/fixtures/ambiguous-repo/Ambiguous/Ambiguous.klippspec
+- spec/fixtures/complex-projects/file-requirement/Klippfile-file-requirement
 - spec/fixtures/projects/Klippfile
 - spec/fixtures/projects/Klippfile-after-prepare
 - spec/fixtures/projects/Klippfile-ambiguous
@@ -232,12 +251,14 @@ test_files:
 - spec/fixtures/template-repository/Example/XXPROJECT_IDXX/main.m
 - spec/fixtures/template-repository/Example/XXPROJECT_IDXX/nl.lproj/Localizable.strings
 - spec/fixtures/template-repository/Example/XXPROJECT_IDXXTests/XXPROJECT_TITLEXXTests.m
+- spec/fixtures/template-repository/FileRequirement/FileRequirement.klippspec
 - spec/fixtures/template-repository/Interactive/Interactive.klippspec
 - spec/fixtures/template-repository/Interactive/XXSUBJECT_UNDER_TESTXXTests.m
 - spec/klipp/configuration_spec.rb
 - spec/klipp/creator_spec.rb
 - spec/klipp_spec.rb
 - spec/spec_helper.rb
+- spec/template/required_file_spec.rb
 - spec/template/spec_spec.rb
 - spec/template/token_spec.rb
 - spec/template_spec.rb