rubyblok 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096e822e37774a75693902aff5fe81ccb971ed74d50e849a0b47fa49511642e6'
-  data.tar.gz: 28ac8e653f9ed908a14be4622883acf6ef29c642d96925c1e84766228a5a0f1d
+  metadata.gz: 387e9c3d34367e3cbc2f7bd45bb3c38358e203e009f0d7a79f77c2f0569e590c
+  data.tar.gz: 13d329d7a0d6498124ee602b9252722051b4bf6f01e62186cc9c6b61fd26da69
 SHA512:
-  metadata.gz: feae7213dc1c38278accc0cc36ec91b903c15ac1087fb598e51551bf87156cdfe0a4eaaef033e7e3ff4c4ecd50a8296b874390c5b93db741b0fe69bda2efa474
-  data.tar.gz: aa25681967a4c901c4c12c9146db6fd03d3f87ef39de957a47337f66a21cede5edd5b0350b61f9690530f376eb86d2f87d7cc17f2b7ad8c87d1895c95eeedfdf
+  metadata.gz: 663185c2a74652136c644306457bb110d5c67290826f100e14c4e033e543f7db68bdb24b1f8d5843d78d20e32760ddc861b8f57abedba05cf9da73092f36041f
+  data.tar.gz: b2000c3d50bc5eef358a3b2cffc43cb2e980f89f63cf0b8a8acc7ac83bfc568e3b0440fd0029473a4f3ba792fd9e416d7e85164eafcc03a4677f81e0082239be

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [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

@@ -18,15 +18,14 @@ In addition, Rubyblok provides an abstraction layer and stores all your content
 
 ## Installation
 Rubyblok 1.0 works with Rails 6.0 onwards. Run:
-```
+```bash
 bundle add rubyblok
 ```
 
-### Storyblok account and variables
+### 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.
 
-[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.
-
-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.
 
@@ -43,88 +42,45 @@ STORYBLOK_WEBHOOK_SECRET=''
 
 ## Getting Started
 
-### Your first Rubyblok page
-Let's get started with Rubyblok by creating our first page.
+### Necessary gems
+You need to add some gems to your app for Rubyblok to work correctly. Run the following commands:
 
-First, you need to run the install generator, which will create the initializer for you:
 ```bash
-rails g rubyblok:install
+bundle add "storyblok"
+bundle add "hash_dot"
+bundle add "dotenv-rails"
 ```
 
-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
-```
+### 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.
 
-Then, generate the webhook controller:
+1. First, you need to run the install generator, which will create the initializer for you:
 ```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:install
 ```
-The Storyblok webhook is responsible for updating and deleting content in our local database in case of changes of content in Storyblok.
 
-Finally, generate the home controller:
+2. Now let's generate and run a migration to create the `pages` table and the `Page` model:
 ```bash
-rails g controller home_controller
-```
-Add the following code to your home controller:
-```
-def index
-  response.headers['X-FRAME-OPTIONS'] = 'ALLOWALL'
-end
-```
-
-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'
-```
+rails g rubyblok:migration 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"
+rails db:migrate
 ```
 
-Inside the `views/shared/storyblok` folder, create a file named `_page.html.erb` with the following code:
-```
-<%= rubyblok_blocks_tag(blok.body) %>
+3. Finally, let's generate your first page:
+```bash
+rails g rubyblok:hello_world page
 ```
+This will automatically create a new route, controller, views and styling for your hello world page.
 
-And then create another file for the hero section block `_hero_section.html.erb` (more explanation on that later):
+For this example, go to the `rubyblok.rb` file and turn the caching option off:
 ```
-<section>
-  <div>
-    <%= rubyblok_content_tag(blok.headline) %>
-    <%= rubyblok_content_tag(blok.subheadline) %>
-  </div>
-</section>
+config.cached = false
 ```
 
-### 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 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 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,6 +111,13 @@ 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
 
@@ -199,8 +162,7 @@ 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)
@@ -209,7 +171,6 @@ storyblok_story_content = Rubyblok::Services::GetStoryblokStory.call(slug: slug)
 ```
 
 ## How to Run Tests
-
 You can run unit tests for RubyBlok with the following command:
 ```
 bundle exec rspec
@@ -223,5 +184,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/lib/generators/rubyblok/hello_world_generator.rb

@@ -0,0 +1,43 @@
+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/templates/hello_world_generator/_feature.html.erb

@@ -0,0 +1,3 @@
+<div class="feature">
+  <span class="name"><%%= blok.name %></span>
+</div>

data/lib/generators/templates/hello_world_generator/_grid.html.erb

@@ -0,0 +1,3 @@
+<div class="columns">
+  <%%= rubyblok_blocks_tag(blok.columns) %>
+</div>

data/lib/generators/templates/hello_world_generator/_page.html.erb

@@ -0,0 +1 @@
+<%%= rubyblok_blocks_tag(blok.body) %>

data/lib/generators/templates/hello_world_generator/_teaser.html.erb

@@ -0,0 +1,3 @@
+<div class="teaser">
+  <span class="headline"><%%= blok.headline %></span>
+</div>

data/lib/generators/templates/hello_world_generator/controller.rb.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= class_name.pluralize %>Controller < ApplicationController
+  include StoryblokHelper
+
+  def index
+    @slug = "home"
+  end
+end

data/lib/generators/templates/hello_world_generator/index.html.erb

@@ -0,0 +1,5 @@
+<%%= stylesheet_link_tag("hello.css") %>
+
+<div class="page">
+  <%%= rubyblok_story_tag(@slug) %>
+</div>

data/lib/generators/templates/hello_world_generator/styles.css

@@ -0,0 +1,54 @@
+.page {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  background: #FFF;
+  color: #1B243F;
+  width: 100%;
+  min-height: 100svh;
+  padding: 0;
+  margin: 0;
+  font-family: sans-serif;
+}
+
+.teaser {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  padding: 2rem 0;
+}
+
+.headline {
+  font-size: 2rem;
+  font-weight: 700;
+  margin-bottom: 1rem;
+}
+
+.feature {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  padding: 2rem;
+  background: #00B3B0;
+  border-radius: 0.5rem;
+}
+
+.name {
+  color: #FFF;
+  font-size: 1.25rem;
+  font-weight: 500;
+}
+
+.columns {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+
+  @media (min-width: 768px) {
+    display: grid;
+    grid-template-columns: repeat(3, minmax(0, 1fr));
+    gap: 1rem;
+  }
+}

data/lib/rubyblok/mixins/model.rb

@@ -1,3 +1,5 @@
+require "active_support/concern"
+
 module Rubyblok
   module Mixins
     module Model

data/lib/rubyblok/mixins/webhook.rb

@@ -1,3 +1,5 @@
+require "active_support/concern"
+
 module Rubyblok
   module Mixins
     module Webhook

data/lib/rubyblok/version.rb

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

data/lib/rubyblok.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
+require "storyblok"
+require "redcarpet"
 require "hash_dot"
-require "rails"
-require "action_controller"
 
 require_relative "rubyblok/helpers/storyblok_helper"
 require_relative "rubyblok/version"
 require_relative "rubyblok/configuration"
-require_relative "rubyblok/services/get_storyblok_story"
 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 "rubyblok/mixins/webhook"
 require_relative "generators/rubyblok/webhook_controller_generator"
+require_relative "generators/rubyblok/hello_world_generator"
 
 module Rubyblok
   def self.configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyblok
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - 100 Starlings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_dot
@@ -75,12 +75,21 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - Rakefile
+- lib/generators/rubyblok/hello_world_generator.rb
 - lib/generators/rubyblok/install_generator.rb
 - lib/generators/rubyblok/migration_generator.rb
 - lib/generators/rubyblok/webhook_controller_generator.rb
+- 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
+- lib/generators/templates/hello_world_generator/_teaser.html.erb
+- 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/migration_create.rb.erb
 - lib/generators/templates/migration_update.rb.erb
 - lib/generators/templates/model.rb.erb
@@ -117,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Simple Storyblok CMS integration for Rails