gem_activity_tracker 0.1.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4fc1894fed1dbe9dbb47ee25f486ddd4349ded7feb0a4a91384108735dcbec
-  data.tar.gz: 5c56a548d26d058ea64fc09485ce615ca56468c1c8fa886ea47cb37833bf8c68
+  metadata.gz: dbf3e335476faecbfe09e7b427ec0706ad1cbfc397ceadd74ff8bd2dd68d56ae
+  data.tar.gz: 83d525f61caafca1a605244dca22be4859045739a04ea984a7edd9267361af51
 SHA512:
-  metadata.gz: 9e32b18708d76bc93cb247c0ab2a3a536027e8c8ea7b182b3aa585f989b7a3c33fffbc46ebc9c4120c513a8887d60caef4f797e4999920dc32af36e64aeb46d3
-  data.tar.gz: 1c7dd0bd08afba432bd0bdeb3c1d85fea8c4e47e07514f9a976363784c034717e85303f5505ed7f5494cd81f2fbd23406a5129a0067789fd3ad0eea27adf00b6
+  metadata.gz: 55066b038228ba20827e13f17fd962d0e4da8c9056ca4d5c67d4b3b414fe01ac4e6f067c4652169089cff9d13407819e997203e28dfb7ec2c5eb5e10ace8960a
+  data.tar.gz: 354d740e41817c937009444eec07ffd896e0f41918896c1eb4725025b0592447459bd95d809e4673eff13c688328904b33dbb4af1bc7af2c7fe36bb7074e609e

data/README.md

@@ -1,39 +1,25 @@
-# 🚀 GemActivityTracker
+# 📊 Gem Activity Tracker
 
-**GemActivityTracker** is a Ruby gem that automatically tracks the structure and changes in your Ruby on Rails project. It collects details like models, controllers, jobs, mailers, services, migrations, schema, routes, and Git history. It also provides real-time file change tracking with a detailed activity log and supports exporting the report as JSON or CSV.
+**`gem_activity_tracker`** is a Ruby gem that tracks the internal structure, changes, and metadata of your **Ruby** or **Rails** projects. It generates a complete project activity report in **YAML**, with support for **JSON/CSV export**, **auto-tracking with file watcher**, and **Git log visualization**.
 
 ---
 
-## 🔍 What Does This Gem Do?
+## 🚀 Features
 
-When you include this gem in your Rails project, it will:
-
-- ✅ Scan and record project components:
-  - Models, Controllers, Jobs, Mailers, Services
-  - Migrations, Routes, Schema hash
-  - Database type and Git history
-- 🔁 Automatically detect changes after initialization
-- 🕵️ Keep an activity log of every file change (created, modified, removed)
-- 📊 Export report in:
-  - YAML (default)
-  - JSON
-  - CSV
-- 🔁 Real-time file watcher using the `listen` gem
-
----
-
-## 🔧 Compatibility
-
-- ✅ **Ruby**: >= 2.6.5 and < 4.0
-- ✅ **Rails**: >= 5.2 and <= 7.1
-
-- ✅ Works with: **MySQL**, **PostgreSQL**, **SQLite**
+- 🔍 Analyze project structure: models, controllers, jobs, services, mailers, routes, etc.
+- 🧠 Advanced model analysis: attributes, associations, methods, validations, callbacks, and enums.
+- 🏗️ Migration tracking and schema hashing.
+- 🛠️ Detect database type from `database.yml`.
+- 📦 Git history tracking (last 20 commits).
+- 🔄 Auto-tracking using the `listen` gem on file changes.
+- 📁 Export report to **YAML**, **JSON**, or **CSV**.
+- ✅ Works with both **Rails** and **plain Ruby** projects.
 
 ---
 
 ## 📦 Installation
 
-Add this line to your Rails application's Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
 gem 'gem_activity_tracker'
@@ -45,7 +31,7 @@ Then run:
 bundle install
 ```
 
-Or install it manually:
+Or install it directly:
 
 ```bash
 gem install gem_activity_tracker
@@ -53,138 +39,141 @@ gem install gem_activity_tracker
 
 ---
 
-## 🚀 Basic Usage
-
-Once installed, you can use the CLI commands:
+## ⚙️ Usage
 
-### 1. 📌 Generate Activity Report
+### 📌 Basic CLI Commands
 
 ```bash
-gem_activity_tracker --track=.
+gem_activity_tracker --track=PATH          # Track a Ruby/Rails project and generate report
+gem_activity_tracker --report              # Show last generated report
+gem_activity_tracker --export=json         # Export report to JSON
+gem_activity_tracker --export=csv          # Export report to CSV
+gem_activity_tracker --watch               # Start file watcher to auto-track changes
 ```
 
-It will generate a `report.yml` in the `activity_tracker/` folder.
+### 🛠️ Rails Auto-Tracking
 
----
+In a Rails app, the gem automatically hooks into the app after initialization via a Railtie.
 
-### 2. 👁 Start Watching for File Changes
+Set this in your `.env` or shell:
 
 ```bash
-gem_activity_tracker --watch
+export GEM_ACTIVITY_TRACKER_ENABLED=true
 ```
 
-This will keep watching the project. On any file change (model, controller, migration, etc.), it will:
-
-- Update the report
-- Add a new entry to `log.txt`
+Then start your Rails app and the gem will:
 
----
-
-### 3. 📄 View Last Generated Report
-
-```bash
-gem_activity_tracker --report
-```
+- Detect and track changes
+- Update `activity_tracker/report.yml`
+- Start watching the file system
 
 ---
 
-### 4. 📤 Export Report as JSON
-
-```bash
-gem_activity_tracker --export=json
-```
-
----
+## 📂 Output
 
-### 5. 📤 Export Report as CSV
+The gem creates an `activity_tracker/` folder at your project root:
 
 ```bash
-gem_activity_tracker --export=csv
+activity_tracker/
+├── report.yml        # Main YAML report
+├── report.json       # (Optional) Exported JSON
+├── report.csv        # (Optional) Exported CSV
+└── log.txt           # File change logs (when watch mode is on)
 ```
 
 ---
 
-## 📁 Output Structure
-
-The following directory is automatically created:
-
-```
-activity_tracker/
-├── report.yml       # Main YAML report
-├── report.json      # (Optional) JSON export
-├── report.csv       # (Optional) CSV export
-└── log.txt          # Activity logs of file changes
-```
+## 📊 What’s Tracked?
+
+| Component   | Details                                                                 |
+|------------|-------------------------------------------------------------------------|
+| Models      | Count, files, attributes, associations, methods, validations, enums     |
+| Controllers | List of files                                                           |
+| Services    | List of files                                                           |
+| Mailers     | List of files                                                           |
+| Jobs        | List of files                                                           |
+| Migrations  | Count and recent migration names                                        |
+| Routes      | Full route listing via `rails routes`                                   |
+| Schema      | Schema hash (`db/schema.rb`)                                            |
+| Git Log     | Last 20 commits                                                         |
+| Database    | Type detected from `config/database.yml`                                |
 
 ---
 
-## 🧪 Development
+## 🔁 Auto-Watcher
 
-For contributing or testing locally:
+Auto-track changes in real-time using the `listen` gem:
 
 ```bash
-git clone https://github.com/atul13055/gem_activity_tracker.git
-cd gem_activity_tracker
-bundle install
+gem_activity_tracker --watch
 ```
 
-Run interactive Ruby console:
+You'll see logs like:
 
-```bash
-bin/console
+```
+[2025-04-10 12:00:00] Modified: app/models/user.rb
+[2025-04-10 12:00:01] Added: app/services/new_service.rb
 ```
 
-Build the gem locally:
+Each change triggers regeneration of the report.
 
-```bash
-bundle exec rake install
+---
+
+## 🧪 Example Output (YAML)
+
+```yaml
+ruby_version: ruby 3.2.2
+rails_version: 6.1.4
+database: postgresql
+models:
+  count: 5
+  files:
+    - app/models/user.rb
+    - app/models/post.rb
+  detailed:
+    User:
+      table_name: users
+      attributes: [id, name, email]
+      associations:
+        has_many: [posts]
+      validations: ["PresenceValidator"]
+      callbacks: [before_create, after_save]
+controllers:
+  count: 3
+  files: [...]
+git_log:
+  - "1a2b3c4 - Atul Yadav (2025-04-10): Add model tracker"
+  - ...
 ```
 
 ---
 
-## 🚀 Releasing New Version
+## 💡 Configuration
 
-1. Update version in `lib/gem_activity_tracker/version.rb`
-2. Build and release:
+You can toggle auto-tracking with an ENV variable:
 
 ```bash
-bundle exec rake release
+export GEM_ACTIVITY_TRACKER_ENABLED=false  # disables auto-tracking
 ```
 
-This will:
-
-- Create a `.gem` file
-- Push to RubyGems
-- Tag and push to GitHub
-
 ---
 
-## 🤝 Contributing
+## 🧑 Author
 
-1. Fork this repo
-2. Create a new branch: `git checkout -b my-feature`
-3. Make your changes
-4. Commit: `git commit -m "Add my feature"`
-5. Push: `git push origin my-feature`
-6. Open a Pull Request
+**Atul Yadav**  
+📧 atuIyadav9039@gmail.com  
+📍 Indore, India  
+🔗 [LinkedIn](https://www.linkedin.com/in/atul-yadav-9445ab1a4)  
+📦 RubyGems: [gem_activity_tracker](https://rubygems.org/gems/gem_activity_tracker)
 
 ---
 
 ## 📄 License
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
-
----
-
-## 🌍 Links
-
-- 📦 [RubyGems Page](https://rubygems.org/gems/gem_activity_tracker)
-- 🧠 [GitHub Repo](https://github.com/atul13055/gem_activity_tracker)
+This project is licensed under the MIT License. See `LICENSE.txt` for details.
 
 ---
 
-## 🙌 Author
+## 💬 Contributing
 
-Built with ❤️ by **Atul Yadav**  
-📧 [atuIyadav9039@gmail.com](mailto:atuIyadav9039@gmail.com)  
-🌐 [LinkedIn](https://www.linkedin.com/in/atul-yadav-9445ab1a4)
+Pull requests are welcome! For major changes, please open an issue first to discuss what you'd like to change.

data/exe/gem_activity_tracker

@@ -8,21 +8,10 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: gem_activity_tracker [options]"
 
-  opts.on("-tPATH", "--track=PATH", "Track a Rails/Ruby project") do |path|
-    options[:track] = path
-  end
-
-  opts.on("-r", "--report", "Show last generated report") do
-    options[:report] = true
-  end
-
-  opts.on("-eFORMAT", "--export=FORMAT", "Export as json or csv") do |format|
-    options[:export] = format.to_sym
-  end
-
-  opts.on("-w", "--watch", "Start the file watcher") do
-    options[:watch] = true
-  end
+  opts.on("-tPATH", "--track=PATH", "Track a Rails/Ruby project") { |v| options[:track] = v }
+  opts.on("-r", "--report", "Show last generated report") { options[:report] = true }
+  opts.on("-eFORMAT", "--export=FORMAT", "Export as json or csv") { |v| options[:export] = v.to_sym }
+  opts.on("-w", "--watch", "Start the file watcher") { options[:watch] = true }
 end.parse!
 
 if options[:track]

data/lib/gem_activity_tracker/railtie.rb

@@ -3,27 +3,38 @@ require 'rails/railtie'
 module GemActivityTracker
   class Railtie < Rails::Railtie
     initializer "gem_activity_tracker.auto_track" do
-      ActiveSupport.on_load(:after_initialize) do
+      Rails.application.config.after_initialize do
+        # Delay the execution slightly to avoid blocking boot
         Thread.new do
+          sleep(2) # Give Rails a moment to fully start
+
           begin
             path = Rails.root.to_s
             report_path = File.join(path, "activity_tracker", "report.yml")
+            tracking_enabled = ENV.fetch('GEM_ACTIVITY_TRACKER_ENABLED', 'true') == 'true'
+
+            if tracking_enabled
+              Rails.logger.info "[GemActivityTracker] 🔍 Checking for project changes..."
+              
+              last_data = File.exist?(report_path) ? YAML.load_file(report_path) : {}
+              
+              current_data = GemActivityTracker::Tracker.collect_data(path)
 
-            last_data = File.exist?(report_path) ? YAML.load_file(report_path) : {}
-            current_data = GemActivityTracker::Tracker.collect_data(path)
+              if last_data != current_data
+                Rails.logger.info "[GemActivityTracker] 🔄 Project activity changed. Updating report..."
+                GemActivityTracker::Tracker.track(path)
+              else
+                Rails.logger.info "[GemActivityTracker] ✅ No project changes detected."
+              end
 
-            if last_data != current_data
-              puts "🔄 Project activity changed. Updating report..."
-              GemActivityTracker::Tracker.track(path)
+              Rails.logger.info "[GemActivityTracker] 👀 Starting auto-watcher for #{path}..."
+              GemActivityTracker::Watcher.start(path)
             else
-              puts "✅ No project changes detected."
+              Rails.logger.info "[GemActivityTracker] ⚙️ Auto-tracking disabled via ENV."
             end
-
-            # ✅ Start auto watching
-            puts "👀 Starting auto-watcher for #{path} from Railtie..."
-            GemActivityTracker::Watcher.start(path)
           rescue => e
-            puts "⚠️ GemActivityTracker error: #{e.message}"
+            Rails.logger.error "[GemActivityTracker] ⚠️ Error: #{e.message}"
+            Rails.logger.error e.backtrace.join("\n")
           end
         end
       end

data/lib/gem_activity_tracker/tracker.rb

@@ -1,28 +1,39 @@
 require 'yaml'
 require 'json'
 require 'fileutils'
-require 'psych'
 require 'csv'
 require 'digest'
+require 'active_support/all'
+require 'active_record'
+require 'active_support/dependencies'
 
 module GemActivityTracker
   class Tracker
     def self.track(path)
       puts "🔍 Tracking project at: #{path}"
-      data = collect_data(path)
 
+      if !defined?(Rails) || Rails.root.to_s != path
+        # Only require environment if we're not already inside a Rails app
+        $LOAD_PATH.unshift(path)
+        ENV['RAILS_ENV'] ||= 'development'
+        require File.join(path, 'config', 'environment')
+      end
+
+      data = collect_data(path)
       FileUtils.mkdir_p("#{path}/activity_tracker")
       File.write("#{path}/activity_tracker/report.yml", data.to_yaml)
 
       puts "✅ Report generated at: #{path}/activity_tracker/report.yml"
     end
-
+    
     def self.collect_data(path)
       {
+        project_name: File.basename(path),
         ruby_version: `ruby -v`.strip,
-        rails_version: get_rails_version(path),
+        # rails_version: get_rails_version(path),
+        rails_version: Rails.version,
         database: detect_database(path),
-        models: list_and_count_files(path, "app/models"),
+        models: analyze_models(path),
         controllers: list_and_count_files(path, "app/controllers"),
         jobs: list_and_count_files(path, "app/jobs"),
         mailers: list_and_count_files(path, "app/mailers"),
@@ -36,27 +47,18 @@ module GemActivityTracker
 
     def self.report
       file = "activity_tracker/report.yml"
-      if File.exist?(file)
-        puts YAML.load_file(file).to_yaml
-      else
-        puts "❌ No report found. Please run tracking first."
-      end
+      puts File.exist?(file) ? YAML.load_file(file).to_yaml : "❌ No report found."
     end
 
     def self.list_and_count_files(base, dir)
       path = File.join(base, dir)
       files = Dir.glob("#{path}/**/*.rb").map { |f| f.gsub(base + '/', '') }
-      {
-        count: files.count,
-        files: files
-      }
+      { count: files.count, files: files }
     end
 
     def self.get_rails_version(path)
       gemfile = File.join(path, 'Gemfile.lock')
-      return 'Not a Rails project' unless File.exist?(gemfile)
-
-      File.read(gemfile)[/rails \((.*?)\)/, 1]
+      File.exist?(gemfile) ? File.read(gemfile)[/rails \((.*?)\)/, 1] : 'Not a Rails project'
     end
 
     def self.detect_database(path)
@@ -83,8 +85,7 @@ module GemActivityTracker
 
     def self.schema_hash(path)
       file = File.join(path, "db/schema.rb")
-      return nil unless File.exist?(file)
-      Digest::MD5.hexdigest(File.read(file))
+      File.exist?(file) ? Digest::MD5.hexdigest(File.read(file)) : nil
     end
 
     def self.get_git_log(path)
@@ -94,6 +95,84 @@ module GemActivityTracker
       end
     end
 
+    def self.analyze_models(path)
+      result = { count: 0, files: [], detailed: {} }
+
+      ActiveSupport::Dependencies.autoload_paths += Dir["#{path}/app/models/**/"]
+
+      Dir.glob("#{path}/app/models/**/*.rb").each do |file|
+        relative_path = file.gsub("#{path}/", '')
+        model_name = relative_path.sub('app/models/', '').sub('.rb', '').camelize
+
+        begin
+          require_dependency file
+          model_class = model_name.constantize
+          next unless model_class < ActiveRecord::Base
+
+          result[:count] += 1
+          result[:files] << relative_path
+
+          # Validations
+          validations = Hash.new { |hash, key| hash[key] = [] }
+          model_class.validators.each do |validator|
+            validator.attributes.each do |attr|
+              validations[attr] << validator.class.name.demodulize.underscore
+            end
+          end
+
+          # Callbacks
+          callbacks = {}
+          ActiveRecord::Callbacks::CALLBACKS.each do |cb|
+            if model_class.respond_to?("_#{cb}_callbacks")
+              methods = model_class.send("_#{cb}_callbacks").map(&:filter).uniq
+              callbacks[cb] = methods.map(&:to_s) if methods.any?
+            end
+          end
+
+          # Enums
+          # debugger
+          enums = model_class.defined_enums.transform_values { |v| v.keys }
+
+          # Associations
+          associations = model_class.reflect_on_all_associations.group_by(&:macro).transform_values { |a| a.map(&:name) }
+
+          # Scopes
+          scopes = model_class.methods(false).select do |method|
+            model_class.method(method).source_location&.first&.include?('/models/')
+          end.select { |m| model_class.respond_to?(m) && model_class.send(m).is_a?(ActiveRecord::Relation) rescue false }
+
+          # Class methods
+          class_methods = (model_class.methods(false) - ActiveRecord::Base.methods)
+          instance_methods = (model_class.instance_methods(false) - ActiveRecord::Base.instance_methods).map(&:to_s)
+
+          # # Comments
+          # comment = File.foreach(file).first if File.read(file).lines.first.strip.start_with?('#')
+
+          result[:detailed][model_class.name] = {
+            table_name: model_class.table_name,
+            file: relative_path,
+            # comment: comment&.strip,
+            attributes: model_class.columns.map(&:name),
+            associations: associations,
+            validations: validations,
+            enums: enums,
+            callbacks: callbacks,
+            scopes: scopes.map(&:to_s),
+            class_methods: class_methods.map(&:to_s),
+            instance_methods: instance_methods,
+            methods_count: model_class.instance_methods(false).count
+          }
+
+        rescue => e
+          result[:detailed][model_name] = { error: "Failed to load: #{e.message}" }
+        end
+      end
+
+      result
+    end
+
+
+
     def self.export(path, format = :json)
       file = "#{path}/activity_tracker/report.yml"
       return puts "❌ Report not found." unless File.exist?(file)
@@ -110,7 +189,7 @@ module GemActivityTracker
           data.each do |key, value|
             if value.is_a?(Hash)
               csv << [key.to_s, ""]
-              value.each { |k, v| csv << ["  #{k}", v] }
+              value.each { |k, v| csv << ["  #{k}", v.to_json] }
             elsif value.is_a?(Array)
               csv << [key.to_s, "#{value.count} items"]
               value.each { |item| csv << ["", item] }

data/lib/gem_activity_tracker/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module GemActivityTracker
-  VERSION = "0.1.1"
+  VERSION = "1.0.1"
 end

data/lib/gem_activity_tracker/watcher.rb

@@ -12,10 +12,7 @@ module GemActivityTracker
         FileUtils.mkdir_p(File.dirname(log_file))
 
         any_change = false
-
         changes.each do |type, files|
-          next if files.empty?
-
           files.each do |file|
             timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
             relative_path = file.sub("#{path}/", '')
@@ -26,10 +23,7 @@ module GemActivityTracker
           end
         end
 
-        if any_change
-          puts "🔄 Updating activity report..."
-          GemActivityTracker::Tracker.track(path)
-        end
+        GemActivityTracker::Tracker.track(path) if any_change
       end
 
       listener.start

data/lib/gem_activity_tracker.rb

@@ -2,10 +2,9 @@
 
 require_relative "gem_activity_tracker/version"
 require_relative "gem_activity_tracker/tracker"
-require_relative "gem_activity_tracker/railtie" if defined?(Rails)
 require_relative "gem_activity_tracker/watcher"
+require_relative "gem_activity_tracker/railtie" if defined?(Rails)
 
 module GemActivityTracker
   class Error < StandardError; end
-  # Additional code (if needed) goes here
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_activity_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Atul Yadav
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -24,8 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: gem_activity_tracker is a CLI tool to track and analyze gems used in
-  any Ruby project using its Gemfile.lock
+description: 'A CLI gem to analyze Ruby/Rails projects and track activity: models,
+  migrations, routes, Git, schema, and more.'
 email:
 - atulyadav9039@gmail.com
 executables:
@@ -33,25 +33,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gem_activity_tracker.gemspec.swp"
-- CHANGELOG.md
 - README.md
-- Rakefile
 - exe/gem_activity_tracker
-- gem_activity_tracker-0.1.0.gem
 - lib/gem_activity_tracker.rb
 - lib/gem_activity_tracker/railtie.rb
 - lib/gem_activity_tracker/tracker.rb
 - lib/gem_activity_tracker/version.rb
 - lib/gem_activity_tracker/watcher.rb
-- sig/gem_activity_tracker.rbs
-homepage: https://example.com/gem_activity_tracker
-licenses: []
-metadata:
-  allowed_push_host: https://rubygems.org
-  homepage_uri: https://example.com/gem_activity_tracker
-  source_code_uri: https://example.com/gem_activity_tracker
-  changelog_uri: https://example.com/gem_activity_tracker/CHANGELOG.md
+homepage: https://github.com/atul13055/gem_activity_tracker
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -60,7 +52,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -70,5 +65,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: Track gem dependencies of any Ruby project
+summary: Track gem and project activity in Ruby/Rails projects
 test_files: []

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2025-04-09
-
-- Initial release

data/Rakefile

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-task default: %i[]

data/sig/gem_activity_tracker.rbs

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