iron-cms 0.1.3 → 0.2.0

data/app/models/iron/content_import/session.rb

@@ -0,0 +1,89 @@
+require "csv"
+
+module Iron
+  class ContentImport::Session
+      attr_reader :errors
+
+      def initialize(archive)
+        raise ArgumentError, "Missing import archive" unless archive.present?
+
+        @archive = archive
+        @errors = []
+        @registry = ContentImport::Registry.new
+      end
+
+      def run
+        ActiveRecord::Base.transaction do
+          prepare_entries
+          reconstruct_entries
+
+          Result.new(success: true)
+        end
+      rescue StandardError => e
+        warn e.full_message
+        @errors << "Import failed: #{e.message}"
+        Result.new(success: false, errors: @errors)
+      end
+
+      private
+
+        def prepare_entries
+          content_manifests.each do |content_type, csv_data|
+            entry_builder = ContentImport::EntryBuilder.new(content_type, @registry)
+            entry_builder.ensure_entries_exist(csv_data)
+          end
+        end
+
+        def reconstruct_entries
+          content_manifests.each do |content_type, csv_data|
+            reconstructor = ContentImport::FieldReconstructor.new(content_type, @registry, @archive)
+            reconstructor.reconstruct_all(csv_data)
+          end
+        end
+
+        def content_manifests
+          @content_manifests ||= build_content_manifests
+        end
+
+        def build_content_manifests
+          @archive.file_paths
+            .select { |path| content_manifest?(path) }
+            .sort
+            .filter_map do |path|
+              content_type = find_content_type(path)
+
+              unless content_type
+                @errors << "Unknown content type '#{extract_handle(path)}' in archive"
+                next
+              end
+
+              [ content_type, @archive[path] ]
+            end
+        end
+
+        def content_manifest?(path)
+          path.start_with?("content/") && path.end_with?(".csv")
+        end
+
+        def extract_handle(path)
+          ::File.basename(path, ".csv")
+        end
+
+        def find_content_type(path)
+          Iron::ContentType.find_by(handle: extract_handle(path))
+        end
+
+      class Result
+        attr_reader :errors
+
+        def initialize(success:, errors: [])
+          @success = success
+          @errors = errors
+        end
+
+        def success?
+          @success
+        end
+      end
+  end
+end

data/app/models/iron/content_import.rb

@@ -0,0 +1,15 @@
+module Iron
+  class ContentImport
+    def self.import(archive)
+      new(archive).import
+    end
+
+    def initialize(archive)
+      @archive = archive
+    end
+
+    def import
+      Session.new(@archive).run
+    end
+  end
+end

data/app/models/iron/current.rb

@@ -4,9 +4,10 @@ module Iron
     delegate :user, to: :session, allow_nil: true
 
     attribute :locale
+    attribute :account
 
     def account
-      Account.first
+      super || (self.account = Account.first)
     end
   end
 end

data/app/models/iron/entry/portable.rb

@@ -0,0 +1,35 @@
+module Iron
+  class Entry
+    module Portable
+      extend ActiveSupport::Concern
+
+      def to_csv_rows
+        rows = []
+
+        rows.concat(entry_attribute_rows)
+
+        fields.where(parent_type: nil).includes(:locale, :definition).each do |field|
+          rows.concat(field.to_csv_rows)
+        end
+
+        rows
+      end
+
+      private
+
+        def entry_attribute_rows
+          rows = []
+
+          rows << csv_row("/created_at", "date", created_at.iso8601)
+          rows << csv_row("/updated_at", "date", updated_at.iso8601)
+          rows << csv_row("/route", "text", route) unless route.nil?
+
+          rows
+        end
+
+        def csv_row(path, type, value)
+          [ to_gid, nil, path, type, value ]
+        end
+    end
+  end
+end

data/app/models/iron/entry.rb

@@ -1,6 +1,6 @@
 module Iron
   class Entry < ApplicationRecord
-    include Titlable, Schemable, WebPublishable, Presentable, DeepValidation
+    include Titlable, Schemable, WebPublishable, Presentable, DeepValidation, InstanceScoped, Portable
 
     belongs_to :creator, class_name: "Iron::User", default: -> { Current.user }
     has_many :fields, inverse_of: :entry, dependent: :destroy

data/app/models/iron/field/portable.rb

@@ -0,0 +1,33 @@
+module Iron
+  class Field
+    module Portable
+      extend ActiveSupport::Concern
+
+      def to_csv_rows
+        [ csv_row(field_path, csv_type, csv_value) ]
+      end
+
+      def field_path
+        if parent.is_a?(Fields::Block)
+          "#{parent.field_path}/#{definition.handle}"
+        elsif parent.is_a?(Fields::BlockList)
+          "#{parent.field_path}/#{rank}"
+        else
+          "/fields/#{definition.handle}"
+        end
+      end
+
+      def csv_row(path, type, value = nil)
+        [ entry.to_gid, locale&.code, path, type, value ]
+      end
+
+        def csv_type
+          raise NotImplementedError, "#{self.class} must implement csv_type"
+        end
+
+        def csv_value
+          raise NotImplementedError, "#{self.class} must implement csv_value"
+        end
+    end
+  end
+end

data/app/models/iron/field.rb

@@ -1,6 +1,6 @@
 module Iron
   class Field < ApplicationRecord
-    include BelongsToEntry
+    include BelongsToEntry, Portable
 
     TYPES = %w[text_field text_area rich_text_area number file boolean date block block_list reference_list reference].freeze
 

data/app/models/iron/fields/block.rb

@@ -6,7 +6,15 @@ module Iron
     has_rank scoped_by: :parent
 
     def block_list
-      parent.is_a?(Iron::Fields::BlockList) ? parent : nil
+      parent.is_a?(Fields::BlockList) ? parent : nil
+    end
+
+    def block_definition
+      if definition.is_a?(FieldDefinitions::Block)
+        definition.supported_block_definition
+      else
+        definition
+      end
     end
 
     def find_or_build_field(definition)
@@ -14,13 +22,7 @@ module Iron
     end
 
     def value
-      locale = Iron::Current.locale || Iron::Locale.default
-
-      block_definition = if definition.is_a?(Iron::FieldDefinitions::Block)
-        definition.supported_block_definition
-      else
-        definition
-      end
+      locale = Current.locale || Locale.default
 
       result = OpenStruct.new(id: id, _type: block_definition.handle)
 
@@ -36,5 +38,17 @@ module Iron
 
       result
     end
+
+    def to_csv_rows
+      rows = []
+
+      rows << csv_row("#{field_path}/_block", "text", block_definition.handle)
+
+      fields.includes(:locale, :definition).each do |nested_field|
+        rows.concat(nested_field.to_csv_rows)
+      end
+
+      rows
+    end
   end
 end

data/app/models/iron/fields/block_list.rb

@@ -12,5 +12,15 @@ module Iron
     def value
       blocks.map(&:value)
     end
+
+    def to_csv_rows
+      rows = []
+
+      blocks.includes(:fields, :locale, :definition).each do |block|
+        rows.concat(block.to_csv_rows)
+      end
+
+      rows
+    end
   end
 end

data/app/models/iron/fields/boolean.rb

@@ -3,5 +3,15 @@ module Iron
     def value
       value_boolean
     end
+
+    private
+
+      def csv_type
+        "boolean"
+      end
+
+      def csv_value
+        value_boolean&.to_s
+      end
   end
 end

data/app/models/iron/fields/date.rb

@@ -3,5 +3,15 @@ module Iron
     def value
       value_datetime
     end
+
+    private
+
+      def csv_type
+        "date"
+      end
+
+      def csv_value
+        value_datetime&.iso8601
+      end
   end
 end

data/app/models/iron/fields/file.rb

@@ -25,5 +25,13 @@ module Iron
           errors.add(:base, "must be one of the accepted formats: #{definition.accepted_extensions.join(', ')}")
         end
       end
+
+      def csv_type
+        "file"
+      end
+
+      def csv_value
+        file.attached? ? file.blob.id : nil
+      end
   end
 end

data/app/models/iron/fields/number.rb

@@ -3,5 +3,15 @@ module Iron
     def value
       value_float
     end
+
+    private
+
+      def csv_type
+        "number"
+      end
+
+      def csv_value
+        value_float&.to_s
+      end
   end
 end

data/app/models/iron/fields/reference.rb

@@ -10,5 +10,15 @@ module Iron
         )
       end
     end
+
+    private
+
+      def csv_type
+        "reference"
+      end
+
+      def csv_value
+        referenced_entry&.to_gid
+      end
   end
 end

data/app/models/iron/fields/reference_list.rb

@@ -13,5 +13,19 @@ module Iron
         )
       end
     end
+
+    def to_csv_rows
+      rows = []
+
+      references.includes(:entry).each do |reference|
+        rows << csv_row(
+          "#{field_path}/#{reference.rank}",
+          "reference",
+          reference.entry.to_gid
+        )
+      end
+
+      rows
+    end
   end
 end

data/app/models/iron/fields/rich_text_area.rb

@@ -5,5 +5,31 @@ module Iron
     def value
       rich_text&.to_s
     end
+
+    def to_csv_rows
+      rows = []
+
+      if rich_text.present?
+        rows << csv_row("#{field_path}/html", "rich_text", rich_text.body&.to_html)
+
+        rich_text.body.attachables.each do |attachable|
+          next unless attachable.respond_to?(:blob)
+
+          rows << csv_row("#{field_path}/attachments", "reference", attachable.blob.id)
+        end
+      end
+
+      rows
+    end
+
+    private
+
+      def csv_type
+        "rich_text"
+      end
+
+      def csv_value
+        rich_text.body&.to_html
+      end
   end
 end

data/app/models/iron/fields/text_area.rb

@@ -3,5 +3,15 @@ module Iron
     def value
       value_text
     end
+
+    private
+
+      def csv_type
+        "text"
+      end
+
+      def csv_value
+        value_text
+      end
   end
 end

data/app/models/iron/fields/text_field.rb

@@ -15,5 +15,13 @@ module Iron
           errors.add(:base, :blank)
         end
       end
+
+      def csv_type
+        "text"
+      end
+
+      def csv_value
+        value_string
+      end
   end
 end

data/app/models/iron/locale.rb

@@ -11,7 +11,7 @@ module Iron
     end
 
     def self.default
-      Account.first&.default_locale
+      Current.account&.default_locale
     end
 
     def default?

data/app/views/iron/contents/new.html.erb

@@ -0,0 +1,34 @@
+<% content_for :title, "Import Content" %>
+
+<div class="">
+  <%= back_button_to "Settings", settings_path %>
+  <h1 class="page-title">Import Content</h1>
+  <p class="mt-2 text-sm text-stone-500">Upload a content archive exported from another Iron instance.</p>
+
+  <%= form_with url: import_content_path, multipart: true, class: "mt-8 max-w-2xl", data: { turbo: false } do |form| %>
+    <div class="field-group">
+      <div class="field">
+        <%= form.label :content_file, "Content Archive" %>
+        <div>
+          <%= form.file_field :content_file,
+              accept: ".tar",
+              required: true,
+              class: "input" %>
+          <p class="mt-2 text-sm text-stone-500">Select a .tar file exported using Iron's content export.</p>
+        </div>
+      </div>
+
+      <div class="field">
+        <label class="text-sm font-medium text-stone-700">Import behaviour</label>
+        <p class="text-sm text-stone-500 mt-1">
+          Entries with matching IDs and instance tokens are updated. Other records are created.
+        </p>
+      </div>
+    </div>
+
+    <div class="mt-6 flex items-center gap-x-3">
+      <%= form.submit "Import Content", class: "btn" %>
+      <%= link_to "Cancel", settings_path, class: "btn", data: { variant: "plain" } %>
+    </div>
+  <% end %>
+</div>

data/app/views/iron/settings/show.html.erb

@@ -35,4 +35,23 @@
       </div>
     <% end %>
   </div>
+
+  <div class="bg-white dark:bg-stone-800/50 rounded-lg shadow-sm p-6 max-w-96">
+    <h2 class="text-lg font-semibold mb-4">Content Management</h2>
+    <p class="text-sm text-stone-600 dark:text-stone-400 mb-4">
+      Export content entries and their files or import an archive from another instance.
+    </p>
+    <div class="flex flex-col gap-2">
+      <%= link_to "Export Content",
+        export_content_path,
+        class: "btn",
+        data: {
+          turbo: false,
+        } %>
+      <%= link_to "Import Content",
+        new_content_path,
+        class: "btn",
+        data: { variant: "secondary" } %>
+    </div>
+  </div>
 </div>

data/config/routes.rb

@@ -22,6 +22,11 @@ Iron::Engine.routes.draw do
     post :import, on: :member
   end
 
+  resource :content, only: [ :new ] do
+    get :export, on: :collection
+    post :import, on: :collection
+  end
+
   resources :block_definitions do
     resources :field_definitions, shallow: true, module: :block_definitions
   end

data/db/migrate/20250908203158_add_instance_token_to_iron_accounts.rb

@@ -0,0 +1,6 @@
+class AddInstanceTokenToIronAccounts < ActiveRecord::Migration[8.0]
+  def change
+    add_column :iron_accounts, :instance_token, :string
+    add_index :iron_accounts, :instance_token, unique: true
+  end
+end

data/lib/iron/engine.rb

@@ -31,6 +31,15 @@ module Iron
       app.config.active_storage.analyzers.prepend Iron::ImageAnalyzer
     end
 
+    initializer "iron.global_id_locator" do |app|
+      app.config.after_initialize do
+        global_id_app = ::GlobalID.app || ::Rails.application.config.try(:global_id)&.app
+        next unless global_id_app
+
+        ::GlobalID::Locator.use(global_id_app, Iron::GlobalID::InstanceScopedLocator.new)
+      end
+    end
+
     config.to_prepare do
       ActionView::Base.include(Module.new do
         def attachment_url(attachment, **options)

data/lib/iron/global_id/instance_scoped_locator.rb

@@ -0,0 +1,29 @@
+require "globalid"
+
+module Iron
+  module GlobalID
+    class InstanceScopedLocator < ::GlobalID::Locator::UnscopedLocator
+      def locate(gid, options = {})
+        return unless instance_matches?(gid)
+
+        super
+      end
+
+      def locate_many(gids, options = {})
+        filtered_gids = gids.select { |candidate| instance_matches?(candidate) }
+        return [] if filtered_gids.empty?
+
+        super(filtered_gids, options)
+      end
+
+      private
+
+        def instance_matches?(gid)
+          instance_token = gid.params[:instance]
+          return true if instance_token.blank?
+
+          Current.account&.instance_token == instance_token
+        end
+    end
+  end
+end

data/lib/iron/version.rb

@@ -1,3 +1,3 @@
 module Iron
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/iron.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron-cms
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Massimo De Marchi
@@ -198,6 +198,7 @@ files:
 - app/controllers/iron/blocks_controller.rb
 - app/controllers/iron/content_types/field_definitions_controller.rb
 - app/controllers/iron/content_types_controller.rb
+- app/controllers/iron/contents_controller.rb
 - app/controllers/iron/entries_controller.rb
 - app/controllers/iron/field_definitions_controller.rb
 - app/controllers/iron/first_runs_controller.rb
@@ -239,11 +240,21 @@ files:
 - app/mailers/iron/application_mailer.rb
 - app/mailers/passwords_mailer.rb
 - app/models/concerns/iron/csv_serializable.rb
+- app/models/concerns/iron/instance_scoped.rb
 - app/models/iron/account.rb
 - app/models/iron/account/joinable.rb
 - app/models/iron/application_record.rb
+- app/models/iron/archive.rb
 - app/models/iron/block_definition.rb
 - app/models/iron/block_definition/portable.rb
+- app/models/iron/content_export.rb
+- app/models/iron/content_import.rb
+- app/models/iron/content_import/entry_builder.rb
+- app/models/iron/content_import/entry_snapshot.rb
+- app/models/iron/content_import/field_reconstructor.rb
+- app/models/iron/content_import/field_snapshot.rb
+- app/models/iron/content_import/registry.rb
+- app/models/iron/content_import/session.rb
 - app/models/iron/content_type.rb
 - app/models/iron/content_type/field_queryable.rb
 - app/models/iron/content_type/portable.rb
@@ -254,12 +265,14 @@ files:
 - app/models/iron/current.rb
 - app/models/iron/entry.rb
 - app/models/iron/entry/deep_validation.rb
+- app/models/iron/entry/portable.rb
 - app/models/iron/entry/presentable.rb
 - app/models/iron/entry/schemable.rb
 - app/models/iron/entry/titlable.rb
 - app/models/iron/entry/web_publishable.rb
 - app/models/iron/field.rb
 - app/models/iron/field/belongs_to_entry.rb
+- app/models/iron/field/portable.rb
 - app/models/iron/field_definition.rb
 - app/models/iron/field_definition/portable.rb
 - app/models/iron/field_definitions/block.rb
@@ -312,6 +325,7 @@ files:
 - app/views/iron/content_types/index.html.erb
 - app/views/iron/content_types/new.html.erb
 - app/views/iron/content_types/show.html.erb
+- app/views/iron/contents/new.html.erb
 - app/views/iron/entries/_entry.html.erb
 - app/views/iron/entries/_entry_option.html.erb
 - app/views/iron/entries/_form.html.erb
@@ -394,6 +408,7 @@ files:
 - db/migrate/20250601080146_add_icon_to_iron_content_types.rb
 - db/migrate/20250609091605_add_web_publishing_to_iron_content_types.rb
 - db/migrate/20250609091813_add_route_to_iron_entries.rb
+- db/migrate/20250908203158_add_instance_token_to_iron_accounts.rb
 - lib/generators/iron/pages/pages_generator.rb
 - lib/generators/iron/pages/templates/pages_controller.rb
 - lib/generators/iron/pages/templates/show.html.erb
@@ -403,6 +418,7 @@ files:
 - lib/iron.rb
 - lib/iron/cva.rb
 - lib/iron/engine.rb
+- lib/iron/global_id/instance_scoped_locator.rb
 - lib/iron/image_analyzer.rb
 - lib/iron/lexorank.rb
 - lib/iron/lexorank/exceptions.rb