maglevcms 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5142dce26e1cb4b93eb9a4e6783e5c390d5da6646d85135e68c2a9b8a714138c
+  data.tar.gz: 6a87b553dc20fe437842c254fc6a68a030bc09fa6a900c2300898d59ab7c5343
+SHA512:
+  metadata.gz: 6ec83fa045b101597ded5a9be7aa23c8143b9946036529595a49b2f4dc179c937e09af4872a86823c250396b43f5ca84c7677de69ef8703fc7abec88de58d359
+  data.tar.gz: 7c4b80c442eb39146daf6b4fa3ce390d4d7b3a9436c192b28d7dbed3fd668324a2fd230f267b1b80da123069ab308ed1206e8e0618ec58409798dabdfd1ccb3a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 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,27 @@
+# Maglev
+
+[![Build Status](https://travis-ci.com/maglevhq/maglev-core.svg?token=Peo8iU6ug5EgwGpofkrd&branch=master)](https://travis-ci.com/maglevhq/maglev-core)
+
+Maglev is a page builder / CMS that you can plug in any Ruby on Rails 6+ application.
+
+![Editor UI](https://gblobscdn.gitbook.com/assets%2F-Me54MJUO0o8Vj5WCTWJ%2F-MeUwrTI6TuqN8mdhZtm%2F-MekxQC_Ueu6lgqhQ9BW%2Feditor-ui-default.jpg?alt=media&token=58e1782a-00c2-4b29-8ff3-0988a90d7517)
+
+## Demo
+
+Coming soon
+
+## Getting started / Documentation
+
+- [Install Maglev](https://docs.maglev.dev/quickstart)
+- [Documentation](https://docs.maglev.dev/)
+
+## Testing
+
+If for some reasons you want your Maglev site to exist during your tests,
+you can use `Maglev::GenerateSite.call` on your setup block.
+
+## Contributing
+Contribution directions go here.
+
+## 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,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Maglev'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/maglev_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/maglev .css

data/app/assets/stylesheets/maglev/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/components/maglev/base_component.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Maglev
+  class BaseComponent
+    extend Forwardable
+    def_delegators :view_context, :render
+
+    attr_accessor :view_context
+
+    def build(component_class, attributes)
+      component_class.new(**attributes).tap do |component|
+        component.view_context = view_context
+      end
+    end
+
+    # Useful helper to avoid manipulating hashes
+    # eg.: <%= section.settings.body %> instead of <%= section.settings[:body] %>
+    def settings_proxy(map)
+      settings_keys = map.keys
+      return nil if settings_keys.blank?
+
+      settings_struct = Struct.new(*settings_keys)
+      settings_struct.new(*map.values)
+    end
+
+    def build_settings_map(settings)
+      definition.settings.inject({}) do |memo, setting_def|
+        memo.merge(
+          setting_def.id.to_sym => build_content(
+            self,
+            find_setting_value(settings, setting_def),
+            setting_def
+          )
+        )
+      end
+    end
+
+    def build_content(scope, content, setting)
+      Maglev::Content::Builder.build(scope, content, setting)
+    end
+
+    private
+
+    def find_setting_value(settings, definition)
+      settings.find { |setting| definition.id == setting[:id] }&.[](:value)
+    end
+
+    def find_setting(settings, setting_id)
+      settings.public_send(setting_id)
+    rescue NoMethodError
+      raise "[Maglev] We're sorry but there is no '#{setting_id}' setting in your section/block."
+    end
+  end
+end

data/app/components/maglev/block_component.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Maglev
+  class BlockComponent < BaseComponent
+    include TagHelper
+
+    extend Forwardable
+    def_delegators :section, :site, :config
+
+    attr_reader :section, :id, :name, :type, :settings, :attributes, :definition
+    attr_accessor :children
+
+    # rubocop:disable Lint/MissingSuper
+    def initialize(section:, attributes:, definition:)
+      @section = section
+      @id = attributes[:id]
+      @name = attributes[:name]
+      @type = attributes[:type]
+      @children = children
+      @definition = definition
+
+      @settings = settings_proxy(
+        build_settings_map(attributes[:settings])
+      )
+    end
+    # rubocop:enable Lint/MissingSuper
+
+    def children?
+      children.present?
+    end
+
+    def dom_id
+      "block-#{id}"
+    end
+
+    # rubocop:disable Rails/OutputSafety
+    def dom_data
+      "data-maglev-block-id=\"#{id}\"".html_safe
+    end
+    # rubocop:enable Rails/OutputSafety
+
+    def tag_data
+      { maglev_block_id: id }
+    end
+  end
+end

data/app/components/maglev/content/base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Base
+      extend Forwardable
+      def_delegators :scope, :site, :config
+
+      attr_accessor :scope, :content, :setting
+
+      # Scope can be either a section or a block
+      def initialize(scope, content, setting)
+        @scope = scope
+        @content = content
+        @setting = setting
+      end
+
+      # rubocop:disable Rails/OutputSafety
+      def dom_data
+        "data-maglev-id=\"#{tag_id}\"".html_safe
+      end
+      # rubocop:enable Rails/OutputSafety
+
+      def tag_data
+        { maglev_id: tag_id }
+      end
+
+      def tag_id
+        "#{scope.id}.#{setting.id}"
+      end
+
+      def to_s
+        content || ''
+      end
+
+      def tag(_view_context, _options)
+        to_s
+      end
+
+      def asset_host
+        case config.asset_host
+        when nil
+          nil
+        when String
+          config.asset_host
+        when Proc
+          instance_exec(site, &config.asset_host)
+        end
+      end
+    end
+  end
+end

data/app/components/maglev/content/builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    module Builder
+      TYPES = {
+        text: Maglev::Content::Text,
+        image: Maglev::Content::Image,
+        link: Maglev::Content::Link,
+        checkbox: Maglev::Content::Checkbox,
+        color: Maglev::Content::Color,
+        select: Maglev::Content::Select,
+        collection_item: Maglev::Content::CollectionItem,
+        icon: Maglev::Content::Icon
+      }.freeze
+
+      def build(scope, content, setting)
+        klass = TYPES[setting.type.to_sym]
+
+        raise "[Maglev] Unknown setting type: #{setting.type}" unless klass
+
+        klass.new(scope, content, setting)
+      end
+
+      module_function :build
+    end
+  end
+end

data/app/components/maglev/content/checkbox.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Checkbox < Base
+      def true?
+        !!content
+      end
+
+      def false?
+        !true?
+      end
+
+      def to_s
+        content
+      end
+    end
+  end
+end

data/app/components/maglev/content/collection_item.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class CollectionItem < Base
+      def exists?
+        item.present?
+      end
+
+      def to_s
+        item.inspect
+      end
+
+      def item
+        (content || {})[:item]
+      end
+
+      def tag(view_context, options = {}, &block)
+        return unless item && block_given?
+
+        view_context.tag.public_send(
+          options.delete(:html_tag)&.to_sym || :div,
+          view_context.capture(item, &block),
+          **{ data: (options.delete(:data) || {}).merge(tag_data) }.merge(options)
+        )
+      end
+    end
+  end
+end

data/app/components/maglev/content/color.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Color < Base
+      def dark?
+        brightness < 128
+      end
+
+      def light?
+        !dark?
+      end
+
+      def brightness
+        r, g, b = content.match(/^#(..)(..)(..)$/).captures.map(&:hex)
+        (r * 299 + g * 587 + b * 114) / 1000.0
+      end
+    end
+  end
+end

data/app/components/maglev/content/icon.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Icon < Base
+      def_delegators :icon_class, :blank?
+
+      def icon_class
+        @content
+      end
+
+      def to_s
+        @content
+      end
+
+      def tag(view_context, options = {})
+        view_context.content_tag(:i, '',
+                                 {
+                                   class: [options.delete(:class), icon_class].compact.join(' '),
+                                   data: (options.delete(:data) || {}).merge(tag_data)
+                                 }.merge(options),
+                                 false)
+      end
+    end
+  end
+end

data/app/components/maglev/content/image.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Image < Base
+      def url
+        return image[:url] if asset_host.nil? || !hosted_on_platform?
+
+        URI.join(asset_host, URI.parse(image[:url]).path).to_s
+      end
+
+      def width
+        image[:width]
+      end
+
+      def height
+        image[:height]
+      end
+
+      def alt_text
+        image[:alt_text]
+      end
+
+      def to_s
+        url
+      end
+
+      def tag(view_context, options = {})
+        view_context.tag(:img,
+                         {
+                           src: url,
+                           alt: alt_text,
+                           data: (options.delete(:data) || {}).merge(tag_data)
+                         }.merge(options),
+                         false)
+      end
+
+      private
+
+      def image
+        @image ||= if @content.is_a?(String)
+                     { url: @content }
+                   elsif @content
+                     @content
+                   else
+                     {}
+                   end
+      end
+
+      def hosted_on_platform?
+        (width.present? && height.present?) || image[:url] =~ %r{^/themes?/}
+      end
+    end
+  end
+end

data/app/components/maglev/content/link.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Link < Base
+      def href
+        link[:href]
+      end
+
+      def text
+        link[:text]
+      end
+
+      def with_text?
+        !!setting.options[:with_text]
+      end
+
+      def open_new_window?
+        !!link[:open_new_window]
+      end
+
+      def target_blank
+        open_new_window? ? '_blank' : nil
+      end
+
+      def to_s
+        href
+      end
+
+      def tag(view_context, options = {}, &block)
+        captured_content = view_context.capture(&block) if block_given?
+        view_context.link_to(
+          captured_content || text_tag(view_context),
+          href,
+          {
+            data: (options.delete(:data) || {}).merge(tag_data),
+            target: target_blank
+          }.merge(options)
+        )
+      end
+
+      private
+
+      def link
+        @link ||= if content.is_a?(String)
+                    { href: content, link_type: 'url', open_new_window: false }
+                  elsif content
+                    content
+                  else
+                    {}
+                  end.symbolize_keys
+      end
+
+      # rubocop:disable Rails/OutputSafety
+      def text_tag(view_context)
+        view_context.tag.span(text, **{ data: { maglev_id: "#{tag_id}.text" } }).html_safe
+      end
+      # rubocop:enable Rails/OutputSafety
+    end
+  end
+end

data/app/components/maglev/content/select.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Select < Base
+    end
+  end
+end

data/app/components/maglev/content/text.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Maglev
+  module Content
+    class Text < Base
+      # rubocop:disable Rails/OutputSafety
+      def tag(view_context, options = {})
+        view_context.tag.public_send(
+          options.delete(:html_tag)&.to_sym || tag_name,
+          to_s.html_safe,
+          **{
+            data: (options.delete(:data) || {}).merge(tag_data)
+          }.merge(options)
+        )
+      end
+      # rubocop:enable Rails/OutputSafety
+
+      private
+
+      def tag_name
+        setting.options[:html] && !setting.options[:line_break] ? :div : :span
+      end
+    end
+  end
+end

data/app/components/maglev/page_component.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Maglev
+  class PageComponent < BaseComponent
+    attr_reader :site, :theme, :page, :page_sections, :templates_root_path, :config
+
+    # rubocop:disable Lint/MissingSuper, Metrics/ParameterLists
+    def initialize(site:, theme:, page:, page_sections:, templates_root_path:, config:)
+      @site = site
+      @theme = theme
+      @page = page
+      @page_sections = page_sections
+      @templates_root_path = templates_root_path
+      @config = config
+    end
+    # rubocop:enable Lint/MissingSuper, Metrics/ParameterLists
+
+    # Sections within a dropzone
+    def sections
+      @sections ||= page_sections.map do |attributes|
+        definition = theme.sections.find(attributes['type'])
+        next unless definition
+
+        build_section(definition, attributes)
+      end.compact
+    end
+
+    def render
+      sections.collect(&:render).join
+    end
+
+    private
+
+    def build_section(definition, attributes)
+      build(
+        SectionComponent,
+        parent: self,
+        definition: definition,
+        attributes: attributes.deep_transform_keys! { |k| k.to_s.underscore.to_sym },
+        templates_root_path: templates_root_path
+      )
+    end
+  end
+end

data/app/components/maglev/section_component.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Maglev
+  class SectionComponent < BaseComponent
+    include TagHelper
+
+    extend Forwardable
+    def_delegators :parent, :site, :config
+
+    attr_reader :parent, :id, :type, :settings, :attributes, :definition, :templates_root_path
+
+    # rubocop:disable Lint/MissingSuper
+    def initialize(parent:, attributes:, definition:, templates_root_path:)
+      @parent = parent # aka a PageComponent
+      @id = attributes[:id]
+      @type = attributes[:type]
+      @definition = definition
+      @attributes = attributes
+      @templates_root_path = templates_root_path
+
+      @settings = settings_proxy(
+        build_settings_map(attributes[:settings])
+      )
+    end
+    # rubocop:enable Lint/MissingSuper
+
+    def dom_id
+      "section-#{id}"
+    end
+
+    # rubocop:disable Rails/OutputSafety
+    def dom_data
+      "data-maglev-section-id=\"#{id}\"".html_safe
+    end
+    # rubocop:enable Rails/OutputSafety
+
+    def tag_data
+      { maglev_section_id: id }
+    end
+
+    def blocks
+      return @blocks if @blocks
+
+      @blocks = if definition.blocks_presentation == 'tree'
+                  build_block_tree
+                else
+                  build_block_list
+                end
+    end
+
+    def render
+      super(
+        template: "#{templates_root_path}/sections/#{definition.category}/#{type}",
+        locals: { section: self, maglev_section: self }
+      )
+    end
+
+    private
+
+    def build_block_list
+      build_blocks(attributes[:blocks])
+    end
+
+    def build_block_tree(parent_id = nil)
+      blocks = attributes[:blocks].select do |block_attributes|
+        block_attributes[:parent_id] == parent_id
+      end
+
+      build_blocks(blocks) do |block|
+        block.children = build_block_tree(block.id)
+      end
+    end
+
+    def build_blocks(blocks)
+      (blocks || []).map do |block_attributes|
+        block_definition = definition.blocks.find { |settings| settings.type == block_attributes[:type] }
+        next unless block_definition
+
+        block = build_block(block_definition, block_attributes)
+
+        yield block if block_given?
+
+        block
+      end.compact
+    end
+
+    def build_block(block_definition, block_attributes)
+      build(
+        BlockComponent,
+        section: self,
+        definition: block_definition,
+        attributes: block_attributes
+      )
+    end
+  end
+end