iOSTemplate 脚本逻辑说明

原项目地址

前言

引用作者的说明
当我们开始一个新项目的时候，我们往往需要做一些配置和文件的结构配置，以及一些git相关的配置，虽然不是什么困难的事，但是也会耗费我们半天到一天的时间，对于爱偷懒的工程师来说，为什么不把这些时间节省出来去找媳妇呢？iOSTemplate就是帮你省下这部分时间。

作者：Zero_Lee
链接：https://www.jianshu.com/p/1a75d46e0eba

核心

主要使用xcodeproj对iOS项目进行配置、其他是文件操作

脚本结构

build.rb:入口文件
proj_creator.rb:iOS工程创建文件
file_migration.rb:文件copy并移动到iOS项目中
conf_substitution.rb:将模版文件中的工程名替换为用户输入的工程名

src文件夹下
script：编译大包脚本、图片名转译脚本
setting_files：podfile和gitigonore文件
uitest_files：uitest文件
unittest_files：unittest文件
xcode_files：iOS初始化的模版文件

build.rb 入口文件

#引入文件
require File.expand_path('../proj_creator', __FILE__)
require File.expand_path('../file_migration', __FILE__)
require File.expand_path('../conf_substitution', __FILE__)

#proj_creator.rb 创建iOS项目
# create program
#输入工程名 \033[32m这些是控制终端上显示文字的颜色的
puts "\033[32m'=============START============='\033[0m\n"
creator = ProCreator.new
creator.start

#把模版代码复制到新创建项目的路径中
# migrate files
puts "\033[32m'files setting...'\033[0m\n"
mig = FileMigration.new
mig.migration

#替换copy到新工程中的模版文件中的项目名称
# replace key words
puts "\033[32m'content setting...'\033[0m\n"
subOp = ConfSubsitution.new
subOp.start

#执行pod install 
puts "\033[32m'pod install...'\033[0m\n"
puts "\033[32m#{`pod install`}\033[0m\n"

proj_creator.rb

#引入ruby库 xcodeproj和fileutils
require "xcodeproj"
require "fileutils"

#全局变量 工程名称 初始值为空字符串
# project's name
$projName = ''

class ProCreator

    # default user's folder 需要创建的文件夹
    MainFolders = ['View', 'Model', 
                'ViewModel', 'Controller', 
                'Extension', 'Resources', 
                'DataBase', 'net']

    # program's base build settings
    @@mainSettings = {'IPHONEOS_DEPLOYMENT_TARGET' => '8.0'}
    @@unitTestSettings = @@mainSettings.clone
    @@uiTestSettings = @@mainSettings.clone

    # program's root dir
    @@filepath = '../'#类变量 

    def initialize
        #初始化方法 没有带入参
        puts "\033[35m↓ ↓ ↓ ↓ ↓ Please Input Program\'s Name ↓ ↓ ↓ ↓ ↓\033[0m\n"

        $projName = gets.chomp #终端输入工程名并复制给全局变量

        #下面是工程配置
        @@mainSettings['PRODUCT_BUNDLE_IDENTIFIER'] = "com.oudmon.#{$projName}"
        @@mainSettings['INFOPLIST_FILE'] = "$(SRCROOT)/#{$projName}/Info.plist"

        @@unitTestSettings['PRODUCT_BUNDLE_IDENTIFIER'] = "com.oudmon.#{$projName}Tests"
        @@unitTestSettings['INFOPLIST_FILE'] = "$(SRCROOT)/#{$projName}Tests/Info.plist"

        @@uiTestSettings['PRODUCT_BUNDLE_IDENTIFIER'] = "com.oudmon.#{$projName}UITests"
        @@uiTestSettings['INFOPLIST_FILE'] = "$(SRCROOT)/#{$projName}UITests/Info.plist"
        @@uiTestSettings['LD_RUNPATH_SEARCH_PATHS'] = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"
        @@uiTestSettings['IPHONEOS_DEPLOYMENT_TARGET'] = '10.0'

        @proj
    end
   
    def start
        #开创建ios工程
        create_proj
        #设置xcode对创建文件夹的引用
        main_group = create_main_group
        #项目的基础文件夹组织(基于MVVP模式) 复制并移动到xcode项目中 上面只是引用关系并没有创建文件
        creat_folders(main_group, $projName, MainFolders)
        #unittest文件操作
        create_unittest_group
        #uitest文件操作
        create_uitest_group
        #调用xcodeproj 保存设置
        save
    end

    private
    def create_proj
        # create a new default project
        projPath = "../#{$projName}.xcodeproj"
        Xcodeproj::Project.new(projPath).save
        # open proj befor edit
        @proj = Xcodeproj::Project.open(projPath)
        #调用Xcodeproj库 根据路径创建项目
    end

    def create_main_group
        # create folder 
        dst = @@filepath + $projName
        FileUtils.mkdir(dst) if !File.directory?(dst) #这种事ruby的语法 if 右侧的条件成立才调用if左面的方法

        mainGroup     = @proj.main_group.new_group($projName, "./#{$projName}")
        ref1         = mainGroup.new_reference('AppDelegate.swift')
        ref2         = mainGroup.new_reference('Assets.xcassets')
        ref3         = mainGroup.new_reference('Base.lproj/LaunchScreen.storyboard')
        ref4         = mainGroup.new_reference('Base.lproj/Main.storyboard')
        _             = mainGroup.new_reference('Info.plist')

        target = @proj.new_target(:application, $projName, :iOS)
        # Build Settings
        conf_target_settings(target, @@mainSettings)
        # add file to [Build Phases -> Compile Sources] 
        target.add_file_references([ref1])
        # add resources to [Build Phases -> Copy Bundle Resources]
        target.add_resources([ref2, ref3, ref4])

        return mainGroup

    end

    def create_unittest_group
        # create unit test folder
        unit_dst = @@filepath + $projName + 'Tests'
        FileUtils.mkdir(unit_dst) if !File.directory?(unit_dst)

        unitTestName = "#{$projName}Tests"
        unitTestGroup = @proj.main_group.new_group(unitTestName, "./#{unitTestName}")
        ref = unitTestGroup.new_reference("#{unitTestName}.swift")
        _ = unitTestGroup.new_reference('Info.plist')

        target = @proj.new_target(:unit_test_bundle, "#{$projName}Tests", :iOS)
        conf_target_settings(target, @@unitTestSettings)
        target.add_file_references([ref])
        return target
    end

    def create_uitest_group
        # create ui test folder
        ui_dst = @@filepath + $projName + 'UITests'
        FileUtils.mkdir(ui_dst) if !File.directory?(ui_dst)

        uiTestName = "#{$projName}UITests"
        uiTestGroup = @proj.main_group.new_group(uiTestName, "./#{uiTestName}")
        ref = uiTestGroup.new_reference("#{uiTestName}.swift")
        _ = uiTestGroup.new_reference('Info.plist')

        target = @proj.new_target(:ui_test_bundle, "#{$projName}UITests", :iOS)
        conf_target_settings(target, @@uiTestSettings)
        target.add_file_references([ref])
        return target
    end

    def conf_target_settings(target, settings)
        settings.each { |key, value|
            target.build_configuration_list.set_setting(key, value)
        }
    end

    def creat_folders(group, group_name, folders)
        folders.each { |folder_name|
            folder_path = @@filepath + group_name + '/' + folder_name
            FileUtils.mkdir(folder_path) if !File.directory?(folder_path)
            group.new_group(folder_name)
        }
    end

    def save
        @proj.save
    end
end

其他文件不做说明了