script_tracker 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d372a25d4ace7ddcd9d7cd978e4dc328deb3cc9fd24bcc4ea47b3efbf7c2b9
-  data.tar.gz: 42ad440f174f8e3fafdae807a898545893e631ae174fc3ad99a36737c65e38aa
+  metadata.gz: 1035933e320fe159fddb60f9f99e67f3d707250f8e6ba1901460973995df3567
+  data.tar.gz: 203bb6d7a9139e9e9069b0f98017cbe1e682a52c9f7fef67f6ccde5dc503a607
 SHA512:
-  metadata.gz: dc156bc040a0a421dc912e25163854ffae79ddf520d26e83d095a0f45905ee344882208b5559d6e9459a9d33565c9db3bf4bed54dae23aae61b09fd568eef0f4
-  data.tar.gz: d42cd031ccd17efe53b9bb69b790b3dc0eddf90aacb368ac7d16f24a620aebee6ba6af4c6430f0f70249fa65e9aa962301423b60139b55ce1a09746421aea182
+  metadata.gz: 6a48bc5347dfdb40f412bff93e89a872e6a07756643e705f2f6a49232b5eed14ca742c229254ffd6759142b5444d57d1753d4ef74f2e74bf58d945baa051ed7e
+  data.tar.gz: 71a2e8e39d6a20d0da06517d43f190fe6811ca5164115a2c4171238b6900ecad0bebd2cdf3d93430e4161d171ba68219d0720a3464fba238a592681c813af05f

data/CHANGELOG.md

@@ -7,12 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3] - 2025-01-17
+
+### Changed
+- Simplified and streamlined README documentation
+- Cleaned up CHANGELOG format
+
 ## [0.1.2] - 2025-01-17
 
 ### Fixed
-- Updated GitHub Actions workflows to use v4 actions (fix deprecated upload-artifact)
+- Updated GitHub Actions workflows to use v4 actions
+- Fixed GitHub release permissions
 - Refactored workflows to match successful gem release pattern
-- Fixed RubyGems authentication configuration
 
 ## [0.1.1] - 2025-01-17
 
@@ -22,29 +28,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Manual release workflow via GitHub Actions UI
 - Local release script (`bin/release`)
 
-### Changed
-- Improved workflow documentation in README
-
 ## [0.1.0] - 2025-01-17
 
 ### Added
-- Initial release of ScriptTracker
+- Initial release
 - Script execution tracking with status management
 - Transaction support for script execution
 - Built-in logging and progress tracking
 - Batch processing helpers
 - Timeout support for long-running scripts
 - Stale script cleanup functionality
-- Rake tasks for managing scripts:
-  - `scripts:create` - Create new scripts
-  - `scripts:run` - Run pending scripts
-  - `scripts:status` - View script status
-  - `scripts:rollback` - Rollback scripts
-  - `scripts:cleanup` - Cleanup stale scripts
+- Rake tasks for managing scripts
 - Comprehensive RSpec test suite
-- Full documentation and examples
 
-[Unreleased]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/a-abdellatif98/script_tracker/releases/tag/v0.1.0

data/README.md

@@ -1,70 +1,35 @@
 # ScriptTracker
 
-ScriptTracker is a Ruby gem that provides a migration-like system for managing one-off scripts in Rails applications. It tracks script execution history, provides transaction support, and includes built-in logging and progress tracking.
+A Ruby gem that provides a migration-like system for managing one-off scripts in Rails applications with execution tracking, transaction support, and built-in logging.
 
 ## Features
 
-* **Execution Tracking**: Automatically tracks which scripts have been run and their status
-* **Transaction Support**: Wraps script execution in database transactions
-* **Status Management**: Track scripts as success, failed, running, or skipped
-* **Built-in Logging**: Convenient logging methods with timestamps
-* **Batch Processing**: Helper methods for processing large datasets efficiently
-* **Timeout Support**: Configure custom timeouts for long-running scripts
-* **Stale Script Cleanup**: Automatically identify and cleanup stuck scripts
-* **Migration Generator**: Generate timestamped script files with templates
+* **Execution Tracking** - Automatically tracks which scripts have been run and their status
+* **Transaction Support** - Wraps script execution in database transactions
+* **Status Management** - Track scripts as success, failed, running, or skipped
+* **Built-in Logging** - Convenient logging methods with timestamps
+* **Batch Processing** - Helper methods for processing large datasets efficiently
+* **Timeout Support** - Configure custom timeouts for long-running scripts
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'script_tracker'
 ```
 
-And then execute:
+Then run:
 
 ```bash
 bundle install
-```
-
-Or install it yourself as:
-
-```bash
-gem install script_tracker
-```
-
-## Setup
-
-1. Install the gem using the generator:
-
-```bash
 rails generate script_tracker:install
-```
-
-This will:
-* Create a migration for the `executed_scripts` table
-* Create the `lib/scripts` directory for your scripts
-
-2. Run the migration:
-
-```bash
 rails db:migrate
 ```
 
-3. (Optional) Configure the scripts directory in an initializer:
+## Quick Start
 
-```ruby
-# config/initializers/script_tracker.rb
-ScriptTracker.configure do |config|
-  config.scripts_path = Rails.root.join('lib', 'scripts')
-end
-```
-
-## Usage
-
-### Creating a New Script
-
-Generate a new script with a descriptive name:
+### Create a Script
 
 ```bash
 rake scripts:create["update user preferences"]
@@ -73,136 +38,71 @@ rake scripts:create["update user preferences"]
 This creates a timestamped script file in `lib/scripts/` :
 
 ```ruby
-# lib/scripts/20231117120000_update_user_preferences.rb
 module Scripts
   class UpdateUserPreferences < ScriptTracker::Base
     def self.execute
-      log "Starting script: update user preferences"
-
-      # Your script logic here
+      log "Starting script"
+      
       User.find_each do |user|
         user.update!(preferences: { theme: 'dark' })
       end
-
-      log "Script completed successfully"
+      
+      log "Script completed"
     end
   end
 end
 ```
 
-### Running Scripts
-
-Run all pending (not yet executed) scripts:
-
-```bash
-rake scripts:run
-```
-
-### Checking Script Status
-
-View the status of all scripts:
+### Run Scripts
 
 ```bash
-rake scripts:status
+rake scripts:run        # Run all pending scripts
+rake scripts:status     # View script status
+rake scripts:rollback[filename]  # Rollback a script
+rake scripts:cleanup    # Cleanup stale scripts
 ```
 
-Output:
-
-```
-Scripts:
-  [SUCCESS] 20231117120000_update_user_preferences.rb (2.5s)
-  [PENDING] 20231117130000_cleanup_old_data.rb
-```
-
-### Rolling Back a Script
-
-Remove a script from execution history (allows it to be run again):
-
-```bash
-rake scripts:rollback[20231117120000_update_user_preferences.rb]
-```
-
-### Cleaning Up Stale Scripts
-
-Mark scripts stuck in "running" status as failed:
-
-```bash
-rake scripts:cleanup
-```
-
-## Advanced Features
-
-### Skipping Scripts
+## Advanced Usage
 
-Skip a script execution conditionally:
+### Skip Script Conditionally
 
 ```ruby
-module Scripts
-  class ConditionalUpdate < ScriptTracker::Base
-    def self.execute
-      if User.where(needs_update: true).count.zero?
-        skip! "No users need updating"
-      end
-
-      # Your script logic here
-    end
-  end
+def self.execute
+  skip! "No users need updating" if User.where(needs_update: true).count.zero?
+  # Your logic here
 end
 ```
 
 ### Custom Timeout
 
-Override the default 5-minute timeout:
-
 ```ruby
-module Scripts
-  class LongRunningScript < ScriptTracker::Base
-    def self.timeout
-      3600 # 1 hour in seconds
-    end
-
-    def self.execute
-      # Long-running logic here
-    end
-  end
+def self.timeout
+  3600 # 1 hour in seconds
 end
 ```
 
 ### Batch Processing
 
-Process large datasets efficiently:
-
 ```ruby
-module Scripts
-  class ProcessUsers < ScriptTracker::Base
-    def self.execute
-      users = User.where(processed: false)
-
-      process_in_batches(users, batch_size: 1000) do |user|
-        user.update!(processed: true)
-      end
-    end
+def self.execute
+  users = User.where(processed: false)
+  process_in_batches(users, batch_size: 1000) do |user|
+    user.update!(processed: true)
   end
 end
 ```
 
 ### Progress Logging
 
-Track progress during execution:
-
 ```ruby
-module Scripts
-  class DataMigration < ScriptTracker::Base
-    def self.execute
-      total = User.count
-      processed = 0
-
-      User.find_each do |user|
-        # Process user
-        processed += 1
-        log_progress(processed, total) if (processed % 100).zero?
-      end
-    end
+def self.execute
+  total = User.count
+  processed = 0
+  
+  User.find_each do |user|
+    # Process user
+    processed += 1
+    log_progress(processed, total) if (processed % 100).zero?
   end
 end
 ```
@@ -211,49 +111,22 @@ end
 
 ### ScriptTracker:: Base
 
-Base class for all scripts.
-
 **Class Methods:**
-
-* `execute` - Implement this method with your script logic (required)
-* `run` - Execute the script with transaction and error handling
+* `execute` - Implement with your script logic (required)
 * `timeout` - Override to set custom timeout (default: 300 seconds)
-* `skip!(reason)` - Skip script execution with optional reason
-* `log(message, level: :info)` - Log a message with timestamp
-* `log_progress(current, total, message = nil)` - Log progress percentage
-* `process_in_batches(relation, batch_size: 1000, &block)` - Process records in batches
+* `skip!(reason)` - Skip script execution
+* `log(message, level: :info)` - Log a message
+* `log_progress(current, total)` - Log progress percentage
+* `process_in_batches(relation, batch_size: 1000, &block)` - Process in batches
 
 ### ScriptTracker:: ExecutedScript
 
-ActiveRecord model for tracking script execution.
-
-**Scopes:**
-
-* `successful` - Scripts that completed successfully
-* `failed` - Scripts that failed
-* `running` - Scripts currently running
-* `skipped` - Scripts that were skipped
-* `completed` - Scripts that finished (success or failed)
-* `ordered` - Order by execution time ascending
-* `recent_first` - Order by execution time descending
+**Scopes:** `successful` , `failed` , `running` , `skipped` , `completed` , `ordered` , `recent_first`
 
 **Class Methods:**
-
-* `executed?(filename)` - Check if a script has been executed
-* `mark_as_running(filename)` - Mark a script as running
+* `executed?(filename)` - Check if script has been executed
 * `cleanup_stale_running_scripts(older_than: 1.hour.ago)` - Clean up stale scripts
 
-**Instance Methods:**
-
-* `mark_success!(output, duration)` - Mark as successful
-* `mark_failed!(error, duration)` - Mark as failed
-* `mark_skipped!(output, duration)` - Mark as skipped
-* `success?`,     `failed?`,     `running?`,  `skipped?` - Status predicates
-* `formatted_duration` - Human-readable duration
-* `formatted_output` - Truncated output text
-* `timeout_seconds` - Get timeout value
-* `timed_out?` - Check if script has timed out
-
 ## Rake Tasks
 
 * `rake scripts:create[description]` - Create a new script
@@ -262,68 +135,33 @@ ActiveRecord model for tracking script execution.
 * `rake scripts:rollback[filename]` - Rollback a script
 * `rake scripts:cleanup` - Cleanup stale running scripts
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
-
-To install this gem onto your local machine, run `bundle exec rake install` .
-
-### Releasing a New Version
-
-#### Option 1: GitHub Actions (Recommended)
+## Releasing
 
-The easiest way to release is using GitHub Actions:
+### GitHub Actions (Recommended)
 
-1. Go to the **Actions** tab in GitHub
-2. Select **Release** workflow
-3. Click **Run workflow**
-4. Enter the version number (e.g., `0.1.1`)
-5. Click **Run workflow**
+1. Go to **Actions** → **Release** workflow
+2. Click **Run workflow**
+3. Enter version number (e.g., `0.1.3`)
 
-The workflow will:
-* Run all tests across multiple Ruby versions
-* Update version and CHANGELOG
-* Build the gem
-* Create git tag
-* Push to git
-* Push to RubyGems automatically
-
-**Required Secrets**: Set `RUBYGEMS_AUTH_TOKEN` in GitHub repository secrets.
-
-#### Option 2: Local Release Script
-
-To release locally, use the release script:
+Or push a tag:
 
 ```bash
-bin/release 0.1.1
+git tag -a v0.1.3 -m "Release version 0.1.3"
+git push origin v0.1.3
 ```
 
-The release script will:
-* Run all tests to ensure everything passes
-* Update the version in `lib/script_tracker/version.rb`
-* Update `CHANGELOG.md` with the new version
-* Build the gem
-* Create a git tag
-* Push to git (if remote configured)
-* Push to RubyGems
-
-**Note**: The script requires:
-* All tests passing
-* No uncommitted changes
-* RubyGems credentials configured (`gem credentials`)
-
-#### Option 3: Rake Task
+**Required:** Set `RUBYGEMS_AUTH_TOKEN` in GitHub repository secrets.
 
-Alternatively, you can use the rake task:
+### Local Release
 
 ```bash
-bundle exec rake release
+bin/release 0.1.3
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/a-abdellatif98/script_tracker.
+Bug reports and pull requests welcome at https://github.com/a-abdellatif98/script_tracker.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+MIT License - see LICENSE file for details.

data/lib/script_tracker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScriptTracker
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: script_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ahmed Abd El-Latif