rubyblok 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096e822e37774a75693902aff5fe81ccb971ed74d50e849a0b47fa49511642e6'
-  data.tar.gz: 28ac8e653f9ed908a14be4622883acf6ef29c642d96925c1e84766228a5a0f1d
+  metadata.gz: 7012bc69cffbe4334c2176ae14a987af28f812c0a5587aecf579f13ce67e8b01
+  data.tar.gz: ace98ab94b1c2b10526c29fe24724d3cdcef12a76a172ea832d3c8ba38986d07
 SHA512:
-  metadata.gz: feae7213dc1c38278accc0cc36ec91b903c15ac1087fb598e51551bf87156cdfe0a4eaaef033e7e3ff4c4ecd50a8296b874390c5b93db741b0fe69bda2efa474
-  data.tar.gz: aa25681967a4c901c4c12c9146db6fd03d3f87ef39de957a47337f66a21cede5edd5b0350b61f9690530f376eb86d2f87d7cc17f2b7ad8c87d1895c95eeedfdf
+  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

@@ -0,0 +1,23 @@
+# Changelog
+
+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
+- Hello world generator
+
+## [1.0.0] - 2024-03-27
+
+### Added
+- Initial release
+- Rubyblok helpers
+- Config generator
+- Model generator for caching Storyblok content
+- Webhook controller generator for publishing Storyblok contents

data/README.md

@@ -8,123 +8,70 @@ 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:
-```
+```bash
 bundle add rubyblok
 ```
 
-### Storyblok account and variables
-
-[Click here](https://app.storyblok.com/?_gl=1*196uoul*_gcl_au*MTg1NjA5NjA0MS4xNzA5MDY5ODk3#!/signup) to create a free acount at Storyblok, the CMS platform where you will have access to the visual and real-time content editing.
+### Storyblok account and new space
+[Click here](https://app.storyblok.com/#/signup) to create a free acount at Storyblok, the CMS platform where you will have access to the visual and real-time content editing.
 
-Create a new Space, in _Spaces > Add Space_.
+Create a new Space, in _My Spaces > Add Space_. Select the free Community plan by clicking its "Continue" button and give your space a name.
 
 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
 
-### Your first Rubyblok page
-Let's get started with Rubyblok by creating our first page.
+### 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.
 
-First, you need to run the install generator, which will create the initializer for you:
+1. First, you need to run the install generator, which will create the initializer for you:
 ```bash
 rails g rubyblok:install
 ```
 
-Now let's generate and run a migration to create the `pages` table and the `Page` model:
+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 db:migrate
 ```
 
-Then, generate the webhook controller:
+3. Finally, let's generate your first page:
 ```bash
-rails g rubyblok:webhook_controller STORYBLOK_WEBHOOK
-```
-It also adds this line to your `routes.rb` file:
-```
-resources :storyblok_webhook, only: :create
+rails g rubyblok:hello_world PAGE
 ```
-The Storyblok webhook is responsible for updating and deleting content in our local database in case of changes of content in Storyblok.
+This will automatically create a new `/pages` route, a `PagesController`, views and styling for your hello world page.
 
-Finally, generate the home controller:
-```bash
-rails g controller home_controller
-```
-Add the following code to your home controller:
+For this example, go to the `config/initializers/rubyblok.rb` file and turn the caching option off:
 ```
-def index
-  response.headers['X-FRAME-OPTIONS'] = 'ALLOWALL'
-end
+config.cached = false
 ```
 
-Add this code to your app/views/home/index.html.erb file:
-```
-<%= rubyblok_story_tag('home') %>
-```
-Configure your `routes.rb` file to call the home controller. For example, adding this line:
-```
-root to: 'home#index'
-```
+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.
 
-Create a `shared/storyblok` directory in the `views` directory, this directory is going to store the partials that render Storyblok components.
-You can change the folder settings at the `rubyblok.rb` file as needed:
-```
-config.component_path = "shared/storyblok"
-```
-
-Inside the `views/shared/storyblok` folder, create a file named `_page.html.erb` with the following code:
-```
-<%= rubyblok_blocks_tag(blok.body) %>
-```
-
-And then create another file for the hero section block `_hero_section.html.erb` (more explanation on that later):
-```
-<section>
-  <div>
-    <%= rubyblok_content_tag(blok.headline) %>
-    <%= rubyblok_content_tag(blok.subheadline) %>
-  </div>
-</section>
-```
-
-### Creating your page at Storyblok
-1. Once you're logged in, access your new space in the "My Spaces" section
-2. Go to the "Content" section
-3. Click the CTA "Create new" > Story
-4. Name your story "Home", so it connects to our previous code. The content type is "Page".
-5. Open your new story to start editing.
-6. On the right side, you can add new blocks to your page. Create a new block by clicking the "+ Add Block" button.
-7. This will open the Insert block section, then create the new "hero_section" block by typing its name in the search input.
-8. Click the "Create new hero_section" CTA 
-9. Add the "headline" and "subheadline" text fields to the new Hero Section and save.
-10. In your new Hero Section block, add any text you want to it.
-11. Click the Publish button in the right top corner.
-
-Now you have your first demo page and block created. Start your rails server and you will be able to see it in your application.
-
-### 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_. 
@@ -155,7 +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 🎉
 
-
 ## Rubyblok tags
 
 ### rubyblok_story_tag
@@ -164,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.
@@ -199,17 +145,100 @@ Use this tag to render more than one component:
 ```
 
 ### Updating content manually at the caching layer
-
-You can do the following in case you need to update the caching layer with some content that already exists in Storyblok:
+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)
 ```
 
-## How to Run Tests
+## 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:
 ```
 bundle exec rspec
@@ -223,5 +252,4 @@ Issues should be used to report bugs, request a new feature, or to discuss poten
 For any inquiries, reach out to us at: info@rubyblok.com
 
 ## License
-
 RubyBlok is released under the MIT License.

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Rubyblok
+  module Generators
+    class HelloWorldGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Generates a "Hello, world" Rubyblok page.'
+
+      def generate_hello_world
+        add_controller
+        add_route
+        copy_views
+      end
+
+      private
+
+      def add_controller
+        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
+          "\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")
+
+        copy_file('hello_world_generator/styles.css', 'app/assets/stylesheets/hello.css')
+      end
+
+      def destination_partial_path
+        @destination_partial_path ||= Rubyblok.configuration.component_path
+      end
+    end
+  end
+end

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