paulie_lombardo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb56753c7d4d30bcaa0d23a1e7ee369f5f5e4d9eca7c273a6b0f19075826894b
+  data.tar.gz: 31773ebb1fc6ce4596166bebdef54ea91f1fd13a56f947493d19853355dda7cf
+SHA512:
+  metadata.gz: fa1f3c6fbb13b13de3d86febd773a4e7cda4c761930ea414c43d4e6eb5a786e4936ecc7000d71e721cb31a8ea633b282c120b7ec8465b1e49e796050641313bb
+  data.tar.gz: 6b96d4d26951d97abb621a8d0f514ca7273c63423f0324a30a6f4715f536ae4b9c03d9d5f3506b7ff90cd5e9ca1914231dc65284810a305270a545e1a50af6fe

data/lib/generators/paulie_lombardo/active_record/active_record_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module PaulieLombardo
+  module Generators
+    # Creating the migration file for the paulie_notes table.
+    class ActiveRecordGenerator < Rails::Generators::Base
+      # Provides ActiveRecord implementation of #next_migration_number for #migration_template
+      include ::ActiveRecord::Generators::Migration
+
+      argument :tables, type: :array, default: []
+
+      source_root File.join(File.dirname(__FILE__), "templates")
+
+      def validate_tables_exist
+        return if tables.empty?
+
+        connection = ActiveRecord::Base.connection
+
+        tables.each do |table_name|
+          name = table_name.tableize
+
+          unless connection.table_exists?(name)
+            msg = set_color("Error: Table '#{name}' does not exist in the database.", :red, :bold)
+            raise Thor::Error, msg
+          end
+        end
+      end
+
+      def create_migration_file
+        migration_template "create_paulie_notes_table.rb.erb", "db/migrate/create_paulie_notes.rb"
+      end
+
+      def add_counter_cache_fields_to_tables
+        return if tables.empty?
+
+        migration_template "add_paulie_notes_count_to_tables.rb.erb", "db/migrate/add_paulie_notes_count.rb"
+      end
+    end
+  end
+end

data/lib/generators/paulie_lombardo/install/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  module Generators
+    # Primary setup generator for installing the gem into a Rails app
+    class InstallGenerator < Rails::Generators::Base
+      argument :tables, type: :array, default: []
+
+      # Invokes the configured ORM generator (e.g., ActiveRecord) to create migrations
+      hook_for :orm, required: true
+    end
+  end
+end

data/lib/generators/paulie_lombardo/mongoid/mongoid_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  module Generators
+    # Stub generator for Mongoid ORM implementation
+    class MongoidGenerator < Rails::Generators::Base
+      def create_migration_file
+        say_status :warning, "Mongoid support requires implementation for paulie_lombardo.", :yellow
+        say "   Currently, automatic document/migration generation for Mongoid is not supported.", :yellow
+      end
+    end
+  end
+end

data/lib/generators/paulie_lombardo/sequel/sequel_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  module Generators
+    # Stub generator for Sequel ORM implementation
+    class SequelGenerator < Rails::Generators::Base
+      def create_migration_file
+        say_status :warning, "Sequel support requires implementation for paulie_lombardo.", :yellow
+        say "   Currently, automatic migration generation for Sequel is not supported.", :yellow
+      end
+    end
+  end
+end

data/lib/paulie_lombardo/consigliere.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  # The decision-making authority that decides
+  # whether a page view request should be approved and logged.
+  class Consigliere
+    def initialize(dossier)
+      @dossier = dossier
+    end
+
+    def approve?
+      no_prior_record?
+    end
+
+    private
+
+    # Checks if there are no previous records for the given visitor.
+    #
+    # Automatically handles collision/fingerprint overlaps
+    # multiple records with the same request_hash can coexist if they belong to different session_hashes
+    #
+    # @return [Boolean]
+    #   true if no record exists and a new one should be created
+    #   false if a record already exists
+    def no_prior_record?
+      # 1. Highest priority: if user is logged in, check purely by user_id
+      return PaulieNote.where(@dossier.user_profile).none? if @dossier.user_id.present?
+
+      # 2. If session_hash is blank, simply check existence via request_hash
+      return PaulieNote.where(@dossier.request_profile).none? if @dossier.session_hash.blank?
+
+      # 3. When session_hash present - returns false early if a matching record exists
+      return false if PaulieNote.where(@dossier.session_profile).exists?
+
+      # Finds a session-less record matching the request profile and links the current session_hash.
+      return false if session_attached?
+
+      true
+    end
+
+    def session_attached?
+      note = PaulieNote.find_by(@dossier.request_profile)
+      note&.update(session_hash: @dossier.session_hash)
+    end
+  end
+end

data/lib/paulie_lombardo/controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  # Adds controller methods
+  module Controller
+    # Creates a new paulie_note record
+    def paulie_note(*target)
+      PaulieLombardo.bouncer(self, *target) do |target, data|
+        target.paulie_notes.create!(data)
+      end
+    end
+  end
+end

data/lib/paulie_lombardo/dossier.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  # Build paulie_note attributes
+  class Dossier
+    attr_reader :data, :user_id, :interval, :target
+
+    def initialize(controller, target, scope = nil)
+      @request = controller.request
+      @session = controller.session
+      @user_id = user_id_from_warden
+      @target = identify_subject(target)
+      @interval = configured_interval(scope)
+
+      build
+    end
+
+    def request_hash
+      data[:request_hash]
+    end
+
+    def session_hash
+      data[:session_hash]
+    end
+
+    def request_profile
+      base_profile(request_hash: request_hash, session_hash: nil)
+    end
+
+    def session_profile
+      base_profile(session_hash: session_hash)
+    end
+
+    def user_profile
+      base_profile(user_id: user_id)
+    end
+
+    UUID_NAMESPACE = "9cac5761-c7b1-4c75-be24-1d4db88ac468"
+    private_constant :UUID_NAMESPACE
+
+    private
+
+    attr_reader :request
+
+    def build
+      @data = {
+        session_hash: generate_uuid(@session.id),
+        request_hash: generate_uuid(raw_string),
+        referrer: request.referrer
+      }
+
+      @data[:user_id] = user_id if user_id.present?
+    end
+
+    def generate_uuid(value)
+      return if value.blank?
+
+      Digest::UUID.uuid_v5(UUID_NAMESPACE, value.to_s)
+    end
+
+    def raw_string
+      ["request_hash",
+       request.user_agent,
+       request.accept_language,
+       mask_ip,
+       http_sec_ch_ua,
+       http_sec_ch_ua_platform,
+       http_sec_ch_ua_mobile].compact.join("/")
+    end
+
+    def mask_ip
+      addr = IPAddr.new(request.remote_ip)
+
+      if addr.ipv4?
+        addr.mask(24).to_s
+      else
+        addr.mask(48).to_s
+      end
+    end
+
+    def http_sec_ch_ua
+      request.headers["HTTP_SEC_CH_UA"]
+    end
+
+    def http_sec_ch_ua_platform
+      request.headers["HTTP_SEC_CH_UA_PLATFORM"]
+    end
+
+    def http_sec_ch_ua_mobile
+      request.headers["HTTP_SEC_CH_UA_MOBILE"]
+    end
+
+    def user_id_from_warden
+      warden = request.env["warden"]
+      return nil unless warden
+
+      warden.user(:user)&.id
+    end
+
+    def configured_interval(scope)
+      return scope if @target.is_a?(PaulieStaticPage)
+      return unless @target.respond_to?(:paulie_notes_options)
+
+      @target.paulie_notes_options[:interval]
+    end
+
+    def identify_subject(target)
+      target.is_a?(ActiveRecord::Base) ? target : PaulieStaticPage.new(target)
+    end
+
+    def base_profile(attributes)
+      attributes[:noteable_type] = @target.class.polymorphic_name
+      attributes[:noteable_id] = @target.id.to_s
+      attributes[:viewed_on] = Time.current.utc.to_date if interval == :daily
+      attributes
+    end
+  end
+end

data/lib/paulie_lombardo/model.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  # Adds 'has_paulie_notes' association to ActiveRecord models
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # rubocop:disable-next Naming/PredicatePrefix
+      def has_paulie_notes(interval: nil)
+        class_attribute :paulie_notes_options, default: {}
+        self.paulie_notes_options = { interval: interval }.freeze
+
+        has_many :paulie_notes, as: :noteable, dependent: :delete_all
+      end
+    end
+  end
+end

data/lib/paulie_lombardo/paulie_note.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Represents an individual note record associated polymorphically with any model.
+class PaulieNote < ActiveRecord::Base
+  belongs_to :noteable, polymorphic: true, counter_cache: true
+
+  before_create :set_viewed_on
+
+  def noteable
+    if noteable_type == PaulieStaticPage.polymorphic_name
+      PaulieStaticPage.new(noteable_id)
+    else
+      super
+    end
+  end
+
+  private
+
+  def set_viewed_on
+    self.viewed_on ||= Time.current.utc.to_date
+  end
+end

data/lib/paulie_lombardo/paulie_static_page.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Represents a non-ActiveRecord target for polymorphic `PaulieNote` associations
+class PaulieStaticPage
+  attr_reader :id
+
+  def initialize(name)
+    @id = name.to_s.underscore
+  end
+
+  def self.polymorphic_name
+    name
+  end
+
+  # Emulates `has_many :paulie_notes` creation for non-ActiveRecord target
+  class AssociationProxy
+    def initialize(target)
+      @target = target
+    end
+
+    def create!(attributes = {})
+      PaulieNote.create!(
+        attributes.merge(
+          noteable_type: @target.class.polymorphic_name,
+          noteable_id: @target.id
+        )
+      )
+    end
+  end
+
+  def paulie_notes
+    AssociationProxy.new(self)
+  end
+
+  def paulie_notes_count
+    PaulieNote.where(noteable_type: self.class.polymorphic_name, noteable_id: id).count
+  end
+
+  # Stubs to prevent SQL execution and NoMethodError for the counter_cache column
+  #
+  # rubocop:disable-next Style/SingleLineMethods
+  # rubocop:disable-next Naming/PredicatePrefix
+  class << self
+    def unscoped; self; end
+    def where!(*); self; end
+    def primary_key; :id; end
+    def has_query_constraints?; false; end
+    def composite_primary_key?; false; end
+    def update_counters(*_args); 0 end
+  end
+end

data/lib/paulie_lombardo/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  # Railtie integration to automatically load Controller and Model concerns
+  # into Rails framework components upon initialization.
+  class Railtie < ::Rails::Railtie
+    initializer "paulie_lombardo.controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include PaulieLombardo::Controller
+      end
+    end
+
+    initializer "paulie_lombardo.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        include PaulieLombardo::Model
+      end
+    end
+  end
+end

data/lib/paulie_lombardo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PaulieLombardo
+  VERSION = "1.0.0"
+end

data/lib/paulie_lombardo.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "paulie_lombardo/paulie_static_page"
+require "paulie_lombardo/dossier"
+require "paulie_lombardo/controller"
+require "paulie_lombardo/paulie_note"
+require "paulie_lombardo/model"
+require "paulie_lombardo/consigliere"
+require "paulie_lombardo/railtie"
+
+# Main entry point for the PaulieLombardo
+module PaulieLombardo
+  def self.bouncer(*)
+    dossier = Dossier.new(*)
+    consigliere = Consigliere.new(dossier)
+
+    paulie_note = yield(dossier.target, dossier.data) if consigliere.approve?
+
+    if paulie_note.present?
+      paulie_note.noteable
+    else
+      dossier.target
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: paulie_lombardo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sasha Stadnyk
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+description: |
+  Paulie is the silent mobster standing at the entrance
+  of your page, closely watching every visitor and logging it to the database"
+email: stadniklksndr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/paulie_lombardo/active_record/active_record_generator.rb
+- lib/generators/paulie_lombardo/install/install_generator.rb
+- lib/generators/paulie_lombardo/mongoid/mongoid_generator.rb
+- lib/generators/paulie_lombardo/sequel/sequel_generator.rb
+- lib/paulie_lombardo.rb
+- lib/paulie_lombardo/consigliere.rb
+- lib/paulie_lombardo/controller.rb
+- lib/paulie_lombardo/dossier.rb
+- lib/paulie_lombardo/model.rb
+- lib/paulie_lombardo/paulie_note.rb
+- lib/paulie_lombardo/paulie_static_page.rb
+- lib/paulie_lombardo/railtie.rb
+- lib/paulie_lombardo/version.rb
+homepage: https://github.com/stadniklksndr/paulie_lombardo
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/stadniklksndr/paulie_lombardo
+  changelog_uri: https://github.com/stadniklksndr/paulie_lombardo/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.19
+specification_version: 4
+summary: Ruby on Rails page view counter
+test_files: []