xc_metrics_aggregator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61c0dba58870efc2783f660b792ac84bdf9e876107b6f42dd65c6cc004ca68ca
+  data.tar.gz: 9921f07076290282093d572302b5afdf0f9950e08dcedb2c99b3c9ce9cc7bf84
+SHA512:
+  metadata.gz: 1c69738d9955e674bed8628b262fb8a704018eafce81e9046f97741d0d0c0c29848026f60f4761077345bdbd3344f73b9b676eac08d782d8da7d86f3a319b49c
+  data.tar.gz: 39f88c73f3031c1f6641e44703d6051fa70aeae62ff93ba33c74304e25bfb5869688e0339ebc1cc57de5d3ba8509a32ecd4ff34c69481fe16d0445214df69449

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kazuhiro.hayashi.49@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xc_metrics_aggregator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    xc_metrics_aggregator (0.1.0)
+      ascii_charts
+      etc
+      terminal-table
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ascii_charts (0.9.1)
+    chronic_duration (0.10.6)
+      numerizer (~> 0.1.1)
+    etc (1.1.0)
+    numerizer (0.1.1)
+    rake (10.5.0)
+    spec (5.3.4)
+      chronic_duration (~> 0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.0.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  spec
+  xc_metrics_aggregator!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Yahoo Japan Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,244 @@
+![](./assets/XCMetricsAggregator.png)
+
+## What's this?
+
+XCMetricsAggregator aggregates metrics data from [Xcode Metrics Organizer](https://help.apple.com/xcode/mac/current/#/devb642b28ac) with AppleScript. 
+It also processes the raw data on your mac device to show the organized tables and charts.
+
+You can check how to use Xcode Metrics Organizer in WWDC 2019 session below.
+
+- [Improving Battery Life and Performance - WWDC 2019](https://developer.apple.com/videos/play/wwdc2019/417/)
+
+## Setup
+
+1. Install Xcode 11.x from App Store or the following link
+
+https://developer.apple.com/download/more/
+
+2. Login with your Apple ID on Accounts preferences in Xcode
+
+<img width="400" alt="スクリーンショット 0002-02-09 18 32 32" src="https://user-images.githubusercontent.com/18320004/74100072-1b04b300-4b6e-11ea-97e0-32239898846d.png">
+
+3. check Accessibility setting in Security & Privacy. Script Editor, System Events and Terminal needs to be checked.
+
+<img width="400" alt="Screen Shot 0002-02-09 at 19 28 25" src="https://user-images.githubusercontent.com/18320004/74100455-789afe80-4b72-11ea-9cef-4ea1704edeac.png">
+
+
+## Getting Started
+There are 2 kinds of command.
+
+- manupulating Xcode automatically
+- processing raw json files for metrics data
+
+"crowl" command download the json files with Xcode, and the others process them.
+
+### Downloading metrics data 
+```
+bundle exec exe/xcmagg crowl
+```
+
+This command launches Xcode automatically, and operates the mouse. 
+
+If you interrupt the crowling, input Ctrl + C on the terminal.
+
+
+### Application lookup in metrics data
+```
+bundle exec exe/xcmagg apps
+```
+
+```
++--------------------------------------------+---------------------+
+|                        available app list                        |
++--------------------------------------------+---------------------+
+| bundle id                                  | status              |
++--------------------------------------------+---------------------+
+| yourapp1                                   | has metrics         |
+| yourapp2                                   | has metrics         |
++--------------------------------------------+---------------------+
+```
+
+### Available devices for your apps
+```
+bundle exec exe/xcmagg devices --b yourapp1,yourapp2
+```
+
+```
++--------------+---------------------------------------+------------+
+|                           yourapp1                                |
++--------------+---------------------------------------+------------+
+| kind         | device                                | id         |
++--------------+---------------------------------------+------------+
+| iPhone (All) | iPhone 8                              | iPhone10,1 |
+|              | iPhone X                              | iPhone10,3 |
+|              | iPhone Xs                             | iPhone11,2 |
+|              | iPhone Xs Max                         | iPhone11,6 |
+|              | iPhone Xʀ                             | iPhone11,8 |
+|              | iPhone 11                             | iPhone12,1 |
++--------------+---------------------------------------+------------+
+| iPad (All)   | iPad (6th Generation)                 | iPad7,5    |
+|              | iPad (7th generation)                 | iPad7,11   |
+|              | iPad Pro (11-inch)                    | iPad8,1    |
+|              | iPad Pro (12.9-inch) (3rd Generation) | iPad8,5    |
+|              | iPad mini (5th generation)            | iPad11,1   |
+|              | iPad Air (3rd generation)             | iPad11,3   |
++--------------+---------------------------------------+------------+
+
++--------------+---------------------------------------+------------+
+|                           yourapp2                                |
++--------------+---------------------------------------+------------+
+| kind         | device                                | id         |
++--------------+---------------------------------------+------------+
+| iPhone (All) | iPhone 8                              | iPhone10,1 |
+|              | iPhone X                              | iPhone10,3 |
+|              | iPhone Xs                             | iPhone11,2 |
+|              | iPhone Xs Max                         | iPhone11,6 |
+|              | iPhone Xʀ                             | iPhone11,8 |
+|              | iPhone 11                             | iPhone12,1 |
++--------------+---------------------------------------+------------+
+| iPad (All)   | iPad (6th Generation)                 | iPad7,5    |
+|              | iPad (7th generation)                 | iPad7,11   |
+|              | iPad Pro (11-inch)                    | iPad8,1    |
+|              | iPad Pro (12.9-inch) (3rd Generation) | iPad8,5    |
+|              | iPad mini (5th generation)            | iPad11,1   |
+|              | iPad Air (3rd generation)             | iPad11,3   |
++--------------+---------------------------------------+------------+
+```
+
+### Available percentiles for your apps
+```
+bundle exec exe/xcmagg percentiles --b yourapp1,yourapp2
+```
+
+```
++----------------+--------------------------------------------+
+|                        yourapp1                             |
++----------------+--------------------------------------------+
+| percentile     | id                                         |
++----------------+--------------------------------------------+
+| Typical        | com.apple.dt.metrics.percentile.fifty      |
+| Top Percentile | com.apple.dt.metrics.percentile.ninetyFive |
++----------------+--------------------------------------------+
+
++----------------+--------------------------------------------+
+|                        yourapp2                             |
++----------------+--------------------------------------------+
+| percentile     | id                                         |
++----------------+--------------------------------------------+
+| Typical        | com.apple.dt.metrics.percentile.fifty      |
+| Top Percentile | com.apple.dt.metrics.percentile.ninetyFive |
++----------------+--------------------------------------------+
+```
+
+### Launch time metrics for an app
+```
+bundle exec exe/xcmagg metrics -s launchTime -b yourapp1 -d iPhone11,6
+```
+
+```
++-------+-------------+----------+----------------+
+| Label | Version     | Device   | Percentile     |
++-------+-------------+----------+----------------+
+| 0     | 1.0.0       | iPhone 8 | Typical        |
+| 1     | 1.1.0       | iPhone 8 | Typical        |
+| 2     | 1.3.0       | iPhone 8 | Typical        |
+| 3     | 1.4.0       | iPhone 8 | Typical        |
+| 4     | 1.5.0       | iPhone 8 | Typical        |
+| 5     | 2.0.0       | iPhone 8 | Typical        |
++-------+-------------+----------+----------------+
+
+700.0|                  
+600.0|                  
+500.0|          *       
+400.0|          *       
+300.0|    *  *  *  *  *  
+200.0| *  *  *  *  *  *  
+100.0| *  *  *  *  *  *  
+  0.0+-------------------
+       0  1  2  3  4  5  
+ 
+Unit: ms
+
+```
+
+
+### Compare launch times between your apps
+```
+bundle exec exe/xcmagg latest -s launchTime -d iPhone11,6 -p com.apple.dt.metrics.percentile.ninetyFive
+```
+
+```
++-------+-----------------------------------+-------------+
+| Label | Bundle ID                         | Version     |
++-------+-----------------------------------+-------------+
+| 0     | yourapp1                          | 2.0.0       |
+| 1     | yourapp2                          | 1.1.0       |
++-------+-----------------------------------+-------------+
+
+700.0|    *              
+600.0|    *              
+500.0|    *     
+400.0|    *  
+300.0| *  * 
+200.0| *  * 
+100.0| *  * 
+  0.0+------
+       0  1 
+ 
+Unit: ms
+
+```
+
+### Send the metrics to your log server with CSV format
+```
+bundle exec exe/xcmagg latest -s launchTime -d iPhone11,6 -p com.apple.dt.metrics.percentile.ninetyFive --f csv
+```
+
+```
+Label,Bundle ID,Version,Point
+0,yourapp1,2.0.0,698
+1,yourapp2,1.1.0,300
+```
+
+## Run with Launchd to see changes over time
+
+If you would like to run script periodically, you can use launchd.
+
+Create plist file to `~/Library/LaunchAgents/xcode-metrics.plist`. 
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>xcode-metrics</string>
+    <key>ProgramArguments</key>
+    <array>
+        <string>/bin/sh</string>
+        <string>/your/path/xcode-metrics-automation/run.sh</string>
+    </array>
+    <key>StartCalendarInterval</key>
+    <dict>
+      <key>Hour</key>
+      <integer>12</integer>
+      <key>Minute</key>
+      <integer>10</integer>
+    </dict>
+    <key>StandardOutPath</key>
+    <string>/tmp/xcode-metrics.out</string>
+    <key>StandardErrorPath</key>
+    <string>/tmp/xcode-metrics.err</string>
+</dict>
+</plist>
+```
+
+Run this command in Terminal to enable the setting.
+
+```
+launchctl load ~/Library/LaunchAgents/xcode-metrics.plist
+```
+
+## License
+
+This software is released under the MIT License, see LICENSE.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xc_metrics_aggregator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/xcmagg

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'xc_metrics_aggregator'
+
+XcMetricsAggregator::CLI.start

data/lib/xc_metrics_aggregator/crawler.rb

@@ -0,0 +1,19 @@
+require 'open3'
+
+module XcMetricsAggregator
+    ROOT_DIR = File.expand_path("..", __dir__)
+    APPLE_SCRIPT_EXECUTION = "osascript"
+    APPLE_SCRIPT_FILE = "xcode_metrics_automation.applescript"
+
+  class Crawler
+    def self.execute
+        script_fullpath = File.join(ROOT_DIR, APPLE_SCRIPT_FILE)
+        command ="#{APPLE_SCRIPT_EXECUTION} #{script_fullpath}"
+        Open3.popen3(command) do |i, o, e, w|
+          o.each do |line| puts line end
+          e.each do |line| puts line end
+          puts w.value
+        end
+    end
+  end
+end

data/lib/xc_metrics_aggregator/formatter/formatter.rb

@@ -0,0 +1,105 @@
+require 'terminal-table'
+require 'xc_metrics_aggregator/structure/structure'
+require 'xc_metrics_aggregator/formatter/output_format'
+
+
+module XcMetricsAggregator
+    class Formatter
+        def self.get_formatter(format)
+            case format
+            when OutputFormat::CSV
+                CSVFormatter.new
+            when OutputFormat::ASCII
+                ASCIIFormatter.new
+            end
+        end
+
+        def format(data)
+            case data
+            when TableStructure
+                format_table(data)
+            when ChartStructure
+                format_chart(data)
+            end
+        end
+
+        def format_table(data)
+        end
+
+        def format_chart(data)
+        end
+    end
+    
+    class CSVFormatter < Formatter
+        def format_table(data)
+            output = data.headings.join(',') + "\n"
+            data.rows.each do |row|
+                if row == :separator
+                    next
+                end
+
+                sub_rows = row.map { |e| e.split("\n") }
+                max_sub_row = sub_rows.max { |a, b| a.count <=> b.count }
+                expaneded_sub_rows = sub_rows.map do |sub_row|
+                    unit = max_sub_row.count / sub_row.count
+                    mod = max_sub_row.count.modulo sub_row.count
+                    expanded_sub_row = sub_row.map { |sub_row_e| Array.new(unit, sub_row_e) }.flatten
+                    if sub_row.last
+                        expanded_sub_row += Array.new(mod, sub_row.last)
+                    end
+                    expanded_sub_row
+                end
+                output += expaneded_sub_rows
+                    .transpose
+                    .map do |row| 
+                        row.map{ |e| e.include?(",") ? "\"#{e}\"" : e }
+                          .join(',')
+                    end
+                    .join("\n")
+                output += "\n"
+            end
+            output
+        end
+
+        def format_chart(data)
+            csv_head = data.series.headings + ["Point"]
+            output = csv_head.join(',') + "\n"
+
+            rows = data.series.rows.map do |line|
+                label = line.first
+                unless label
+                    next
+                end
+
+                sample = data.samples.find {|sample| sample.first == label }
+                unless sample
+                    next
+                end
+
+                line.append(sample.last)
+            end
+
+            output += rows.map do |row| 
+                row.map{ |e| e.to_s.include?(",") ? "\"#{e}\"" : e }
+                  .join(',')
+            end
+            .join("\n")
+            output += "\n"
+            output
+        end
+    end
+
+    class ASCIIFormatter < Formatter
+        def format_table(data)
+            Terminal::Table.new rows: data.rows, headings: data.headings, title: data.title
+        end
+
+        def format_chart(data)
+            output = Terminal::Table.new(rows: data.series.rows, headings: data.series.headings).to_s
+            output += "\n"
+            output += AsciiCharts::Cartesian.new(data.samples, bar: true, hide_zero: true).draw.to_s
+            output += "\n"
+            output += "Unit: #{data.unit}\n\n"
+        end
+    end
+end