firebase-stats 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02e80c2483750c226661b360380901045e4c62b56241649462a97601f0ad3c39
-  data.tar.gz: 6ef53c34c50fe8b5a769fd8786a4a5a3f475e74c87283938997b41a19cbed5a0
+  metadata.gz: fbcdeca6db0a52d5363c394beaaa7eafa626cf9cc33efd6bb50e41c1ad364d89
+  data.tar.gz: 20249bc78d26a568cf21288b144aae3999e597519a9bcc41e41f3f61890a027a
 SHA512:
-  metadata.gz: 05e6a9d46726b08cbf16a2b594a295984cbb84e64a6943e40933a14b5d9ad521a1dacb998b0bd82b604d06aa9b3abe946fa8c1cdda577431963280558ac93b22
-  data.tar.gz: f5eba9bbb41bbb4501d493233df567326269d02a1da7fdef476ec7d0d11e0749e5ff1d7bb324f78356574db1a45fcc635988fa5c4065edcf65004876fedbcf2c
+  metadata.gz: 20c75f62fdd228779f51ba1a64b5f783c07b859a280efb65be07e47b5c8aabe6b94859650bb99d85f71056d5a4b1b2336bd9af148b724c67fb208fa4e52390a6
+  data.tar.gz: 8b8baf3a8985fc72ff61a5b75d69cc6660bc53bd42e0d5271a62e98d5eef262ba86631d99ee3e10226211ecd991327626ccc15e991a0acac77ae0895432a2678

data/bin/firebase-stats

@@ -34,8 +34,8 @@ command :devices do |c|
 
     platform = map_platform(options)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
-    tp wrapper.devices(friendly: options.friendly, limit: options.limit)
+    wrapper = FirebaseStats::Wrapper.new(stats)
+    tp wrapper.devices(friendly: options.friendly, limit: options.limit, platform: platform)
   end
 end
 
@@ -53,16 +53,13 @@ command :os do |c|
 
     platform = map_platform(options)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    wrapper = FirebaseStats::Wrapper.new(stats)
 
-    data = options.grouped.nil? ? wrapper.os_version : wrapper.os_grouped
+    grouped = options.grouped || false
+    major_order = options.version_sorted || false
+
+    data = wrapper.os(platform: platform, grouped: grouped, major_order: major_order)
 
-    p options
-    unless options.version_sorted.nil?
-      data = data.sort_by do |row|
-        row['version']
-      end.reverse
-    end
     tp data
   end
 end
@@ -76,9 +73,7 @@ command :gender do |c|
     stats = FirebaseStats::Reader.new
     stats.parse_file(args[0])
 
-    platform = map_platform(options)
-
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    wrapper = FirebaseStats::Wrapper.new(stats)
     tp wrapper.gender
   end
 end
@@ -92,9 +87,7 @@ command :gender_age do |c|
     stats = FirebaseStats::Reader.new
     stats.parse_file(args[0])
 
-    platform = map_platform(options)
-
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    wrapper = FirebaseStats::Wrapper.new(stats)
     tp wrapper.gender_age
   end
 end

data/lib/device_utils.rb

@@ -0,0 +1,24 @@
+module FirebaseStats
+  # Parses the Firebase CSV file into sections
+  class DeviceUtils
+    # Is this device name an iOS device?
+    # @param [CSV::Row] device_name
+    def self.ios_device?(device_name)
+      device_name.downcase.include?('iphone') or device_name.downcase.include?('ipad') or device_name.downcase.include?('ipod')
+    end
+
+    # Filters a device list to only the requested platform
+    # @param [CSV::Table] device_data
+    # @param [Symbol] platform One of :all, :ios, :android
+    def self.filter_device(device_data, platform)
+      case platform
+      when :android
+        device_data.reject { |row| ios_device? row['Device model'] }
+      when :ios
+        device_data.select { |row| ios_device? row['Device model'] }
+      else
+        device_data
+      end
+    end
+  end
+end

data/lib/firebase-stats.rb

@@ -3,3 +3,4 @@
 require 'reader'
 require 'wrapper'
 require 'version'
+require 'device_utils'

data/lib/reader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class FirebaseStats
+module FirebaseStats
   require 'csv'
 
   # Parses the Firebase CSV file into sections
@@ -59,12 +59,14 @@ class FirebaseStats
         'Device model,Users' => :devices,
         'OS with version,Users' => :os_version,
         'Gender,Users' => :gender,
-        'Category,Female,Male' => :gender_age,
         'Platform,Users' => :platform,
         'Platform,Users,% Total,User engagement,Total revenue' => :platform_engagement
       }
+      cleaned_header = header.strip
+      section = mappings[cleaned_header]
 
-      mappings[header.strip]
+      section = :gender_age if section.nil? and cleaned_header.include? 'Category,'
+      section
     end
     # rubocop:enable Metrics/MethodLength
 

data/lib/version.rb

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

data/lib/wrapper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class FirebaseStats
+module FirebaseStats
   require 'csv'
   require 'android/devices'
   require 'open-uri'
@@ -8,65 +8,41 @@ class FirebaseStats
   # Transforms the parsed Firebase file into something more user friendly
   class Wrapper
     # @param [FirebaseStats::Reader] stats
-    # @param [Symbol] platform One of :all, :ios, :android
-    def initialize(stats, platform = :all)
+    def initialize(stats)
       super()
       @stats = stats
-      @platform = platform
     end
 
-    def os_version
-      filtered = filter_os(@stats.data[:os_version], @platform)
-
-      cleaned = []
-      filtered.each do |row|
-        cleaned << {
-          'version' => row['OS with version'],
-          'count' => row['Users'].to_i,
-          'percentage' => as_percentage(os_total, row['Users'].to_f)
-        }
-      end
-      cleaned
-    end
-
-    def os_grouped
-      raw_os = @stats.data[:os_version]
-
-      grouped = case @platform
-                when :ios
-                  ios_os_group(raw_os)
-                when :android
-                  android_os_group(raw_os)
-                else
-                  android_os_group(raw_os).merge ios_os_group(raw_os)
-                end
-      computed = []
-      grouped.each do |k, v|
-        version_name = k
-        total = v.map { |version| version['Users'].to_i }.reduce(0, :+)
-        computed << { 'version' => version_name, 'total' => total, 'percentage' => as_percentage(os_total, total.to_f) }
-      end
-      computed
-    end
-
-    def os_total
-      filtered = filter_os(@stats.data[:os_version], @platform)
-      total = 0
-      filtered.each do |row|
-        total += row['Users'].to_i
-      end
-      total
+    # Get all OS versions, grouped by Major version
+    # @param [Symbol] platform One of :all, :ios, :android
+    # @param [Boolean] grouped Group by Major OS version
+    # @param [Boolean] major_order Order by Major OS version (instead of percentage)
+    def os(platform: :all, grouped: true, major_order: true)
+      os_data = all_os
+      filtered = filter_os(os_data, platform)
+
+      data = if grouped
+               make_group_stats(filtered, platform)
+             else
+               filtered
+             end
+
+      major_order ? major_version_sort(data) : data
     end
 
-    def devices(friendly: false, limit: 10)
-      filtered = filter_device(@stats.data[:devices], @platform)
+    # Gets all devices
+    # @param [Boolean] friendly Transform the Android model numbers into their human numaes
+    # @param [Integer] limit Number of devices to turn
+    # @param [Symbol] platform One of :all, :ios, :android
+    def devices(friendly: false, limit: 10, platform: :all)
+      filtered = DeviceUtils.filter_device(@stats.data[:devices], platform)
       filtered = filtered.take(limit || 10)
       cleaned = []
       filtered.each do |row|
         device = {
           'model' => row['Device model']
         }
-        if friendly && ((@platform == :all) || (@platform == :android))
+        if friendly && ((platform == :all) || (platform == :android))
           mapped = Android::Devices.search_by_model(row['Device model'])
           device['friendly'] = if mapped.nil?
                                  row['Device model']
@@ -87,7 +63,7 @@ class FirebaseStats
       raw.each do |row|
         data << {
           'gender' => row['Gender'],
-          'count' => row['Users']
+          'count' => row['Users'].to_i
         }
       end
       data
@@ -100,7 +76,8 @@ class FirebaseStats
         data << {
           'age' => row['Category'],
           'male' => (row['Male'].to_f * 100).round(2),
-          'female' => (row['Female'].to_f * 100).round(2)
+          'female' => (row['Female'].to_f * 100).round(2),
+          'other' => (row['Other'].to_f * 100).round(2)
         }
       end
       data
@@ -113,32 +90,14 @@ class FirebaseStats
     def filter_os(os_data, platform)
       case platform
       when :android
-        os_data.select { |row| row['OS with version'].downcase.include?('android') }
+        os_data.select { |row| row['version'].downcase.include?('android') }
       when :ios
-        os_data.select { |row| row['OS with version'].downcase.include?('ios') }
+        os_data.select { |row| row['version'].downcase.include?('ios') }
       else
         os_data
       end
     end
 
-    # @param [CSV::Table] device_data
-    # @param [Symbol] platform One of :all, :ios, :android
-    def filter_device(device_data, platform)
-      case platform
-      when :android
-        device_data.reject { |row| ios_device? row['Device model'] }
-      when :ios
-        device_data.select { |row| ios_device? row['Device model'] }
-      else
-        device_data
-      end
-    end
-
-    # @param [CSV::Row] device_name
-    def ios_device?(device_name)
-      device_name.downcase.include?('iphone') or device_name.downcase.include?('ipad') or device_name.downcase.include?('ipod')
-    end
-
     def as_percentage(total, value)
       percentage = (value / total) * 100
       if percentage < 0.01
@@ -149,11 +108,59 @@ class FirebaseStats
     end
 
     def ios_os_group(os_details)
-      filter_os(os_details, :ios).group_by { |row| row['OS with version'].match('(iOS [0-9]{1,2})').captures[0] }
+      filter_os(os_details, :ios).group_by { |row| row['version'].match('(iOS [0-9]{1,2})').captures[0] }
     end
 
     def android_os_group(os_details)
-      filter_os(os_details, :android).group_by { |row| row['OS with version'].match('(Android [0-9]{1,2})').captures[0] }
+      filter_os(os_details, :android).group_by { |row| row['version'].match('(Android [0-9]{1,2})').captures[0] }
+    end
+
+    # Get all OS versions
+    def all_os
+      data = @stats.data[:os_version]
+
+      data.map do |row|
+        {
+          'version' => row['OS with version'],
+          'count' => row['Users'].to_i
+        }
+      end
+    end
+
+    def make_group_stats(os_data, platform)
+      data = make_os_groups(os_data, platform)
+
+      total_devices = os_total(os_data)
+      data.map do |k, v|
+        version_name = k
+        group_total = v.map { |version| version['count'].to_i }.reduce(0, :+)
+        { 'version' => version_name,
+          'total' => group_total,
+          'percentage' => as_percentage(total_devices.to_f, group_total) }
+      end
+    end
+
+    def make_os_groups(os_data, platform)
+      case platform
+      when :ios
+        ios_os_group(os_data)
+      when :android
+        android_os_group(os_data)
+      else
+        android_os_group(os_data).merge ios_os_group(os_data)
+      end
+    end
+
+    def os_total(os_data)
+      os_data.map { |row| row['count'] }.reduce(0, :+)
+    end
+
+    def major_version_sort(data)
+      data.sort_by do |row|
+        version = row['version']
+        number = version.match('([0-9.]+)').captures[0]
+        Gem::Version.new(number)
+      end.reverse
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-stats
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - chedabob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: android-devices
@@ -103,7 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/firebase-stats
-- lib/.DS_Store
+- lib/device_utils.rb
 - lib/firebase-stats.rb
 - lib/reader.rb
 - lib/version.rb
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Firebase CSV Stats CLI