impressionist-cody 2.0.0

data/spec/controllers/widgets_controller_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe WidgetsController do
+  before do
+    @widget = Widget.find(1)
+    allow(Widget).to receive(:find).and_return(@widget)
+  end
+
+  it "logs impression at the per action level" do
+    get :show, params: { id: 1 }
+    expect(Impression.all.size).to eq 12
+
+    get :index
+
+    expect(Impression.all.size).to eq 13
+
+    get :new
+
+    expect(Impression.all.size).to eq 13
+  end
+
+  it "does not log impression when user-agent is in wildcard list" do
+    request.env['HTTP_USER_AGENT'] = 'somebot'
+
+    get :show, params: { id: 1 }
+    expect(Impression.all.size).to eq 11
+  end
+
+  it "does not log impression when user-agent is in the bot list" do
+    request.env['HTTP_USER_AGENT'] = 'Acoon Robot v1.50.001'
+
+    get :show, params: { id: 1 }
+    expect(Impression.all.size).to eq 11
+  end
+
+  context "impressionist unique options" do
+    it "logs unique impressions at the per action level" do
+      get :show, params: { id: 1 }
+      expect(Impression.all.size).to eq 12
+      get :show, params: { id: 2 }
+      expect(Impression.all.size).to eq 13
+      get :show, params: { id: 2 }
+      expect(Impression.all.size).to eq 13
+      get :index
+      expect(Impression.all.size).to eq 14
+    end
+
+    it "logs unique impressions only once per id" do
+      get :show, params: { id: 1 }
+      expect(Impression.all.size).to eq 12
+      get :show, params: { id: 2 }
+      expect(Impression.all.size).to eq 13
+
+      get :show, params: { id: 2 }
+      expect(Impression.all.size).to eq 13
+
+      get :index
+      expect(Impression.all.size).to eq 14
+    end
+  end
+
+  context "Impresionist unique params options" do
+    it "logs unique impressions at the per action and params level" do
+      get :show, params: { id: 1 }
+      expect(Impression.all.size).to eq 12
+
+      get :show, params: { id: 2, checked: true }
+      expect(Impression.all.size).to eq 13
+
+      get :show, params: { id: 2, checked: false }
+      expect(Impression.all.size).to eq 14
+
+      get :index
+      expect(Impression.all.size).to eq 15
+    end
+
+    it "does not log impression for same params and same id" do
+      get :show, params: { id: 1 }
+      expect(Impression.all.size).to eq 12
+
+      get :show, params: { id: 1 }
+      expect(Impression.all.size).to eq 12
+
+      get :show, params: { id: 1, checked: true }
+      expect(Impression.all.size).to eq 13
+
+      get :show, params: { id: 1, checked: false }
+      expect(Impression.all.size).to eq 14
+
+      get :show, params: { id: 1, checked: true }
+      expect(Impression.all.size).to eq 14
+
+      get :show, params: { id: 1, checked: false }
+      expect(Impression.all.size).to eq 14
+
+      get :show, params: { id: 1 }
+      expect(Impression.all.size).to eq 14
+
+      get :show, params: { id: 2 }
+      expect(Impression.all.size).to eq 15
+    end
+  end
+end

data/spec/counter_caching_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Impression do
+  fixtures :widgets
+
+  let(:widget) { Widget.find(1) }
+
+  before do
+    described_class.destroy_all
+  end
+
+  describe "self#impressionist_counter_caching?" do
+    it "knows when counter caching is enabled" do
+      expect(Widget).to be_impressionist_counter_caching
+    end
+
+    it "knows when counter caching is disabled" do
+      expect(Article).not_to be_impressionist_counter_caching
+    end
+  end
+
+  describe "self#counter_caching?" do
+    it "knows when counter caching is enabled" do
+      allow(ActiveSupport::Deprecation).to receive(:warn)
+      expect(Widget).to be_counter_caching
+    end
+
+    it "knows when counter caching is disabled" do
+      allow(ActiveSupport::Deprecation).to receive(:warn)
+      expect(Article).not_to be_counter_caching
+    end
+  end
+
+  describe "#update_impressionist_counter_cache" do
+    it "updates the counter cache column to reflect the correct number of impressions" do
+      expect do
+        widget.impressions.create(:request_hash => 'abcd1234')
+        widget.reload
+      end.to change(widget, :impressions_count).from(0).to(1)
+    end
+
+    it "does not update the timestamp on the impressable" do
+      expect do
+        widget.impressions.create(:request_hash => 'abcd1234')
+        widget.reload
+      end.not_to change(widget, :updated_at)
+    end
+  end
+end

data/spec/dummy/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link application.css

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,22 @@
+class ArticlesController < ApplicationController
+  if Rails::VERSION::MAJOR >= 5
+    before_action :test_current_user_var
+  else
+    before_filter :test_current_user_var
+  end
+
+  def test_current_user_var
+    if session[:user_id]
+      @current_user = User.new
+      @current_user.id = session[:user_id]
+    end
+  end
+
+  def index
+    impressionist(Article.first,"this is a test article impression")
+  end
+
+  def show
+    impressionist(Article.first)
+  end
+end

data/spec/dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,6 @@
+# This controller imports the impressionist module to make the modules methods available for testing
+class DummyController < ApplicationController
+  impressionist
+
+  def index; end
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,23 @@
+class PostsController < ApplicationController
+  helper_method :current_user
+  impressionist
+  def index
+
+  end
+
+  def show
+
+  end
+
+  def edit
+
+  end
+
+  def current_user
+    if session[:user_id]
+      user = User.new
+      user.id = session[:user_id]
+      @current_user ||= user
+    end
+  end
+end

data/spec/dummy/app/controllers/profiles_controller.rb

@@ -0,0 +1,14 @@
+class ProfilesController < ApplicationController
+  helper_method :current_user
+
+  def show
+  end
+
+  def current_user
+    if session[:user_id]
+      user = User.new
+      user.id = session[:user_id]
+      @current_user ||= user
+    end
+  end
+end

data/spec/dummy/app/controllers/widgets_controller.rb

@@ -0,0 +1,12 @@
+class WidgetsController < ApplicationController
+  impressionist :actions=>[:show, :index], :unique => [:controller_name, :action_name, :impressionable_id, :params]
+
+  def show
+  end
+
+  def index
+  end
+
+  def new
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  is_impressionable
+end

data/spec/dummy/app/models/dummy.rb

@@ -0,0 +1,7 @@
+# We don't really care about this model. It's just being used to test the uniqueness controller
+# specs. Nevertheless, we need a model because the counter caching functionality expects it.
+#
+class Dummy < ActiveRecord::Base
+  self.abstract_class = true # doesn't need to be backed by an actual table
+  is_impressionable
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  is_impressionable
+end

data/spec/dummy/app/models/profile.rb

@@ -0,0 +1,6 @@
+class Profile < ActiveRecord::Base
+  extend FriendlyId
+
+  friendly_id :username, use: :slugged
+  is_impressionable
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User
+  attr_accessor :id
+end

data/spec/dummy/app/models/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ActiveRecord::Base
+  is_impressionable :counter_cache => true, :unique => :request_hash
+end

data/spec/dummy/app/views/articles/index.html.erb

@@ -0,0 +1 @@
+<%=@impressionist_hash==nil%>

data/spec/dummy/app/views/articles/show.html.erb

@@ -0,0 +1 @@
+<%=link_to "Same Page", article_url(Article.first)%>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/app/views/profiles/show.html.erb

@@ -0,0 +1,3 @@
+<h2>User Public Profile</h2>
+
+<p>User Name: <%= @profile.username %></p>

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,20 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+# FIXME
+require "impressionist"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite. Versions 3.8.0 and up are supported.
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,62 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end