evva 0.1.4.2 → 0.3.0

data/lib/evva/swift_generator.rb

@@ -10,29 +10,26 @@ module Evva
     NATIVE_TYPES = %w[Int String Double Float Bool].freeze
 
     def events(bundle, file_name)
-      event_file = EXTENSION_HEADER
-      event_file += "\tenum Event {\n\n"
-      bundle.each do |event|
-        event_file += event_case(event)
+      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}"""
       end
-      event_file += "\n\t\tvar data: EventData {\n"
-      event_file += "\t\t\tswitch self {\n"
-      bundle.each do |event|
-        event_file += event_data(event)
-      end
-      event_file += "\t\t\t}\n"
-      event_file += "\t\t}\n\n"
-      event_file += "\t}"
-      event_file += EXTENSION_FOOTER
     end
 
     def event_case(event_data)
       function_name = camelize(event_data.event_name)
       if event_data.properties.empty?
-        "\t\tcase #{function_name}\n"
+        "\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})\n"
+        "\t\tcase #{function_name}(#{trimmed_properties})"
       end
     end
 
@@ -40,14 +37,14 @@ module Evva
       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}\")\n\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)\n\n"
+                        "\t\t\t\t)"
       end
       function_body
     end
@@ -57,23 +54,39 @@ module Evva
     end
 
     def people_properties(people_bundle, file_name)
-      properties = EXTENSION_HEADER
-      properties += "\tenum Property: String {\n"
-      people_bundle.each do |prop|
-        properties += "\t\tcase #{camelize(prop)} = \"#{prop}\"\n"
+      header_footer_wrapper do
+        props = "\tenum Property: String {\n"
+        people_bundle.each do |prop|
+          props << "\t\tcase #{camelize(prop)} = \"#{prop}\"\n"
+        end
+        props << "\t}"
       end
-      properties += "\t}"
-      properties += EXTENSION_FOOTER
     end
 
-    def special_property_enum(enum)
-      enum_body = EXTENSION_HEADER
-      enum_body += "\tenum #{enum.enum_name}: String {\n"
-      enum.values.map do |val|
-        enum_body += "\t\tcase #{val.tr(' ', '_')} = \"#{val}\"\n"
+    def special_property_enums(enums)
+      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")
       end
-      enum_body += "\t}"
-      enum_body += EXTENSION_FOOTER
+    end
+
+    private
+
+    def header_footer_wrapper
+"""// This file was automatically generated by evva: https://github.com/hole19/evva
+
+import Foundation
+
+extension Analytics {
+
+#{yield.gsub("\t", "    ")}
+}
+"""
     end
 
     def dictionary_pairs(props)
@@ -89,8 +102,6 @@ module Evva
       end
     end
 
-    private
-
     def is_raw_representable_property?(type)
       !NATIVE_TYPES.include?(native_type(type).chomp('?'))
     end
@@ -108,7 +119,7 @@ module Evva
     end
 
     def camelize(term)
-      string = term.to_s
+      string = term.to_s.tr(' ', '_').downcase
       string = string.sub(/^(?:#{@acronym_regex}(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
       string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
       string.gsub!("/".freeze, "::".freeze)

data/lib/evva/version.rb

@@ -1,4 +1,4 @@
 module Evva
-  VERSION = '0.1.4.2'.freeze
-  VERSION_UPDATED_AT = '2018-02-14'.freeze
+  VERSION = '0.3.0'.freeze
+  VERSION_UPDATED_AT = '2021-12-16'.freeze
 end

data/lib/evva.rb

@@ -5,9 +5,8 @@ require 'evva/logger'
 require 'evva/google_sheet'
 require 'evva/config'
 require 'evva/file_reader'
-require 'evva/data_source'
-require 'evva/mixpanel_event'
-require 'evva/mixpanel_enum'
+require 'evva/analytics_event'
+require 'evva/analytics_enum'
 require 'evva/object_extension'
 require 'evva/version'
 require 'evva/android_generator'
@@ -27,7 +26,7 @@ module Evva
     bundle = analytics_data(config: config.data_source)
     case config.type.downcase
     when 'android'
-      generator = Evva::AndroidGenerator.new
+      generator = Evva::AndroidGenerator.new(config.package_name)
       evva_write(bundle, generator, config, 'kt')
     when 'ios'
       generator = Evva::SwiftGenerator.new
@@ -44,20 +43,19 @@ module Evva
       path = "#{configuration.out_path}/#{configuration.event_enum_file_name}.#{extension}"
       write_to_file(path, generator.event_enum(bundle[:events], configuration.event_enum_file_name))
     end
+
     path = "#{configuration.out_path}/#{configuration.people_file_name}.#{extension}"
     write_to_file(path, generator.people_properties(bundle[:people], configuration.people_file_name))
 
-    bundle[:enums].each do |enum|
-      path = "#{configuration.out_path}/#{enum.enum_name}.#{extension}"
-      write_to_file(path, generator.special_property_enum(enum))
-    end
+    path = "#{configuration.out_path}/#{configuration.special_enum_file_name}.#{extension}"
+    write_to_file(path, generator.special_property_enums(bundle[:enums]))
   end
 
   def analytics_data(config:)
     source =
       case config[:type]
       when 'google_sheet'
-        Evva::GoogleSheet.new(config[:sheet_id])
+        Evva::GoogleSheet.new(config[:events_url], config[:people_properties_url], config[:enum_classes_url])
       end
     events_bundle = {}
     events_bundle[:events] = source.events

data/spec/evva_spec.rb

@@ -7,7 +7,7 @@ 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::MixpanelEvent.new('trackEvent',[])])
+        [Evva::AnalyticsEvent.new('trackEvent',[])])
 
       allow_any_instance_of(Evva::GoogleSheet).to receive(:people_properties).and_return([])
       allow_any_instance_of(Evva::GoogleSheet).to receive(:enum_classes).and_return([])

data/spec/fixtures/sample_public_enums.csv

@@ -0,0 +1,3 @@
+Enum Name,Possible Values
+PageViewSourceScreen,"course_discovery,synced_courses,nearby,deal"
+PremiumClickBuy,"notes,hi_res_maps,whatever"

data/spec/fixtures/sample_public_events.csv

@@ -0,0 +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"

data/spec/fixtures/sample_public_people_properties.csv

@@ -0,0 +1,3 @@
+Property Name,Comments
+rounds_with_wear,asldkaslkdlaksd
+total_friends,

data/spec/fixtures/test.yml

@@ -2,9 +2,12 @@ type: Android
 
 data_source:
   type: google_sheet
-  sheet_id: 1LaJd68os3g_GFlerogC64grNIlXb2iukMznOvdml7A4
+  events_url: https://path-to-csv
+  people_properties_url: https://path-to-csv
+  enum_classes_url: https://path-to-csv
 
 out_path: analytics
-event_file_name: MixpanelAnalytics
-event_enum_file_name: MixpanelEvent
-people_file_name: MixpanelProperties
+event_file_name: AnalyticsEvent
+event_enum_file_name: AnalyticsEvents
+people_file_name: AnalyticsProperties
+package_name: com.package.name.analytics

data/spec/lib/evva/android_generator_spec.rb

@@ -1,135 +1,144 @@
 describe Evva::AndroidGenerator do
-  let(:generator) { described_class.new }
+  let(:generator) { described_class.new("com.hole19golf.hole19.analytics") }
 
-  def trim_spaces(str)
-      str.gsub(/^[ \t]+/, '')
-         .gsub(/[ \t]+$/, '')
-  end
+  describe '#events' do
+    subject { generator.events(events, "AnalyticsEvent") }
+
+    let(:events) { [
+      Evva::AnalyticsEvent.new('cp_page_view'),
+      Evva::AnalyticsEvent.new('cp_page_view_a', { course_id: 'Long', course_name: 'String' }),
+      Evva::AnalyticsEvent.new('cp_page_view_b', { course_id: 'Long', course_name: 'String', from_screen: 'CourseProfileSource' }),
+      Evva::AnalyticsEvent.new('cp_page_view_c', { course_id: 'Long', course_name: 'String', from_screen: 'CourseProfileSource?' }),
+      Evva::AnalyticsEvent.new('cp_page_view_d', { course_id: 'Long?', course_name: 'String' })
+    ] }
+
+    let(:expected) {
+<<-Kotlin
+package com.hole19golf.hole19.analytics
+
+/**
+ * This file was automatically generated by evva: https://github.com/hole19/evva
+ */
+
+sealed class AnalyticsEvent(event: AnalyticsEvents) {
+    val name = event.key
+
+    open val properties: Map<String, Any?>? = null
 
-  describe '#kotlin_function' do
-    subject { trim_spaces(generator.kotlin_function(event)) }
-
-    context 'when the event has no properties' do
-      let(:event) { Evva::MixpanelEvent.new('nav_feed_tap') }
-      let(:expected) { <<-Kotlin
-        open fun trackNavFeedTap() {
-          mixpanelMask.trackEvent(MixpanelEvent.NAV_FEED_TAP)
-        }
-        Kotlin
-      }
-      it { should eq trim_spaces(expected) }
-    end
-
-    context 'event has properties' do
-      let(:event) { Evva::MixpanelEvent.new('cp_page_view', { course_id: 'Long', course_name: 'String' }) }
-      let(:expected) { <<-Kotlin
-        open fun trackCpPageView(course_id: Long, course_name: String) {
-          val properties = JSONObject().apply {
-            put("course_id", course_id)
-            put("course_name", course_name)
-          }
-          mixpanelMask.trackEvent(MixpanelEvent.CP_PAGE_VIEW, properties)
-        }
-        Kotlin
-      }
-      it { should eq trim_spaces(expected) }
-    end
-
-    context 'event has special properties' do
-      let(:event) { Evva::MixpanelEvent.new('cp_page_view', { course_id: 'Long', course_name: 'String', from_screen: 'CourseProfileSource' }) }
-      let(:expected) { <<-Kotlin
-        open fun trackCpPageView(course_id: Long, course_name: String, from_screen: CourseProfileSource) {
-          val properties = JSONObject().apply {
-            put("course_id", course_id)
-            put("course_name", course_name)
-            put("from_screen", from_screen.key)
-          }
-          mixpanelMask.trackEvent(MixpanelEvent.CP_PAGE_VIEW, properties)
-        }
-        Kotlin
-      }
-      it { should eq trim_spaces(expected) }
-    end
-
-    context 'event has optional properties' do
-      let(:event) { Evva::MixpanelEvent.new('cp_page_view', { course_id: 'Long', course_name: 'String', from_screen: 'CourseProfileSource?' }) }
-      let(:expected) { <<-Kotlin
-        open fun trackCpPageView(course_id: Long, course_name: String, from_screen: CourseProfileSource?) {
-          val properties = JSONObject().apply {
-            put("course_id", course_id)
-            put("course_name", course_name)
-            from_screen?.let { put("from_screen", it.key) }
-          }
-          mixpanelMask.trackEvent(MixpanelEvent.CP_PAGE_VIEW, properties)
-        }
-        Kotlin
-      }
-      it { should eq trim_spaces(expected) }
-    end
-
-    context 'event has optional but not special properties' do
-      let(:event) { Evva::MixpanelEvent.new('cp_page_view', { course_id: 'Long?', course_name: 'String' }) }
-      let(:expected) { <<-Kotlin
-        open fun trackCpPageView(course_id: Long?, course_name: String) {
-          val properties = JSONObject().apply {
-            course_id?.let { put("course_id", it) }
-            put("course_name", course_name)
-          }
-          mixpanelMask.trackEvent(MixpanelEvent.CP_PAGE_VIEW, properties)
-        }
-        Kotlin
-      }
-      it { should eq trim_spaces(expected) }
-    end
+    object CpPageView : AnalyticsEvent(AnalyticsEvents.CP_PAGE_VIEW)
+
+    data class CpPageViewA(
+        val courseId: Long, val courseName: String
+    ) : AnalyticsEvent(AnalyticsEvents.CP_PAGE_VIEW_A) {
+        override val properties = mapOf(
+            "course_id" to courseId,
+            "course_name" to courseName
+        )
+    }
+
+    data class CpPageViewB(
+        val courseId: Long, val courseName: String, val fromScreen: CourseProfileSource
+    ) : AnalyticsEvent(AnalyticsEvents.CP_PAGE_VIEW_B) {
+        override val properties = mapOf(
+            "course_id" to courseId,
+            "course_name" to courseName,
+            "from_screen" to fromScreen.key
+        )
+    }
+
+    data class CpPageViewC(
+        val courseId: Long, val courseName: String, val fromScreen: CourseProfileSource?
+    ) : AnalyticsEvent(AnalyticsEvents.CP_PAGE_VIEW_C) {
+        override val properties = mapOf(
+            "course_id" to courseId,
+            "course_name" to courseName,
+            "from_screen" to fromScreen?.key
+        )
+    }
+
+    data class CpPageViewD(
+        val courseId: Long?, val courseName: String
+    ) : AnalyticsEvent(AnalyticsEvents.CP_PAGE_VIEW_D) {
+        override val properties = mapOf(
+            "course_id" to courseId,
+            "course_name" to courseName
+        )
+    }
+}
+Kotlin
+    }
+
+    it { should eq expected }
   end
 
-  describe '#special_property_enum' do
-    subject { trim_spaces(generator.special_property_enum(enum)) }
-    let(:enum) { Evva::MixpanelEnum.new('CourseProfileSource', ['course_discovery','synced_courses']) }
-    let(:expected) { <<-Kotlin
-      package com.hole19golf.hole19.analytics
-
-      enum class CourseProfileSource(val key: String) {
-        COURSE_DISCOVERY("course_discovery"),
-        SYNCED_COURSES("synced_courses")
-      }
-      Kotlin
+  describe '#special_property_enums' do
+    subject { generator.special_property_enums(enums) }
+    let(:enums) { [
+      Evva::AnalyticsEnum.new('CourseProfileSource', ['course_discovery', 'synced_courses']),
+      Evva::AnalyticsEnum.new('PremiumFrom', ['Course Profile', 'Round Setup'])
+    ] }
+    let(:expected) {
+<<-Kotlin
+package com.hole19golf.hole19.analytics
+
+/**
+ * This file was automatically generated by evva: https://github.com/hole19/evva
+ */
+
+enum class CourseProfileSource(val key: String) {
+    COURSE_DISCOVERY("course_discovery"),
+    SYNCED_COURSES("synced_courses");
+}
+
+enum class PremiumFrom(val key: String) {
+    COURSE_PROFILE("Course Profile"),
+    ROUND_SETUP("Round Setup");
+}
+Kotlin
      }
-    it { should eq trim_spaces(expected) }
+    it { should eq expected }
   end
 
   describe '#event_enum' do
-    subject { trim_spaces(generator.event_enum(event_bundle, 'MixpanelEvent')) }
+    subject { generator.event_enum(event_bundle, 'AnalyticsEvents') }
     let(:event_bundle) { [
-      Evva::MixpanelEvent.new('nav_feed_tap', {}),
-      Evva::MixpanelEvent.new('nav_performance_tap', {})
+      Evva::AnalyticsEvent.new('nav_feed_tap', {}),
+      Evva::AnalyticsEvent.new('nav_performance_tap', {})
       ] }
-    let(:expected) { <<-Kotlin
-      package com.hole19golf.hole19.analytics
-      import com.hole19golf.hole19.analytics.Event
-
-      enum class MixpanelEvent(override val key: String) : Event {
-        NAV_FEED_TAP("nav_feed_tap"),
-        NAV_PERFORMANCE_TAP("nav_performance_tap")
-      }
-      Kotlin
+    let(:expected) {
+<<-Kotlin
+package com.hole19golf.hole19.analytics
+
+/**
+ * This file was automatically generated by evva: https://github.com/hole19/evva
+ */
+
+enum class AnalyticsEvents(val key: String) {
+    NAV_FEED_TAP("nav_feed_tap"),
+    NAV_PERFORMANCE_TAP("nav_performance_tap");
+}
+Kotlin
      }
-    it { should eq trim_spaces(expected) }
+    it { should eq expected }
   end
 
   describe '#people_properties' do
-    subject { trim_spaces(generator.people_properties(people_bundle, 'MixpanelProperties')) }
+    subject { generator.people_properties(people_bundle, 'AnalyticsProperties') }
     let(:people_bundle) { ['rounds_with_wear', 'friends_from_facebook'] }
-    let(:expected) { <<-Kotlin
-      package com.hole19golf.hole19.analytics
-      import com.hole19golf.hole19.analytics.Event
-
-      enum class MixpanelProperties(val key: String) {
-        ROUNDS_WITH_WEAR("rounds_with_wear"),
-        FRIENDS_FROM_FACEBOOK("friends_from_facebook");
-      }
-      Kotlin
+    let(:expected) {
+<<-Kotlin
+package com.hole19golf.hole19.analytics
+
+/**
+ * This file was automatically generated by evva: https://github.com/hole19/evva
+ */
+
+enum class AnalyticsProperties(val key: String) {
+    ROUNDS_WITH_WEAR("rounds_with_wear"),
+    FRIENDS_FROM_FACEBOOK("friends_from_facebook");
+}
+Kotlin
     }
-    it { should eq trim_spaces(expected) }
+    it { should eq expected }
   end
 end

data/spec/lib/evva/config_spec.rb

@@ -5,13 +5,16 @@ describe Evva::Config do
     {
       type: 'EvvaOS',
       data_source: {
-        type:         'google_sheet',
-        sheet_id:     'abc1234567890'
+        type: 'google_sheet',
+        events_url: 'https://events.csv',
+        people_properties_url: 'https://people_properties.csv',
+        enum_classes_url: 'https://enum_classes.csv',
       },
       out_path: 'clear/path/to/event',
       event_file_name: 'event/file/name',
       people_file_name: 'people/file/name',
-      event_enum_file_name: 'event/enum/file'
+      event_enum_file_name: 'event/enum/file',
+      package_name:         'com.package.name.analytics'
     }
   end
 
@@ -26,11 +29,12 @@ describe Evva::Config do
   its(:event_file_name) { should eq('event/file/name') }
   its(:people_file_name) { should eq('people/file/name') }
   its(:event_enum_file_name) { should eq 'event/enum/file' }
+  its(:package_name) { should eq 'com.package.name.analytics' }
 
   describe '#data_source' do
     subject(:data_source) { config.data_source }
 
-    it { should eq(type: 'google_sheet', sheet_id: 'abc1234567890') }
+    it { should eq(type: 'google_sheet', events_url: 'https://events.csv', people_properties_url: 'https://people_properties.csv', enum_classes_url: 'https://enum_classes.csv') }
 
     context 'when given an unknown type data source' do
       before { hash[:data_source] = { type: 'i_dunno' } }