[# 242 Command::Spec::Linter] Refactoring

- moved Specification#validate! to Linter
- fixed FileList bugs
- cleaned up

lib/cocoapods/specification.rb

@@ -340,49 +340,6 @@ module Pod
       "#<#{self.class.name} for #{to_s}>"
     end
 
-    def validate!
-      missing = []
-      missing << "name"              unless name
-      missing << "version"           unless version
-      missing << "summary"           unless summary
-      missing << "homepage"          unless homepage
-      missing << "author(s)"         unless authors
-      missing << "source or part_of" unless source || part_of
-      missing << "source_files"      if source_files.empty? && subspecs.empty?
-      # TODO
-      # * validate subspecs
-
-      incorrect = []
-      allowed = [nil, :ios, :osx]
-      incorrect << "platform - accepted values are (no value, :ios, :osx)" unless allowed.include?(platform.name)
-
-      {
-        :source_files => source_files.values,
-        :resources    => resources.values,
-        :clean_paths  => clean_paths
-      }.each do |name, paths|
-        if paths.flatten.any? { |path| path.start_with?("/") }
-          incorrect << "#{name} - paths cannot start with a slash"
-        end
-      end
-
-      if source && source[:local] && source[:local].start_with?("/")
-        incorrect << "source[:local] - paths cannot start with a slash"
-      end
-
-      no_errors_found = missing.empty? && incorrect.empty?
-
-      unless no_errors_found
-        message = "\n[!] The #{name || 'nameless'} specification is incorrect\n".red
-        missing.each {|s| message << " - Missing #{s}\n"}
-        incorrect.each {|s| message << " - Incorrect #{s}\n"}
-        message << "\n"
-        raise Informative, message
-      end
-
-      no_errors_found
-    end
-
     # This is a convenience method which gets called after all pods have been
     # downloaded, installed, and the Xcode project and related files have been
     # generated. (It receives the Pod::Installer::Target instance for the current

spec/functional/command/spec_spec.rb

@@ -14,7 +14,7 @@ describe Pod::Command::Spec do
   end
 end
 
-describe "Pod::Command::Spec create" do
+describe "Pod::Command::Spec#create" do
   extend SpecHelper::Command
   extend SpecHelper::Github
   extend SpecHelper::TemporaryDirectory
@@ -51,7 +51,7 @@ describe "Pod::Command::Spec create" do
     spec.source.should   == { :git => 'https://github.com/lukeredpath/libPusher.git', :tag => 'v1.3' }
   end
 
-  it "accepts the a name when creating a podspec form github" do
+  it "accepts a name when creating a podspec form github" do
     expect_github_repo_request
     expect_github_user_request
     expect_github_tags_request
@@ -90,7 +90,7 @@ describe "Pod::Command::Spec create" do
   end
 end
 
-describe "Pod::Command::Spec lint" do
+describe "Pod::Command::Spec#lint" do
   extend SpecHelper::Command
   extend SpecHelper::TemporaryDirectory
   extend SpecHelper::Git
@@ -104,13 +104,8 @@ describe "Pod::Command::Spec lint" do
   end
 
   it "lints a repo" do
-    # the fixture master repo has warnings and does not validates
-    lambda { run_command('spec', 'lint', 'master') }.should.raise Pod::Informative
-  end
-
-  it "lints a repo with --only-errors option and show the warnings" do
-    # The fixture has an error due to name mismatch
-    cmd = command('spec', 'lint', 'master', '--only-errors')
+    # The fixture has an error due to a name mismatch
+    cmd = command('spec', 'lint', 'master')
     lambda { cmd.run }.should.raise Pod::Informative
     cmd.output.should.include "InAppSettingKit (0.0.1)\n    - ERROR | The name of the spec should match the name of the file"
     cmd.output.should.include "WARN"
@@ -136,51 +131,10 @@ describe "Pod::Command::Spec lint" do
     cmd.output.should.include "Missing license[:file] or [:text]"
   end
 
-  before do
-    spec = (fixture('spec-repos') + 'master/JSONKit/1.4/JSONKit.podspec').read
-    spec.gsub!(/https:\/\/github\.com\/johnezang\/JSONKit\.git/, fixture('integration/JSONKit').to_s)
-    spec.gsub!(/s\.source_files = 'JSONKit\.\*'/, "s.source_files = 'JSONKit.*'\ns.resources = 'WRONG_FOLDER'")
-    File.open(temporary_directory + 'JSONKit.podspec', 'w') {|f| f.write(spec) }
-  end
-
-  it "fails if there are warnings" do
-    cmd = command('spec', 'lint', '--quick')
-    Dir.chdir(temporary_directory) { lambda { cmd.run }.should.raise Pod::Informative }
-    cmd.output.should.include "- WARN  | Missing license[:file] or [:text]"
-  end
-
-  it "respects the --only-errors option" do
-    cmd = command('spec', 'lint', '--quick', '--only-errors')
-    Dir.chdir(temporary_directory) { lambda { cmd.run }.should.not.raise Pod::Informative }
-    cmd.output.should.include "- WARN  | Missing license[:file] or [:text]"
-    cmd.output.should.include "passed validation"
-  end
-
-  it "respects the --quick option" do
-    cmd = command('spec', '--quick', 'lint')
-    Dir.chdir(temporary_directory) { lambda { cmd.run }.should.raise Pod::Informative }
-    cmd.output.should.not.include "JSONKit/JSONKit.m:1640:27: warning: equality comparison with extraneous parentheses"
-  end
-
-  it "uses xcodebuild to generate warnings and checks for file patterns" do
-    # those two checks are merged because pod install is computationally expensive
-    cmd = command('spec', 'lint')
-    Dir.chdir(temporary_directory) { lambda { cmd.run }.should.raise Pod::Informative }
-    unless `which xcodebuild`.strip.empty?
-      cmd.output.should.include "JSONKit/JSONKit.m:1640:27: warning: equality comparison with extraneous parentheses"
-    end
-    cmd.output.should.include "- ERROR | [resources = 'WRONG_FOLDER'] -> did not match any file"
-  end
-
-  before do
-    spec = (fixture('spec-repos') + 'master/JSONKit/1.4/JSONKit.podspec').read
-    spec.gsub!(/s\.source_files = 'JSONKit\.\*'/, "s.source_files = 'JSONKit.*'\n if config.ios?\nend")
-    File.open(temporary_directory + 'JSONKit.podspec', 'w') {|f| f.write(spec) }
-  end
-
-  it "produces deprecation notices" do
-    cmd = command('spec', '--quick', 'lint')
-    Dir.chdir(temporary_directory) { lambda { cmd.run }.should.raise Pod::Informative }
-    cmd.output.should.include "- WARN  | `config.ios?' and `config.osx' will be removed in version 0.7"
+  it "respects the -only--errors option" do
+    spec_file = fixture('spec-repos') + 'master/JSONKit/1.4/JSONKit.podspec'
+    cmd = command('spec', 'lint', '--quick', '--only-errors', spec_file.to_s)
+    lambda { cmd.run }.should.not.raise
+    cmd.output.should.include "Missing license[:file] or [:text]"
   end
 end

spec/unit/command/spec_spec.rb

+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "Pod::Command::Spec::Linter" do
+  extend SpecHelper::TemporaryDirectory
+
+  def write_podspec(text, name = 'JSONKit.podspec')
+    file = temporary_directory + 'JSONKit.podspec'
+    File.open(file, 'w') {|f| f.write(text) }
+    spec = Pod::Specification.from_file(file)
+    [spec, file]
+  end
+
+  def stub_podspec(pattern = nil, replacement = nil)
+    spec = (fixture('spec-repos') + 'master/JSONKit/1.4/JSONKit.podspec').read
+    spec.gsub!(/https:\/\/github\.com\/johnezang\/JSONKit\.git/, fixture('integration/JSONKit').to_s)
+    spec.gsub!(pattern, replacement) if pattern && replacement
+    spec
+  end
+
+  it "fails a specifications that does not contain the minimum required attributes" do
+    spec, file = write_podspec('Pod::Spec.new do |s| end')
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = true, true
+    linter.lint.should == false
+    linter.errors.join(' | ') =~ /name.*version.*summary.*homepage.*authors.*(source.*part_of).*source_files/
+  end
+
+  it "fails specifications if the name does not match the name of the file" do
+    spec, file = write_podspec(stub_podspec(/s.name *= 'JSONKit'/, "s.name = 'JSONKitAAA'"))
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = true, true
+    linter.lint.should == false
+    linter.errors.count.should == 1
+    linter.errors[0].should =~ /The name of the spec should match the name of the file/
+  end
+
+  it "fails a specification if a path starts with a slash" do
+    spec, file = write_podspec(stub_podspec(/s.source_files = 'JSONKit\.\*'/, "s.source_files = '/JSONKit.*'"))
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = true, true
+    linter.lint.should == false
+    linter.errors.count.should == 1
+    linter.errors[0].should =~ /Paths cannot start with a slash/
+  end
+
+  it "fails a specification if the plafrom is unrecognized" do
+    spec, file = write_podspec(stub_podspec(/s.name *= 'JSONKit'/, "s.name = 'JSONKit'\ns.platform = :iososx\n"))
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = true, true
+    linter.lint.should == false
+    linter.errors.count.should == 1
+    linter.errors[0].should =~ /Unrecognized platfrom/
+  end
+
+  it "fails validation if the specification contains warnings" do
+    spec, file = write_podspec(stub_podspec)
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = false, true
+    linter.lint.should == false
+    linter.errors.should.be.empty
+    linter.warnings.should.not.be.empty
+  end
+
+  it "validates in lenient mode if there are no erros but there are warnings" do
+    spec, file = write_podspec(stub_podspec)
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = true, true
+    linter.lint.should == true
+    linter.errors.should.be.empty
+    linter.warnings.should.not.be.empty
+  end
+
+  it "respects quick mode" do
+    spec, file = write_podspec(stub_podspec)
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.expects(:peform_multiplatform_analysis).never
+    linter.expects(:install_pod).never
+    linter.expects(:xcodebuild_output_for_platfrom).never
+    linter.expects(:file_patterns_errors_for_platfrom).never
+    linter.lenient, linter.quick = false, true
+    linter.lint
+  end
+
+  it "produces deprecation notices" do
+    spec, file = write_podspec(stub_podspec(/s\.source_files = 'JSONKit\.\*'/, "s.source_files = 'JSONKit.*'\n if config.ios?\nend"))
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = false, true
+    linter.lint.should == false
+    linter.errors.should.be.empty
+    linter.warnings.join(' | ').should =~ /`config.ios\?' and `config.osx' will be removed in version 0.7/
+  end
+
+ it "uses xcodebuild to generate notes and warnings" do
+    spec, file = write_podspec(stub_podspec)
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.lenient, linter.quick = false, false
+    linter.lint.should == false
+    linter.notes.join(' | ').should.include "JSONKit/JSONKit.m:1640:27: warning: equality comparison with extraneous parentheses" unless `which xcodebuild`.strip.empty?
+  end
+
+ it "checks for file patterns" do
+    spec, file = write_podspec(stub_podspec(/s\.source_files = 'JSONKit\.\*'/, "s.source_files = 'JSONKit.*'\ns.resources = 'WRONG_FOLDER'"))
+    linter = Pod::Command::Spec::Linter.new(spec, file)
+    linter.stubs(:xcodebuild_output_for_platfrom).returns([])
+    linter.lenient, linter.quick = false, false
+    linter.lint.should == false
+    linter.errors.join(' | ').should.include "[resources = 'WRONG_FOLDER'] -> did not match any file"
+  end
+end

spec/unit/specification_spec.rb

@@ -149,25 +149,6 @@ describe "A Pod::Specification, in general," do
     @spec = Pod::Spec.new
   end
 
-  def validate(&block)
-    Proc.new(&block).should.raise(Pod::Informative)
-  end
-
-  it "raises if the specification does not contain the minimum required attributes" do
-    exception = validate { @spec.validate! }
-    exception.message =~ /name.*version.*summary.*homepage.*authors.*(source.*part_of).*source_files/
-  end
-
-  it "raises if the platform is unrecognized" do
-    validate { @spec.validate! }.message.should.not.include 'platform'
-    @spec.platform = :ios
-    validate { @spec.validate! }.message.should.not.include 'platform'
-    @spec.platform = :osx
-    validate { @spec.validate! }.message.should.not.include 'platform'
-    @spec.platform = :windows
-    validate { @spec.validate! }.message.should.include 'platform'
- end
-
   it "returns the platform that the static library should be build for" do
     @spec.platform = :ios
     @spec.platform.should == :ios