simplec 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30941905c919979a56cf165241070e5da7822192
-  data.tar.gz: 48b105ceabc6246c9b3cdbcc30dcbdc1a479696d
+  metadata.gz: 97eb4b055eff958715400003bbf1a6296fa5c4af
+  data.tar.gz: ab0e7a5baa49e1389b8e925ec17063fb9683db84
 SHA512:
-  metadata.gz: f9b3616fc0b37ae640025027a50f55a41a52bbc6187ffc781de995717311142b922fafb1990bc98290fdbdfe6378173257842051a892a65ca3d96e3038ac8024
-  data.tar.gz: 8e1fbe53a20d80b5362d16ff6a71be9d5c62ae97a855dc97e1f753010d9e92079ddb78733bbf3f6ca23e9544a973efb91b29618bc72957e10ae0e56ac892fc6c
+  metadata.gz: f3a22c3c561611dee863c259c6aa358689a9ab9779efd8111e6d2c1348fd107b373757d7070d2589f0a1401c1d9495609afb093fc863550f3a21ad11413e12c3
+  data.tar.gz: 6b68170c0d3f3958e69f844dfbd90a8cc4926aafbe106b602600f2bf4667d146796678e2979d45d22f60d5782abc31d4eedab35f2740d5f7ecc27532d30439ca

data/README.md

@@ -1,29 +1,34 @@
 # Simplec
 
-### A CMS for developers, built by developers.
+### A CMS that stays out of the way.
 
-This gem handles all of the rote parts of a CMS, but gets out of the way for
-everything else. In Rails it is easy to build things from scratch, but it is
-a waste of resources to build again and again. This library is an attempt to
-get all of the good parts of a CMS without the baggage of a CMS that takes
-over the entire ecosystem.
+This gem handles all of the rote parts of a CMS, but gets out of the way for everything else.
+
+In Rails it is easy to build things from scratch, but it is a waste of resources
+to build again and again. This library is an attempt to get all of the good
+parts of a CMS without the baggage of a CMS that takes over the entire
+ecosystem.
 
 ## Dependencies
-- rails >= 5.0.5
 
-- pg >= 0.21.0; postgres >= 9.5
+- rails >= 5.0.5
 
-    We hate dependencies, but postgres is just too good. We use it for search
-    and JSONB.
+    This probably can be lowered to older versions.
 
-- imagemagick
+- pg >= 0.21.0; Postgres >= 9.5
 
-    For image processing. Note there is a known vulnerability, please update
-    accordingly: https://imagetragick.com/
+    We hate dependencies, but Postgres is just too good. We use it for search
+    and JSONB. If you think we could make this database agnostic, we are open
+    for contributions!
 
 - dragonfly
 
-    We still hate dependencies, but this is a necessity and the best option.
+    We still hate dependencies, but this is a necessity and one of the best
+    options. We might change it out for ActiveStorage.
+
+- imagemagick
+
+    For image processing.
 
 ## Recommended Dependencies
 
@@ -44,19 +49,23 @@ application.**
 
 _Optionally, you can create a separate set of assets for only the admin via
 standard Rails methods. Or you could not include them and deal with the
-fallout. ;-)_
+fallout. We are happy to accept pull requests! ;-)_
 
 
 ## Features
+
 - Pages with Templates
 
 - Subdomain support
 
-- Use application models or assets in CMS pages
-
 - Search (coming soon)
 
+- Documents and Document Sets (local or S3/Google/etc)
+
+- Use application models or assets in CMS pages
+
 ## Anti-Features
+
 - User management
 
 - Permissions
@@ -69,6 +78,9 @@ fallout. ;-)_
 - simplec-blog: Don't always need or want a blog bundled in. (You might have
   your own.)
 
+- simplec-sections: Sections compose pages. Configure pages composed of Sections
+  rather than taking a page hook line and sinker.
+
 - simplec-admin: Opinionated, prebuilt way of managing pages. Take it or leave
   it. Or don't mount it and generate scaffold controllers and views for basic
   functions.
@@ -238,6 +250,8 @@ used to generate uuid primary keys.
 Installation varies per operating system. Image magic is used by dragonfly
 for on the fly (then cached) image manipulation.
 
+Note there is a known vulnerability, please update accordingly: https://imagetragick.com/
+
 See this page for a good cheat sheet: http://markevans.github.io/dragonfly/imagemagick
 
 ## Roadmap
@@ -265,6 +279,12 @@ See this page for a good cheat sheet: http://markevans.github.io/dragonfly/image
 
     - utilize thread local variable for found subdomain in #subdomain
 
+    - page previews?
+
+    - configure uuid or integer pk/fk
+
+    - note about migration versions on old rails installs
+
 1. Sitemap
 
 1. Installer `rails generater simplec:install`
@@ -279,6 +299,8 @@ See this page for a good cheat sheet: http://markevans.github.io/dragonfly/image
 
 1. Remove as many dependencies as possible.
 
+1. github-markdown for markup?
+
 ## Contributing
 1. Use it and file create issues. Somethings are core, other things will be
   relegated to 3rd party extensions.
@@ -304,6 +326,11 @@ See this page for a good cheat sheet: http://markevans.github.io/dragonfly/image
 
         rake db:migrate
 
+4. Run the documentation server
+
+        gem install yard
+        yard server -r --no-cache --no-save --verbose --debug --backtrace
+
 
 ## Contributors
 

data/app/controllers/simplec/pages_controller.rb

@@ -3,10 +3,18 @@ require_dependency "simplec/page_action_helpers"
 
 module Simplec
   class PagesController < ApplicationController
+    include Simplec::ActionController::Extensions
     include Simplec::PageActionHelpers
 
     def show
-      render_path params[:path] || ''
+      begin
+        render_path params[:path] || ''
+      rescue ActiveRecord::SubclassNotFound => e
+        # TODO add proc config for error notification, airbrake, etc
+        #
+        Rails.logger.info e
+        render status: 404
+      end
     end
 
   end

data/app/models/simplec/admin/page.rb

@@ -0,0 +1,10 @@
+module Simplec
+  module Admin
+    class Page < Simplec::Page
+      # ignore type column for instatiation in admin pages,
+      # which can cause errors if a model class is deleted
+      self.inheritance_column = nil
+    end
+  end
+end
+

data/app/models/simplec/page.rb

@@ -4,20 +4,26 @@ module Simplec
   #
   # == Model and Template Relationship.
   #
-  # Each page has a class located in:
-  #   app/models/page/NAME.rb
+  # This is a para with `code`. WTF
   #
-  # Each page has a partial template in:
-  #   app/views/pages/_NAME.html.erb
+  # Each page has:
   #
-  #   Where NAME is the demodulized, snake-case name of the Page Subclasss. For
-  #   example:
+  # - a class located in: `app/models/page/NAME.rb`
   #
-  #     class Page::Home < Page
-  #       field :h1
-  #     end
+  # - a partial template in: +app/views/pages/_NAME.html.erb+
   #
-  #   Would have a have a template in `app/views/pages/_home.html.erb`.
+  # Where NAME is the demodulized, snake-case name of the Page Subclass.
+  #
+  # @example Class and template
+  #
+  #   # app/models/page/home.rb
+  #   class Page::Home < Page
+  #     field :h1
+  #   end
+  #
+  #   <!-- app/views/pages/_home.html.erb -->
+  #   <h1>My Application</h1>
+  #   <h2><%= @page.tagline %></h2>
   #
   # @!visibility public
   class Page < ApplicationRecord

data/lib/simplec/page_action_helpers.rb

@@ -8,11 +8,26 @@ module Simplec
 
       private
 
-      def render_path(path)
+      # Render the template and layout for a path.
+      #
+      # @param path [String] a path without a leading /
+      # @param options [Hash] passed through to underlying `render`
+      #
+      # @!visibility public
+      def render_path(path, options={})
         @page = page(path)
-        render template: 'simplec/pages/show', layout: layout(@page)
+        render options.merge(
+          template: 'simplec/pages/show',
+          layout: layout(@page)
+        )
       end
 
+      # Determine the layout for a page.
+      #
+      # @param page [Simplec::Page]
+      #
+      # @return [String] layout name
+      # @!visibility public
       def layout(page)
         # TODO allow config for public
         [page.layout, page.subdomain.default_layout, 'public'].
@@ -21,6 +36,7 @@ module Simplec
 
     end
 
+    # @!visibility private
     def self.included(receiver)
       receiver.extend         ClassMethods
       receiver.send :include, InstanceMethods

data/lib/simplec/version.rb

@@ -1,3 +1,3 @@
 module Simplec
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplec
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Matt Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A CMS that doesn't take over an application.
 email:
 - matt@nearapogee.com
@@ -120,6 +134,7 @@ files:
 - app/helpers/simplec/application_helper.rb
 - app/jobs/simplec/application_job.rb
 - app/mailers/simplec/application_mailer.rb
+- app/models/simplec/admin/page.rb
 - app/models/simplec/application_record.rb
 - app/models/simplec/document.rb
 - app/models/simplec/document_set.rb