occams 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8dcda75b6239c3fb7e71b35c45c3b5674373bd96d9c14457776af68ff8b1a391
+  data.tar.gz: 003f1604af55a848c28214b6fcccbb2863ec797adad4515580d933ddb9078c79
+SHA512:
+  metadata.gz: 6a7f7f9b4317cefb3961cd916b75f4df6bd8247686f80224926bc5cde93f255e840b567cf506e03112c069e755ffa9810840eff605905fe39ec65471a9c17658
+  data.tar.gz: 68ed2b0e79500d11ac2c940f4b89c33a894a388b26eec05cfec13d6c28198bc61ec945ad49367df83546d7d40e0b36dab379e6dd4fa6bfca7f206b35424ce964

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,22 @@
+*Note:* For general questions and feature requests please leave a message
+on Gitter: https://gitter.im/comfy/comfortable-mexican-sofa
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### Steps to reproduce
+Things that help:
+
+* Describe 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/.gitignore

@@ -0,0 +1,21 @@
+.bundle
+db/*.sqlite3
+log/*.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,87 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - db/migrate/**/*
+    - test/fixtures/**/*
+    - tmp/**/*
+
+# -- Layout --------------------------------------------------------------------
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineHashBraceLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/ParameterAlignment:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+# -- Metrics -------------------------------------------------------------------
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+# -- Naming --------------------------------------------------------------------
+Naming/MethodParameterName:
+  Enabled: false
+
+# -- Style ---------------------------------------------------------------------
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false

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/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v1.0.0 - 8/5/2023
+
+- Copies the original [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa)
+- Adds the changes from [Restarone's fork](https://github.com/restarone/comfortable-mexican-sofa) (23 commits)
+- Adds the ability to write snippets in Markdown

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Contribute your code to Occams 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,30 @@
+# frozen_string_literal: true
+
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "autoprefixer-rails", "~> 8.1.0"
+  gem "byebug",             "~> 10.0.0", platforms: %i[mri mingw x64_mingw]
+  gem "capybara",           "~> 3.39.0"
+  gem "image_processing",   ">= 1.2"
+  gem "kaminari",           "~> 1.1.1"
+  gem "puma",               "~> 3.12.2"
+  gem "rubocop",            "~> 0.55.0", require: false
+  gem "selenium-webdriver", "~> 4.9.0"
+  gem "sqlite3",            "~> 1.4.2"
+end
+
+group :development do
+  gem "listen",       "~> 3.8.0"
+  gem "web-console",  "~> 3.5.1"
+end
+
+group :test do
+  gem "coveralls",                "~> 0.8.21", require: false
+  gem "diffy",                    "~> 3.2.0"
+  gem "equivalent-xml",           "~> 0.6.0"
+  gem "mocha",                    "~> 1.3.0", require: false
+  gem "rails-controller-testing", "~> 1.0.2"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Andrew vonderLuft
+
+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/LICENSE.comfy

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2019 Oleg Khabarov
+
+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,121 @@
+# ocCaM'S
+
+Prefer Simplicity
+
+## Raison d'etre
+
+ocCaM'S is a revival of [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa), with all due thanks and acknowledgements to [Oleg Khabarov](https://github.com/GBH), et al. 'Comfy' was the simplest and cleanest Rails-based CMS that I had used. Its last commit was in 2020, and I simply did not want to see it die on the vine as [RadiantCMS](https://github.com/radiant/radiant) did some years ago.
+
+```
+             ____      __  __ _ ____
+  ___   ___ / ___|__ _|  \/  ( ) ___|
+ / _ \ / __| |   / _` | |\/| |/\___ \
+| (_) | (__| |__| (_| | |  | |  ___) |
+ \___/ \___|\____\__,_|_|  |_| |____/
+
+``` 
+
+## The name
+
+ocCaM'S, pronounced "AH-kums" is a nod to [Occam's Razor](https://en.wikipedia.org/wiki/Occam%27s_razor) - for this Rails-based Content Management System endeavors to follow the principle that the preferred solution is that which is simplest and built with the smallest possible set of components.
+
+## Features
+
+* Simple drop-in integration with Rails 6.0+ apps with minimal configuration
+* CMS stays away from the rest of your application
+
+Referring to the [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) documentation, substituting 'Occams' for 'ComfortableMexicanSofa' where appropriate.
+
+* Powerful page templating capability using [Content Tags](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Content-Tags)
+* [Multiple Sites](https://github.com/ocms/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` and then `rake db:migrate`
+* 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
+
+- Install and basic functionality validated on Ruby 3.2.2. with Rails 6.1.7.4 and 7.0.6
+- >= Rails 7 is recommended, since performance is noticably better
+
+## Installation
+
+Add gem definition to your Gemfile:
+
+```ruby
+gem "occams"
+```
+
+* From the Rails project's root run:  
+  `bundle install`
+* Then add the CMS:  
+  `rails generate occams:cms`
+* If you want to store files in your CMS with Active Storage:  
+  `rails active_storage:install`
+* Set up the database:  
+  `rails 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
+occams_route :cms_admin, path: "/admin"
+occams_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/occams.rb](https://github.com/avonderluft/occams/blob/main/config/initializers/occams.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.
+
+## ToDos
+
+- Linting via current version of rubocop
+- Image file thumbnail hover not working on Rails 7
+- get the original [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) tests working
+- add documentation to Occams to replace ComfortableMexicanSofa 
+
+## Documentation
+
+Refer to the [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) documentation, substituting 'Occams' for 'Comfy' where appropriate.
+
+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).
+
+[Ocms Demo App](https://github.com/comfy/comfy-demo) also can be used as an
+example of a default Rails app with CMS installed.
+
+#### Contributing
+
+The Occams repository can run like any Rails application in development. It's as easy to work on as any other Rails app.
+For more detail see [CONTRIBUTING](CONTRIBUTING.md)
+
+#### Acknowledgements
+
+- Obviously to Oleg Khabarov, the creator of [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa). This is his work, with just a few updates and additions.
+- Thanks to [Roman Almeida](https://github.com/nasmorn) for contributing OEM License for [Redactor Text Editor](http://imperavi.com/redactor)
+
+---
+- [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) Copyright 2010-2019 Oleg Khabarov. Released under the [MIT license](LICENSE)
+- [Occams](https://github.com/avonderluft/occams) follows suit, being also 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/occams/admin/cms/application.js

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

data/app/assets/javascripts/occams/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/occams/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/occams/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/occams/admin/cms/custom.js

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

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

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