maglevcms-hyperui-kit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d920cc6483be76fb904b81677954400a2f952f82f395a9bd1fb23fde1a4c70f7
+  data.tar.gz: 4b2a79ffdd80d667fdbb483d0f58d3b725ef8183d517a3e80e9801449ad551fc
+SHA512:
+  metadata.gz: 11492fac4c0e9f0cd869d0db32be0ff69713e78905564d93809df128ecc8d1e1c4d78f86e0f6c48cb3bd2d7be52f9d940525143cc7880f2ddb12d9e2dc420736
+  data.tar.gz: d1f0129617b62ca9d30bbd7902fee2a911464d7cfbfeb5037a66625617824b66150cb2cbbe86b778c89dee2115344cef0c6ebc5c5d4cbdeb08463dc528396ae5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Didier Lafforgue
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Maglev::Hyperui
+
+Gem to be used in addition to the `maglev` gem in order to have some sections to play with.
+
+The sections are based on the awesome job from Mark Mead with the `hyperui` components.
+Check it out [here](https://www.hyperui.dev).
+
+## Development
+
+This gem works by extracting all the Maglev files of the `https://github.com/maglevhq/maglev-hyperui` Ruby on Rails application powered by Maglev. 
+
+In other words, the development of the sections is mainly done on the `https://github.com/maglevhq/maglev-hyperui` project.
+
+Once the modifications or the creation of new sections have been made, the `maglev-hyperui-kit` gem has to been updated as well with the following command:
+
+```bash
+bundle exec rake copy_sections
+```
+
+## Release a new version
+
+Bump the version of gem here: `maglev/hyperui/version` and release the gem:
+
+```bash
+bundle exec rake release
+```
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maglev-hyperui-kit'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,42 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+desc "Copy all the Hyperui sections"
+task :copy_sections do
+  source_root_path = ENV['MAGLEV_HYPERUI_PATH']
+  destination_root_path = File.join(File.expand_path(__dir__), 'lib/generators/maglev/hyperui/install/templates')
+
+  raise 'missing MAGLEV_HYPERUI_PATH env variable 😘' if source_root_path.nil?
+
+  require 'fileutils'
+  
+  # copy the maglev views folder
+  destination_path = File.join(destination_root_path, '/app/views')
+  FileUtils.mkdir_p(destination_path)
+
+  FileUtils.cp_r(
+    File.join(source_root_path, '/app/views/maglev'), 
+    destination_path
+  )
+  
+  # copy the section definitions
+  FileUtils.cp_r(
+    File.join(source_root_path, '/app/theme'), 
+    File.join(destination_root_path, '/app')
+  )
+
+  # copy the section templates
+  FileUtils.cp_r(
+    File.join(source_root_path, '/app/views/theme'), 
+    File.join(destination_root_path, '/app/views')
+  )
+
+  # copy the section assets
+  FileUtils.cp_r(
+    File.join(source_root_path, '/public/theme'), 
+    File.join(destination_root_path, '/public')
+  )
+
+  puts "🎉 All the files have been copied with success!"
+end

data/lib/generators/maglev/hyperui/install/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Install the Maglev sections based on the Hyperui kit.
+
+Example:
+    bin/rails generate maglev:hyperui:install
+
+    This will copy all the files required by the Hyperui theme and it will also a create a landing page as a sample.

data/lib/generators/maglev/hyperui/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Maglev
+  module Hyperui
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_theme_and_sections
+        directory 'app'
+        directory 'public'
+      end
+      
+    end
+  end
+end

data/lib/generators/maglev/hyperui/install/templates/app/theme/sections/banner/banner_01.yml

@@ -0,0 +1,97 @@
+# Name of the section displayed in the editor UI
+name: "Centered with Actions"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: banner
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+- label: "Top title"
+  id: top_title
+  type: text
+  default: "Understand User Flow."
+
+- label: "Bottom title"
+  id: bottom_title
+  type: text
+  default: "Increase Conversion."
+
+- label: "Body"
+  id: body
+  type: text
+  html: true
+  line_break: true
+  nb_rows: 5
+  default: "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Nesciunt illo tenetur fuga ducimus numquam ea!"
+
+- label: "Primary call to action"
+  id: primary_cta
+  type: link
+  with_text: true
+  default: 
+    text: "Get Started"
+    href: "#"
+
+- label: "Secondary call to action"
+  id: secondary_cta
+  type: link
+  with_text: true
+  default: 
+    text: "Learn More"
+    href: "#"
+
+- label: "Show primary call to action"
+  id: show_primary_cta
+  type: checkbox
+  advanced: true
+  default: true
+  
+- label: "Show secondary call to action"
+  id: show_secondary_cta
+  type: checkbox
+  advanced: true
+  default: true
+  
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: []
+
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+# sample:
+#   settings:
+#     top_title: "Understand User Flow."
+#     bottom_title: "Increase Conversion."
+#     body: "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Nesciunt illo tenetur fuga ducimus numquam ea!"
+#     primary_cta: 
+#       text: "Get Started"
+#       href: "#"
+#     secondary_cta: 
+#       text: "Learn More"
+#       href: "#"
+#     show_primary_cta: true    
+#     show_secondary_cta: true    
+#   blocks: []
+  

data/lib/generators/maglev/hyperui/install/templates/app/theme/sections/banner/banner_02.yml

@@ -0,0 +1,97 @@
+# Name of the section displayed in the editor UI
+name: "Centered with Actions and Gradient"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: banner
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+- label: "Top title"
+  id: top_title
+  type: text
+  default: "Understand User Flow."
+
+- label: "Bottom title"
+  id: bottom_title
+  type: text
+  default: "Increase Conversion."
+
+- label: "Body"
+  id: body
+  type: text
+  html: true
+  line_break: true
+  nb_rows: 5
+  default: "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Nesciunt illo tenetur fuga ducimus numquam ea!"
+
+- label: "Primary call to action"
+  id: primary_cta
+  type: link
+  with_text: true
+  default: 
+    text: "Get Started"
+    href: "#"
+
+- label: "Secondary call to action"
+  id: secondary_cta
+  type: link
+  with_text: true
+  default: 
+    text: "Learn More"
+    href: "#"
+
+- label: "Show primary call to action"
+  id: show_primary_cta
+  type: checkbox
+  advanced: true
+  default: true
+  
+- label: "Show secondary call to action"
+  id: show_secondary_cta
+  type: checkbox
+  advanced: true
+  default: true
+  
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: []
+
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+# sample:
+#   settings:
+#     top_title: "Understand User Flow."
+#     bottom_title: "Increase Conversion."
+#     body: "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Nesciunt illo tenetur fuga ducimus numquam ea!"
+#     primary_cta: 
+#       text: "Get Started"
+#       href: "#"
+#     secondary_cta: 
+#       text: "Learn More"
+#       href: "#"
+#     show_primary_cta: true    
+#     show_secondary_cta: true    
+#   blocks: []
+  

data/lib/generators/maglev/hyperui/install/templates/app/theme/sections/banner/banner_03.yml

@@ -0,0 +1,102 @@
+# Name of the section displayed in the editor UI
+name: "Left with Actions and Image"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: banner
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+- label: "Top title"
+  id: top_title
+  type: text
+  default: "Let us find your"
+
+- label: "Bottom title"
+  id: bottom_title
+  type: text
+  default: "Forever Home."
+
+- label: "Background image"
+  id: background_image
+  type: image
+  default: "/theme/image-placeholder.jpg"
+
+- label: "Body"
+  id: body
+  type: text
+  html: true
+  line_break: true
+  nb_rows: 5
+  default: "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Nesciunt illo tenetur fuga ducimus numquam ea!"
+
+- label: "Primary call to action"
+  id: primary_cta
+  type: link
+  with_text: true
+  default: 
+    text: "Get Started"
+    href: "#"
+
+- label: "Secondary call to action"
+  id: secondary_cta
+  type: link
+  with_text: true
+  default: 
+    text: "Learn More"
+    href: "#"
+
+- label: "Show primary call to action"
+  id: show_primary_cta
+  type: checkbox
+  advanced: true
+  default: true
+  
+- label: "Show secondary call to action"
+  id: show_secondary_cta
+  type: checkbox
+  advanced: true
+  default: true
+  
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: []
+
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+# sample:
+#   settings:
+#     top_title: "Let us find your"
+#     bottom_title: "Forever Home."
+#     body: "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Nesciunt illo tenetur fuga ducimus numquam ea!"
+#     primary_cta: 
+#       text: "Get Started"
+#       href: "#"
+#     secondary_cta: 
+#       text: "Learn More"
+#       href: "#"
+#     show_primary_cta: true    
+#     show_secondary_cta: true    
+#   blocks: []
+  

data/lib/generators/maglev/hyperui/install/templates/app/theme/sections/cta/cta_01.yml

@@ -0,0 +1,73 @@
+# Name of the section displayed in the editor UI
+name: "Content and Image"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: cta
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+- label: "Title"
+  id: title
+  type: text
+  nb_rows: 3
+  default: "Lorem, ipsum dolor sit amet consectetur adipisicing elit"
+
+- label: "Body"
+  id: body
+  type: text
+  html: true
+  line_break: true
+  nb_rows: 5
+  default: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Et, egestas tempus tellus etiam sed. Quam a scelerisque amet ullamcorper eu enim et fermentum, augue. Aliquet amet volutpat quisque ut interdum tincidunt duis."
+
+- label: "Image"
+  id: image
+  type: image
+  default: "/theme/image-placeholder.jpg"
+
+- label: "Button"
+  id: button
+  type: link
+  with_text: true
+  default: 
+    text: "Get Started Today"
+    href: "#"
+  
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: []
+
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+# sample:
+#   settings:
+#     title: "Lorem, ipsum dolor sit amet consectetur adipisicing elit"
+#     body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Et, egestas tempus tellus etiam sed. Quam a scelerisque amet ullamcorper eu enim et fermentum, augue. Aliquet amet volutpat quisque ut interdum tincidunt duis."
+#     image: "/theme/image-placeholder.jpg"
+#     button: 
+#       text: "Get Started Today"
+#       href: "#"
+#   blocks: []
+  

data/lib/generators/maglev/hyperui/install/templates/app/theme/sections/cta/cta_02.yml

@@ -0,0 +1,73 @@
+# Name of the section displayed in the editor UI
+name: "Featured Product"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: cta
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+- label: "Title"
+  id: title
+  type: text
+  nb_rows: 3
+  default: "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Quo!"
+
+- label: "Body"
+  id: body
+  type: text
+  html: true
+  line_break: true
+  nb_rows: 5
+  default: "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Inventore officia corporis quasi doloribus iure architecto quae voluptatum beatae excepturi dolores."
+
+- label: "Image"
+  id: background_image
+  type: image
+  default: "/theme/image-placeholder.jpg"
+
+- label: "Button"
+  id: button
+  type: link
+  with_text: true
+  default: 
+    text: "Order Now"
+    href: "#"
+  
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: []
+
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+sample:
+  settings:
+    title: "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Quo!"
+    body: "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Inventore officia corporis quasi doloribus iure architecto quae voluptatum beatae excepturi dolores."
+    background_image: "/theme/image-placeholder.jpg"
+    button: 
+      text: "Order Now"
+      href: "#"
+  blocks: []
+  

data/lib/generators/maglev/hyperui/install/templates/app/theme/sections/cta/cta_03.yml

@@ -0,0 +1,79 @@
+# Name of the section displayed in the editor UI
+name: "Content with Image Grid"
+
+# Category of the section in the editor UI (headers, features, testimonials, ...etc)
+category: cta
+
+# A section might have the same content all over the site, like a menu or a footer for instance.
+# To enable this behavior, uncomment the following statement
+# site_scoped: true
+
+# Display or not the button to insert a new section after this one
+# insert_button: false
+
+# Insert this section at the top or the bottom of the page (default: nil)
+# insert_at: top 
+
+# Definition of the settings:
+# A setting type can be one of the following values: text, image, link, collection_item, checkbox, color and icon.
+# Please visit: https://docs.maglev.dev/concepts/setting for more explanation.
+settings:
+- label: "Title"
+  id: title
+  type: text
+  nb_rows: 3
+  default: "Lorem, ipsum dolor sit amet consectetur adipisicing elit"
+
+- label: "Body"
+  id: body
+  type: text
+  html: true
+  line_break: true
+  nb_rows: 5
+  default: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Et, egestas tempus tellus etiam sed. Quam a scelerisque amet ullamcorper eu enim et fermentum, augue. Aliquet amet volutpat quisque ut interdum tincidunt duis."
+
+- label: "Button"
+  id: button
+  type: link
+  with_text: true
+  default: 
+    text: "Get Started Today"
+    href: "#"
+
+- label: "First image"
+  id: first_image
+  type: image
+  default: "/theme/image-placeholder.jpg"
+
+- label: "Second image"
+  id: second_image
+  type: image
+  default: "/theme/image-placeholder.jpg"
+  
+# Definition of the blocks.
+# You can define as many types of blocks as you want.
+blocks: []
+
+# By default, in the editor UI, blocks will be listed below the "Content" title.
+# The title can be changed with the following property:
+# blocks_label: "My list of items"
+
+# By default, blocks are presented as a list in the editor UI. 
+# If you like to use blocks to build a menu with sub menu items, 
+# consider using the tree presentation
+# blocks_presentation: "tree"
+
+# In order to get a section with "meaning" content for the editors, 
+# you can set the default content of a new instance of this section.
+# (it's also be useful when taking a screenshot of the section).
+# sample:
+#   settings:
+#     title: "Lorem, ipsum dolor sit amet consectetur adipisicing elit"
+#     body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Et, egestas tempus tellus etiam sed. Quam a scelerisque amet ullamcorper eu enim et fermentum, augue. Aliquet amet volutpat quisque ut interdum tincidunt duis."
+#     first_image: "/theme/image-placeholder.jpg"
+#     second_image: "/theme/image-placeholder.jpg"
+#     button: 
+#       text: "Get Started Today"
+#       href: "#"
+#   blocks: []
+