evva 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9078e38ca6bba5b85a3349fb9e1c3f9c31b8de357080ffb1ab105e6bcbbdaa1
-  data.tar.gz: 16b264637125fafdc14a991a9cb984e440b948bdc7d934776329b8aa8ef2d89f
+  metadata.gz: 9b5e24a443e11f788768884a4830e8731d4f7f0cbeb02c66e613bb293809b82a
+  data.tar.gz: 5ccb08d43adccc135c64d3ae9bb06c19cb811c0a8a1a5b647cafdab2370fdaa0
 SHA512:
-  metadata.gz: 6efc1abd4ea8d72f7ac2edeccbf111deac25922fa0b1464d754d21e7bfef921efffddd228bb6d6913f3b64a4acfcd8763082f0b36b16e85e28b930d933df879c
-  data.tar.gz: 77a4ad5df7074b646def8c880654b551fcde2e10523e3dec622d202fba48ac7bdda6d1a882abcd5c54bc2e6175b2bb68a52c30ab77d1c522f29362bc9a297db3
+  metadata.gz: ee89843173f05753970aacb497add3a0408bbebd2ba6c4d757c41c3f3b0ba90fa00e28dcf455069e1b81e348ef8ceac1c91c01a4369a7fb903b4497ba8bc9b5c
+  data.tar.gz: eb3281e5f3ee84bec798731117504c2e6fdddfc035e772ed13b025a6f506111b4e81875f4126c74fe4582e0bc5fe2aa4b32be29c6f39edb72cbb291192ad424b

data/.rubocop_todo.yml

@@ -57,8 +57,8 @@ Layout/EmptyLinesAroundBlockBody:
 Layout/EmptyLinesAroundClassBody:
   Exclude:
     - 'lib/evva/android_generator.rb'
-    - 'lib/evva/mixpanel_enum.rb'
-    - 'lib/evva/mixpanel_event.rb'
+    - 'lib/evva/analytics_enum.rb'
+    - 'lib/evva/analytics_event.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -163,8 +163,8 @@ Layout/TrailingBlankLines:
     - 'lib/evva/enum_generator.rb'
     - 'lib/evva/event_generator.rb'
     - 'lib/evva/google_sheet.rb'
-    - 'lib/evva/mixpanel_enum.rb'
-    - 'lib/evva/mixpanel_event.rb'
+    - 'lib/evva/analytics_enum.rb'
+    - 'lib/evva/analytics_event.rb'
     - 'spec/lib/evva/enum_generator_spec.rb'
     - 'spec/lib/evva/event_generator_spec.rb'
     - 'spec/lib/evva/google_sheet_spec.rb'
@@ -226,8 +226,8 @@ Lint/UselessAssignment:
 # Offense count: 2
 Lint/Void:
   Exclude:
-    - 'lib/evva/mixpanel_enum.rb'
-    - 'lib/evva/mixpanel_event.rb'
+    - 'lib/evva/analytics_enum.rb'
+    - 'lib/evva/analytics_event.rb'
 
 # Offense count: 8
 Metrics/AbcSize:
@@ -309,8 +309,8 @@ Style/Documentation:
     - 'lib/evva/event_generator.rb'
     - 'lib/evva/google_sheet.rb'
     - 'lib/evva/logger.rb'
-    - 'lib/evva/mixpanel_enum.rb'
-    - 'lib/evva/mixpanel_event.rb'
+    - 'lib/evva/analytics_enum.rb'
+    - 'lib/evva/analytics_event.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -407,8 +407,8 @@ Style/RaiseArgs:
 # Cop supports --auto-correct.
 Style/RedundantSelf:
   Exclude:
-    - 'lib/evva/mixpanel_enum.rb'
-    - 'lib/evva/mixpanel_event.rb'
+    - 'lib/evva/analytics_enum.rb'
+    - 'lib/evva/analytics_event.rb'
     - 'lib/evva/object_extension.rb'
 
 # Offense count: 1

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
-ruby '2.7.3'
 
 gem 'colorize'
 gem 'safe_yaml'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.3.0)
     colorize (0.8.1)
     crack (0.4.3)
@@ -15,7 +15,7 @@ GEM
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
-    public_suffix (3.0.0)
+    public_suffix (4.0.6)
     rainbow (2.2.2)
       rake
     rake (12.3.3)
@@ -71,8 +71,5 @@ DEPENDENCIES
   simplecov-rcov
   webmock (~> 1.20)
 
-RUBY VERSION
-   ruby 2.7.3p183
-
 BUNDLED WITH
    2.2.26

data/README.md

@@ -24,7 +24,6 @@ Evva automatically generates code for triggering events based on a Google Sheets
 
  data_source:
   type: google_sheet
-  sheet_id: <GOOGLE-DRIVE-SHEET-ID>
   events_url: <GOOGLE-DRIVE-EVENTS-SHEET-URL>
   people_properties_url: <GOOGLE-DRIVE-PEOPLE-PROPERTIES-SHEET-URL>
   enum_classes_url: <GOOGLE-DRIVE-ENUM-CLASSES-SHEET-URL>
@@ -33,5 +32,7 @@ Evva automatically generates code for triggering events based on a Google Sheets
  event_file_name: /file/with/tracking/functions
  event_enum_file_name: /file/with/event/names
  people_file_name: /file/with/people/properties
- special_enum_file_name: //file/with/special/enum/properties/
+ people_file_name: /file/with/people/property/names
+ destinations_file_name: /file/with/destinations
+ special_enum_file_name: /file/with/special/enum/properties/
  ```

data/changelog.md

@@ -1,6 +1,22 @@
 # Change Log
 
-## [0.2.0] - 2021/08/30
+## Unreleased
+
+
+## [0.4.2] - 2022-01-05
+- Fix kotlin generation changes in 0.4.0
+
+## [0.4.1] - 2021-12-23
+- Changes swift implementation so that destinations belong to EventType/PropertyType instead of Event/Property
+
+## [0.4.0] - 2021-12-21
+- Adds type to people properties
+- Adds a list of destinations to events and people properties
+
+## [0.3.0] - 2021-12-16
+- Revamp Android generator to generate events as classes instead of methods.
+
+## [0.2.0] - 2021-08-30
 - Google Spreadsheet option stopped working due to a change in the API. This version fixes that.
 
 Note: You'll need a new setup. View README.
@@ -32,6 +48,6 @@ Note: You'll need a new setup. View README.
 ## [0.1.1] - 2017-11-07
 - Fixes mismatch between file name and class name generated.
 
-## [0.1.0] - 2017/10/26
+## [0.1.0] - 2017-10-26
 - Initial Release.
 

data/lib/evva/{mixpanel_enum.rb → analytics_enum.rb}

@@ -1,6 +1,7 @@
 module Evva
-  class MixpanelEnum
+  class AnalyticsEnum
     attr_reader :enum_name, :values
+
     def initialize(enum_name, values)
       @enum_name = enum_name
       @values = values

data/lib/evva/analytics_event.rb

@@ -0,0 +1,17 @@
+module Evva
+  class AnalyticsEvent
+    attr_reader :event_name, :properties, :destinations
+
+    def initialize(event_name, properties, destinations)
+      @event_name = event_name
+      @properties = properties
+      @destinations = destinations
+    end
+
+    def ==(other)
+      event_name == other.event_name &&
+      properties == other.properties &&
+      destinations == other.destinations
+    end
+  end
+end

data/lib/evva/analytics_property.rb

@@ -0,0 +1,17 @@
+module Evva
+  class AnalyticsProperty
+    attr_reader :property_name, :type, :destinations
+
+    def initialize(property_name, type, destinations)
+      @property_name = property_name
+      @type = type
+      @destinations = destinations
+    end
+
+    def ==(other)
+      property_name == other.property_name &&
+      type == other.type &&
+      destinations == other.destinations
+    end
+  end
+end

data/lib/evva/android_generator.rb

@@ -6,126 +6,184 @@ module Evva
       @package_name = package_name
     end
 
-    IMPORT_EVENT = "import packagename.Event".freeze
-    IMPORT_MASK = "import packagename.MixpanelAnalyticsMask".freeze
-    IMPORT_JSON = "import org.json.JSONObject".freeze
+    BASE_TEMPLATE = File.expand_path("./templates/kotlin/base.kt", __dir__)
+    EVENTS_TEMPLATE = File.expand_path("./templates/kotlin/events.kt", __dir__)
+    EVENT_ENUM_TEMPLATE = File.expand_path("./templates/kotlin/event_enum.kt", __dir__)
+    PEOPLE_PROPERTIES_TEMPLATE = File.expand_path("./templates/kotlin/people_properties.kt", __dir__)
+    PEOPLE_PROPERTIES_ENUM_TEMPLATE = File.expand_path("./templates/kotlin/people_properties_enum.kt", __dir__)
+    SPECIAL_PROPERTY_ENUMS_TEMPLATE = File.expand_path("./templates/kotlin/special_property_enums.kt", __dir__)
+    DESTINATIONS_TEMPLATE = File.expand_path("./templates/kotlin/destinations.kt", __dir__)
 
-    NATIVE_TYPES = %w[Long Int String Double Float Boolean].freeze
+    TAB_SIZE = "    " # \t -> 4 spaces
 
-    def events(bundle, file_name)
-      header_footer_wrapper([IMPORT_EVENT, IMPORT_MASK, IMPORT_JSON]) do
-"""open class #{file_name}(private val mask: MixpanelAnalyticsMask) {
+    NATIVE_TYPES = %w[Long Int String Double Float Boolean Date].freeze
 
-#{bundle.map { |e| kotlin_function(e) }.join("\n\n")}
+    def events(bundle, file_name, enums_file_name, destinations_file_name)
+      header_footer_wrapper do
+        class_name = file_name
+        enums_class_name = enums_file_name
+        destinations_class_name = destinations_file_name
+
+        events = bundle.map do |event|
+          properties = event.properties.map do |name, type|
+            type = native_type(type)
+
+            param_name = camelize(name.to_s, false)
+            value_fetcher = param_name
+
+            if is_special_property?(type)
+              if type.end_with?('?')
+                # optional value, we need ? to access a parameter
+                value_fetcher += "?"
+              end
+              value_fetcher += ".key"
+            end
+
+            {
+              param_name: param_name,
+              value_fetcher: value_fetcher,
+              type: type,
+              name: name.to_s,
+            }
+          end
+
+          destinations = event.destinations.map { |p| constantize(p) }
 
-\topen fun updateProperties(property: MixpanelProperties, value: Any) {
-\t\tmask.updateProperties(property.key, value)
-\t}
+          {
+            class_name: camelize(event.event_name),
+            event_name: constantize(event.event_name),
+            properties: properties,
+            destinations: destinations
+          }
+        end
 
-\topen fun incrementCounter(property: MixpanelProperties) {
-\t\tmask.incrementCounter(property.key)
-\t}
-}"""
+        template_from(EVENTS_TEMPLATE).result(binding)
       end
     end
 
-    def people_properties(people_bundle, file_name)
+    def event_enum(bundle, file_name)
       header_footer_wrapper do
-        body = "enum class MixpanelProperties(val key: String) {\n"
-        body << people_bundle.map { |prop| "\t#{prop.upcase}(\"#{prop}\")" }.join(",\n")
-        body << ";\n}"
+        class_name = file_name
+
+        events = bundle.map(&:event_name).map do |event_name|
+          {
+            name: constantize(event_name),
+            value: event_name,
+          }
+        end
+
+        template_from(EVENT_ENUM_TEMPLATE).result(binding)
       end
     end
 
-    def event_enum(bundle, file_name)
-      header_footer_wrapper([IMPORT_EVENT]) do
-        body = "enum class #{file_name}(override val key: String) : Event {\n"
-        body << bundle.map(&:event_name).map { |prop| "\t#{prop.upcase}(\"#{prop}\")" }.join(",\n")
-        body << ";\n}"
+    def people_properties(people_bundle, file_name, enums_file_name, destinations_file_name)
+      header_footer_wrapper do
+        class_name = file_name
+        enums_class_name = enums_file_name
+        destinations_class_name = destinations_file_name
+
+        properties = people_bundle.map do |property|
+          type = native_type(property.type)
+          {
+            class_name: camelize(property.property_name),
+            property_name: constantize(property.property_name),
+            type: type,
+            is_special_property: is_special_property?(property.type),
+            destinations: property.destinations.map { |p| constantize(p) },
+          }
+        end
+
+        template_from(PEOPLE_PROPERTIES_TEMPLATE).result(binding)
       end
     end
 
-    def special_property_enums(enums)
+    def people_properties_enum(people_bundle, file_name)
       header_footer_wrapper do
-        enums.map do |enum|
-          body = "enum class #{enum.enum_name}(val key: String) {\n"
-          body << enum.values.map { |vals| "\t#{vals.tr(' ', '_').upcase}(\"#{vals}\")"}.join(",\n")
-          body << ";\n}"
-        end.join("\n\n")
+        class_name = file_name
+
+        properties = people_bundle.map(&:property_name).map do |property_name|
+          {
+            name: constantize(property_name),
+            value: property_name,
+          }
+        end
+
+        template_from(PEOPLE_PROPERTIES_ENUM_TEMPLATE).result(binding)
       end
     end
 
-    private
+    def special_property_enums(enums_bundle)
+      header_footer_wrapper do
+        enums = enums_bundle.map do |enum|
+          values = enum.values.map do |value|
+            {
+              name: constantize(value),
+              value: value,
+            }
+          end
 
-    def imports_header(imports = [])
-      return unless imports.length > 0
-      imports.map { |ev| ev. gsub("packagename", @package_name) }
-             .join("\n") + "\n\n"
+          {
+            class_name: enum.enum_name,
+            values: values,
+          }
+        end
+
+        template_from(SPECIAL_PROPERTY_ENUMS_TEMPLATE).result(binding)
+      end
     end
 
-    def header_footer_wrapper(imports = [])
-<<-Kotlin
-package #{@package_name}
+    def destinations(bundle, file_name)
+      header_footer_wrapper do
+        class_name = file_name
 
-#{imports_header(imports)}/**
- * This file was automatically generated by evva: https://github.com/hole19/evva
- */
+        destinations = bundle.map { |d| constantize(d) }
 
-#{yield.gsub("\t", "    ")}
-Kotlin
+        template_from(DESTINATIONS_TEMPLATE).result(binding)
+      end
     end
 
-    def kotlin_function(event_data)
-      function_name = 'track' + titleize(event_data.event_name)
-      function_arguments = event_data.properties.map { |name, type| "#{name}: #{type}" }.join(', ')
-      if !function_arguments.empty?
-        props = json_props(event_data.properties)
-"""\topen fun #{function_name}(#{function_arguments}) {
-#{props}
-\t\tmask.trackEvent(MixpanelEvent.#{event_data.event_name.upcase}, properties)
-\t}"""
+    private
 
-      else
-"""\topen fun #{function_name}() {
-\t\tmask.trackEvent(MixpanelEvent.#{event_data.event_name.upcase})
-\t}"""
-      end
+    def header_footer_wrapper
+      package_name = @package_name
+
+      content = yield
+        .chop # trim trailing newlines created by sublime
+
+      template_from(BASE_TEMPLATE).result(binding).gsub("\t", TAB_SIZE)
     end
 
-    def json_props(properties)
-      split_properties =
-        properties
-        .map do |name, type|
-          if special_property?(type)
-            if optional_property?(type)
-              "#{name}?.let { put(\"#{name}\", it.key) }"
-            else
-              "put(\"#{name}\", #{name}.key)"
-            end
-          else
-            if optional_property?(type)
-              "#{name}?.let { put(\"#{name}\", it) }"
-            else
-              "put(\"#{name}\", #{name})"
-            end
-          end
-        end
-        .map { |line| "\t\t\t#{line}" }
-        .join("\n")
+    def template_from(path)
+      file = File.read(path)
 
-      "\t\tval properties = JSONObject().apply {\n#{split_properties}\n\t\t}"
+      # - 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 special_property?(type)
-      !NATIVE_TYPES.include?(type.chomp('?'))
+    # extracted from Rails' ActiveSupport
+    def camelize(string, uppercase_first_letter = true)
+      string = string.to_s
+      if uppercase_first_letter
+        string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+      else
+        string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+      end
+      string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
     end
 
-    def optional_property?(type)
-      type.include?('?')
+    def constantize(string)
+      string.tr(' ', '_').upcase
     end
 
-    def titleize(str)
-      str.split('_').collect(&:capitalize).join
+    def native_type(type)
+      type
+        .gsub('Date','String')
+    end
+
+    def is_special_property?(type)
+      !NATIVE_TYPES.include?(type.chomp('?'))
     end
   end
 end

data/lib/evva/config.rb

@@ -31,18 +31,26 @@ module Evva
       @hash[:event_file_name]
     end
 
+    def event_enum_file_name
+      @hash[:event_enum_file_name]
+    end
+
     def people_file_name
       @hash[:people_file_name]
     end
 
-    def event_enum_file_name
-      @hash[:event_enum_file_name]
+    def people_enum_file_name
+      @hash[:people_enum_file_name]
     end
 
     def special_enum_file_name
       @hash[:special_enum_file_name]
     end
 
+    def destinations_file_name
+      @hash[:destinations_file_name]
+    end
+
     def package_name
       @hash[:package_name]
     end
@@ -58,6 +66,8 @@ module Evva
         event_file_name: { type: String },
         event_enum_file_name: { type: String },
         people_file_name: { type: String },
+        people_enum_file_name: { type: String },
+        destinations_file_name: { type: String },
         package_name: { type: String }
       }
     }.freeze

data/lib/evva/google_sheet.rb

@@ -3,6 +3,17 @@ require 'csv'
 
 module Evva
   class GoogleSheet
+    EVENT_NAME = 'Event Name'
+    EVENT_PROPERTIES = 'Event Properties'
+    EVENT_DESTINATION = 'Event Destination'
+
+    PROPERTY_NAME = 'Property Name'
+    PROPERTY_TYPE = 'Property Type'
+    PROPERTY_DESTINATION = 'Property Destination'
+
+    ENUM_NAME = 'Enum Name'
+    ENUM_VALUES = 'Possible Values'
+
     def initialize(events_url, people_properties_url, enum_classes_url)
       @events_url = events_url
       @people_properties_url = people_properties_url
@@ -10,41 +21,48 @@ module Evva
     end
 
     def events
-      Logger.info("Downloading data from Google Sheet at #{@events_url}")
-      csv = get_csv(@events_url)
-
-      event_list = []
-      csv.each do |row|
-        event_name = row['Event Name']
-        properties = hash_parser(row['Event Properties'])
-        event_list << Evva::MixpanelEvent.new(event_name, properties)
+      @events_csv ||= begin
+        Logger.info("Downloading data from Google Sheet at #{@events_url}")
+        get_csv(@events_url)
+      end
+
+      @events ||= @events_csv.map do |row|
+        event_name = row[EVENT_NAME]
+        properties = hash_parser(row[EVENT_PROPERTIES])
+        destinations = row[EVENT_DESTINATION]&.split(',')
+        Evva::AnalyticsEvent.new(event_name, properties, destinations || [])
       end
-      event_list
     end
 
     def people_properties
-      Logger.info("Downloading data from Google Sheet at #{@people_properties_url}")
-      csv = get_csv(@people_properties_url)
+      @people_properties_csv ||= begin
+        Logger.info("Downloading data from Google Sheet at #{@people_properties_url}")
+        get_csv(@people_properties_url)
+      end
 
-      people_list = []
-      csv.each do |row|
-        value = row['Property Name']
-        people_list << value
+      @people_properties ||= @people_properties_csv.map do |row|
+        property_name = row[PROPERTY_NAME]
+        property_type = row[PROPERTY_TYPE]
+        destinations = row[PROPERTY_DESTINATION]&.split(',')
+        Evva::AnalyticsProperty.new(property_name, property_type, destinations || [])
       end
-      people_list
     end
 
     def enum_classes
-      Logger.info("Downloading data from Google Sheet at #{@enum_classes_url}")
-      csv = get_csv(@enum_classes_url)
-
-      enum_list = []
-      csv.each do |row|
-        enum_name = row['Enum Name']
-        values = row['Possible Values'].split(',')
-        enum_list << Evva::MixpanelEnum.new(enum_name, values)
+      @enum_classes_csv ||= begin
+        Logger.info("Downloading data from Google Sheet at #{@enum_classes_url}")
+        get_csv(@enum_classes_url)
+      end
+
+      @enum_classes ||= @enum_classes_csv.map do |row|
+        enum_name = row[ENUM_NAME]
+        values = row[ENUM_VALUES].split(',')
+        Evva::AnalyticsEnum.new(enum_name, values)
       end
-      enum_list
+    end
+
+    def destinations
+      @destinations ||= events.map(&:destinations).flatten.uniq
     end
 
     private