chariot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec689a23a3903f34656d8c3af1234fef065fe997b1c7451962157b54da2a6517
+  data.tar.gz: 69a1c2fdd6b6be1e6ab77961af6ede257fb84b9d29448a47552f06da21424a94
+SHA512:
+  metadata.gz: b5555a7ca082c177509b38136587e625ae2cbaf9b461c714ec521ad15c81b6ead0ed07c1eaf9cefe8bc5843fd984559708a8642c5bbf66c029052bfa9d08ab6d
+  data.tar.gz: 5089a7cb62500655cbb39c2bd57f1a3141b15ca9e8552542a064549d422baee43f54e4cbbc3a86903bf50792e46a570263a720820c47fc0a900d3b9b2a4b0f11

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Fingertips
+
+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,72 @@
+# Chariot
+
+Ruby wrapper for `os_signposts` used to record events and intervals and show them using Xcode Instruments.
+
+## Installation
+
+Install a recent version of Xcode either through the developer portal or the App Store. Once installed you can start Xcode Instruments through Xcode or you can find it at:
+
+    /Applications/Xcode.app/Contents/Applications/Instruments.app
+
+## Usage
+
+First you need to come up with a unique subsystem identifier so you don't get in the way of other systems or applications using the same naming as yours.
+
+Our example is for a fictive application called ‘Yellow’.
+
+```ruby
+SUBSYSTEM = 'com.fngtps.yellow'
+```
+
+### Logs
+
+Next we need to decide on a category and initialize a log for it. There is no overhead for creating logs other than memory allocation.
+
+```ruby
+log = Chariot::Log.new(SUBSYSTEM, "Redis Connection")
+```
+
+### Events
+
+You can either emit an event or record the start or end of an interval. These pieces of data will later be pieced together in Instruments. Let's look at an event first.
+
+```ruby
+log.emit("Open")
+```
+
+When you are emitting large volume of events it's slightly better for performance to create a topic.
+
+```ruby
+topic = Chariot::Topic.new(log, "Open")
+topic.emit
+```
+
+An event might have some important details so you can also supply them in the form a string.
+
+```ruby
+topic.emit(message: "host: #{redis.host}, port: #{redis.port}")
+```
+
+### Intervals
+
+Recording an interval is useful because it allows us to see if certain things happen at the same time. An interval is kind of like an event with a duration so when you use the same name they will appear associated in Instruments.
+
+```ruby
+log.start("Open", message: "index: #{index}")
+redis = open_connection
+log.stop("Open", message: "object_id: #{redis.object_id}")
+```
+
+You can also use the block syntax so you don't have to repeat the 
+
+```ruby
+log.interval("Open") do
+  redis = open_connection
+end
+```
+
+Or you can combine both the topic and block approach:
+
+```ruby
+topic.interval { redis = open_connection } 
+```

data/lib/chariot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Chariot
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: chariot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-21 00:00:00.000000000 Z
+dependencies: []
+description: Ruby wrapper for os_signposts used to record events and intervals and
+  show them using Xcode Instruments.
+email:
+- manfred@fngtps.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/chariot/version.rb
+homepage: http://github.com/Fingertips/chariot
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for os_signposts
+test_files: []