xcactivitylog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc90141684fae80212880fb48cfb68fa36773c2d27428df4f1e2e7eccb89d988
+  data.tar.gz: 074f11361b4312d978ac19e14fb6f4c56fc958308866a92f63c0f4a2f4fddac0
+SHA512:
+  metadata.gz: 450ac2460c8789d8efba482f009ff7813fe5e238b5f647bc6fe1bbf9ec249a364920aed7c2fce81a13c74c8c30d54407fdff2d981451bf78740b6c8f0bd90dc8
+  data.tar.gz: f5711987622f8ea0589f4b8249867d447923ebbe6b775384c3113eec42b39960618d2472efecf196e7b9b04f61c8422912b36429c414605139a8d485912cc114

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 segiddins@segiddins.me. 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Samuel Giddins
+
+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,45 @@
+# xcactivitylog
+
+Easy parse Xcode's `.xcactivitylog` files!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xcactivitylog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xcactivitylog
+
+## Usage
+
+```ruby
+require 'xcactivitylog'
+
+toplevel_sections = XCActivityLog.parse_file(path: 'path/to/log.xcactivitylog')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/segiddins/xcactivitylog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Xcactivitylog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/segiddins/xcactivitylog/blob/master/CODE_OF_CONDUCT.md).

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/slf0.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module SLF0
+end

data/lib/slf0/parser.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'slf0/token'
+require 'slf0/tokenizer'
+
+module SLF0
+  class Parser
+    def initialize(class_deserializer:)
+      @class_deserializer = class_deserializer
+    end
+
+    def parse!(io)
+      tokens = Tokenizer.tokenize(io)
+
+      parse_tokens!(tokens)
+    end
+
+    def parse_tokens!(tokens)
+      class_names = tokens.grep(SLF0::Token::ClassName).map(&:value)
+      tokens.reject! { |t| t.is_a? SLF0::Token::ClassName }
+      values = []
+      stream = make_stream(tokens, [nil] + class_names.map { |n| [n, @class_deserializer[n]] })
+      until tokens.empty?
+        values << case tokens.first
+                  when SLF0::Token::ClassNameRef
+                    stream.object
+                  else
+                    tokens.shift.value
+                  end
+      end
+      values
+    end
+
+    def make_stream(tokens, class_deserializer)
+      SLF0::Token::Stream.new(tokens, class_deserializer: class_deserializer)
+    end
+  end
+end

data/lib/slf0/token.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module SLF0
+  class Token
+    attr_reader :value
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    def inspect
+      "#<#{self.class} #{value.inspect}>"
+    end
+
+    class ObjectListNil < Token
+    end
+    class Int < Token
+      alias int value
+    end
+    class ClassName < Token
+    end
+    class ClassNameRef < Token
+    end
+    class String < Token
+      alias string value
+    end
+    class Double < Token
+      alias double value
+    end
+    class ObjectList < Token
+      alias length value
+    end
+
+    class Stream
+      def initialize(tokens, class_deserializer:)
+        @tokens = tokens
+        @class_deserializer = class_deserializer
+      end
+
+      def int(reason = nil)
+        shift(Int, reason).value
+      end
+
+      def string(reason = nil)
+        return if shift_nil?(reason)
+
+        shift(String, reason).value
+      end
+
+      def double(reason = nil)
+        return if shift_nil?
+
+        shift(Double, reason).value
+      end
+
+      def object_list(reason = nil)
+        return if shift_nil?(reason)
+
+        shift(ObjectList, reason).length.times.map { object(reason && "object in object list for #{reason}") }
+      end
+
+      def object(reason = nil)
+        deserializer_for(shift(ClassNameRef, reason).value)[self]
+      end
+
+      def deserializer_for(class_ref_num)
+        @class_deserializer[class_ref_num].last
+      end
+
+      def shift_nil?(reason = nil)
+        shift(ObjectListNil, reason, raise: false)
+      end
+
+      def shift(cls, reason = nil, raise: true)
+        unless (token = @tokens.shift)
+          raise 'no more tokens'
+        end
+
+        unless token.is_a?(cls)
+          raise "expected #{cls} got #{token.inspect} for #{reason}" if raise
+
+          @tokens.unshift(token)
+          return
+        end
+        token
+      end
+    end
+  end
+end

data/lib/slf0/tokenizer.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module SLF0
+  class Tokenizer
+    attr_reader :scanner
+    def initialize(slf0)
+      @scanner = StringScanner.new(slf0)
+    end
+    private_class_method :new
+
+    def self.tokenize(slf0)
+      new(slf0).tokenize
+    end
+
+    def tokenize
+      skip_header!
+      tokenize_body!
+    end
+
+    def skip_header!
+      raise 'missing header' unless scanner.skip(/SLF0/)
+    end
+
+    def tokenize_body!
+      body = []
+      until scanner.eos?
+        object = tokenize_field || tokenize_double_field || tokenize_object_list_nil
+        raise "malformed no object: #{scanner.rest.inspect}\n\nafter: #{body.inspect}" unless object
+
+        body << object
+      end
+      body
+    end
+
+    def tokenize_field
+      raise 'no int found' unless (int = scanner.scan(/\d+/).to_i)
+
+      case scanner.get_byte
+      when '#'
+        SLF0::Token::Int.new int
+      when '%'
+        SLF0::Token::ClassName.new scanner.scan(/.{#{int}}/).freeze
+      when '@'
+        SLF0::Token::ClassNameRef.new int
+      when '"'
+        SLF0::Token::String.new scanner.scan(/.{#{int}}/).tr("\r", "\n").freeze
+      when '('
+        SLF0::Token::ObjectList.new int
+      else
+        scanner.unscan
+        nil
+      end
+    end
+
+    def tokenize_double_field
+      return unless (hex = scanner.scan(/[0-9a-fA-F]*\^/)&.chomp('^'))
+
+      double = [hex.to_i(16)].pack('Q<').unpack1('G')
+      SLF0::Token::Double.new double
+    end
+
+    def tokenize_object_list_nil
+      return unless scanner.skip(/-/)
+
+      SLF0::Token::ObjectListNil.new nil
+    end
+  end
+end

data/lib/xcactivitylog.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'zlib'
+
+module XCActivityLog
+  class Error < StandardError; end
+
+  autoload :Parser, 'xcactivitylog/parser'
+
+  def self.parse_file(path:)
+    contents = File.open(path, 'rb', &:read)
+    unzipped_contents = Zlib.gunzip(contents)
+
+    Parser.new(class_deserializer: {}).parse!(unzipped_contents)
+  end
+end

data/lib/xcactivitylog/objects.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module XCActivityLog
+  class SerializedObject
+    Attribute = Struct.new(:name, :type, :first_version, :last_version)
+    def self.attribute(name, type, first_version = 0, last_version = 99_999)
+      attr_reader name
+      alias_method "#{name}?", name if type == :boolean
+      if type == :time
+        define_method(:"#{name}_usec") do
+          time = send(name)
+          time.to_i * 1_000_000 + time.usec
+        end
+      end
+      attributes << Attribute.new(name, type, first_version, last_version).freeze
+    end
+
+    def self.attributes
+      @attributes ||= begin
+        SerializedObject == self ? [].freeze : superclass.attributes.dup
+      end
+    end
+
+    def hash
+      self.class.attributes.reduce(0x747) do |hash, attr|
+        hash ^ send(attr.name).hash
+      end
+    end
+
+    def ==(other)
+      self.class.attributes.reduce(self.class == other.class) do |eq, attr|
+        eq && (send(attr.name) == other.send(attr.name))
+      end
+    end
+
+    def eql?(other)
+      self.class.attributes.reduce(self.class == other.class) do |eq, attr|
+        eq && send(attr.name).eql?(other.send(attr.name))
+      end
+    end
+  end
+
+  class NSRange < SerializedObject
+    attribute :location, :int
+    attribute :length, :int
+    attributes.freeze
+  end
+
+  class IDEActivityLogSection < SerializedObject
+    include Enumerable
+    def each(&blk)
+      return enum_for(__method__) unless block_given?
+
+      yield self
+      subsections&.each { |s| s.each(&blk) }
+    end
+
+    def duration_usec
+      time_stopped_recording_usec - time_started_recording_usec
+    end
+    attribute :section_type, :int
+    attribute :domain_type, :string
+    attribute :title, :string
+    attribute :signature, :string
+    attribute :time_started_recording, :time
+    attribute :time_stopped_recording, :time
+    attribute :subsections, :object_list
+    attribute :text, :string
+    attribute :messages, :object_list
+    attribute :cancelled, :boolean
+    attribute :quiet, :boolean
+    attribute :fetched_from_cache, :boolean
+    attribute :subtitle, :string
+    attribute :location, :document_location
+    attribute :command_detail_description, :string
+    attribute :unique_identifier, :string
+    attribute :localized_result_string, :string
+    attribute :xcbuild_signature, :string
+    attribute :collect_metrics, :boolean, 9
+    attributes.freeze
+  end
+  class IDECommandLineBuildLog < IDEActivityLogSection
+    attributes.freeze
+  end
+
+  class IDEActivityLogMessage < SerializedObject
+    include Enumerable
+    def each(&blk)
+      return enum_for(__method__) unless block_given?
+
+      yield self
+      submessages&.each { |s| s.each(&blk) }
+    end
+    attribute :title, :string
+    attribute :short_title, :string
+    attribute :time_emitted, :int
+    attribute :range_in_section_text, :nsrange
+    attribute :submessages, :object_list
+    attribute :severity, :int
+    attribute :type, :string
+    attribute :location, :object
+    attribute :category_identifier, :string
+    attribute :secondary_locations, :object_list
+    attribute :additional_description, :string
+    attributes.freeze
+  end
+  class IDEClangDiagnosticActivityLogMessage < IDEActivityLogMessage
+    attributes.freeze
+  end
+
+  class DVTDocumentLocation < SerializedObject
+    attribute :document_url_string, :string
+    attribute :timestamp, :double
+    attributes.freeze
+
+    def document_url
+      URI::File.parse(document_url_string)
+    end
+  end
+  class DVTTextDocumentLocation < DVTDocumentLocation
+    attribute :starting_line_number, :int
+    attribute :starting_column_number, :int
+    attribute :ending_line_number, :int
+    attribute :ending_column_number, :int
+    attribute :character_range, :nsrange
+    attribute :location_encoding, :int
+    attributes.freeze
+  end
+end

data/lib/xcactivitylog/parser.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'slf0/parser'
+require 'xcactivitylog/objects'
+
+module XCActivityLog
+  class Parser < SLF0::Parser
+    class S < SLF0::Token::Stream
+      def initialize(tokens, class_deserializer:)
+        super(tokens, class_deserializer: class_deserializer)
+        @version = int('activity log version')
+      end
+
+      def deserializer_for(class_ref_num)
+        class_name, = @class_deserializer[class_ref_num]
+        cls = XCActivityLog.const_get(class_name)
+        raise "invalid #{class_name} #{cls}" unless cls < SerializedObject
+
+        lambda do |stream|
+          deserialize_instance_of(stream, cls)
+        end
+      end
+
+      def deserialize_instance_of(stream, cls)
+        instance = cls.new
+        cls.attributes.each do |attr|
+          next if attr.first_version > @version || attr.last_version < @version
+
+          value = stream.send(attr.type, "#{attr.name} for #{cls.name.split('::').last}")
+          instance.instance_variable_set(:"@#{attr.name}", value)
+        end
+        instance.freeze
+      end
+
+      def boolean(reason = nil)
+        int(reason) != 0
+      end
+
+      def nsrange(_reason = nil)
+        deserialize_instance_of(self, NSRange)
+      end
+
+      def document_location(reason = nil)
+        return if shift_nil?
+
+        object(reason).tap do |o|
+          raise "expected location, got #{o.class.name} for #{reason}" unless o.is_a?(DVTDocumentLocation)
+        end
+      end
+
+      EPOCH = Time.new(2001, 1, 1, 0, 0, 0, '+00:00').freeze
+
+      def time(reason = nil)
+        EPOCH.+(double(reason)).freeze
+      end
+    end
+    def make_stream(tokens, class_deserializer)
+      S.new(tokens, class_deserializer: class_deserializer)
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: xcactivitylog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Giddins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- segiddins@segiddins.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- VERSION
+- lib/slf0.rb
+- lib/slf0/parser.rb
+- lib/slf0/token.rb
+- lib/slf0/tokenizer.rb
+- lib/xcactivitylog.rb
+- lib/xcactivitylog/objects.rb
+- lib/xcactivitylog/parser.rb
+homepage: https://github.com/segiddins/xcactivitylog
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/segiddins/xcactivitylog
+  source_code_uri: https://github.com/segiddins/xcactivitylog
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Parse Xcode's xcactivitylog files (and other SLF0-serialized files)
+test_files: []