framework-generate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6a1985258384b624b703aac6457212dcf99228a
+  data.tar.gz: 12eb8e3deaa3ab2fb726fa71762624581bfebb31
+SHA512:
+  metadata.gz: f8b2d24cedfa67541e1ab606fa703e35eeb38c53e37d81d6994c178bf10246092896f1f390a9e8a837abad7b476c550c0959059d250a3dd33eebbc577e6ad53a
+  data.tar.gz: 2d39715193e553131c6c40262f5b2152ae3a6f079b9d0f8e4c43feb13ddd77f435fa2169be7bb6528d62c21b72d0c6da89d8fe13cbe2fbcc66c8b3c98bf96abb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Pierre-Marc Airoldi
+
+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,32 @@
+# framework-generate
+Simple tool to help generate a [multiplatform, single-scheme Xcode project](http://promisekit.org/news/2016/08/Multiplatform-Single-Scheme-Xcode-Projects/).
+
+## Installation
+
+Add this line to your Gemfile:
+
+```rb
+gem 'framework-generate'
+```
+
+## Usage
+
+Once installed you can run the generate command from the command line as follows
+
+```bash
+framework-generate
+```
+
+`framework-generate` will look for a `FrameworkSpec` file in the current folder to generate your Xcode project. An example of a `FrameworkSpec` can be found in the [`docs`](docs/FrameworkSpec) folder of this repoisitory.
+
+To view the full `FrameworkSpec` documentation see the [`docs`](docs/FrameworkSpec.md) folder.
+
+## Todo
+
+- [X] Add documentation
+- [ ] Add tests
+- [ ] Release 1.0
+
+## License
+
+This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file.

data/bin/framework-generate

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'framework-generate'
+
+FrameworkGenerate::Runner.generate

data/lib/framework-generate/copy-carthage-frameworks.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+case "$PLATFORM_NAME" in
+    macosx) plat=Mac;;
+    iphone*) plat=iOS;;
+    watch*) plat=watchOS;;
+    appletv*) plat=tvOS;;
+    *) echo "error: Unknown PLATFORM_NAME: $PLATFORM_NAME"; exit 1;;
+esac
+
+for (( n = 0; n < SCRIPT_INPUT_FILE_COUNT; n++ )); do
+    VAR=SCRIPT_INPUT_FILE_$n
+    framework=$(basename "${!VAR}")
+    export SCRIPT_INPUT_FILE_$n="$SRCROOT"/Carthage/Build/$plat/"$framework"
+done
+
+/usr/local/bin/carthage copy-frameworks || exit
+
+for (( n = 0; n < SCRIPT_INPUT_FILE_COUNT; n++ )); do
+    VAR=SCRIPT_INPUT_FILE_$n
+    source=${!VAR}.dSYM
+    dest=${BUILT_PRODUCTS_DIR}/$(basename "$source")
+    ditto "$source" "$dest" || exit
+done

data/lib/framework-generate/language.rb

@@ -0,0 +1,16 @@
+module FrameworkGenerate
+  class Language
+    attr_accessor :type, :version
+
+    def initialize(type = nil, version = nil)
+      @type = type
+      @version = version
+
+      yield(self) if block_given?
+    end
+
+    def to_s
+      "Language<#{type}, #{version}>"
+    end
+  end
+end

data/lib/framework-generate/platform.rb

@@ -0,0 +1,66 @@
+module FrameworkGenerate
+  class Platform
+    attr_accessor :type, :minimum_version, :search_paths
+
+    def initialize(type = nil, minimum_version = nil, search_paths = nil)
+      @type = type
+      @minimum_version = minimum_version
+      @search_paths = search_paths == nil ? default_search_paths : search_paths
+
+      yield(self) if block_given?
+    end
+
+    def to_s
+      "Platform<#{type}, #{minimum_version}, #{search_paths}>"
+    end
+
+    def self.supported_platforms(platforms, is_test_target = false)
+      platforms
+          .reject { |platform| is_test_target && platform.type == :watchos }
+          .map { |platform| platform.raw_values }
+          .join(' ')
+    end
+
+    def self.find_platform(platforms, type)
+      platforms.find { |platform| platform.type == type }
+    end
+
+    def self.deployment_target(platforms, type)
+      find_platform(platforms, type).minimum_version
+    end
+
+    def self.search_paths(platforms, type)
+      find_platform(platforms, type).search_paths
+    end
+
+    def raw_values
+      case @type
+      when :macos
+        'macosx'
+      when :ios
+        'iphoneos iphonesimulator'
+      when :tvos
+        'appletvos appletvsimulator'
+      when :watchos
+        'watchos watchsimulator'
+      else
+        abort 'platform not supported!'
+      end
+    end
+
+    def default_search_paths
+      case @type
+      when :macos
+        '$(SRCROOT)/Carthage/Build/Mac/ $(inherited)'
+      when :ios
+        '$(SRCROOT)/Carthage/Build/iOS/ $(inherited)'
+      when :tvos
+        '$(SRCROOT)/Carthage/Build/tvOS/ $(inherited)'
+      when :watchos
+        '$(SRCROOT)/Carthage/Build/watchOS/ $(inherited)'
+      else
+        abort 'platform not supported!'
+      end
+    end
+  end
+end

data/lib/framework-generate/project.rb

@@ -0,0 +1,174 @@
+require 'xcodeproj'
+
+module FrameworkGenerate
+  class Project
+    attr_accessor :name, :platforms, :language, :targets
+
+    def initialize(name = nil, platforms = nil, language = nil, targets = nil)
+      @name = name
+      @platforms = platforms
+      @language = language
+      @targets = targets
+
+      yield(self) if block_given?
+    end
+
+    def project
+      yield(self) if block_given?
+      self
+    end
+
+    def to_s
+      "Project<#{name}, #{platforms}, #{language}, #{targets}>"
+    end
+
+    # DSL
+    def new_target(&block)
+      Target.new do |target|
+        block.call(target)
+      end
+    end
+
+    def new_platform(&block)
+      Platform.new do |platform|
+        block.call(platform)
+      end
+    end
+
+    def new_language(&block)
+      Language.new do |language|
+        block.call(language)
+      end
+    end
+    
+    def new_script(&block)
+      Script.new do |script|
+        block.call(script)
+      end
+    end
+
+    # sugar
+    def macos(version, search_paths = nil)
+      Platform.new(:macos, version, search_paths)
+    end
+
+    def ios(version, search_paths = nil)
+      Platform.new(:ios, version, search_paths)
+    end
+
+    def tvos(version, search_paths = nil)
+      Platform.new(:tvos, version, search_paths)
+    end
+
+    def watchos(version, search_paths = nil)
+      Platform.new(:watchos, version, search_paths)
+    end
+
+    def swift(version)
+      Language.new(:swift, version)
+    end
+
+    def objc
+      Language.new(:objc, nil)
+    end
+
+    # Interface
+    def project_path
+      if File.extname(@name) == '.xcodeproj'
+        return @name
+      end
+
+      "#{@name}.xcodeproj"
+    end
+
+    def general_build_settings(settings)
+      settings['SDKROOT'] = 'macosx'
+      settings['SUPPORTED_PLATFORMS'] = FrameworkGenerate::Platform::supported_platforms(@platforms)
+      settings['TARGETED_DEVICE_FAMILY'] = '1,2,3,4'
+      settings['MACOSX_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform::deployment_target(@platforms, :macos)
+      settings['IPHONEOS_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform::deployment_target(@platforms, :ios)
+      settings['TVOS_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform::deployment_target(@platforms, :tvos)
+      settings['WATCHOS_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform::deployment_target(@platforms, :watchos)
+      settings['CODE_SIGN_IDENTITY'] = ''
+      settings['COMBINE_HIDPI_IMAGES'] = 'YES'
+      settings['FRAMEWORK_SEARCH_PATHS[sdk=macosx*]'] = FrameworkGenerate::Platform::search_paths(@platforms, :macos)
+      settings['FRAMEWORK_SEARCH_PATHS[sdk=iphone*]'] = FrameworkGenerate::Platform::search_paths(@platforms, :ios)
+      settings['FRAMEWORK_SEARCH_PATHS[sdk=appletv*]'] = FrameworkGenerate::Platform::search_paths(@platforms, :tvos)
+      settings['FRAMEWORK_SEARCH_PATHS[sdk=watch*]'] = FrameworkGenerate::Platform::search_paths(@platforms, :watchos)
+      settings['SWIFT_VERSION'] = @language.version
+      settings['SWIFT_OPTIMIZATION_LEVEL'] = '-Owholemodule'
+      settings['CLANG_WARN_INFINITE_RECURSION'] = 'YES'
+      settings['CLANG_WARN_SUSPICIOUS_MOVE'] = 'YES'
+      settings['ENABLE_STRICT_OBJC_MSGSEND'] = 'YES'
+      settings['GCC_NO_COMMON_BLOCKS'] = 'YES'
+
+      settings
+    end
+
+    def test_build_settings(settings)
+      settings['SUPPORTED_PLATFORMS'] = FrameworkGenerate::Platform::supported_platforms(@platforms, true)
+
+      settings['LD_RUNPATH_SEARCH_PATHS'] = '$(inherited) @executable_path/Frameworks @loader_path/Frameworks'
+      settings['LD_RUNPATH_SEARCH_PATHS[sdk=macosx*]'] = '$(inherited) @executable_path/../Frameworks @loader_path/../Frameworks'
+
+      settings
+    end
+
+    def generate
+
+      project = Xcodeproj::Project.new(project_path)
+
+      schemes_dir = Xcodeproj::XCScheme.user_data_dir(project.path)
+      FileUtils.rm_rf(schemes_dir)
+      FileUtils.mkdir_p(schemes_dir)
+
+      xcschememanagement = {}
+      xcschememanagement['SchemeUserState'] = {}
+      xcschememanagement['SuppressBuildableAutocreation'] = {}
+
+      project.build_configurations.each do |configuration|
+        general_build_settings(configuration.build_settings)
+      end
+
+      @targets.each do |target|
+
+        scheme = Xcodeproj::XCScheme.new
+
+        created_target = target.create(project, language)
+
+        scheme.add_build_target(created_target)
+
+        if created_target.test_target_type?
+          scheme.add_test_target(created_target)
+        end
+
+        if target.test_target != nil
+          created_test_target = target.test_target.create(project, language)
+          created_test_target.add_dependency(created_target)
+
+          scheme.add_test_target(created_test_target)
+        end
+
+        scheme.save_as(project.path, target.name, true)
+        xcschememanagement['SchemeUserState']["#{target.name}.xcscheme"] = {}
+        xcschememanagement['SchemeUserState']["#{target.name}.xcscheme"]['isShown'] = true
+
+      end
+
+      project.native_targets.each do |target|
+        next unless target.test_target_type?
+        target.build_configurations.each do |configuration|
+          test_build_settings(configuration.build_settings)
+        end
+      end
+
+      xcschememanagement_path = schemes_dir + 'xcschememanagement.plist'
+      Xcodeproj::Plist.write_to_path(xcschememanagement, xcschememanagement_path)
+
+      project.save
+
+      puts "Successfully generated #{project_path}"
+    end
+
+  end
+end

data/lib/framework-generate/script.rb

@@ -0,0 +1,17 @@
+module FrameworkGenerate
+  class Script
+    attr_accessor :name, :script, :inputs
+
+    def initialize(name = nil, script = nil, inputs = nil)
+      @name = name
+      @script = script
+      @inputs = inputs
+
+      yield(self) if block_given?
+    end
+
+    def to_s
+      "Script<#{name}, #{script}, #{inputs}>"
+    end
+  end
+end

data/lib/framework-generate/target.rb

@@ -0,0 +1,243 @@
+require 'xcodeproj'
+
+module FrameworkGenerate
+  class Target
+    attr_accessor :name, :info_plist, :bundle_id, :header, :include_files, :exclude_files, :resource_files, :dependencies, :type, :pre_build_scripts, :post_build_scripts, :test_target, :is_safe_for_extensions
+
+    def initialize(name = nil, info_plist = nil, bundle_id = nil, header = nil, include_files = nil, exclude_files = nil, resource_files = nil, dependencies = nil, type = :framework, pre_build_scripts = nil, post_build_scripts = nil, test_target = nil, is_safe_for_extensions = false)
+      @name = name
+      @info_plist = info_plist
+      @bundle_id = bundle_id
+      @header = header
+      @include_files = include_files
+      @exclude_files = exclude_files
+      @resource_files = resource_files
+      @dependencies = dependencies
+      @type = type
+      @pre_build_scripts = pre_build_scripts
+      @post_build_scripts = post_build_scripts
+      @test_target = test_target
+      @is_safe_for_extensions = is_safe_for_extensions
+
+      yield(self) if block_given?
+    end
+
+    def to_s
+      "Target<#{name}, #{info_plist}, #{bundle_id}, #{header}, #{include_files}, #{exclude_files}, #{dependencies}, #{type}, #{test_target}, #{is_safe_for_extensions}>"
+    end
+
+    def target_build_settings(settings)
+      settings.delete('CODE_SIGN_IDENTITY')
+
+      settings['INFOPLIST_FILE'] = @info_plist
+      settings['PRODUCT_BUNDLE_IDENTIFIER'] = @bundle_id
+      settings['APPLICATION_EXTENSION_API_ONLY'] = @is_safe_for_extensions ? 'YES' : 'NO';
+
+      settings
+    end
+
+    def find_group(project, path)
+      folder_path = File.dirname(path)
+      project.main_group.find_subpath(folder_path, true)
+    end
+
+    def add_framework_header(project, target)
+      return unless @header != nil
+      header_path = @header
+      header_file_group = find_group(project, header_path)
+      header_file = header_file_group.new_reference(header_path)
+      header_build_file = target.headers_build_phase.add_file_reference(header_file, true)
+      header_build_file.settings ||= {}
+      header_build_file.settings['ATTRIBUTES'] = ['Public']
+    end
+
+    def add_info_plist(project)
+      info_plist_path = @info_plist
+      info_plist_group = find_group(project, info_plist_path)
+      has_info_plist = info_plist_group.find_file_by_path(info_plist_path)
+
+      info_plist_group.new_reference(@info_plist) unless has_info_plist
+    end
+
+    def add_supporting_files(project, target)
+      add_info_plist(project)
+      return if target.test_target_type?
+      add_framework_header(project, target)
+    end
+
+    def reject_excluded_files(exclude_files, path)
+      exclude_files.each do |files_to_exclude|
+        files_to_exclude.each do |file_to_exclude|
+          return true if File.fnmatch(file_to_exclude, path)
+        end
+      end
+
+      false
+    end
+
+    def add_source_files(project, target)
+      exclude_files = @exclude_files.map do |files|
+        Dir[files]
+      end
+
+      source_files = @include_files.map do |files|
+        Dir[files].reject do |path|
+          reject_excluded_files(exclude_files, path)
+        end
+      end
+
+      source_files.each do |file_directory|
+        file_directory.each do |path|
+          source_file_group = find_group(project, path)
+          has_source_file = source_file_group.find_file_by_path(path)
+          unless has_source_file
+            source_file = source_file_group.new_reference(path)
+            target.source_build_phase.add_file_reference(source_file, true)
+          end
+        end
+      end
+    end
+
+    def append_framework_extension(framework)
+      if File.extname(framework) == '.framework'
+        return framework
+      end
+
+      "#{framework}.framework"
+    end
+
+    def add_dependencies(project, target)
+      return unless @dependencies != nil
+
+      dependency_names = @dependencies.map do |dependency|
+        append_framework_extension(dependency)
+      end
+
+      frameworks = dependency_names.reject do |name|
+        !project.products.any? { |x| x.path == name }
+      end
+
+      frameworks = frameworks.map do |name|
+        project.products.find { |x| x.path == name }
+      end
+
+      frameworks.each do |path|
+        target.frameworks_build_phase.add_file_reference(path, true)
+      end
+    end
+
+    def copy_carthage_frameworks(project, build_phase)
+      script_file_path = File.join(File.dirname(__FILE__), 'copy-carthage-frameworks.sh')
+
+      script_file = File.open(script_file_path)
+
+      build_phase.shell_script = script_file.read
+
+      script_file.close
+
+      add_framework_to_copy_phase(project, build_phase)
+    end
+
+    def add_framework_to_copy_phase(project, build_phase)
+      return unless @dependencies != nil
+
+      dependency_names = @dependencies.map do |dependency|
+        append_framework_extension(dependency)
+      end
+
+      frameworks = dependency_names.reject do |name|
+        project.products.any? { |x| x.path == name }
+      end
+
+      frameworks.each do |path|
+        build_phase.input_paths << path
+      end
+    end
+
+    def add_resource_files(project, target)
+      return unless @resource_files != nil
+
+      files = @resource_files.map do |files|
+        Dir[files]
+      end
+
+      files.each do |file_directory|
+        file_directory.each do |path|
+          file_group = find_group(project, path)
+          has_file = file_group.find_file_by_path(path)
+          unless has_file
+            file = file_group.new_reference(path)
+            target.resources_build_phase.add_file_reference(file, true)
+          end
+        end
+      end
+    end
+
+    def add_build_scripts(target, scripts)
+      return unless scripts != nil
+
+      scripts.each do |script| 
+        build_phase = target.new_shell_script_build_phase(script.name)
+        build_phase.shell_script = script.script
+        build_phase.input_paths = script.inputs
+      end
+    end
+
+    def add_pre_build_scripts(target)
+      add_build_scripts(target, @pre_build_scripts)
+    end
+    
+    def add_post_build_scripts(target)
+      add_build_scripts(target, @post_build_scripts)
+    end
+    
+    def create(project, language)
+      name = @name
+      type = @type
+
+      # Target
+      target = project.new(Xcodeproj::Project::Object::PBXNativeTarget)
+      project.targets << target
+      target.name = name
+      target.product_name = name
+      target.product_type = Xcodeproj::Constants::PRODUCT_TYPE_UTI[type]
+      target.build_configuration_list = Xcodeproj::Project::ProjectHelper.configuration_list(project, :osx, nil, type, language.type)
+
+      # Pre build script
+      add_pre_build_scripts(target)
+
+      add_supporting_files(project, target)
+      add_source_files(project, target)
+
+      target.build_configurations.each do |configuration|
+        target_build_settings(configuration.build_settings)
+      end
+
+      # Product
+      product = project.products_group.new_product_ref_for_target(name, type)
+      target.product_reference = product
+
+      # Build phases
+
+      target.build_phases << project.new(Xcodeproj::Project::Object::PBXResourcesBuildPhase)
+      target.build_phases << project.new(Xcodeproj::Project::Object::PBXFrameworksBuildPhase)
+      
+      # Post build script
+      add_post_build_scripts(target)
+
+      # Dependencies
+      add_dependencies(project, target)
+
+      # Resource files
+      add_resource_files(project, target)
+
+      # Copy frameworks to test target
+      if target.test_target_type?
+        build_phase = target.new_shell_script_build_phase('Copy Carthage Frameworks')
+        copy_carthage_frameworks(project, build_phase)
+      end
+
+      target
+    end
+  end
+end

data/lib/framework-generate.rb

@@ -0,0 +1,24 @@
+module FrameworkGenerate
+  class Runner
+    def self.generate
+      file_path = "#{Dir.pwd}/FrameworkSpec"
+
+      unless File.exist?(file_path)
+        abort "Couldn't find FrameworkSpec"
+      end
+
+      file_contents = File.read(file_path)
+
+      project = FrameworkGenerate::Project.new
+      project.instance_eval(file_contents, file_path)
+
+      project.generate
+    end
+  end
+
+  autoload :Project, 'framework-generate/project'
+  autoload :Language, 'framework-generate/language'
+  autoload :Platform, 'framework-generate/platform'
+  autoload :Target, 'framework-generate/target'
+  autoload :Script, 'framework-generate/script'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: framework-generate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre-Marc Airoldi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Simple tool to help generate a multiplatform, single-scheme Xcode project
+email:
+- pierremarcairoldi@gmail.com
+executables:
+- framework-generate
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/framework-generate
+- lib/framework-generate.rb
+- lib/framework-generate/copy-carthage-frameworks.sh
+- lib/framework-generate/language.rb
+- lib/framework-generate/platform.rb
+- lib/framework-generate/project.rb
+- lib/framework-generate/script.rb
+- lib/framework-generate/target.rb
+homepage: https://pierremarcairoldi.com
+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.0.0
+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: Tool to generate an Xcode framework project
+test_files: []