evva 0.3.0 → 0.4.0

data/lib/evva/swift_generator.rb

@@ -1,121 +1,132 @@
+require 'erb'
+
 module Evva
   class SwiftGenerator
-    EXTENSION_HEADER =
-      "\nimport Foundation\n\n"\
-      "extension Analytics {\n\n".freeze
+    BASE_TEMPLATE = File.expand_path("./templates/swift/base.swift", __dir__)
+    EVENTS_TEMPLATE = File.expand_path("./templates/swift/events.swift", __dir__)
+    PEOPLE_PROPERTIES_TEMPLATE = File.expand_path("./templates/swift/people_properties.swift", __dir__)
+    SPECIAL_PROPERTY_ENUMS_TEMPLATE = File.expand_path("./templates/swift/special_property_enums.swift", __dir__)
+    DESTINATIONS_TEMPLATE = File.expand_path("./templates/swift/destinations.swift", __dir__)
 
-    EXTENSION_FOOTER =
-      "\n\n}\n"
+    TAB_SIZE = "    " # \t -> 4 spaces
 
-    NATIVE_TYPES = %w[Int String Double Float Bool].freeze
+    NATIVE_TYPES = %w[Int String Double Float Bool Date].freeze
 
-    def events(bundle, file_name)
+    def events(bundle, _file_name, _enums_file_name, _destinations_file_name)
       header_footer_wrapper do
-"""\tenum Event {
-#{bundle.map { |e| event_case(e) }.join("\n")}
-
-\t\tvar data: EventData {
-\t\t\tswitch self {
-#{bundle.map { |e| event_data(e) }.join("\n\n")}
-\t\t\t}
-\t\t}
-\t}"""
+        events = bundle.map do |event|
+          properties = event.properties.map { |k, v|
+            type = native_type(v)
+
+            value_fetcher = k.to_s
+
+            if is_special_property?(type)
+              if type.end_with?('?')
+                # optional value, we need ? to access a parameter
+                value_fetcher += "?"
+              end
+              value_fetcher += ".rawValue"
+            end
+
+            {
+              name: k.to_s,
+              type: type,
+              value: value_fetcher,
+            }
+          }
+
+          {
+            case_name: camelize(event.event_name),
+            event_name: event.event_name,
+            properties: properties,
+            destinations: event.destinations.map { |p| camelize(p) },
+          }
+        end
+
+        template_from(EVENTS_TEMPLATE).result(binding)
       end
     end
 
-    def event_case(event_data)
-      function_name = camelize(event_data.event_name)
-      if event_data.properties.empty?
-        "\t\tcase #{function_name}"
-      else
-        trimmed_properties = event_data.properties.map { |k, v| k.to_s + ': ' + native_type(v) }.join(", ")
-        "\t\tcase #{function_name}(#{trimmed_properties})"
-      end
+    def event_enum
+      # empty
     end
 
-    def event_data(event_data)
-      function_name = camelize(event_data.event_name)
-      if event_data.properties.empty?
-        function_body = "\t\t\tcase .#{function_name}:\n" \
-                        "\t\t\t\treturn EventData(name: \"#{event_data.event_name}\")"
-      else
-        function_header = prepend_let(event_data.properties)
-        function_arguments = dictionary_pairs(event_data.properties)
-        function_body = "\t\t\tcase .#{function_name}(#{function_header}):\n"\
-                        "\t\t\t\treturn EventData(name: \"#{event_data.event_name}\", properties: [\n"\
-                        "\t\t\t\t\t#{function_arguments.join(",\n\t\t\t\t\t")} ]\n"\
-                        "\t\t\t\t)"
+    def people_properties(people_bundle, _file_name, _enums_file_name, _destinations_file_name)
+      header_footer_wrapper do
+        properties = people_bundle.map do |p|
+          type = native_type(p.type)
+          {
+            case_name: camelize(p.property_name),
+            property_name: p.property_name,
+            type: type,
+            is_special_property: is_special_property?(type),
+            destinations: p.destinations.map { |p| camelize(p) },
+          }
+        end
+
+        template_from(PEOPLE_PROPERTIES_TEMPLATE).result(binding)
       end
-      function_body
     end
 
-    def event_enum(enum, file_name)
+    def people_properties_enum
       # empty
     end
 
-    def people_properties(people_bundle, file_name)
+    def special_property_enums(enums_bundle)
       header_footer_wrapper do
-        props = "\tenum Property: String {\n"
-        people_bundle.each do |prop|
-          props << "\t\tcase #{camelize(prop)} = \"#{prop}\"\n"
+        enums = enums_bundle.map do |enum|
+          values = enum.values.map do |value|
+            {
+              case_name: camelize(value),
+              value: value
+            }
+          end
+
+          {
+            name: enum.enum_name,
+            values: values
+          }
         end
-        props << "\t}"
+
+        template_from(SPECIAL_PROPERTY_ENUMS_TEMPLATE).result(binding)
       end
     end
 
-    def special_property_enums(enums)
+    def destinations(destinations_bundle, _file_name)
       header_footer_wrapper do
-        enums.map do |enum|
-          body = "\tenum #{enum.enum_name}: String {\n"
-          enum.values.each do |value|
-            body << "\t\tcase #{camelize(value)} = \"#{value}\"\n"
-          end
-          body << "\t}"
-        end.join("\n\n")
+        destinations = destinations_bundle.map { |p| camelize(p) }
+
+        template_from(DESTINATIONS_TEMPLATE).result(binding)
       end
     end
 
     private
 
     def header_footer_wrapper
-"""// This file was automatically generated by evva: https://github.com/hole19/evva
-
-import Foundation
+      content = yield
+        .gsub(/^/, "\t").gsub(/^\t+$/, "") # add tabs, unless it's an empty line
+        .chop # trim trailing newlines created by sublime
 
-extension Analytics {
-
-#{yield.gsub("\t", "    ")}
-}
-"""
+      template_from(BASE_TEMPLATE).result(binding).gsub("\t", TAB_SIZE)
     end
 
-    def dictionary_pairs(props)
-      props.map do |name, type|
-        pair = "\"#{name}\": #{name}"
-        if is_raw_representable_property?(type)
-          if is_optional_property?(type)
-            pair += "?"
-          end
-          pair += ".rawValue"
-        end
-        pair += " as Any"
-      end
-    end
+    def template_from(path)
+      file = File.read(path)
 
-    def is_raw_representable_property?(type)
-      !NATIVE_TYPES.include?(native_type(type).chomp('?'))
-    end
-
-    def is_optional_property?(type)
-      type.end_with?('?')
+      # - 2nd argument (nil) changes nothing
+      # - 3rd argument activates trim mode using "-" so that you can decide to
+      # not include a line (useful on loops and if statements)
+      ERB.new(file, nil, '-')
     end
 
     def native_type(type)
-      type.gsub('Boolean','Bool').gsub('Long', 'Int')
+      type
+        .gsub('Boolean','Bool')
+        .gsub('Long', 'Int')
     end
 
-    def prepend_let(props)
-      props.map { |k, v| "let #{k}" }.join(', ')
+    def is_special_property?(type)
+      !NATIVE_TYPES.include?(type.chomp('?'))
     end
 
     def camelize(term)
@@ -125,6 +136,5 @@ extension Analytics {
       string.gsub!("/".freeze, "::".freeze)
       string
     end
-
   end
 end

data/lib/evva/templates/kotlin/base.kt

@@ -0,0 +1,7 @@
+package <%= package_name %>
+
+/**
+ * This file was automatically generated by evva: https://github.com/hole19/evva
+ */
+
+<%= content %>

data/lib/evva/templates/kotlin/destinations.kt

@@ -0,0 +1,5 @@
+enum class <%= class_name %> {
+	<%- destinations.each_with_index do |destination, index| -%>
+	<%= destination %><%= index == destinations.count - 1 ? ";" : "," %>
+	<%- end -%>
+}

data/lib/evva/templates/kotlin/event_enum.kt

@@ -0,0 +1,5 @@
+enum class <%= class_name %>(val key: String) {
+	<%- events.each_with_index do |event, index| -%>
+	<%= event[:name] %>("<%= event[:value] %>")<%= index == events.count - 1 ? ";" : "," %>
+	<%- end -%>
+}

data/lib/evva/templates/kotlin/events.kt

@@ -0,0 +1,34 @@
+sealed class <%= class_name %>(event: <%= enums_class_name %>) {
+    val name = event.key
+
+    open val properties: Map<String, Any?>? = null
+    open val destinations: Array<<%= destinations_class_name %>> = []
+
+    <%- events.each_with_index do |e, index| -%>
+    <%- if e[:is_object] -%>
+    object <%= e[:class_name] %> : <%= class_name %>(<%= enums_class_name %>.<%= e[:event_name] %>)
+    <%- else -%>
+    data class <%= e[:class_name] %><% if e[:properties].count > 0 %>(
+        <%= e[:properties].map { |p| "val #{p[:param_name]}: #{p[:type]}" }.join(", ") %>
+    )<% end %> : <%= class_name %>(<%= enums_class_name %>.<%= e[:event_name] %>) {
+        <%- if e[:properties].count > 0 -%>
+        override val properties = mapOf(
+            <%- e[:properties].each_with_index do |p, index| -%>
+            "<%= p[:name] %>" to <%= p[:value_fetcher] %><% if index < e[:properties].count - 1 %>,<% end %>
+            <%- end -%>
+        )
+        <%- end -%>
+        <%- if e[:destinations].count > 0 -%>
+        override val destinations = [
+            <%- e[:destinations].each_with_index do |d, index| -%>
+            <%= destinations_class_name %>.<%= d %><% if index < e[:destinations].count - 1 %>,<% end %>
+            <%- end -%>
+        ]
+        <%- end -%>
+    }
+    <%- end -%>
+    <%- unless index == events.count - 1 -%>
+
+    <%- end -%>
+    <%- end -%>
+}

data/lib/evva/templates/kotlin/people_properties.kt

@@ -0,0 +1,24 @@
+sealed class <%= class_name %>(property: <%= enums_class_name %>) {
+	val name = property.key
+
+	open val value: Any = ""
+	open val destinations: Array<<%= destinations_class_name %>> = []
+
+	<%- properties.each_with_index do |property, index| -%>
+	data class <%= property[:class_name] %>(
+		val value: <%= property[:type] %>
+	) : <%= class_name %>(<%= enums_class_name %>.<%= property[:property_name] %>) {
+		override val value = value<% if property[:is_special_property] %>.key<% end %>
+		<%- if property[:destinations].count > 0 -%>
+		override val destinations = [
+			<%- property[:destinations].each_with_index do |d, index| -%>
+			<%= destinations_class_name %>.<%= d %><% if index < property[:destinations].count - 1 %>,<% end %>
+			<%- end -%>
+		]
+		<%- end -%>
+	}
+	<%- unless index == properties.count - 1 -%>
+
+	<%- end -%>
+	<%- end -%>
+}

data/lib/evva/templates/kotlin/people_properties_enum.kt

@@ -0,0 +1,5 @@
+enum class <%= class_name %>(val key: String) {
+	<%- properties.each_with_index do |property, index| -%>
+	<%= property[:name] %>("<%= property[:value] %>")<%= index == properties.count - 1 ? ";" : "," %>
+	<%- end -%>
+}

data/lib/evva/templates/kotlin/special_property_enums.kt

@@ -0,0 +1,10 @@
+<%- enums.each_with_index do |enum, index| -%>
+enum class <%= enum[:class_name] %>(val key: String) {
+	<%- enum[:values].each_with_index do |v, index| -%>
+	<%= v[:name] %>("<%= v[:value] %>")<%= index == enum[:values].count - 1 ? ";" : "," %>
+	<%- end -%>
+}
+<%- unless index == enums.count - 1 -%>
+
+<%- end -%>
+<%- end -%>

data/lib/evva/templates/swift/base.swift

@@ -0,0 +1,7 @@
+// This file was automatically generated by evva: https://github.com/hole19/evva
+
+import Foundation
+
+extension Analytics {
+<%= content %>
+}

data/lib/evva/templates/swift/destinations.swift

@@ -0,0 +1,5 @@
+enum Destination {
+	<%- destinations.each do |d| -%>
+	case <%= d %>
+	<%- end -%>
+}

data/lib/evva/templates/swift/events.swift

@@ -0,0 +1,65 @@
+struct EventData {
+	let name: String
+	var properties: [String: Any]?
+	let destinations: [Destination]
+
+	init(name: String, properties: [String: Any]?, destinations: [Destination]) {
+		self.name = name
+		self.properties = properties
+		self.destinations = destinations
+	}
+
+	init(name: EventName, properties: [String: Any]?, destinations: [Destination]) {
+		self.init(name: name.rawValue, properties: properties, destinations: destinations)
+	}
+}
+
+enum EventName: String {
+	<%- events.each do |e| -%>
+	case <%= e[:case_name] %> = "<%= e[:event_name] %>"
+	<%- end -%>
+}
+
+enum Event {
+	<%- events.each do |e| -%>
+	<%- if e[:properties].count == 0 -%>
+	case <%= e[:case_name] %>
+	<%- else -%>
+	case <%= e[:case_name] %>(<%= e[:properties].map { |p| "#{p[:name]}: #{p[:type]}" }.join(", ") %>)
+	<%- end -%>
+	<%- end -%>
+
+	var data: EventData {
+		switch self {
+		<%- events.each_with_index do |e, index| -%>
+		<%- if e[:properties].count == 0 -%>
+		case .<%= e[:case_name] %>:
+		<%- else -%>
+		case let .<%= e[:case_name] %>(<%= e[:properties].map { |p| p[:name] }.join(", ") %>):
+		<%- end -%>
+			return EventData(name: .<%= e[:case_name] %>,
+				<%- if e[:properties].count == 0 -%>
+							 properties: nil,
+				<%- else -%>
+							 properties: [
+					<%- e[:properties].each do |p| -%>
+								"<%= p[:name] %>": <%= p[:value] %> as Any,
+					<%- end -%>
+							 ],
+				<%- end -%>
+				<%- if e[:destinations].count == 0 -%>
+							 destinations: [])
+				<%- else -%>
+							 destinations: [
+					<%- e[:destinations].each do |d| -%>
+								.<%= d %>,
+					<%- end -%>
+							 ])
+				<%- end -%>
+				<%- unless index == events.count - 1 -%>
+
+				<%- end -%>
+		<%- end -%>
+		}
+	}
+}

data/lib/evva/templates/swift/people_properties.swift

@@ -0,0 +1,49 @@
+struct PropertyData {
+	let name: String
+	let value: Any
+	let destinations: [Destination]
+
+	init(name: String, value: Any, destinations: [Destination]) {
+		self.name = name
+		self.value = value
+		self.destinations = destinations
+	}
+
+	init(name: PropertyName, value: Any, destinations: [Destination]) {
+		self.init(name: name.rawValue, value: value, destinations: destinations)
+	}
+}
+
+enum PropertyName: String {
+	<%- properties.each do |p| -%>
+	case <%= p[:case_name] %> = "<%= p[:property_name ] %>"
+	<%- end -%>
+}
+
+enum Property {
+	<%- properties.each do |p| -%>
+	case <%= p[:case_name] %>(<%= p[:type] %>)
+	<%- end -%>
+
+	var data: PropertyData {
+		switch self {
+		<%- properties.each_with_index do |p, index| -%>
+		case let .<%= p[:case_name] %>(value):
+			return PropertyData(name: .<%= p[:case_name] %>,
+								value: value<% if p[:is_special_property] %>.rawValue<% end %>,
+			<%- if p[:destinations].count == 0 -%>
+								destinations: [])
+			<%- else -%>
+								destinations: [
+				<%- p[:destinations].each do |d| -%>
+									.<%= d %>,
+				<%- end -%>
+								])
+			<%- end -%>
+			<%- unless index == properties.count - 1 -%>
+
+			<%- end -%>
+		<%- end -%>
+		}
+	}
+}

data/lib/evva/templates/swift/special_property_enums.swift

@@ -0,0 +1,10 @@
+<%- enums.each_with_index do |enum, index| -%>
+enum <%= enum[:name] %>: String {
+	<%- enum[:values].each do |v| -%>
+	case <%= v[:case_name] %> = "<%= v[:value ] %>"
+	<%- end -%>
+}
+<%- unless index == enums.count - 1 -%>
+
+<%- end -%>
+<%- end -%>

data/lib/evva/version.rb

@@ -1,4 +1,4 @@
 module Evva
-  VERSION = '0.3.0'.freeze
-  VERSION_UPDATED_AT = '2021-12-16'.freeze
+  VERSION = '0.4.0'.freeze
+  VERSION_UPDATED_AT = '2021-12-21'.freeze
 end

data/lib/evva.rb

@@ -7,6 +7,7 @@ require 'evva/config'
 require 'evva/file_reader'
 require 'evva/analytics_event'
 require 'evva/analytics_enum'
+require 'evva/analytics_property'
 require 'evva/object_extension'
 require 'evva/version'
 require 'evva/android_generator'
@@ -37,7 +38,7 @@ module Evva
 
   def evva_write(bundle, generator, configuration, extension)
     path = "#{configuration.out_path}/#{configuration.event_file_name}.#{extension}"
-    write_to_file(path, generator.events(bundle[:events], configuration.event_file_name))
+    write_to_file(path, generator.events(bundle[:events], configuration.event_file_name, configuration.event_enum_file_name, configuration.destinations_file_name))
 
     unless configuration.type.downcase == 'ios'
       path = "#{configuration.out_path}/#{configuration.event_enum_file_name}.#{extension}"
@@ -45,10 +46,18 @@ module Evva
     end
 
     path = "#{configuration.out_path}/#{configuration.people_file_name}.#{extension}"
-    write_to_file(path, generator.people_properties(bundle[:people], configuration.people_file_name))
+    write_to_file(path, generator.people_properties(bundle[:people], configuration.people_file_name, configuration.people_enum_file_name, configuration.destinations_file_name))
+
+    unless configuration.type.downcase == 'ios'
+      path = "#{configuration.out_path}/#{configuration.people_enum_file_name}.#{extension}"
+      write_to_file(path, generator.people_properties_enum(bundle[:people], configuration.people_enum_file_name))
+    end
 
     path = "#{configuration.out_path}/#{configuration.special_enum_file_name}.#{extension}"
     write_to_file(path, generator.special_property_enums(bundle[:enums]))
+
+    path = "#{configuration.out_path}/#{configuration.destinations_file_name}.#{extension}"
+    write_to_file(path, generator.destinations(bundle[:destinations], configuration.destinations_file_name))
   end
 
   def analytics_data(config:)
@@ -61,6 +70,7 @@ module Evva
     events_bundle[:events] = source.events
     events_bundle[:people] = source.people_properties
     events_bundle[:enums] = source.enum_classes
+    events_bundle[:destinations] = source.destinations
     events_bundle
   end
 

data/spec/evva_spec.rb

@@ -6,12 +6,10 @@ describe Evva do
 
     before do
       allow_any_instance_of(Evva::FileReader).to receive(:open_file).and_return(file)
-      allow_any_instance_of(Evva::GoogleSheet).to receive(:events).and_return(
-        [Evva::AnalyticsEvent.new('trackEvent',[])])
-
+      allow_any_instance_of(Evva::GoogleSheet).to receive(:events).and_return([])
       allow_any_instance_of(Evva::GoogleSheet).to receive(:people_properties).and_return([])
       allow_any_instance_of(Evva::GoogleSheet).to receive(:enum_classes).and_return([])
-
+      allow_any_instance_of(Evva::GoogleSheet).to receive(:destinations).and_return([])
       allow(Evva).to receive(:write_to_file)
     end
 
@@ -37,4 +35,4 @@ describe Evva do
                     .and change { Evva::Logger.summary[:error] }.by(1)
     end
   end
-end
+end

data/spec/fixtures/sample_public_events.csv

@@ -1,4 +1,4 @@
-Event Name,Event Properties
-cp_page_view,"course_id:Long,course_name:String"
-nav_feed_tap,
-cp_view_scorecard,"course_id:Long,course_name:String"
+Event Name,Event Properties,Event Destination
+cp_page_view,"course_id:Long,course_name:String","firebase,custom destination"
+nav_feed_tap,,
+cp_view_scorecard,"course_id:Long,course_name:String","custom destination"

data/spec/fixtures/sample_public_people_properties.csv

@@ -1,3 +1,4 @@
-Property Name,Comments
-rounds_with_wear,asldkaslkdlaksd
-total_friends,
+Property Name,Property Type,Property Destination
+rounds_with_wear,String,"firebase,custom destination"
+total_friends,Int,
+wearable_platform,WearableAppPlatform,firebase

data/spec/fixtures/test.yml

@@ -9,5 +9,7 @@ data_source:
 out_path: analytics
 event_file_name: AnalyticsEvent
 event_enum_file_name: AnalyticsEvents
-people_file_name: AnalyticsProperties
+people_file_name: AnalyticsProperty
+people_enum_file_name: AnalyticsProperties
+destinations_file_name: AnalyticsDestinations
 package_name: com.package.name.analytics