umbrellalinter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6cbaaa221219244a94b2b8f21431675882d1e09
-  data.tar.gz: 25f1a0cfefb90fa40b676995925b27f864820228
+  metadata.gz: f455c4ed49c5dd52f11a9d911c990428d1d88bc7
+  data.tar.gz: dd0d28572c3414a042f9bf54d292fbe965119bdf
 SHA512:
-  metadata.gz: 7a8509d4e03bc42c5f9f2626de1cfcc5b676ba4a1e2d77acebbab9ed7b3c6561ef36ec5f82b116e855ed0eadd787a508c925b9ba4e045c47da13f6dcbc34b488
-  data.tar.gz: 20e702bacdab8a59581a858022da67f6c8c44b986010eeff0c91d8ce5da7c6dda323c05e4053a2e91dab9f0e0612ab88adfffef4a27cd0683659d17f54e4af40
+  metadata.gz: fa96a3164613beb7d8e0a4e07fdaba9fe0cb012edc0ccdea2cf7e7604a76fc633c5bfa2a02d32a9244166842cd81fd3e4e0cdc96ee15cdfa6c1b4935760f7e0c
+  data.tar.gz: 50f949b1a61c911b09619a93950b64c05eb0b4712bc944a3b74ffd55b58cd2f8577cdec07e2bf4ae1c3aaa48ab88130dc6004153a434afebd7f7f7efc6c3606b

data/README.md

@@ -1,4 +1,4 @@
-# Umbrellalinter
+# Umbrella Helper Linter
 
 __Umbrella Header Linter__ is a linter for iOS/macOS/tvOS/watchOS Frameworks. 
 Since Xcode doesn't provide a good way to identify at pre/post compile time that the umbrella header is missing files, or files are missing its Public scope, I decided to build this gem to help with the development of Frameworks.
@@ -26,9 +26,9 @@ Or install it yourself as:
 
 `umbrellalinter lint FrameworkTargetName` to lint your Framework Target.
 
-## Usage
-
+`umbrellalinter lint FrameworkTargetName --fix` to lint and fix your umbrella header and the file's scopes.
 
+__NOTE__: Take in consideration we don't know what files you want public or private, we don't know the aritecture of your application or your public API. We base our linting and fixing based on what is declared on your umbrella header or what is missing on it(Files with public scope).
 
 ## Contributing
 

data/lib/umbrellalinter.rb

@@ -4,33 +4,37 @@ require "umbrellalinter/xcodeprojparser"
 
 module Umbrella
   class Linter
-  	attr_reader :framework_target_name
+  	attr_reader :framework_target_name, :fix
 
   	def self.perform(options)
 		new(options).perform
 	end
 
 	def initialize(options)
-			@framework_target_name = options.fetch(:framework_target_name)
+		@framework_target_name = options.fetch(:framework_target_name)
+		@fix = options.fetch(:fix)
 	end
 
 	def run
 		# The directories containing the umbrella header(should only be 1, so we will take the last).
 		directories = Dir.glob("./**/" + @framework_target_name + ".h")
 	 	file = File.read(directories.last)
-	 	
+	 	umbrella_header = directories.last
 	 	import_files = []
-	 	IO.readlines(directories.last).each do |line|
+	 	IO.readlines(umbrella_header).each do |line|
 	 		if  line.start_with?("#import <" + framework_target_name + "/")
 	 			filename = line.partition("#import <" + framework_target_name + "/").last
 	 			#remove last 2 characters(/n and >)
-	 			filename = filename.chop.chop
+	 			filename = filename.chop
 	 			#Add import files to array.
 				import_files.push(filename)
 	 		end
 	 	end
 	 	Umbrella::XcodeProjParser.new({
-				:import_files => import_files
+				:import_files => import_files,
+				:fix => fix,
+				:umbrella_header => umbrella_header,
+				:framework_target_name => @framework_target_name
 		}).parse
 	end
   end

data/lib/umbrellalinter/cli.rb

@@ -4,9 +4,11 @@
  module Umbrella
    class CLI < Thor
    	desc "lint FrameworkTargetName", "Lints the umbrella header of the Framework"
+    option :fix, :type => :boolean
   	def lint(name)
     	Umbrella::Linter.new({
-			:framework_target_name => name
+			:framework_target_name => name,
+      :fix => options[:fix]
 		}).run
   	end
 

data/lib/umbrellalinter/validator.rb

@@ -1,9 +1,12 @@
 require 'fileutils'
 require 'colorize'
+require 'Xcodeproj'
+require 'fileutils'
+require 'tempfile'
 
 module Umbrella
   class Validator
-  	attr_reader :project_files, :import_files
+  	attr_reader :project_files, :import_files, :fix, :project_file_path, :umbrella_header, :framework_target_name
 
   	def self.perform(options)
 		new(options).perform
@@ -12,18 +15,49 @@ module Umbrella
 	def initialize(options)
 		@import_files = options.fetch(:import_files)
 		@project_files = options.fetch(:project_files)
+		@fix = options.fetch(:fix)
+		@project_file_path = options.fetch(:project_file_path)
+		@umbrella_header = options.fetch(:umbrella_header)
+		@framework_target_name = options.fetch(:framework_target_name)
 	end
 
-	def validate
+	def validate 
+		xcodeproj_path = ""
 		# First we need to validate that all the import files in umbrella header are set as public.
 		@import_files.each { |filename|
         	unless @project_files.key?(filename)
-          		puts filename.red + " needs to be set as public or your consumers won't be able to import it.".red
+        		if @fix
+    				t_file = Tempfile.new('filename_temp.txt')
+    				File.open(@project_file_path, 'r') do |f|
+      					f.each_line{|line|
+      						if line.include? filename.chop + " */;"
+      							puts "Changing the scope of " + filename.chop + " to" +" Public".green
+								newline = line.slice(0..(line.index(filename.chop + " */;")))
+								newline = newline + filename.chop + " */;" + " settings = {ATTRIBUTES = (Public, ); }; };"
+								t_file.puts newline
+      						else 
+      							t_file.puts line
+      						end
+      					}
+    				end
+    				t_file.close
+    				FileUtils.mv(t_file.path, @project_file_path)
+        		else
+          			puts filename.red + " needs to be set as Public or your consumers won't be able to import it.".red
+          		end
         	end
       	}
       	@project_files.each do |filename, scope|
       		unless @import_files.include? filename
-      			puts filename.red + "is Public and needs to be added to the umbrella header".red
+      			if @fix
+      				unless filename.include? File.basename( umbrella_header )
+      					puts "Adding ".green + filename.green + " to Umbrella Header".green
+      					File.open(@umbrella_header, 'a') do |f1|  f1.write("\n#import <" + File.basename( umbrella_header, ".*" ) + "/" + filename + ">")
+						end
+					end
+      			else
+      				puts filename.red + "is Public and needs to be added to the umbrella header".red
+      			end
       		end
 		end
 	end

data/lib/umbrellalinter/version.rb

@@ -1,3 +1,3 @@
 module Umbrellalinter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/umbrellalinter/xcodeprojparser.rb

@@ -4,7 +4,7 @@ require "umbrellalinter/validator"
 
 module Umbrella
    class XcodeProjParser
-   	attr_reader :import_files
+   	attr_reader :import_files, :fix, :umbrella_header, :framework_target_name
 
     def self.perform(options)
       new(options).perform
@@ -12,6 +12,9 @@ module Umbrella
 
     def initialize(options)
       @import_files = options.fetch(:import_files)
+      @fix = options.fetch(:fix)
+      @umbrella_header = options.fetch(:umbrella_header)
+      @framework_target_name = options.fetch(:framework_target_name)
       @project_files = {}
     end
 
@@ -25,13 +28,17 @@ module Umbrella
         if line.include? "in Headers"
           if line.include? "settings = {ATTRIBUTES = (Public"
             filename = line.split(/\/\* (.*?)in Headers \*\//)[1]
-            @project_files[filename] =  "Public"
+            @project_files[filename.chop] =  "Public"
           end
         end
       end
       Umbrella::Validator.new({
         :import_files => @import_files,
-        :project_files => @project_files
+        :project_files => @project_files,
+        :fix => @fix,
+        :project_file_path => project_file_path,
+        :umbrella_header => @umbrella_header,
+        :framework_target_name => @framework_target_name
       }).validate
     end
   end

data/umbrellalinter.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency "xcodeproj"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: umbrellalinter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc Terns
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  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: This ruby gem allows iOS/watchOS/tvOS Framework developers to lint and
   fix their umbrella headers
 email: