active_analytics 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5054460d87d609cd11f9418dd84963ff89407d20c22beb685b6d2a9eb8b2f922
-  data.tar.gz: 3b2b67cb7d9ce4e652bd22ea519fa294f05fe3b105bd3bfbae932e477a3f9fe2
+  metadata.gz: 8be54d2704a6f0c7141fd6c0c4d276992d13f8cd1126868a5e71d038ba4333e5
+  data.tar.gz: 4a6eb25b26894054f9a1b669a198a6f97d2e13bdf892d8b09b5f8da5251036db
 SHA512:
-  metadata.gz: 2280cf59a6a021c902451bf8a51b7ad678f57917aad786d16a4eeebfc2931766c49f99081eba4d13e0a74fbeba711b26c9c3c12f9405edc20dee4902908f6077
-  data.tar.gz: 915bd565e0218737fc98ce6a97948896be7beb65669a3c8fb5d29d1936f11e8476ad1c24324967ce9fccb7c0db65ebab74c5c31d0d582d7aa0d03dbe7099fb52
+  metadata.gz: efae89347949dc906204ee4188b278a4482e46a2575a83868c4ffc73915869c46f88517fc235c4976ebec9f7474bc26b6823066156aaa2ccffa9ffaeb1128164
+  data.tar.gz: 4b94f1808a3ce5da5e8050fda39270fb7f65990aecb708f0dc6e54174139fa5d9a4f4c87431917be607fed4ad3580710af84b8449f290bbebb78308086ed6f25

data/README.md

@@ -32,7 +32,8 @@ rails active_analytics:install:migrations
 rails db:migrate
 ```
 
-Your controllers have to call `ActiveAnalytics.record_request(request)` to record page views:
+Your controllers have to call `ActiveAnalytics.record_request(request)` to record page views. The Rails way to achieve is to use a `before_action` :
+
 ```ruby
 class ApplicationController < ActionController::Base
   before_action :record_page_view
@@ -45,27 +46,43 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-This is a basic `before_action`. In case you don't want to record all page views, simply define a `skip_before_action :record_page_view` in the relevant controller.
+In case you don't want to record all page views, because each application has sensitive URLs such as password reset and so on, simply define a `skip_before_action :record_page_view` in the relevant controller.
 
 Finally, just add the route to ActiveAnalytics dashboard at the desired endpoint:
+
 ```ruby
 mount ActiveAnalytics::Engine, at: "analytics"  # http://localhost:3000/analytics
 ```
 
 ## Authentication and permissions
-ActiveAnalytics cannot guess how you handle user authentication, because it is different for all Rails applications. So you have to inject your own mechanism into `ActiveAnalytics::ApplicationController`. Create a file in `config/initializers/active_analytics.rb`:
+
+ActiveAnalytics cannot guess how you handle user authentication, because it is different for all Rails applications. So you have to monkey patch `ActiveAnalytics::ApplicationController` in order to inject your own mechanism. Create a file in `config/initializers/active_analytics.rb` to add a before action :
 
 ```ruby
+# config/initializers/active_analytics.rb
 require_dependency "active_analytics/application_controller"
 
 module ActiveAnalytics
   class ApplicationController
-    # include Currentuser           # This is an example that you have to change by
-    # before_action :require_admin  # your own modules and methods
+    before_action :require_admin
+
+    def require_admin
+      # This example supposes there are current_user and User#admin? methods
+      raise ActionController::RoutingError.new("Not found") unless current_user.try(:admin?)
+    end
   end
 end
 ```
 
+If you have Devise, you can check the permission directly from routes.rb :
+
+```ruby
+# config/routes.rb
+authenticate :user, -> (u) { u.admin? } do # Supposing there is a User#admin? method
+  mount ActiveAnalytics::Engine, at: "analytics" # http://localhost:3000/analytics
+end
+```
+
 ## License
 The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/app/assets/javascripts/active_analytics/ariato.js

@@ -86,137 +86,6 @@ Ariato.assignRoles = function(container, controller) {
       controller[name] = controller.roles[name][0]
 }
 
-Ariato.Accordion = function(node) {
-  this.node = node
-  node.ariaAccordion = this
-  this.regions = []
-}
-
-Ariato.Accordion.addRegion = function(region) {
-  var button = region.labelledBy()
-
-  if (!button)
-    return
-
-  var accordion = region.node.parentElement.ariaAccordion || new Ariato.Accordion(region.node.parentElement)
-  accordion.addRegion(region)
-  return accordion
-}
-
-Ariato.Accordion.prototype.addRegion = function(region) {
-  this.regions.push(region)
-}
-
-Ariato.Accordion.prototype.hideRegions = function() {
-  for (var i = 0; i < this.regions.length; i++)
-    this.regions[i].hide()
-}
-
-Ariato.Accordion.prototype.showRegion = function(region) {
-  if (this.mutilpleAllowed())
-    region.expanded() ? region.hide() : region.show()
-  else {
-    this.hideRegions()
-    region.show()
-  }
-}
-
-Ariato.Accordion.prototype.mutilpleAllowed = function() {
-  return this.node.hasAttribute("data-allow-multiple")
-}
-
-Ariato.Carousel = function() {
-  this.currentSlide() || this.showSlide(this.slides()[0])
-  this.node.addEventListener("keydown", this.keydown.bind(this))
-
-  var nextButton = this.node.querySelector("[data-carousel=next]")
-  nextButton && nextButton.addEventListener("click", this.clicked.bind(this))
-
-  var previousButton = this.node.querySelector("[data-carousel=previous]")
-  previousButton.addEventListener("click", this.clicked.bind(this))
-}
-
-Ariato.Carousel.prototype.slides = function() {
-  return this.node.querySelectorAll("[aria-roledescription=slide]")
-}
-
-Ariato.Carousel.prototype.currentSlide = function() {
-  return this.node.querySelector("[aria-current=slide]")
-}
-
-Ariato.Carousel.prototype.showSlide = function(slide) {
-  var slides = this.slides()
-
-  for (var i = 0; i < slides.length; i++)
-    if (slides[i] == slide)
-      slides[i].setAttribute("aria-current", "slide")
-    else
-      slides[i].removeAttribute("aria-current")
-}
-
-Ariato.Carousel.prototype.nextSlide = function(slide) {
-  var slides = this.slides()
-  this.currentSlide()
-  for (var i = 0; i < slides.length; i++) {
-    if (slides[i] == slide)
-      slides[i].setAttribute("aria-current", "slide")
-    else
-      slides[i].removeAttribute("aria-current")
-  }
-}
-
-Ariato.Carousel.prototype.nextSlide = function(slide) {
-  var current = this.currentSlide()
-  return current && current.nextElementSibling
-}
-
-Ariato.Carousel.prototype.previousSlide = function(slide) {
-  var current = this.currentSlide()
-  return current && current.previousElementSibling
-}
-
-Ariato.Carousel.prototype.keydown = function(event) {
-  switch(event.key) {
-    case "ArrowLeft":
-      this.showSlide(this.previousOrLastSlide())
-      break
-    case "ArrowRight":
-      this.showSlide(this.nextOrFirstSlide())
-      break
-  }
-}
-
-Ariato.Carousel.prototype.clicked = function(event) {
-  switch(event.currentTarget.getAttribute("data-carousel")) {
-    case "next":
-      this.showSlide(this.previousOrLastSlide())
-      break
-    case "previous":
-      this.showSlide(this.nextOrFirstSlide())
-      break
-  }
-}
-
-Ariato.Carousel.prototype.previousOrLastSlide = function(event) {
-  var slide = this.previousSlide()
-  if (slide)
-    return slide
-  else {
-    var slides = this.slides()
-    return slides[slides.length-1]
-  }
-}
-
-Ariato.Carousel.prototype.nextOrFirstSlide = function(event) {
-  var slide = this.nextSlide()
-  if (slide)
-    return slide
-  else {
-    var slides = this.slides()
-    return slides[0]
-  }
-}
-
 Ariato.Dialog = function(node) {
   node.setAttribute("hidden", true)
   node.addEventListener("open", this.open.bind(this))
@@ -346,139 +215,6 @@ Ariato.Dialog.prototype.removeBackdrop = function() {
 
 Ariato.Alertdialog = Ariato.Dialog
 
-Ariato.MenuBar = function() {
-  this.node.addEventListener("keydown", this.keyDown.bind(this))
-}
-
-// Ariato defines role="menubar" but MenuBar in camel case is nicer
-Ariato.Menubar = Ariato.MenuBar
-
-Ariato.Menubar.prototype.keyDown = function(event) {
-  switch (event.key) {
-    case "ArrowDown":
-      event.preventDefault()
-      if (event.target.hasAttribute("aria-haspopup"))
-        this.openItem(event.target)
-      else
-        this.focusNextItem(event.target)
-      break
-    case "ArrowUp":
-      event.preventDefault()
-      if (event.target.hasAttribute("aria-haspopup"))
-        this.openItem(event.target)
-      else
-        this.focusPreviousItem(event.target)
-      break
-    case "ArrowRight":
-      // Open parent next menu
-      // Open child menu
-      // Focus next item
-      this.openNextMenu(event.target)
-      break
-      if (event.target.hasAttribute("aria-haspopup"))
-        this.openItem(event.target)
-      else
-        this.openNextMenu(this.findParentMenu(event.target))
-    case "ArrowLeft":
-      this.openPreviousMenu(event.target)
-      break
-    case "Escape":
-      this.closeAllExcept()
-      break
-  }
-}
-
-Ariato.Menubar.prototype.closeAllExcept = function(item) {
-  var menus = this.node.querySelectorAll("[role=menu]")
-  for (var i = 0; i < menus.length; i++)
-    menus[i].style.display = menus[i].contains(item) ? "block" : null
-}
-
-Ariato.Menubar.prototype.openItem = function(item) {
-  var menu = item.parentElement.querySelector("[role=menu]")
-  item.setAttribute("aria-expanded", true)
-  var subItem = menu.querySelector("[role=menuitem]")
-  if (subItem) {
-    this.closeAllExcept(subItem)
-    subItem.focus()
-  } else {
-    this.closeAllExcept(item)
-    item.focus()
-  }
-}
-
-Ariato.Menubar.prototype.openNextMenu = function(item) {
-  var menu = this.findNextMenu(item)
-  menu && this.openItem(menu.parentElement.querySelector("[role=menuitem]"))
-}
-
-Ariato.Menubar.prototype.openPreviousMenu = function(item) {
-  var menu = this.findPreviousMenu(item)
-  menu && this.openItem(menu.parentElement.querySelector("[role=menuitem]"))
-}
-
-Ariato.Menubar.prototype.focusNextItem = function(item) {
-  var nextItem = this.findNextItem(item)
-  nextItem && nextItem.focus()
-}
-
-Ariato.Menubar.prototype.focusPreviousItem = function(item) {
-  var previousItem = this.findPreviousItem(item)
-  previousItem && previousItem.focus()
-}
-
-Ariato.Menubar.prototype.findParentMenu = function(item) {
-  var parent = item.parentElement
-  var menuRoles = ["menu", "menubar"]
-  while (parent && !menuRoles.includes(parent.getAttribute("role")))
-    parent = parent.parentElement
-  return parent
-}
-
-Ariato.Menubar.prototype.findNextItem = function(item) {
-  var menu = this.findParentMenu(item)
-  var items = menu.querySelectorAll("[role=menuitem]")
-  for (var i = 0; i < items.length; i++)
-    if (items[i] == item)
-      return items[i+1]
-}
-
-Ariato.Menubar.prototype.findPreviousItem = function(item) {
-  var menu = this.findParentMenu(item)
-  var items = menu.querySelectorAll("[role=menuitem]")
-  for (var i = 0; i < items.length; i++)
-    if (items[i] == item)
-      return items[i-1]
-}
-
-Ariato.Menubar.prototype.findNextMenu = function(item) {
-  var menus = this.rootMenus()
-  for (var i = 0; i < menus.length; i++)
-    if (menus[i].contains(item))
-      return menus[i+1]
-
-  var parent = item.parentElement
-  for (var i = 0; i < menus.length; i++)
-    if (parent.contains(menus[i]))
-      return menus[i+1]
-}
-
-Ariato.Menubar.prototype.findPreviousMenu = function(item) {
-  var menus = this.rootMenus()
-  for (var i = 0; i < menus.length; i++)
-    if (menus[i].contains(item))
-      return menus[i-1]
-
-  var parent = item.parentElement
-  for (var i = 0; i < menus.length; i++)
-    if (parent.contains(menus[i]))
-      return menus[i-1]
-}
-
-Ariato.Menubar.prototype.rootMenus = function() {
-  return this.node.querySelectorAll("li > [role=menu]")
-}
-
 Ariato.MenuButton = function(node) {
   this.node = this.button = node
   this.menu = document.getElementById(this.button.getAttribute("aria-controls"))
@@ -583,164 +319,4 @@ Ariato.Menu = function(node) {
 
 Ariato.Menu.prototype.labelledBy = function() {
   return document.getElementById(this.node.getAttribute("aria-labelledby"))
-}
-
-/*
- * A region is a role="region" element which represents a panel of an accordion.
- * It is controlled by a button.
- */
-Ariato.Region = function(node) {
-  this.node = node
-  var labelledBy = this.labelledBy()
-  
-  if (!labelledBy)
-    return
-
-  this.accordion = Ariato.Accordion.addRegion(this)
-  labelledBy.addEventListener("click", this.buttonClicked.bind(this))
-}
-
-Ariato.Region.prototype.labelledBy = function() {
-  return document.getElementById(this.node.getAttribute("aria-labelledby"))
-}
-
-Ariato.Region.prototype.buttonClicked = function(event) {
-  this.accordion.showRegion(this)
-}
-
-Ariato.Region.prototype.show = function(event) {
-  this.labelledBy().setAttribute("aria-expanded", true)
-  this.node.removeAttribute("hidden")
-}
-
-Ariato.Region.prototype.hide = function(event) {
-  this.labelledBy().setAttribute("aria-expanded", false)
-  this.node.setAttribute("hidden", "")
-}
-
-Ariato.Region.prototype.expanded = function() {
-  return !this.node.hasAttribute("hidden")
-}
-
-Ariato.Tablist = function(node) {
-  this.node = node
-  var tabs = this.tabs()
-  for (var i = 0; i < tabs.length; i++) {
-    tabs[i].addEventListener("click", this.click.bind(this))
-    tabs[i].addEventListener("keydown", this.keydown.bind(this))
-    tabs[i].addEventListener("keyup", this.keyup.bind(this))
-  }
-  tabs[0] && this.showTab(tabs[0])
-}
-
-Ariato.Tablist.prototype.click = function(event) {
-  this.showTab(event.currentTarget)
-}
-
-Ariato.Tablist.prototype.tabs = function() {
-  return this.node.querySelectorAll("[role=tab]")
-}
-
-Ariato.Tablist.prototype.activeTab = function() {
-  return this.node.querySelector("[aria-selected=true]")
-}
-
-Ariato.Tablist.prototype.panels = function() {
-  var tabs = this.tabs(), result = []
-  for (var i = 0; i < tabs.length; i++)
-    result.push(document.getElementById(tabs[i].getAttribute("aria-controls")))
-  return result
-}
-
-Ariato.Tablist.prototype.showTab = function(tab) {
-  this.hidePanels()
-  tab.removeAttribute("tabindex")
-  tab.setAttribute("aria-selected", "true")
-  document.getElementById(tab.getAttribute("aria-controls")).style.display = null
-  tab.focus()
-}
-
-Ariato.Tablist.prototype.hidePanels = function() {
-  var tabs = this.tabs()
-  for (var i = 0; i < tabs.length; i++) {
-    tabs[i].setAttribute("tabindex", "-1");
-    tabs[i].setAttribute("aria-selected", "false");
-  }
-
-  var panels = this.panels()
-  for (var i = 0; i < panels.length; i++)
-    panels[i].style.display = "none"
-}
-
-Ariato.Tablist.prototype.keydown = function(event) {
-  switch (event.key) {
-    case "End":
-      var tabs = this.tabs()
-      event.preventDefault()
-      this.showTab(this.tabs()[tabs.length - 1])
-      break
-    case "Home":
-      event.preventDefault()
-      this.showTab(this.tabs()[0])
-      break
-    case "ArrowUp":
-      event.preventDefault()
-      this.showPrevious()
-      break
-    case "ArrowDown":
-      event.preventDefault()
-      this.showNext()
-      break
-  }
-}
-
-Ariato.Tablist.prototype.keyup = function(event) {
-  if (event.key == "ArrowLeft")
-    this.showPrevious()
-  else if (event.key == "ArrowRight")
-    this.showNext(event)
-  // TODO delete
-}
-
-Ariato.Tablist.prototype.showNext = function() {
-  var tabs = this.tabs()
-  var index = Array.prototype.indexOf.call(tabs, this.activeTab())
-  tabs[index + 1] && this.showTab(tabs[index + 1])
-}
-
-Ariato.Tablist.prototype.showPrevious = function() {
-  var tabs = this.tabs()
-  var index = Array.prototype.indexOf.call(tabs, this.activeTab())
-  tabs[index - 1] && this.showTab(tabs[index - 1])
-}
-
-Ariato.ThemeSwitcher = function() {
-  Ariato.ThemeSwitcher.initialize()
-  this.node.addEventListener("click", this.change.bind(this))
-}
-
-Ariato.ThemeSwitcher.initialize = function() {
-  if (!this.initialized) {
-    console.log("initialize")
-    this.initialized = true
-    this.update()
-  }
-}
-
-Ariato.ThemeSwitcher.update = function() {
-  var name = localStorage.getItem("ariato-theme")
-  document.documentElement.classList.forEach(function(theme) {
-    theme.startsWith("theme-") && document.documentElement.classList.remove(theme)
-  })
-  document.documentElement.classList.add("theme-" + name)
-
-  var buttons = document.querySelectorAll("[data-ariato='ThemeSwitcher']")
-  for (var i = 0; i < buttons.length; i++)
-    buttons[i].setAttribute("aria-pressed", buttons[i].getAttribute("data-theme") == name)
-}
-
-Ariato.ThemeSwitcher.prototype.change = function(event) {
-  var name = event.currentTarget.getAttribute("data-theme")
-  localStorage.setItem("ariato-theme", name)
-  name && Ariato.ThemeSwitcher.update(name)
 }