swift_generator 0.1.2 → 0.3.0

data/README.md

@@ -1,8 +1,6 @@
-# SwiftGenerator
+# swift\_generator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swift_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem vends an API to generate swift code programatically. Any number of code elements can be created simultaneously and iteratively. 
 
 ## Installation
 
@@ -21,8 +19,58 @@ Or install it yourself as:
     $ gem install swift_generator
 
 ## Usage
+### Ruby API
+
+```ruby
+
+# Coming Soon
+
+```
+
+### Command Line Tool
+Work on a simple command-line interface has been started to generate Swift code from non-ruby systems.
+
+To invoke the tool:
+
+	genswift generate SPECFILE [options]
+	
+or just
+
+	genswift SPECFILE [options]
+	
+Some help is availible:
+
+	genswift help
+	genswift help generate
+	
+###### Specfile Format
+ 
+```json
+
+# Coming Soon
+
+```
+
+##Project Status
+The initial use of this gem is by the [objective\_c\_2\_swift\_assistant](https://www.something.com "Github project") gem to generate Swift files.
+ 
+The current release is functional, but rough. Testing, input validation, and other important quality aspects are missing. 
+
+##Design and History 
+This gem started out as a way to generate Swift code for a production application. It was started a few weeks after WWDC 2014.
+
+The design was experiment in a sense. We want to see if it was possible to create a code generator that could have some intelligence about the code it was generating.
+
+###Goals
+* Preservation of intermediate state information for debugging and extensibility
+* High-level constructs for things that matter to developers: Types, Classes, Methods, Properties, ...
+* The ability to generate unit tests for the methods it generates. This feature is not yet well documented at this time
+* Ability to generate meaningful pure Swift classes (classes not descending from NSObject)
+* JSON serialization support for generated Swift classes
 
-TODO: Write usage instructions here
+###Non-Goals
+* Code generation speed
+* Minimal Memory Footprint
 
 ## Development
 

data/bin/genswift

@@ -11,7 +11,7 @@ program :version, '1.0.0'
 program :description, 'Basic CLI interface to the swift_generator gem'
 
 command :generate do |c|
-  c.syntax = 'genswift specfile'
+  c.syntax = 'genswift SPECFILE [options]'
   c.description = 'Generate Swift files based upon a JSON specification file.'
   c.option '--out STRING', String, 'The root of the generated Swift source. Overrides the setting in the spec file.'
   c.action do |args, options|

data/examples/ReadmeExample.rb

@@ -0,0 +1,216 @@
+require 'rubygems'
+require 'json'
+require_relative 'POSOMetaclasses'
+require_relative 'POSOTypes'
+require_relative 'usi_metaclasses'
+
+def make_definition_set
+	# File Paths
+	useful_root = '../Useful'
+	model_user_source = File.join(useful_root, 'Shared', 'Models')
+	model_generated_source = File.join(model_user_source, 'Generated')
+
+	test_root = '../UsefulTests'
+	model_test = File.join(test_root, 'Shared', 'Models')
+	model_generated_test = File.join(model_test, 'Generated')
+
+	# Standard USI Model settings
+	uis_model_characteristics = [:json_serializable, :comparable, :make_test_class, :create_user_class]
+
+	# USI Model (Wire Data) settings
+	defs = SwiftDefinitionSet.new( generated_root:model_generated_source,
+								   generated_user_root:model_user_source,
+								   generated_test_root:model_generated_test)
+
+	base = SwiftClass.new(defs, 'USIBaseModel', ['NSObject'], characteristics: uis_model_characteristics )
+	base.add_simple_class_property( "restEndpoint", :AnvilEndpoint, value:".None", override:false )
+
+	SwiftPersistentProperty.new( base, '__v',             :String, 	:optional, rest_omit: :omit_if_null)
+	SwiftPersistentProperty.new( base, '_id',             :String, 	:optional, rest_omit: :omit_if_null )
+	SwiftPersistentProperty.new( base, 'organizationID',  :String, 	:optional, json_key:'organizationId', rest_omit: :omit   )
+	SwiftPersistentProperty.new( base, 'updatedAt',       :NSDate, 	:optional, rest_omit: :omit )
+
+	address = USIWireDataClass.new(defs, 'Address', endpoint:".Addresses"  )
+	SwiftPersistentProperty.new( address, 'buildingName',		:String,	:optional )
+	SwiftPersistentProperty.new( address, 'city',				:String,	:optional )
+	SwiftPersistentProperty.new( address, 'country',			:String,	:optional )
+	SwiftPersistentProperty.new( address, 'governingDistrict',	:String,	:optional )
+	SwiftPersistentProperty.new( address, 'latitude',			:Double,	:optional )
+	SwiftPersistentProperty.new( address, 'localMunicipality',	:String,	:optional )
+	SwiftPersistentProperty.new( address, 'longitude',			:Double,	:optional )
+	SwiftPersistentProperty.new( address, 'postalArea',			:String,	:optional )
+	SwiftPersistentProperty.new( address, 'streetDirection',	:String,	:optional )
+	SwiftPersistentProperty.new( address, 'streetName',			:String,	:optional )
+	SwiftPersistentProperty.new( address, 'streetNumber',		:Int,		:optional )
+	SwiftPersistentProperty.new( address, 'streetNumberSuffix',	:String,	:optional )
+	SwiftPersistentProperty.new( address, 'streetType',			:String,	:optional )
+	SwiftPersistentProperty.new( address, 'title',				:String,	:optional )
+	SwiftPersistentProperty.new( address, 'type',				:String,	:optional )
+	SwiftPersistentProperty.new( address, 'typeIdentifier',		:String,	:optional )
+
+	affOrg = USIWireDataClass.new( defs, 'AffiliateOrganization', endpoint:".AffiliateOrganizations" )
+	SwiftPersistentProperty.new( affOrg, 'activeCustomer', 		:Bool,			:optional )
+	SwiftPersistentProperty.new( affOrg, 'activePartner',		:Bool,			:optional )
+	SwiftPersistentProperty.new( affOrg, 'customer',			:Bool,			:optional )
+	SwiftPersistentProperty.new( affOrg, 'otherOrganization',	:USIObjectID,	:optional )
+	SwiftPersistentProperty.new( affOrg, 'partner', 			:Bool,			:optional )
+
+	contact = USIWireDataClass.new( defs, 'Contact', endpoint:".Contacts"  )
+	SwiftPersistentProperty.new( contact, 'email', 			:String, 		:optional )
+	SwiftPersistentProperty.new( contact, 'firstName', 		:String, 		:optional )
+	SwiftPersistentProperty.new( contact, 'lastName', 		:String, 		:optional )
+	SwiftPersistentProperty.new( contact, 'phoneNumber', 	:PhoneNumber, 	:optional )
+
+	customer = USIWireDataClass.new( defs, 'Customer', endpoint:".Customers" )
+	SwiftPersistentProperty.new( customer, 'name', 			:String, 		:optional )
+	SwiftPersistentProperty.new( customer, 'email', 		:String, 		:optional )
+	SwiftPersistentProperty.new( customer, 'types', 		:String, 		:optional, collection_type: :array )
+	SwiftPersistentProperty.new( customer, 'account', 		:String, 		:optional )
+	SwiftPersistentProperty.new( customer, 'addresses', 	:Address,		:optional, collection_type: :array )
+	SwiftPersistentProperty.new( customer, 'contacts', 		:Contact,		:optional, collection_type: :array  )
+	SwiftPersistentProperty.new( customer, 'phoneNumbers', 	:PhoneNumber, 	:optional, collection_type: :array )
+
+	customerSummary = USIWireDataClass.new( defs, 'CustomerSummary' )
+	SwiftPersistentProperty.new( customerSummary, 'name', 		:String, 		:optional )
+	SwiftPersistentProperty.new( customerSummary, 'email', 		:String, 		:optional )
+	SwiftPersistentProperty.new( customerSummary, 'types', 		:String, 		:optional, collection_type: :array  )
+	SwiftPersistentProperty.new( customerSummary, 'account', 	:String, 		:optional )
+
+	detail = USIWireDataClass.new( defs, 'Detail', endpoint:".Details" )
+	SwiftPersistentProperty.new( detail, 'detailText', 	:String,	:optional )
+	SwiftPersistentProperty.new( detail, 'userId', 		:String,	:optional )
+	SwiftPersistentProperty.new( detail, 'workFormID', 	:String,	:optional, json_key:'workFormid'  )
+	SwiftPersistentProperty.new( detail, 'title', 		:String,	:optional )
+
+	materialType = USIWireDataClass.new( defs, 'MaterialType', endpoint:".MaterialTypes" )
+	SwiftPersistentProperty.new( materialType, 'materialDescription', 	:String,	:optional, json_key:'description' )
+	SwiftPersistentProperty.new( materialType, 'defaultBillablePrice', 	:Int,		:optional )
+	SwiftPersistentProperty.new( materialType, 'defaultCost', 			:Int,		:optional )
+	SwiftPersistentProperty.new( materialType, 'name',					:String,	:optional )
+	SwiftPersistentProperty.new( materialType, 'partNumber',			:String,	:optional )
+	SwiftPersistentProperty.new( materialType, 'unit',					:String,	:optional )
+
+	material = USIWireDataClass.new(defs, 'Material', endpoint:".Materials")
+	SwiftPersistentProperty.new( material, 'workFormID', 			:String,	:optional )
+	SwiftPersistentProperty.new( material, 'materialTypeID', 		:String,	:optional )
+	SwiftPersistentProperty.new( material, 'materialDescription', 	:String,	:optional, json_key:'description' )
+	SwiftPersistentProperty.new( material, 'billablePrice', 		:Int,		:optional )
+	SwiftPersistentProperty.new( material, 'cost', 					:Int,		:optional )
+	SwiftPersistentProperty.new( material, 'name',					:String,	:optional )
+	SwiftPersistentProperty.new( material, 'partNumber',			:String,	:optional )
+	SwiftPersistentProperty.new( material, 'unit',					:String,	:optional )
+
+	org = USIWireDataClass.new( defs, 'Organization', endpoint:".Organizations" )
+	SwiftPersistentProperty.new( org, 'addresses',					:Address, 					:optional, collection_type: :array )
+	SwiftPersistentProperty.new( org, 'affiliateOrganizations', 	:Organization, 	:optional, collection_type: :array )
+	SwiftPersistentProperty.new( org, 'contacts',					:Contact, 					:optional, collection_type: :array )
+	SwiftPersistentProperty.new( org, 'defaultTaxRate',				:Int,						:optional )
+	SwiftPersistentProperty.new( org, 'email',						:String,					:optional )
+	SwiftPersistentProperty.new( org, 'logoURIs',					:String, 					:optional, collection_type: :array )
+	SwiftPersistentProperty.new( org, 'materialTypes', 				:MaterialType, 				:optional, collection_type: :array )
+	SwiftPersistentProperty.new( org, 'name',						:String,					:optional )
+	SwiftPersistentProperty.new( org, 'phoneNumbers',				:PhoneNumber,				:optional, collection_type: :array )
+	SwiftPersistentProperty.new( org, 'serviceTypes',				:ServiceType, 				:optional, collection_type: :array )
+	# 'subscription (ref to Subscription)
+	SwiftPersistentProperty.new( org, 'timezone',					:String,					:optional )
+	SwiftPersistentProperty.new( org, 'website',					:String,					:optional )
+	SwiftPersistentProperty.new( org, 'users',						:User,						:optional, collection_type: :array )
+
+	payRate = USIWireDataClass.new(defs, 'PayRate', endpoint:".PayRates" )
+	SwiftPersistentProperty.new( payRate, 'rate', 		:Int, 		:optional )
+	SwiftPersistentProperty.new( payRate, 'taxType', 	:TaxType, 	:optional )
+
+	permission = SwiftEnum.new(defs, 'Permission', ['String'] )
+	SwiftEnumCase.new( permission, 'Admin', 		'ADMIN' )
+
+	phoneNumber = USIWireDataClass.new(defs, 'PhoneNumber', endpoint:".PhoneNumbers" )
+	SwiftPersistentProperty.new( phoneNumber, 'areaCode', 		:Int, 		:optional )
+	SwiftPersistentProperty.new( phoneNumber, 'countryCode',	:Int, 		:optional )
+	SwiftPersistentProperty.new( phoneNumber, 'exchange',		:Int, 		:optional )
+	SwiftPersistentProperty.new( phoneNumber, 'line',			:Int, 		:optional )
+	SwiftPersistentProperty.new( phoneNumber, 'type',			:String,	:optional )
+
+	role = USIWireDataClass.new( defs, 'Role', endpoint:".Roles" )
+	SwiftPersistentProperty.new( role, 'permissions', 	:Permission, 	:optional, collection_type: :array )
+
+	serviceType = USIWireDataClass.new( defs, 'ServiceType', endpoint:".ServiceTypes" )
+	SwiftPersistentProperty.new( serviceType, 'defaultBillableRate',	:Int, 		:optional )
+	SwiftPersistentProperty.new( serviceType, 'serviceDescription',		:String, 	:optional, json_key:'description')
+	SwiftPersistentProperty.new( serviceType, 'isHourlyRate',			:Bool,		:optional )
+	SwiftPersistentProperty.new( serviceType, 'name',					:String,	:optional )
+
+	service = USIWireDataClass.new( defs, 'Service', endpoint: ".Services" )
+	SwiftPersistentProperty.new( service, 'billableRate',			:Int, 		:optional )
+	SwiftPersistentProperty.new( service, 'serviceDescription',		:String, 	:optional, json_key:'description')
+	SwiftPersistentProperty.new( service, 'isHourlyRate',			:Bool,		:optional )
+	SwiftPersistentProperty.new( service, 'name',					:String,	:optional )
+	SwiftPersistentProperty.new( service, 'serviceTypeId',			:String,	:optional )
+	SwiftPersistentProperty.new( service, 'workFormId',				:String,	:optional )
+
+	tax_type = SwiftEnum.new(defs, 'TaxType', ['String']  )
+	SwiftEnumCase.new( tax_type, 'HourlyEmployee', 		'HOURLY_EMPLOYEE' )
+	SwiftEnumCase.new( tax_type, 'None', 				'NONE' )
+	SwiftEnumCase.new( tax_type, 'SalariedContractor', 	'SALARIED_CONTRACTOR' )
+	SwiftEnumCase.new( tax_type, 'SalariedEmployee', 	'SALARIED_EMPLOYEE' )
+
+	user = USIWireDataClass.new(defs, 'User', endpoint:".Users")
+	SwiftPersistentProperty.new( user, 'addresses',					:Address, 		:optional, collection_type: :array )
+	SwiftPersistentProperty.new( user, 'disabled',					:Bool, 			:optional )
+	SwiftPersistentProperty.new( user, 'emergencyContacts',			:Contact, 		:optional, collection_type: :array )
+	SwiftPersistentProperty.new( user, 'email',						:String, 		:optional )
+	SwiftPersistentProperty.new( user, 'firstName',					:String, 		:optional )
+	SwiftPersistentProperty.new( user, 'lastName',					:String, 		:optional )
+	SwiftPersistentProperty.new( user, 'latitude',					:Double, 		:optional )
+	SwiftPersistentProperty.new( user, 'longitude',					:Double, 		:optional )
+	SwiftPersistentProperty.new( user, 'passwordHash',				:String, 		:optional )
+	SwiftPersistentProperty.new( user, 'payRate',					:PayRate, 		:optional )
+	SwiftPersistentProperty.new( user, 'phoneNumbers',				:PhoneNumber,	:optional, collection_type: :array )
+	SwiftPersistentProperty.new( user, 'photoURIs',					:String, 		:optional, collection_type: :array )
+	SwiftPersistentProperty.new( user, 'role',						:Role, 			:optional )
+
+	userSummary = USIWireDataClass.new( defs, 'UserSummary' )
+	SwiftPersistentProperty.new( userSummary, 'isDisabled',			:Bool, 			:optional )
+	SwiftPersistentProperty.new( userSummary, 'email',				:String, 		:optional )
+	SwiftPersistentProperty.new( userSummary, 'firstName',			:String, 		:optional )
+	SwiftPersistentProperty.new( userSummary, 'lastName',			:String, 		:optional )
+	SwiftPersistentProperty.new( userSummary, 'nickname',			:String, 		:optional )
+
+	workForm = USIWireDataClass.new( defs, 'WorkForm', endpoint:".WorkForms" )
+	SwiftPersistentProperty.new( workForm, 'customer',				:CustomerSummary,	:optional )
+	SwiftPersistentProperty.new( workForm, 'formDescription',		:String,			:optional, json_key:'description' )
+	SwiftPersistentProperty.new( workForm, 'assignedToUser', 		:UserSummary,		:optional )
+	SwiftPersistentProperty.new( workForm, 'createdByUser', 		:UserSummary,		:optional )
+	SwiftPersistentProperty.new( workForm, 'details',				:Detail,			:optional, collection_type: :array )
+	SwiftPersistentProperty.new( workForm, 'materials',				:Material,			:optional, collection_type: :array )
+	SwiftPersistentProperty.new( workForm, 'services',				:Service,			:optional, collection_type: :array )
+	SwiftPersistentProperty.new( workForm, 'crew', 					:UserSummary,		:optional, collection_type: :array  )
+	SwiftPersistentProperty.new( workForm, 'formId',				:String,			:optional )
+	SwiftPersistentProperty.new( workForm, 'formType',				:WorkFormType,		:optional )
+	SwiftPersistentProperty.new( workForm, 'workFlowId',			:String,			:optional )
+	SwiftPersistentProperty.new( workForm, 'previousFormId',		:String,			:optional )
+	SwiftPersistentProperty.new( workForm, 'status',				:WorkStatusType,	:optional )
+	SwiftPersistentProperty.new( workForm, 'startDate',				:NSDate,			:optional )
+	SwiftPersistentProperty.new( workForm, 'endDate',				:NSDate,			:optional )
+	SwiftPersistentProperty.new( workForm, 'marqueeImageURL',		:String,			:optional )
+	SwiftPersistentProperty.new( workForm, 'totalValue',			:Int,				:optional )
+
+	work_form_type = SwiftEnum.new(defs, 'WorkFormType', ['String']  )
+	SwiftEnumCase.new( work_form_type, 'Request', 		'REQUEST' )
+	SwiftEnumCase.new( work_form_type, 'Inspection', 	'INSPECTION' )
+	SwiftEnumCase.new( work_form_type, 'Estimate', 		'ESTIMATE' )
+	SwiftEnumCase.new( work_form_type, 'WorkOrder', 	'WORKORDER' )
+	SwiftEnumCase.new( work_form_type, 'Invoice', 		'INVOICE' )
+
+	work_status_type = SwiftEnum.new(defs, 'WorkStatusType', ['String']  )
+	SwiftEnumCase.new( work_status_type, 'Draft', 			'DRAFT' )
+	# SwiftEnumCase.new( work_status_type, 'Unscheduled', 	'UNSCHEDULED' )
+	SwiftEnumCase.new( work_status_type, 'Assigned', 		'ASSIGNED' )
+	SwiftEnumCase.new( work_status_type, 'Scheduled', 		'SCHEDULED' )
+	SwiftEnumCase.new( work_status_type, 'Dispatched', 		'DISPATCHED' )
+	SwiftEnumCase.new( work_status_type, 'InProgress', 		'IN-PROGRESS' )
+	SwiftEnumCase.new( work_status_type, 'Completed', 		'COMPLETED' )
+	SwiftEnumCase.new( work_status_type, 'Rejected', 		'REJECTED' )
+	SwiftEnumCase.new( work_status_type, 'Submitted', 		'SUBMITTED' )
+
+	return defs
+end

data/lib/swift_generator/code_generation/SwiftFileTemplate.dna

@@ -20,10 +20,14 @@ module_function :write_files_for_definition_set
 
 # Templated Output Methods
 def write_element( element )
-  if( element.kind_of? SwiftClass )
-    SwiftGenerator::write_class( element )
+  if( element.kind_of? SwiftCategory )
+    SwiftGenerator::write_category( element )
+  elsif( element.kind_of? SwiftProtocol )
+    SwiftGenerator::write_protocol( element )
   elsif( element.kind_of? SwiftEnum )
     SwiftGenerator::write_enum( element )
+  elsif( element.kind_of? SwiftClass )      # Must be last as it is the superclass
+    SwiftGenerator::write_class( element )
   end
 end
 
@@ -32,10 +36,12 @@ module_function :write_element
 def writeGeneratedFile( f )
     return if ( f.is_user_file && File.exist?( f.file_path ))
 
+    Pathname.new( f.file_path ).parent().mkpath()
+
 ./!output( f.file_path )
 
 .//
-.//  @{f.file_name}
+.//  @{ Pathname.new( f.file_name ).basename }
 .//  @{f.company_name}
 if $definition_file
 .//
@@ -91,7 +97,6 @@ def write_enum( e )
   SwiftGenerator::write_methods( e.methods )
 . }
 end
-
 module_function :write_enum
 
 
@@ -104,21 +109,58 @@ def write_class( c )
     end
 .    /+  {
 
-  SwiftGenerator::write_property_declarations( c.transient_properties, "Transient" )
-  SwiftGenerator::write_property_declarations( c.persistent_properties, "Persistent" )
+  SwiftGenerator::write_class_body( c )
+.}
+end
+module_function :write_class
+
 
-  SwiftGenerator::write_methods( c.initializers )
-  SwiftGenerator::write_methods( c.methods )
+def write_category( c )
+.
+.
+.&{c.access_control_modifier}extension @{c.categorized_class_name} /*@{c.type_name || ' '}*/ {
+  SwiftGenerator::write_class_body( c )
 .}
+end
+module_function :write_category
+
+def write_class_body( c )
+    c.top_inner_comment_block().each do |line|
+.    &{line}
+    end
+
+  # SwiftGenerator::write_property_declarations( c.transient_properties, "Transient" )
+  # SwiftGenerator::write_property_declarations( c.persistent_properties, "Persistent" )
+  SwiftGenerator::write_property_declarations( c.transient_properties )
+  SwiftGenerator::write_property_declarations( c.persistent_properties )
 
+  SwiftGenerator::write_methods( c.initializers )
+  SwiftGenerator::write_methods( c.methods )
 end
+module_function :write_class_body
 
-module_function :write_class
+def write_protocol( p )
+.
+.
+.&{p.access_control_modifier}protocol @{p.type_name}
+    if p.inheritance_list.count > 0
+.    /+ : @{p.inheritance_list.join( ", " )}
+    end
+.    /+  {
+  # SwiftGenerator::write_property_declarations( c.transient_properties, "Transient" )
+  # SwiftGenerator::write_property_declarations( c.persistent_properties, "Persistent" )
+  SwiftGenerator::write_property_declarations( p.transient_properties )
+  SwiftGenerator::write_property_declarations( p.persistent_properties )
 
+  SwiftGenerator::write_methods( p.initializers, for_protocol=true )
+  SwiftGenerator::write_methods( p.methods, for_protocol=true )
+.}
+end
+module_function :write_protocol
 
-def write_property_declarations( properties, property_type_label )
+def write_property_declarations( properties, property_type_label=nil )
   properties.each_with_index do |prop, i|
-    if i == 0
+    if i == 0 && ! property_type_label.nil?
 .
 .    // MARK: @{property_type_label} Properties
     end
@@ -126,13 +168,12 @@ def write_property_declarations( properties, property_type_label )
 .    &{declLine}
     end
   end
-
 end
 
 module_function :write_property_declarations
 
 
-def write_methods( methods )
+def write_methods( methods, for_protocol=false )
     methods.each_with_index do |m, i|
         overrideString = m.override ? 'override ' : ''
 .
@@ -140,15 +181,18 @@ def write_methods( methods )
 .   &{m.comment}
     end
     args = m.argStr.nil? || m.argStr.empty? ? m.argStr : ' ' + m.argStr + ' '
-.   &{overrideString}&{m.access_control_modifier}&{m.func_fragment} @{m.name}(&{args})
+    access_control_modifier_str = m.access_control_modifiers.length > 0 ? m.access_control_modifiers.join( ", " ) + " " : ""
+.    &{overrideString}&{access_control_modifier_str}&{m.func_fragment + " " unless m.func_fragment.length == 0}@{m.name}(&{args})
     if ! (m.returns.nil? || m.returns.length == 0 )
 .     /+ -> @{m.returns}
     end
+    unless for_protocol
 .   /+ {
-    m.bodyLines.each do |line|
-.        &{line}
-    end
+        m.bodyLines.each do |line|
+.           &{line}
+        end
 .    }
+    end
   end
 end
 

data/lib/swift_generator/code_generation/swift_class_generation.rb

@@ -22,7 +22,7 @@ class SwiftFile
 		@file_name = name
 		@file_path = File.join(root_path, @file_name)
 
-    puts( "--- SwiftFile name = #{name} root_path = #{root_path} file_path = #{@file_path}" )
+    #puts( "--- SwiftFile name = #{name} root_path = #{root_path} file_path = #{@file_path}" )
 
     @is_user_file = is_user_file
 		@elements = []
@@ -43,7 +43,7 @@ class SwiftFile
 		end
 	end
 
-	def prepare_for_generation()
+	def prepare_for_generation
 		@elements.each do |element|
 			element.prepare_for_generation
 		end
@@ -62,12 +62,14 @@ class SwiftNonPrimitive
 	attr_accessor :definition_set
 	attr_accessor :type_name
 	attr_accessor :specified_type_name
-	attr_accessor :access_control_modifier
+	attr_accessor :access_control_modifiers
 	attr_accessor :inheritance_list		# Raw parent list
 
 	attr_accessor :file_name
 	attr_accessor :source_file
 
+	attr_accessor :top_inner_comment_block		# Useful for converted Objective-C classes
+
 	attr_accessor :properties
 	attr_accessor :initializers
 	attr_accessor :methods
@@ -85,7 +87,7 @@ class SwiftNonPrimitive
 		@type_name = type_name.nil? ? specified_type_name : type_name
 		@file_name = file_name
 		#@access_control_modifier = 'public '
-		@access_control_modifier = ''
+		@access_control_modifiers = []
 
 		@class_characteristics = [* characteristics]
 		@is_user_editable = is_user_editable
@@ -96,6 +98,8 @@ class SwiftNonPrimitive
 		@properties = []
 		@post_super_initializations = {}
 
+    @top_inner_comment_block = []
+
 		# This class will now be added to the definition set and its source file
 		# The source file will be created if needed.
 		@definition_set.add_element(self)
@@ -739,6 +743,28 @@ class SwiftClass < SwiftNonPrimitive
 	end
 end
 
+class SwiftCategory < SwiftClass
+  attr_accessor :categorized_class_name
+
+	def initialize( definition_set, specified_type_name, categorized_class_name, file_name: nil, characteristics:$default_swift_class_characteristics,
+                  is_test_element: false, is_user_editable: false )
+    super( definition_set, specified_type_name, inheritance_list=[], file_name:file_name,
+                    characteristics:characteristics, is_test_element:is_test_element, is_user_editable:is_user_editable )
+    @categorized_class_name = categorized_class_name || nil
+	end
+
+end
+
+class SwiftProtocol < SwiftClass
+	attr_accessor :categorized_class_name
+
+	def initialize( definition_set, specified_type_name, inheritance_list, file_name: nil, characteristics:$default_swift_class_characteristics )
+		super( definition_set, specified_type_name, inheritance_list=[], file_name:file_name,
+					 characteristics:characteristics, is_test_element:false, is_user_editable:false )
+		@categorized_class_name = categorized_class_name || nil
+	end
+
+end
 
 class SwiftUnitTestClass < SwiftClass
 	attr_accessor :tested_class
@@ -754,7 +780,6 @@ class SwiftUnitTestClass < SwiftClass
 		@source_file.add_import('XCTest')
 	end
 
-
 	def prepare_for_generation()
 		super()
 
@@ -867,6 +892,9 @@ class SwiftProperty
 	attr_accessor :getter_body
 	attr_accessor :setter_body
 	attr_accessor :rest_omit
+	attr_accessor :access_control_modifiers
+
+	attr_accessor :protocol_get_set_spec	# for declarations in protocols
 
 
 	def initialize(swift_class, property_name, property_type_symbol, mutability= :let, initialization_value:nil, collection_type: nil, required: true, rest_omit:nil )
@@ -881,7 +909,7 @@ class SwiftProperty
 		@required = required
 
 		#@access_control_modifier = 'public '
-		@access_control_modifier = ''
+		@access_control_modifiers = nil
 		@property_qualifiers = nil
 
 		@initialization_value = initialization_value
@@ -889,13 +917,16 @@ class SwiftProperty
 		@setter_body = nil
 		@rest_omit = rest_omit
 
+		@protocol_get_set_spec = nil
+
 		swift_class.properties << self
 	end
 
 	def declaration_lines
 
 		qualifiers = []
-		qualifiers += [*@property_qualifiers] if !@property_qualifiers.nil?
+		qualifiers += [*@access_control_modifiers] unless @access_control_modifiers.nil?
+		qualifiers += [*@property_qualifiers] unless @property_qualifiers.nil?
 		qualifiers << @mutability_type.mutability
 
 		declaration = "#{qualifiers.join(' ')} #{@property_name} : #{full_type_specifier()}"
@@ -912,9 +943,9 @@ class SwiftProperty
 			end
 		end
 
-		if (!initial_value.nil?)
-			declaration += " = #{initial_value}"
-		end
+    declaration += " = #{initial_value}" unless initial_value.nil?
+
+    declaration += " #{@protocol_get_set_spec}" unless @protocol_get_set_spec.nil?  # Must be set if part of a protocol definition
 
 		# Computed Properties
 		if !( @getter_body.nil? && @setter_body.nil? )
@@ -979,6 +1010,30 @@ class SwiftProperty
 end
 
 
+class SwiftBlockProperty < SwiftProperty
+
+	attr_accessor :declaration_string
+
+	def initialize( swift_class, property_name, declaration_string, mutability= :let, initialization_value:nil, required: false )
+
+			super(swift_class, property_name, property_type_symbol, mutability= :let, initialization_value:nil, collection_type: nil, required: required, rest_omit:true )
+			@declaration_string = declaration_string
+	end
+
+	def resolve_type()
+		@property_type = @declaration_string
+	end
+
+	def full_type_specifier
+		return @declaration_string
+	end
+
+	def property_declared_type
+		@declaration_string + @mutability_type.declaration_wrapping
+	end
+
+end
+
 class SwiftPersistentProperty < SwiftProperty
 	attr_accessor :json_key
 
@@ -1294,7 +1349,7 @@ class SwiftMethodBase
 	attr_accessor :returns
 	attr_accessor :comment
 
-	attr_accessor :access_control_modifier
+	attr_accessor :access_control_modifiers
 	attr_accessor :func_qualifiers
 
 	attr_accessor :indent
@@ -1311,7 +1366,7 @@ class SwiftMethodBase
 		@indent = 0
 		@bodyLines = []
 
-		@access_control_modifier = ''
+		@access_control_modifiers = []
 	end