gyro 0.4.0 → 1.0.0

data/lib/templates/decodable/entity_filename.liquid

@@ -0,0 +1 @@
+{{name}}+Decodable.swift

data/lib/templates/object-mapper/README.md

@@ -0,0 +1,40 @@
+# ObjectMapper Template Information
+
+| Name      | Description       |
+| --------- | ----------------- |
+| Folder name | templates/object-mapper |
+| Invocation example | `gyro -m <model> -t object-mapper …` |
+| Language | Swift 3 |
+
+This template generate `ObjectMapper` extension for each object of your data model.
+
+# Generated Code
+
+`ShopMapper.swift` :
+
+```swift
+/* DO NOT EDIT | Generated by gyro */
+
+import ObjectMapper
+
+extension Shop: Mappable {
+
+  // MARK: Initializers
+  convenience init?(map: Map) {
+    self.init()
+  }
+
+  // MARK: Mappable
+  func mapping(map: Map) {
+    // MARK: Attributes
+    self.attrDate <- (map["attrDate"], ISO8601DateTransform())
+    self.attrDateCustom <- (map["attrDateCustom"], CustomDateTransformer())
+    self.attrDecimal <- (map["attrDecimal"], MPDecimalTransformer())
+    self.attrDouble <- map["attrDouble"]
+    self.attrFloat <- (map["attrFloat"], MPDecimalTransformer())
+    self.attrInteger16 <- (map["attrInteger16"], MPIntegerTransformer())
+    self.attrInteger32 <- map["attrInteger32"]
+    self.attrInteger64 <- (map["attrInteger64"], MPIntegerTransformer())
+  }
+}
+```

data/lib/templates/object-mapper/entity.liquid

@@ -0,0 +1,66 @@
+/* DO NOT EDIT | Generated by gyro */
+
+import ObjectMapper
+
+extension {{ entity.name }}: Mappable {
+
+  // MARK: Initializers
+  convenience init?(map: Map) {
+    self.init()
+  }
+
+  // MARK: Mappable
+  func mapping(map: Map) {
+    {%- if entity.attributes.size > 0 %}
+    // MARK: Attributes
+    {%- endif -%}
+    {%- for attribute in entity.attributes -%}
+      {% assign attributeKey = attribute.name -%}
+      {%- if attribute.json_key_path.size > 0 -%}
+        {%- assign attributeKey = attribute.json_key_path -%}
+      {%- endif -%}
+
+      {%- case attribute.type -%}
+        {%- when "date" -%}
+          {%- assign transformer = "ISO8601DateTransform" -%}
+          {%- if attribute.transformer.size > 0 -%}
+            {%- assign transformer = attribute.transformer -%}
+          {%- endif %}
+    self.{{ attribute.name }} <- (map["{{ attributeKey }}"], {{ transformer }}())
+        {%- when "integer_16" or "integer_32" or "integer_64" or "float" or "double" or "boolean" -%}
+         {%- if attribute.optional == true and attribute.enum_type.size == 0 %}
+    self.{{ attribute.name }}.value <- map["{{ attributeKey }}"]
+          {%- else %}
+            {%- if attribute.transformer.size > 0 %}
+    self.{{ attribute.name }} <- (map["{{ attributeKey }}"], {{ attribute.transformer }}())
+            {%- else %}
+    self.{{ attribute.name }} <- map["{{ attributeKey }}"]
+            {%- endif %}
+          {%- endif -%}
+        {%- else %}
+          {%- if attribute.transformer.size > 0 %}
+    self.{{ attribute.name }} <- (map["{{ attributeKey }}"], {{ attribute.transformer }}())
+          {%- else %}
+    self.{{ attribute.name }} <- map["{{ attributeKey }}"]
+          {%- endif %}
+      {%- endcase -%}
+    {%- endfor -%}
+    {%- if entity.relationships.size > 0 %}
+
+    // MARK: Relationships
+    {%- endif -%}
+    {%- for relationship in entity.relationships -%}
+      {%- if relationship.inverse == false -%}
+        {% assign relationKey = relationship.name -%}
+        {%- if relationship.json_key_path.size > 0 -%}
+          {%- assign relationKey = relationship.json_key_path -%}
+        {%- endif -%}
+        {%- if relationship.type == "to_many" %}
+    self.{{ relationship.name }} <- (map["{{ relationKey }}"], ListTransform<{{ relationship.inverse_type }}>())
+        {%- else %}
+    self.{{ relationship.name }} <- map["{{ relationKey }}"]
+        {%- endif -%}
+      {%- endif -%}
+    {%- endfor %}
+  }
+}

data/lib/templates/object-mapper/entity_filename.liquid

@@ -0,0 +1 @@
+{{name}}Mapper.swift

data/lib/templates/swift3-variant/README.md

@@ -0,0 +1,60 @@
+# Swift3 variant Template Information
+
+| Name      | Description       |
+| --------- | ----------------- |
+| Folder name | templates/swift3-variant |
+| Invocation example | `gyro -m <model> -t swift3-variant …` |
+| Language | Swift 3 |
+
+# When to use it
+
+When you need to work with `ObjectMapper` and `Realm` together
+
+# Caracteristics
+
+In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are var properties :
+
+```
+// Attribute generation
+{%- if attribute.is_number == true or attribute.is_bool == true %}
+  var {{ attribute.name }} = RealmOptional<{{ convert_type }}>()
+{%- else %}
+  dynamic var {{ attribute.name }}: {{ convert_type }}?
+{%- endif -%}
+
+// Relationship generation
+{%- if relationship.inverse == false %}
+  {%- if relationship.type == "to_many" %}
+  var {{ relationship.name }} = List<{{ relationship.inverse_type }}>()
+  {%- else %}
+  dynamic var {{ relationship.name }}: {{ relationship.inverse_type }}?
+  {%- endif %}
+{%- endif %}
+```
+
+# Generated Code
+
+`Product.swift`
+
+```swift
+/* DO NOT EDIT | Generated by gyro */
+
+import RealmSwift
+
+final class Product: Object {
+
+  enum Attributes: String {
+    case brand = "brand"
+    case name = "name"
+    case price = "price"
+    case users = "users"
+  }
+
+  dynamic var brand: String?
+  dynamic var name: String = ""
+  var price = RealmOptional<Int32>()
+  
+  var users = List<Users>()
+}
+
+```

data/lib/templates/swift3-variant/entity.liquid

@@ -0,0 +1,12 @@
+/* DO NOT EDIT | Generated by gyro */
+
+import RealmSwift
+
+final class {{ entity.name }}: Object {
+    {%- include 'inc/attributes_enum' -%}
+    {% include 'inc/relationships_enum' -%}
+    {% include 'inc/attributes_properties' %}
+    {% include 'inc/primary_key' -%}
+    {% include 'inc/indexed_properties' -%}
+    {% include 'inc/ignored_properties' %}
+}

data/lib/templates/swift3-variant/entity_filename.liquid

@@ -0,0 +1 @@
+{{params.prefix}}{{name}}.swift

data/lib/templates/swift3-variant/enum.liquid

@@ -0,0 +1,15 @@
+{%- if attribute.enum_type.size > 0 -%}
+/* DO NOT EDIT | Generated by gyro */
+
+enum {{ params.prefix }}{{ attribute.enum_type }}: String {
+{%- for value in attribute.enum_values %}
+  {%- if attribute.enum_values.size > 0 %}
+  {% assign jsonKey = value -%}
+  {%- if attribute.json_values.size > 0 and attribute.json_values[forloop.index0] -%}
+    {%- assign jsonKey = attribute.json_values[forloop.index0] -%}
+  {%- endif -%}
+  case {{ value | uncapitalize }} = "{{ jsonKey | escape_quotes }}"
+  {%- endif %}
+{%- endfor %}
+}
+{% endif %}

data/lib/templates/swift3-variant/enum_filename.liquid

@@ -0,0 +1 @@
+{{params.prefix}}{{name}}.swift

data/lib/templates/swift3-variant/inc/_attributes_enum.liquid

@@ -0,0 +1,13 @@
+
+{% if entity.attributes.size > 0 %}
+  enum Attributes: String {
+    {%- for attribute in entity.attributes -%}
+        {%- if attribute.realm_ignored or attribute.realm_read_only.size == 0 -%}
+            {%- if attribute.comment.size > 0 %}
+    /** {{ attribute.comment }} **/
+            {%- endif %}
+    case {{ attribute.name }} = "{{ attribute.name | escape_quotes }}"
+        {%- endif %}
+    {%- endfor %}
+  }
+{% endif -%}

data/lib/templates/swift3-variant/inc/_attributes_properties.liquid

@@ -0,0 +1,32 @@
+{%- for attribute in entity.attributes -%}
+  {%- comment %} ******* DEFAULT VALUE CAPTURE ******* {% endcomment -%}
+  {%- capture default_value -%}
+    {%- include 'inc/default_value_converter' -%}
+  {%- endcapture -%}
+
+  {%- comment %} ******* CONVERT TYPE CAPTURE ******* {% endcomment -%}
+  {%- capture convert_type -%}
+    {%- include 'inc/type_converter' -%}
+  {%- endcapture -%}
+
+  {%- if attribute.realm_read_only.size == 0 -%}
+    {%- if attribute.enum_values.size > 0 -%}
+      {%- comment -%} ******* GENERATE ENUM ATTRIBUTE PROPERTY ******* {% endcomment -%}
+      {%- include 'inc/enum_attribute_property' -%}
+        {%- else -%}
+          {%- if attribute.optional == true -%}
+            {% comment -%} ******* GENERATE OPTIONAL ATTRIBUTE PROPERTY ******* {% endcomment -%}
+            {%- include 'inc/optional_attribute_property' -%}
+          {%- else -%}
+            {%- comment -%} ******* GENERATE DEFAULT ATTRIBUTE PROPERTY ******* {% endcomment %}
+  dynamic var {{ attribute.name }}: {{ convert_type }} = {{ default_value }}
+          {%- endif -%}
+    {%- endif -%}
+  {%- endif -%}
+{%- endfor -%}
+
+{%- comment %} ******* GENERATE RELATIONSHIP PROPERTIES ******* {% endcomment %}
+{%- include 'inc/relationship_properties' -%}
+
+{%- comment %} ******* GENERATE INVERSE PROPERTIES ******* {% endcomment -%}
+{%- include 'inc/inverse_properties' -%}

data/lib/templates/swift3-variant/inc/_default_value_converter.liquid

@@ -0,0 +1,14 @@
+{%- case attribute.type -%}
+{%- when 'integer_16' or 'integer_32' or 'integer_64' -%}
+0
+{%- when 'float' or 'double' or 'decimal' -%}
+0.0
+{%- when 'string' -%}
+""
+{%- when 'boolean' -%}
+false
+{%- when 'date' -%}
+Date()
+{%- when 'binary' -%}
+Data()
+{%- endcase -%}

data/lib/templates/swift3-variant/inc/_enum_attribute_property.liquid

@@ -0,0 +1,26 @@
+  {%- if attribute.optional == true %}
+
+  dynamic var {{ attribute.name }}: String?
+  {%- else %}
+
+  dynamic var {{ attribute.name }}: String = ""
+  {%- endif %}
+  {%- assign enum_type = attribute.enum_type %}
+  {%- assign enum_name = attribute.name %}
+  var {{ enum_name }}Enum: {{ enum_type }}? {
+    get {
+      {%- if attribute.optional == true %}
+      guard let {{ attribute.name }} = {{ attribute.name }},
+        let enumValue = {{ enum_type }}(rawValue: {{ attribute.name }})
+        else { return nil }
+      {%- else %}
+      guard let enumValue = {{ enum_type }}(rawValue: {{ attribute.name }}) else { return nil }
+      {%- endif %}
+      return enumValue
+    }
+    {%- if attribute.optional == true %}
+    set { {{ attribute.name }} = newValue?.rawValue ?? nil }
+    {%- else %}
+    set { {{ attribute.name }} = newValue?.rawValue ?? "" }
+    {%- endif %}
+  }

data/lib/templates/swift3-variant/inc/_ignored_properties.liquid

@@ -0,0 +1,24 @@
+{%- if entity.has_ignored == true %}
+  // Specify properties to ignore (Realm won't persist these)
+  override static func ignoredProperties() -> [String] {
+    return [
+    {%- capture enum_ignored_properties -%}
+      {%- for attribute in entity.attributes -%}
+        {%- if attribute.realm_ignored == true -%}
+            "{{ attribute.name }}",
+        {%- endif -%}
+      {%- endfor -%}
+
+      {%- for relationship in entity.relationships -%}
+        {%- if relationship.realm_ignored == true -%}
+            "{{ relationship.name }}",
+        {%- endif -%}
+      {%- endfor -%}
+    {%- endcapture -%}
+
+    {%- assign enum_ignored_properties_array = enum_ignored_properties | split: "," -%}
+    {%- for item in enum_ignored_properties_array -%}
+      {{ item }}{%- if forloop.last == false -%},{%- endif -%}
+    {%- endfor -%}]
+  }
+{% endif -%}

data/lib/templates/swift3-variant/inc/_indexed_properties.liquid

@@ -0,0 +1,19 @@
+{%- if entity.has_indexed_attributes == true %}
+	// Specify properties to index
+	override static func indexedProperties() -> [String] {
+		return [
+			{%- capture enum_indexed_properties -%}
+				{%- for attribute in entity.attributes -%}
+					{%- if attribute.is_indexed == true -%}
+						"{{attribute.name}}",
+					{%- endif %}
+				{%- endfor %}
+			{%- endcapture -%}
+
+    	{%- assign enum_indexed_properties_array = enum_indexed_properties | split: "," -%}
+			{%- assign enum_indexed_properties_array_size = enum_indexed_properties_array | size | minus: 1 -%}
+			{%- for item in enum_indexed_properties_array limit:enum_indexed_properties_array_size -%}
+				{{ item }}{%- if forloop.last == false -%},{%- endif -%}
+			{%- endfor -%}]
+	}
+{%- endif -%}

data/lib/templates/swift3-variant/inc/_inverse_properties.liquid

@@ -0,0 +1,11 @@
+{%- for relationship in entity.relationships -%}
+	{%- if relationship.inverse == true %}
+	{% assign name_size = relationship.name | size | minus: 1 %}
+		{%- if relationship.type == "to_many" %}
+  let {{ relationship.name | truncate: name_size, '' }}s = LinkingObjects(fromType: {{ relationship.inverse_type }}.self, property: "{{ relationship.inverse_name }}")
+		{%- else %}
+  let {{ relationship.name | truncate: name_size, '' }}s = LinkingObjects(fromType: {{ relationship.inverse_type }}.self, property: "{{ relationship.inverse_name }}")
+  var {{ relationship.name | truncate: name_size, '' }}: {{ relationship.inverse_type }}? { return {{ relationship.name | truncate: name_size, '' }}s.first }
+		{%- endif -%}
+	{%- endif -%}
+{%- endfor -%}

data/lib/templates/swift3-variant/inc/_optional_attribute_property.liquid

@@ -0,0 +1,5 @@
+{%- if attribute.is_number == true or attribute.is_bool == true %}
+  var {{ attribute.name }} = RealmOptional<{{ convert_type }}>()
+{%- else %}
+  dynamic var {{ attribute.name }}: {{ convert_type }}?
+{%- endif -%}

data/lib/templates/swift3-variant/inc/_primary_key.liquid

@@ -0,0 +1,5 @@
+{%- if entity.has_primary_key == true %}
+  override static func primaryKey() -> String? {
+    return "{{ entity.identity_attribute }}"
+  }
+{% endif -%}

data/lib/templates/swift3-variant/inc/_relationship_properties.liquid

@@ -0,0 +1,9 @@
+{%- for relationship in entity.relationships -%}
+{%- if relationship.inverse == false %}
+  {%- if relationship.type == "to_many" %}
+  var {{ relationship.name }} = List<{{ relationship.inverse_type }}>()
+  {%- else %}
+  dynamic var {{ relationship.name }}: {{ relationship.inverse_type }}?
+  {%- endif %}
+{%- endif %}
+{%- endfor -%}

data/lib/templates/swift3-variant/inc/_relationships_enum.liquid

@@ -0,0 +1,17 @@
+{%- if entity.relationships.size > 0 and entity.has_only_inverse == false %}
+  enum Relationships: String {
+    {%- for relationship in entity.relationships %}
+      {%- capture relationship_name -%}
+        {%- if relationship.inverse == true -%}
+				  {%- assign name_size = relationship.name | size | minus: 1 -%}
+          {{ relationship.name | truncate: name_size, '' }}
+          {%- if relationship.type == "to_many" -%}s{%- endif -%}
+        {%- else  -%}
+          {{ relationship.name }}
+        {%- endif -%}
+			{%- endcapture -%}
+      {%- assign relationship_name = relationship_name %}
+    case {{ relationship_name | uncapitalize }} = "{{ relationship_name | escape_quotes }}"
+    {%- endfor %}
+  }
+{% endif -%}

data/lib/templates/swift3-variant/inc/_type_converter.liquid

@@ -0,0 +1,20 @@
+{%- case attribute.type -%}
+{%- when 'integer_16' -%}
+Int16
+{%- when 'integer_32' -%}
+Int32
+{%- when 'integer_64' -%}
+Int64
+{%- when 'double' or 'decimal' -%}
+Double
+{%- when 'float' -%}
+Float
+{%- when 'string' -%}
+String
+{%- when 'boolean' -%}
+Bool
+{%- when 'date' -%}
+Date
+{%- when 'binary' -%}
+Data
+{%- endcase -%}

data/lib/templates/swift3/README.md

@@ -0,0 +1,60 @@
+# Swift3 Template Information
+
+| Name      | Description       |
+| --------- | ----------------- |
+| Folder name | templates/swift3 |
+| Invocation example | `gyro -m <model> -t swift3 …` |
+| Language | Swift 3 |
+
+# When to use it
+
+This template is the reference for swift 3 with Realm generation code. 
+You can use it when you need to work with `Realm`
+
+# Caracteristics
+
+In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are `let` properties (conform to the Realm documentation) :
+
+```
+// Attribute generation
+{%- if attribute.is_number == true or attribute.is_bool == true %}
+  let {{ attribute.name }} = RealmOptional<{{ convert_type }}>()
+{%- else %}
+  dynamic var {{ attribute.name }}: {{ convert_type }}?
+{%- endif -%}
+
+// Relationship generation
+{%- if relationship.inverse == false %}
+  {%- if relationship.type == "to_many" %}
+  let {{ relationship.name }} = List<{{ relationship.inverse_type }}>()
+  {%- else %}
+  dynamic var {{ relationship.name }}: {{ relationship.inverse_type }}?
+  {%- endif %}
+{%- endif %}
+```
+
+# Generated Code
+
+`Product.swift` :
+
+```swift
+/* DO NOT EDIT | Generated by gyro */
+
+import RealmSwift
+
+final class Product: Object {
+
+  enum Attributes: String {
+    case brand = "brand"
+    case name = "name"
+    case price = "price"
+    case users = "users"
+  }
+
+  dynamic var brand: String?
+  dynamic var name: String = ""
+  let price = RealmOptional<Int32>()
+  
+  let users = List<Users>()
+}
+```