rails_view_counter 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68f292167e4cdd05f97668402c13874c8430c72576617db238fed93300406b32
+  data.tar.gz: d548e125c5f634c57b6d52b1bba9f8a8d5985663f6c256921b61848fb64d03dc
+SHA512:
+  metadata.gz: 47a42521d810b3100054ab638ec6f4567a753977d031cd9b0bd2231a7fe688c5defa58656291ff3dab09f7b48e23c24d3bad455b89241e2b12f3ccb5c5c7c58a
+  data.tar.gz: 0125db9783a615d06b5be8c0f039b910979b549def60f57ed75115241b16b1227019dd4dfe5ed0bd979717346435352d3fc5c16e8c24065b15a5fae7ebddaafe

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright aric.zheng
+
+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,49 @@
+# rails_view_counter
+> A Rails gem for tracking and managing view counts with IP limiting.
+
+## Usage
+```sh
+rails generate rails_view_counter:install
+rails generate rails_view_counter:migration posts
+rails db:migrate
+```
+```rb
+# config/initializers/rails_view_counter.rb
+RailsViewCounter.configure do |config|
+  config.ip_limit_duration = 2.hours
+  config.enable_ip_limit = true
+  config.log_views = true
+end
+
+
+class Post < ApplicationRecord
+  # 自动包含 ViewCounter::ModelAdditions
+  validates :title, presence: true
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_view_counter"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_view_counter
+```
+
+## Resources
+- https://chat.qwen.ai/c/b1a1ea17-4937-48df-abf0-81be548e3d89
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/rails_view_counter/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/app/controllers/rails_view_counter/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsViewCounter
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/rails_view_counter/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsViewCounter
+  module ApplicationHelper
+  end
+end

data/app/jobs/rails_view_counter/application_job.rb

@@ -0,0 +1,4 @@
+module RailsViewCounter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_view_counter/application_mailer.rb

@@ -0,0 +1,6 @@
+module RailsViewCounter
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/rails_view_counter/application_record.rb

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

data/app/views/layouts/rails_view_counter/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails view counter</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "rails_view_counter/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RailsViewCounter::Engine.routes.draw do
+end

data/lib/generators/rails_view_counter/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module RailsViewCounter
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generates Rails View Counter initializer'
+
+    def copy_initializer
+      template 'initializer.rb', 'config/initializers/rails_view_counter.rb'
+    end
+
+    private
+
+    def source_paths
+      [File.expand_path('../templates', __dir__)]
+    end
+  end
+end

data/lib/generators/rails_view_counter/migration_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module RailsViewCounter
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    
+    source_root File.expand_path('../templates', __dir__)
+    desc 'Generates migration for adding view counter to a model'
+
+    argument :table_name, type: :string, required: true, desc: 'Table name to add view counter to'
+
+    def create_migration_file
+      # 确保表名是复数形式
+      plural_table_name = table_name.pluralize
+      migration_template 'migration.rb', 
+                        "db/migrate/add_view_counter_to_#{plural_table_name}.rb"
+    end
+
+    private
+
+    def source_paths
+      [File.expand_path('../templates', __dir__)]
+    end
+
+    # 必需的方法：返回下一个可用的迁移版本号
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,14 @@
+# generators/templates/initializer.rb
+RailsViewCounter.configure do |config|
+  # IP 限制时间间隔（默认1小时）
+  config.ip_limit_duration = 1.hour
+
+  # 是否启用 IP 限制
+  config.enable_ip_limit = true
+
+  # 是否记录详细访问日志
+  config.log_views = false
+
+  # 缓存存储方式
+  config.cache_store = :rails_cache
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,6 @@
+class AddViewCounterTo<%= table_name.camelize %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :<%= table_name %>, :view_count, :integer, default: 0
+    add_index :<%= table_name %>, :view_count
+  end
+end

data/lib/rails_view_counter/configuration.rb

@@ -0,0 +1,21 @@
+# lib/rails_view_counter/configuration.rb
+module RailsViewCounter
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :ip_limit_duration, :enable_ip_limit, :log_views, :cache_store
+
+    def initialize
+      @ip_limit_duration = 1.hour
+      @enable_ip_limit = true
+      @log_views = false
+      @cache_store = :rails_cache
+    end
+  end
+end

data/lib/rails_view_counter/controller_additions.rb

@@ -0,0 +1,24 @@
+module RailsViewCounter
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    def increment_view_count!(viewable, options = {})
+      ip_address = get_user_ip
+      viewable.increment_view_count!(ip_address, options)
+    end
+
+    private
+
+    def get_user_ip
+      # 优先使用 X-Forwarded-For 头（用于负载均衡器或代理）
+      forwarded_ips = request.headers['X-Forwarded-For']
+      if forwarded_ips.present?
+        # 取第一个 IP（客户端真实 IP）
+        forwarded_ips.split(',').first.strip
+      else
+        # 直接使用 remote_ip
+        request.remote_ip
+      end
+    end
+  end
+end

data/lib/rails_view_counter/engine.rb

@@ -0,0 +1,23 @@
+module RailsViewCounter
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsViewCounter
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+
+    initializer "rails_view_counter.active_record" do
+      ActiveSupport.on_load :active_record do
+        include RailsViewCounter::ModelAdditions
+      end
+    end
+
+    initializer "rails_view_counter.action_controller" do
+      ActiveSupport.on_load :action_controller do
+        include RailsViewCounter::ControllerAdditions
+      end
+    end
+  end
+end

data/lib/rails_view_counter/model_additions.rb

@@ -0,0 +1,74 @@
+# lib/rails_view_counter/model_additions.rb
+module RailsViewCounter
+  module ModelAdditions
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize :set_default_view_count, if: :new_record?
+    end
+
+    def increment_view_count!(ip_address = nil, options = {})
+      return false unless view_counter_enabled?
+      
+      if ip_address && should_count_view?(ip_address, options)
+        increment!(:view_count)
+        log_view(ip_address) if log_views_enabled?
+        true
+      else
+        false
+      end
+    end
+
+    def can_increment_view_count?(ip_address, options = {})
+      should_count_view?(ip_address, options)
+    end
+
+    private
+
+    def set_default_view_count
+      self.view_count ||= 0
+    end
+
+    def should_count_view?(ip_address, options = {})
+      return true unless ip_address
+      
+      # 获取配置
+      limit_duration = options[:limit_duration] || RailsViewCounter.configuration.ip_limit_duration
+      enable_ip_limit = options[:enable_ip_limit] || RailsViewCounter.configuration.enable_ip_limit
+      
+      return true unless enable_ip_limit
+
+      cache_key = generate_cache_key(ip_address)
+      
+      # 检查该 IP 是否在限制时间内已经访问过
+      if Rails.cache.read(cache_key)
+        return false # 不允许增加浏览次数
+      else
+        # 设置缓存，有效期为限制时间
+        Rails.cache.write(cache_key, true, expires_in: limit_duration)
+        return true # 允许增加浏览次数
+      end
+    end
+
+    def generate_cache_key(ip_address)
+      "#{self.class.name.downcase}_#{id}_#{normalize_ip(ip_address)}"
+    end
+
+    def normalize_ip(ip)
+      ip.gsub(/[.:]/, '_')
+    end
+
+    def view_counter_enabled?
+      true
+    end
+
+    def log_views_enabled?
+      RailsViewCounter.configuration.log_views
+    end
+
+    def log_view(ip_address)
+      # 如果需要记录访问日志，这里可以实现
+      # ViewCounter::ViewLog.create!(...)
+    end
+  end
+end

data/lib/rails_view_counter/version.rb

@@ -0,0 +1,3 @@
+module RailsViewCounter
+  VERSION = "1.0.1"
+end

data/lib/rails_view_counter.rb

@@ -0,0 +1,19 @@
+require "rails_view_counter/version"
+require "rails_view_counter/engine"
+require "rails_view_counter/model_additions"
+require "rails_view_counter/controller_additions"
+require "rails_view_counter/configuration"
+
+module RailsViewCounter
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/tasks/rails_view_counter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_view_counter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rails_view_counter
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- aric.zheng
+bindir: bin
+cert_chain: []
+date: 2025-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: A Rails gem for tracking and managing view counts with IP limiting and
+  cache optimization.
+email:
+- 1290657123@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_view_counter/application.css
+- app/controllers/rails_view_counter/application_controller.rb
+- app/helpers/rails_view_counter/application_helper.rb
+- app/jobs/rails_view_counter/application_job.rb
+- app/mailers/rails_view_counter/application_mailer.rb
+- app/models/rails_view_counter/application_record.rb
+- app/views/layouts/rails_view_counter/application.html.erb
+- config/routes.rb
+- lib/generators/rails_view_counter/install_generator.rb
+- lib/generators/rails_view_counter/migration_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/migration.rb
+- lib/rails_view_counter.rb
+- lib/rails_view_counter/configuration.rb
+- lib/rails_view_counter/controller_additions.rb
+- lib/rails_view_counter/engine.rb
+- lib/rails_view_counter/model_additions.rb
+- lib/rails_view_counter/version.rb
+- lib/tasks/rails_view_counter_tasks.rake
+homepage: https://js.work
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://js.work
+  source_code_uri: https://github.com/ariczheng/rails_view_counter
+  changelog_uri: https://github.com/ariczheng/rails_view_counter/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: A Rails gem for tracking and managing view counts with IP limiting.
+test_files: []