evva 0.1.4.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 87f47c713fe2f646dc5302d44a06e739976bfd6f
-  data.tar.gz: ed72f81ccb086f03fc21426dee5332260a38aa6b
+SHA256:
+  metadata.gz: f74dbff0766dc7623ca1ac518e7636172440511a4470398d594fefef8364fba9
+  data.tar.gz: 4793e14af612e48d0e7cf85aa313d5c6c4f92c5eb440be7a853503f39fd093e6
 SHA512:
-  metadata.gz: dda81be8b9ea3b174d0d20b8e68846681521574eee808318778ccd7265ec7ae27c185b5f615a010c8d544bf62ef5f3fd47382252476d7e46e8a80dc829c4f997
-  data.tar.gz: cede59eb52f5858775c0fce0d6ca35621dc0365ace4171bd69f1961d9ea10fcdda4b2139f1fb4bfdb93a2462dafaa3ef0e980fb130eed78fa07bd2b3eb5a8adb
+  metadata.gz: ebbee6abfa8abd7e6717f20246a1271a7d7b35e4b9a42414293ff436cff842e82ac45beb7638dc642cdb00c1408f7c81cb4b8dcfdd7d4ee6dafa04f121388b5a
+  data.tar.gz: 18c42c24f8f2b7d923c9a99b5ec58a43d258340b2523fdb4bf8f136bb0d4d9a075f3497b4c0c8a8176c4e01b07db56f116066b1139389104497db86e6ed9e30b

data/.gitignore

@@ -1,6 +1,5 @@
 *.sublime-*
-.ruby-version
 running
 coverage
 .DS_Store*
-.byebug_history
+.byebug_history

data/.rspec

@@ -1,5 +1,4 @@
 --color
 --format documentation
 --profile
---drb
 --require spec_helper

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/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -1,13 +1,14 @@
 source 'https://rubygems.org'
-ruby '2.3.3'
 
 gem 'colorize'
-gem 'rubocop'
 gem 'safe_yaml'
-gem 'xml-simple'
 
-gem 'rspec'
-gem 'rspec-its'
-gem 'simplecov', require: false, group: :test
-gem 'simplecov-rcov', require: false
-gem 'webmock', '~> 1.20'
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-its'
+  gem 'simplecov', require: false, group: :test
+  gem 'simplecov-rcov', require: false
+  gem 'webmock', '~> 1.20'
+  gem 'rubocop'
+end

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)
@@ -10,15 +10,15 @@ GEM
     diff-lcs (1.3)
     docile (1.1.5)
     hashdiff (0.3.7)
-    json (2.1.0)
+    json (2.3.0)
     parallel (1.12.0)
     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.1.0)
+    rake (12.3.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -56,13 +56,13 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    xml-simple (1.1.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   colorize
+  rake
   rspec
   rspec-its
   rubocop
@@ -70,10 +70,6 @@ DEPENDENCIES
   simplecov
   simplecov-rcov
   webmock (~> 1.20)
-  xml-simple
-
-RUBY VERSION
-   ruby 2.3.3p222
 
 BUNDLED WITH
-   1.15.4
+   2.2.26

data/README.md

@@ -1,4 +1,10 @@
 Evva
+========
+
+[![Status](https://travis-ci.org/hole19/evva.svg?branch=master)](https://travis-ci.org/hole19/evva?branch=master)
+[![Gem](https://img.shields.io/gem/v/evva.svg?style=flat)](http://rubygems.org/gems/evva "View this project in Rubygems")
+
+Evva automatically generates code for triggering events based on a Google Sheets specification. It generated code for both iOS (Swift) and Android (Kotlin).
 
 # Instalation
 
@@ -18,11 +24,15 @@ Evva
 
  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>
 
  out_path: /folder/where/analytics/classes/are
  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/Rakefile

@@ -0,0 +1,9 @@
+require "rake"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+  t.rspec_opts = "--format documentation"
+end
+
+task default: :spec

data/changelog.md

@@ -1,4 +1,20 @@
 # Change Log
+
+## [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.
+
+## [0.1.4.4] - 2019-02-04
+ - Adds support for dynamic android package name
+
 ## [0.1.4.3] - 2018-10-12
  - Fixes swift and kotlin tabs, indentation and property names
  - Merges all special enums in a single file
@@ -23,5 +39,6 @@
 ## [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/evva.gemspec

@@ -18,7 +18,4 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'safe_yaml',  '~> 1.0'
   s.add_runtime_dependency 'colorize',   '~> 0.7'
-  s.add_runtime_dependency 'xml-simple', '~> 1.1'
-
-  s.add_development_dependency 'webmock', '~> 1.20'
 end

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

@@ -1,125 +1,182 @@
 module Evva
   class AndroidGenerator
+    attr_accessor :package_name
 
-    def events(bundle, file_name)
-      header_footer_wrapper([IMPORT_EVENT, IMPORT_MASK, IMPORT_JSON]) do
-"""open class #{file_name}(private val mask: MixpanelAnalyticsMask) {
+    def initialize(package_name)
+      @package_name = package_name
+    end
 
-#{bundle.map { |e| kotlin_function(e) }.join("\n\n")}
+    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__)
 
-\topen fun updateProperties(property: MixpanelProperties, value: Any) {
-\t\tmask.updateProperties(property.key, value)
-\t}
+    TAB_SIZE = "    " # \t -> 4 spaces
 
-\topen fun incrementCounter(property: MixpanelProperties) {
-\t\tmask.incrementCounter(property.key)
-\t}
-}"""
-      end
-    end
+    NATIVE_TYPES = %w[Long Int String Double Float Boolean Date].freeze
 
-    def people_properties(people_bundle, file_name)
+    def events(bundle, file_name, enums_file_name, destinations_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
+        enums_class_name = enums_file_name
+        destinations_class_name = destinations_file_name
+
+        events = bundle.map do |event|
+          properties = event.properties.map do |name, 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) }
+
+          {
+            class_name: camelize(event.event_name),
+            event_name: constantize(event.event_name),
+            properties: properties,
+            destinations: destinations,
+            is_object: properties.count == 0 && destinations.count == 0,
+          }
+        end
+
+        template_from(EVENTS_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}"
+      header_footer_wrapper do
+        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 special_property_enums(enums)
+    def people_properties(people_bundle, file_name, enums_file_name, destinations_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
+        enums_class_name = enums_file_name
+        destinations_class_name = destinations_file_name
+
+        properties = people_bundle.map do |property|
+          {
+            class_name: camelize(property.property_name),
+            property_name: constantize(property.property_name),
+            type: property.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
 
-    IMPORT_EVENT = "import com.hole19golf.hole19.analytics.Event".freeze
-    IMPORT_MASK = "import com.hole19golf.hole19.analytics.MixpanelAnalyticsMask".freeze
-    IMPORT_JSON = "import org.json.JSONObject".freeze
-
-    NATIVE_TYPES = %w[Long Int String Double Float Boolean].freeze
+    def people_properties_enum(people_bundle, file_name)
+      header_footer_wrapper do
+        class_name = file_name
 
-    private
+        properties = people_bundle.map(&:property_name).map do |property_name|
+          {
+            name: constantize(property_name),
+            value: property_name,
+          }
+        end
 
-    def imports_header(imports = [])
-      return unless imports.length > 0
-      imports.join("\n") + "\n\n"
+        template_from(PEOPLE_PROPERTIES_ENUM_TEMPLATE).result(binding)
+      end
     end
 
-    def header_footer_wrapper(imports = [])
-<<-Kotlin
-package com.hole19golf.hole19.analytics
+    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
 
-#{imports_header(imports)}/**
- * This file was automatically generated by evva: https://github.com/hole19/evva
- */
+          {
+            class_name: enum.enum_name,
+            values: values,
+          }
+        end
 
-#{yield.gsub("\t", "    ")}
-Kotlin
+        template_from(SPECIAL_PROPERTY_ENUMS_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}"""
+    def destinations(bundle, file_name)
+      header_footer_wrapper do
+        class_name = file_name
 
-      else
-"""\topen fun #{function_name}() {
-\t\tmask.trackEvent(MixpanelEvent.#{event_data.event_name.upcase})
-\t}"""
+        destinations = bundle.map { |d| constantize(d) }
+
+        template_from(DESTINATIONS_TEMPLATE).result(binding)
       end
     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")
+    private
+
+    def header_footer_wrapper
+      package_name = @package_name
+
+      content = yield
+        .chop # trim trailing newlines created by sublime
 
-      "\t\tval properties = JSONObject().apply {\n#{split_properties}\n\t\t}"
+      template_from(BASE_TEMPLATE).result(binding).gsub("\t", TAB_SIZE)
     end
 
-    def special_property?(type)
-      !NATIVE_TYPES.include?(type.chomp('?'))
+    def template_from(path)
+      file = File.read(path)
+
+      # - 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 optional_property?(type)
-      type.include?('?')
+    # 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 titleize(str)
-      str.split('_').collect(&:capitalize).join
+    def constantize(string)
+      string.tr(' ', '_').upcase
+    end
+
+    def is_special_property?(type)
+      !NATIVE_TYPES.include?(type.chomp('?'))
     end
   end
 end

data/lib/evva/config.rb

@@ -31,18 +31,30 @@ 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
+
     CONFIG_STRUCT = {
       type: Hash,
       elements: {
@@ -53,7 +65,10 @@ module Evva
         out_path: { type: String },
         event_file_name: { type: String },
         event_enum_file_name: { type: String },
-        people_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
 
@@ -61,7 +76,9 @@ module Evva
       type: Hash,
       elements: {
         type: { type: String },
-        sheet_id: { type: String }
+        events_url: { type: String },
+        people_properties_url: { type: String },
+        enum_classes_url: { type: String },
       }
     }.freeze