comfy_archive 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73980cbf5c9dfe489601266553d0ab4a16b369758e8f379d60861ea7f0e9cbdf
-  data.tar.gz: 6f6b3c14ba6754b8cb01f50a3eabf2149fcad1427c960f63e9db66d4a03797a5
+  metadata.gz: c55ea63ba29ffb508628ff2e03e49526f078960ae53897f39bae7d87169e0f9b
+  data.tar.gz: 866ab58373fcbc74ba56b311359a74b01d1c891dd3a01a0badf16b8193c93f2d
 SHA512:
-  metadata.gz: c635e6a7f305a8b9b4915c7f7051fe2c2ef3883ee0d66ec09c13761eb265da3fe33a89d95757796c8b0e3ba26f85886c713c2356543f973a9f7463a169e642a6
-  data.tar.gz: 3a691a6cf2f79254787dd0dcf3284fd1d4ac2ef52285ea5b5660d96712d096175a45b6b8df9772e7cedd9684c2527b5e2f5de6b852328a884edc6eaef1feab9c
+  metadata.gz: a54e9ae15d7ec66c381ea2027a7656721dcde69927e57649d9c47946080fe1ab3faa933743125304519e67f9104ccf601e264f957d0ea7e8985c9f7f50f2a2e8
+  data.tar.gz: 8ef5a1444f1dadf90fc75e2ced725cb62199c062b35735868a9933477f3a414c05d4e98ea8e740281b7f9e0442d14ad0f2b8d198ef4303dacd917b3a4b297080

data/LICENSE

@@ -1,5 +1,5 @@
 Copyright 2013-2018 Oleg Khabarov
-Copyright 2019 Discovery Map International, Inc.
+Copyright 2019-2022 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

data/README.md

@@ -12,7 +12,7 @@ Make sure that you have [ComfortableMexicanSofa](https://github.com/comfy/comfor
 
 1) Add gem definition to your Gemfile:
 
-    gem "comfy_archive", "~> 0.2.0"
+    gem "comfy_archive", "~> 0.3.0"
 
 2) From your Rails project's root run:
 
@@ -25,21 +25,24 @@ Make sure that you have [ComfortableMexicanSofa](https://github.com/comfy/comfor
     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.
+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.
+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
 
+3) Optionally, create a `config/initializers/comfy_archive.rb` file to override default configuration options
+
 ## Architecture
 
 * `ComfyArchive`: Rails Engine which manages configuration, adds scopes & associations to `Comfy::Cms::Site` & `Comfy::Cms::Page` models, and adds route matching methods
+* `Comfy::ArchiveHelper`: Helper methods for generating links to chronological & category archive pages
 * `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.
+Copyright (c) 2019-2022 Discovery Map International, Inc.

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

@@ -22,8 +22,8 @@ class Comfy::Archive::IndexController < Comfy::Cms::ContentController
           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)
+        load_category
+        scope = scope.for_category(@category.label).distinct(false)
       end
 
       @archive_pages = comfy_paginate(scope, per_page: ComfyArchive.config.posts_per_page)
@@ -46,4 +46,24 @@ class Comfy::Archive::IndexController < Comfy::Cms::ContentController
     end
   end
 
+  def load_category
+    @category = ComfyArchive.config.parameterize_category ? find_cms_category_by_parameterized_label(params[:category]) : Comfy::Cms::Category.find_by(label: CGI.unescape(params[:category]))
+    unless @category
+      if ComfyArchive.config.strict_categories
+        if find_cms_page_by_full_path("/404")
+          render_page(:not_found)
+        else
+          message = "Page Not Found at: \"#{params[:cms_path]}/category/#{params[:category]}\""
+          raise ActionController::RoutingError, message
+        end
+      else
+        @category = Comfy::Cms::Category.new(label: ComfyArchive.config.parameterize_category ? params[:category].gsub('-', ' ').titleize : CGI.unescape(params[:category]))
+      end
+    end
+  end
+
+  def find_cms_category_by_parameterized_label(parameterized)
+    @cms_index.categories.find { |c| c.label.parameterize == parameterized }
+  end
+
 end

data/app/helpers/comfy/archive_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Comfy
+  module ArchiveHelper
+
+    require 'cgi'
+
+    def comfy_archive_link_to_month(year, month)
+      unless !@cms_index || year.blank? || month.blank?
+        date = [I18n.t("date.month_names")[month.to_i], year].join(' ')
+        link_to date, comfy_archive_pages_of_month_path(@cms_index.url(relative: false), year: year, month: month)
+      end
+    end
+
+    def comfy_archive_link_to_category(category)
+      if category.is_a? Comfy::Cms::Category
+        label = category.label
+      elsif category.is_a? String
+        label = category
+      end
+      unless !@cms_index || category.blank?
+        encoded_label = ComfyArchive.config.parameterize_category ? label.parameterize : CGI.escape(label)
+        link_to label, comfy_archive_pages_of_category_path(@cms_index.url(relative: false), encoded_label)
+      end
+    end
+
+  end
+end

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

@@ -1,5 +1,3 @@
-- require 'cgi'
-
 - site_path = @cms_index.url(relative: false)
 
 %h2
@@ -23,9 +21,8 @@
   - 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)
+    = comfy_archive_link_to_month year, 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))
+  = comfy_archive_link_to_category category

data/lib/comfy_archive/configuration.rb

@@ -6,9 +6,17 @@ module ComfyArchive
     # Number of posts per page. Default is 10
     attr_accessor :posts_per_page
 
+    # Parameterize category label in paths. Default is false
+    attr_accessor :parameterize_category
+
+    # Generate 404 error or throw warning for invalid catgegories. Default is true
+    attr_accessor :strict_categories
+
     # Configuration defaults
     def initialize
-      @posts_per_page   = 10
+      @posts_per_page         = 10
+      @parameterize_category  = false
+      @strict_categories      = true
     end
 
   end

data/lib/comfy_archive/version.rb

@@ -2,6 +2,6 @@
 
 module ComfyArchive
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comfy_archive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Morgan Aldridge
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: comfortable_mexican_sofa
@@ -39,6 +39,7 @@ files:
 - app/assets/config/manifest.js
 - app/controllers/comfy/admin/archive/indices_controller.rb
 - app/controllers/comfy/archive/index_controller.rb
+- app/helpers/comfy/archive_helper.rb
 - app/models/comfy/archive/index.rb
 - app/views/comfy/admin/archive/indices/_form.html.haml
 - app/views/comfy/admin/archive/indices/edit.html.haml
@@ -79,7 +80,7 @@ homepage: http://github.com/discoverymap/comfy-archive
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Chronological Archives Engine for ComfortableMexicanSofa
 test_files: []