matey 0.1.1 → 0.1.4

data/app/components/matey/visits_by_day_of_week_component.rb

@@ -0,0 +1,24 @@
+require "ahoy_matey"
+
+class Matey::VisitsByDayOfWeekComponent < Matey::ApplicationComponent
+  def initialize(visits:, time_window: 1.month, limit: 10, exclude_days: [], color_scheme: "neutral")
+    @time_window = time_window
+
+    # query for all the visits
+    all_visits = visits.where(started_at: time_window.ago..)
+
+    visits_by_day_of_week = {}
+
+    # get day of week from each visit. Incrase value of dayOfWeek key by 1 if key is already there else initialize key with value of 1
+    all_visits.each { |visit| visits_by_day_of_week.key?(visit.started_at.strftime("%A")) ? visits_by_day_of_week[(visit.started_at.strftime("%A"))] += 1 : visits_by_day_of_week[visit.started_at.strftime("%A")] = 1 }
+
+    # take out items from visits_by_day_of_week  hashmap based on exclude_days parameter
+    if exclude_days.length > 0
+      exclude_days.each { |exclude| visits_by_day_of_week = visits_by_day_of_week.slice!(exclude) }
+    end
+
+    @visits_by_day_of_week = visits_by_day_of_week
+
+    @color_scheme = color_scheme(scheme: color_scheme)
+  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/helpers.rb

@@ -0,0 +1,12 @@
+module ColorSchemeHelper
+  def color_scheme(scheme: "blue")
+    case scheme
+    when "blue"
+      "bg-primary text-light"
+    when "neutral"
+      "bg-light text-dark border-dark"
+    else
+      "bg-light text-dark border-dark"
+    end
+  end
+end

data/lib/matey/version.rb

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

data/lib/matey.rb

@@ -2,12 +2,17 @@
 
 require_relative "matey/version"
 
-require_relative "../app/components/application_component"
+require_relative "../app/components/matey/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"
+require_relative "../app/components/matey/daily_active_users_component"
+require_relative "../app/components/matey/visits_by_day_of_week_component"
+require_relative "../app/components/matey/browser_os_breakdown_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"
   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.4
 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: 2023-06-21 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.74'
 - !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,14 +153,22 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- COLOR_SCHEMES.md
+- COMPONENTS.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/application_component.rb
+- app/components/matey/bounce_rate_component.html.erb
+- app/components/matey/bounce_rate_component.rb
+- app/components/matey/browser_os_breakdown_component.html.erb
+- app/components/matey/browser_os_breakdown_component.rb
+- app/components/matey/daily_active_users_component.html.erb
+- app/components/matey/daily_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
@@ -144,12 +177,21 @@ 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
+- app/components/matey/visits_by_day_of_week_component.html.erb
+- app/components/matey/visits_by_day_of_week_component.rb
+- docs/CONTRIBUTING.md
 - images/.DS_Store
 - images/activeUsersComponent.png
+- images/bounceRateComponent.png
+- images/colorSchemeBlue.png
+- images/colorSchemeNeutral.png
 - images/newActivityComponent.png
 - images/newUsersComponent.png
 - images/topEventsComponent.png
 - images/topVisitedPages.png
+- lib/helpers.rb
 - lib/matey.rb
 - lib/matey/version.rb
 - matey.gemspec
@@ -176,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Track user engagement using Ahoy and ViewComponents.