firebase-stats 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31e2bde60780e358406a6768cc19f3da5a66ab5b7f09e8357fab765f18781a17
-  data.tar.gz: 275de86d9f9379678507dd401e3c86ac43ea3027076af1abed3ccf990a1b8a35
+  metadata.gz: 02e80c2483750c226661b360380901045e4c62b56241649462a97601f0ad3c39
+  data.tar.gz: 6ef53c34c50fe8b5a769fd8786a4a5a3f475e74c87283938997b41a19cbed5a0
 SHA512:
-  metadata.gz: ab0a0b830ccd9a9b485c6680848b0b25fef3d1a040de5599e06fffa8578155e973cbae8b7a32c83f9a91b6b3fc526d6601f4e36405eb0f052d74f3dc4e0325ca
-  data.tar.gz: f30040b4dd8a768492a67d56649eef5790b288a45dac7ef2b3ca4899c34251fabea32c97614aa13feecee6691a318fef9937e8d6c12af1246efd46eead1573cf
+  metadata.gz: 05e6a9d46726b08cbf16a2b594a295984cbb84e64a6943e40933a14b5d9ad521a1dacb998b0bd82b604d06aa9b3abe946fa8c1cdda577431963280558ac93b22
+  data.tar.gz: f5eba9bbb41bbb4501d493233df567326269d02a1da7fdef476ec7d0d11e0749e5ff1d7bb324f78356574db1a45fcc635988fa5c4065edcf65004876fedbcf2c

data/bin/firebase-stats

@@ -9,8 +9,8 @@ require 'table_print'
 program :name, 'firebase-stats'
 program :version, FirebaseStats::VERSION
 program :description, 'A CLI tool to get different stats out of the huge Firebase Analytics CSV'
+program :help_formatter, Commander::HelpFormatter::TerminalCompact
 
-global_option('--platform STRING', String, 'Show only stats for this OS. Either ios, android or all (default)')
 
 def map_platform(options)
   raw_platform = options.platform ||= 'all'
@@ -21,10 +21,12 @@ def map_platform(options)
 end
 
 command :devices do |c|
-  c.syntax = 'devices [options]'
+  c.syntax = 'devices <path to csv> [options]'
   c.summary = 'Prints out device stats'
-  c.description = ''
-  c.option '--friendly', 'Maps Android model numbers to friendly names'
+  c.description = 'Prints out a table with all of the devices, optionally filtered by OS'
+  c.option '--friendly', 'Prints out Android device models with their human readable name (this is slow)'
+  c.option '--limit NUMBER', Integer, 'Limits number of devices output'
+  c.option '--platform STRING', String, 'Show only stats for this OS. Either ios, android or all (default)'
 
   c.action do |args, options|
     stats = FirebaseStats::Reader.new
@@ -33,15 +35,17 @@ command :devices do |c|
     platform = map_platform(options)
 
     wrapper = FirebaseStats::Wrapper.new(stats, platform)
-    tp wrapper.devices(friendly: options.friendly)
+    tp wrapper.devices(friendly: options.friendly, limit: options.limit)
   end
 end
 
 command :os do |c|
-  c.syntax = 'os [options]'
-  c.summary = 'Prints out all of the data'
-  c.description = ''
+  c.syntax = 'os <path to csv> [options]'
+  c.summary = 'Prints out OS stats'
+  c.description = 'Prints out the number of devices per OS version, optionally filtered by OS and grouped by major version'
   c.option '--grouped', 'Groups minor OS versions together'
+  c.option '--version-sorted', 'Sorts by OS version instead of percentage'
+  c.option '--platform STRING', String, 'Show only stats for this OS. Either ios, android or all (default)'
 
   c.action do |args, options|
     stats = FirebaseStats::Reader.new
@@ -51,6 +55,46 @@ command :os do |c|
 
     wrapper = FirebaseStats::Wrapper.new(stats, platform)
 
-    options.grouped.nil? ? tp(wrapper.os_version) : tp(wrapper.os_grouped)
+    data = options.grouped.nil? ? wrapper.os_version : wrapper.os_grouped
+
+    p options
+    unless options.version_sorted.nil?
+      data = data.sort_by do |row|
+        row['version']
+      end.reverse
+    end
+    tp data
+  end
+end
+
+command :gender do |c|
+  c.syntax = 'gender'
+  c.summary = 'Prints out gender stats (if available)'
+  c.description = 'Prints out a table with number of users of each gender'
+
+  c.action do |args, options|
+    stats = FirebaseStats::Reader.new
+    stats.parse_file(args[0])
+
+    platform = map_platform(options)
+
+    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    tp wrapper.gender
+  end
+end
+
+command :gender_age do |c|
+  c.syntax = 'gender_age'
+  c.summary = 'Prints out age group stats (if available)'
+  c.description = 'Prints out a table with percentage of users of each gender grouped by age'
+
+  c.action do |args, options|
+    stats = FirebaseStats::Reader.new
+    stats.parse_file(args[0])
+
+    platform = map_platform(options)
+
+    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    tp wrapper.gender_age
   end
 end

data/lib/reader.rb

@@ -22,7 +22,7 @@ class FirebaseStats
     def parse(input)
       curr_lines = []
       input.each_with_index do |line, idx|
-        curr_lines.append(line) unless comment?(line) || line.strip.empty?
+        curr_lines.push(line) unless comment?(line) || line.strip.empty?
 
         if (idx == input.length - 1) || line.strip.empty?
           process_lines curr_lines unless curr_lines.empty?

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FirebaseStats
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/wrapper.rb

@@ -2,7 +2,8 @@
 
 class FirebaseStats
   require 'csv'
-  # require 'android/devices'
+  require 'android/devices'
+  require 'open-uri'
 
   # Transforms the parsed Firebase file into something more user friendly
   class Wrapper
@@ -57,22 +58,54 @@ class FirebaseStats
       total
     end
 
-    def devices(friendly: false)
+    def devices(friendly: false, limit: 10)
       filtered = filter_device(@stats.data[:devices], @platform)
+      filtered = filtered.take(limit || 10)
       cleaned = []
       filtered.each do |row|
         device = {
-          'model' => row['Device model'],
-          'count' => row['Users'].to_i
+          'model' => row['Device model']
         }
-        # if friendly && ((@platform == :all) || (@platform == :android))
-        #   device['friendly'] = Android::Devices.search_by_model(row['Device Model']).name
-        # end
+        if friendly && ((@platform == :all) || (@platform == :android))
+          mapped = Android::Devices.search_by_model(row['Device model'])
+          device['friendly'] = if mapped.nil?
+                                 row['Device model']
+                               else
+                                 mapped.name
+                               end
+        end
+        device['count'] = row['Users'].to_i
+
         cleaned << device
       end
       cleaned
     end
 
+    def gender
+      raw = @stats.data[:gender]
+      data = []
+      raw.each do |row|
+        data << {
+          'gender' => row['Gender'],
+          'count' => row['Users']
+        }
+      end
+      data
+    end
+
+    def gender_age
+      raw = @stats.data[:gender_age]
+      data = []
+      raw.each do |row|
+        data << {
+          'age' => row['Category'],
+          'male' => (row['Male'].to_f * 100).round(2),
+          'female' => (row['Female'].to_f * 100).round(2)
+        }
+      end
+      data
+    end
+
     private
 
     # @param [CSV::Table] os_data
@@ -103,7 +136,7 @@ class FirebaseStats
 
     # @param [CSV::Row] device_name
     def ios_device?(device_name)
-      device_name.downcase.include?('iphone') or device_name.downcase.include?('ipad')
+      device_name.downcase.include?('iphone') or device_name.downcase.include?('ipad') or device_name.downcase.include?('ipod')
     end
 
     def as_percentage(total, value)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: firebase-stats
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - chedabob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: android-devices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement