ahoy-views 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7833368548e41179bc7ae7697fde7102958f3dfc65f6cd76b1cafeb485533626
+  data.tar.gz: 1c7bc67cb59b0dea5ffd44f3c6255e369ae4fbbafe0160e19297614c361df754
+SHA512:
+  metadata.gz: abf402fecadcdb107dd623087b64649c43e7805c48fea51b3c2e86a70194ef17510eb9f529b47a4bbc142764749e9eb2ced9b785ec52acc3be33af06fe5f112d
+  data.tar.gz: 984ec5a5004c3a50fb2be4a25c35ce28824b1fec28553ff182720953dbeba262216584f328ccde01e74e9c5f90b61ddc3a4d4c209075090c4db61eea12906d96

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/13
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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,209 @@
+# Ahoy Views
+
+[![Gem Version](https://badge.fury.io/rb/ahoy-views.svg)](https://badge.fury.io/rb/ahoy-views) <img src="https://travis-ci.org/jonhue/ahoy-views.svg?branch=master" />
+
+Track views of ActiveRecord objects in Rails. Ahoy Views depends on [Ahoy](https://github.com/ankane/ahoy).
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Tracking](#tracking)
+        * [Types](#types)
+    * [`ahoy_viewable`](#ahoy_viewable)
+    * [`ahoy_viewer`](#ahoy_viewer)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+**Note:** Before installing Ahoy Views make sure to setup the original [Ahoy](https://github.com/ankane/ahoy) gem.
+
+Ahoy Views works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'ahoy-views'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ahoy_views
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'ahoy-views', github: 'jonhue/ahoy-views'
+```
+
+Now run the generator:
+
+    $ rails g ahoy_views
+
+Lastly make sure to call `ahoy_views` from your `Ahoy::Event` class:
+
+```ruby
+module Ahoy
+    class Event < ApplicationRecord
+        ahoy_views
+    end
+end
+```
+
+---
+
+## Usage
+
+### Tracking
+
+You can track views for ActiveRecord objects from your controllers:
+
+```ruby
+class ArticleController < ApplicationController
+
+    def index
+        @articles = Article.all
+        ahoy_view @articles
+    end
+
+    def show
+        @article = Article.find params[:id]
+        ahoy_view @article
+    end
+
+end
+```
+
+**Note:** This will create an `Ahoy::Event` object for every record passed.
+
+The `current_visit` object, if present, will be automatically associated with every visit.
+
+You are also able to associate other records with views. [Learn more](#ahoy_viewer).
+
+#### Types
+
+You can pass an array of `types` to `ahoy_view`. Types allow you to track multiple types of visits. The `:types` option defaults to `[:visit]`.
+
+```ruby
+ahoy_view @article, types: [:view, :visitor, :returnee, :unique_visitor, :unique_returnee]
+```
+
+Here is a list of available types:
+
+* `:visit` stores every call to `ahoy_view` for an object.
+
+* `:visitor` stores only one call per visit to `ahoy_view`.
+
+* `:returnee` ...
+
+* `:unique_visitor` ...
+
+* `:unique_returnee` ...
+
+### `ahoy_viewable`
+
+Add `ahoy_viewable` to an ActiveRecord class.
+
+```ruby
+class Article < ApplicationRecord
+    ahoy_viewable
+end
+
+a = Article.first
+
+# All belonging Ahoy::Event objects that are a view
+a.ahoy_views
+
+# All viewer records that have a view object
+a.ahoy_viewers
+
+# Scope to order Article records by views
+Article.trending
+
+# Whether or not a is one of the 5 "most trending" articles
+a.trending? 5
+```
+
+### `ahoy_viewer`
+
+Add `ahoy_viewer` to an ActiveRecord class.
+
+```ruby
+class User < ApplicationRecord
+    ahoy_viewer
+end
+
+u = User.first
+
+# All belonging Ahoy::Event objects that are a view
+u.ahoy_visits
+
+# All records that this user has taken a look at
+u.ahoy_viewed
+```
+
+Here is how to associate a viewer with a view:
+
+```ruby
+ahoy_view @article, viewer: current_user
+```
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/ahoy-views/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/ahoy-views/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to Ahoy Views. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/ahoy-views/graphs/contributors
+
+### Semantic Versioning
+
+Ahoy Views follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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/lib/ahoy-views.rb

@@ -0,0 +1,14 @@
+require 'ahoy/views/version'
+
+module Ahoy
+    module Views
+
+        autoload :View, 'ahoy/views/view'
+        autoload :Viewable, 'ahoy/views/viewable'
+        autoload :Viewer, 'ahoy/views/viewer'
+        autoload :Views, 'ahoy/views/views'
+
+        require 'ahoy/views/railtie'
+
+    end
+end

data/lib/ahoy/views/railtie.rb

@@ -0,0 +1,23 @@
+require 'rails/railtie'
+
+module Ahoy
+    module Views
+        class Railtie < Rails::Railtie
+
+            initializer 'ahoy-views.active_record' do
+                ActiveSupport.on_load :active_record do
+                    include Ahoy::Views::Views
+                    include Ahoy::Views::Viewer
+                    include Ahoy::Views::Viewable
+                end
+            end
+
+            initializer 'ahoy-views.action_controller' do
+                ActiveSupport.on_load :action_controller do
+                    include Ahoy::Views::View
+                end
+            end
+
+        end
+    end
+end

data/lib/ahoy/views/version.rb

@@ -0,0 +1,7 @@
+module Ahoy
+    module Views
+
+        VERSION = '1.0.0'
+
+    end
+end

data/lib/ahoy/views/view.rb

@@ -0,0 +1,35 @@
+module Ahoy
+    module Views
+        module View
+
+            extend ActiveSupport::Concern
+
+            def ahoy_view objects, options = {}
+                defaults = {
+                    types: [:view],
+                    viewer: nil
+                }
+                options = defaults.merge! options
+
+                if current_visit
+                    if objects.kind_of? Array
+                        objects.each do |object|
+                            track_ahoy_view object, options[:types], options[:viewer]
+                        end
+                    else
+                        track_ahoy_view objects, options[:types], options[:viewer]
+                    end
+                end
+            end
+
+            private
+
+            def track_ahoy_view object, types, viewer
+                types.each do |name|
+                    ahoy.track name, visited: object, visitor: viewer, visit: current_visit
+                end
+            end
+
+        end
+    end
+end

data/lib/ahoy/views/viewable.rb

@@ -0,0 +1,30 @@
+module Ahoy
+    module Views
+        module Viewable
+
+            extend ActiveSupport::Concern
+
+            module ClassMethods
+
+                def ahoy_viewable
+                    has_many :ahoy_views, as: :visited, class_name: 'Ahoy::Event'
+                    has_many :ahoy_viewers, through: :ahoy_views, source: :visitor
+
+                    scope :trending, -> { left_joins(:views).group(:id).order('count(views.id) desc') }
+
+                    include Ahoy::Views::Viewable::InstanceMethods
+                end
+
+            end
+
+            module InstanceMethods
+
+                def trending? limit
+                    self.class.trending.limit(limit).include? self
+                end
+
+            end
+
+        end
+    end
+end

data/lib/ahoy/views/viewer.rb

@@ -0,0 +1,18 @@
+module Ahoy
+    module Views
+        module Viewer
+
+            extend ActiveSupport::Concern
+
+            module ClassMethods
+
+                def ahoy_viewer
+                    has_many :ahoy_visits, as: :visitor, class_name: 'Ahoy::Event'
+                    has_many :ahoy_viewed, through: :ahoy_visits, source: :visited
+                end
+
+            end
+
+        end
+    end
+end

data/lib/ahoy/views/views.rb

@@ -0,0 +1,50 @@
+module Ahoy
+    module Views
+        module Views
+
+            extend ActiveSupport::Concern
+
+            module ClassMethods
+
+                def ahoy_views
+                    before_create :process_view
+
+                    belongs_to :visitor, polymorphic: true, optional: true
+                    belongs_to :visited, polymorphic: true, optional: true
+
+                    scope :appearances, -> { where name: 'appearance' }
+                    scope :views, -> { where name: 'view' }
+                    scope :visitors, -> { where name: 'visitor' }
+                    scope :returnees, -> { where name: 'returnee' }
+                    scope :visited_in_session, -> (visit) { where visit_id: visit.id }
+                    scope :visited, -> (visitor) { where visitor_id: visitor.id, visitor_type: visitor.class.name }
+
+                    include Ahoy::Views::Views::InstanceMethods
+                end
+
+            end
+
+            module InstanceMethods
+
+                private
+
+                def process_view
+                    if self.visited && self.name
+                        case self.name
+                        when 'visitor'
+                            return false if self.class.visitors.visited_in_session(self.visit).where(visited_id: visited.id, visited_type: visited.class.name).any?
+                        when 'returnee'
+                            return false if self.class.returnees.visited_in_session(self.visit).where(visited_id: visited.id, visited_type: visited.class.name).any? && !self.class.visited(self.visitor).where(visited_id: visited.id, visited_type: visited.class.name).any?
+                        when 'unique_visitor'
+                            return false if self.class.visitors.visited(self.visitor).where(visited_id: visited.id, visited_type: visited.class.name).any?
+                        when 'unique_returnee'
+                            return false if self.class.returnees.visited(self.visitor).where(visited_id: visited.id, visited_type: visited.class.name).any? && !self.class.visited(self.visitor).where(visited_id: visited.id, visited_type: visited.class.name).any?
+                        end
+                    end
+                end
+
+            end
+
+        end
+    end
+end

data/lib/generators/ahoy_views_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AhoyViewsGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install ahoy-views'
+
+    def self.next_migration_number dirname
+        if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime '%Y%m%d%H%M%S'
+        else
+            "%.3d" % (current_migration_number(dirname) + 1)
+        end
+    end
+
+    def create_migration_file
+        migration_template 'migration.rb.erb', 'db/migrate/ahoy_views_migration.rb', migration_version: migration_version
+    end
+
+    def show_readme
+        readme 'README.md'
+    end
+
+    private
+
+    def migration_version
+        if Rails.version >= '5.0.0'
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+    end
+
+end

data/lib/generators/templates/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add ahoy-views to your database.

data/lib/generators/templates/migration.rb.erb

@@ -0,0 +1,8 @@
+class AhoyViewsMigration < ActiveRecord::Migration<%= migration_version %>
+    def change
+        add_column :ahoy_events, :visitor_id, :bigint, index: true
+        add_column :ahoy_events, :visitor_type, :string, index: true
+        add_column :ahoy_events, :visited_id, :bigint, index: true
+        add_column :ahoy_events, :visited_type, :string, index: true
+    end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: ahoy-views
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ahoy_matey
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Track views of ActiveRecord objects in Rails.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/ahoy-views.rb
+- lib/ahoy/views/railtie.rb
+- lib/ahoy/views/version.rb
+- lib/ahoy/views/view.rb
+- lib/ahoy/views/viewable.rb
+- lib/ahoy/views/viewer.rb
+- lib/ahoy/views/views.rb
+- lib/generators/ahoy_views_generator.rb
+- lib/generators/templates/README.md
+- lib/generators/templates/migration.rb.erb
+homepage: https://github.com/jonhue/ahoy-views
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Track views of ActiveRecord objects in Rails
+test_files: []