xclinter 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e55a275c71738e4324735eebba7a7958863f92a
+  data.tar.gz: ab341c95860d7c1a7b8dea3c0c2758ea1b8c8cfe
+SHA512:
+  metadata.gz: 5a5e8117e213db902c0c7f173b25f9fd6a1186f402413a3d1927d1c67df4df780f83eaa091885d7a62f2e3226e18d3eee032bbe51a75326f95df98628578f3ed
+  data.tar.gz: f30588cc80d70a20c7d3d0c3a9f3e802e73ad033b4bc2e31354ccf97b69bdffccbcaf67104e1f29b95114487948a4b19bfe5bf4925323b90a083d0a80f079e69

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xclinter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/xclinter

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+
+require "xclinter"
+
+Xclinter::Xclinter.start

data/lib/xclinter/version.rb

@@ -0,0 +1,3 @@
+module Xclinter
+  VERSION = "0.9.0"
+end

data/lib/xclinter.rb

@@ -0,0 +1,204 @@
+require "xclinter/version"
+require "thor"
+require "xcodeproj"
+
+module Xclinter
+  class Xclinter < Thor
+    package_name "Xclinter"
+    
+    desc "lintAll", "Runs all linters"
+    options :project => :string, :target => :string
+    def lintAll
+      project = getProject(options)
+      target = getTarget(options, project)
+
+      stringFiles = stringsFiles(target)
+      imageNamesUsed = imageNamesUsed(target)
+      images = images(target)
+      
+      exitcode = 0
+
+      exitcode += lintStringFilesHelper(stringFiles)
+      exitcode += lintImageLiteralsHelper(images, imageNamesUsed)
+      exitcode += findUnusedImagesHelper(images, imageNamesUsed)
+      
+      exit exitcode
+    end
+    
+    desc "lintStringFiles", "Lints Strings files for missing semicolons etc."
+    options :project => :string, :target => :string
+    def lintStringFiles
+      project = getProject(options)
+      target = getTarget(options, project)
+
+      stringFiles = stringsFiles(target)
+
+      exit lintStringFilesHelper(stringFiles)
+    end
+
+    desc "lintImageLiterals", "Lints code for imageLiterals with non existing images "
+    options :project => :string, :target => :string
+    def lintImageLiterals
+      project = getProject(options)
+      target = getTarget(options, project)
+      
+      imageNamesUsed = imageNamesUsed(target)
+      images = images(target)
+      
+      exit lintImageLiteralsHelper(images, imageNamesUsed)
+    end
+
+    desc "findUnusedImages", "Lints code for images not used in any imageLiterals"
+    options :project => :string, :target => :string
+    def findUnusedImages
+      project = getProject(options)
+      target = getTarget(options, project)
+          
+      imageNamesUsed = imageNamesUsed(target)
+      images = images(target)
+      
+      exit findUnusedImagesHelper(images, imageNamesUsed)
+    end
+
+    no_commands{
+      private def getProject(options)
+        projectPath = options[:project]
+
+        if projectPath.nil?
+          projectPath = ENV["PROJECT_FILE_PATH"]
+        end
+
+        if projectPath.nil?
+          projectPath = Dir.entries('.').select { |f| f.end_with?(".xcodeproj") }.first
+        end
+
+        if projectPath.nil?
+          fail "no xcodeproject found"
+        end
+
+        project = Xcodeproj::Project.open(projectPath)
+
+        project
+      end
+
+      private def getTarget(options, project)
+        targetName = options[:target]
+
+        if targetName.nil?
+          targetName = ENV["TARGETNAME"]
+        end
+
+        if targetName.nil?
+          targetName = project.targets.first.name
+        end
+
+        if targetName.nil?
+          fail "no target found"
+        end
+
+        target = project.targets.select { |target| target.name.eql? targetName }.first
+
+        if target.nil?
+          fail 'no target'
+        end
+
+        target
+      end
+
+      private def codeFiles(target)
+
+       codeFiles = target.source_build_phase.files.to_a.map do |pbx_build_file|
+  	       pbx_build_file.file_ref.real_path.to_s
+        end.select do |path|
+           path.end_with?(".m", ".mm", ".swift")
+        end.select do |path|
+           File.exists?(path)
+       end
+
+        codeFiles
+      end
+
+      private def assetFiles(target)
+        resources(target, ".xcassets")
+      end
+      
+      private def stringsFiles(target)
+        resources(target, ".strings")
+      end
+      
+      private def resources(target, ending)
+        target.resources_build_phase.files.to_a.map do |pbx_build_file|
+          pbx_build_file.file_ref.real_path.to_s
+        end.select do |path|
+         path.end_with?(ending)
+        end.select do |path|
+         File.exists?(path)
+        end
+      end
+      
+      private def imageNamesUsed(target)
+        imageNamesUsed = codeFiles(target).flat_map do |file|
+          File.readlines(file).to_s.enum_for(:scan, /#imageLiteral\(resourceName: \\"[^"]*\\"\)/).flat_map {Regexp.last_match}.flat_map do |string|
+            string.to_s.sub!('#imageLiteral(resourceName: \\"','').sub!('\")','')
+          end
+        end
+        
+        imageNamesUsed
+      end
+
+      private def images(target)
+
+        imageNames = assetFiles(target).flat_map do |assetFile|
+    		  Dir.entries(assetFile).select do |file|
+    			  file.end_with?(".imageset")
+    		  end.map do |file|
+    			  File.basename(file,File.extname(file))
+    		  end
+    	  end
+
+        imageNames
+      end
+      
+      private def findUnusedImagesHelper(images, imageNamesUsed)
+        exitcode = 0
+        
+        images.each do |image|
+          if not imageNamesUsed.include? image
+            puts ":: warning: Xclinter findUnusedImages: \"#{image}\" is not used in any imageLiteral and might be obsolete"
+            exitcode = 1
+          end
+        end
+        
+        return exitcode
+      end
+      
+      private def lintImageLiteralsHelper(images, imageNamesUsed)
+        exitcode = 0 
+        
+        imageNamesUsed.each do |imageNameUsed|
+          if not images.include? imageNameUsed
+            puts ":: error: Xclinter lintImageLiteral: \"#{imageNameUsed}\" does not exist in asset files"
+            exitcode = 1
+          end
+        end
+        
+        return exitcode
+      end
+      
+      private def lintStringFilesHelper(stringFiles)
+        exitcode = 0 
+        
+        stringFiles.each do |path|
+          File.foreach(path).with_index do |line, line_num|
+              if not line.strip.empty? and not line.strip.end_with?(";") and not (line.strip.start_with?("/*") and line.strip.end_with?("*/"))
+                  puts "#{path}:#{line_num+1}: error: Xclinter lintStringFiles: semicolon missing"
+                  exitcode = 1
+              end
+          end
+        end
+        
+        return exitcode
+      end
+    }
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: xclinter
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Wolfgang Lutz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: xclinter lints various possible problems of xcodeprojects, e.g. broken
+  strings files, unavailable images or unused images.
+email:
+- wlut@num42.de
+executables:
+- console
+- setup
+- xclinter
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/xclinter.rb"
+- "./lib/xclinter/version.rb"
+- bin/console
+- bin/setup
+- bin/xclinter
+homepage: https://github.com/num42/xclinter-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: xclinter lints various possible problems of xcodeprojects
+test_files: []