KCommercialPipeline 0.2.5.1

data/lib/KCommercialPipeline/core/resource/i18n/generator.rb

@@ -0,0 +1,368 @@
+# frozen_string_literal: true
+require_relative '../component_resources_config'
+require_relative '../swift/colors_generator'
+require_relative '../swift/files_generate'
+require_relative '../swift/fonts_generator'
+require_relative '../swift/i18n_generetor'
+require_relative '../swift/images_generator'
+require_relative '../bundle/images_generator'
+require_relative '../bundle/colors_generator'
+require_relative '../bundle/files_generator'
+require_relative '../bundle/fonts_generator'
+require_relative '../bundle/i18ns_generator'
+require_relative '../objective-c/oc_generator'
+require_relative '../objective-c/oc_file_model'
+require_relative 'bundle_generator'
+require_relative '../auto_publish_resource/update_resource_component'
+require 'ruby-enum'
+require_relative '../source/lib_bundle'
+require_relative '../../component_publisher'
+module KCommercial
+  module Resources
+    class Generator
+
+      class SupportLanguage
+        include Ruby::Enum
+        define :OC, 'objective-c'
+        define :SWIFT, 'swift'
+      end
+
+      class ResourcesStatus
+        attr_accessor :has_i18ns, :has_images, :has_fonts, :has_files, :has_colors
+
+        alias has_images? has_images
+        alias has_fonts? has_fonts
+        alias has_files? has_files
+        alias has_colors? has_colors
+        alias has_i18ns? has_i18ns
+
+        def  initialize
+          has_images = false
+          has_fonts = false
+          has_files = false
+          has_colors = false
+          has_i18ns = false
+        end
+      end
+
+      # The component for generate the resources
+      # @return [CocoaDepot::Component]
+      attr_reader :component
+
+      # The source for this generator
+      # @return [CocoaDepot::Resources::GitSource]
+      attr_reader :source
+
+      attr_reader :language
+
+      attr_reader :auto_push
+      # Create a new Generator
+      def initialize(component, source, options = {})
+        @component = component
+        @super_module = options.delete(:super_module) { 'MKResources' }
+        @language = options.delete(:language) || component.main_language
+        @source = source
+        @resources_status = ResourcesStatus.new
+        @language = SupportLanguage::OC if @language == 'oc'
+        unless SupportLanguage.values.include?(@language)
+          raise "You set unsupported language #{@language}, please check!"
+        end
+        raise "Unsupported options: #{options}" if options.count.positive?
+      end
+
+      # The path for auto generated files
+      # @return [Pathname]
+      def auto_path
+        component.path.join('Auto')
+      end
+
+      # The path for auto generated resources
+      # @return [Pathname]
+      def auto_assets_path
+        auto_path.join('Assets')
+      end
+
+      # The path for auto generated classes
+      # @return [Pathname]
+      def auto_classes_path
+        auto_path.join('Classes')
+      end
+
+      def check_local_file_status
+        @auto_push = ResourcesUpdate.can_auto_push?
+      end
+      # Do the generate process, it will generate the code and get the remote resources
+      def generate!
+        check_local_file_status
+        update_source
+        write_colors
+        write_files
+        write_fonts
+        write_i18ns
+        write_images
+        case language
+        when SupportLanguage::SWIFT
+          write_swift_code 'Resources.swift', resources_class_contents
+        when SupportLanguage::OC
+          write_oc_key_defines OCFileModel.main_model, []
+          write_oc_key_defines OCFileModel.public_model, []
+        end
+        auto_compoment_list = component.auto_compoment_list
+        component.check_auto_compoment!
+        component.check_auto_codes!
+        auto_publish_components(auto_compoment_list || [])
+        push_resource_to_remote
+      end
+
+      private
+
+      def update_source
+        source.update
+      end
+
+      def write_colors
+        return unless component.colors_keys
+
+        valid_assets = valid_assets(KCommercial::Resources::AssetType::Color, component.colors_keys)
+        return unless valid_assets
+        return if valid_assets.empty?
+
+        KCommercial::UI.info 'Generating the colors indexes ...'
+        valid_assets.each do |app_assets|
+          bundle_generator = ColorsIndexesGenerator.new(app_assets.assets, auto_assets_path.join(app_assets.app))
+          bundle_generator.generate!
+        end
+        sort_assets = valid_assets.sort_by { |items| items.assets.size }
+        write_universal_code_defines 'Colors.swift',
+                                     KCommercial::Resources::OCFileModel.colors_model,
+                                     sort_assets.first.assets.map(&:name),
+                                     ColorsGenerator
+        @resources_status.has_colors = true
+      end
+
+      def write_files
+        return unless component.files_keys
+
+        valid_assets = valid_assets(KCommercial::Resources::AssetType::File, component.files_keys)
+        return unless valid_assets
+        return if valid_assets.empty?
+
+        KCommercial::UI.info 'Generating the files indexes ...'
+        valid_assets.each do |app_assets|
+          bundle_generator = FilesIndexesGenerator.new(app_assets.assets, auto_assets_path.join(app_assets.app))
+          bundle_generator.generate!
+        end
+        sort_assets = valid_assets.sort_by { |items| items.assets.size }
+        write_universal_code_defines 'Files.swift',
+                                     KCommercial::Resources::OCFileModel.files_model,
+                                     sort_assets.first.assets.map(&:name),
+                                     FilesGenerator
+        @resources_status.has_files = true
+
+      end
+
+      def write_fonts
+        return unless component.fonts_keys
+
+        valid_assets = valid_assets(KCommercial::Resources::AssetType::Font, component.fonts_keys)
+        return unless valid_assets
+        return if valid_assets.empty?
+
+        KCommercial::UI.info 'Generating the fonts indexes ...'
+        valid_assets.each do |app_assets|
+          bundle_generator = FontsIndexesGenerator.new(app_assets.assets, auto_assets_path.join(app_assets.app))
+          bundle_generator.generate!
+        end
+        sort_assets = valid_assets.sort_by { |items| items.assets.size }
+        write_universal_code_defines 'Fonts.swift',
+                                     KCommercial::Resources::OCFileModel.fonts_model,
+                                     sort_assets.first.assets.map(&:name),
+                                     FontsGenerator
+
+        @resources_status.has_fonts = true
+      end
+
+      def write_i18ns
+        return unless component.i18ns_keys
+
+        valid_assets = valid_assets(KCommercial::Resources::AssetType::I18n, component.i18ns_keys)
+        return unless valid_assets
+        return if valid_assets.empty?
+
+        KCommercial::UI.info 'Generating the i18ns indexes ...'
+        valid_assets.each do |app_assets|
+          bundle_generator = I18nsIndexesGenerator.new(app_assets.assets, auto_assets_path.join(app_assets.app))
+          bundle_generator.generate!
+        end
+        sort_assets = valid_assets.sort_by { |items| items.assets.size }
+        write_universal_code_defines 'I18ns.swift',
+                                     KCommercial::Resources::OCFileModel.i18ns_model,
+                                     sort_assets.first.assets.map(&:name),
+                                     I18nsGenerator
+        @resources_status.has_i18ns = true
+      end
+
+      def write_images
+        return unless component.images_keys
+
+        valid_assets = valid_assets(KCommercial::Resources::AssetType::Image, component.images_keys)
+        return unless valid_assets
+        return if valid_assets.empty?
+
+        KCommercial::UI.info 'Generating the images indexes ...'
+        valid_assets.each do |app_assets|
+          bundle_generator = ImagesIndexesGenerator.new(app_assets.assets, auto_assets_path.join(app_assets.app))
+          bundle_generator.generate!
+        end
+        sort_assets = valid_assets.sort_by { |items| items.assets.size }
+        write_universal_code_defines 'Images.swift',
+                                     KCommercial::Resources::OCFileModel.images_model,
+                                     sort_assets.last.assets.map(&:name),
+                                     ImagesGenerator
+        @resources_status.has_images = true
+      end
+
+      def valid_assets(type, key_defines)
+        keys = key_defines.keys
+        return if keys.empty?
+
+        # 返回各宿主 + default 资源
+        app_sources = source.load_assets(type)
+        app_sources.each do |e|
+          valid_resources(e, keys)
+        end
+      end
+
+      def valid_resources(app_source, keys)
+        exist_keys = app_source.assets.map(&:name)
+        not_found_keys = keys - exist_keys
+        found_keys = keys & exist_keys
+        exist_assets = app_source.assets.select{|asset| found_keys.include? asset.name}
+        valid_assets = exist_assets.select(&:valid)
+        invalid_assets = exist_assets - valid_assets
+        if not_found_keys.count.positive?
+          KCommercial::UI.warning "Some assets is not found for(#{app_source.app}): \n#{not_found_keys.map{|key|"\t #{key}"}.join("\n")}"
+        end
+        if invalid_assets.count.positive?
+          KCommercial::UI.warning "Some cdasset is invalid: for(#{app_source.app}): \n" + invalid_assets.map{|a|"\t #{a.name}"}.join("\n")
+        end
+        app_source.assets = valid_assets
+      end
+      # The name for the auto generated bundle
+      # @return [String]
+      def auto_bundle_name
+        if component.name.end_with? "Resources"
+          return  "Auto#{component.name}"
+        else
+          "Auto#{component.name}Resources"
+        end
+      end
+
+      private
+
+      def push_resource_to_remote
+        raise "有变动，退出自动推送资源组件代码" unless auto_push
+        ResourcesUpdate.push
+      end
+
+      def auto_publish_components(components)
+        components.each do |c|
+          publisher = KCommercial::KCPipeline::Publisher.new(c,'patch','true','true') unless c.empty?
+          publisher.publish if !publisher.nil?
+        end
+      end
+
+      def write_universal_code_defines(swift_file_name,
+                                       oc_file_model,
+                                       keys,
+                                       swift_generator)
+        return if keys.nil? || keys.empty?
+
+        case language
+        when SupportLanguage::SWIFT
+          write_swift_key_defines swift_file_name, keys, swift_generator
+        when SupportLanguage::OC
+          write_oc_key_defines oc_file_model, keys
+        end
+      end
+
+      def write_oc_key_defines(file_model, key_defines)
+        options = {}
+        options[:super] = @super_module if @super_module
+        code_generator = KCommercial::Resources::OCGenerator.new(file_model,
+                                                                component.name,
+                                                                key_defines,
+                                                                @resources_status,
+                                                                options)
+        render_map = {
+          'oc_class_name' => code_generator.code_model.oc_class_name,
+          'component_name' => component.name,
+          'component_header_name' => code_generator.code_model.component_header_name
+        }
+        write_oc_code(file_model.header.basename.to_s, code_generator.header_contents, render_map) if file_model.header
+        if file_model.implementation
+          write_oc_code(file_model.implementation.basename.to_s, code_generator.imp_contents, render_map)
+        end
+      end
+
+      def write_oc_code(file_name, contents, render_map)
+        file_name = Liquid::Template.parse(file_name).render(render_map)
+        output_path = auto_classes_path.join(file_name)
+        output_path.parent.mkpath
+        File.open(output_path, 'w+') do |file|
+          file.write contents
+        end
+      end
+
+      def write_swift_key_defines(filename, key_defines, generator_class)
+        return if key_defines.nil?
+
+        options = {
+          super: @super_module
+        }
+        contents = generator_class.new(key_defines, options).extension_contents
+        write_swift_code filename, contents
+      end
+
+      # Write the contents to the local file
+      # @param [String] filename the name for the code file
+      # @param [String] contents the content for the code file
+      def write_swift_code(filename, contents)
+        path = auto_classes_path.join(filename)
+        path.parent.mkpath
+        File.open(path, 'w+') do |file|
+          file.write contents
+        end
+      end
+
+      def resources_class_contents
+        <<EOF
+//
+//  Resources.swift
+//  MKSharedResources
+//
+//  Created by Dong Zhao on 2021/1/1.
+//
+
+import Foundation
+import #{@super_module}
+#{'import MKResources' if @super_module != 'MKResources'}
+// swiftlint:disable type_name
+open class R: #{@super_module}.R {
+    static let `default` = R()
+    public override init() {
+        super.init()
+        if let pack = Bundle.main.url(forResource: "#{auto_bundle_name}", withExtension: "bundle") {
+            registerPack(pack: Pack(url: pack))
+        } else if let url = Bundle(for: type(of: self)).url(forResource: "#{auto_bundle_name}",
+                                                            withExtension: "bundle") {
+            registerPack(pack: Pack(url: url))
+        }
+    }
+}
+// swiftlint:enable type_name
+EOF
+      end
+    end
+  end
+end

data/lib/KCommercialPipeline/core/resource/key_defines.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require 'yaml'
+
+module KCommercial
+  module Resources
+    class KeyDefines
+
+      class << self
+        # Creat a new KeyDefines from a file
+        # @return [KeyDefines]
+        def from_file(file)
+          unless file
+            KCommercial::UI.debug "can not find the key defines file #{file}"
+            return  nil
+          end
+          contents = File.read(file)
+          hash = YAML.load contents
+          unless hash.is_a? Hash
+            raise KCommercial::Exception("The content is not an hash in #{file}")
+          end
+          keys = KeyDefines.new(hash)
+          keys.defined_in_file = file
+          keys
+        end
+      end
+      # All the key defines for the generator
+      attr_reader :keys
+
+      # The configuration file defines in the storage path
+      attr_accessor :defined_in_file
+
+      def initialize(hash = {})
+        @keys = hash['keys'] or hash[:keys]
+        if @keys.nil?
+          @keys = []
+        end
+      end
+
+    end
+  end
+end

data/lib/KCommercialPipeline/core/resource/objective-c/code_model.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require 'liquid'
+require_relative '../code_generator/resources_status'
+module KCommercial
+  module Resources
+    class CodeModel
+      attr_accessor :component_name, :super_module_name, :keys, :resources_status
+
+      def oc_class_name
+        name = component_name
+        name = "#{component_name}Resources" unless component_name.end_with? "Resources"
+        "#{name}Internal"
+      end
+
+      def super_class_name
+        name = "#{super_module_name}Internal"
+        if super_module_name.to_s == "KCSemanticResources"
+          name = "KCResources"
+        end
+        name
+      end
+
+      def component_header_name
+        name = "#{component_name}Auto"
+        name
+      end
+
+      def bundle_name
+        if component_name.end_with? "Resources"
+          return  "Auto#{component_name}"
+        else
+          "Auto#{component_name}Resources"
+        end
+      end
+
+      def key_to_function_name(key)
+        key = key.camelize(false)
+        if key.length > 0
+          key[0] = key[0].downcase
+        end
+        key
+      end
+
+      def get_binding
+        binding
+      end
+
+
+    end
+  end
+end

data/lib/KCommercialPipeline/core/resource/objective-c/oc_file_model.rb

@@ -0,0 +1,59 @@
+module KCommercial
+  module Resources
+
+    class OCFileModel
+      attr_accessor :header
+      attr_accessor :implementation
+
+      class << self
+        def templates_root
+          Pathname(__FILE__).parent.join('templates')
+        end
+
+        def public_header
+          templates_root.join('{{component_header_name}}.h')
+        end
+
+        def public_model
+          OCFileModel.new('{{component_header_name}}.h', nil)
+        end
+
+        def main_model
+          OCFileModel.new('{{oc_class_name}}.h',
+                          '{{oc_class_name}}.m')
+        end
+
+        def i18ns_model
+          file_model_for_type('I18ns')
+        end
+
+        def fonts_model
+          file_model_for_type('Fonts')
+        end
+
+        def images_model
+          file_model_for_type('Images')
+        end
+
+        def files_model
+          file_model_for_type('Files')
+        end
+
+        def colors_model
+          file_model_for_type('Colors')
+        end
+
+        def file_model_for_type(type)
+          OCFileModel.new("{{oc_class_name}}+#{type}.h",
+                          "{{oc_class_name}}+#{type}.m")
+        end
+      end
+
+      def initialize(header_name, imp_name)
+        @header = OCFileModel.templates_root.join(header_name) if header_name
+        @implementation = OCFileModel.templates_root.join(imp_name) if imp_name
+      end
+    end
+
+  end
+end

data/lib/KCommercialPipeline/core/resource/objective-c/oc_generator.rb

@@ -0,0 +1,55 @@
+require_relative '../code_generator/code_generator'
+require_relative 'code_model'
+require 'liquid'
+
+module KCommercial
+  module Resources
+    class OCGenerator
+      class << self
+        def templates_root
+          Pathname(__FILE__).parent.join('templates')
+        end
+      end
+
+      def initialize(file_model, name, keys, resources_status, options)
+        @file_model = file_model
+        @name = name
+        @keys = keys
+        @super_module_name = options.delete(:super) { :KCSemanticResources }
+        @resources_status = resources_status
+      end
+
+      def header_contents
+        ERB.new(File.read(@file_model.header)).result(code_model.get_binding)
+      end
+
+      def imp_contents
+        ERB.new(File.read(@file_model.implementation)).result(code_model.get_binding)
+      end
+
+      def code_model
+        @code_model ||= begin
+                          model = CodeModel.new
+                          model.keys = @keys
+                          model.super_module_name = @super_module_name
+                          model.component_name = @name
+                          model.resources_status = @resources_status
+                          model
+                        end
+      end
+
+      private
+
+      def render_map
+        {
+          "oc_class_name" => code_model.oc_class_name,
+          "bundle_name" => code_model.bundle_name,
+          "component_name" => code_model.component_name,
+          "keys" => @keys
+        }
+      end
+
+
+    end
+  end
+end

data/lib/KCommercialPipeline/core/resource/objective-c/templates/{{component_header_name}}.h

@@ -0,0 +1,39 @@
+//
+// Auto Generated By CocoaDepot
+//
+//     _____                      _____                   _
+//    / ____|                    |  __ \                 | |
+//   | |     ___   ___ ___   __ _| |  | | ___ _ __   ___ | |_
+//   | |    / _ \ / __/ _ \ / _` | |  | |/ _ | '_ \ / _ \| __|
+//   | |___| (_) | (_| (_) | (_| | |__| |  __| |_) | (_) | |_
+//    \_____\___/ \___\___/ \__,_|_____/ \___| .__/ \___/ \__|
+//                                           | |
+//                                           |_|
+// The universal cocoa devops toolchain.
+// This file is generated using the semantic resources. If you want
+// check more info please see:
+// * RFC-2021.07.01 iOS 资源语义化方案 http://shortlink.test.gifshow.com/A8nIepnk
+// * 资源语义化 Objective-C 代码生成 http://shortlink.test.gifshow.com/A8nIepnk
+//
+
+
+#ifndef <%= component_header_name%>_h
+#define <%= component_header_name%>_h
+/// The main portal for resources with component named '<%= component_name%>'
+#define <%= component_header_name%>R [<%= oc_class_name%> R]
+<% if resources_status.has_i18ns? %>
+#import "<%= oc_class_name %>+I18ns.h"
+<% end %>
+<% if resources_status.has_images? %>
+#import "<%=oc_class_name %>+Images.h"
+<% end %>
+<% if resources_status.has_colors? %>
+#import "<%=oc_class_name %>+Colors.h"
+<% end %>
+<% if resources_status.has_files? %>
+#import "<%=oc_class_name %>+Files.h"
+<% end %>
+<% if resources_status.has_fonts? %>
+#import "<%=oc_class_name %>+Fonts.h"
+<% end %>
+#endif

data/lib/KCommercialPipeline/core/resource/objective-c/templates/{{oc_class_name}}+Colors.h

@@ -0,0 +1,31 @@
+//
+// Auto Generated By CocoaDepot
+//
+//     _____                      _____                   _
+//    / ____|                    |  __ \                 | |
+//   | |     ___   ___ ___   __ _| |  | | ___ _ __   ___ | |_
+//   | |    / _ \ / __/ _ \ / _` | |  | |/ _ | '_ \ / _ \| __|
+//   | |___| (_) | (_| (_) | (_| | |__| |  __| |_) | (_) | |_
+//    \_____\___/ \___\___/ \__,_|_____/ \___| .__/ \___/ \__|
+//                                           | |
+//                                           |_|
+// The universal cocoa devops toolchain.
+// This file is generated using the semantic resources. If you want
+// check more info please see:
+// * RFC-2021.07.01 iOS 资源语义化方案 http://shortlink.test.gifshow.com/A8nIepnk
+// * 资源语义化 Objective-C 代码生成 http://shortlink.test.gifshow.com/A8nIepnk
+//
+
+
+#import <Foundation/Foundation.h>
+#import "<%= oc_class_name %>.h"
+
+/// @brief The portal for using colors from component named <%= component_name%>.
+@interface <%= oc_class_name %> (Colors)
+<% for key in keys %>
+/// The color for key '<%= key%>'
+///
+/// @return The color for key '<%= key%>'
+- (UIColor *)<%= key_to_function_name(key)%>;
+<% end %>
+@end

data/lib/KCommercialPipeline/core/resource/objective-c/templates/{{oc_class_name}}+Colors.m

@@ -0,0 +1,29 @@
+//
+// Auto Generated By CocoaDepot
+//
+//     _____                      _____                   _
+//    / ____|                    |  __ \                 | |
+//   | |     ___   ___ ___   __ _| |  | | ___ _ __   ___ | |_
+//   | |    / _ \ / __/ _ \ / _` | |  | |/ _ | '_ \ / _ \| __|
+//   | |___| (_) | (_| (_) | (_| | |__| |  __| |_) | (_) | |_
+//    \_____\___/ \___\___/ \__,_|_____/ \___| .__/ \___/ \__|
+//                                           | |
+//                                           |_|
+// The universal cocoa devops toolchain.
+// This file is generated using the semantic resources. If you want
+// check more info please see:
+// * RFC-2021.07.01 iOS 资源语义化方案 http://shortlink.test.gifshow.com/A8nIepnk
+// * 资源语义化 Objective-C 代码生成 http://shortlink.test.gifshow.com/A8nIepnk
+//
+
+#import "<%= oc_class_name %>+Colors.h"
+#import <KCSemanticResources/KCSemanticResources.h>
+
+@implementation <%= oc_class_name %> (Colors)
+
+<% for key in keys %>
+- (UIColor *)<%= key_to_function_name(key)%> {
+    return [self colorForKey:@"<%= key%>" env:KCRuntimeEnviroment.sharedInstance];
+}
+<% end %>
+@end