ccios 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc6f5c81e7b9f2abf46e0f373717896e51762b3565f616205bd6a666d888fc65
-  data.tar.gz: 0f8661b91001f98ebe5e6435e8572bf1d671d871a22c120d85d29783d294cb36
+  metadata.gz: 27b359e8339dcd511d85488eb93f75d19e7b03bc6ed7cceedebdd721c3b9ad03
+  data.tar.gz: db07b4baa0b8143fcec3f70c3ecbd45b9e4a26b1885659128da67a52ffb1afc3
 SHA512:
-  metadata.gz: 7113bdee060f5d5808bb43951a0e0485b45cc058d857ccd0c64e36702a6418ed893e62a6a1dc9695ffa2c770c177931b9705a533cf2f2f8727bbabbbe0c25244
-  data.tar.gz: b0d3109396e17b9d8d3b4979901b3c2b6183de19da7df9f60ad784d6e0c7b26b6da9a730f6f0c607f4fd344634d8ca9f1ae505207f86131e677261fee451a4a1
+  metadata.gz: 25e62f91e331fe7b2e1e8b58dd1e44559faefe40be02b61a8d3858a0ba174618af52d897d9e87fa2b91b7df21e82a6130c8891d51bb0bc706764142c2b8916a4
+  data.tar.gz: c924d07dc088ca07efddc97de3222411f8fa564935b28e971480856bce1c08f88e3323134725f721d385e061980c62d50083057d9291a55c6c399db5b4ec0ca2

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [5.2.0]
+
+### Added
+
+- Add support for Swift Packages and Xcode 16 synchronized folders
+    - Add new optional variable nammed "project_type" which accepts 2 values: "xcode" and "filesystem". When missing ccios use "xcode" by default.
+    - When "project_type" is set to "filesystem" ccios will not try to update a pbxproj and will only generate files.
+    - When "project_type" is set to "filesystem" multi target definition is no longer supported for generated files.
+    - When generating files for an filesystem project, the target name in the header is either: the target defined in the template variables, the target defined in `.ccios.yml`, or it will try to guess the name when using SPM by searching the target name inside the standard naming scheme of: "Sources/<target_name>/".
+
 ## [5.1.0]
 
 ### Changed

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    ccios (5.1.0)
+    ccios (5.2.0)
       activesupport (> 4)
       mustache (~> 1.0)
-      xcodeproj (~> 1.4)
+      xcodeproj (~> 1.27)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,7 @@ GEM
       base64
       nkf
       rexml
-    activesupport (8.0.1)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -27,22 +27,22 @@ GEM
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
     atomos (0.1.3)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
     claide (1.1.0)
     colored2 (3.1.2)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
-    drb (2.2.1)
+    connection_pool (2.5.3)
+    drb (2.2.3)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    logger (1.6.6)
-    minitest (5.25.4)
+    logger (1.7.0)
+    minitest (5.25.5)
     mustache (1.1.1)
     nanaimo (0.4.0)
     nkf (0.2.0)
-    rake (13.2.1)
+    rake (13.3.0)
     rexml (3.4.1)
     securerandom (0.4.1)
     tzinfo (2.0.6)

data/MAINTAINER.md

@@ -6,3 +6,7 @@
 - Update the version in ccios.gemspec & run `bundle install`
 - Create a Pull Request
 - Once merged, create a tag `A.B.C` on the merged commit
+- Create release in GitHub
+- Publish release to RubyGem:
+	- `make build`
+	- `gem push ccios-A.B.C.gem`

data/README.md

@@ -137,6 +137,7 @@ templates_collection: ccios/templates
 
 # Global overrides of variables [Optional]
 variables:
+  project_type: xcode
   project: Project.xcodeproj
   target: SomeDefaultTarget
 
@@ -221,6 +222,9 @@ parameters:
 # List of templates variables that is used to generate files in an xcode project. [Optional]
 # Those variables can be overridden in config file, see section "Variable hierarchy" for more informations.
 variables:
+  # Type of project "filesystem" or "xcode", will be considered as "xcode" if not specified. [Optional]
+  # You want to use "filesystem" if you want to generate files for an SPM project, or if your Xcode project uses the new synchronized group from Xcode 16.
+  project_type: filesystem
   # The name of the xcode project. "*.xcodeproj" will use the first it finds. [required]
   project: "*.xcodeproj"
   # The base path used to generate an element. This variable must be defined once here, or on each elements below.
@@ -297,3 +301,16 @@ Element will use variables in this order (first in this list is used): (For file
 - Config Template variables
 - Default templates variables
 - Config Global variables
+
+# How to develop
+
+1. install the gem locally using
+```bash
+make install
+```
+2. Run use the locally installed ccios gem on your project
+```bash
+ccios presenter MyNewPresenterStack
+```
+
+Note: ensure that you use the same ruby version when building, installing and running this local version of ccios.

data/ccios.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ccios'
-  s.version     = '5.1.0'
+  s.version     = '5.2.0'
   s.executables << 'ccios'
   s.date        = '2016-08-03'
   s.summary     = "Clean Code iOS Generator"
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://rubygems.org/gems/hola'
   s.license     = 'MIT'
   s.add_dependency 'activesupport', '> 4'
-  s.add_dependency 'xcodeproj', '~> 1.4'
+  s.add_dependency 'xcodeproj', '~> 1.27'
   s.add_dependency "mustache", "~> 1.0"
 
   s.add_development_dependency 'rake', '~> 13.2'

data/lib/ccios/file_creator.rb

@@ -3,18 +3,6 @@ require 'fileutils'
 require 'logger'
 require 'xcodeproj'
 
-class Xcodeproj::Project::Object::PBXGroup
-
-  def pf_new_group(associate_path_to_group:, name:, path:)
-    # When using "Group with folder" we only provide a path
-    # When using "Group without folder" we only provide a name
-    new_group(
-      associate_path_to_group ? nil : name,
-      associate_path_to_group ? path : nil
-    )
-  end
-end
-
 class Xcodeproj::Project
 
   def project_name_from_path
@@ -37,10 +25,18 @@ class FileCreator
       full_username: git_username,
       date: DateTime.now.strftime("%d/%m/%Y"),
     }
-    if targets.count == 1
-      defaults["project_name"] = targets[0].display_name
+    if project.nil?
+      if targets.count == 1
+        defaults["project_name"] = targets[0]
+      else
+        raise "A file outside an xcode project cannot require multiple targets"
+      end
     else
-      defaults["project_name"] = project.project_name_from_path
+      if targets.count == 1
+        defaults["project_name"] = targets[0].display_name
+      else
+        defaults["project_name"] = project.project_name_from_path
+      end
     end
     defaults
   end
@@ -69,10 +65,7 @@ class FileCreator
     file.puts(file_content)
 
     file.close
-    file_ref = group.new_reference(file_path)
-    targets.each do |target|
-      target.add_file_references([file_ref])
-    end
+    group.register_file_to_targets(file_path, targets)
   end
 
   def print_file_content_using_template(filename, template_path, context)
@@ -83,8 +76,12 @@ class FileCreator
     logger.info file_content
   end
 
-  def create_empty_directory(group)
+  def create_empty_directory_for_group(group)
     dirname = group.real_path
+    create_empty_directory(dirname)
+  end
+
+  def create_empty_directory(dirname)
     FileUtils.mkdir_p dirname unless File.directory?(dirname)
 
     git_keep_path = File.join(dirname, ".gitkeep")

data/lib/ccios/file_template_definition.rb

@@ -1,6 +1,6 @@
 require_relative 'code_templater'
 require_relative 'file_creator'
-require_relative 'pbxproj_parser'
+require_relative 'xcode_group_representation'
 
 class FileTemplateDefinition
   def initialize(file_template_definition_hash)
@@ -33,20 +33,34 @@ class FileTemplateDefinition
     base_path = merged_variables["base_path"]
     raise "Missing base_path variable" if base_path.nil?
 
-    base_group = project[base_path]
-    raise "Base path \"#{base_path}\" is missing" if base_group.nil?
-
     target_name = merged_variables["target"]
-    if target_name.is_a?(String) || target_name.nil?
-      target = parser.target_for(project, target_name)
-      raise "Unable to find target \"#{target_name}\"" if target.nil?
-    elsif target_name.is_a?(Array)
-      target_name.each do |target_name|
+    if project.nil?
+      if target_name.is_a?(String)
+        target = target_name
+      elsif target_name.nil?
+        guessed_name = guess_target_name_from_path(base_path)
+        raise "Unable to guess the target from the base path \"#{base_path}\", please specify the target in your config file" if guessed_name.nil?
+        target = guessed_name
+      elsif target_name.is_a?(Array)
+        raise "A template generating files in an filesystem project type cannot specify multiple targets"
+      else
+        raise "Invalid target in template #{@name}"
+      end
+    else
+      base_group = XcodeGroupRepresentation.findGroup(base_path, project)
+      raise "Base path \"#{base_path}\" is missing" if base_group.nil?
+
+      if target_name.is_a?(String) || target_name.nil?
         target = parser.target_for(project, target_name)
         raise "Unable to find target \"#{target_name}\"" if target.nil?
+      elsif target_name.is_a?(Array)
+        target_name.each do |target_name|
+          target = parser.target_for(project, target_name)
+          raise "Unable to find target \"#{target_name}\"" if target.nil?
+        end
+      else
+        raise "Invalid target in template #{@name}"
       end
-    else
-      raise "Invalid target in template #{@name}"
     end
 
   end
@@ -55,32 +69,30 @@ class FileTemplateDefinition
     merged_variables = config.variables_for_template_element(template_definition, @name, @variables)
 
     base_path = merged_variables["base_path"]
-    base_group = project[base_path]
+    base_group = XcodeGroupRepresentation.findGroup(base_path, project)
     file_path = CodeTemplater.new.render_string(@path, context)
 
     intermediates_groups = file_path.split("/")[0...-1]
     generated_filename = file_path.split("/")[-1]
 
-    group = base_group
-    associate_path_to_group = !base_group.path.nil?
-
-    intermediates_groups.each do |group_name|
-      new_group_path = File.join(group.real_path, group_name)
-      existing_group = group.groups.find { |g| g.display_name == group_name }
-      group = existing_group || group.pf_new_group(
-        associate_path_to_group: associate_path_to_group,
-        name: group_name,
-        path: new_group_path
-      )
-    end
+    group = base_group.create_groups_if_needed_for_intermediate_groups(intermediates_groups)
 
     target_name = merged_variables["target"]
 
     targets = []
-    if target_name.is_a?(String) || target_name.nil?
-      targets = [parser.target_for(project, target_name)]
-    elsif target_name.is_a?(Array)
-      targets = target_name.map { |name| parser.target_for(project, name) }
+    if project.nil?
+      if target_name.is_a?(String)
+        targets = [target_name]
+      elsif target_name.nil?
+        guessed_name = guess_target_name_from_path(base_path)
+        targets = [guessed_name]
+      end
+    else
+      if target_name.is_a?(String) || target_name.nil?
+        targets = [parser.target_for(project, target_name)]
+      elsif target_name.is_a?(Array)
+        targets = target_name.map { |name| parser.target_for(project, name) }
+      end
     end
 
     FileCreator.new.create_file_using_template_path(
@@ -92,4 +104,15 @@ class FileTemplateDefinition
       context
     )
   end
-end
+
+  private def guess_target_name_from_path(path)
+    # SPM standard format
+    parts = path.split(File::SEPARATOR)
+    sources_index = parts.index("Sources")
+    if sources_index && sources_index + 1 < parts.length
+      return parts[sources_index + 1]
+    else
+      return nil
+    end
+  end
+end

data/lib/ccios/group_template_definition.rb

@@ -1,6 +1,5 @@
 require_relative 'code_templater'
 require_relative 'file_creator'
-require_relative 'pbxproj_parser'
 
 class GroupTemplateDefinition
   def initialize(group_template_definition_hash)
@@ -22,7 +21,7 @@ class GroupTemplateDefinition
     base_path = merged_variables["base_path"]
     raise "Missing base_path variable" if base_path.nil?
 
-    base_group = project[base_path]
+    base_group = XcodeGroupRepresentation.findGroup(base_path, project)
     raise "Base path \"#{base_path}\" is missing" if base_group.nil?
   end
 
@@ -30,25 +29,13 @@ class GroupTemplateDefinition
     merged_variables = config.variables_for_template_element(template_definition, @name, @variables)
 
     base_path = merged_variables["base_path"]
-    base_group = project[base_path]
+    base_group = XcodeGroupRepresentation.findGroup(base_path, project)
     group_path = CodeTemplater.new.render_string(@path, context)
 
-    group_path = group_path.split("/")
-
-    group = base_group
-    associate_path_to_group = !base_group.path.nil?
-
-    group_path.each do |group_name|
-      new_group_path = File.join(group.real_path, group_name)
-      existing_group = group.groups.find { |g| g.display_name == group_name }
-      group = existing_group || group.pf_new_group(
-        associate_path_to_group: associate_path_to_group,
-        name: group_name,
-        path: new_group_path
-      )
-    end
+    group_path_components = group_path.split("/")
+    group = base_group.create_groups_if_needed_for_intermediate_groups(group_path_components)
 
     file_creator = FileCreator.new
-    file_creator.create_empty_directory(group)
+    file_creator.create_empty_directory_for_group(group)
   end
-end
+end

data/lib/ccios/pbxproj_parser.rb

@@ -33,4 +33,4 @@ class PBXProjParser
       project.targets.find { |t| t.name == target_name }
     end
   end
-end
+end

data/lib/ccios/template_definition.rb

@@ -59,10 +59,17 @@ class TemplateDefinition
     raise "Error: invalid template name" unless @name.is_a? String
 
     merged_variables = config.variables_for_template(self)
-    project_path = merged_variables["project"]
-
-    project = parser.project_for(project_path)
-    raise "Error: Unable to find project \"#{project_path}\"" if project.nil?
+    project_type = merged_variables["project_type"] || "xcode"
+    case project_type
+    when "xcode"
+      project_path = merged_variables["project"]
+      project = parser.project_for(project_path)
+      raise "Error: Unable to find project \"#{project_path}\"" if project.nil?
+    when "filesystem"
+      project = nil
+    else
+      raise "Invalid project_type given \"#{project_type}\", only \"xcode\" and \"fiilesystem\" are supported"
+    end
 
     @template_file_source.each do |file_template_name, path|
       raise "Missing template source file for \"#{file_template_name}\"" unless File.exist?(self.template_source_file(file_template_name))
@@ -93,9 +100,16 @@ class TemplateDefinition
     options = agrument_transformed_options(options)
 
     merged_variables = config.variables_for_template(self)
-    project_path = merged_variables["project"]
 
-    project = parser.project_for project_path
+    project_type = merged_variables["project_type"] || "xcode"
+    case project_type
+    when "xcode"
+      project_path = merged_variables["project"]
+      project = parser.project_for project_path
+    when "filesystem"
+      project = nil
+
+    end
 
     @generated_elements.each do |element|
       element.generate(parser, project, options, self, config)

data/lib/ccios/xcode_group_representation.rb

@@ -0,0 +1,107 @@
+require_relative 'pbxproj_parser'
+
+# This object handles Xcode groups, folder reference and synchronized folder reference
+class XcodeGroupRepresentation
+  def self.findGroup(path, project)
+    intermediates_groups = path.split("/")
+
+    if project.nil?
+      return self.new nil, nil, intermediates_groups
+    end
+
+    deepest_group = project.main_group
+    additional_path = []
+
+    intermediates_groups.each do |group_name|
+      if deepest_group.is_a?(Xcodeproj::Project::Object::PBXFileSystemSynchronizedRootGroup)
+        additional_path.append(group_name)
+      elsif deepest_group.is_a?(Xcodeproj::Project::Object::PBXGroup)
+        deepest_group = deepest_group.find_subpath(group_name)
+        return nil if deepest_group.nil?
+      else
+        raise "Unsupported element found with name \"#{group_name}\": #{deepest_group}"
+      end
+    end
+    self.new project, deepest_group, additional_path
+  end
+
+  def initialize(project, xcode_group, additional_path = [])
+    if project.nil?
+      throw "Unexpected xcode_group when project is nil, we should be in an filesystem context" unless xcode_group.nil?
+    else
+      throw "Unsupported group type" unless xcode_group.is_a?(Xcodeproj::Project::Object::PBXFileSystemSynchronizedRootGroup) || xcode_group.is_a?(Xcodeproj::Project::Object::PBXGroup)
+      if !additional_path.empty? && !xcode_group.is_a?(Xcodeproj::Project::Object::PBXFileSystemSynchronizedRootGroup)
+        throw "additional_path can only be specified for a synchronized file system group"
+      end
+    end
+    # This represent the xcode project if present, if nil we should be generating files in an Swift package
+    @project = project
+    # This represents the deepest group or folder reference in the project
+    @xcode_deepest_group = xcode_group
+    # This represents the additional filesystem path after `xcode_deepest_group` as an Array of strings. This should be non empty only when deepest group is a synchronized group
+    @additional_path = additional_path
+  end
+
+  def real_path
+    if @xcode_deepest_group.nil?
+      @additional_path.join("/")
+    else
+      Xcodeproj::Project::Object::GroupableHelper.real_path(@xcode_deepest_group) + @additional_path.join("/")
+    end
+  end
+
+
+  def register_file_to_targets(file_path, targets)
+    if @xcode_deepest_group.nil?
+      return
+    end
+    if @xcode_deepest_group.is_a?(Xcodeproj::Project::Object::PBXGroup)
+      file_ref = @xcode_deepest_group.new_reference(file_path)
+      targets.each do |target|
+        target.add_file_references([file_ref])
+      end
+    else
+      # no file to register, unless exceptions needs to be made
+      # TODO: Handle synchronized groups (no new reference, but use exceptions)
+      targets.each do |taget|
+        puts "Unsupported target mismatch between \"#{file_path}\" and synchronized group #{ @xcode_deepest_group.display_name }" unless taget.file_system_synchronized_groups.index(@xcode_deepest_group) != nil
+      end
+    end
+  end
+
+  # @return [XcodeGroupRepresentation] the created group or self if the intermediates_groups is empty
+  def create_groups_if_needed_for_intermediate_groups(intermediates_groups)
+    return self if intermediates_groups.empty?
+
+    new_deepest_group = @xcode_deepest_group
+    new_additional_path = @additional_path
+
+    intermediates_groups.each do |group_name|
+      if new_deepest_group.nil? || new_deepest_group.is_a?(Xcodeproj::Project::Object::PBXFileSystemSynchronizedRootGroup)
+        new_additional_path.append(group_name)
+      elsif new_deepest_group.is_a?(Xcodeproj::Project::Object::PBXGroup)
+        existing_child = new_deepest_group.find_subpath(group_name)
+        new_group_path = File.join(new_deepest_group.real_path, group_name)
+        new_deepest_group = existing_child || new_deepest_group.pf_new_group(
+          associate_path_to_group: !new_deepest_group.path.nil?,
+          name: group_name,
+          path: new_group_path
+        )
+      else
+        raise "Unsupported element found for \"#{group_name}\": #{new_deepest_group}"
+      end
+    end
+    XcodeGroupRepresentation.new @project, new_deepest_group, new_additional_path
+  end
+end
+
+# Private utility method
+
+class Xcodeproj::Project::Object::PBXGroup
+  def pf_new_group(associate_path_to_group:, name:, path:)
+    new_group(
+      associate_path_to_group ? nil : name,
+      associate_path_to_group ? path : nil
+    )
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ccios
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Pierre Felgines
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.27'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - lib/ccios/templates/Repository/repository_implementation.mustache
 - lib/ccios/templates/Repository/template.yml
 - lib/ccios/templates_loader.rb
+- lib/ccios/xcode_group_representation.rb
 - templates_library/async/Coordinator/coordinator.mustache
 - templates_library/async/Coordinator/template.yml
 - templates_library/async/Presenter/dependency_provider.mustache