comfortable_media_surfer 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ebf4f5ffb32f8c4e6aa359c897a5d35aead15a9c3839fc7e41af49db4f44676
+  data.tar.gz: cec761f797bc01265e44d5f64f9426a59eb5940e722ab2f149b29e8d7dec818f
+SHA512:
+  metadata.gz: c301e8f8152f0eaeadda3f7560f0926370987fda15647218701751953d712891e97aeedda19d462cbf054c50d2a9e56a85c8381640a5200dd623cd6b1a744760
+  data.tar.gz: 2aa71081385b605f87e1f9d4642f0ca4f3f92a9fd91e9b927562ec289adb3f3f71111d05f15ebb2e61f62491c61e1a2f7655bf9ca53787dd852678f091361e72

data/.codeclimate.yml

@@ -0,0 +1,4 @@
+exclude_paths:
+  - app/assets/javascripts/comfy/vendor/*
+  - app/assets/stylesheets/comfy/vendor/*
+  - db/*

data/.gitattributes

@@ -0,0 +1,2 @@
+app/assets/javascripts/comfy/vendor/* linguist-vendored
+app/assets/stylesheets/comfy/vendor/* linguist-vendored

data/.github/issue_template.md

@@ -0,0 +1,19 @@
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what does happen
+
+### Steps to reproduce
+Things that help:
+
+* Describe the issue in detail.
+* Add relevant code snippets.
+* Create a failing test case.
+
+### System configuration
+**Rails version**:
+
+**CMS version**:
+
+**Ruby version**:

data/.github/pull_request_template.md

@@ -0,0 +1,6 @@
+### Summary
+
+General information about what this PR is all about. If it fixes any issues
+please don't forget to tag them.
+
+Thanks for contributing!

data/.github/workflows/coveralls.yml

@@ -0,0 +1,40 @@
+name: "Coveralls"
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  coveralls:
+    strategy:
+      matrix:
+        ruby-version:
+          - "3.3"
+        rails-version:
+          - "7.1"
+        continue-on-error: [true]
+    name: ${{ format('Coverage (Ruby {0}, Rails {1})', matrix.ruby-version, matrix.rails-version) }}
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.continue-on-error }}
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.rails-version }}.gemfile
+      RAILS_ENV: test
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Run tests, report coverage
+        run: |
+          bin/bundle install --retry 3 --quiet
+          bin/bundle exec rails db:drop
+          bin/bundle exec rails db:create
+          bin/bundle exec rails db:migrate
+          bin/bundle exec rails test:db

data/.github/workflows/rubyonrails.yml

@@ -0,0 +1,51 @@
+name: "Rails CI"
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build_test_lint_audit:
+    strategy:
+      matrix:
+        ruby-version:
+          - "3.1"
+          - "3.2"
+          - "3.3"
+        rails-version:
+          - "6.1"
+          - "7.1"
+          - "7.2"
+        continue-on-error: [true]
+    name: ${{ format('Tests (Ruby {0}, Rails {1})', matrix.ruby-version, matrix.rails-version) }}
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.continue-on-error }}
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.rails-version }}.gemfile
+      RAILS_ENV: test
+      SKIP_COV: true
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Run tests
+        run: |
+          bin/bundle install --retry 3 --quiet
+          bin/bundle exec rails db:drop
+          bin/bundle exec rails db:create
+          bin/bundle exec rails db:migrate
+          bin/bundle exec rails test:db
+
+      - name: Lint the code
+        run: bin/bundle exec rubocop --parallel
+
+      - name: Audit for security
+        run: |
+          bin/bundle exec brakeman -q -w3
+          bin/bundle exec bundler-audit --update --gemfile-lock gemfiles/${{ matrix.rails-version }}.gemfile.lock

data/.gitignore

@@ -0,0 +1,21 @@
+.bundle
+db/*.sqlite3*
+log/*
+tmp/**/*
+.DS_Store
+db/schema.rb
+db/development_structure.sql
+db/test.sqlite3-journal
+pkg
+rdoc
+/tmp
+public/system/
+Gemfile.lock
+.rvmrc
+.ruby-version
+.ruby-gemset
+/.sass-cache
+coverage/
+/storage
+db/cms_fixtures/test-site/
+.idea

data/.rubocop.yml

@@ -0,0 +1,75 @@
+require:
+  # - rubocop-rails
+  # - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - db/migrate/**/*
+    - test/fixtures/**/*
+    - tmp/**/*
+    - vendor/bundle/**/*
+
+# -- Layout --------------------------------------------------------------------
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Max: 148
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+# -- Metrics -------------------------------------------------------------------
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 45
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+# -- Naming --------------------------------------------------------------------
+Naming/MethodParameterName:
+  Enabled: false
+
+# -- Style ---------------------------------------------------------------------
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r

data/.travis.yml

@@ -0,0 +1,44 @@
+dist: xenial
+services:
+  - xvfb
+addons:
+  sources:
+  - google-chrome
+  apt:
+    packages:
+    - google-chrome-stable
+
+language: ruby
+rvm:
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+gemfile:
+  - test/gemfiles/5.2.gemfile
+jobs:
+  include:
+    - rvm: 2.5.7
+      gemfile: test/gemfiles/6.0.gemfile
+    - rvm: 2.6.5
+      gemfile: test/gemfiles/6.0.gemfile
+branches:
+  only:
+    - master
+before_install:
+  - gem update --system
+  - gem update bundler
+before_script:
+  - wget http://chromedriver.storage.googleapis.com/2.36/chromedriver_linux64.zip
+  - unzip chromedriver_linux64.zip
+  - sudo apt-get install libnss3
+  - sudo apt-get --only-upgrade install google-chrome-stable
+  - sudo cp chromedriver /usr/local/bin/.
+  - sudo chmod +x /usr/local/bin/chromedriver
+  - export DISPLAY=:99.0
+  - sleep 3
+script:
+  - bundle exec rake db:migrate
+  - bundle exec rake test
+  - SKIP_COV=true bundle exec rake test:system
+  - bundle exec rubocop

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Contribute your code to ComfortableMediaSurfer in 5 easy steps:
+
+### 1. Fork it
+
+Fork the project. Optionally, create a branch you want to work on.
+
+### 2. Get it running locally
+
+- Install gem dependencies with `bundle install`
+- There's nothing to configure, by default database is SQLite so it will be
+  created for you. Just run `bundle exec rake db:migrate`
+- Make sure that existing tests are passing by running `bundle exec rake test`
+- There are system tests that can be run with `bundle exec rake test:system`.
+  You need to have `chromedriver` installed for that.
+- You should be able to start the app via `bin/rails s` and navigate to http://localhost:3000/admin
+
+### 3. Hack away
+
+- Create a few small pull requests instead of a humoungous one. I can merge small stuff faster.
+- When adding new code just make sure it follows the same slyle as the existing code.
+- Avoid adding 3rd party dependencies if you can.
+- Tests please, but nothing complicated. UnitTest / Fixtures all the way. Make sure all tests pass.
+- Run `bundle exec rubocop` and fix any issues raised.
+
+### 4. Make a pull request
+
+- If you never done it before read this: https://help.github.com/articles/using-pull-requests
+- When PR is submitted check if TravisCI ran all tests successfully and Rubocop didn't raise any issues
+
+### 5. Done!
+
+If everything is good your changes will be merged into master branch. Eventually
+a new version of gem will be published.

data/Gemfile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem 'rails', '~> 7.2'
+
+group :development, :test do
+  gem 'autoprefixer-rails', '~> 10.4.16.0'
+  gem 'byebug',             '~> 11.1.0', platforms: %i[mri mingw x64_mingw]
+  gem 'image_processing',   '>= 1.12.0'
+  gem 'sqlite3',            '~> 1.6.7'
+  # gem 'mysql2',             '~> 0.5'
+  # gem 'pg',                 '~> 1.5.4'
+end
+
+group :development do
+  gem 'listen',       '~> 3.9.0'
+  gem 'web-console',  '~> 4.2'
+end
+
+group :test do
+  gem 'brakeman',                 '~> 6.1.2'
+  gem 'bundler-audit',            '~> 0.9.1'
+  gem 'coveralls_reborn',         '~> 0.28.0', require: false
+  gem 'cuprite',                  '>= 0.15'
+  gem 'equivalent-xml',           '~> 0.6.0'
+  gem 'minitest',                 '>= 5.23.0'
+  gem 'minitest-reporters',       '>= 1.6.1'
+  gem 'mocha',                    '>= 2.3.0', require: false
+  gem 'rails-controller-testing', '~> 1.0.5'
+  gem 'rubocop',                  '~> 1.63.0', require: false
+  gem 'rubocop-minitest'
+  gem 'rubocop-rails'
+  gem 'simplecov', '~> 0.22.0', require: false
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2019 Oleg Khabarov, (c) 2024 Shakacode LLC
+
+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,109 @@
+# ComfortableMediaSurfer
+
+ComfortableMediaSurfer is a powerful Ruby 6.1+ CMS (Content Management System) Engine, picking up where [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) left off.
+
+## Features
+
+* Simple drop-in integration with Rails 6.1+ apps with minimal configuration
+* The CMS keeps clear from the rest of your application
+* Powerful page templating capability using [Content Tags](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Content-Tags)
+* [Multiple Sites](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Sites) from a single installation
+* Multi-Language Support (i18n) (ca, cs, da, de, en, es, fi, fr, gr, hr, it, ja, nb, nl, pl, pt-BR, ru, sv, tr, uk, zh-CN, zh-TW) and page localization.
+* [CMS Seeds](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-CMS-Seeds) for initial content population
+* [Revision History](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Revisions) to revert changes
+* [Extendable Admin Area](https://github.com/comfy/comfortable-mexican-sofa/wiki/HowTo:-Reusing-Admin-Area) built with [Bootstrap 4](http://getbootstrap.com) (responsive design). Using [CodeMirror](http://codemirror.net) for HTML and Markdown highlighing and [Redactor](http://imperavi.com/redactor) as the WYSIWYG editor.
+
+## Dependencies
+
+* File attachments are handled by [ActiveStorage](https://github.com/rails/rails/tree/master/activestorage). Make sure that you can run appropriate migrations by running: `rails active_storage:install`
+* Image resizing is done with with [ImageMagick](http://www.imagemagick.org/script/download.php), so make sure it's installed.
+* Pagination is handled by [kaminari](https://github.com/amatsuda/kaminari) or [will_paginate](https://github.com/mislav/will_paginate). Please add one of those to your Gemfile.
+
+## Compatibility
+
+- Ruby >= 3.0 with Rails >= 6.1
+- On Ruby 3.x, Rails 7.x + is recommended, since performance is noticably better than on 6.x
+
+## Installation
+
+Add gem definition to your Gemfile:
+
+```ruby
+gem "comfortable_media_surfer", "~> 3.0.0"
+```
+
+Then from the Rails project's root run:
+
+    bundle install
+    rails generate comfy:cms
+    rake db:migrate
+
+Now take a look inside your `config/routes.rb` file. You'll see where routes attach for the admin area and content serving. Make sure that content serving route appears as a very last item or it will make all other routes to be inaccessible.
+
+```ruby
+comfy_route :cms_admin, path: "/admin"
+comfy_route :cms, path: "/"
+```
+
+## Quick Start Guide
+
+After finishing installation you should be able to navigate to http://localhost:3000/admin
+
+Default username and password is 'user' and 'pass'. You probably want to change it right away. Admin credentials (among other things) can be found and changed in the cms initializer: [/config/initializers/comfortable\_media\_surfer.rb](https://github.com/shakacode/comfortable-media-surfer/blob/master/config/initializers/comfortable_media_surfer.rb)
+
+Before creating pages and populating them with content we need to create a Site. Site defines a hostname, content path and its language.
+
+After creating a Site, you need to make a Layout. Layout is the template of your pages; it defines some reusable content (like header and footer, for example) and places where the content goes. A very simple layout can look like this:
+
+```html
+<html>
+  <body>
+    <h1>{{ cms:text title }}</h1>
+    {{ cms:wysiwyg content }}
+  </body>
+</html>
+```
+
+Once you have a layout, you may start creating pages and populating content. It's that easy.
+
+## Documentation
+
+For more information on how to use this CMS please refer to the [Wiki](https://github.com/comfy/comfortable-mexican-sofa/wiki). Section that might be of interest is the entry
+on [Content Tags](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Content-Tags).
+
+[Comfy Demo App](https://github.com/comfy/comfy-demo) also can be used as an
+example of a default Rails app with CMS installed.
+
+## Add-ons
+
+If you want to add a Blog functionality to your app take a look at
+[ComfyBlog](https://github.com/comfy/comfy-blog).
+
+![Admin Area Preview](doc/preview.jpg)
+
+#### Old Versions
+
+[CHANGELOG](//github.com/comfy/comfortable-mexican-sofa/releases) is documented
+in Github releases.
+
+#### Contributing
+
+ComfortableMediaSurfer repository can be ran like a regular Rails application in
+development environment. It's as easy to work on as any other Rails app out there.
+For more detail take a look at [CONTRIBUTING](CONTRIBUTING.md)
+
+#### Testing
+
+- `bin/rails db:migrate RAILS_ENV=test`
+- `rake db:test:prepare`
+- `rake test`
+
+#### Acknowledgements
+
+- to [Oleg Khabarov](https://github.com/GBH), the creator of [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa)
+- to [Roman Almeida](https://github.com/nasmorn) for contributing OEM License for [Redactor Text Editor](http://imperavi.com/redactor)
+
+---
+
+Copyright 2010-2019 Oleg Khabarov, 2024 ShakaCode LLC
+Released under the [MIT license](LICENSE)

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/app/assets/javascripts/comfy/admin/cms/application.js

@@ -0,0 +1,39 @@
+//= require rails-ujs
+//= require jquery3
+
+//= require comfy/vendor/codemirror
+//= require comfy/vendor/codemirror/mode/css/css
+//= require comfy/vendor/codemirror/mode/htmlmixed/htmlmixed
+//= require comfy/vendor/codemirror/mode/javascript/javascript
+//= require comfy/vendor/codemirror/mode/markdown/markdown
+//= require comfy/vendor/codemirror/mode/xml/xml
+//= require comfy/vendor/codemirror/addon/edit/closetag
+//= require comfy/vendor/sortable.min
+//= require comfy/vendor/bootstrap.bundle.min
+//= require comfy/vendor/diff/diff_match_patch.min
+//= require comfy/vendor/diff/pretty_text_diff
+//= require comfy/vendor/fontawesome
+//= require comfy/vendor/redactor
+//= require comfy/vendor/redactor/filemanager
+//= require comfy/vendor/redactor/imagemanager
+//= require comfy/vendor/redactor/definedlinks
+//= require comfy/vendor/redactor/table
+//= require comfy/vendor/redactor/video
+//= require_directory ../../vendor/redactor/i18n/
+//= require comfy/vendor/flatpickr.min
+//= require_directory ../../vendor/flatpickr/i18n/
+
+//= require comfy/admin/cms/base
+//= require comfy/admin/cms/categories
+//= require comfy/admin/cms/codemirror
+//= require comfy/admin/cms/diff
+//= require comfy/admin/cms/file_link
+//= require comfy/admin/cms/file_upload
+//= require comfy/admin/cms/files_modal
+//= require comfy/admin/cms/page_fragments
+//= require comfy/admin/cms/sortable_list
+//= require comfy/admin/cms/slugify
+//= require comfy/admin/cms/timepicker
+//= require comfy/admin/cms/wysiwyg
+
+//= require comfy/admin/cms/custom

data/app/assets/javascripts/comfy/admin/cms/base.js

@@ -0,0 +1,46 @@
+(() => {
+  if (!window.CMS) window.CMS = {};
+  const CMS = window.CMS;
+
+  // TODO(glebm): Use the battle-tested universal onPageLoad code and enable Turbolinks+async in the demo app.
+  // See: https://gist.github.com/glebm/2496daf445877055447a6fac46509d9a
+  const isTurbolinks = 'Turbolinks' in window && window.Turbolinks.supported;
+  if (isTurbolinks) {
+    document.addEventListener('turbolinks:load', () => {
+      window.CMS.init();
+    });
+    document.addEventListener('turbolinks:before-cache', () => {
+      window.CMS.dispose();
+    });
+  } else {
+    document.addEventListener('DOMContentLoaded', () => {
+      window.CMS.init();
+    });
+  }
+
+  CMS.init = () => {
+    CMS.current_path = window.location.pathname;
+    CMS.slugify();
+    CMS.codemirror.init();
+    CMS.wysiwyg.init();
+    CMS.sortableList.init();
+    CMS.timepicker.init();
+    CMS.pageFragments();
+    CMS.categories();
+    CMS.files.init();
+    CMS.fileLinks();
+    CMS.fileUpload.init();
+    CMS.diff();
+  };
+
+  CMS.dispose = () => {
+    CMS.codemirror.dispose();
+    CMS.wysiwyg.dispose();
+    CMS.files.dispose();
+    CMS.fileUpload.dispose();
+    CMS.sortableList.dispose();
+    CMS.timepicker.dispose();
+  };
+
+  CMS.getLocale = () => document.querySelector('meta[name="cms-locale"]').content;
+})();

data/app/assets/javascripts/comfy/admin/cms/categories.js

@@ -0,0 +1,17 @@
+(() => {
+  window.CMS.categories = (root = document) => {
+    const widget = root.querySelector('.categories-widget');
+    if (widget === null) return;
+    const readSection = widget.querySelector('.read');
+    const editSection = widget.querySelector('.editable');
+    widget.querySelector('.read button.toggle-cat-edit').addEventListener('click', () => {
+      readSection.style.display = 'none';
+      editSection.style.display = 'block';
+    });
+    widget.querySelector('.editable button.toggle-cat-edit').addEventListener('click', () => {
+      editSection.style.display = 'none';
+      readSection.style.display = 'block';
+    });
+  };
+})();
+

data/app/assets/javascripts/comfy/admin/cms/codemirror.js

@@ -0,0 +1,31 @@
+(() => {
+  const codeMirrorInstances = [];
+  window.CMS.codemirror = {
+    init(root = document) {
+      for (const textarea of root.querySelectorAll('textarea[data-cms-cm-mode]')) {
+        const codemirror = CodeMirror.fromTextArea(textarea, {
+          mode: textarea.dataset.cmsCmMode,
+          tabSize: 2,
+          lineWrapping: true,
+          autoCloseTags: true,
+          lineNumbers: true,
+          viewportMargin: Infinity
+        });
+        codeMirrorInstances.push(codemirror);
+      }
+
+      const tabsRoot = root.id === 'form-fragments' ? root : root.querySelector('#form-fragments');
+      jQuery(tabsRoot).find('a[data-toggle="tab"]').on('shown.bs.tab', () => {
+        for (const codemirror of codeMirrorInstances) {
+          codemirror.refresh();
+        }
+      });
+    },
+    dispose() {
+      for (const codemirror of codeMirrorInstances) {
+        codemirror.toTextArea();
+      }
+      codeMirrorInstances.length = 0;
+    }
+}
+})();

data/app/assets/javascripts/comfy/admin/cms/custom.js

@@ -0,0 +1 @@
+// Custom JS for the admin area

data/app/assets/javascripts/comfy/admin/cms/diff.js

@@ -0,0 +1,10 @@
+(() => {
+  window.CMS.diff = () => {
+    jQuery('.revision').prettyTextDiff({
+      cleanup: true,
+      originalContainer: '.original',
+      changedContainer: '.current',
+      diffContainer: '.diff .content',
+    });
+  }
+})();