ccios 4.1.0 → 5.0.0

data/lib/ccios.rb

@@ -2,67 +2,89 @@ require 'date'
 require 'xcodeproj'
 require 'optparse'
 require 'active_support'
-require 'ccios/presenter_generator'
-require 'ccios/coordinator_generator'
-require 'ccios/interactor_generator'
-require 'ccios/repository_generator'
 require 'ccios/config'
+require 'ccios/template_definition'
+require 'ccios/templates_loader'
 
+config = Config.parse ".ccios.yml"
+source_path = Dir.pwd
+
+templates = TemplatesLoader.new.get_templates(config)
+
+subcommands = {}
 options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: ccios [options]"
+
+templates.values.each do |template|
+  subcommands[template.name] = OptionParser.new do |opts|
+
+    arguments = template.parameters.select { |p| p.is_a?(ArgumentTemplateParameter) }
+    flags = template.parameters.select { |p| p.is_a?(FlagTemplateParameter) }
+
+    arguments_line = arguments.map { |argument| "<#{argument.name}>" }.join(" ")
+
+    opts.banner = "Usage: ccios #{template.name} #{arguments_line} [options]"
+
+    flags.each do |flagParameter|
+      if flagParameter.short_name != nil
+        opts.on("-#{flagParameter.short_name}", "--#{flagParameter.name}", flagParameter.description) do |v|
+          options[flagParameter.template_variable_name] = v
+        end
+      else
+        opts.on("--#{flagParameter.name}", flagParameter.description) do |v|
+          options[flagParameter.template_variable_name] = v
+        end
+      end
+    end
+  end
+end
+
+global_cli = OptionParser.new do |opts|
+  opts.banner = "Usage: ccios <template> [options]"
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     options[:verbose] = v
   end
-  opts.on("-pName", "--presenter=Name", "Generate NamePresenter, NamePresenterImplementation, NameViewContract and NameViewController") do |name|
-    options[:presenter] = name
-  end
-  opts.on("-cName", "--coordinator=Name", "Generate NameCoordinator") do |name|
-    options[:coordinator] = name
-  end
-  opts.on("-iName", "--interactor=Name", "Generate NameInteractor and NameInteractorImplementation") do |name|
-    options[:interactor] = name
-  end
-  opts.on("-rName", "--repository=Name", "Generate NameRepository and NameRepositoryImplementation") do |name|
-    options[:repository] = name
-  end
-  opts.on("-d", "--delegate", "Add delegate for curent generation") do |add_delegate|
-    options[:generate_delegate] = add_delegate
-  end
   opts.on("-h", "--help", "Print this help") do
     puts opts
+    puts "Available templates: #{subcommands.keys.sort.join(", ")}"
     exit
   end
-end.parse!
+end
 
-source_path = Dir.pwd
-config = Config.parse ".ccios.yml"
-parser = PBXProjParser.new(source_path, config)
+global_cli.order!
+template_name = ARGV.shift
 
-if options[:presenter]
-  presenter_name = options[:presenter]
-  presenter_generator = PresenterGenerator.new(parser, config)
-  generator_options = {generate_delegate: options[:generate_delegate]}
-  presenter_generator.generate(presenter_name, generator_options)
+if template_name.nil?
+  puts "Error: Missing template name"
+  puts global_cli
+  exit(1)
 end
 
-if options[:coordinator]
-  coordinator_name = options[:coordinator]
-  coordinator_generator = CoordinatorGenerator.new(parser, config)
-  generator_options = {generate_delegate: options[:generate_delegate]}
-  coordinator_generator.generate(coordinator_name, generator_options)
+if subcommands[template_name].nil?
+  puts "Error: Unknown template \"#{template_name}\""
+  puts global_cli
+  exit(1)
 end
 
-if options[:interactor]
-  interactor_name = options[:interactor]
-  interactor_generator = InteractorGenerator.new(parser, config)
-  interactor_generator.generate(interactor_name)
+template = templates[template_name]
+expected_remaining_arguments = template.parameters.select { |p| p.is_a?(ArgumentTemplateParameter) }
+
+subcommands[template_name].order! do |argument|
+  expected_argument = expected_remaining_arguments.shift
+  if expected_argument.nil?
+    puts "Unexpected argument: #{argument}"
+    exit 1
+  end
+  options[expected_argument.template_variable_name] = argument
 end
 
-if options[:repository]
-  repository_name = options[:repository]
-  repository_generator = RepositoryGenerator.new(parser, config)
-  repository_generator.generate(repository_name)
+if !expected_remaining_arguments.empty?
+  puts "Missing arguments: #{expected_remaining_arguments.map { |p| p.name }.join(", ")}"
+  exit 1
 end
 
+parser = PBXProjParser.new(source_path, config)
+
+template.validate(parser, options, config)
+template.generate(parser, options, config)
+
 parser.save

data/templates_library/async/Coordinator/template.yml

@@ -0,0 +1,20 @@
+name: "coordinator"
+description: "Generate NameCoordinator"
+variables:
+  project: "*.xcodeproj"
+  base_path: "Coordinator"
+  target: ""
+parameters:
+  - argument: "name"
+    removeSuffix: "Coordinator"
+  - flag: "delegate"
+    short_name: "d"
+    template_variable_name: "generate_delegate"
+    description: "Generate delegate protocols when provided"
+generated_elements:
+  - name: "coordinator"
+    file: "{{ name }}Coordinator.swift"
+    template: "coordinator"
+    variables: {}
+template_file_source:
+  coordinator: "coordinator.mustache"

data/templates_library/async/Presenter/template.yml

@@ -0,0 +1,49 @@
+name: "presenter"
+description: "Generate NamePresenter, NamePresenterImplementation, NameViewContract and NameViewController"
+parameters:
+  - argument: "name"
+    removeSuffix: "Presenter"
+    lowercased_variable_name: "lowercased_name"
+  - flag: "delegate"
+    short_name: "d"
+    template_variable_name: "generate_delegate"
+    description: "Generate delegate protocols when provided"
+variables:
+  project: "*.xcodeproj"
+  base_path: "App"
+  target: ""
+generated_elements:
+  - name: "ui_view_group"
+    group: "{{ name }}/UI/View"
+    variables: {}
+  - name: "view_controller"
+    file: "{{ name }}/UI/ViewController/{{ name }}ViewController.swift"
+    template: "view_controller"
+    variables: {}
+  - name: "view_contract"
+    file: "{{ name }}/UI/{{ name }}ViewContract.swift"
+    template: "view_contract"
+    variables: {}
+  - name: "presenter"
+    file: "{{ name }}/Presenter/{{ name }}Presenter.swift"
+    template: "presenter"
+    variables: {}
+  - name: "presenter_implementation"
+    file: "{{ name }}/Presenter/{{ name }}PresenterImplementation.swift"
+    template: "presenter_implementation"
+    variables: {}
+  - name: "model_group"
+    group: "{{ name }}/Model"
+    variables: {}
+code_snippets:
+  - name: DependencyProvider
+    template: "dependency_provider"
+  - name: PresenterAssembly
+    template: "presenter_assembly"
+template_file_source:
+  view_controller: "view_controller.mustache"
+  view_contract: "view_contract.mustache"
+  presenter: "presenter.mustache"
+  presenter_implementation: "presenter_implementation.mustache"
+  dependency_provider: "dependency_provider.mustache"
+  presenter_assembly: "presenter_assembly.mustache"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ccios
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Pierre Felgines
@@ -99,40 +99,43 @@ files:
 - bin/ccios
 - ccios.gemspec
 - lib/ccios.rb
+- lib/ccios/argument_template_parameter.rb
 - lib/ccios/code_templater.rb
 - lib/ccios/config.rb
-- lib/ccios/coordinator_generator.rb
 - lib/ccios/file_creator.rb
-- lib/ccios/interactor_generator.rb
+- lib/ccios/file_template_definition.rb
+- lib/ccios/flag_template_parameter.rb
+- lib/ccios/group_template_definition.rb
 - lib/ccios/pbxproj_parser.rb
-- lib/ccios/presenter_generator.rb
-- lib/ccios/repository_generator.rb
-- lib/ccios/templates/coordinator.mustache
-- lib/ccios/templates/dependency_provider.mustache
-- lib/ccios/templates/interactor.mustache
-- lib/ccios/templates/interactor_assembly.mustache
-- lib/ccios/templates/interactor_implementation.mustache
-- lib/ccios/templates/presenter.mustache
-- lib/ccios/templates/presenter_assembly.mustache
-- lib/ccios/templates/presenter_implementation.mustache
-- lib/ccios/templates/repository.mustache
-- lib/ccios/templates/repository_assembly.mustache
-- lib/ccios/templates/repository_implementation.mustache
-- lib/ccios/templates/view_contract.mustache
-- lib/ccios/templates/view_controller.mustache
-- templates_library/async/coordinator.mustache
-- templates_library/async/dependency_provider.mustache
-- templates_library/async/interactor.mustache
-- templates_library/async/interactor_assembly.mustache
-- templates_library/async/interactor_implementation.mustache
-- templates_library/async/presenter.mustache
-- templates_library/async/presenter_assembly.mustache
-- templates_library/async/presenter_implementation.mustache
-- templates_library/async/repository.mustache
-- templates_library/async/repository_assembly.mustache
-- templates_library/async/repository_implementation.mustache
-- templates_library/async/view_contract.mustache
-- templates_library/async/view_controller.mustache
+- lib/ccios/snippet_template_definition.rb
+- lib/ccios/template_definition.rb
+- lib/ccios/templates/Coordinator/coordinator.mustache
+- lib/ccios/templates/Coordinator/template.yml
+- lib/ccios/templates/Interactor/interactor.mustache
+- lib/ccios/templates/Interactor/interactor_assembly.mustache
+- lib/ccios/templates/Interactor/interactor_implementation.mustache
+- lib/ccios/templates/Interactor/template.yml
+- lib/ccios/templates/Presenter/dependency_provider.mustache
+- lib/ccios/templates/Presenter/presenter.mustache
+- lib/ccios/templates/Presenter/presenter_assembly.mustache
+- lib/ccios/templates/Presenter/presenter_implementation.mustache
+- lib/ccios/templates/Presenter/template.yml
+- lib/ccios/templates/Presenter/view_contract.mustache
+- lib/ccios/templates/Presenter/view_controller.mustache
+- lib/ccios/templates/Repository/repository.mustache
+- lib/ccios/templates/Repository/repository_assembly.mustache
+- lib/ccios/templates/Repository/repository_implementation.mustache
+- lib/ccios/templates/Repository/template.yml
+- lib/ccios/templates_loader.rb
+- templates_library/async/Coordinator/coordinator.mustache
+- templates_library/async/Coordinator/template.yml
+- templates_library/async/Presenter/dependency_provider.mustache
+- templates_library/async/Presenter/presenter.mustache
+- templates_library/async/Presenter/presenter_assembly.mustache
+- templates_library/async/Presenter/presenter_implementation.mustache
+- templates_library/async/Presenter/template.yml
+- templates_library/async/Presenter/view_contract.mustache
+- templates_library/async/Presenter/view_controller.mustache
 - templates_library/default/README.md
 homepage: http://rubygems.org/gems/hola
 licenses:
@@ -153,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Clean Code iOS Generator

data/lib/ccios/coordinator_generator.rb

@@ -1,18 +0,0 @@
-require_relative 'file_creator'
-require_relative "pbxproj_parser"
-
-class CoordinatorGenerator
-
-  def initialize(parser, config)
-    @parser = parser
-    @config = config
-  end
-
-  def generate(coordinator_name, options = {})
-    coordinator_group = @parser.coordinator_group
-    file_creator = FileCreator.new(options, @config)
-    target = @parser.app_target
-    coordinator_name = coordinator_name.gsub("Coordinator", "")
-    file_creator.create_file(coordinator_name, 'Coordinator', coordinator_group, target)
-  end
-end

data/lib/ccios/interactor_generator.rb

@@ -1,33 +0,0 @@
-require_relative 'file_creator'
-require_relative "pbxproj_parser"
-
-class InteractorGenerator
-
-  def initialize(parser, config)
-    @parser = parser
-    @config = config
-  end
-
-  def generate(interactor_name, options = {})
-    interactor_group = @parser.interactor_group
-    interactor_name = interactor_name.gsub("Interactor", "")
-    new_group_name = "#{interactor_name}Interactor"
-
-    associate_path_to_group = !interactor_group.path.nil?
-
-    raise "[Error] Group #{new_group_name} already exists in #{app_group.display_name}" if interactor_group[new_group_name]
-    new_group_path = File.join(interactor_group.real_path, new_group_name)
-    new_group = interactor_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: new_group_name,
-      path: new_group_path
-    )
-
-    file_creator = FileCreator.new(options, @config)
-    target = @parser.core_target
-    file_creator.create_file(interactor_name, 'Interactor', new_group, target)
-    file_creator.create_file(interactor_name, 'InteractorImplementation', new_group, target)
-
-    file_creator.print_file_content(interactor_name, 'InteractorAssembly')
-  end
-end

data/lib/ccios/presenter_generator.rb

@@ -1,71 +0,0 @@
-require_relative 'file_creator'
-require_relative "pbxproj_parser"
-
-class PresenterGenerator
-
-  def initialize(parser, config)
-    @parser = parser
-    @config = config
-  end
-
-  def generate(presenter_name, options = {})
-    app_group = @parser.presenter_group
-    presenter_name = presenter_name.gsub("Presenter", "")
-    associate_path_to_group = !app_group.path.nil?
-
-    raise "[Error] Group #{presenter_name} already exists in #{app_group.display_name}" if app_group[presenter_name]
-    new_group_path = File.join(app_group.real_path, presenter_name)
-    new_group = app_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: presenter_name,
-      path: new_group_path
-    )
-
-    ui_group_path = File.join(new_group_path, "UI")
-    ui_group = new_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: "UI",
-      path: ui_group_path
-    )
-
-    view_group_path = File.join(ui_group_path, "View")
-    view_group = ui_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: "View",
-      path: view_group_path
-    )
-
-    view_controller_group_path = File.join(ui_group_path, "ViewController")
-    view_controller_group = ui_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: "ViewController",
-      path: view_controller_group_path
-    )
-
-    presenter_group_path = File.join(new_group_path, "Presenter")
-    presenter_group = new_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: "Presenter",
-      path: presenter_group_path
-    )
-
-    model_group_path = File.join(new_group_path, "Model")
-    model_group = new_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: "Model",
-      path: model_group_path
-    )
-
-    file_creator = FileCreator.new(options, @config)
-    target = @parser.app_target
-    file_creator.create_file(presenter_name, 'ViewContract', ui_group, target)
-    file_creator.create_file(presenter_name, 'ViewController', view_controller_group, target)
-    file_creator.create_file(presenter_name, 'Presenter', presenter_group, target)
-    file_creator.create_file(presenter_name, 'PresenterImplementation', presenter_group, target)
-    file_creator.create_empty_directory(model_group)
-    file_creator.create_empty_directory(view_group)
-
-    file_creator.print_file_content(presenter_name, 'DependencyProvider')
-    file_creator.print_file_content(presenter_name, 'PresenterAssembly')
-  end
-end

data/lib/ccios/repository_generator.rb

@@ -1,44 +0,0 @@
-require_relative 'file_creator'
-require_relative "pbxproj_parser"
-
-class RepositoryGenerator
-
-  def initialize(parser, config)
-    @parser = parser
-    @config = config
-  end
-
-  def generate(repository_name, options = {})
-    core_group = @parser.repository_core_group
-    data_group = @parser.repository_data_group
-    repository_name = repository_name.gsub("Repository", "")
-
-    raise "[Error] Group #{repository_name} already exists in #{core_group.display_name}" if core_group[repository_name]
-    associate_path_to_group = !core_group.path.nil?
-    core_data_new_group_path = File.join(core_group.real_path, repository_name)
-    core_data_new_group = core_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: repository_name,
-      path: core_data_new_group_path
-    )
-
-    raise "[Error] Group #{repository_name} already exists in #{data_group.display_name}" if data_group[repository_name]
-    associate_path_to_group = !data_group.path.nil?
-    data_new_group_path = File.join(data_group.real_path, repository_name)
-    data_new_group = data_group.pf_new_group(
-      associate_path_to_group: associate_path_to_group,
-      name: repository_name,
-      path: data_new_group_path
-    )
-
-    file_creator = FileCreator.new(options, @config)
-    core_target = @parser.core_target
-    file_creator.create_file(repository_name, 'Repository', core_data_new_group, core_target)
-
-    file_creator = FileCreator.new(options, @config)
-    data_target = @parser.data_target
-    file_creator.create_file(repository_name, 'RepositoryImplementation', data_new_group, data_target)
-
-    file_creator.print_file_content(repository_name, 'RepositoryAssembly')
-  end
-end

data/templates_library/async/interactor.mustache

@@ -1,13 +0,0 @@
-//
-//  {{name}}Interactor.swift
-//  {{project_name}}
-//
-//  Created by {{full_username}} on {{date}}.
-//
-//
-
-import Foundation
-
-public protocol {{name}}Interactor {
-    func execute() async throws
-}

data/templates_library/async/interactor_assembly.mustache

@@ -1,5 +0,0 @@
-container.register({{name}}Interactor.self) { _ in
-    {{name}}InteractorImplementation(
-
-    )
-}

data/templates_library/async/interactor_implementation.mustache

@@ -1,22 +0,0 @@
-//
-//  {{name}}InteractorImplementation.swift
-//  {{project_name}}
-//
-//  Created by {{full_username}} on {{date}}.
-//
-//
-
-import Foundation
-
-public class {{name}}InteractorImplementation: {{name}}Interactor {
-
-    public init() {
-
-    }
-
-    // MARK: - {{name}}Interactor
-
-    public func execute() async throws {
-
-    }
-}

data/templates_library/async/repository.mustache

@@ -1,13 +0,0 @@
-//
-//  {{name}}Repository.swift
-//  {{project_name}}
-//
-//  Created by {{full_username}} on {{date}}.
-//
-//
-
-import Foundation
-
-public protocol {{name}}Repository {
-
-}

data/templates_library/async/repository_assembly.mustache

@@ -1,6 +0,0 @@
-container.register({{name}}Repository.self) { _ in
-    {{name}}RepositoryImplementation(
-
-    )
-}
-.inObjectScope(.container)

data/templates_library/async/repository_implementation.mustache

@@ -1,20 +0,0 @@
-//
-//  {{name}}RepositoryImplementation.swift
-//  {{project_name}}
-//
-//  Created by {{full_username}} on {{date}}.
-//
-//
-
-import Foundation
-import Core
-
-public class {{name}}RepositoryImplementation: {{name}}Repository {
-
-    public init() {
-
-    }
-
-    // MARK: - {{name}}Repository
-
-}