historiographer 4.4.1 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9299cb62bdfd77ef8cec2c614a592166c67d489a1c36a77d83d78eb3dca48d1
-  data.tar.gz: 9e03988f85e756bbbc2789c86dc4df255df837aef07bdc718ee2774f5a5956cb
+  metadata.gz: e539c6a610a6dd526ea49199d9d8f773dc8528c5e50960b3fc40615d87d81ffb
+  data.tar.gz: cc44f3a4a98e65763b27b869a36e4b8997e4bd9e3b1f988ee07a267b0b346dd3
 SHA512:
-  metadata.gz: 70e7054198d9010c9d7cc01986e9d8d92b64f4f6a65d4ba2c96d66b7d903d07dd21ac2690407ff40d8bfd685c174e1f9c65b0c659e7d915d1398a637808435bb
-  data.tar.gz: b2ccf22179ec57e5cf045628eadd76b7e755ac3d9951b838030d72f132461f524752774e5d5baeefcb01bfdb6a47a430c8eaa08ed6382fa54dddb84ec5b1ec6d
+  metadata.gz: fb5d80e2d90f8c5dc2172b1a81f75b646750c3eff34c2921fa3a454d7905d05e59420c86c0b24d08eec96ace5f067e1b91e30c0d944675a84a2c5f2ad63e0fb8
+  data.tar.gz: 2fedc59aa4c1fcb684e43f18a03a686ffdf4137fcef83e086583d064491a9cb16b7b17ca46f4893b1a3d83cdc4bc6a3977de4ae534454895fa0a53e0b7bdcf2d

data/DEVELOPMENT.md

@@ -0,0 +1,124 @@
+# Historiographer Development Guide
+
+## Quick Start
+
+```bash
+# Initial setup
+bin/setup
+
+# Run tests
+bin/test        # Regular test suite (fast)
+bin/test-rails  # Rails integration tests (slower)
+bin/test-all    # Both test suites
+
+# Interactive console
+bin/console
+```
+
+## Available Commands
+
+### Using Rake Tasks
+
+```bash
+# Testing
+rake spec           # Run regular specs (default)
+rake spec:regular   # Run regular specs explicitly
+rake spec:rails     # Run Rails integration specs
+rake spec:all       # Run all specs
+
+# Database
+rake db:create      # Create test database
+rake db:migrate     # Run migrations
+rake db:rollback    # Rollback migrations
+rake test_setup     # Setup test database
+rake test_reset     # Reset test database
+
+# Other
+rake console        # Launch console with gem loaded
+rake help           # List all available tasks
+```
+
+### Using Bin Scripts
+
+All scripts are in the `bin/` directory:
+
+- `bin/setup` - Initial development setup
+- `bin/test` - Run regular test suite
+- `bin/test-rails` - Run Rails integration tests  
+- `bin/test-all` - Run all tests
+- `bin/console` - Interactive console
+
+### Direct Commands
+
+```bash
+# Run specific tests
+bundle exec rspec spec/historiographer_spec.rb
+bundle exec rspec spec/historiographer_spec.rb:100  # Run specific line
+
+# Rails integration tests only
+bundle exec rspec spec/rails_integration
+
+# Database operations
+bundle exec rake db:create
+bundle exec rake db:migrate
+bundle exec rake db:rollback
+```
+
+## Test Organization
+
+The test suite is split into two parts:
+
+1. **Regular Tests** (`spec/*.rb`, `spec/models/*.rb`, etc.)
+   - Fast, lightweight Rails simulation
+   - Uses standalone_migrations
+   - Default when running `rake spec` or `bin/test`
+
+2. **Rails Integration Tests** (`spec/rails_integration/*.rb`)
+   - Uses Combustion to create a real Rails app
+   - Tests Rails-specific behaviors like autoloading
+   - Run separately with `rake spec:rails` or `bin/test-rails`
+
+## Database Setup
+
+The gem uses PostgreSQL for testing. Two databases are used:
+
+1. `historiographer_test` - Main test database
+2. `historiographer_combustion_test` - Rails integration test database
+
+Configure database connection in:
+- `spec/db/database.yml` - Main test database
+- `spec/internal/config/database.yml` - Combustion test database
+
+## Adding New Tests
+
+### Regular Tests
+Place in `spec/` directory. Models go in `spec/models/`.
+
+### Rails Integration Tests  
+Place in `spec/rails_integration/`. These tests use Combustion and require:
+```ruby
+require 'combustion_helper'
+```
+
+## Debugging
+
+```bash
+# Launch console with all models loaded
+bin/console
+
+# Or with rake
+rake console
+
+# Or manually
+bundle exec pry -r ./init.rb
+```
+
+## Gem Development
+
+```bash
+# Build gem
+rake build
+
+# Release new version
+rake release
+```

data/Gemfile

@@ -25,9 +25,11 @@ group :development do
 end
 
 group :test do
+  gem 'combustion', '~> 1.3'
   gem 'database_cleaner'
   gem 'factory_bot_rails'
   gem 'guard'
   gem 'guard-rspec'
   gem 'rspec'
+  gem 'rspec-rails'
 end

data/Gemfile.lock

@@ -103,6 +103,10 @@ GEM
     bigdecimal (3.1.8)
     builder (3.3.0)
     coderay (1.1.3)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
@@ -281,6 +285,14 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
+    rspec-rails (7.1.1)
+      actionpack (>= 7.0)
+      activesupport (>= 7.0)
+      railties (>= 7.0)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
     rspec-support (3.13.1)
     securerandom (0.3.1)
     semver2 (3.4.2)
@@ -317,6 +329,7 @@ DEPENDENCIES
   activerecord (>= 6)
   activerecord-import
   activesupport
+  combustion (~> 1.3)
   database_cleaner
   factory_bot_rails
   guard
@@ -330,6 +343,7 @@ DEPENDENCIES
   rdoc (~> 3.12)
   rollbar
   rspec
+  rspec-rails
   simplecov
   standalone_migrations
   timecop

data/README.md

@@ -358,7 +358,22 @@ For contributors on OSX, you may have difficulty installing mysql:
 gem install mysql2 -v '0.4.10' --source 'https://rubygems.org/' -- --with-ldflags=-L/usr/local/opt/openssl/lib --with-cppflags=-I/usr/local/opt/openssl/include
 ```
 
+== Testing
+
+```bash
+# Initial setup
+bin/setup
+
+# Run tests
+bin/test        # Regular test suite (fast)
+bin/test-rails  # Rails integration tests (slower)
+bin/test-all    # Both test suites
+
+# Interactive console
+bin/console
+```
+
 == Copyright
 
-Copyright (c) 2016-2020 brettshollenberger. See LICENSE.txt for
+Copyright (c) 2016-2025 brettshollenberger. See LICENSE.txt for
 further details.

data/Rakefile

@@ -52,3 +52,57 @@ end
 
 require 'standalone_migrations'
 StandaloneMigrations::Tasks.load_tasks
+
+# Custom tasks for common operations
+namespace :spec do
+  require 'rspec/core/rake_task'
+  
+  desc "Run regular specs (excluding Rails integration)"
+  RSpec::Core::RakeTask.new(:regular) do |t|
+    t.rspec_opts = "--exclude-pattern spec/rails_integration/**/*_spec.rb"
+  end
+  
+  desc "Run Rails integration specs with Combustion"
+  RSpec::Core::RakeTask.new(:rails) do |t|
+    t.pattern = "spec/rails_integration/**/*_spec.rb"
+  end
+  
+  desc "Run all specs (regular and Rails integration separately)"
+  task :all do
+    puts "\n========== Running Regular Specs ==========\n"
+    Rake::Task['spec:regular'].invoke
+    puts "\n========== Running Rails Integration Specs ==========\n"
+    Rake::Task['spec:rails'].invoke
+  end
+end
+
+desc "Run regular test suite (default)"
+task :spec => 'spec:regular'
+
+desc "Setup test database"
+task :test_setup do
+  sh "bundle exec rake db:create"
+  sh "bundle exec rake db:migrate"
+end
+
+desc "Reset test database"
+task :test_reset do
+  sh "bundle exec rake db:drop"
+  sh "bundle exec rake db:create"
+  sh "bundle exec rake db:migrate"
+end
+
+desc "Run linting and type checking"
+task :lint do
+  puts "No linting configured yet. Consider adding rubocop."
+end
+
+desc "Console with the gem loaded"
+task :console do
+  sh "bundle exec pry -r ./init.rb"
+end
+
+desc "List all available tasks"
+task :help do
+  sh "rake -T"
+end

data/VERSION

@@ -1 +1 @@
-4.4.1
+4.4.3

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# Launch an interactive console with the gem loaded
+
+require "bundler/setup"
+require "pry"
+require_relative "../init"
+
+puts "Loading Historiographer console..."
+puts "Models available: Post, Author, Comment, User, etc."
+Pry.start

data/bin/setup

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# Setup script for development
+
+puts "Setting up Historiographer development environment..."
+
+system("bundle install")
+system("bundle exec rake db:create")
+system("bundle exec rake db:migrate")
+system("createdb historiographer_combustion_test 2>/dev/null")
+
+puts "\nSetup complete! You can now run:"
+puts "  bin/test        - Run regular tests"
+puts "  bin/test-rails  - Run Rails integration tests"
+puts "  bin/test-all    - Run all tests"
+puts "  bin/console     - Launch interactive console"

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# Run the regular test suite (excluding Rails integration tests)
+
+puts "Running regular test suite..."
+exec "bundle exec rspec --exclude-pattern spec/rails_integration/**/*_spec.rb"

data/bin/test-all

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# Run all tests (regular and Rails integration)
+
+puts "\n========== Running Regular Test Suite ==========\n"
+system("bundle exec rspec --exclude-pattern spec/rails_integration/**/*_spec.rb")
+
+puts "\n========== Running Rails Integration Tests ==========\n"
+system("bundle exec rspec spec/rails_integration")
+
+exit($?.exitstatus || 0)

data/bin/test-rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# Run Rails integration tests with Combustion
+
+puts "Running Rails integration tests..."
+exec "bundle exec rspec spec/rails_integration/historiographer_rails_integration_spec.rb"

data/historiographer.gemspec

@@ -2,18 +2,19 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: historiographer 4.4.1 ruby lib
+# stub: historiographer 4.4.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "historiographer".freeze
-  s.version = "4.4.1"
+  s.version = "4.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["brettshollenberger".freeze]
-  s.date = "2025-08-21"
+  s.date = "2025-08-22"
   s.description = "Creates separate tables for each history table".freeze
   s.email = "brett.shollenberger@gmail.com".freeze
+  s.executables = ["console".freeze, "setup".freeze, "test".freeze, "test-all".freeze, "test-rails".freeze]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -23,6 +24,7 @@ Gem::Specification.new do |s|
     ".rspec",
     ".ruby-version",
     ".standalone_migrations",
+    "DEVELOPMENT.md",
     "Gemfile",
     "Gemfile.lock",
     "Guardfile",
@@ -30,6 +32,11 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/console",
+    "bin/setup",
+    "bin/test",
+    "bin/test-all",
+    "bin/test-rails",
     "historiographer-4.1.12.gem",
     "historiographer-4.1.13.gem",
     "historiographer-4.1.14.gem",
@@ -49,6 +56,7 @@ Gem::Specification.new do |s|
     "lib/historiographer/safe.rb",
     "lib/historiographer/silent.rb",
     "lib/historiographer/version.rb",
+    "spec/combustion_helper.rb",
     "spec/db/database.yml",
     "spec/db/migrate/20161121212228_create_posts.rb",
     "spec/db/migrate/20161121212229_create_post_histories.rb",
@@ -67,13 +75,30 @@ Gem::Specification.new do |s|
     "spec/db/migrate/20241119000000_create_datasets.rb",
     "spec/db/migrate/2025082100000_create_projects.rb",
     "spec/db/migrate/2025082100001_create_project_files.rb",
+    "spec/db/migrate/20250823000000_create_easy_ml_columns.rb",
+    "spec/db/migrate/20250824000000_create_test_articles.rb",
+    "spec/db/migrate/20250824000001_create_test_categories.rb",
+    "spec/db/migrate/20250825000000_create_bylines.rb",
+    "spec/db/migrate/20250826000000_create_test_users.rb",
+    "spec/db/migrate/20250826000001_create_test_user_histories.rb",
+    "spec/db/migrate/20250826000002_create_test_websites.rb",
+    "spec/db/migrate/20250826000003_create_test_website_histories.rb",
     "spec/db/schema.rb",
     "spec/factories/post.rb",
-    "spec/foreign_key_spec.rb",
     "spec/historiographer_spec.rb",
+    "spec/integration/historiographer_safe_integration_spec.rb",
+    "spec/internal/app/models/application_record.rb",
+    "spec/internal/app/models/deploy.rb",
+    "spec/internal/app/models/user.rb",
+    "spec/internal/app/models/website.rb",
+    "spec/internal/app/models/website_history.rb",
+    "spec/internal/config/database.yml",
+    "spec/internal/config/routes.rb",
+    "spec/internal/db/schema.rb",
     "spec/models/application_record.rb",
     "spec/models/author.rb",
     "spec/models/author_history.rb",
+    "spec/models/byline.rb",
     "spec/models/comment.rb",
     "spec/models/comment_history.rb",
     "spec/models/easy_ml/column.rb",
@@ -88,10 +113,19 @@ Gem::Specification.new do |s|
     "spec/models/safe_post_history.rb",
     "spec/models/silent_post.rb",
     "spec/models/silent_post_history.rb",
+    "spec/models/test_article.rb",
+    "spec/models/test_article_history.rb",
+    "spec/models/test_category.rb",
+    "spec/models/test_category_history.rb",
+    "spec/models/test_user.rb",
+    "spec/models/test_user_history.rb",
+    "spec/models/test_website.rb",
+    "spec/models/test_website_history.rb",
     "spec/models/thing_with_compound_index.rb",
     "spec/models/thing_with_compound_index_history.rb",
     "spec/models/thing_without_history.rb",
     "spec/models/user.rb",
+    "spec/rails_integration/historiographer_rails_integration_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/brettshollenberger/historiographer".freeze