rubyblok 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 387e9c3d34367e3cbc2f7bd45bb3c38358e203e009f0d7a79f77c2f0569e590c
-  data.tar.gz: 13d329d7a0d6498124ee602b9252722051b4bf6f01e62186cc9c6b61fd26da69
+  metadata.gz: 97de159fda2be4c48fe193e20470427a8d387b751adf6e6c736cc540ded7bb93
+  data.tar.gz: 9e0db1ebff8bcb3d3fc319c1f82c1e43a9c178be17f4cff130263c8f6013579c
 SHA512:
-  metadata.gz: 663185c2a74652136c644306457bb110d5c67290826f100e14c4e033e543f7db68bdb24b1f8d5843d78d20e32760ddc861b8f57abedba05cf9da73092f36041f
-  data.tar.gz: b2000c3d50bc5eef358a3b2cffc43cb2e980f89f63cf0b8a8acc7ac83bfc568e3b0440fd0029473a4f3ba792fd9e416d7e85164eafcc03a4677f81e0082239be
+  metadata.gz: 989944be668f8fd1948ce7a708fcbe26015c847d0bfd5ef181998776af887c1524d3a5e671085efa9890d857e401d389eee52cd8d73aad96cc5d6d8dbc054a90
+  data.tar.gz: 0db3897c8213431fe5bc44a0bb0f0c3025988ee9dc1d3db6dced4e01c3d6833c7c4098df75bbbcb216d7633d21d9bc356d705a2e1289fb6a13c1b4445465ef01

data/.rubocop.yml

@@ -6,146 +6,9 @@ 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,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.0] - 2024-07-04
+
+### Added
+- Securing webhook with secret token
+- Visibility property on components
+- Rake task to download all content
+
+## [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,25 +53,25 @@ 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 
+### 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.
 
 At Storyblok, select your Space and go to _Settings > Visual Editor_. 
@@ -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.
@@ -155,20 +138,126 @@ text = {
 # Output: "<p>this is a richtext</p>"
 ```
 
+You can prevent rendering content on production by adding a boolean field type with the name "invisible_on_production" to your Storyblok block.
+
 ### rubyblok_blocks_tag
 Use this tag to render more than one component:
 ```
 <%= rubyblok_blocks_tag(blok.bloks) %>
 ```
 
+You can prevent rendering content on production by adding a boolean field type with the name "invisible_on_production" to your Storyblok block.
+
 ### Updating content manually at the caching layer
 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
+```
+
+You can also use the rake task `rubyblok:create_or_update_content` to update the local cache:
+
+```bash
+rails rubyblok:create_or_update_content # Using the version configured on `Rubyblok.configuration.version`.
+```
+
+or with the `version` argument (`draft` or `published`):
+
+```bash
+rails rubyblok:create_or_update_content[published]
+```
+
+## 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)
+
+1. First generate the webhook controller:
+```bash
+rails g rubyblok:webhook_controller STORYBLOK_WEBHOOK
+```
+
+2. You need to set the webhook secret used in Storyblok in the `config/initializers/rubyblok.rb` file:
+```
+config.webhook_secret = 'secret'
+```
+
+## 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