matey 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66e49f6118a1523d6292998e3d8fa619215337fc30de9eb53ed9a80fbb0afe69
-  data.tar.gz: 5de9ddf3a9ba33dff9df9561ed67fab9ed95e996dfc0aa7d7a77bd89632de116
+  metadata.gz: 5991529e6b95d161fa55e0b72a16fb4d22afd2f1d3fd3e657e6c834b5baca48f
+  data.tar.gz: 7764c92bd83d7d7796b7e8737af3c8a6c5007b444238d4307f82790413da249c
 SHA512:
-  metadata.gz: 1624664b60404d56131c260aa31f9cdfc6a5b5947d9b46ff49904011f0cfa2b180b46ce1aff9f21342d0ada07038920ef8ad1b5147ad8cbee548f820deddb246
-  data.tar.gz: fb0ef079b743b0976606b21e9952004fcb22d6959c3b28fd7fc87adff39ba44c62a8aadb877a151eae34da7357f2c0e95341bc7ded68dab8747ddd4c9cf3ac9f
+  metadata.gz: 2cdb414b9eef61de45dc70babff6c441ff54cceebe2c3b6f515c79c52c8b3f4678f8e65bd41d3ca03f00317f21d634c5780263e9004eedcb607ecbdc7260cb65
+  data.tar.gz: 91e809d70fead673bfa1d308db1edefb5872da969f322f2ac813569de19d18d08657beb21cd31789fbb6e41f04466dad9b054ceecd36cf785b33c3bdb051f243

data/CHANGELOG.md

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

data/COMPONENTS.md

@@ -0,0 +1,75 @@
+# Components
+
+The following components are available;
+
+* [NewUsersComponent](#newuserscomponent)
+* [ActiveUsersComponent](#activeuserscomponent)
+* [NewActivityComponent](#newactivitycomponent)
+* [TopVisitedLandingPagesComponent](#topvisitedlandingpagescomponent)
+* [TopEventsComponent](#topeventscomponent)
+* [BounceRateComponent](#bounceratecomponent)
+
+## NewUsersComponent
+
+![New Users Component](./images/newUsersComponent.png)
+
+The NewUsersComponent displays the number of new users that have been created within the time window parameter. It also displays the number and percentage change from the previous time period. 
+
+``` ruby
+<%= 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 and/or a specific time period. The component finds new users created in the past month and shows us the increase/decrease since the last period based on the `created_at` attribute.
+
+## ActiveUsersComponent
+
+![ActiveUsersComponent](./images/activeUsersComponent.png)
+
+The ActiveUsersComponent displays the number of active users that have been created within the time window parameter.  It also displays the number 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.
+
+``` ruby
+<%= render Matey::ActiveUsersComponent.new(events: Ahoy::Event.all, time_window: 1.month) %>
+```
+
+Here we are passing in all of our **Ahoy::Event** model data which is used to determine what users triggered an event in the parameter time period. The component finds the active users created in the past month and shows us the increase/decrease since the last period.
+
+## NewActivityComponent
+
+![New Activity Component](./images/newActivityComponent.png)
+
+The NewActivityComponent component displays the number of Ahoy events that have been created within the time window parameter. It also displays the number and percentage change from the previous time period.
+
+``` ruby
+<%= 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 Events, but we can filter this data to only include a specific subset of Ahoy Events or from a specific time period. The component finds the Ahoy events created in the past month and shows us the increase/decrease since the last period.
+
+## TopVisitedLandingPagesComponent
+
+![Top Visited Landing Pages Component](./images/topVisitedPages.png)
+
+The TopVisitedPagesTableComponent component uses **`Ahoy::Visit`** data and displays a list of the top visited paths. Pass in `Ahoy::Visit.all` and the component displays the top landing pages based on the visits that have been created within the time window parameter. The *`limit`* parameter limits the number of results and is `10` by default. 
+
+``` ruby
+<%= render Matey::TopVisitedPagesTableComponent.new(events: Ahoy::Visit.all, time_window: 1.month, limit: 10) %>
+```
+
+## TopEventsComponent
+
+![Top Events Component](./images/topEventsComponent.png)
+
+The TopEventsComponent displays a list of the top Ahoy::Events. Pass in the `Ahoy::Event.all` and the component calculates 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.
+
+``` ruby
+<%= render(Matey::TopEventsComponent.new(events: Ahoy::Event.all, time_window: 1.month, limit: 10)) %>
+```
+
+## BounceRateComponent
+![Bounce Rate Component](./images/bounceRateComponent.png)
+
+The BounceRateComponent displays the total bounce rate percentage of the application. That is the number of visits to the application in which the user visited **only** one page and left the site, compared to the total number of visits to the application. It additionally shows a list of the pages with the highest bounces. Pass in the `Ahoy::Event.all` & `Ahoy::Visit.all` parameters and the component calculates the bounce rate of the application and the top 5 pages with the highest bounces. The *`limit`* parameter limits the number of results and is `5` by default.
+
+``` ruby
+<%= render(Matey::BounceRateComponent.new(events: Ahoy::Event.all, visits: Ahoy::Visit.all, limit: 5)) %>
+```

data/Gemfile

@@ -3,25 +3,14 @@
 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]
 
+# compensate for ruby 3 factoring out required gems
 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

@@ -1,95 +1,93 @@
 PATH
   remote: .
   specs:
-    matey (0.1.1)
+    matey (0.1.3)
       ahoy_matey (~> 4.0)
-      view_component (~> 2.0)
+      view_component (~> 2.74.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actioncable (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       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)
+    actionmailbox (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
       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)
+    actionmailer (7.0.4)
+      actionpack (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activesupport (= 7.0.4)
       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)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
       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)
+    actiontext (7.0.4)
+      actionpack (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
       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)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
       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)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activestorage (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activesupport (= 7.0.4)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.2.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    ahoy_matey (4.0.3)
+    ahoy_matey (4.1.0)
       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)
+    debug (1.6.3)
       irb (>= 1.3.6)
-      reline (>= 0.2.7)
+      reline (>= 0.3.1)
     device_detector (1.0.7)
     diff-lcs (1.5.0)
-    digest (3.1.0)
     errbase (0.2.2)
-    erubi (1.10.0)
+    erubi (1.11.0)
     factory_bot (6.2.1)
       activesupport (>= 5.0.0)
     factory_bot_rails (6.2.0)
@@ -97,13 +95,13 @@ GEM
       railties (>= 5.0.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     io-console (0.5.11)
-    io-wait (0.2.1)
-    irb (1.4.1)
+    irb (1.4.2)
       reline (>= 0.3.0)
-    loofah (2.15.0)
+    json (2.6.2)
+    loofah (2.19.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -111,79 +109,68 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.15.0)
-    net-imap (0.2.3)
-      digest
+    minitest (5.16.3)
+    net-imap (0.3.1)
       net-protocol
-      strscan
-    net-pop (0.1.1)
-      digest
+    net-pop (0.1.2)
       net-protocol
+    net-protocol (0.1.3)
       timeout
-    net-protocol (0.1.2)
-      io-wait
-      timeout
-    net-smtp (0.3.1)
-      digest
+    net-smtp (0.3.3)
       net-protocol
-      timeout
     nio4r (2.5.8)
-    nokogiri (1.13.3-x86_64-darwin)
+    nokogiri (1.13.9-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.3-x86_64-linux)
+    nokogiri (1.13.9-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.1)
       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)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.4)
+      actioncable (= 7.0.4)
+      actionmailbox (= 7.0.4)
+      actionmailer (= 7.0.4)
+      actionpack (= 7.0.4)
+      actiontext (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activemodel (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
       bundler (>= 1.15.0)
-      railties (= 7.0.2.3)
+      railties (= 7.0.4)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.0)
     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)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-rails (5.0.3)
+      rspec-support (~> 3.12.0)
+    rspec-rails (5.1.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -191,68 +178,67 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.11.0)
-    rubocop (1.26.0)
+    rspec-support (3.12.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.14.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)
+    sprockets (4.1.1)
       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)
+    sqlite3 (1.5.3-x86_64-darwin)
+    sqlite3 (1.5.3-x86_64-linux)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
     thor (1.2.1)
-    timeout (0.2.0)
-    tzinfo (2.0.4)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    view_component (2.52.0)
+    unicode-display_width (2.3.0)
+    view_component (2.74.1)
       activesupport (>= 5.0.0, < 8.0)
+      concurrent-ruby (~> 1.0)
       method_source (~> 1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.4)
 
 PLATFORMS
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
-  byebug (~> 11.1)
   debug
-  factory_bot (~> 6.0)
-  factory_bot_rails
+  factory_bot_rails (~> 6.0)
   matey!
   net-imap
   net-pop
   net-smtp
   rails (~> 7)
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rspec-rails (~> 5.0.0)
+  rspec-rails (~> 5.0)
   sprockets-rails (~> 3.2.2)
-  sqlite3 (>= 1.4)
+  sqlite3 (~> 1.0)
   standard (~> 1.3)
 
 BUNDLED WITH

data/README.md

@@ -4,25 +4,24 @@
 ![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) 🏴‍☠️
+📈 User Engagement Tracking ViewComponents for [Ahoy](https://github.com/ankane/ahoy) data 🏴‍☠️
 
-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!
+This gem provides a suite of prebuilt [ViewComponents](https://github.com/github/view_component) to observe user engagement in an Ahoy-powered Ruby on Rails 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:
+`matey` depends on:
+* [Ahoy](https://github.com/ankane/ahoy) installed, configured and  tracking user visit and event data
+* [Bootstrap 5.1](https://getbootstrap.com/docs/5.1/getting-started/introduction/) available for styling
+
+Add this line to the Gemfile:
 
 ```ruby
+# latest from rubygems
+gem 'matey'
+
+# or latest from github
 gem 'matey', github: 'harled/matey', branch: 'main'
 ```
 
@@ -30,126 +29,75 @@ 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) %>
-```
+Once `matey` is installed, the next step is to render a component. The data required varies by component. 
+Below is an example of how the `Matey::ActiveUsersComponent` would be 
+called in an application. This component reports on the number of active users within the past two weeks.
 
-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. 
+Below the component is called with two named parameters which include `events` (ahoy event data) and 
+the `time_window`, which is the period to report on.
 
-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) %>
+```ruby
+# dashboard.html.erb
+<%= render Matey::ActiveUsersComponent.new(events: Ahoy::Event.all, time_window: 1.week) %>
 ```
 
-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
+It is that simple! There should now be a card displaying the number of active users within the past week.
 
-![Active Users Component](./images/activeUsersComponent.png)
+View the list of available components [here](COMPONENTS.md).
 
-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:
+**Note**: The more data, the more interesting the components will be. A common and helpful pattern is to capture events on all controller actions. Details on doing this can be found [here](https://github.com/ankane/ahoy#ruby).
 
-```
-<%= 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.
+## Development
 
-### New Activity Component
+After checking out the repository, run the following commands to get started:
 
-![New Activity Component](./images/newActivityComponent.png)
+```bash
+# install required packages
+bin/setup  
 
-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:
+# run test cases and ensure everything is passing
+rake spec  
 
-```
-<%= render Matey::NewActivityComponent.new(events: Ahoy::Event.all, time_window: 1.month) %>
+# an interactive prompt that will allow you to experiment with matey (currently broken!)
+bin/console
 ```
 
-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)) %>
-```
+To install `matey` and make it available as a regular rubygem, run the following command: `bundle exec rake install`
 
-### Top Events Component
+### Sample Application
 
-![Top Events Component](./images/topEventsComponent.png)
+ViewComponents are pretty hard to test without a Ruby on Rails application. This repository includes a sample application that makes it easy to see how a component renders and make quick adjustments.
 
-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:
+To use the sample application: 
 
-```
-<%= render(Matey::TopEventsComponent.new(events: Ahoy::Event.all, time_window: 1.month, limit: 10)) %>
-```
+1. `cd spec/sample`
+2. `bundle`
+3. `rails s`
+4. Open a browser to `localhost:3000`
 
-### Custom Card Component
-*Coming Soon...*
-### Custom Table Component
-*Coming Soon...*
-## Development
+## Testing
 
-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 run the test cases:
 
-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).
+1. `rails db:test:prepare`
+2. `bundle exec rake`
 
-A sample application is included in this repository to help with exploring the components and testing. To use the 
-sample application: 
+## Releasing a New Version
 
-1. cd spec/sample
-2. bundle
-3. rails s
-4. Open a browser to localhost:3000
+To release a new version:
 
-## Testing
+1. Update the version number in `version.rb`
+2. Run `bundle exec rake release`
 
-Use the folloiwng steps to run the test cases:
+The rake task 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).
 
-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! 🎉
+Please take a look at our [Contribution Guidelines](https://github.com/harled/matey/blob/main/docs/CONTRIBUTING.md).
 
-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
 
@@ -157,4 +105,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/app/components/matey/active_users_component.html.erb

@@ -6,7 +6,7 @@
       </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 + "%" %>
+          <%= (@change_active_number > 0 ? "+" : "") + @change_active_number.to_s + " / " + @change_active_percent.to_s + "%" %> compared to last period.
         </p>
       </div><!-- .col -->
     </div><!-- .row -->

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

@@ -0,0 +1,35 @@
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <h5 class = "text-center"><strong>The Bounce Rate of your Application is: <u><%= @percentage_of_visits_that_were_bounced %>%</u></strong></h5>
+    <div>
+      <table class="table table-hover table-borderless table-sm">
+        <tr class="table-dark">
+          <td><strong>Total Number of Bounced Visits:</strong></td>
+          <td class="text-end"><%= @total_number_of_single_event_visits %></td>
+        </tr>
+        <tr class="table-dark">
+          <td><strong>Total Number of Visits:</strong></td>
+          <td class="text-end"><%= @total_number_of_user_visits %></td>
+        </tr>
+      </table>
+    </div>
+    <div>
+      <table class="table table-hover table-borderless table-sm">
+        <thead class="table-dark">
+          <tr>
+            <th>Bounced Page</th>
+            <th class="text-end">Bounce Count</th>
+          </tr>
+        </thead>
+        <tbody class="text-light">
+          <% @most_bounced_pages.each do |controller_name_and_action, count| %>
+            <tr>
+              <td><%= controller_name_and_action %></td>
+              <td class="text-end"><%= count %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/app/components/matey/bounce_rate_component.rb

@@ -0,0 +1,22 @@
+require "ahoy_matey"
+
+class Matey::BounceRateComponent < ApplicationComponent
+  def initialize(events:, visits:, limit: 5)
+    # Determine the total number of user sessions to the website
+    @total_number_of_user_visits = events.pluck(:visit_id).uniq.count
+
+    # First we group by visit_id and scope to visits containing ONLY 1 event
+    @visits_having_only_one_event = events.group(:visit_id).having("count(ahoy_events.id) == 1")
+    # We then count each unique occurence of a visit with 1 event
+    @total_number_of_single_event_visits = @visits_having_only_one_event.uniq.count
+
+    # Determine pages in which the most bounces occur
+    @single_event_visits_landing_page_count = visits.where(id: @visits_having_only_one_event.pluck(:visit_id)).pluck(:landing_page).tally
+
+    # Scope the results to the given limit and sort them in descending order
+    @most_bounced_pages = @single_event_visits_landing_page_count.sort_by { |controller_name_and_action, count| count }.last(limit).reverse
+
+    # Get the percentage as #-One-Page-Visits / Total-#-Of-Visits
+    @percentage_of_visits_that_were_bounced = ((@total_number_of_single_event_visits.to_f / (@total_number_of_user_visits == 0 ? 1 : @total_number_of_user_visits)) * 100).round(1)
+  end
+end

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

@@ -6,7 +6,7 @@
       </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 + "%" %>
+          <%= (@change_active_number > 0 ? "+" : "") + @change_active_number.to_s + " / " + @change_active_percent.to_s + "%" %> compared to last period.
         </p>
       </div><!-- .col -->
     </div><!-- .row -->

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

@@ -6,7 +6,7 @@
       </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 + "%" %>
+          <%= (@change_new_number > 0 ? "+" : "") + @change_new_number.to_s + " / " + @change_new_percent.to_s + "%" %> compared to last period.
         </p>
       </div><!-- .col -->
     </div><!-- .row -->

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

@@ -0,0 +1,27 @@
+<div class="card bg-primary text-light">
+  <div class="card-body">
+    <h5>User Activity for <i>user id: <%=@user_id%></i> since <i><%= time_ago_in_words(@time_window.ago).titleize %></i> ago </h5>
+    <div>
+      <table class="table table-hover table-borderless table-sm">
+        <thead class="table-dark">
+          <tr>
+            <th class="text-start">Event</th>
+            <th class="text-end">Count</th>
+          </tr>
+        </thead>
+        <tbody class="text-light">
+          <% @count_by_event.each do |event, count| %>
+            <tr>
+              <td><%= event %></td>
+              <td class="text-end"><%= count %></td>
+            </tr>
+          <% end %>
+          <tr class="table-dark">
+            <td><strong>Total:</strong></td>
+            <td class="text-end"><%=  @count_by_event.sum {|event, count| count} %></td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </div><!-- .card-body -->
+</div><!-- .card -->

data/app/components/matey/user_engagement_component.rb

@@ -0,0 +1,10 @@
+require "ahoy_matey"
+
+class Matey::UserEngagementComponent < ApplicationComponent
+  def initialize(events:, user_id:, time_window: 1.week, limit: 10)
+    @events_for_user = events.where_props(user_id: user_id).where(time: time_window.ago..Time.current).group(:name).count
+    @count_by_event = @events_for_user.sort_by { |event, count| count }.last(limit).reverse
+    @time_window = time_window
+    @user_id = user_id
+  end
+end

data/docs/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+## Welcome to Matey's Contribution Guidelines
+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)
+
+### For New Contributors:
+Be sure to take a look at the [README](https://github.com/harled/matey/blob/main/README.md) to get a sense of what Matey does and how it works
+
+### Contribution Steps:
+Want to help us out? Here are some steps to make sure you are contributing according to our guidelines.
+
+1. Find an issue you like, or create a new issue [here.](https://github.com/harled/matey/issues)
+  
+Please ask if you have any questions or need clarification on creating a new issue, or related to any existing issue! 🤔
+
+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 (ie. Update the README if necessary). 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/)

data/lib/matey/version.rb

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

data/lib/matey.rb

@@ -4,10 +4,12 @@ require_relative "matey/version"
 
 require_relative "../app/components/application_component"
 require_relative "../app/components/matey/active_users_component"
+require_relative "../app/components/matey/bounce_rate_component"
+require_relative "../app/components/matey/new_activity_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"
+require_relative "../app/components/matey/user_engagement_component"
 
 module Matey
   class Error < StandardError; end

data/matey.gemspec

@@ -3,11 +3,16 @@ 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"]
+
+  # Former authors include:
+  # Suvasan Krishnasamy / suvasan@harled.ca
+  # Caitlin Henry / caitlin@harled.ca
+
+  spec.authors = ["Jon Loos", "Chris Young"]
+  spec.email = ["jon@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.description = "ViewComponents that are 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"
@@ -29,14 +34,16 @@ Gem::Specification.new do |spec|
   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 "view_component", "~> 2.74.1"
   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 "factory_bot_rails", "~> 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"
+  spec.add_development_dependency "standard", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 13.0"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: matey
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 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
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -19,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.74.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.74.1
 - !ruby/object:Gem::Dependency
   name: ahoy_matey
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -111,11 +109,38 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: ViewComponents that helpful in viewing user engagement metrics from Ahoy.
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: ViewComponents that are helpful in viewing user engagement metrics from
+  Ahoy.
 email:
-- suvasan@harled.ca
 - jon@harled.ca
-- caitlin@harled.ca
 - chris@harled.ca
 executables: []
 extensions: []
@@ -128,6 +153,7 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- COMPONENTS.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -136,6 +162,8 @@ files:
 - app/components/application_component.rb
 - app/components/matey/active_users_component.html.erb
 - app/components/matey/active_users_component.rb
+- app/components/matey/bounce_rate_component.html.erb
+- app/components/matey/bounce_rate_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
@@ -144,8 +172,12 @@ files:
 - 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
+- app/components/matey/user_engagement_component.html.erb
+- app/components/matey/user_engagement_component.rb
+- docs/CONTRIBUTING.md
 - images/.DS_Store
 - images/activeUsersComponent.png
+- images/bounceRateComponent.png
 - images/newActivityComponent.png
 - images/newUsersComponent.png
 - images/topEventsComponent.png