rubyblok 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 387e9c3d34367e3cbc2f7bd45bb3c38358e203e009f0d7a79f77c2f0569e590c
-  data.tar.gz: 13d329d7a0d6498124ee602b9252722051b4bf6f01e62186cc9c6b61fd26da69
+  metadata.gz: 7012bc69cffbe4334c2176ae14a987af28f812c0a5587aecf579f13ce67e8b01
+  data.tar.gz: ace98ab94b1c2b10526c29fe24724d3cdcef12a76a172ea832d3c8ba38986d07
 SHA512:
-  metadata.gz: 663185c2a74652136c644306457bb110d5c67290826f100e14c4e033e543f7db68bdb24b1f8d5843d78d20e32760ddc861b8f57abedba05cf9da73092f36041f
-  data.tar.gz: b2000c3d50bc5eef358a3b2cffc43cb2e980f89f63cf0b8a8acc7ac83bfc568e3b0440fd0029473a4f3ba792fd9e416d7e85164eafcc03a4677f81e0082239be
+  metadata.gz: 8f420d367f94c54c3a2c7185e3785f72cbc7445e1323205bc962b6e48565f221c52ddcc534662864b7995ec8f1587dfd1ea915d4fe4479d507e61ae771562be9
+  data.tar.gz: c1f1266ef1eb592eb466bca2ba321bb1a7625248b2461e5696020234014f98d4d3d4d5b5ccbb3f234bcdcbf6689ff719c8bd093bc6b82446d4bc7d0b8fc6d87f

data/.rubocop.yml

@@ -6,146 +6,7 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 3.1.X
 
-Capybara/VisibilityMatcher:
-  Enabled: false
-
 Documentation:
   Enabled: false
-
-Layout/HashAlignment:
-  Enabled: false
 Layout/LineLength:
   Max: 120
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: aligned
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - spec/**/*
-Lint/IneffectiveAccessModifier:
-  Enabled: false
-Lint/MissingSuper:
-  Enabled: false
-Lint/RedundantSplatExpansion:
-  Enabled: false
-Lint/UriEscapeUnescape:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/ClassLength:
-  Max: 500
-Metrics/ModuleLength:
-  Max: 250
-  Exclude:
-    - spec/**/*
-Naming/AccessorMethodName:
-  Enabled: false
-Naming/BlockForwarding:
-  Enabled: false
-Naming/InclusiveLanguage:
-  Enabled: false
-Naming/FileName:
-  Enabled: false
-Naming/MemoizedInstanceVariableName:
-  Enabled: false
-Naming/PredicateName:
-  Enabled: false
-Naming/VariableNumber:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/ExponentialNotation:
-  Enabled: false
-Style/FetchEnvVar:
-  Enabled: true
-  Exclude:
-    - spec/**/*
-Style/FormatString:
-  Enabled: false
-Style/FormatStringToken:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/HashSyntax:
-  EnforcedStyle: ruby19
-Style/InPatternThen:
-  Enabled: false
-Style/MultilineInPatternThen:
-  Enabled: false
-Style/MapToHash:
-  Enabled: false
-Style/NumericLiteralPrefix:
-  Enabled: false
-Style/NumericPredicate:
-  Enabled: false
-Style/OpenStructUse:
-  Enabled: false
-Style/SafeNavigation:
-  Enabled: false
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma
-
-RSpec/AnyInstance:
-  Enabled: false
-RSpec/ChangeByZero:
-  Enabled: false
-RSpec/ContextWording:
-  Enabled: false
-RSpec/DescribedClass:
-  Enabled: false
-RSpec/DescribeClass:
-  Enabled: false
-RSpec/ExampleLength:
-  Enabled: false
-RSpec/ExampleWording:
-  Enabled: false
-RSpec/ExpectInHook:
-  Enabled: false
-RSpec/HooksBeforeExamples:
-  Enabled: false
-RSpec/ImplicitBlockExpectation:
-  Enabled: false
-RSpec/InstanceVariable:
-  Exclude:
-    - spec/views/**/*
-RSpec/LetBeforeExamples:
-  Enabled: false
-RSpec/LetSetup:
-  Enabled: false
-RSpec/MessageChain:
-  Enabled: false
-RSpec/MessageSpies:
-  Enabled: false
-RSpec/MultipleDescribes:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Enabled: false
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-RSpec/NamedSubject:
-  Enabled: false
-RSpec/NestedGroups:
-  Enabled: false
-RSpec/RepeatedDescription:
-  Enabled: false
-RSpec/RepeatedExampleGroupBody:
-  Enabled: false
-RSpec/RepeatedExampleGroupDescription:
-  Enabled: false
-RSpec/StubbedMock:
-  Enabled: false
-RSpec/VerifiedDoubles:
-  Enabled: false
-RSpec/VerifiedDoubleReference:
-  Enabled: false
-RSpec/FilePath:
-  Enabled: false
-RSpec/SpecFilePathFormat:
-  Enabled: false
-Style/FetchEnvVar:
-  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.2.0] - 2024-06-17
+
+### Added
+- Caching Storyblok images on S3
+- Fragment caching of Rubyblok components
+
 ## [1.1.0] - 2024-05-02
 
 ### Added

data/README.md

@@ -8,13 +8,18 @@ This integration allows you to edit your content online, preview it in real-time
 In addition, Rubyblok provides an abstraction layer and stores all your content locally, reducing data usage and enhancing performance. This enables new functionalities that leverage the local data, such as global content search, sitemaps, and listings. Ultimately, this setup increases resilience by eliminating dependency on external data sources.
 
 ## Table of Contents
-1. [Installation](#installation)
-2. [Getting Started](#getting-started)
-3. [Rubyblok tags](#rubyblok-tags)
-4. [How to Run Tests](#how-to-run-tests)
-5. [Guide for Contributing](#guide-for-contributing)
-6. [How to Contact Us](#how-to-contact-us)
-7. [License](#license)
+1.  [Installation](#installation)
+2.  [Getting Started](#getting-started)
+3.  [Rubyblok tags](#rubyblok-tags)
+4.  [Rubyblok workflows](#rubyblok-workflows)
+5.  [Rubyblok webhook](#rubyblok-webhook)
+6.  [Caching storyblok images](#caching-storyblok-images)
+7.  [Caching views](#caching-views)
+8.  [Sitemap configuration](#sitemap-configuration)
+9.  [How to Run Tests](#how-to-run-tests)
+10.  [Guide for Contributing](#guide-for-contributing)
+11. [How to Contact Us](#how-to-contact-us)
+12. [License](#license)
 
 ## Installation
 Rubyblok 1.0 works with Rails 6.0 onwards. Run:
@@ -29,28 +34,14 @@ Create a new Space, in _My Spaces > Add Space_. Select the free Community plan b
 
 Get your Storyblok API token in your account, at _Storyblok Space > Settings > Access tokens_ page. Copy the "Preview" access level key.
 
-Add the key to your `STORYBLOK_API_TOKEN` in your env file, like this example:
+Add the API token to your `config/initializers/rubyblok.rb` file:
 
 ```
-STORYBLOK_API_TOKEN=<your API token>
-```
-You will also need to add the variables below to your env file:
-```
-STORYBLOK_VERSION=draft
-STORYBLOK_WEBHOOK_SECRET=''
+config.api_token = <your API token>
 ```
 
 ## Getting Started
 
-### Necessary gems
-You need to add some gems to your app for Rubyblok to work correctly. Run the following commands:
-
-```bash
-bundle add "storyblok"
-bundle add "hash_dot"
-bundle add "dotenv-rails"
-```
-
 ### Hello world - Your first Rubyblok page
 Let's get started with Rubyblok by creating your first page in three steps.
 Note that it is important that you have your Storyblok space set up as described above, in the `Storyblok account and new space` section.
@@ -62,23 +53,23 @@ rails g rubyblok:install
 
 2. Now let's generate and run a migration to create the `pages` table and the `Page` model:
 ```bash
-rails g rubyblok:migration page
+rails g rubyblok:migration PAGE
 
 rails db:migrate
 ```
 
 3. Finally, let's generate your first page:
 ```bash
-rails g rubyblok:hello_world page
+rails g rubyblok:hello_world PAGE
 ```
-This will automatically create a new route, controller, views and styling for your hello world page.
+This will automatically create a new `/pages` route, a `PagesController`, views and styling for your hello world page.
 
-For this example, go to the `rubyblok.rb` file and turn the caching option off:
+For this example, go to the `config/initializers/rubyblok.rb` file and turn the caching option off:
 ```
 config.cached = false
 ```
 
-Now you have created your first Hello World page! Start your Rails server, access the '/pages' route and you will be able to see the page.
+Now you have created your first Hello World page! Start your Rails server, access the `/pages` route and you will be able to see the page.
 
 ### Activate the visual editor 
 Here are the steps to configure the visual editor at Storyblok. This allows you to see a preview of your changes in the Storyblok interface as you edit and save.
@@ -111,14 +102,6 @@ This will start a proxy server.
 
 By doing this initial setup, you are able to see your first Storyblok page inside your app and edit its content in the Storyblok admin interface 🎉
 
-### Storyblok webhook
-The Storyblok webhook will be responsible for updating and deleting content in the local database in case of changes. [Learn more here.](https://www.storyblok.com/docs/guide/in-depth/webhooks)
-
-Generate the webhook controller:
-```bash
-rails g rubyblok:webhook_controller storyblok_webhook
-```
-
 ## Rubyblok tags
 
 ### rubyblok_story_tag
@@ -127,7 +110,7 @@ Use this tag to render stories:
 # Slug: full_slug of the storyblok story
 <%= rubyblok_story_tag(slug) %>
 ```
-The name of the storyblok blok should match the rails partial, ie the `header` storyblok blok should have a corresponding `_header.html.erb` partial in the `config.component_path` directory. The partial is called with a `blok` local variable which contains the storyblok blok properties.
+The name of the storyblok block should match the rails partial, ie if the block is named `header`, it should have a corresponding `_header.html.erb` partial in the directory defined in `config.component_path`. The partial is called with a `blok` local variable which contains the storyblok block properties.
 
 ### rubyblok_content_tag
 It renders content of Text, TextArea, Markdown or Richtext storyblok fields.
@@ -165,10 +148,95 @@ Use this tag to render more than one component:
 In case you need to update the caching layer with new content added to Storyblok, run the following command:
 ```
 # Slug: full_slug of the storyblok story
-storyblok_story_content = Rubyblok::Services::GetStoryblokStory.call(slug: slug)
-<MODEL_NAME>.find_or_initialize_by(storyblok_story_slug: page)
-     .update(storyblok_story_content:, storyblok_story_id: storyblok_story_content["id"])
+storyblok_story = Rubyblok::Services::GetStoryblokStory.call(slug: slug)
+<MODEL_NAME>.find_or_create(storyblok_story)
+```
+
+## Rubyblok workflows
+
+### Non-cached mode (default)
+Rubyblok fetches the content via the Storyblok API and the content is not cached locally.
+
+### Cached mode
+Rubyblok fetches the content from the local database. This mode is useful ie. if you don't want to call the API on every page request or you want to index the content locally. To enable this mode you need to set the cached feature on in the `config/initializers/rubyblok.rb` file:
+```
+config.cached = true
+```
+
+If you want to update the local cache on every page request (ie. the content is not updated via the webhook), you need to set the auto_update feature on in the `config/initializers/rubyblok.rb` file:
+```
+config.auto_update = true
+```
+
+## Storyblok webhook
+The Storyblok webhook will be responsible for updating and deleting content in the local database in case of changes. [Learn more here.](https://www.storyblok.com/docs/guide/in-depth/webhooks)
+
+Generate the webhook controller:
+```bash
+rails g rubyblok:webhook_controller STORYBLOK_WEBHOOK
+```
+
+## Caching storyblok images
+You can store your storyblok images and videos on your own S3 storage by enabling this rubyblok feature.
+
+1. First, you need to run the image cache generator, which will create the model file, the uploader file and the carrierwave config file for you:
+```bash
+rails g rubyblok:image_cache STORYBLOK_IMAGE
+```
+
+2. Add the following gems to your Gemfile:
+```
+bundle add 'carrierwave'
+bundle add 'fog-aws'
+
+```
+
+3. Now let's run a migration to create the `storyblok_images` table:
+```bash
+rails db:migrate
+```
+
+4. Finally, enable the image cache feature in the `config/initializers/rubyblok.rb` file:
+```
+config.use_cdn_images = true
+```
+
+Please note that it caches only images added as an `Asset` field type in Storyblok.
+
+## Caching views
+
+You can enable fragment caching on rubyblok components by setting the cache_views feature on in the `config/initializers/rubyblok.rb` file:
+```
+config.cache_views = true
+```
+Please note that if any of the component partials changes you need to clear the cache.
+
+## Sitemap configuration
+You can generate a sitemap configuration for your website with the following command:
+```
+rails g rubyblok:sitemap_config
+```
+This generator will create a sitemap configuration for the `sitemap_generator` gem and add the gem to your Gemfile in case it's not already there.
+The sitemap is generated only for cached content. Please make sure that the `cached` configuration value is `true` on `config/initializers/rubyblok.rb`.
+Open `config/sitemap.rb` and add your hostname:
+```
+# ...
+
+# TODO: Configure your hostname here
+SitemapGenerator::Sitemap.default_host = ''
+
+# ...
+```
+For example:
+```
+# ...
+
+# TODO: Configure your hostname here
+SitemapGenerator::Sitemap.default_host = 'https://myhost.com'
+
+# ...
 ```
+In order to generate your sitemap or customize this configuration, please read [the sitemap_generator gem documentation](https://github.com/kjvarga/sitemap_generator).
 
 ## How to Run Tests
 You can run unit tests for RubyBlok with the following command:

data/Rakefile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 task default: %i[]

data/lib/generators/rubyblok/hello_world_generator.rb

@@ -1,9 +1,11 @@
-require "rails/generators"
+# frozen_string_literal: true
+
+require 'rails/generators'
 
 module Rubyblok
   module Generators
     class HelloWorldGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path('../templates', __dir__)
 
       desc 'Generates a "Hello, world" Rubyblok page.'
 
@@ -16,23 +18,23 @@ module Rubyblok
       private
 
       def add_controller
-        template("hello_world_generator/controller.rb.erb", "app/controllers/#{plural_file_name}_controller.rb")
+        template('hello_world_generator/controller.rb.erb', "app/controllers/#{plural_file_name}_controller.rb")
       end
 
       def add_route
-        insert_into_file("config/routes.rb", after: "Rails.application.routes.draw do") do
+        insert_into_file('config/routes.rb', after: 'Rails.application.routes.draw do') do
           "\n  get '/#{plural_file_name}' => '#{plural_file_name}#index'\n"
         end
       end
 
       def copy_views
-        template("hello_world_generator/index.html.erb", "app/views/#{plural_file_name}/index.html.erb")
-        template("hello_world_generator/_feature.html.erb", "app/views/#{destination_partial_path}/_feature.html.erb")
-        template("hello_world_generator/_page.html.erb", "app/views/#{destination_partial_path}/_page.html.erb")
-        template("hello_world_generator/_grid.html.erb", "app/views/#{destination_partial_path}/_grid.html.erb")
-        template("hello_world_generator/_teaser.html.erb", "app/views/#{destination_partial_path}/_teaser.html.erb")
+        template('hello_world_generator/index.html.erb', "app/views/#{plural_file_name}/index.html.erb")
+        template('hello_world_generator/_feature.html.erb', "app/views/#{destination_partial_path}/_feature.html.erb")
+        template('hello_world_generator/_page.html.erb', "app/views/#{destination_partial_path}/_page.html.erb")
+        template('hello_world_generator/_grid.html.erb', "app/views/#{destination_partial_path}/_grid.html.erb")
+        template('hello_world_generator/_teaser.html.erb', "app/views/#{destination_partial_path}/_teaser.html.erb")
 
-        copy_file("hello_world_generator/styles.css", "app/assets/stylesheets/hello.css")
+        copy_file('hello_world_generator/styles.css', 'app/assets/stylesheets/hello.css')
       end
 
       def destination_partial_path

data/lib/generators/rubyblok/image_cache_generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Rubyblok
+  module Generators
+    class ImageCacheGenerator < ::Rails::Generators::NamedBase
+      include ::Rails::Generators::Migration
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Installs image cache migration and model files.'
+
+      def install
+        if table_exist?
+          migration_template('migration_update_image_cache.rb.erb', "db/migrate/update_#{plural_file_name}.rb",
+                             migration_version:)
+        else
+          migration_template('migration_create_image_cache.rb.erb', "db/migrate/create_#{plural_file_name}.rb",
+                             migration_version:)
+        end
+
+        create_or_update_model
+        add_model_name_to_config
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def table_exist?
+        ActiveRecord::Base.connection.table_exists?(plural_file_name.to_sym)
+      end
+
+      def create_or_update_model
+        if table_exist?
+          add_mixins_to_existing_model
+        else
+          generate_new_model_from_template
+        end
+      end
+
+      def add_mixins_to_existing_model
+        model_path = "app/models/#{file_name}.rb"
+        mixins_code = "\n  mount_uploader :image, #{class_name}Uploader\n"
+
+        insert_into_file model_path, after: "class #{class_name} < ApplicationRecord" do
+          mixins_code
+        end
+
+        add_uploader_and_config
+      end
+
+      def generate_new_model_from_template
+        template('image_cache_model.rb.erb', "app/models/#{file_name}.rb")
+        add_uploader_and_config
+      end
+
+      def add_uploader_and_config
+        template('image_cache_uploader.rb.erb', "app/uploaders/#{file_name}_uploader.rb")
+        template('carrier_wave_config.rb.erb', 'config/initializers/carrier_wave.rb')
+      end
+
+      def add_model_name_to_config
+        model_path = 'config/initializers/rubyblok.rb'
+        insert_into_file model_path, after: 'config.image_model_name     = "' do
+          class_name
+        end
+      end
+    end
+  end
+end

data/lib/generators/rubyblok/install_generator.rb

@@ -1,15 +1,17 @@
-require "rails/generators"
-require "rails/generators/active_record"
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
 
 module Rubyblok
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path('../templates', __dir__)
 
-      desc "Generates an initializer file."
+      desc 'Generates an initializer file.'
 
       def copy_initializer
-        template("rubyblok.rb", "config/initializers/rubyblok.rb")
+        template('rubyblok.rb', 'config/initializers/rubyblok.rb')
       end
     end
   end

data/lib/generators/rubyblok/migration_generator.rb

@@ -1,19 +1,21 @@
-require "rails/generators"
-require "rails/generators/active_record"
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
 
 module Rubyblok
   module Generators
     class MigrationGenerator < ::Rails::Generators::NamedBase
       include ::Rails::Generators::Migration
-      source_root File.expand_path("../templates", __dir__)
-      desc "Installs Rubyblok migration and model files."
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Installs Rubyblok migration and model files.'
 
       def install
         if table_exist?
-          migration_template("migration_update.rb.erb", "db/migrate/update_rubyblok_#{plural_file_name}.rb",
+          migration_template('migration_update.rb.erb', "db/migrate/update_rubyblok_#{plural_file_name}.rb",
                              migration_version:)
         else
-          migration_template("migration_create.rb.erb", "db/migrate/create_rubyblok_#{plural_file_name}.rb",
+          migration_template('migration_create.rb.erb', "db/migrate/create_rubyblok_#{plural_file_name}.rb",
                              migration_version:)
         end
 
@@ -53,11 +55,11 @@ module Rubyblok
       end
 
       def generate_new_model_from_template
-        template("model.rb.erb", "app/models/#{file_name}.rb")
+        template('model.rb.erb', "app/models/#{file_name}.rb")
       end
 
       def add_model_name_to_config
-        model_path = "config/initializers/rubyblok.rb"
+        model_path = 'config/initializers/rubyblok.rb'
         insert_into_file model_path, after: 'config.model_name     = "' do
           class_name
         end

data/lib/generators/rubyblok/sitemap_config_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Rubyblok
+  module Generators
+    class SitemapConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Generates a configuration for the sitemap_generator gem'
+
+      def generate_sitemap_config
+        copy_config
+        add_sitemap_generator_gem
+      end
+
+      private
+
+      def copy_config
+        template('sitemap.rb.erb', 'config/sitemap.rb')
+      end
+
+      def add_sitemap_generator_gem
+        append_to_file(gemfile_path) { "gem 'sitemap_generator'" } if add_sitemap_generator_gem?
+      end
+
+      def add_sitemap_generator_gem?
+        !gemfile_content.match?(/\bsitemap_generator\b/)
+      end
+
+      def gemfile_content
+        File.read(gemfile_path)
+      end
+
+      def gemfile_path
+        Rails.root.join('Gemfile')
+      end
+    end
+  end
+end

data/lib/generators/rubyblok/webhook_controller_generator.rb

@@ -1,20 +1,22 @@
-require "rails/generators"
-require "rails/generators/active_record"
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
 
 module Rubyblok
   module Generators
     class WebhookControllerGenerator < ::Rails::Generators::NamedBase
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path('../templates', __dir__)
 
-      desc "Generates a webhook controller and a route file."
+      desc 'Generates a webhook controller and a route file.'
 
       def copy_initializer
-        template("webhook_controller.rb.erb", "app/controllers/#{file_name}_controller.rb")
+        template('webhook_controller.rb.erb', "app/controllers/#{file_name}_controller.rb")
       end
 
       def routes_config
-        destination_path = "config/routes.rb"
-        insert_into_file destination_path, after: "Rails.application.routes.draw do" do
+        destination_path = 'config/routes.rb'
+        insert_into_file destination_path, after: 'Rails.application.routes.draw do' do
           routes_content
         end
       end

data/lib/generators/templates/carrier_wave_config.rb.erb

@@ -0,0 +1,13 @@
+CarrierWave.configure do |config|
+  config.fog_credentials = {
+    provider:              'AWS',
+    aws_access_key_id:     ENV.fetch('AWS_ACCESS_KEY_ID', nil),
+    aws_secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY', nil),
+    region:                ENV.fetch('AWS_DEFAULT_REGION', nil),
+  }
+
+  config.asset_host     = ENV.fetch('AWS_CLOUDFRONT_UPLOADS_HOST', nil)
+  config.fog_directory  = ENV.fetch('AWS_UPLOADS_DIRECTORY', nil)
+  config.fog_public     = true
+  config.fog_attributes = { cache_control: "public, max-age=#{365.days.to_i}" }
+end

data/lib/generators/templates/image_cache_model.rb.erb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ApplicationRecord
+  mount_uploader :image, <%= class_name %>Uploader
+end

data/lib/generators/templates/image_cache_uploader.rb.erb

@@ -0,0 +1,12 @@
+class <%= class_name %>Uploader < CarrierWave::Uploader::Base
+  storage :fog
+
+  def store_dir
+    model_name = model.model_name.singular
+    "uploads/#{model_name}/#{mounted_as}/#{model.id}"
+  end
+
+  def extension_allowlist
+    %w[gif jpeg jpg png svg mp4]
+  end
+end

data/lib/generators/templates/migration_create_image_cache.rb.erb

@@ -0,0 +1,12 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+      t.string  :original_image_url
+      t.string  :image
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :original_image_url, unique: true
+  end
+end

data/lib/generators/templates/migration_update_image_cache.rb.erb

@@ -0,0 +1,8 @@
+class Update<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= table_name %>, :original_image_url, :string
+    add_column :<%= table_name %>, :image, :string
+
+    add_index :<%= table_name %>, :storyblok_story_slug, unique: true
+  end
+end

data/lib/generators/templates/rubyblok.rb

@@ -1,12 +1,33 @@
 # frozen_string_literal: true
 
 Rubyblok.configure do |config|
-  config.cached         = true
+  # Storyblok API token
+  config.api_token = ENV.fetch('STORYBLOK_API_TOKEN', nil)
 
-  config.api_token      = ENV["STORYBLOK_API_TOKEN"]
-  config.version        = ENV["STORYBLOK_VERSION"]
-  config.webhook_secret = ENV["STORYBLOK_WEBHOOK_SECRET"]
+  # Storyblok story version (draft or published)
+  config.version = ENV.fetch('STORYBLOK_VERSION', 'draft')
 
-  config.model_name     = ""
-  config.component_path = "shared/storyblok"
+  # Name of the model that stores Storyblok stories
+  config.model_name = ''
+
+  # Directory contains rubyblok partials (relative to app/views)
+  config.component_path = 'shared/storyblok'
+
+  # Feature flag that enables cached mode
+  config.cached = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_CACHED', false))
+
+  # Feature flag that enables auto update of local cache
+  config.auto_update = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_AUTOUPDATE', false))
+
+  # Feature flag that enables caching storyblok images
+  config.use_cdn_images = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_CDN_IMAGES', false))
+
+  # Name of the model that stores Storyblok cached images
+  config.image_model_name = ''
+
+  # Storyblok webhook token
+  config.webhook_secret = ENV.fetch('STORYBLOK_WEBHOOK_SECRET', nil)
+
+  # Feature flag that enables caching view fragments
+  config.cache_views = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_CACHE_VIEWS', false))
 end

data/lib/generators/templates/sitemap.rb.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'sitemap_generator'
+
+# TODO: Configure your hostname here
+SitemapGenerator::Sitemap.default_host = ''
+
+if Rubyblok.configuration.cached
+  SitemapGenerator::Sitemap.create do
+    model = Rubyblok.configuration.model_name.classify.constantize
+    pages = model.all.select { |page| page.storyblok_story_content.dig('content', 'no_index') == false }
+    pages.each { |page| add(page.storyblok_story_slug, lastmod: page.updated_at) }
+  end
+end

data/lib/rubyblok/configuration.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Rubyblok
   class Configuration
-    attr_accessor :api_token, :version, :component_path, :webhook_secret, :model_name, :cached
-
-    attr_writer :property
+    attr_accessor :api_token, :auto_update, :cached, :cache_views, :component_path, :image_model_name,
+                  :model_name, :use_cdn_images, :version, :webhook_secret
   end
 end

data/lib/rubyblok/helpers/storyblok_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module StoryblokHelper
   def rubyblok_content_tag(content)
     return if content.blank?
@@ -10,8 +12,17 @@ module StoryblokHelper
   end
 
   def rubyblok_story_tag(slug)
-    content = get_story(slug)
-    rubyblok_component_tag(partial: content.component, blok: content)
+    story = get_story(slug)
+    content = story['content'].to_dot
+
+    template = <<-ERB
+      <% cache_key = "rubyblok/#{story['id']}-#{Digest::SHA1.hexdigest(story.to_json)}" %>
+      <% cache_if use_cache, cache_key do %>
+        <%= rubyblok_component_tag(partial: content.component, blok: content) %>
+      <% end %>
+    ERB
+
+    render_inline_partial template:, locals: { content:, use_cache: Rubyblok.configuration.cache_views }
   end
 
   def rubyblok_component_tag(blok:, partial: blok.component)
@@ -37,34 +48,48 @@ module StoryblokHelper
     render_inline_partial template:, locals: { bloks: }
   end
 
+  def get_story_content(slug)
+    get_story(slug)['content'].to_dot
+  end
+
+  private
+
   def get_story(slug)
-    if use_cache?
-      get_story_via_cache(slug)["content"].to_dot
+    return get_story_via_api(slug) unless cached?
+
+    if update_storyblok?
+      get_story_via_api(slug, save: true)
     else
-      get_story_via_api(slug)["content"].to_dot
+      get_story_via_cache(slug)
     end
   end
 
-  private
-
-  def get_story_via_api(slug)
-    Rubyblok::Services::GetStoryblokStory.call(slug:)
+  def get_story_via_api(slug, save: false)
+    story = Rubyblok::Services::GetStoryblokStory.call(slug:)
+    replace_storyblok_url(story).tap do |storyblok_story|
+      model.find_or_create(storyblok_story) if save
+    end
   end
 
   def get_story_via_cache(slug)
-    Rubyblok.configuration.model_name.classify.constantize.fetch_content(slug)
+    model.fetch_content(slug)
+  end
+
+  def replace_storyblok_url(story)
+    Rubyblok::Services::ReplaceStoryblokUrl.call(story:)
+  end
+
+  def model
+    Rubyblok.configuration.model_name.classify.constantize
   end
 
-  def rich_text_renderer # rubocop:disable Metrics/MethodLength
+  def rich_text_renderer
     ctx = {}
     path = component_path
     @rich_text_renderer ||=
       Storyblok::Richtext::HtmlRenderer.new.tap do |html_renderer|
         html_renderer.set_component_resolver(lambda { |component, data|
-          ApplicationController.render(
-            partial: "#{path}/#{component}",
-            locals: ctx.merge(blok: data)
-          )
+          ApplicationController.render(partial: "#{path}/#{component}", locals: ctx.merge(blok: data))
         })
       end
   end
@@ -75,7 +100,7 @@ module StoryblokHelper
 
   # rubocop:disable Rails/OutputSafety
   def rubyblok_editable_tag(component)
-    component["_editable"]&.html_safe
+    component['_editable']&.html_safe
   end
   # rubocop:enable Rails/OutputSafety
 
@@ -91,7 +116,15 @@ module StoryblokHelper
     ApplicationController.render inline: template, locals:
   end
 
-  def use_cache?
+  def cached?
     Rubyblok.configuration.cached
   end
+
+  def auto_update?
+    Rubyblok.configuration.auto_update
+  end
+
+  def update_storyblok?
+    auto_update? || params[:storyblok] == 'update'
+  end
 end

data/lib/rubyblok/mixins/model.rb

@@ -1,4 +1,6 @@
-require "active_support/concern"
+# frozen_string_literal: true
+
+require 'active_support/concern'
 
 module Rubyblok
   module Mixins
@@ -17,6 +19,16 @@ module Rubyblok
         def fetch_content(slug)
           find_by(storyblok_story_slug: slug)&.storyblok_story_content
         end
+
+        def find_or_create(story)
+          return if story.blank?
+
+          find_or_initialize_by(storyblok_story_id: story['id']).tap do |model|
+            model.storyblok_story_content = story
+            model.storyblok_story_slug = story['full_slug']
+            model.save
+          end
+        end
       end
     end
   end

data/lib/rubyblok/mixins/webhook.rb

@@ -1,4 +1,6 @@
-require "active_support/concern"
+# frozen_string_literal: true
+
+require 'active_support/concern'
 
 module Rubyblok
   module Mixins
@@ -11,11 +13,11 @@ module Rubyblok
         def create
           payload = JSON.parse(request.raw_post)
 
-          storyblok_story_content = Rubyblok::Services::GetStoryblokStory.call(slug: payload["story_id"])
-          model.find_or_initialize_by(storyblok_story_id: payload["story_id"])
-               .update(storyblok_story_content:, storyblok_story_slug: storyblok_story_content["full_slug"])
+          storyblok_story = Rubyblok::Services::GetStoryblokStory.call(slug: payload['story_id'])
+          storyblok_story = Rubyblok::Services::ReplaceStoryblokUrl.call(story: storyblok_story)
+          model.find_or_create(storyblok_story)
 
-          render json: { success: true }
+          render(json: { success: true })
         end
 
         private

data/lib/rubyblok/railtie.rb

@@ -1,8 +1,10 @@
-require_relative "helpers/storyblok_helper"
+# frozen_string_literal: true
+
+require_relative 'helpers/storyblok_helper'
 
 module Rubyblok
   class Railtie < Rails::Railtie
-    initializer "rubyblok.storyblok_helper" do
+    initializer 'rubyblok.storyblok_helper' do
       ActiveSupport.on_load(:action_view) { include StoryblokHelper }
     end
   end

data/lib/rubyblok/services/get_storyblok_story.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rubyblok
   module Services
     class GetStoryblokStory
@@ -15,15 +17,15 @@ module Rubyblok
 
       private
 
-      def storyblok_client(version: "draft") # rubocop:disable Lint/UnusedMethodArgument
+      def storyblok_client
         Storyblok::Client.new(
           token: Rubyblok.configuration.api_token,
           version: Rubyblok.configuration.version
         )
       end
 
-      def get_story
-        storyblok_client.story(@slug)["data"]["story"]
+      def get_story # rubocop:disable Naming/AccessorMethodName
+        storyblok_client.story(@slug)['data']['story']
       end
     end
   end

data/lib/rubyblok/services/replace_storyblok_url.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Rubyblok
+  module Services
+    class ReplaceStoryblokUrl
+      attr_reader :story
+
+      def self.call(story:)
+        new(story:).call
+      end
+
+      def initialize(story:)
+        @story = story
+      end
+
+      def call
+        return story unless use_cdn_images?
+
+        image_fields = find_image_fields(story['content'])
+        image_fields.each do |image_field|
+          replace_url(image_field)
+        end
+        story
+      end
+
+      private
+
+      # It finds image fields based on their "fieldtype"=>"asset" attribute.
+      # Please note that it caches only images added as an 'Asset' field type in Storyblok.
+      def find_image_fields(content)
+        return [content] if image_field?(content)
+
+        content.values.each_with_object([]) do |field_value, image_fields|
+          case field_value
+          when Array
+            field_value.each { |component| image_fields << find_image_fields(component) }
+          when Hash
+            image_fields << find_image_fields(field_value)
+          end
+        end.flatten
+      end
+
+      def image_field?(field)
+        field['fieldtype'] == 'asset'
+      end
+
+      def replace_url(image_field)
+        url = image_field['filename']
+        image =
+          image_model.create_with(remote_image_url: url).find_or_create_by(original_image_url: url)
+
+        image_field['filename'] = image.image.url if image.persisted?
+      end
+
+      def image_model
+        Rubyblok.configuration.image_model_name.classify.constantize
+      end
+
+      def use_cdn_images?
+        Rubyblok.configuration.use_cdn_images
+      end
+    end
+  end
+end

data/lib/rubyblok/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubyblok
-  VERSION = "1.1.0"
+  VERSION = '1.2.0'
 end

data/lib/rubyblok.rb

@@ -1,20 +1,23 @@
 # frozen_string_literal: true
 
-require "storyblok"
-require "redcarpet"
-require "hash_dot"
+require 'storyblok'
+require 'redcarpet'
+require 'hash_dot'
 
-require_relative "rubyblok/helpers/storyblok_helper"
-require_relative "rubyblok/version"
-require_relative "rubyblok/configuration"
-require_relative "rubyblok/railtie" if defined?(Rails)
-require_relative "rubyblok/services/get_storyblok_story"
-require_relative "rubyblok/mixins/model"
-require_relative "rubyblok/mixins/webhook"
-require_relative "generators/rubyblok/migration_generator"
-require_relative "generators/rubyblok/install_generator"
-require_relative "generators/rubyblok/webhook_controller_generator"
-require_relative "generators/rubyblok/hello_world_generator"
+require_relative 'rubyblok/helpers/storyblok_helper'
+require_relative 'rubyblok/version'
+require_relative 'rubyblok/configuration'
+require_relative 'rubyblok/railtie' if defined?(Rails)
+require_relative 'rubyblok/services/get_storyblok_story'
+require_relative 'rubyblok/services/replace_storyblok_url'
+require_relative 'rubyblok/mixins/model'
+require_relative 'rubyblok/mixins/webhook'
+require_relative 'generators/rubyblok/migration_generator'
+require_relative 'generators/rubyblok/install_generator'
+require_relative 'generators/rubyblok/webhook_controller_generator'
+require_relative 'generators/rubyblok/hello_world_generator'
+require_relative 'generators/rubyblok/sitemap_config_generator'
+require_relative 'generators/rubyblok/image_cache_generator'
 
 module Rubyblok
   def self.configuration

data/rubyblok.gemspec

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "lib/rubyblok/version"
+require_relative 'lib/rubyblok/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "rubyblok"
+  spec.name = 'rubyblok'
   spec.version = Rubyblok::VERSION
-  spec.license = "MIT"
-  spec.authors = ["100 Starlings"]
-  spec.email = ["rubyblok@100starlings.com"]
+  spec.license = 'MIT'
+  spec.authors = ['100 Starlings']
+  spec.email = ['rubyblok@100starlings.com']
 
-  spec.summary = "Simple Storyblok CMS integration for Rails"
-  spec.homepage = "http://www.rubyblok.com"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.summary = 'Simple Storyblok CMS integration for Rails'
+  spec.homepage = 'http://www.rubyblok.com'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/100Starlings/rubyblok"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/100Starlings/rubyblok'
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -22,14 +22,14 @@ Gem::Specification.new do |spec|
         f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "hash_dot", "~> 2.5"
-  spec.add_dependency "railties", "~> 7.1"
-  spec.add_dependency "redcarpet", "~> 3.6.0"
-  spec.add_dependency "storyblok", "~> 3.2.0"
+  spec.add_dependency 'hash_dot', '~> 2.5'
+  spec.add_dependency 'railties', '~> 7.1'
+  spec.add_dependency 'redcarpet', '~> 3.6.0'
+  spec.add_dependency 'storyblok', '~> 3.2.0'
 
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyblok
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - 100 Starlings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_dot
@@ -80,9 +80,12 @@ files:
 - README.md
 - Rakefile
 - lib/generators/rubyblok/hello_world_generator.rb
+- lib/generators/rubyblok/image_cache_generator.rb
 - lib/generators/rubyblok/install_generator.rb
 - lib/generators/rubyblok/migration_generator.rb
+- lib/generators/rubyblok/sitemap_config_generator.rb
 - lib/generators/rubyblok/webhook_controller_generator.rb
+- lib/generators/templates/carrier_wave_config.rb.erb
 - lib/generators/templates/hello_world_generator/_feature.html.erb
 - lib/generators/templates/hello_world_generator/_grid.html.erb
 - lib/generators/templates/hello_world_generator/_page.html.erb
@@ -90,10 +93,15 @@ files:
 - lib/generators/templates/hello_world_generator/controller.rb.erb
 - lib/generators/templates/hello_world_generator/index.html.erb
 - lib/generators/templates/hello_world_generator/styles.css
+- lib/generators/templates/image_cache_model.rb.erb
+- lib/generators/templates/image_cache_uploader.rb.erb
 - lib/generators/templates/migration_create.rb.erb
+- lib/generators/templates/migration_create_image_cache.rb.erb
 - lib/generators/templates/migration_update.rb.erb
+- lib/generators/templates/migration_update_image_cache.rb.erb
 - lib/generators/templates/model.rb.erb
 - lib/generators/templates/rubyblok.rb
+- lib/generators/templates/sitemap.rb.erb
 - lib/generators/templates/webhook_controller.rb.erb
 - lib/rubyblok.rb
 - lib/rubyblok/configuration.rb
@@ -102,6 +110,7 @@ files:
 - lib/rubyblok/mixins/webhook.rb
 - lib/rubyblok/railtie.rb
 - lib/rubyblok/services/get_storyblok_story.rb
+- lib/rubyblok/services/replace_storyblok_url.rb
 - lib/rubyblok/version.rb
 - rubyblok.gemspec
 homepage: http://www.rubyblok.com