iron-cms 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dc16db2bf8c1ee5f0cca129113aed94f3064d405ae13b7a8a80cc2f601c4a4f
-  data.tar.gz: ff04983432ca9fce51945b29625144685b082047278f6afda51a057e70040b5a
+  metadata.gz: 8d019cb05573756b7d61bd6eaafe23f1bfecc02df82b9bbb0533909aa432d2aa
+  data.tar.gz: 5a71d2e8cded815151c6d2bf4c8b349340a532aab46428e3841f0289633ec473
 SHA512:
-  metadata.gz: 8f1b195f43f04b198e29f18c8bae4dde22424dd869435db76c1e1ea644f8756e67ca0f0cd6f81b4b83410687c664e14952448b599125630c12a13dc547f744a8
-  data.tar.gz: c3c3fa9ae10cb698dac50abdac3f36fd6d0342f2ca7800e8d42445330fdb7863faab8a562b57d2d432a71e50ba7a12138d90592b77557a455e55a0899bfb5fba
+  metadata.gz: edd018af4978ff7bf85c1dae55ea57e99b272444bed821812b4e2bba5a887c46db039f37338f565999d2260ff0e0c701c51ae9edfd43141a49cbd6129d01c758
+  data.tar.gz: 5b49d870736b4ecf0ca3b4d497be6c7697d94ab2bf19f8441458d175de08e60f8f777872acb05b327840b1a39a8a4150c5c68aa7fc19478dce2f397dc5c2d86b

data/README.md

@@ -9,6 +9,7 @@ Iron is a flexible CMS engine for Rails apps
 Iron CMS allows you to publish content types to your website. To set this up:
 
 1. **Install the pages controller** in your application:
+
    ```bash
    bin/rails g iron:pages
    ```
@@ -19,6 +20,7 @@ Iron CMS allows you to publish content types to your website. To set this up:
    - Create a default view template
 
 2. **Create custom templates** for your content types:
+
    ```bash
    bin/rails g iron:template article
    ```
@@ -60,6 +62,7 @@ Use `iron_picture_tag` for optimal image delivery:
 ```
 
 This automatically:
+
 - Generates responsive variants (150w, 320w, 640w, 1024w, 1920w)
 - Serves modern formats (AVIF, WebP) with automatic fallback
 - Adds proper dimensions to prevent layout shift
@@ -93,6 +96,38 @@ For cases where you need a basic responsive image without format optimization:
 
 This generates a standard `<img>` with srcset but without modern format variants.
 
+### Testing
+
+Iron provides test fixtures to populate your test database with CMS schema and content, eliminating the need to stub the SDK in your tests.
+
+#### Generating Fixtures
+
+Generate test fixtures from your development database (or production if you prefer):
+
+```bash
+bin/rails iron:fixtures:generate
+```
+
+This creates two files in `test/fixtures/iron/`:
+
+- `schema.tar.gz` - Content types, field definitions, and block definitions
+- `content.tar.gz` - All entries and their field data
+
+Regenerate these fixtures whenever you make changes to your CMS schema or content that you want reflected in tests.
+
+#### Using Fixtures in Tests
+
+Load the fixtures in your `test/test_helper.rb`:
+
+```ruby
+class ActiveSupport::TestCase
+  fixtures :all
+  Iron::TestFixtures.load
+end
+```
+
+The fixtures are loaded once at the start of your test suite. Rails' transactional tests provide test isolation by rolling back changes after each test.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -174,6 +209,7 @@ To release a new version of the Iron gem:
    - Update `CHANGELOG.md` with the changes for the new version
 
 2. **Commit and tag the release:**
+
    ```bash
    git add -A
    git commit -m "chore: release version X.Y.Z"
@@ -181,11 +217,13 @@ To release a new version of the Iron gem:
    ```
 
 3. **Push to GitHub:**
+
    ```bash
    git push origin main --tags
    ```
 
 4. **Build and publish the gem:**
+
    ```bash
    gem build iron.gemspec
    gem push iron-X.Y.Z.gem

data/lib/iron/test_fixtures.rb

@@ -0,0 +1,50 @@
+require "stringio"
+
+module Iron
+  module TestFixtures
+    class << self
+      def load
+        return if @loaded
+
+        fixture_path = Rails.root.join("test/fixtures/iron")
+        schema_file = fixture_path.join("schema.tar.gz")
+        content_file = fixture_path.join("content.tar.gz")
+
+        if schema_file.exist?
+          load_schema(schema_file)
+        else
+          Rails.logger.warn "Iron test fixture not found: #{schema_file}"
+        end
+
+        if content_file.exist?
+          load_content(content_file)
+        else
+          Rails.logger.warn "Iron test fixture not found: #{content_file}"
+        end
+
+        @loaded = true
+      end
+
+      private
+
+        def load_schema(file_path)
+          File.open(file_path, "rb") do |file|
+            result = SchemaImporter.import(file, mode: "merge")
+            unless result.success?
+              raise "Failed to load Iron schema fixtures: #{result.errors.join(', ')}"
+            end
+          end
+        end
+
+        def load_content(file_path)
+          File.open(file_path, "rb") do |file|
+            archive = Archive.from_file(file)
+            result = ContentImport.import(archive)
+            unless result.success?
+              raise "Failed to load Iron content fixtures: #{result.errors.join(', ')}"
+            end
+          end
+        end
+    end
+  end
+end

data/lib/iron/version.rb

@@ -1,3 +1,3 @@
 module Iron
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/iron.rb

@@ -3,6 +3,7 @@ require "iron/engine"
 require "iron/cva"
 require "iron/sdk"
 require "iron/global_id/instance_scoped_locator"
+require "iron/test_fixtures"
 
 module Iron
   # Your code goes here...

data/lib/tasks/iron_tasks.rake

@@ -0,0 +1,24 @@
+namespace :iron do
+  namespace :fixtures do
+    desc "Generate test fixtures from current database"
+    task generate: :environment do
+      fixture_dir = Rails.root.join("test/fixtures/iron")
+      FileUtils.mkdir_p(fixture_dir)
+
+      schema_path = fixture_dir.join("schema.tar.gz")
+      content_path = fixture_dir.join("content.tar.gz")
+
+      puts "Exporting Iron schema to #{schema_path}..."
+      schema_tar = Iron::SchemaExporter.export
+      File.binwrite(schema_path, schema_tar)
+
+      puts "Exporting Iron content to #{content_path}..."
+      content_archive = Iron::ContentExport.export
+      content_archive.to_file(content_path)
+
+      puts "Test fixtures generated successfully!"
+      puts "  - Schema: #{schema_path}"
+      puts "  - Content: #{content_path}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron-cms
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Massimo De Marchi
@@ -427,8 +427,10 @@ files:
 - lib/iron/lexorank/utils.rb
 - lib/iron/routing.rb
 - lib/iron/sdk.rb
+- lib/iron/test_fixtures.rb
 - lib/iron/version.rb
 - lib/puma/plugin/iron_tailwindcss.rb
+- lib/tasks/iron_tasks.rake
 homepage: https://github.com/inkOfPixel/iron
 licenses:
 - MIT