composite_content 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a686efcdcec61939877f6b8615c135ccf783fe7d4aa5c41257bdc0aa622186e9
+  data.tar.gz: c55f515cb92332b9620d4c040f4643870f06780f277ee10a20ab6dd0f1dfedc6
+SHA512:
+  metadata.gz: 839c222ed66ed2fa56e9657bf5a54cc15bd64d938ecbf7ca7bff97aeb038aeea0e22373d3c22a610c92454005855ee83521b23d5c2f7def2bde188cbb0acdfe1
+  data.tar.gz: 97e9c56f6d39cfe92607a4af147c6704e87852d82dd0b46983b8fcfbf8b0016cda2a4712aa8ce26bbd90b0b0a062de3b11b9c6c7f8440c3f8fc6bee00c7ab1b6

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,43 @@
+---
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'spec/dummy/db/schema.rb'
+
+Layout/LineLength:
+  Max: 120
+
+# DSLs produce long blocks
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - '**/db/migrate/*.rb'
+    - 'spec/**/*_spec.rb'
+Metrics/MethodLength:
+  Exclude:
+    - '**/db/migrate/*.rb'
+
+Rails/ApplicationRecord:
+  Exclude:
+    - 'app/**/*.rb'
+    - 'lib/**/*.rb'
+
+Rails/I18nLocaleTexts:
+  Exclude:
+    - 'spec/dummy/**/*.rb'
+
+Style/Documentation:
+  Exclude:
+    - '**/db/migrate/*.rb'
+    - 'spec/dummy/**/*.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in composite_content.gemspec
+gemspec
+
+gem 'puma'
+gem 'sprockets-rails'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,239 @@
+PATH
+  remote: .
+  specs:
+    composite_content (1.0.0)
+      active_model_validations_reflection
+      acts_as_list (~> 1.0.4)
+      cocooned (~> 1.4.0)
+      rails (>= 6.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_model_validations_reflection (0.1.2)
+      activemodel (>= 3.2)
+      activesupport (>= 3.2)
+    activejob (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.3.6)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activestorage (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    acts_as_list (1.0.4)
+      activerecord (>= 4.2)
+    ast (2.4.2)
+    builder (3.2.4)
+    cocooned (1.4.1)
+      rails (>= 5.0, <= 7.1)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.16.2)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    puma (5.6.4)
+      nio4r (~> 2.0)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.3.1)
+      actioncable (= 7.0.3.1)
+      actionmailbox (= 7.0.3.1)
+      actionmailer (= 7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actiontext (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3.1)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.34.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.15.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    shoulda-matchers (5.1.0)
+      activesupport (>= 5.2.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.4)
+    strscan (3.0.4)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  composite_content!
+  puma
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop
+  rubocop-performance
+  rubocop-rails
+  rubocop-rake
+  rubocop-rspec
+  shoulda-matchers (~> 5.0)
+  sprockets-rails
+  sqlite3
+
+BUNDLED WITH
+   2.3.19

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2022 notus.sh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,112 @@
+# CompositeContent
+
+[![Build Status](https://app.travis-ci.com/notus-sh/composite_content.svg?branch=master)](https://app.travis-ci.com/notus-sh/composite_content)
+[![Gem Version](https://badge.fury.io/rb/composite_content.svg)](https://badge.fury.io/rb/composite_content)
+
+`CompositeContent` add capacities to your Rails application to manage complex contents made of blocks with ease.
+
+## Some Background
+
+Rich administrable contents used to be managed through WYSIWYG editors. This leaves you with a very poor control over what is allowed inside such content areas and how it will be rendered afterwards: `img` tags may include the full picture as base64 data or, like `iframe`s (pasted from videos or slides sharing code), can have hard-coded dimensions that makes them hard to manipulate in a responsive design; titles hierarchy may not semantically fit in every context where your content will be displayed; rogue CSS classes can be pasted from word processors without being noticed.  
+The list of potential problems in a responsive and multi-channel world goes on…
+
+An alternative to a monolithic WYSIWYG editor is to split your content into manageable chunks, or blocks. Each type of block can have its own properties and options and their definition should give you the ability to carefully manage their content to integrate it in various use cases and/or with other parts of your application. Such system should be extensible, so you can create new types of blocks to fit your needs.
+
+For example:
+
+- An image block can use your favorite attachment solution to retain picture information and be able to render it with the appropriate `src-set` attribute to accommodate screen resolutions you support.
+- A video block can be rendered in a custom made player.
+- A button block can survive your next redesign.
+- Knowing your titles hierarchy inside a long content can gives you the ability to automate building of a table of content.
+- A dedicated block type can help you to integrate descriptions of one or more of your products into a blog post.
+
+`CompositeContent` provides basis for a composite content management on your models, in a way that can be compared to article construction on [medium.com](https://medium.com) or to the [WordPress Gutenberg editor](https://wordpress.org/gutenberg/), and aims to integrate well with your Rails application. It's voluntarily kept simple so you can plug your favorite tools in and style it to integrate well with your design.
+
+## Installation
+
+`CompositeContent` is distributed as a gem and available on [rubygems.org](https://rubygems.org/gems/composite_content) so you can add it to your `Gemfile` or install it manually with:
+
+```ruby
+gem install composite_content
+```
+
+Once the gem is installed, you need to integrate it with your Rails application.
+
+```shell
+# Copy CompositeContent's engine files into your app:
+# - Views to app/views/composite_content
+# - Database migrations to db/migrate
+$ rails g composite_content:install
+
+# Apply migrations
+$ rails db:migrate 
+```
+
+**Important:** For forms to work, you also need to integrate assets from the [Cocooned gem](https://github.com/notus-sh/cocooned) with yours. As there is multiple ways to do so, wether you use Sprockets, webpacker/shakapacker or importmaps, we won't describe this step in details here.
+
+## Usage
+
+In your models, you can declare one or more CompositeContent per model.
+
+```ruby
+class Article < ApplicationRecord
+  # You can use the default content slot name (:composite_content)…
+  has_composite_content
+end
+
+class Page < ApplicationRecord
+  # …or give it a name that is explicit for you.
+  has_composite_content :main
+  
+  # You can specify what kinds of blocks you accept in a content slot.
+  has_composite_content :aside, types: %w(CompositeContent::Blocks::Text)
+end
+```
+
+### Strong Parameters
+
+In your controllers, allow composite content attributes with:
+
+```ruby
+class ArticleController < ApplicationController
+  # […]
+  def article_params
+    params.require(:article)
+          .permit(:title,
+                  composite_content_attributes: Article.strong_parameters_for_composite_content)
+  end
+end
+
+class PageController < ApplicationController
+  # […]
+  def page_params
+    params.require(:page)
+          .permit(:title,
+                  main_attributes: Page.strong_parameters_for_main,
+                  aside_attributes: Page.strong_parameters_for_aside)
+  end
+end
+```
+
+### Views
+
+In your forms, make composite content editable with:
+
+```erbruby
+<%= form.fields_for :composite_content do |composite_content_form| %>
+  <%= render 'composite_content/slot/form', form: composite_content_form %>
+<% end %>
+```
+
+In your views, render the content of a slot with:
+
+```erbruby
+<%= composite_content_render_slot(article.composite_content) %>
+
+<%= composite_content_render_slot(page.main) %>
+<%= composite_content_render_slot(page.aside) %>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/notus-sh/composite_content>.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: :spec

data/composite_content.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'lib/composite_content/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'composite_content'
+  spec.version       = CompositeContent::VERSION
+  spec.licenses      = ['Apache-2.0']
+  spec.authors       = ['Gaël-Ian Havard']
+  spec.email         = ['gael-ian@notus.sh']
+
+  spec.summary       = 'Add composite content capacities to your ActiveRecord models.'
+  spec.description   = 'Build complex contents for your ActiveRecord models in a controllable way.'
+  spec.homepage      = 'https://github.com/notus-sh/composite_content'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.require_paths = ['lib']
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.add_dependency 'active_model_validations_reflection'
+  spec.add_dependency 'acts_as_list', '~> 1.0.4'
+  spec.add_dependency 'cocooned', '~> 1.4.0'
+  spec.add_dependency 'rails', '>= 6.1.0'
+
+  # Development tools
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rails'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'shoulda-matchers', '~> 5.0'
+end

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+---
+en:
+  composite_content:
+    blocks:
+      heading:
+        add: Add a title
+      quote:
+        add: Add a quote
+      text:
+        add: Add a text

data/config/locales/fr.yml

@@ -0,0 +1,10 @@
+---
+fr:
+  composite_content:
+    blocks:
+      heading:
+        add: Ajouter un titre
+      quote:
+        add: Ajouter une citation
+      text:
+        add: Ajouter un text

data/db/migrate/20220807184334_create_composite_content_slots.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateCompositeContentSlots < ActiveRecord::Migration[6.0]
+  def change
+    create_table :composite_content_slots do |t|
+      t.string :type,
+               null: false,
+               index: true
+
+      t.references :parent,
+                   polymorphic: true,
+                   index: { name: 'index_composite_content_slots_on_parent' }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220807185808_create_composite_content_blocks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateCompositeContentBlocks < ActiveRecord::Migration[6.0]
+  def change
+    create_table :composite_content_blocks do |t|
+      t.references :slot
+      t.references :blockable, polymorphic: true,
+                               index: { name: 'index_composite_content_blocks_on_blockable' }
+      t.integer :position, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220807191353_create_composite_content_headings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateCompositeContentHeadings < ActiveRecord::Migration[6.0]
+  def change
+    create_table :composite_content_headings do |t|
+      t.integer :level, null: false, default: 1
+      t.string :content
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220807191402_create_composite_content_quotes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateCompositeContentQuotes < ActiveRecord::Migration[6.0]
+  def change
+    create_table :composite_content_quotes do |t|
+      t.text :content
+      t.string :source
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220807191410_create_composite_content_texts.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateCompositeContentTexts < ActiveRecord::Migration[6.0]
+  def change
+    create_table :composite_content_texts do |t|
+      t.text :content
+
+      t.timestamps
+    end
+  end
+end

data/gemfiles/rails-6.1.x.gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+group :development, :test do
+  gem 'rails', '~> 6.1.0'
+  gem 'sqlite3'
+
+  gem 'net-smtp'
+  gem 'net-pop'
+  gem 'net-imap'
+end