gem_activity_tracker 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d25cb2bbf3c1e686dd780fa27dd35dfa6d1bf7c6a0c55630ae1e24ba8afd7e7
-  data.tar.gz: bba4fdb1fc98d3772159b150d4e65aeab13b2a08dbff438b716d77d10d0328d3
+  metadata.gz: 20ff8068ac6c6d5f25370bc05493b268788fd353deb03b44c5bc7fcc5055a2a3
+  data.tar.gz: 21c65e1c1b3645d8a807272459d55328ba608371446d7836434ab2c56106b9e1
 SHA512:
-  metadata.gz: e571832eebfd184aa356c7207d9b2270ac24587d7cfdaffaffc6e11a4581f3f2e38cc78ce50ff4a05f06f1fd80c9439944628d6378435fee35d14b96a407bfbb
-  data.tar.gz: ae6fd1d52fdfcbf131e9281149bf0fde98a50905053d31da4eb934367d623a081bfb17303bf3df6b015f3a5a7c978f99abb9738d0d601dfa538751a3b59d9c8e
+  metadata.gz: 78196e0eb4f23179194535eafcb0acda1613c1c8c96e46b43c38982b52e5673627ac0e604b3bdcec5534f9715414bf13068a05174a1bc9d4d20e5af31e9e40b7
+  data.tar.gz: 2ca4a582fe411cd1cb0d850b562835f7f190832d3d0dd812b986be9842e9ee685633e021d48d6f4db86f380afbce5d775a29c423ffe37439347a69e355329582

data/README.md

@@ -1,35 +1,179 @@
-# GemActivityTracker
+# 📊 Gem Activity Tracker
 
-TODO: Delete this and the text below, and describe your gem
+**`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**.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gem_activity_tracker`. To experiment with that code, run `bin/console` for an interactive prompt.
+---
 
-## Installation
+## 🚀 Features
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+- 🔍 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.
 
-Install the gem and add to the application's Gemfile by executing:
+---
+
+## 📦 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gem_activity_tracker'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install it directly:
+
+```bash
+gem install gem_activity_tracker
+```
+
+---
+
+## ⚙️ Usage
+
+### 📌 Basic CLI Commands
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+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
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### 🛠️ Rails Auto-Tracking
+
+In a Rails app, the gem automatically hooks into the app after initialization via a Railtie.
+
+Set this in your `.env` or shell:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+export GEM_ACTIVITY_TRACKER_ENABLED=true
 ```
 
-## Usage
+Then start your Rails app and the gem will:
+
+- Detect and track changes
+- Update `activity_tracker/report.yml`
+- Start watching the file system
+
+---
+
+## 📂 Output
+
+The gem creates an `activity_tracker/` folder at your project root:
+
+```bash
+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)
+```
+
+---
+
+## 📊 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`                                |
+
+---
+
+## 🔁 Auto-Watcher
+
+Auto-track changes in real-time using the `listen` gem:
+
+```bash
+gem_activity_tracker --watch
+```
+
+You'll see logs like:
+
+```
+[2025-04-10 12:00:00] Modified: app/models/user.rb
+[2025-04-10 12:00:01] Added: app/services/new_service.rb
+```
+
+Each change triggers regeneration of the report.
+
+---
+
+## 🧪 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"
+  - ...
+```
+
+---
+
+## 💡 Configuration
+
+You can toggle auto-tracking with an ENV variable:
+
+```bash
+export GEM_ACTIVITY_TRACKER_ENABLED=false  # disables auto-tracking
+```
+
+---
+
+## 🧑 Author
+
+**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)
 
-TODO: Write usage instructions here
+---
 
-## Development
+## 📄 License
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+This project is licensed under the MIT License. See `LICENSE.txt` for details.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+---
 
-## Contributing
+## 💬 Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gem_activity_tracker.
+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/gem_activity_tracker.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative "lib/gem_activity_tracker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem_activity_tracker"
+  spec.version       = GemActivityTracker::VERSION
+  spec.authors       = ["Atul Yadav"]
+  spec.email         = ["atulyadav9039@gmail.com"]
+
+  spec.summary       = "Track gem and project activity in Ruby/Rails projects"
+  spec.description   = "A CLI gem to analyze Ruby/Rails projects and track activity: models, migrations, routes, Git, schema, and more."
+  spec.homepage      = "https://github.com/atul13055/gem_activity_tracker"
+  spec.license       = "MIT"
+
+  spec.files         = Dir["lib/**/*.rb", "exe/*", "README.md", "LICENSE.txt", "*.gemspec"]
+  spec.bindir        = "exe"
+  spec.executables   = ["gem_activity_tracker"]
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.add_dependency "listen", "~> 3.0"
+end

data/lib/gem_activity_tracker/railtie.rb

@@ -0,0 +1,43 @@
+require 'rails/railtie'
+
+module GemActivityTracker
+  class Railtie < Rails::Railtie
+    initializer "gem_activity_tracker.auto_track" 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)
+
+              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
+
+              Rails.logger.info "[GemActivityTracker] 👀 Starting auto-watcher for #{path}..."
+              GemActivityTracker::Watcher.start(path)
+            else
+              Rails.logger.info "[GemActivityTracker] ⚙️ Auto-tracking disabled via ENV."
+            end
+          rescue => e
+            Rails.logger.error "[GemActivityTracker] ⚠️ Error: #{e.message}"
+            Rails.logger.error e.backtrace.join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gem_activity_tracker/tracker.rb

@@ -0,0 +1,207 @@
+require 'yaml'
+require 'json'
+require 'fileutils'
+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}"
+
+      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: Rails.version,
+        database: detect_database(path),
+        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"),
+        services: list_and_count_files(path, "app/services"),
+        migrations: migration_changes(path),
+        schema_hash: schema_hash(path),
+        routes: get_routes(path),
+        git_log: get_git_log(path)
+      }
+    end
+
+    def self.report
+      file = "activity_tracker/report.yml"
+      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 }
+    end
+
+    def self.get_rails_version(path)
+      gemfile = File.join(path, 'Gemfile.lock')
+      File.exist?(gemfile) ? File.read(gemfile)[/rails \((.*?)\)/, 1] : 'Not a Rails project'
+    end
+
+    def self.detect_database(path)
+      db_file = File.join(path, "config/database.yml")
+      return 'Unknown' unless File.exist?(db_file)
+
+      config = YAML.load_file(db_file, aliases: true)
+      config["development"]["adapter"] rescue "Unknown"
+    end
+
+    def self.get_routes(path)
+      output = `cd #{path} && RAILS_ENV=development bundle exec rails routes 2>/dev/null`
+      output.empty? ? "No routes found or Rails not installed" : output
+    end
+
+    def self.migration_changes(path)
+      files = Dir.glob("#{path}/db/migrate/*.rb")
+      recent = files.sort_by { |f| File.mtime(f) }.last(10)
+      {
+        count: files.count,
+        recent_changes: recent.map { |f| File.basename(f, ".rb").gsub(/^\d+_/, '') }
+      }
+    end
+
+    def self.schema_hash(path)
+      file = File.join(path, "db/schema.rb")
+      File.exist?(file) ? Digest::MD5.hexdigest(File.read(file)) : nil
+    end
+
+    def self.get_git_log(path)
+      Dir.chdir(path) do
+        log = `git log --pretty=format:'%h - %an (%ad): %s' --date=short -n 20`
+        log.split("\n")
+      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)
+
+      data = YAML.load_file(file)
+
+      case format
+      when :json
+        File.write("#{path}/activity_tracker/report.json", JSON.pretty_generate(data))
+        puts "✅ Exported to report.json"
+      when :csv
+        CSV.open("#{path}/activity_tracker/report.csv", "w") do |csv|
+          csv << ["Key", "Value"]
+          data.each do |key, value|
+            if value.is_a?(Hash)
+              csv << [key.to_s, ""]
+              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] }
+            else
+              csv << [key.to_s, value]
+            end
+          end
+        end
+        puts "✅ Exported to report.csv"
+      else
+        puts "❌ Unsupported format: #{format}"
+      end
+    end
+  end
+end

data/lib/gem_activity_tracker/version.rb

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

data/lib/gem_activity_tracker/watcher.rb

@@ -0,0 +1,34 @@
+require 'listen'
+require 'fileutils'
+
+module GemActivityTracker
+  class Watcher
+    def self.start(path)
+      puts "👀 Watching for changes in: #{path}"
+
+      listener = Listen.to(path, ignore: [%r{activity_tracker/}, %r{tmp/}, %r{log/}, /\.log$/]) do |modified, added, removed|
+        changes = { modified: modified, added: added, removed: removed }
+        log_file = File.join(path, "activity_tracker", "log.txt")
+        FileUtils.mkdir_p(File.dirname(log_file))
+
+        any_change = false
+        changes.each do |type, files|
+          files.each do |file|
+            timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+            relative_path = file.sub("#{path}/", '')
+            log_line = "[#{timestamp}] #{type.to_s.capitalize}: #{relative_path}"
+            puts log_line
+            File.open(log_file, "a") { |f| f.puts log_line }
+            any_change = true
+          end
+        end
+
+        GemActivityTracker::Tracker.track(path) if any_change
+      end
+
+      listener.start
+      puts "✅ Watcher started. Press Ctrl+C to stop."
+      sleep
+    end
+  end
+end

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.0
+  version: 1.0.0
 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,20 +33,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - README.md
-- Rakefile
 - exe/gem_activity_tracker
+- gem_activity_tracker.gemspec
 - lib/gem_activity_tracker.rb
+- lib/gem_activity_tracker/railtie.rb
+- lib/gem_activity_tracker/tracker.rb
 - lib/gem_activity_tracker/version.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
+- lib/gem_activity_tracker/watcher.rb
+homepage: https://github.com/atul13055/gem_activity_tracker
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -65,5 +63,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