evva 0.1.4.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 90dd43b0fdd3169aa137cf665a8c592693b9d686
-  data.tar.gz: 12649831ed616d714b7357c3fdff9d1cd7cf41ea
+SHA256:
+  metadata.gz: 32699d4abc90a02f944c069ac0cefc8e26fbf972d42342f86ad55652d198f0c2
+  data.tar.gz: d9e9c0e5a62a712636ebede3bf3b04a9f47c8bc36bac4f06ea4d27b48ff3703f
 SHA512:
-  metadata.gz: 9d043c714969d7d188026015fe15d0ef3a6d0be113d05593c53624e4af1a63f755800bcfab407d35b4512fd00045791ea59085cc6cc918163faae540222dbd5c
-  data.tar.gz: ec753ef63337efd78777711e1e2b62b46956a3c44ef699d50d2f9761ff54a9f82cec7124527cf774ca5c95fbae6a3a90785d2d9702bcf0396525dabfc692b2aa
+  metadata.gz: cd70916584265dc7077907d324049b93000f5805bf43bb9dda152547e36181740ba8524980606400a8bd128c556dbf09ad641d4c634d513e714b2748639a4498
+  data.tar.gz: a9a95c538e9d88011507e5a12e64afb84b91fbee6a5b70e0d48f431a05496a0384347c2f6edc97ad3a3164f80677ff05e0b700d4a2c7ea08bce69d7e59ab8145

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
 
@@ -19,9 +25,13 @@ 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/
  ```

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.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
+
 ## [0.1.4.2] - 2018-02-14
  - Replaces Swift headers
 
@@ -19,5 +35,6 @@
 ## [0.1.1] - 2017-11-07
 - Fixes mismatch between file name and class name generated.
 
-## [0.1.0] - 2017/10/26
-- Initial Release.
+## [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/evva_config.yml

@@ -3,8 +3,12 @@ type: iOS
 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.hole19golf.hole19.analytics

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

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

data/lib/evva/{mixpanel_event.rb → analytics_event.rb}

@@ -1,5 +1,5 @@
 module Evva
-  class MixpanelEvent
+  class AnalyticsEvent
     attr_reader :event_name, :properties
     def initialize(event_name, properties = {})
       @event_name = event_name

data/lib/evva/android_generator.rb

@@ -1,100 +1,112 @@
 module Evva
   class AndroidGenerator
-    KOTLIN_EVENT_HEADER =
-      "package com.hole19golf.hole19.analytics\n\n"\
-      "import com.hole19golf.hole19.analytics.Event\n"\
-      "import com.hole19golf.hole19.analytics.MixpanelAnalyticsMask\n"\
-      "import org.json.JSONObject\n\n".freeze
-
-    KOTLIN_PEOPLE_HEADER =
-      "package com.hole19golf.hole19.analytics\n"\
-      "import com.hole19golf.hole19.analytics.Event\n\n".freeze
-
-    KOTLIN_BUNDLE_HEADER =
-      "package com.hole19golf.hole19.analytics\n"\
-      "import com.hole19golf.hole19.analytics.Event\n\n".freeze
-
-    KOTIN_PEOPLE_FUNCTIONS =
-      "\nopen fun updateProperties(property: MixpanelProperties, value: Any) {\n"\
-      "\t\tmixpanelMask.updateProperties(property.key, value)"\
-      "\t\n} \n"\
-      "\nopen fun incrementCounter(property: MixpanelProperties) {\n"\
-      "\t\tmixpanelMask.incrementCounter(property.key)"\
-      "\t\n} \n".freeze
+    attr_accessor :package_name
+
+    def initialize(package_name)
+      @package_name = package_name
+    end
 
     NATIVE_TYPES = %w[Long Int String Double Float Boolean].freeze
 
     def events(bundle, file_name)
-      event_file = KOTLIN_EVENT_HEADER + "open class #{file_name}(private val mixpanelMask: MixpanelAnalyticsMask) {\n".freeze
-      bundle.each do |event|
-        event_file += "\n#{kotlin_function(event)}"
+      header_footer_wrapper do
+"""sealed class #{file_name}(event: AnalyticsEvents) {
+\tval name = event.key
+
+\topen val properties: Map<String, Any?>? = null
+
+#{bundle.map { |e| event_class(e, file_name) }.join("\n\n")}
+}"""
       end
-      event_file += KOTIN_PEOPLE_FUNCTIONS
-      event_file += "\n}"
     end
 
     def people_properties(people_bundle, file_name)
-      properties = KOTLIN_PEOPLE_HEADER + "enum class #{file_name}(val key: String) {\n"
-      properties += people_bundle.map { |prop| "\t\t#{prop.upcase}(\"#{prop}\")" }.join(",\n")
-      properties += ";\n}\n"
+      header_footer_wrapper do
+        body = "enum class #{file_name}(val key: String) {\n"
+        body << people_bundle.map { |prop| "\t#{prop.upcase}(\"#{prop}\")" }.join(",\n")
+        body << ";\n}"
+      end
     end
 
     def event_enum(bundle, file_name)
-      event_file = KOTLIN_BUNDLE_HEADER + "enum class #{file_name}(override val key: String) : Event {\n"
-      event_file += bundle.map { |event| "\t\t#{event.event_name.upcase}(\"#{event.event_name}\")"}.join(", \n")
-      event_file += "\n}\n"
+      header_footer_wrapper do
+        body = "enum class #{file_name}(val key: String) {\n"
+        body << bundle.map(&:event_name).map { |prop| "\t#{prop.upcase}(\"#{prop}\")" }.join(",\n")
+        body << ";\n}"
+      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)
-        function_body =
-          "open fun #{function_name}(#{function_arguments}) {"\
-          "#{props}"\
-          "\tmixpanelMask.trackEvent(MixpanelEvent.#{event_data.event_name.upcase}, properties)\n"
-      else
-        function_body =
-          "open fun #{function_name}() {\n"\
-          "\tmixpanelMask.trackEvent(MixpanelEvent.#{event_data.event_name.upcase})\n"
+    def special_property_enums(enums)
+      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")
       end
-      function_body += "}\n"
     end
 
-    def special_property_enum(enum)
-      enum_body = "package com.hole19golf.hole19.analytics\n\n"
-      enum_body += "enum class #{enum.enum_name}(val key: String) {\n"
-      enum_body += enum.values.map { |vals| "\t#{vals.tr(' ', '_').upcase}(\"#{vals}\")"}.join(",\n")
-      enum_body += "\n}\n"
+    private
+
+    def imports_header(imports = [])
+      return unless imports.length > 0
+      imports.map { |ev| ev. gsub("packagename", @package_name) }
+             .join("\n") + "\n\n"
     end
 
-    private
+    def header_footer_wrapper(imports = [])
+<<-Kotlin
+package #{@package_name}
+
+#{imports_header(imports)}/**
+ * This file was automatically generated by evva: https://github.com/hole19/evva
+ */
+
+#{yield.gsub("\t", "    ")}
+Kotlin
+    end
+
+    def event_class(event_data, superclass_name)
+      class_name = camelize(event_data.event_name)
+      class_arguments = event_data.properties.map { |name, type| "val #{camelize(name, false)}: #{type}" }.join(', ')
+      if !class_arguments.empty?
+        props = props_map(event_data.properties)
 
-    def json_props(properties)
+"""\tdata class #{class_name}(
+\t\t#{class_arguments}
+\t) : #{superclass_name}(AnalyticsEvents.#{event_data.event_name.upcase}) {
+#{props}
+\t}"""
+
+      else
+"""\tobject #{class_name} : #{superclass_name}(AnalyticsEvents.#{event_data.event_name.upcase})"""
+      end
+    end
+
+    def props_map(properties)
       split_properties =
         properties
-        .map do |name, type|
+        .map.with_index do |data, index|
+          name, type = data
+          prop = "\t\t\t\"#{name}\" to #{camelize(name, false)}"
+
           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})"
+              prop = "#{prop}?"
             end
+            prop = "#{prop}.key"
+          end
+
+          if index < properties.size - 1
+            # add list comma to every property except the last one
+            prop = "#{prop},"
           end
+
+          prop
         end
-        .map { |line| "\t\t#{line}" }
         .join("\n")
 
-      resulting_json = "\n\tval properties = JSONObject().apply {\n" +
-                       +split_properties.to_s
-      resulting_json += "\n\t}\n"
+      "\t\toverride val properties = mapOf(\n#{split_properties}\n\t\t)"
     end
 
     def special_property?(type)
@@ -105,8 +117,15 @@ module Evva
       type.include?('?')
     end
 
-    def titleize(str)
-      str.split('_').collect(&:capitalize).join
+    # 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
   end
 end

data/lib/evva/config.rb

@@ -39,6 +39,14 @@ module Evva
       @hash[:event_enum_file_name]
     end
 
+    def special_enum_file_name
+      @hash[:special_enum_file_name]
+    end
+
+    def package_name
+      @hash[:package_name]
+    end
+
     CONFIG_STRUCT = {
       type: Hash,
       elements: {
@@ -49,7 +57,8 @@ 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 },
+        package_name: { type: String }
       }
     }.freeze
 
@@ -57,7 +66,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
 

data/lib/evva/google_sheet.rb

@@ -1,83 +1,86 @@
 require 'net/https'
-require 'xmlsimple'
+require 'csv'
 
 module Evva
   class GoogleSheet
-    def initialize(sheet_id)
-      @sheet_id = sheet_id
+    def initialize(events_url, people_properties_url, enum_classes_url)
+      @events_url = events_url
+      @people_properties_url = people_properties_url
+      @enum_classes_url = enum_classes_url
     end
 
     def events
-      raw = raw_data(@sheet_id, 0)
-      Logger.info('Downloading dictionary from Google Sheet...')
-      non_language_columns = %w[id updated category
-                                title content link]
+      Logger.info("Downloading data from Google Sheet at #{@events_url}")
+      csv = get_csv(@events_url)
+
       event_list = []
-      raw['entry'].each do |entry|
-        filtered_entry = entry.reject { |c| non_language_columns.include?(c) }
-        event_name = filtered_entry['eventname'].first
-        properties = hash_parser(filtered_entry['props'].first)
-        event_list.push(Evva::MixpanelEvent.new(event_name, properties))
+      csv.each do |row|
+        event_name = row['Event Name']
+        properties = hash_parser(row['Event Properties'])
+        event_list << Evva::AnalyticsEvent.new(event_name, properties)
       end
       event_list
     end
 
     def people_properties
-      raw = raw_data(@sheet_id, 1)
+      Logger.info("Downloading data from Google Sheet at #{@people_properties_url}")
+      csv = get_csv(@people_properties_url)
+
       people_list = []
-      Logger.info('Downloading dictionary from Google Sheet...')
-      non_language_columns = %w[id updated category title content link]
-      raw['entry'].each do |entry|
-        filtered_entry = entry.reject { |c| non_language_columns.include?(c) }
-        value = filtered_entry['value'].first
+      csv.each do |row|
+        value = row['Property Name']
         people_list << value
       end
       people_list
     end
 
     def enum_classes
-      raw = raw_data(@sheet_id, 2)
-      Logger.info('Downloading dictionary from Google Sheet...')
-      non_language_columns = %w[id updated category title content link]
+      Logger.info("Downloading data from Google Sheet at #{@enum_classes_url}")
+      csv = get_csv(@enum_classes_url)
+
       enum_list = []
-      raw['entry'].each do |entry|
-        filtered_entry = entry.reject { |c| non_language_columns.include?(c) }
-        enum_name = filtered_entry['enum'].first
-        values = filtered_entry['values'].first.split(',')
-        enum_list.push(Evva::MixpanelEnum.new(enum_name, values))
+      csv.each do |row|
+        enum_name = row['Enum Name']
+        values = row['Possible Values'].split(',')
+        enum_list << Evva::AnalyticsEnum.new(enum_name, values)
       end
       enum_list
     end
 
-    def xml_data(uri, headers = nil)
-      uri = URI.parse(uri)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      data = http.get(uri.path, headers)
-      unless data.code.to_i == 200
-        raise 'Cannot access sheet at #{uri} - HTTP #{data.code}'
-      end
+    private
+
+    def get_csv(url)
+      data = get(url)
 
       begin
-        XmlSimple.xml_in(data.body, 'KeyAttr' => 'name')
-      rescue
-        raise 'Cannot parse. Expected XML at #{uri}'
+        CSV.parse(data, headers: true)
+      rescue StandardError => e
+        raise "Cannot parse. Expected CSV at #{url}: #{e}"
       end
     end
 
-    def raw_data(sheet_id, sheet_number)
-      Logger.info('Downloading Google Sheet...')
-      sheet = xml_data("https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full")
-      url   = sheet['entry'][sheet_number]['link'][0]['href']
-      xml_data(url)
-    end
+    def get(url, max_redirects = 1)
+      raise "Too may redirects" if max_redirects == -1
 
-    private
+      uri = URI(url)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+
+      return get(response['location'], max_redirects - 1) if response.is_a? Net::HTTPRedirection
+
+      raise "Http Error #{response.body}" if response.code.to_i >= 400
+
+      response.body
+    end
 
     def hash_parser(property_array)
       h = {}
-      unless property_array.empty?
+      unless property_array.nil? || property_array.empty?
         property_array.split(',').each do |prop|
           split_prop = prop.split(':')
           prop_name = split_prop[0].to_sym