acts_as_active 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cbd00213b63afb3d4d25559eaa07f4055e6399a6970a6787ae39fb15836ea47
+  data.tar.gz: 55cc1dd443c1a269660177a6d97c369c22c6b9a312ac8f7e5214358843382d9a
+SHA512:
+  metadata.gz: dfa7ac68afbba0acee383721b9409add97fe339ecb37958d13d136fa0fff0d63589153f77f01805bca11faa0914eef2fe0e9ae44c66ef71eafad3145be9a2eff
+  data.tar.gz: 3a0ed275fcbd798ff021cc2689e0c54b5dc43cd1f212dd28f149cb3ef619ff394d126388408c31bc00625762bf266c1b7aef194f3866b8a8d9828376cf2db183

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Amit Leshed
+
+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,57 @@
+# ActsAsActive
+
+Acts As Active adds plug-and-play activity tracking to any ActiveRecord model, giving you instant daily stats, streak analytics, and heat-map–ready data.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add acts_as_active
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install acts_as_active
+```
+
+## Usage
+
+```ruby
+class Record < ApplicationRecord
+  acts_as_active on: [:create, :update],          # ➜ track different actions
+                 if:     -> { track_activity? },  # ➜ on different conditions
+                 unless: -> { skip_tracking? }
+end
+```
+
+```ruby
+record = Record.create!(title: "First draft")   # ➜ records activity for today
+record.update!(title: "Second draft")           # ➜ activity count for today = 2
+ 
+
+record.active_today?                # => true
+record.active_on?(Date.yesterday)   # => false
+record.activity_count(range: 1.day.ago..Date.today)
+# => 2   (two events in the last 24 h)
+
+
+record.heatmap(range: 1.week.ago..Date.today)
+# => { "2025-08-01" => 1, "2025-08-02" => 3, "2025-08-03" => 2 }
+
+record.longest_streak   # => 3   (e.g. active 1-3 Aug)
+record.current_streak   # => 2   (e.g. active 5-6 Aug, still “on a streak” today)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amitleshed/acts_as_active. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/amitleshed/acts_as_active/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActsAsActive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amitleshed/acts_as_active/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/acts_as_active/activable.rb

@@ -0,0 +1,91 @@
+require "active_support"
+require "active_support/concern"
+
+module ActsAsActive
+  extend ActiveSupport::Concern
+
+  included do
+    include InstanceMethods
+  end
+
+  class_methods do
+    SUPPORTED_EVENTS = %i[create update destroy].freeze
+
+    def acts_as_active(options = {})
+      has_many :activities, as: :trackable, class_name: "Activity"
+
+      events      = Array(options[:on] || SUPPORTED_EVENTS) & SUPPORTED_EVENTS
+      events.each do |ev|
+        after_commit on: ev do |_ignored|
+          should_run = true
+          should_run &&=  instance_exec(&options[:if])     if options[:if]
+          should_run &&= !instance_exec(&options[:unless]) if options[:unless]
+
+          record_activity! if should_run
+        end
+      end
+    end
+  end
+
+
+  def record_activity!(at: Time.current)
+    today    = at.to_date
+    activity = activities.find_or_initialize_by(occurred_on: today)
+  
+    activity.count ||= 0
+    activity.count  += 1
+    activity.save!
+  end
+end
+
+module InstanceMethods
+  def active_today?
+    self.activities.find_by(occurred_on: Time.current.to_date).present?
+  end
+
+  def active_on?(date)
+    self.activities.find_by(occurred_on: date).present?
+  end
+
+  def activity_count(range:)
+    self.activities.where(occurred_on: range).sum(:count)
+  end
+
+  def heatmap(range:)
+    activity_data = activities.where(occurred_on: range).pluck(:occurred_on, :count)
+  
+    activity_data.each_with_object(Hash.new(0)) do |(date, count), hash|
+      hash[date.to_s] = count
+    end
+  end
+
+  def longest_streak
+    dates = activities.pluck(:occurred_on).uniq.sort
+    return 0 if dates.empty?
+  
+    longest = current = 1
+    dates.each_cons(2) do |current_date, next_date|
+      if next_date == current_date + 1
+        current += 1
+        longest = current if current > longest
+      else
+        current = 1
+      end
+    end
+
+    longest
+  end
+  
+  def current_streak
+    date_set = activities.pluck(:occurred_on).to_set
+    count    = 0
+    day      = Date.today
+  
+    while date_set.include?(day)
+      count += 1
+      day   -= 1
+    end
+  
+    count
+  end 
+end

data/lib/acts_as_active/railtie.rb

@@ -0,0 +1,14 @@
+module ActsAsActive
+  class Railtie < Rails::Railtie
+    initializer "acts_as_active.configure_rails_initialization" do
+      ActiveSupport.on_load(:active_record) do
+        require "acts_as_active/activable"
+        ActiveRecord::Base.include ActsAsActive
+      end
+    end
+
+    generators do
+      require_relative "../generators/acts_as_active/install_generator"
+    end
+  end
+end

data/lib/acts_as_active/version.rb

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

data/lib/acts_as_active.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "acts_as_active/version"
+require "acts_as_active/activable"
+require "acts_as_active/railtie" if defined?(Rails)
+
+module ActsAsActive
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/generators/acts_as_active/install_generator.rb

@@ -0,0 +1,30 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module ActsAsActive
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+      desc "Generates the migration for ActsAsActive"
+
+      def self.next_migration_number(dirname)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_migration
+        migration_template "create_activities.rb", "db/migrate/create_activities.rb"
+        create_model
+      end
+
+      def create_model
+        create_file "app/models/activity.rb", <<~RUBY
+          class Activity < ApplicationRecord
+            belongs_to :trackable, polymorphic: true, class_name: "Activity"
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/acts_as_active/templates/create_activities.rb

@@ -0,0 +1,14 @@
+class CreateActivities < ActiveRecord::Migration[7.1]
+  def change
+    create_table :activities do |t|
+      t.string  :trackable_type, null: false
+      t.bigint  :trackable_id,   null: false
+      t.date    :occurred_on,    null: false
+      t.integer :count,          null: false, default: 0
+
+      t.timestamps
+    end
+
+    add_index :activities, [:trackable_type, :trackable_id, :occurred_on], unique: true, name: "index_activities_on_trackable_and_occurred_on"
+  end
+end

data/sig/acts_as_active.rbs

@@ -0,0 +1,4 @@
+module ActsAsActive
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_active
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amit Leshed
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Acts As Active is a tracker and activity generator for any ActiveRecord
+  model, making it easy to generate statistics, streaks, and data visualization.
+email:
+- amitleshed@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/acts_as_active.rb
+- lib/acts_as_active/activable.rb
+- lib/acts_as_active/railtie.rb
+- lib/acts_as_active/version.rb
+- lib/generators/acts_as_active/install_generator.rb
+- lib/generators/acts_as_active/templates/create_activities.rb
+- sig/acts_as_active.rbs
+homepage: https://github.com/amitleshed/acts_as_active
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amitleshed/acts_as_active
+  source_code_uri: https://www.amitleshed.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Track activity and generate streaks, heatmaps, and visualizations for ActiveRecord
+  models
+test_files: []