gem_activity_tracker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d25cb2bbf3c1e686dd780fa27dd35dfa6d1bf7c6a0c55630ae1e24ba8afd7e7
-  data.tar.gz: bba4fdb1fc98d3772159b150d4e65aeab13b2a08dbff438b716d77d10d0328d3
+  metadata.gz: 1a4fc1894fed1dbe9dbb47ee25f486ddd4349ded7feb0a4a91384108735dcbec
+  data.tar.gz: 5c56a548d26d058ea64fc09485ce615ca56468c1c8fa886ea47cb37833bf8c68
 SHA512:
-  metadata.gz: e571832eebfd184aa356c7207d9b2270ac24587d7cfdaffaffc6e11a4581f3f2e38cc78ce50ff4a05f06f1fd80c9439944628d6378435fee35d14b96a407bfbb
-  data.tar.gz: ae6fd1d52fdfcbf131e9281149bf0fde98a50905053d31da4eb934367d623a081bfb17303bf3df6b015f3a5a7c978f99abb9738d0d601dfa538751a3b59d9c8e
+  metadata.gz: 9e32b18708d76bc93cb247c0ab2a3a536027e8c8ea7b182b3aa585f989b7a3c33fffbc46ebc9c4120c513a8887d60caef4f797e4999920dc32af36e64aeb46d3
+  data.tar.gz: 1c7dd0bd08afba432bd0bdeb3c1d85fea8c4e47e07514f9a976363784c034717e85303f5505ed7f5494cd81f2fbd23406a5129a0067789fd3ad0eea27adf00b6

data/README.md

@@ -1,35 +1,190 @@
-# GemActivityTracker
+# 🚀 GemActivityTracker
 
-TODO: Delete this and the text below, and describe your gem
+**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.
 
-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
+## 🔍 What Does This Gem Do?
 
-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.
+When you include this gem in your Rails project, it will:
 
-Install the gem and add to the application's Gemfile by executing:
+- ✅ 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**
+
+---
+
+## 📦 Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'gem_activity_tracker'
+```
+
+Then run:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it manually:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install gem_activity_tracker
 ```
 
-## Usage
+---
+
+## 🚀 Basic Usage
+
+Once installed, you can use the CLI commands:
+
+### 1. 📌 Generate Activity Report
+
+```bash
+gem_activity_tracker --track=.
+```
+
+It will generate a `report.yml` in the `activity_tracker/` folder.
+
+---
+
+### 2. 👁 Start Watching for File Changes
+
+```bash
+gem_activity_tracker --watch
+```
+
+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`
+
+---
+
+### 3. 📄 View Last Generated Report
+
+```bash
+gem_activity_tracker --report
+```
+
+---
+
+### 4. 📤 Export Report as JSON
+
+```bash
+gem_activity_tracker --export=json
+```
+
+---
+
+### 5. 📤 Export Report as CSV
+
+```bash
+gem_activity_tracker --export=csv
+```
+
+---
+
+## 📁 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
+```
+
+---
+
+## 🧪 Development
+
+For contributing or testing locally:
+
+```bash
+git clone https://github.com/atul13055/gem_activity_tracker.git
+cd gem_activity_tracker
+bundle install
+```
+
+Run interactive Ruby console:
+
+```bash
+bin/console
+```
+
+Build the gem locally:
+
+```bash
+bundle exec rake install
+```
+
+---
+
+## 🚀 Releasing New Version
+
+1. Update version in `lib/gem_activity_tracker/version.rb`
+2. Build and release:
+
+```bash
+bundle exec rake release
+```
+
+This will:
+
+- Create a `.gem` file
+- Push to RubyGems
+- Tag and push to GitHub
+
+---
+
+## 🤝 Contributing
+
+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
+
+---
+
+## 📄 License
+
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
 
-TODO: Write usage instructions here
+---
 
-## Development
+## 🌍 Links
 
-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.
+- 📦 [RubyGems Page](https://rubygems.org/gems/gem_activity_tracker)
+- 🧠 [GitHub Repo](https://github.com/atul13055/gem_activity_tracker)
 
-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
+## 🙌 Author
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gem_activity_tracker.
+Built with ❤️ by **Atul Yadav**  
+📧 [atuIyadav9039@gmail.com](mailto:atuIyadav9039@gmail.com)  
+🌐 [LinkedIn](https://www.linkedin.com/in/atul-yadav-9445ab1a4)

data/lib/gem_activity_tracker/railtie.rb

@@ -0,0 +1,32 @@
+require 'rails/railtie'
+
+module GemActivityTracker
+  class Railtie < Rails::Railtie
+    initializer "gem_activity_tracker.auto_track" do
+      ActiveSupport.on_load(:after_initialize) do
+        Thread.new do
+          begin
+            path = Rails.root.to_s
+            report_path = File.join(path, "activity_tracker", "report.yml")
+
+            last_data = File.exist?(report_path) ? YAML.load_file(report_path) : {}
+            current_data = GemActivityTracker::Tracker.collect_data(path)
+
+            if last_data != current_data
+              puts "🔄 Project activity changed. Updating report..."
+              GemActivityTracker::Tracker.track(path)
+            else
+              puts "✅ No project changes detected."
+            end
+
+            # ✅ Start auto watching
+            puts "👀 Starting auto-watcher for #{path} from Railtie..."
+            GemActivityTracker::Watcher.start(path)
+          rescue => e
+            puts "⚠️ GemActivityTracker error: #{e.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gem_activity_tracker/tracker.rb

@@ -0,0 +1,128 @@
+require 'yaml'
+require 'json'
+require 'fileutils'
+require 'psych'
+require 'csv'
+require 'digest'
+
+module GemActivityTracker
+  class Tracker
+    def self.track(path)
+      puts "🔍 Tracking project at: #{path}"
+      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)
+      {
+        ruby_version: `ruby -v`.strip,
+        rails_version: get_rails_version(path),
+        database: detect_database(path),
+        models: list_and_count_files(path, "app/models"),
+        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"
+      if File.exist?(file)
+        puts YAML.load_file(file).to_yaml
+      else
+        puts "❌ No report found. Please run tracking first."
+      end
+    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')
+      return 'Not a Rails project' unless File.exist?(gemfile)
+
+      File.read(gemfile)[/rails \((.*?)\)/, 1]
+    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")
+      return nil unless File.exist?(file)
+      Digest::MD5.hexdigest(File.read(file))
+    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.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] }
+            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,5 @@
 # frozen_string_literal: true
 
 module GemActivityTracker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/gem_activity_tracker/watcher.rb

@@ -0,0 +1,40 @@
+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|
+          next if files.empty?
+
+          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
+
+        if any_change
+          puts "🔄 Updating activity report..."
+          GemActivityTracker::Tracker.track(path)
+        end
+      end
+
+      listener.start
+      puts "✅ Watcher started. Press Ctrl+C to stop."
+      sleep
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_activity_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Atul Yadav
@@ -33,12 +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: []