spm_utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4ce02f74f991372beab1718fed4fde916a14e1b
+  data.tar.gz: 8de90016785062102c144b6bd889e43c3a66c9fb
+SHA512:
+  metadata.gz: f4f4c7f38bead6aafef00233b1bc7bbd5ffcb9ce1e1a3e9a9bacad26c46404d81061db8b858989b029a5a65c5b9574718d6d77e0a160c181b63c54ee4a4fc816
+  data.tar.gz: 38c935bdd9d180c9e3025b7961e410ab6eeedff3d97f3688bd0a66be1b58e5d7a6665a524fa219abb3f2dedbddcd062ea735390c10688420514a88d9b39e0209

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+.vscode

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Łukasz Mróz
+
+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,47 @@
+# SPM fixers
+Hey there! This is my repo for a bunch of fixers for SPM. All of this is mostly work in progress and written in Ruby.
+Which means this is probably not the best code you'll see these days and I recommend you to do a **backup/commit before using this scripts**. 
+These were not tested on many projects yet, so please bear in mind that this is really experimental.
+Fortunately, I accept PRs to fix anything you see that is wrong! I will be really grateful for that, actually.
+
+## Before you use the script:
+1. Go to your SPM project.
+1. Backup/commit your files.
+1. Clean your project if needed.
+1. Run `swift build & swift package generate-xcodeproj` (make sure it passes)
+1. Install this gem using `gem install spm_fixers`
+
+## Cleaning your project
+Whenever something goes wrong with building/caching/resolving, try cleaning your project:
+`swift package clean && rm -rf .build && rm Package.resolved`
+
+## Quick fixer
+See issue [Quick#751](https://github.com/Quick/Quick/issues/751) and PR [swift-package-manager#955](https://github.com/apple/swift-package-manager/pull/955). TL;DR because of SPM, Quick can't set `CLANG_ENABLE_MODULES` by itself.
+This script does it for you.
+
+Steps:
+1. Make sure to follow the [Before you use the script](#before-you-use-the-script) guide.
+1. Run `spm_fixers quick`.
+1. If everything goes correcly, your project should be fixed!
+
+## Swift4All - update all your dependencies to Swift 4
+By running `swift build & swift package generate-xcodeproj` you don't necessarily get all your dependencies built with Swift 4 (see [SR-5940](https://bugs.swift.org/browse/SR-5940)). This script fixes that for you. You might want want to use my fork of Quick as Swift 4 is currently 
+broken, but [PR#755](https://github.com/Quick/Quick/pull/755) is waiting for the merge :)
+
+```swift
+.package(url: "https://github.com/sunshinejr/Quick.git", .branch("fix/spm_swift4"))
+```
+
+Steps:
+1. Go to your SPM project.
+1. Clean your packages by using `swift package clean`
+1. Run `swift build & swift package generate-xcodeproj` (make sure it passes)
+1. Run `gem install xcodeproj` to install additional library for our scrip.
+1. Run `ruby path/to/spm_swift4all.rb` to update your Xcodeproj.
+1. If everything goes correcly, you should have your project updated.
+
+## [WIP] Inhibit deps warnings - Basically `CocoaPods'` `inhibit_all_warnings` copy.
+This currently does not work, but it would be awesome to have it working sometime in future.
+
+# License
+[MIT](https://github.com/sunshinejr/spm_fixers/blob/master/LICENSE).

data/bin/spm_utils

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'clamp'
+require_relative '../lib/project_mod'
+require_relative '../lib/command/fix_quick_command'
+require_relative '../lib/command/swift_version_command'
+require_relative '../lib/command/inhibit_all_warnings_command'
+require_relative '../lib/command/clean_project_command'
+require_relative '../lib/version'
+
+class MainCommand < Clamp::Command
+    subcommand 'quick', 'Fix Quick\'s problem with SPM until it\'s resolved. See: https://github.com/Quick/Quick/issues/751', FixQuickCommand
+    subcommand 'swift', 'Change Swift version of a target/targets', SwiftVersionCommand
+    subcommand 'inhibit_all_warnings', 'Inhibit all warninigs in a target/targets', InhibitAllWarningsCommand
+    subcommand 'clean_project', 'Remove .build dir, Package.resolved & packages cache', CleanProjectCommand
+    
+    option "--version", :flag, "Show version" do
+        puts SPMFixers::VERSION
+        exit(0)
+    end    
+end
+
+MainCommand.run

data/lib/command/clean_project_command.rb

@@ -0,0 +1,6 @@
+class CleanProjectCommand < Clamp::Command
+    def execute
+        system "swift package clean && rm -rf .build && rm Package.resolved &> /dev/null"
+        puts "All things cleaned! Now to the good stuff..."
+    end
+end

data/lib/command/fix_quick_command.rb

@@ -0,0 +1,6 @@
+class FixQuickCommand < Clamp::Command
+    def execute
+        ProjectMod.apply_build_setting(name: 'CLANG_ENABLE_MODULES', value: 'YES', target_names: ['QuickSpecBase'])
+        puts "Quick fixed!"        
+    end
+end

data/lib/command/inhibit_all_warnings_command.rb

@@ -0,0 +1,10 @@
+class InhibitAllWarningsCommand < Clamp::Command
+    option ['--target'], 'TARGET', 'Target name', :multivalued => true
+
+    def execute
+        ProjectMod.append_or_apply_build_setting(name: 'OTHER_SWIFT_FLAGS', value: "-suppress-warnings", target_names: target_list)
+        
+        targets_string = target_list.empty? ? 'All targets' : (target_list.join(", ") + " targets")
+        puts "#{targets_string} have inhibited warnings now!"                
+    end
+end

data/lib/command/swift_version_command.rb

@@ -0,0 +1,17 @@
+class SwiftVersionCommand < Clamp::Command
+    parameter "VERSION", "version", :attribute_name => :swift_version
+    option ['--target'], 'TARGET', 'Target name', :multivalued => true
+    # option ['--swift-version'], 'SWIFT_VERSION', 'What Swift version to change into', :required => true
+
+    def execute
+        supported_swift_versions = ['3', '4']
+        if !supported_swift_versions.include? swift_version
+            signal_usage_error "'#{swift_version}' swift version is not supported. Supported values: " + supported_swift_versions.map { |v| "'#{v}'" }.join(", ")
+        end
+             
+        ProjectMod.apply_build_setting(name: 'SWIFT_VERSION', value: "#{swift_version}.0", target_names: target_list)
+        
+        targets_string = target_list.empty? ? 'All targets' : (target_list.join(", ") + " targets")
+        puts "#{targets_string} were updated to use Swift #{swift_version}!"        
+    end
+end

data/lib/project_mod.rb

@@ -0,0 +1,57 @@
+require 'xcodeproj'
+
+class ProjectMod
+    def self.xcodeproject(path:)
+        xcodeprojs = Dir.new(path).select { |a| a.include? '.xcodeproj' }
+        xcodeprojs_count = xcodeprojs.count
+        
+        abort "No *.xcodeproj files in current directory" if xcodeprojs_count == 0
+        abort "Found #{xcodeprojs_count} .xcodeproj files in the directory (1 required)." if xcodeprojs_count > 1
+        
+        Xcodeproj::Project.open(xcodeprojs[0])        
+    end
+
+    def self.get_targets(project:,target_names:) 
+        targets = project.targets.clone
+        if !target_names.empty?
+            not_found_targets = target_names.select { |t| !targets.map { |tt| tt.name }.include? t }
+            abort not_found_targets.join(", ") + " targets were not found in the Xcodeproj." if !not_found_targets.empty?
+
+            targets.select! { |t| target_names.include? t.name }
+        end
+        
+        abort "No targets selected" if targets.empty?
+
+        return targets
+    end
+
+    def self.apply_build_setting(name:, value:, target_names: [])        
+        project = xcodeproject(path: Dir.pwd)
+        targets = get_targets(project: project, target_names: target_names)
+        
+        targets.each do |target|
+            target.build_configurations.each do |config|
+                config.build_settings[name] = value
+            end
+        end
+        
+        project.save
+    end
+
+    def self.append_or_apply_build_setting(name:, value:, target_names: []) 
+        project = xcodeproject(path: Dir.pwd)
+        targets = get_targets(project: project, target_names: target_names)
+        
+        targets.each do |target|
+            target.build_configurations.each do |config|
+                if config.build_settings[name].nil?
+                    config.build_settings[name] = value
+                else
+                    config.build_settings[name] += " #{value}"
+                end
+            end
+        end
+        
+        project.save
+    end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module SPMFixers
+  VERSION = '0.0.1'
+end

data/spm_utils.gemspec

@@ -0,0 +1,18 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'spm_utils'
+  spec.version = SPMFixers::VERSION
+  spec.authors = ['Łukasz Mróz']
+  spec.email = ['thesunshinejr@gmail.com']
+  spec.license = 'MIT'
+  spec.summary = 'Bunch of utility scripts for Swift Package Manager.'
+  spec.homepage = 'https://github.com/sunshinejr/spm_fixers'
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.add_dependency 'xcodeproj', '~> 1.0'
+  spec.add_dependency 'clamp', '~> 1.0'
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: spm_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Łukasz Mróz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- thesunshinejr@gmail.com
+executables:
+- spm_utils
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- bin/spm_utils
+- lib/command/clean_project_command.rb
+- lib/command/fix_quick_command.rb
+- lib/command/inhibit_all_warnings_command.rb
+- lib/command/swift_version_command.rb
+- lib/project_mod.rb
+- lib/version.rb
+- spm_utils.gemspec
+homepage: https://github.com/sunshinejr/spm_fixers
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Bunch of utility scripts for Swift Package Manager.
+test_files: []