firebase-stats 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaeab070afaf270810993c11137363d74ff5700131a95e52e798cb8e62337525
-  data.tar.gz: d6fd22e36775bf9ffa6fcab773c027839fa3f67dc6eb0f5aec18ac526bf8a6d0
+  metadata.gz: 42d5a812445ad1d9db51a4f816f6f678ea749df62b8c7e510b6cbe7843a950d3
+  data.tar.gz: 826c4fe794426ac4efe62df7ad63665e077958c9705c56aa5978b4626ed2d939
 SHA512:
-  metadata.gz: ffd869cca7971501c8d066c0ca2a5b9e1ec266c2e33d078345b313678e6df4a64af29b1a337ba64017af63d5379c6991d6fc1e955fc82a5462b80b184816946e
-  data.tar.gz: be9b8f09955a53e35335e0c7c80c8e0f340ebe0649e8da6249e128ddd9edabf3f284c2ab5b8027b5b8559b799c29d04be10ebef519dcfc70bc1cd663572e3ddd
+  metadata.gz: cd7329b485308ff80da4e3be8446b936b1416de11b67db024a3a9fb478420a7bb3747e5bd658ef351504278854b21a58cb5a506e08a04f44f54f49a577906b1b
+  data.tar.gz: 761f3532a97601e44363e40cf3b31a9bd18fbda00fb54aac02d401072276fbc1228b683738cf594e899ca9b7e793e77c715fa4953588db1746d49d24b1c0e0cf

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,15 +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)
 
-    unless options.version_sorted.nil?
-      data = data.sort_by do |row|
-        row['version']
-      end.reverse
-    end
     tp data
   end
 end
@@ -77,7 +75,7 @@ command :gender do |c|
 
     platform = map_platform(options)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    wrapper = FirebaseStats::Wrapper.new(stats)
     tp wrapper.gender
   end
 end
@@ -93,7 +91,7 @@ command :gender_age do |c|
 
     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

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class FirebaseStats
-  VERSION = '1.0.3'
+module FirebaseStats
+  VERSION = '1.0.4'
 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,58 +8,34 @@ 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|
@@ -113,32 +89,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 +107,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.3
+  version: 1.0.4
 platform: ruby
 authors:
 - chedabob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: android-devices
@@ -104,6 +104,7 @@ extra_rdoc_files: []
 files:
 - bin/firebase-stats
 - lib/.DS_Store
+- lib/device_utils.rb
 - lib/firebase-stats.rb
 - lib/reader.rb
 - lib/version.rb