comfy_archive 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22cc14df3fd53a58e65d4c3d9e262388d6969414fd7b4a7a8065b2749a2e87f0
+  data.tar.gz: a0709230779817c4011fd429c73859a9a172713214fea66322d9a48b165e5e90
+SHA512:
+  metadata.gz: 23801bb7a1ecc7c6582e6a88ea27fda60de910a4bceb9dc124bdc9ad67061c92632d229098ccc9ea76db3dc7d6a3b4fc13d723c1fd5244e48a22bc3a43245a45
+  data.tar.gz: 29840c80f9337ef60018beeb1c88dcf69a89091ad6a69718e80818924eb9d3a78173cb4f9ad453a52a5ca21d09a238bfc723db02fb939b6c688b97ff5719c3ad

data/.gitignore

@@ -0,0 +1,17 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/**/*
+.DS_Store
+db/schema.rb
+db/development_structure.sql
+pkg
+rdoc
+/tmp
+public/*
+Gemfile.lock
+.rvmrc
+.ruby-version
+/.sass-cache
+coverage/
+.byebug_history

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source "http://rubygems.org"
+
+gemspec
+
+# CMS has dependency on prerelease and Bundler chokes on it
+gem "rails", "~> 5.2.0.rc1"
+
+group :development, :test do
+  gem "byebug",   "~> 10.0.0", platforms: %i[mri mingw x64_mingw]
+  gem "kaminari", "~> 1.1.1"
+  gem "puma",     "~> 3.11.2"
+  gem "rubocop",  "~> 0.55.0", require: false
+  gem "sqlite3",  "~> 1.3.13"
+end
+
+group :development do
+  gem "listen",       "~> 3.1.5"
+  gem "web-console",  "~> 3.5.1"
+end
+
+group :test do
+  gem "coveralls",                "~> 0.8.21", require: false
+  gem "mocha",                    "~> 1.3.0", require: false
+  gem "rails-controller-testing", "~> 1.0.2"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright 2013-2018 Oleg Khabarov
+Copyright 2019 Discovery Map International, Inc.
+
+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,43 @@
+# ComfyArchive
+
+ComfyArchive is a management engine for chronologically & categorically archived sections for [Comfortable Mexican Sofa](https://github.com/comfy/comfortable-mexican-sofa) 2.x. You can select one or more Comfortable Mexican Sofa pages to act as an index for child pages, which will then be organized both cronologically, by year and month, and by category.
+
+## Dependencies
+
+Make sure that you have [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa) installed first.
+
+## Installation
+
+1) Add gem definition to your Gemfile:
+
+    gem "comfy_archive", "~> 0.1.1"
+
+2) From your Rails project's root run:
+
+    bundle install
+    rails generate comfy:archive
+    rake db:migrate
+
+3) Add the following lines to your `config/routes.rb` file, after the "`comfy_route :cms_admin`" line and before the "`comfy_route :cms`" line:
+
+    comfy_route :archive_admin
+    comfy_route :archive
+
+4) You should also find view templates in your `/app/views/comfy/archive` folder. Feel free to adjust them as you see fit.
+
+## Configuration
+
+1) Add a `datetime` tag to the layout used by any page which will be ordered chronologically under an index page, then set the field to a valid date & time in the pages themselves.
+
+2) Add a new Archive Index, selecting the parent page (_Important_: can not be the root page!) which will act as an index for child pages and enter the name of the `datetime` tag you created in Step 1
+
+## Architecture
+
+* `ComfyArchive`: Rails Engine which manages configuration, adds scopes & associations to `Comfy::Cms::Site` & `Comfy::Cms::Page` models, and adds route matching methods
+* `Comfy::Archive::Index`: A model which represents pages which will become chronological archive pages, it has a `Comfy::Cms::Page` association and also the name of the page's `datetime` fragment to use for chronological ordering
+* `Comfy::Admin::Archive::IndicesController`: A Comfortable Mexican Sofa admin controller for managing `Comfy::Archive::Index` models
+* `Comfy::Archive::IndexController`: A controller for rendering `Comfy::Archive::Index` pages, plus chronological & categorical archive pages
+
+---
+
+Copyright (c) 2019 Discovery Map International, Inc.

data/Rakefile

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

data/app/controllers/comfy/admin/archive/indices_controller.rb

@@ -0,0 +1,65 @@
+class Comfy::Admin::Archive::IndicesController < Comfy::Admin::Cms::BaseController
+
+  before_action :build_index, only: %i[new create]
+  before_action :load_index,  only: %i[edit update destroy]
+  before_action :authorize
+
+  def index
+    return redirect_to action: :new if @site.archive_indices.count.zero?
+
+    indices_scope = @site.archive_indices
+    @indices = comfy_paginate(indices_scope)
+  end
+
+  def new
+    render
+  end
+
+  def create
+    @index.save!
+    flash[:success] = t(".created")
+    redirect_to action: :edit, id: @index
+
+  rescue ActiveRecord::RecordInvalid
+    flash.now[:danger] = t(".create_failure")
+    render action: :new
+  end
+
+  def edit
+    render
+  end
+
+  def update
+    @index.update_attributes!(index_params)
+    flash[:success] = t(".updated")
+    redirect_to action: :edit, id: @index
+
+  rescue ActiveRecord::RecordInvalid
+    flash.now[:danger] = t(".update_failure")
+    render action: :edit
+  end
+
+  def destroy
+    @index.destroy
+    flash[:success] = t(".deleted")
+    redirect_to action: :index
+  end
+
+protected
+
+  def load_index
+    @index = @site.archive_indices.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    flash[:danger] = t(".not_found")
+    redirect_to action: :index
+  end
+
+  def build_index
+    @index = @site.archive_indices.new(index_params)
+  end
+
+  def index_params
+    params.fetch(:index, {}).permit!
+  end
+
+end

data/app/controllers/comfy/archive/index_controller.rb

@@ -0,0 +1,45 @@
+require 'cgi'
+
+class Comfy::Archive::IndexController < Comfy::Cms::ContentController
+
+  include Comfy::Paginate
+
+  before_action :load_index,
+                :authenticate,
+                :authorize,
+                only: :index
+
+  def index
+    unless @cms_index && @cms_index.page == @cms_page
+      show
+    else
+      scope = @cms_index.children(true).chronologically(@cms_index.datetime_fragment)
+      if params[:year]
+        @year = params[:year]
+        scope = scope.for_year(@cms_index.datetime_fragment, @year)
+        if params[:month]
+          @month = params[:month]
+          scope = scope.for_month(@cms_index.datetime_fragment, @month)
+        end
+      elsif params[:category]
+        @category = CGI.unescape(params[:category])
+        scope = scope.for_category(@category).distinct(false)
+      end
+
+      @archive_pages = comfy_paginate(scope, per_page: ComfyArchive.config.posts_per_page)
+      render layout: app_layout
+    end
+  end
+
+  protected
+
+  def load_index
+    load_cms_page
+    if @cms_page
+      unless @cms_index = Comfy::Archive::Index.find_by(page: @cms_page)
+        @cms_index = Comfy::Archive::Index.find_by(page: @cms_page.parent)
+      end
+    end
+  end
+
+end

data/app/models/comfy/archive/index.rb

@@ -0,0 +1,36 @@
+class Comfy::Archive::Index < ActiveRecord::Base
+
+  self.table_name = "comfy_archive_indices"
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :site,
+    class_name: "Comfy::Cms::Site"
+  belongs_to :page,
+    class_name: "Comfy::Cms::Page"
+
+  # -- Validations -------------------------------------------------------------
+  validates :label, :datetime_fragment,
+    presence:   true
+  validates :page,
+    presence:   true,
+    uniqueness: { scope: :page_id }
+
+  # -- Instance Mathods --------------------------------------------------------
+  def url(relative: false)
+    page.url(relative: relative)
+  end
+
+  def children(published = false)
+    if published
+      page.children.published
+    else
+      page.children
+    end
+  end
+
+  def categories(published = false)
+    category_ids = Comfy::Cms::Categorization.where(categorized_type: "Comfy::Cms::Page", categorized_id: self.children(published)).pluck(:category_id).uniq
+    Comfy::Cms::Category.where(id: category_ids)
+  end
+
+end

data/app/views/comfy/admin/archive/indices/_form.html.haml

@@ -0,0 +1,14 @@
+= comfy_admin_partial "comfy/admin/archive/partials/index_form_before", form: form
+
+= form.text_field :label
+
+- if (options = ::Comfy::Cms::Page.options_for_select(site: @site, current_page: @index.page, exclude_self: false)).present?
+  = form.select :page_id, options, bootstrap: {custom_control: true}
+
+= form.text_field :datetime_fragment
+
+= comfy_admin_partial "comfy/admin/archive/partials/index_form_after", form: form
+
+= form.form_actions do
+  = submit_tag t(@index.new_record? ? ".create" : ".update"), class: "btn btn-primary ml-sm-1", data: {disable_with: false}
+  = link_to t(".cancel"), comfy_admin_archive_indices_path(@site, @index), class: "btn btn-link"

data/app/views/comfy/admin/archive/indices/edit.html.haml

@@ -0,0 +1,5 @@
+.page-header
+  %h2= t('.title')
+
+= comfy_form_with model: @index, scope: :index, url: {action: :update}, html: {multipart: true} do |form|
+  = render form

data/app/views/comfy/admin/archive/indices/index.html.haml

@@ -0,0 +1,29 @@
+.page-header
+  = link_to t('.new_link'), new_comfy_admin_archive_index_path(@site), class: 'btn btn-secondary float-right'
+  %h2= t('.title')
+
+= comfy_admin_partial "comfy/admin/blog/partials/indices_before"
+
+= comfy_paginate @indices
+
+%ul.list
+  - @indices.each do |index|
+    %li
+      .row
+        .col-md-8.item
+          .item-content
+            .item-title
+              = link_to index.label, edit_comfy_admin_archive_index_path(@site, index)
+            .item-meta
+              - link = index.url
+              = link_to link, link, target: "_blank"
+              %br
+
+        .col-md-4.d-flex.align-items-center.justify-content-md-end
+          .btn-group.btn-group-sm
+            = link_to t('.edit'), edit_comfy_admin_archive_index_path(@site, index), class: 'btn btn-outline-secondary'
+            = link_to t('.delete'), comfy_admin_archive_index_path(@site, index), method: :delete, data: {confirm: t('.are_you_sure')}, class: 'btn btn-danger'
+
+= comfy_paginate @indices
+
+= comfy_admin_partial "comfy/admin/blog/partials/indices_after"

data/app/views/comfy/admin/archive/indices/new.html.haml

@@ -0,0 +1,5 @@
+.page-header
+  %h2= t('.title')
+
+= comfy_form_with model: @index, scope: :index, url: {action: :create}, html: {multipart: true} do |form|
+  = render form

data/app/views/comfy/admin/archive/partials/_navigation.html.haml

@@ -0,0 +1,4 @@
+- if @site && @site.persisted?
+  %li.nav-item
+    = active_link_to comfy_admin_archive_indices_path(@site), class: "nav-link" do
+      = t('comfy.admin.cms.base.archives')

data/app/views/comfy/archive/index/index.html.haml

@@ -0,0 +1,31 @@
+- require 'cgi'
+
+- site_path = @cms_index.url(relative: false)
+
+%h2
+  = link_to @cms_index.page.label, site_path
+
+- @archive_pages.each do |page|
+  %h3
+    = link_to page.label, page.url
+  .date
+    = page.published_at(@cms_index.datetime_fragment).to_s(:db)
+
+= comfy_paginate @archive_pages
+
+%h4 Archives
+- case ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+- when :mysql, :mysql2
+  - dates = @cms_index.children(true).chronologically(@cms_index.datetime_fragment).group(:year, :month).unscope(:order).order(year: :desc, month: :desc).pluck(Arel.sql("YEAR(comfy_cms_fragments.datetime) as year, MONTH(comfy_cms_fragments.datetime) as month"))
+- when :sqlite
+  - dates = @cms_index.children(true).chronologically(@cms_index.datetime_fragment).group(:year, :month).unscope(:order).order(year: :desc, month: :desc).pluck(Arel.sql("strftime('%Y', comfy_cms_fragments.datetime) as year, strftime('%m', comfy_cms_fragments.datetime) as month"))
+- else
+  - raise NotImplementedError, "Unknown adapter type '#{ActiveRecord::Base.connection.adapter_name}'"
+- dates.each do |(year, month)|
+  %li
+    - date = [I18n.t("date.month_names")[month.to_i], year].join(" ")
+    = link_to date, comfy_archive_pages_of_month_path(site_path, year: year, month: month)
+
+%h4 Categories
+- @cms_index.categories(true).each do |category|
+  = link_to category.label, comfy_archive_pages_of_category_path(site_path, category: CGI.escape(category.label))

data/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+VENDOR_PATH = File.expand_path('..', __dir__)
+Dir.chdir(VENDOR_PATH) do
+  begin
+    exec "yarnpkg #{ARGV.join(' ')}"
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/comfy_archive.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require "comfy_archive/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "comfy_archive"
+  s.version     = ComfyArchive::VERSION
+  s.authors     = ["Morgan Aldridge"]
+  s.email       = ["morgan@discoverymap.com"]
+  s.homepage    = "http://github.com/discoverymap/comfy-archive"
+  s.summary     = "Chronological Archives Engine for ComfortableMexicanSofa"
+  s.description = "Chronological Archives Engine for ComfortableMexicanSofa"
+  s.license     = "MIT"
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|doc)/})
+  end
+
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = ">= 2.3.0"
+
+  s.add_dependency "comfortable_mexican_sofa", ">= 2.0.14"
+end

data/config/application.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module ComfyArchive
+  class Application < Rails::Application
+
+    require_relative "../lib/comfy_archive"
+
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Ensuring that all ActiveStorage routes are loaded before out globbing route.
+    config.railties_order = [ActiveStorage::Engine, :main_app, :all]
+
+    # Making sure we don't load our dev routes as part of the engine
+    config.paths["config/routes.rb"] << "config/archive_routes.rb"
+
+    config.i18n.enforce_available_locales = true
+
+  end
+end

data/config/archive_routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+ComfyArchive::Application.routes.draw do
+  comfy_route :cms_admin
+  comfy_route :archive_admin
+  comfy_route :archive
+  comfy_route :cms
+end

data/config/boot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+File.exist?(ENV["BUNDLE_GEMFILE"])

data/config/database.yml

@@ -0,0 +1,11 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 10000
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 10000

data/config/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Load the rails application
+require File.expand_path("application", __dir__)
+
+# Initialize the rails application
+ComfyArchive::Application.initialize!

data/config/environments/development.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+defined?(ComfyArchive::Application) && ComfyArchive::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options)
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  config.active_job.queue_adapter = :inline
+
+  config.action_view.raise_on_missing_translations = true
+end