umbrellalinter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6cbaaa221219244a94b2b8f21431675882d1e09
+  data.tar.gz: 25f1a0cfefb90fa40b676995925b27f864820228
+SHA512:
+  metadata.gz: 7a8509d4e03bc42c5f9f2626de1cfcc5b676ba4a1e2d77acebbab9ed7b3c6561ef36ec5f82b116e855ed0eadd787a508c925b9ba4e045c47da13f6dcbc34b488
+  data.tar.gz: 20e702bacdab8a59581a858022da67f6c8c44b986010eeff0c91d8ce5da7c6dda323c05e4053a2e91dab9f0e0612ab88adfffef4a27cd0683659d17f54e4af40

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tenxurz@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in umbrellalinter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    umbrellalinter (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  umbrellalinter!
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marc Terns
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Umbrellalinter
+
+__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.
+
+`umbrellalinter` is the perfect tool to be used with your C.I, or during development, as a pre-build script. The `umbrellalinter` will identify every single file that is missing on its umbrella header, or every single file in the umbrella header that is missing Public scope.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umbrellalinter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umbrellalinter
+
+## Usage
+
+`umbrellalinter lint FrameworkTargetName` to lint your Framework Target.
+
+## Usage
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pkrmf/umbrellalinter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Umbrellalinter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pkrmf/umbrellalinter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "umbrellalinter"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/umbrellalinter

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby -U
+ require "umbrellalinter/cli.rb"
+
+ Umbrella::CLI.start(ARGV)

data/lib/umbrellalinter/cli.rb

@@ -0,0 +1,21 @@
+ require "thor"
+ require "umbrellalinter"
+
+ module Umbrella
+   class CLI < Thor
+   	desc "lint FrameworkTargetName", "Lints the umbrella header of the Framework"
+  	def lint(name)
+    	Umbrella::Linter.new({
+			:framework_target_name => name
+		}).run
+  	end
+
+  # 	desc "development FrameworkName", "Pulls the FrameworkName as development pod(editable source)"
+  # 	option :exclude_repo
+  # 	def dev(name)
+  #   	Dependency::DependencySwapper.new({
+		# 	:dependency_name => name
+		# }).dev
+  # 	end
+   end
+  end

data/lib/umbrellalinter/validator.rb

@@ -0,0 +1,31 @@
+require 'fileutils'
+require 'colorize'
+
+module Umbrella
+  class Validator
+  	attr_reader :project_files, :import_files
+
+  	def self.perform(options)
+		new(options).perform
+	end
+
+	def initialize(options)
+		@import_files = options.fetch(:import_files)
+		@project_files = options.fetch(:project_files)
+	end
+
+	def validate
+		# 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
+        	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
+      		end
+		end
+	end
+  end
+end

data/lib/umbrellalinter/version.rb

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

data/lib/umbrellalinter/xcodeprojparser.rb

@@ -0,0 +1,38 @@
+require 'fileutils'
+require 'colorize'
+require "umbrellalinter/validator"
+
+module Umbrella
+   class XcodeProjParser
+   	attr_reader :import_files
+
+    def self.perform(options)
+      new(options).perform
+    end
+
+    def initialize(options)
+      @import_files = options.fetch(:import_files)
+      @project_files = {}
+    end
+
+    def parse
+      project_file_path = ""
+      Dir["./**/project.pbxproj"].reject{ |f| f['./Pods'] }.each do |filename|
+        project_file_path = filename
+        break
+      end
+      IO.readlines(project_file_path).each do |line|
+        if line.include? "in Headers"
+          if line.include? "settings = {ATTRIBUTES = (Public"
+            filename = line.split(/\/\* (.*?)in Headers \*\//)[1]
+            @project_files[filename] =  "Public"
+          end
+        end
+      end
+      Umbrella::Validator.new({
+        :import_files => @import_files,
+        :project_files => @project_files
+      }).validate
+    end
+  end
+end

data/lib/umbrellalinter.rb

@@ -0,0 +1,37 @@
+require "umbrellalinter/version"
+require "umbrellalinter/cli"
+require "umbrellalinter/xcodeprojparser"
+
+module Umbrella
+  class Linter
+  	attr_reader :framework_target_name
+
+  	def self.perform(options)
+		new(options).perform
+	end
+
+	def initialize(options)
+			@framework_target_name = options.fetch(:framework_target_name)
+	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)
+	 	
+	 	import_files = []
+	 	IO.readlines(directories.last).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
+	 			#Add import files to array.
+				import_files.push(filename)
+	 		end
+	 	end
+	 	Umbrella::XcodeProjParser.new({
+				:import_files => import_files
+		}).parse
+	end
+  end
+end

data/umbrellalinter.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "umbrellalinter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "umbrellalinter"
+  spec.version       = Umbrellalinter::VERSION
+  spec.authors       = ["Marc Terns"]
+  spec.email         = ["tenxurz@gmail.com"]
+
+  spec.summary       = "This ruby gem allows iOS/watchOS/tvOS Framework developers to lint and fix their umbrella headers"
+  spec.description   = "This ruby gem allows iOS/watchOS/tvOS Framework developers to lint and fix their umbrella headers"
+  spec.homepage      = "https://github.com/pkrmf/umbrella-header-linter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["umbrellalinter"]
+  spec.require_paths = ["lib"]
+  spec.post_install_message = "Thanks for installing Umbrella Header Linter!"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "colorize"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: umbrellalinter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc Terns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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:
+- tenxurz@gmail.com
+executables:
+- umbrellalinter
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/umbrellalinter
+- lib/.DS_Store
+- lib/umbrellalinter.rb
+- lib/umbrellalinter/cli.rb
+- lib/umbrellalinter/validator.rb
+- lib/umbrellalinter/version.rb
+- lib/umbrellalinter/xcodeprojparser.rb
+- pkg/umbrellalinter-0.1.0.gem
+- umbrellalinter.gemspec
+homepage: https://github.com/pkrmf/umbrella-header-linter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+post_install_message: Thanks for installing Umbrella Header Linter!
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: This ruby gem allows iOS/watchOS/tvOS Framework developers to lint and fix
+  their umbrella headers
+test_files: []