comfy_archive 0.1.1

data/config/environments/test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+defined?(ComfyArchive::Application) && ComfyArchive::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory
+  config.active_storage.service = :test
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  config.active_job.queue_adapter = :inline
+
+  config.action_view.raise_on_missing_translations = true
+end

data/config/initializers/comfy_archive.rb

@@ -0,0 +1,3 @@
+ComfyArchive.configure do |config|
+
+end

data/config/locales/en.yml

@@ -0,0 +1,57 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  # ComfyArchive
+  activerecord:
+    models:
+      comfy/archive/index: Post
+    attributes:
+      comfy/archive/index:
+        label: Label
+        datetime_fragment: DateTime Fragment
+  comfy:
+    admin:
+      cms:
+        base:
+          archives: Archives
+      archive:
+        indices:
+          created: Archive Index created
+          create_failure: Failed to create Archive Index
+          updated: Archive Index updated
+          update_failure: Failed to update Archive Index
+          deleted: Archive Index removed
+          not_found: Archive Index not found
+          index:
+            title: Archive Indices
+            new_link: New Archive Index
+            edit: Edit
+            delete: Delete
+            are_you_sure: Are you sure?
+          new:
+            title: New Archive Index
+          edit:
+            title: Edit Archive Index
+          form:
+            create: Create Index
+            update: Update Index
+            cancel: Cancel

data/config/storage.yml

@@ -0,0 +1,35 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   keyfile: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket
+
+# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   path: your_azure_storage_path
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path("../config/environment", __FILE__)
+run ComfyArchive::Application

data/db/migrate/00_create_cms.rb

@@ -0,0 +1,167 @@
+class CreateCms < ActiveRecord::Migration[5.2]
+
+  LIMIT = 16777215
+
+  def change
+
+    # -- Active Storage --------------------------------------------------------
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [:key], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+      t.datetime :created_at, null: false
+
+      t.index [:record_type, :record_id, :name, :blob_id],
+        name:   "index_active_storage_attachments_uniqueness",
+        unique: true
+    end
+
+    # -- Sites -----------------------------------------------------------------
+    create_table :comfy_cms_sites, force: true do |t|
+      t.string :label,        null: false
+      t.string :identifier,   null: false
+      t.string :hostname,     null: false
+      t.string :path
+      t.string :locale,       null: false, default: "en"
+      t.timestamps
+
+      t.index :hostname
+    end
+
+    # -- Layouts ---------------------------------------------------------------
+    create_table :comfy_cms_layouts, force: true do |t|
+      t.integer :site_id,     null: false
+      t.integer :parent_id
+      t.string  :app_layout
+      t.string  :label,       null: false
+      t.string  :identifier,  null: false
+      t.text    :content,     limit: LIMIT
+      t.text    :css,         limit: LIMIT
+      t.text    :js,          limit: LIMIT
+      t.integer :position,    null: false, default: 0
+      t.timestamps
+
+      t.index [:parent_id, :position]
+      t.index [:site_id, :identifier], unique: true
+    end
+
+    # -- Pages -----------------------------------------------------------------
+    create_table :comfy_cms_pages, force: true do |t|
+      t.integer :site_id,         null: false
+      t.integer :layout_id
+      t.integer :parent_id
+      t.integer :target_page_id
+      t.string  :label,           null: false
+      t.string  :slug
+      t.string  :full_path,       null: false
+      t.text    :content_cache,   limit: LIMIT
+      t.integer :position,        null: false, default: 0
+      t.integer :children_count,  null: false, default: 0
+      t.boolean :is_published,    null: false, default: true
+      t.timestamps
+
+      t.index [:site_id, :full_path]
+      t.index [:parent_id, :position]
+      t.index [:is_published]
+    end
+
+    # -- Translations ----------------------------------------------------------
+    create_table :comfy_cms_translations, force: true do |t|
+      t.string  :locale,    null: false
+      t.integer :page_id,   null: false
+      t.integer :layout_id
+      t.string  :label,           null: false
+      t.text    :content_cache,   limit: LIMIT
+      t.boolean :is_published,    null: false, default: true
+      t.timestamps
+
+      t.index [:page_id]
+      t.index [:locale]
+      t.index [:is_published]
+    end
+
+    # -- Fragments -------------------------------------------------------------
+    create_table :comfy_cms_fragments, force: true do |t|
+      t.references  :record,      polymorphic: true
+      t.string      :identifier,  null: false
+      t.string      :tag,         null: false, default: "text"
+      t.text        :content,     limit: LIMIT
+      t.boolean     :boolean,     null: false, default: false
+      t.datetime    :datetime
+      t.timestamps
+
+      t.index [:identifier]
+      t.index [:datetime]
+      t.index [:boolean]
+    end
+
+    # -- Snippets --------------------------------------------------------------
+    create_table :comfy_cms_snippets, force: true do |t|
+      t.integer :site_id,     null: false
+      t.string  :label,       null: false
+      t.string  :identifier,  null: false
+      t.text    :content,     limit: LIMIT
+      t.integer :position,    null: false, default: 0
+      t.timestamps
+
+      t.index [:site_id, :identifier], unique: true
+      t.index [:site_id, :position]
+    end
+
+    # -- Files -----------------------------------------------------------------
+    create_table :comfy_cms_files, force: true do |t|
+      t.integer :site_id,     null: false
+      t.string  :label,       null: false, default: ""
+      t.text    :description, limit: 2048
+      t.integer :position,    null: false, default: 0
+      t.timestamps
+
+      t.index [:site_id, :position]
+    end
+
+    # -- Revisions -------------------------------------------------------------
+    create_table :comfy_cms_revisions, force: true do |t|
+      t.string    :record_type, null: false
+      t.integer   :record_id,   null: false
+      t.text      :data,        limit: LIMIT
+      t.datetime  :created_at
+
+      t.index [:record_type, :record_id, :created_at],
+      name: "index_cms_revisions_on_rtype_and_rid_and_created_at"
+    end
+
+    # -- Categories ------------------------------------------------------------
+    create_table :comfy_cms_categories, force: true do |t|
+      t.integer :site_id,          null: false
+      t.string  :label,            null: false
+      t.string  :categorized_type, null: false
+
+      t.index [:site_id, :categorized_type, :label],
+      unique: true,
+      name:   "index_cms_categories_on_site_id_and_cat_type_and_label"
+    end
+
+    create_table :comfy_cms_categorizations, force: true do |t|
+      t.integer :category_id,       null: false
+      t.string  :categorized_type,  null: false
+      t.integer :categorized_id,    null: false
+
+      t.index [:category_id, :categorized_type, :categorized_id],
+      unique: true,
+      name:   "index_cms_categorizations_on_cat_id_and_catd_type_and_catd_id"
+    end
+
+  end
+end

data/db/migrate/01_create_archive.rb

@@ -0,0 +1,12 @@
+class CreateArchive < ActiveRecord::Migration[5.2]
+  def change
+    create_table :comfy_archive_indices do |t|
+      t.integer :site_id,           null: false
+      t.string  :label,             null: false
+      t.string  :datetime_fragment, null: false
+      t.integer :page_id,           null: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/comfy_archive/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ComfyArchive
+  class Configuration
+
+    # Number of posts per page. Default is 10
+    attr_accessor :posts_per_page
+
+    # Configuration defaults
+    def initialize
+      @posts_per_page   = 10
+    end
+
+  end
+end

data/lib/comfy_archive/engine.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+#require "rubygems"
+require "rails"
+require "comfortable_mexican_sofa"
+#require "comfy_archive"
+
+module ComfyArchive
+
+  module CmsSiteExtensions
+
+    extend ActiveSupport::Concern
+    included do
+      has_many :archive_indices,
+        class_name: "Archive::Index",
+        dependent:  :destroy
+    end
+
+  end
+
+  module CmsPageExtensions
+
+    extend ActiveSupport::Concern
+    included do
+      scope :chronologically, ->(datetime_fragment) { joins(:fragments).where(comfy_cms_fragments: {identifier: datetime_fragment}).reorder(Arel.sql("`comfy_cms_fragments`.`datetime` DESC")) }
+      scope :for_year, ->(datetime_fragment, year) {
+        case ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+        when :mysql, :mysql2
+          chronologically(datetime_fragment).where("YEAR(comfy_cms_fragments.datetime) = ?", year)
+        when :sqlite
+          chronologically(datetime_fragment).where("strftime('%Y', comfy_cms_fragments.datetime) = ?", year.to_s)
+        else
+          raise NotImplementedError, "Unknown adapter type '#{ActiveRecord::Base.connection.adapter_name}'"
+        end
+      }
+      scope :for_month, ->(datetime_fragment, month) {
+        case ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+        when :mysql, :mysql2
+          chronologically(datetime_fragment).where("MONTH(comfy_cms_fragments.datetime) = ?", month)
+        when :sqlite
+          chronologically(datetime_fragment).where("strftime('%m', comfy_cms_fragments.datetime) = ?", month.to_s)
+        else
+          raise NotImplementedError, "Unknown adapter type '#{ActiveRecord::Base.connection.adapter_name}'"
+        end
+      }
+
+      def published_at(datetime_fragment)
+        self.fragments.where(identifier: datetime_fragment).first.datetime
+      end
+    end
+
+  end
+
+  class Engine < ::Rails::Engine
+
+    initializer "comfy_archive.configuration" do
+      ComfortableMexicanSofa::ViewHooks.add(:navigation, "/comfy/admin/archive/partials/navigation")
+      config.to_prepare do
+        Comfy::Cms::Site.send :include, ComfyArchive::CmsSiteExtensions
+        Comfy::Cms::Page.send :include, ComfyArchive::CmsPageExtensions
+      end
+    end
+
+  end
+
+end

data/lib/comfy_archive/routes/archive.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ActionDispatch::Routing::Mapper
+
+  def comfy_route_archive(options = {})
+    scope module: :comfy, as: :comfy do
+      namespace :archive, path: options[:path] do
+        with_options constraints: { year: %r{\d{4}}, month: %r{\d{1,2}} } do |o|
+          o.get "*cms_path/:year",          to: "index#index", as: :pages_of_year
+          o.get "*cms_path/:year/:month",   to: "index#index", as: :pages_of_month
+        end
+        get "*cms_path/category/:category", to: "index#index", as: :pages_of_category
+        get "(*cms_path)",                  to: "index#index", as: :render_page, action: "/:format"
+      end
+    end
+  end
+
+end

data/lib/comfy_archive/routes/archive_admin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class ActionDispatch::Routing::Mapper
+
+  def comfy_route_archive_admin(options = {})
+    options[:path] ||= "admin"
+    path = [options[:path], "sites", ":site_id"].join("/")
+
+    scope module: :comfy, as: :comfy do
+      scope module: :admin do
+        namespace :archive, as: :admin, path: path, except: [:show] do
+          resources :indices, as: :archive_indices, path: "archive-indices" do
+            get :form_fragments, on: :member
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/comfy_archive/routing.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "routes/archive_admin"
+require_relative "routes/archive"

data/lib/comfy_archive/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ComfyArchive
+
+  VERSION = "0.1.1"
+
+end

data/lib/comfy_archive.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "comfy_archive/version"
+require_relative "comfy_archive/engine"
+require_relative "comfy_archive/configuration"
+require_relative "comfy_archive/routing"
+
+module ComfyArchive
+
+  class << self
+
+    # Modify Archive configuration
+    # Example:
+    #   ComfyArchive.configure do |config|
+    #     config.posts_per_page = 5
+    #   end
+    def configure
+      yield configuration
+    end
+
+    # Accessor for ComfyArchive::Configuration
+    def configuration
+      @configuration ||= ComfyArchive::Configuration.new
+    end
+    alias config configuration
+
+  end
+
+end

data/lib/generators/comfy/archive/README

@@ -0,0 +1,12 @@
+   _____                 __                         _     _           
+  / ____|               / _|         /\            | |   (_)          
+ | |     ___  _ __ ___ | |_ _   _   /  \   _ __ ___| |__  ___   _____ 
+ | |    / _ \| '_ ` _ \|  _| | | | / /\ \ | '__/ __| '_ \| \ \ / / _ \
+ | |___| (_) | | | | | | | | |_| |/ ____ \| | | (__| | | | |\ V /  __/
+  \_____\___/|_| |_| |_|_|  \__, /_/    \_\_|  \___|_| |_|_| \_/ \___|
+                             __/ |                                    
+                            |___/                                     
+
+Hey! Everything is almost done. Please don't forget to
+  
+  * run migrations -> `rake db:migrate`

data/lib/generators/comfy/archive/archive_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module Comfy
+  module Generators
+    class ArchiveGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+      include Thor::Actions
+
+      source_root File.expand_path("../../../..", __dir__)
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def generate_migration
+        destination   = File.expand_path("db/migrate/01_create_archive.rb", destination_root)
+        migration_dir = File.dirname(destination)
+        destination   = self.class.migration_exists?(migration_dir, "create_archive")
+
+        if destination
+          puts "\e[0m\e[31mFound existing create_archive migration. Remove it if you want to regenerate.\e[0m"
+        else
+          migration_template "db/migrate/01_create_archive.rb", "db/migrate/create_archive.rb"
+        end
+      end
+
+      def generate_initialization
+        copy_file "config/initializers/comfy_archive.rb",
+          "config/initializers/comfy_archive.rb"
+      end
+
+      def generate_routing
+        route_string = <<-RUBY.strip_heredoc
+          comfy_route :archive_admin
+          comfy_route :archive
+        RUBY
+        route route_string
+      end
+
+      def generate_views
+        directory "app/views/comfy/archive", "app/views/comfy/archive"
+      end
+
+      def show_readme
+        readme "lib/generators/comfy/archive/README"
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: comfy_archive
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Morgan Aldridge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: comfortable_mexican_sofa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.14
+description: Chronological Archives Engine for ComfortableMexicanSofa
+email:
+- morgan@discoverymap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/manifest.js
+- app/controllers/comfy/admin/archive/indices_controller.rb
+- app/controllers/comfy/archive/index_controller.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
+- app/views/comfy/admin/archive/indices/index.html.haml
+- app/views/comfy/admin/archive/indices/new.html.haml
+- app/views/comfy/admin/archive/partials/_navigation.html.haml
+- app/views/comfy/archive/index/index.html.haml
+- bin/bundle
+- bin/rails
+- bin/rake
+- bin/setup
+- bin/update
+- bin/yarn
+- comfy_archive.gemspec
+- config.ru
+- config/application.rb
+- config/archive_routes.rb
+- config/boot.rb
+- config/database.yml
+- config/environment.rb
+- config/environments/development.rb
+- config/environments/test.rb
+- config/initializers/comfy_archive.rb
+- config/locales/en.yml
+- config/storage.yml
+- db/migrate/00_create_cms.rb
+- db/migrate/01_create_archive.rb
+- lib/comfy_archive.rb
+- lib/comfy_archive/configuration.rb
+- lib/comfy_archive/engine.rb
+- lib/comfy_archive/routes/archive.rb
+- lib/comfy_archive/routes/archive_admin.rb
+- lib/comfy_archive/routing.rb
+- lib/comfy_archive/version.rb
+- lib/generators/comfy/archive/README
+- lib/generators/comfy/archive/archive_generator.rb
+homepage: http://github.com/discoverymap/comfy-archive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Chronological Archives Engine for ComfortableMexicanSofa
+test_files: []