swiftproj 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca0cd16af2367356e9386880e476899e81eeb4d0
+  data.tar.gz: 53e703ed9fa2ed2b9e8a93366ed39ff4342044eb
+SHA512:
+  metadata.gz: 64047d85ef1b8b4ca348d3573fb4fd84b68616bf718dafba4a8fe884b603112e297965ce9a8e08fd92680f489bd6bccf2d6998f60dc5e07919def117162e4a25
+  data.tar.gz: 0ba356f9bbd16297fc32e28e5b199601e86b5ebdb5ad17fb917707ee697e5993fc26ad260e4f82f8d887e9e01ed64b7e67ec01cb696231456cf95b596f108f9c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Suyeol Jeon (xoul.kr)
+
+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,48 @@
+# Swiftproj
+
+[![Gem](https://img.shields.io/gem/v/swiftproj.svg)](https://rubygems.org/gems/swiftproj)
+[![Build Status](https://travis-ci.org/devxoul/Swiftproj.svg?branch=master)](https://travis-ci.org/devxoul/Swiftproj)
+
+A command-line tool for managing Xcode project with Swift Package Manager. I wrote this to make it easy to deploy to Carthage in a Swift Package Manager only project.
+
+## Basic Usage
+
+```console
+$ swiftproj help
+    version               Displays the current version of swiftproj
+    help                  Displays this help message
+    configure-scheme      Configures a scheme to have buildable targets only
+    add-systemframework   Adds a system framework to an existing target
+    remove-framework      Removes a framework from a target
+    generate-xcconfig     Generates a Xcode project file
+    generate-xcodeproj    Generates a xcconfig file from podspec file
+```
+
+## Example
+
+This is an example of generating Xcodeproj file and archiving for Carthage release.
+
+```console
+$ swiftproj generate-xcconfig --podspec URLNavigator.podspec
+$ swiftproj generate-xcodeproj --xcconfig-overrides Config.xcconfig
+$ swiftproj add-system-framework \
+    --project URLNavigator.xcodeproj \
+    --target QuickSpecBase \
+    --framework Platforms/iPhoneOS.platform/Developer/Library/Frameworks/XCTest.framework
+$ swiftproj configure-scheme \
+    --project URLNavigator.xcodeproj \
+    --scheme URLNavigator-Package \
+    --targets URLNavigator,URLMatcher
+$ carthage build --no-skip-current
+$ carthage archive URLNavigator,URLMatcher
+```
+
+## Installation
+
+```console
+gem install swiftproj
+```
+
+## License
+
+Swiftproj is under MIT license. See the [LICENSE](LICENSE) for more info.

data/bin/swiftproj

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "swiftproj"
+require "xcodeproj"
+
+ui = $stdout
+shell = Swiftproj::Shell.new
+file = File
+core = Swiftproj::Core.new(
+  :ui => ui,
+  :shell => shell,
+  :file => file,
+)
+command = Swiftproj::Command.new(
+  :core => core,
+  :ui => ui,
+  :file => file,
+  :project_class => Xcodeproj::Project,
+  :scheme_class => Xcodeproj::XCScheme,
+)
+command.run(ARGV)

data/lib/swiftproj.rb

@@ -0,0 +1,17 @@
+module Swiftproj
+  require "colored2"
+
+  require "swiftproj/error"
+  require "swiftproj/pod"
+  require "swiftproj/version"
+  require "swiftproj/xcodehelper"
+
+  autoload :Command,   "swiftproj/commands/command"
+  autoload :Core,      "swiftproj/core"
+  autoload :Shell,     "swiftproj/shell"
+
+  commands_path = File.expand_path("../swiftproj/commands/*.rb", __FILE__)
+  Dir.glob(commands_path).each do |file|
+    require file
+  end
+end

data/lib/swiftproj/commands/add_system_framework_command.rb

@@ -0,0 +1,41 @@
+require "swiftproj"
+
+module Swiftproj
+  class AddSystemFrameworkCommand < Command
+    def self.description()
+      return "Adds a system framework to an existing target"
+    end
+
+    def self.options()
+      return {
+        "--project" => "A xcodeproj path (e.g. ReactorKit.xcodeproj)",
+        "--target" => "A target name",
+        "--framework" => "A framework path to be added (e.g. Platforms/iPhoneOS.platform/Developer/Library/Frameworks/XCTest.framework)",
+      }
+    end
+
+    def run(options)
+      project_path = options["--project"]
+      target_name = options["--target"]
+      framework_path = options["--framework"]
+
+      if project_path.nil?
+        raise Swiftproj::MissingArgumentError.new("--project")
+      end
+      if target_name.nil?
+        raise Swiftproj::MissingArgumentError.new("--target")
+      end
+      if framework_path.nil?
+        raise Swiftproj::MissingArgumentError.new("--framework")
+      end
+
+      begin
+        project = @project_class.open(project_path)
+      rescue
+        raise Swiftproj::NoSuchFileError.new(project_path)
+      end
+
+      @core.add_system_framework(project, target_name, framework_path)
+    end
+  end
+end

data/lib/swiftproj/commands/command.rb

@@ -0,0 +1,88 @@
+module Swiftproj
+  class Command
+    def initialize(core:, ui:, file:, project_class:, scheme_class:)
+      @core = core
+      @ui = ui
+      @file = file
+      @project_class = project_class
+      @scheme_class = scheme_class
+    end
+
+    def run(argv)
+      begin
+        command_name = argv[0] || 'help'
+        command = self.get_command(command_name)
+        options = self.parse_options(argv[1..-1])
+        if options.include?("--help") or options.include?("-h")
+          @ui.puts(command.class.help_message)
+        else
+          command.run(options)
+        end
+      rescue Exception => e
+        @ui.puts("[!] #{e.message}".red)
+      end
+    end
+
+    def get_command(command_name)
+      return self.command_class(command_name).new(
+        :core => @core,
+        :ui => @ui,
+        :file => @file,
+        :project_class => @project_class,
+        :scheme_class => @scheme_class,
+      )
+    end
+
+    def command_class(command_name)
+      name = "#{command_name}-command".split("-").map { |s| s.capitalize }.join
+      begin
+        return Swiftproj.const_get(name)
+      rescue
+        raise Swiftproj::UnknownCommandError
+      end
+    end
+
+    def parse_options(argv)
+      options = Hash.new
+      return options if argv.nil?
+
+      current_key = nil
+      for arg in argv
+        if arg.start_with? "-"
+          current_key = arg
+          options[current_key] = nil
+        elsif not current_key.nil?
+          options[current_key] = arg
+          current_key = nil
+        end
+      end
+      return options
+    end
+
+    def self.command_name()
+      command_name = self.name \
+        .split("::").last \
+        .gsub(/Command$/, "") 
+        .gsub(/([a-z]+)([A-Z])([a-z]+)/, '\1-\2\3')\
+        .downcase
+      if not command_name.nil? and command_name.empty?
+        return nil
+      end
+      return command_name
+    end
+
+    def self.description()
+      return ""
+    end
+
+    def self.options()
+      return {}
+    end
+
+    def self.help_message()
+      return self.options
+        .map { |name, description| "    " + name.blue.ljust(30) + description }
+        .join("\n")
+    end
+  end
+end

data/lib/swiftproj/commands/configure_scheme_command.rb

@@ -0,0 +1,43 @@
+require "swiftproj"
+
+module Swiftproj
+  class ConfigureSchemeCommand < Command
+    def self.description()
+      return "Configures a scheme to have buildable targets only"
+    end
+
+    def self.options()
+      return {
+        "--project" => "A xcodeproj path (e.g. ReactorKit.xcodeproj)",
+        "--scheme" => "A scheme name",
+        "--buildable-targets" => "Names for buildable target, seprated by comma (e.g. URLNavigator,URLMatcher)",
+      }
+    end
+
+    def run(options)
+      project_path = options["--project"]
+      scheme_name = options["--scheme"]
+      buildable_target_names = options["--buildable-targets"]
+
+      if project_path.nil?
+        raise Swiftproj::MissingArgumentError.new("--project")
+      end
+      if scheme_name.nil?
+        raise Swiftproj::MissingArgumentError.new("--scheme")
+      end
+      if buildable_target_names.nil?
+        raise Swiftproj::MissingArgumentError.new("--buildable-targets")
+      end
+
+      path = "#{project_path}/xcshareddata/xcschemes/#{scheme_name}.xcscheme"
+      begin
+        scheme = @scheme_class.new(path)
+      rescue
+        raise Swiftproj::NoSuchFileError.new(project_path)
+      end
+
+      target_names = buildable_target_names.split(",")
+      @core.configure_scheme_with_buildable_targets(scheme, target_names)
+    end
+  end
+end

data/lib/swiftproj/commands/generate_xcconfig_command.rb

@@ -0,0 +1,29 @@
+module Swiftproj
+  class GenerateXcconfigCommand < Command
+    def self.description()
+      return "Generates a Xcode project file"
+    end
+
+    def self.options()
+      return {
+        "--podspec" => "A path for podspec file",
+      }
+    end
+
+    def run(options)
+      podspec_path = options["--podspec"]
+      if podspec_path.nil?
+        raise Swiftproj::MissingArgumentError.new("--podspec")
+      end
+
+      begin
+        podspec_content = @file.open(podspec_path).read
+      rescue
+        raise Swiftproj::NoSuchFileError.new(podspec_path)
+      end
+
+      podspec = Pod::Spec.from_podspec(podspec_content)
+      @core.generate_xcconfig(podspec)
+    end
+  end
+end

data/lib/swiftproj/commands/generate_xcodeproj_command.rb

@@ -0,0 +1,16 @@
+module Swiftproj
+  class GenerateXcodeprojCommand < Command
+    def self.description()
+      return "Generates a xcconfig file from podspec file"
+    end
+
+    def run(options)
+      argv = []
+      for key, value in options
+        argv.push(key)
+        argv.push(value) unless value.nil?
+      end
+      @core.generate_xcodeproj(argv)
+    end
+  end
+end

data/lib/swiftproj/commands/help_command.rb

@@ -0,0 +1,19 @@
+module Swiftproj
+  class HelpCommand < Command
+    def self.description()
+      return "Displays this help message"
+    end
+
+    def run(options)
+      message = Swiftproj.constants
+        .map { |symbol| symbol.to_s }
+        .select { |name| name != "Command" and name.end_with?("Command") }
+        .map { |name| Swiftproj.const_get(name) }
+        .map { |cls|
+          "    " + cls.command_name.ljust(22).green + cls.description
+        }
+        .join("\n")
+      @ui.puts(message)
+    end
+  end
+end

data/lib/swiftproj/commands/remove_framework_command.rb

@@ -0,0 +1,41 @@
+require "swiftproj"
+
+module Swiftproj
+  class RemoveFrameworkCommand < Command
+    def self.description()
+      return "Removes a framework from a target"
+    end
+
+    def self.options()
+      return {
+        "--project" => "A xcodeproj path (e.g. ReactorKit.xcodeproj)",
+        "--target" => "A target name",
+        "--framework" => "A framework name to be removed (e.g. XCTest.framework)",
+      }
+    end
+
+    def run(options)
+      project_path = options["--project"]
+      target_name = options["--target"]
+      framework_name = options["--framework"]
+
+      if project_path.nil?
+        raise Swiftproj::MissingArgumentError.new("--project")
+      end
+      if target_name.nil?
+        raise Swiftproj::MissingArgumentError.new("--target")
+      end
+      if framework_name.nil?
+        raise Swiftproj::MissingArgumentError.new("--framework")
+      end
+
+      begin
+        project = @project_class.open(project_path)
+      rescue
+        raise Swiftproj::NoSuchFileError.new(project_path)
+      end
+
+      @core.remove_framework(project, target_name, framework_name)
+    end
+  end
+end

data/lib/swiftproj/commands/version_command.rb

@@ -0,0 +1,11 @@
+module Swiftproj
+  class VersionCommand < Command
+    def self.description()
+      return "Displays the current version of swiftproj"
+    end
+
+    def run(options)
+      @ui.puts Swiftproj::VERSION
+    end
+  end
+end

data/lib/swiftproj/core.rb

@@ -0,0 +1,82 @@
+module Swiftproj
+  class Core
+    def initialize(ui:, shell:, file:)
+      @ui = ui
+      @shell = shell
+      @file = file
+    end
+
+    def generate_xcodeproj(argv=nil)
+      command = "swift package generate-xcodeproj"
+      if argv
+        command += " " + argv.join(" ")
+      end
+      @shell.run(command)
+    end
+
+    def generate_xcconfig(podspec)
+      config = "CURRENT_PROJECT_VERSION = #{podspec.version}\n"
+      if target = podspec.ios.deployment_target
+        config += "IPHONEOS_DEPLOYMENT_TARGET = #{target}\n"
+      end
+      if target = podspec.osx.deployment_target
+        config += "MACOSX_DEPLOYMENT_TARGET = #{target}\n"
+      end
+      if target = podspec.tvos.deployment_target
+        config += "TVOS_DEPLOYMENT_TARGET = #{target}\n"
+      end
+      if target = podspec.watchos.deployment_target
+        config += "WATCHOS_DEPLOYMENT_TARGET = #{target}\n"
+      end
+      @file.write("Config.xcconfig", config)
+    end
+
+    def add_system_framework(project, target_name, framework_path)
+      target = project.targets.find { |t| t.name == target_name }
+      if target.nil?
+        raise Swiftproj::NoSuchTargetError.new
+      end
+
+      build_phase = target.frameworks_build_phase
+      if build_phase.nil?
+        raise Swiftproj::NoFrameworksBuildPhaseError.new
+      end
+
+      file = project.new_file(framework_path)
+      build_phase.add_file_reference(file)
+      project.save
+    end
+
+    def remove_framework(project, target_name, framework_name)
+      target = project.targets.find { |t| t.name == target_name }
+      if target.nil?
+        raise Swiftproj::NoSuchTargetError.new
+      end
+
+      build_phase = target.frameworks_build_phase
+      if build_phase.nil?
+        raise Swiftproj::NoFrameworksBuildPhaseError.new
+      end
+
+      file = build_phase.files_references.find { |f| f.path == framework_name }
+      if file.nil?
+        raise Swiftproj::NoFrameworkError.new
+      end
+
+      build_phase.remove_file_reference(file)
+      project.save
+    end
+
+    def configure_scheme_with_buildable_targets(scheme, buildable_target_names)
+      action = Xcodeproj::XCScheme::BuildAction.new
+      for entry in scheme.build_action.entries
+        blueprint_name = entry.buildable_references[0].blueprint_name
+        if buildable_target_names.include? blueprint_name
+          action.add_entry(entry)
+        end
+      end
+      scheme.build_action = action
+      scheme.save!
+    end
+  end
+end

data/lib/swiftproj/error.rb

@@ -0,0 +1,39 @@
+module Swiftproj
+  class Error < RuntimeError
+  end
+
+  class MissingPodspecVersionError < Error
+  end
+
+  class NoSuchTargetError < Error
+  end
+
+  class NoFrameworksBuildPhaseError < Error
+  end
+
+  class NoFrameworkError < Error
+  end
+
+  class MissingArgumentError < Error
+    def initialize(argument_name)
+      @argument_name = argument_name
+    end
+
+    def message()
+      return "Required argument is missing: #{@argument_name}"
+    end
+  end
+
+  class UnknownCommandError < Error
+  end
+
+  class NoSuchFileError < Error
+    def initialize(path)
+      @path = path
+    end
+
+    def message()
+      return "No such file: #{@path}"
+    end
+  end
+end

data/lib/swiftproj/pod.rb

@@ -0,0 +1,49 @@
+module Pod
+  class Spec
+    attr_accessor :version
+    attr_accessor :ios
+    attr_accessor :osx
+    attr_accessor :tvos
+    attr_accessor :watchos
+
+    def self.from_podspec(content)
+      pod = eval(content)
+      if pod.version.nil?
+        raise Swiftproj::MissingPodspecVersionError.new
+      end
+      return pod
+    end
+
+    def initialize()
+      @ios = OS.new
+      @osx = OS.new
+      @tvos = OS.new
+      @watchos = OS.new
+      yield self if block_given?
+    end
+
+    def method_missing(*args)
+      # do nothing
+    end
+
+    def ==(spec)
+      return false unless self.class == spec.class
+      return false unless self.version == spec.version
+      return false unless self.ios == spec.ios
+      return false unless self.osx == spec.osx
+      return false unless self.tvos == spec.tvos
+      return false unless self.watchos == spec.watchos
+      return true
+    end
+  end
+
+  class OS
+    attr_accessor :deployment_target
+
+    def ==(os)
+      return false unless self.class == os.class
+      return false unless self.deployment_target == os.deployment_target
+      return true
+    end
+  end
+end

data/lib/swiftproj/shell.rb

@@ -0,0 +1,7 @@
+module Swiftproj
+  class Shell
+    def run(command)
+      return `#{command}`
+    end
+  end
+end

data/lib/swiftproj/version.rb

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

data/lib/swiftproj/xcodehelper.rb

@@ -0,0 +1,11 @@
+require "xcodeproj"
+
+module Xcodeproj
+  class XCScheme
+    class BuildableReference
+      def blueprint_name()
+        return @xml_element.attributes["BlueprintName"]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: swiftproj
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Suyeol Jeon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-22 00:00:00.000000000 Z
+dependencies:
+- !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: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: devxoul@gmail.com
+executables:
+- swiftproj
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/swiftproj
+- lib/swiftproj.rb
+- lib/swiftproj/commands/add_system_framework_command.rb
+- lib/swiftproj/commands/command.rb
+- lib/swiftproj/commands/configure_scheme_command.rb
+- lib/swiftproj/commands/generate_xcconfig_command.rb
+- lib/swiftproj/commands/generate_xcodeproj_command.rb
+- lib/swiftproj/commands/help_command.rb
+- lib/swiftproj/commands/remove_framework_command.rb
+- lib/swiftproj/commands/version_command.rb
+- lib/swiftproj/core.rb
+- lib/swiftproj/error.rb
+- lib/swiftproj/pod.rb
+- lib/swiftproj/shell.rb
+- lib/swiftproj/version.rb
+- lib/swiftproj/xcodehelper.rb
+homepage: https://github.com/devxoul/Swiftproj
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A command-line tool for managing Xcode project with Swift Package Manager
+test_files: []