matey 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66e49f6118a1523d6292998e3d8fa619215337fc30de9eb53ed9a80fbb0afe69
+  data.tar.gz: 5de9ddf3a9ba33dff9df9561ed67fab9ed95e996dfc0aa7d7a77bd89632de116
+SHA512:
+  metadata.gz: 1624664b60404d56131c260aa31f9cdfc6a5b5947d9b46ff49904011f0cfa2b180b46ce1aff9f21342d0ada07038920ef8ad1b5147ad8cbee548f820deddb246
+  data.tar.gz: fb0ef079b743b0976606b21e9952004fcb22d6959c3b28fd7fc87adff39ba44c62a8aadb877a151eae34da7357f2c0e95341bc7ded68dab8747ddd4c9cf3ac9f

data/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.1, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.1-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.1-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/base.Dockerfile

@@ -0,0 +1,43 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.1, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.1-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.1-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM ruby:${VARIANT}
+
+# Copy library scripts to execute
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="true"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+# Install needed packages and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, rvm, core build tools
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    && bash /tmp/library-scripts/ruby-debian.sh "none" "${USERNAME}" "true" "true" \
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \
+    PATH=${NVM_DIR}/current/bin:${PATH}
+RUN bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "${NODE_VERSION}" "${USERNAME}" \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+ # Remove library scripts for final image
+RUN rm -rf /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.217.4/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.1, 3.0, 2, 2.7, 2.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.1",
+			// Options
+			"NODE_VERSION": "lts/*"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,6 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6
+
+ignore:
+  - spec/sample/**/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at chris@harled.ca. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+# rails_version = "#{ENV['RAILS_VERSION'] || 'main'}"
+rails_version = (ENV["RAILS_VERSION"] || "~> 7").to_s
+gem "rails", rails_version == "main" ? {git: "https://github.com/rails/rails", ref: "main"} : rails_version
+gem "sqlite3", ">= 1.4"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "rspec-rails", "~> 5.0.0"
+gem "factory_bot_rails"
+
+gem "standard", "~> 1.3"
+
+gem "debug", platforms: %i[mri mingw x64_mingw]
+
+if RUBY_VERSION >= "3.1"
+  gem "net-imap", require: false
+  gem "net-pop", require: false
+  gem "net-smtp", require: false
+end
+
+gem "byebug", "~> 11.1", groups: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,259 @@
+PATH
+  remote: .
+  specs:
+    matey (0.1.1)
+      ahoy_matey (~> 4.0)
+      view_component (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activestorage (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ahoy_matey (4.0.3)
+      activesupport (>= 5.2)
+      device_detector
+      safely_block (>= 0.2.1)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    debug (1.4.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    device_detector (1.0.7)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
+    errbase (0.2.2)
+    erubi (1.10.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.2.0)
+      factory_bot (~> 6.2.0)
+      railties (>= 5.0.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    io-wait (0.2.1)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    loofah (2.15.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.2)
+      io-wait
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.2.3)
+      actioncable (= 7.0.2.3)
+      actionmailbox (= 7.0.2.3)
+      actionmailer (= 7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actiontext (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.2.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.0.3)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    safely_block (0.3.0)
+      errbase (>= 0.1.1)
+    sprockets (4.0.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    standard (1.9.0)
+      rubocop (= 1.26.0)
+      rubocop-performance (= 1.13.3)
+    strscan (3.0.1)
+    thor (1.2.1)
+    timeout (0.2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    view_component (2.52.0)
+      activesupport (>= 5.0.0, < 8.0)
+      method_source (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  debug
+  factory_bot (~> 6.0)
+  factory_bot_rails
+  matey!
+  net-imap
+  net-pop
+  net-smtp
+  rails (~> 7)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-rails (~> 5.0.0)
+  sprockets-rails (~> 3.2.2)
+  sqlite3 (>= 1.4)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Young
+
+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,160 @@
+# Matey
+
+![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/harled/matey) 
+![GitHub issues](https://img.shields.io/github/issues-raw/harled/matey) 
+![GitHub Repo stars](https://img.shields.io/github/stars/harled/matey?logoColor=purple&style=social)
+
+📈 User Engagement Tracking Components for [Ahoy](https://github.com/ankane/ahoy) 🏴‍☠️
+
+A suite of user engagment ViewComponents for plug and play use right from your Ahoy data! 
+No need to spend time finding what information you need and how to write the queries to set that up.
+Simply install the gem, input the required data and track how your users are responding to your application!
+
+Project Lead: Caitlin Henry  
+[**caitmich**](https://github.com/caitmich) | (*caitlin@harled.ca*)
+
+This gem assumes that event data is coming from [Ahoy](https://github.com/ankane/ahoy) which is a fantastic library
+for tracking visits and events. Your project must have Ahoy installed and configured in order to benefit from Matey.
+
+This gem assumes that you have [Bootstrap 5.1](https://getbootstrap.com/docs/5.1/getting-started/introduction/) loaded in your project. It will work without Bootstrap, however, you will need to provide your own custom styling for the Bootstrap equivalent classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matey', github: 'harled/matey', branch: 'main'
+```
+
+And then execute:
+
+    $ bundle install
+
+You will now have the latest version of Matey on your project. Checkout the Usage section to see what components there are and how to use them in your app!
+
+## Usage
+
+Look here to see what components Matey offers and how to use them 🛠️
+
+### Common Flows
+
+Some common flows to recognize how the named paramaters work for the components. This is what a Matey view component render line would look like in your view file:
+
+```
+<%= render Matey::ComponentName.new(events: Ahoy::Event.all, time_window: 1.week) %>
+```
+
+Here we can see that all components begin with **`Matey::`** followed by the name of the component. The **`data`** parameter will take in Ahoy data as an ***ActiveRecordRelation*** collection. 
+
+The **`time_window`** takes in an amount of time that the component will look calculate the data for and uses this to set the specific date range that the data will be taken from. This is an optional parameter and the default will be a 1 week time window.
+
+In this example, the component will take the **`Ahoy::Events`** data and show information about the week of data.
+
+**Note**: The data the component is completely limited by the extent of your [Ahoy](https://github.com/ankane/ahoy) data. Setting up events on each controller action can be seen [here](https://github.com/ankane/ahoy#ruby) and can be done in the base controller so that all other controllers inherit from here and will create Ahoy events.
+
+Also, if you have a lot of data, you can cut down the data that you are passing through by reducing the time the events have occurred, however the comparison between the current and previous `time_window` will require two time windows worth of data (ie. for data from last week, this will compare to data from 2 weeks ago)
+
+### New Users Component
+
+![New Users Component](./images/newUsersComponent.png)
+
+The New Users component will calculate the number of new users that have been created in the given time window and show you the amount and percentage change from the previous time period. The code should look like this:
+
+```
+<%= render Matey::NewUsersComponent.new(users: User.all, time_window: 2.month) %>
+```
+
+Here we are passing in all of our **User** model data for the component to find the new users that were made in the last 2 months, but we can filter this data to only include a specific subset of users or from a specific time period. The component will find the new users created in the past month and show us the increase/decrease since the last period.
+### Active Users
+
+![Active Users Component](./images/activeUsersComponent.png)
+
+The Active Users component will calculate the number of active users that have been created in the given time window and show you the amount and percentage change from the previous time period. This component counts active users as those who have been involved in an Ahoy event in the given time window. The code should look like this:
+
+```
+<%= render Matey::ActiveUsersComponent.new(events: Ahoy::Event.all, time_window: 1.month) %>
+```
+
+Here we are passing in all of our **Ahoy::Event** model data for the component to find the user that were triggered some Ahoy Event, but we can filter this data to only include a specific subset of Ahoy Events or from a specific time period. The component will find the active users created in the past month and show us the increase/decrease since the last period.
+
+### New Activity Component
+
+![New Activity Component](./images/newActivityComponent.png)
+
+The New Activity component will calculate the number of Ahoy events that have been created in the given time window and show you the amount and percentage change from the previous time period. The implementation should look like:
+
+```
+<%= render Matey::NewActivityComponent.new(events: Ahoy::Event.all, time_window: 1.month) %>
+```
+
+Here we are passing in all of our **Ahoy::Event** model data for the component to count all Ahoy Event, but we can filter this data to only include a specific subset of Ahoy Events or from a specific time period. The component will find the Ahoy events created in the past month and show us the increase/decrease since the last period.
+### Top Visited Landing Pages Component
+
+![Top Visited Landing Pages Component](./images/topVisitedPages.png)
+
+The Top Visited Pages Table Component component will take advantage of **`Ahoy::Visit`** and gives you a list of the top visited paths. Just pass in the Ahoy::Visit.all and the component will calculate the top landing pages based on the visits that have been created in the given time window. The *`limit`* parameter limits the number of results and is 10 by default. The implementation should look like:
+
+```
+<%= render(Matey::TopVisitedPagesTableComponent.new(events: Ahoy::Visit.all, time_window: 1.month, limit: 10)) %>
+```
+
+### Top Events Component
+
+![Top Events Component](./images/topEventsComponent.png)
+
+The Top Events Component component will give you a list of the top Ahoy::Event's that are triggered by your users. Just pass in the Ahoy::Event.all and the component will calculate the top events that have been triggered in the given time window. The *`limit`* parameter limits the number of results and is 10 by default. The implementation should look like:
+
+```
+<%= render(Matey::TopEventsComponent.new(events: Ahoy::Event.all, time_window: 1.month, limit: 10)) %>
+```
+
+### Custom Card Component
+*Coming Soon...*
+### Custom Table Component
+*Coming Soon...*
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+A sample application is included in this repository to help with exploring the components and testing. To use the 
+sample application: 
+
+1. cd spec/sample
+2. bundle
+3. rails s
+4. Open a browser to localhost:3000
+
+## Testing
+
+Use the folloiwng steps to run the test cases:
+
+1. rails db:test:prepare
+2. bundle exec rake
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/harled/matey. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/harled/matey/blob/master/CODE_OF_CONDUCT.md).
+
+### Contribution Steps:
+
+Want to help us out? Here are some steps to make sure you are contributing 
+
+1. Find an issue you like, or create a new issue [here](https://github.com/harled/matey/issues) 
+    - Please ask for any questions or clarifications in the associated issues or in new issues! 🤔
+2. Assign yourself to the issue and create a branch , following GitHub Issue's naming scheme. 🛠️
+    - The naming scheme should follow (#issueNumber-issue-name) ie. (#10-create-new-component)
+3. Get on your local machine and [ensure you have the repo cloned](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). Checkout the branch you just made with `git checkout branch-name` and pull the latest merged changes from the repo with `git pull origin main` to make sure you have the most up-to-date code from the repo. 👩‍💻
+4. Add your amazing changes along with any documentation you feel would be useful. Then commit and push your changes. 🌟
+5. Go back to the repo on GitHub and create a pull request! Then wait for an admin of the repo to get back to your pull request, address any comments and once you are finally approved, merge your code into Matey! 🎉
+
+If you want some more tips on contributing to GitHub projects, [check out this resource from Data School](https://www.dataschool.io/how-to-contribute-on-github/).
+
+## 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 Matey project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/harled/matey/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+APP_RAKEFILE = File.expand_path("spec/sample/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/app/components/application_component.rb

@@ -0,0 +1,10 @@
+require "view_component"
+require "ahoy_matey"
+
+class ApplicationComponent < ViewComponent::Base
+  include ActiveModel::Validations
+
+  def before_render
+    validate!
+  end
+end

data/app/components/matey/active_users_component.html.erb

@@ -0,0 +1,15 @@
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <div class="row">
+      <div class="col">
+        <h1><%= @current_period %></h1>
+      </div>
+      <div class="col-auto">
+        <p class="card-text text-end mb-0">
+          <%= (@change_active_number > 0 ? "+" : "") + @change_active_number.to_s + " / " + @change_active_percent.to_s + "%" %>
+        </p>
+      </div><!-- .col -->
+    </div><!-- .row -->
+    <h4 class="card-text my-2"><strong> Active Users </strong> since <%= time_ago_in_words(@time_window.ago).titleize %> ago (<%= @time_window.ago.strftime("%m/%d/%Y") %>)</h4>
+  </div><!-- .card-body -->
+</div><!-- .card -->

data/app/components/matey/active_users_component.rb

@@ -0,0 +1,16 @@
+require "ahoy_matey"
+
+class Matey::ActiveUsersComponent < ApplicationComponent
+  def initialize(events:, time_window: 1.week)
+    raise ArgumentError unless events.is_a?(ActiveRecord::Relation)
+    raise ArgumentError unless time_window.is_a?(Integer)
+
+    @current_period = events.where(time: time_window.ago..Time.current).pluck(:user_id).uniq.count
+    previous_period = events.where(time: (2 * time_window).ago..time_window.ago).pluck(:user_id).uniq.count
+
+    @change_active_number = @current_period - previous_period
+    @change_active_percent = ((@change_active_number.to_f / (previous_period == 0 ? 1 : previous_period)) * 100).truncate(2)
+
+    @time_window = time_window
+  end
+end

data/app/components/matey/new_activity_component.html.erb

@@ -0,0 +1,15 @@
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <div class="row">
+      <div class="col">
+        <h1><%= @current_period %></h1>
+      </div>
+      <div class="col-auto">
+        <p class="card-text text-end mb-0">
+          <%= (@change_active_number > 0 ? "+" : "") + @change_active_number.to_s + " / " + @change_active_percent.to_s + "%" %>
+        </p>
+      </div><!-- .col -->
+    </div><!-- .row -->
+    <h4 class="card-text my-2"><strong> New Activity </strong> since <%= time_ago_in_words(@time_window.ago).titleize %> ago (<%= @time_window.ago.strftime("%m/%d/%Y") %>)</h4>
+  </div><!-- .card-body -->
+</div><!-- .card -->

data/app/components/matey/new_activity_component.rb

@@ -0,0 +1,14 @@
+class Matey::NewActivityComponent < ApplicationComponent
+  def initialize(events:, time_window: 1.week)
+    raise ArgumentError unless events.is_a?(ActiveRecord::Relation)
+    raise ArgumentError unless time_window.is_a?(Integer)
+
+    @current_period = events.where(time: time_window.ago..Time.current).count
+    previous_period = events.where(time: (2 * time_window).ago..time_window.ago).pluck(:user_id).count
+
+    @change_active_number = @current_period - previous_period
+    @change_active_percent = ((@change_active_number.to_f / (previous_period == 0 ? 1 : previous_period)) * 100).truncate(2)
+
+    @time_window = time_window
+  end
+end

data/app/components/matey/new_users_component.html.erb

@@ -0,0 +1,15 @@
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <div class="row">
+      <div class="col">
+        <h1><%= @current_period %></h1>
+      </div>
+      <div class="col-auto">
+        <p class="card-text text-end mb-0">
+          <%= (@change_new_number > 0 ? "+" : "") + @change_new_number.to_s + " / " + @change_new_percent.to_s + "%" %>
+        </p>
+      </div><!-- .col -->
+    </div><!-- .row -->
+    <h4 class="card-text my-2"><strong> New Users </strong> since <%= time_ago_in_words(@time_window.ago).titleize %> ago (<%= @time_window.ago.strftime("%m/%d/%Y") %>)</h4>
+  </div><!-- .card-body -->
+</div><!-- .card -->

data/app/components/matey/new_users_component.rb

@@ -0,0 +1,11 @@
+class Matey::NewUsersComponent < ApplicationComponent
+  def initialize(users:, time_window: 1.week)
+    @current_period = users.where(created_at: time_window.ago..Time.current).count
+    previous_period = users.where(created_at: (2 * time_window).ago..time_window.ago).count
+
+    @change_new_number = @current_period - previous_period
+    @change_new_percent = ((@change_new_number.to_f / (previous_period == 0 ? 1 : previous_period)) * 100).truncate(2)
+
+    @time_window = time_window
+  end
+end

data/app/components/matey/top_events_component.html.erb

@@ -0,0 +1,29 @@
+
+
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <h5>Top Events Since <%= time_ago_in_words(@time_window.ago).titleize %> Ago (<%= @time_window.ago.strftime("%m/%d/%Y") %>)</h5>
+    <div>
+      <table class="table table-hover table-borderless table-sm">
+        <thead class="table-dark">
+          <tr>
+            <th>Event</th>
+            <th>Count</th>
+          </tr>
+        </thead>
+        <tbody class="text-light">
+          <% @events.each do |action, count| %>
+            <tr>
+              <td><%= action %></td>
+              <td class="text-end"><%= count %></td>
+            </tr>
+          <% end %>
+          <tr class="table-dark">
+            <td><strong>Total:</strong></td>
+            <td class="text-end"><%=  @events.sum {|controller_name_and_action, count| count} %></td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </div><!-- .card-body -->
+</div><!-- .card -->

data/app/components/matey/top_events_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Matey::TopEventsComponent < ApplicationComponent
+  def initialize(events:, time_window: 1.week, limit: 5)
+    raise ArgumentError unless events.is_a?(ActiveRecord::Relation)
+    raise ArgumentError unless time_window.is_a?(Integer)
+
+    @events = events.where(time: time_window.ago..Time.current).limit(limit).order("count(name) DESC").group(:name).count
+    @time_window = time_window
+  end
+end

data/app/components/matey/top_visited_pages_table_component.html.erb

@@ -0,0 +1,27 @@
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <h5>Top Landing Page Visits Since <%= time_ago_in_words(@time_window.ago).titleize %> Ago (<%= @time_window.ago.strftime("%m/%d/%Y") %>)</h5>
+    <div>
+      <table class="table table-hover table-borderless table-sm">
+        <thead class="table-dark">
+          <tr>
+            <th>Path/Page</th>
+            <th>Count</th>
+          </tr>
+        </thead>
+        <tbody class="text-light">
+          <% @user_count_by_event.each do |controller_name_and_action, count| %>
+            <tr>
+              <td><%= controller_name_and_action %></td>
+              <td class="text-end"><%= count %></td>
+            </tr>
+          <% end %>
+          <tr class="table-dark">
+            <td><strong>Total:</strong></td>
+            <td class="text-end"><%=  @user_count_by_event.sum {|controller_name_and_action, count| count} %></td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </div><!-- .card-body -->
+</div><!-- .card -->

data/app/components/matey/top_visited_pages_table_component.rb

@@ -0,0 +1,11 @@
+class Matey::TopVisitedPagesTableComponent < ApplicationComponent
+  def initialize(events:, time_window: 1.week, limit: 10)
+    # Group events by controller (:name) and action. Aggregate number of unique user actions
+    @user_count_by_event = events.where(started_at: time_window.ago..).pluck(:landing_page).tally
+
+    # Filter for the top 10 elements by user actions
+    @user_count_by_event = @user_count_by_event.sort_by { |controller_name_and_action, count| count }.last(limit).reverse
+
+    @time_window = time_window
+  end
+end

data/lib/matey/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Matey
+  VERSION = "0.1.1"
+end

data/lib/matey.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "matey/version"
+
+require_relative "../app/components/application_component"
+require_relative "../app/components/matey/active_users_component"
+require_relative "../app/components/matey/new_users_component"
+require_relative "../app/components/matey/top_events_component"
+require_relative "../app/components/matey/new_activity_component"
+require_relative "../app/components/matey/top_visited_pages_table_component"
+
+module Matey
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/matey.gemspec

@@ -0,0 +1,43 @@
+require_relative "lib/matey/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "matey"
+  spec.version = Matey::VERSION
+  spec.authors = ["Suvasan Krishnasamy", "Jon Loos", "Caitlin Henry", "Chris Young"]
+  spec.email = ["suvasan@harled.ca", "jon@harled.ca", "caitlin@harled.ca", "chris@harled.ca"]
+
+  spec.summary = "Track user engagement using Ahoy and ViewComponents."
+  spec.description = "ViewComponents that helpful in viewing user engagement metrics from Ahoy."
+  spec.homepage = "https://github.com/harled/matey"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/harled/matey"
+  spec.metadata["changelog_uri"] = "https://github.com/harled/matey/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "view_component", "~> 2.0"
+  spec.add_dependency "ahoy_matey", "~> 4.0"
+
+  spec.add_development_dependency "rspec-rails", "~> 5.0"
+  spec.add_development_dependency "factory_bot", "~> 6.0"
+  spec.add_development_dependency "sprockets-rails", "~> 3.2.2"
+  spec.add_development_dependency "sqlite3", "~> 1.0"
+  spec.add_development_dependency "debug", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/matey.rbs

@@ -0,0 +1,4 @@
+module Matey
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: matey
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Suvasan Krishnasamy
+- Jon Loos
+- Caitlin Henry
+- Chris Young
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ahoy_matey
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ViewComponents that helpful in viewing user engagement metrics from Ahoy.
+email:
+- suvasan@harled.ca
+- jon@harled.ca
+- caitlin@harled.ca
+- chris@harled.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/base.Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/components/application_component.rb
+- app/components/matey/active_users_component.html.erb
+- app/components/matey/active_users_component.rb
+- app/components/matey/new_activity_component.html.erb
+- app/components/matey/new_activity_component.rb
+- app/components/matey/new_users_component.html.erb
+- app/components/matey/new_users_component.rb
+- app/components/matey/top_events_component.html.erb
+- app/components/matey/top_events_component.rb
+- app/components/matey/top_visited_pages_table_component.html.erb
+- app/components/matey/top_visited_pages_table_component.rb
+- images/.DS_Store
+- images/activeUsersComponent.png
+- images/newActivityComponent.png
+- images/newUsersComponent.png
+- images/topEventsComponent.png
+- images/topVisitedPages.png
+- lib/matey.rb
+- lib/matey/version.rb
+- matey.gemspec
+- sig/matey.rbs
+homepage: https://github.com/harled/matey
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/harled/matey
+  source_code_uri: https://github.com/harled/matey
+  changelog_uri: https://github.com/harled/matey/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Track user engagement using Ahoy and ViewComponents.
+test_files: []