simplec 0.1.1 → 0.1.2

data/app/controllers/simplec/application_controller.rb

@@ -0,0 +1,9 @@
+module Simplec
+  class ApplicationController < ::ActionController::Base
+    protect_from_forgery with: :exception
+
+    after_action do
+      Thread.current[:simplec_subdomain] = nil
+    end
+  end
+end

data/app/controllers/simplec/pages_controller.rb

@@ -0,0 +1,19 @@
+require_dependency "simplec/application_controller"
+
+module Simplec
+  class PagesController < ApplicationController
+
+    def show
+      @page = page("/#{params[:path]}")
+      render layout: layout(@page)
+    end
+
+    private
+
+    def layout(page)
+      [page.layout, page.subdomain.default_layout, 'public']. # TODO allow config for public
+        reject(&:blank?).first
+    end
+
+  end
+end

data/app/helpers/simplec/application_helper.rb

@@ -0,0 +1,4 @@
+module Simplec
+  module ApplicationHelper
+  end
+end

data/app/jobs/simplec/application_job.rb

@@ -0,0 +1,4 @@
+module Simplec
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/simplec/application_mailer.rb

@@ -0,0 +1,6 @@
+module Simplec
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/simplec/application_record.rb

@@ -0,0 +1,5 @@
+module Simplec
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/simplec/embedded_image.rb

@@ -0,0 +1,15 @@
+module Simplec
+  class EmbeddedImage < ApplicationRecord
+    belongs_to :embeddable,
+      polymorphic: true
+
+    dragonfly_accessor :asset
+
+    def url
+      return unless self.asset
+      return self.asset.url unless persisted?
+      self.asset.url(ei: Base64.urlsafe_encode64(self.id.to_s))
+    end
+
+  end
+end

data/app/models/simplec/page.rb

@@ -0,0 +1,203 @@
+# Simplec::Page
+#
+# This class represents a page in the system.
+#
+# Each page has a class located in:
+#   app/models/page/NAME.html.erb
+#
+# Each page has a partial template in:
+#   app/views/pages/_NAME.html.erb
+#
+#   Where NAME is the demodulized, snake-case name of the Page Subclasss. For
+#   example:
+#
+#     class Page::Home < Page
+#       field :h1
+#     end
+#
+#   Would live in app/models/page/home.html.erb and have a template in
+#   app/views/pages/_home.html.erb.
+#
+#   Each page has the following attributes by default:
+#     - page.title
+#
+# Read the documentation below for the class method .field, it is the most
+# used method.
+#
+#
+module Simplec
+  class Page < ApplicationRecord
+
+
+    # TODO Document FILE_FIELDS constant
+    #
+		FILE_FIELDS = [:file, :image].freeze
+
+		belongs_to :subdomain,
+			optional: false
+		belongs_to :parent,
+			class_name: 'Page',
+			optional: true
+		has_many :childern,
+			class_name: 'Page',
+			foreign_key: :parent_id
+		has_many :embedded_images,
+			as: :embeddable,
+			dependent: :delete_all
+
+		validates :type,
+			presence: true
+		validates :path,
+			presence: true,
+			uniqueness: { scope: :subdomain_id }
+		validates :layout,
+			inclusion: {in: :layouts, allow_blank: true}
+		validates :title,
+			presence: true
+
+		before_validation :match_parent_subdomain
+		before_validation :build_path
+		after_save :link_embedded_images!
+
+		# Define a field on the page.
+		#
+		# - name - name of field
+		# - options[:type] - :string (default), :text, :editor, :file, :image
+		#   :string - yields a text input
+		#   :text - yields a textarea
+		#   :editor - yields a summernote editor
+		#   :file - yields a file field
+		#   :image - yields a file field with image preview
+		#
+		# There is as template for each type for customization located in:
+		#   app/views/shared/fields/_TYPE.html.erb
+		#
+		# Defines a field on a subclass. This creates a getter and setter for the
+		# name passed in. The options are used when building the administration forms.
+		#
+		# Regular dragonfly validations are available on :file and :image fields.
+		# http://markevans.github.io/dragonfly/models#validations
+		#
+		def self.field(name, options={})
+			fields[name] = {name: name, type: :string}.merge(options)
+			if FILE_FIELDS.member?(fields[name][:type])
+				dragonfly_accessor name
+				data_field :"#{name}_uid"
+				data_field :"#{name}_name"
+			else
+				data_field(name)
+			end
+		end
+
+		# List fields
+		#
+		def self.fields
+			@fields ||= Hash.new
+		end
+
+		# Return a constantized type, whitelisted by known subclasses.
+		#
+		def self.type(type)
+      ::Page rescue raise '::Page not defined, define it in app/models'
+			raise 'Unsupported Page Type; define in app/models/page/' unless ::Page.subclasses.map(&:name).
+				member?(type)
+			type.constantize
+		end
+
+		# Return names of fields.
+		#
+		# type: :file, is the only option
+		#
+		def self.field_names(type=nil)
+			_fields = case type
+								when :file
+									fields.select {|k, v| FILE_FIELDS.member?(v[:type])}
+								else
+									fields
+								end
+			_fields.keys
+		end
+
+		# Return field options for building forms.
+		#
+		def field_options
+			self.class.fields.values
+		end
+
+		# List parents, closest to furthest.
+		#
+		def parents
+			page, parents = self, Array.new
+			while page.parent
+				page = page.parent
+				parents << page
+			end
+			parents
+		end
+
+		# Before validation hook.
+		#
+		# Build the path of the page to be used in routing.
+		#
+		def build_path
+			_pages = self.parents.reverse + [self]
+			self.path = "/#{_pages.map(&:slug).reject(&:blank?).join('/')}"
+		end
+
+		# Before validation hook
+		#
+		# All pages need to have a matching subdomain to parent page
+		#
+		def match_parent_subdomain
+			return unless self.parent
+			self.subdomain = self.parent.subdomain
+		end
+
+		def find_embedded_images
+			text = self.fields.values.join(' ')
+			matches = text.scan(/ei=([^&]*)/)
+			encoded_ids = matches.map(&:first)
+			ids = encoded_ids.map { |eid| Base64.urlsafe_decode64(URI.unescape(eid)) }
+			EmbeddedImage.includes(:embeddable).find(ids)
+		end
+
+		def link_embedded_images!
+			images = self.find_embedded_images
+			images.each do |image|
+				raise AlreadyLinkedEmbeddedImage if image.embeddable &&
+					image.embeddable != self
+				image.update!(embeddable: self)
+			end
+		end
+
+		def layouts
+			@layouts ||= Subdomain.new.layouts
+		end
+
+		module Normalizers
+			def slug=(val)
+				val = val ? val.to_s.split('/').reject(&:blank?).join('/') : val
+				super val
+			end
+
+			def slug
+				if self.parent_id && self.parent.nil?
+					self.path.to_s.split('/').reject(&:blank?).join('/')
+				else
+					super
+				end
+			end
+		end
+		prepend Normalizers
+
+		class AlreadyLinkedEmbeddedImage < StandardError; end
+
+		private
+
+		def self.data_field(name)
+			define_method(name) { fields[name.to_s] }
+			define_method("#{name}=") { |val| fields[name.to_s] = val }
+		end
+  end
+end
+

data/app/models/simplec/subdomain.rb

@@ -0,0 +1,30 @@
+module Simplec
+  class Subdomain < ApplicationRecord
+		has_many :pages
+		has_and_belongs_to_many :document_sets
+		has_and_belongs_to_many :documents
+
+		validates :name,
+			presence: true,
+			exclusion: { in: %w(admin) }
+		validates :default_layout,
+			inclusion: {in: :layouts, allow_blank: true}
+
+		def layouts
+			@layouts ||= Dir[Rails.root.join('app/views/layouts').to_s + "/*.html.*"].
+				map{|n| File.basename(n).split('.', 2).first }.
+				reject{|n| n =~ /\A_/ || n =~ /mailer/ || n =~ /application/ || n =~ /sessions/}.
+				sort
+		end
+
+		module Normalizers
+
+			# Force lowercase name
+			#
+			def name=(val)
+				super (val ? val.to_s.strip.downcase : val)
+			end
+		end
+		prepend Normalizers
+  end
+end

data/app/views/simplec/fields/_editor.html.erb

@@ -0,0 +1,5 @@
+<div class="form-group">
+  <%= f.label name, class: 'control-label' %>
+  <%= f.hidden_field name, id: "#{name}-#{f.object.object_id}"%>
+  <%= tag :div, class: 'editor-field', data: {input: "##{name}-#{f.object.object_id}"} %></div>
+</div>

data/app/views/simplec/fields/_file.html.erb

@@ -0,0 +1,16 @@
+<div class="form-group">
+  <%= f.label name, class: 'control-label' %>
+  <% if f.object.send(name) %>
+    <div>
+      <p class="form-control-static"><%= f.object.send(name).name %></p>
+      <div class="checkbox">
+        <label>
+          <%= f.check_box :"remove_#{name}" %>
+          Remove
+        </label>
+      </div>
+    </div>
+  <% end %>
+  <%= f.file_field name %>
+  <%= f.hidden_field :"retained_#{name}" %>
+</div>

data/app/views/simplec/fields/_image.html.erb

@@ -0,0 +1,16 @@
+<div class="form-group">
+  <%= f.label name, class: 'control-label' %>
+  <% if f.object.send(name) %>
+    <div>
+      <%= image_tag f.object.send(name).thumb('100x').url %>
+      <div class="checkbox">
+        <label>
+          <%= f.check_box :"remove_#{name}" %>
+          Remove
+        </label>
+      </div>
+    </div>
+  <% end %>
+  <%= f.file_field name %>
+  <%= f.hidden_field :"retained_#{name}" %>
+</div>

data/app/views/simplec/fields/_string.html.erb

@@ -0,0 +1,4 @@
+<div class="form-group">
+  <%= f.label name, class: 'control-label' %>
+  <%= f.text_field name, class: 'form-control' %>
+</div>

data/app/views/simplec/fields/_text.html.erb

@@ -0,0 +1,4 @@
+<div class="form-group">
+  <%= f.label name, class: 'control-label' %>
+  <%= f.text_area name, class: 'form-control' %>
+</div>

data/app/views/simplec/pages/show.html.erb

@@ -0,0 +1,2 @@
+<%= head @page %>
+<%= template @page %>

data/config/routes.rb

@@ -0,0 +1,8 @@
+Simplec::Engine.routes.draw do
+
+  scope constraints: Simplec::Subdomains do
+    root 'pages#show'
+    get '*path', to: 'pages#show'
+  end
+
+end

data/db/migrate/20170809204353_create_simplec_pages.rb

@@ -0,0 +1,30 @@
+class CreateSimplecPages < ActiveRecord::Migration[5.0]
+  def change
+    create_table :simplec_pages, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.string :type
+      t.uuid :subdomain_id
+      t.uuid :parent_id
+      t.string :path
+      t.string :slug
+      t.string :title
+      t.string :meta_description
+      t.jsonb :fields
+      t.string :layout
+
+      t.timestamps
+    end
+
+		add_index :simplec_pages, :type
+    add_index :simplec_pages, :subdomain_id
+    add_index :simplec_pages, :parent_id
+    add_index :simplec_pages, :path
+    add_index :simplec_pages, [:subdomain_id, :path], unique: true
+
+    reversible do |dir|
+      dir.up {
+        execute "ALTER TABLE simplec_pages ALTER COLUMN fields SET DEFAULT '{}'::JSONB"
+      }
+    end
+
+  end
+end

data/db/migrate/20170809204511_create_simplec_subdomains.rb

@@ -0,0 +1,12 @@
+class CreateSimplecSubdomains < ActiveRecord::Migration[5.0]
+  def change
+    create_table :simplec_subdomains, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.string :name
+      t.string :default_layout
+
+      t.timestamps
+    end
+
+    add_index :simplec_subdomains, :name, unique: true
+  end
+end

data/db/migrate/20170809210304_create_simplec_embedded_images.rb

@@ -0,0 +1,15 @@
+class CreateSimplecEmbeddedImages < ActiveRecord::Migration[5.0]
+  def change
+    create_table :simplec_embedded_images, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.string :embeddable_type
+      t.integer :embeddable_id
+      t.string :asset_uid
+      t.string :asset_name
+
+      t.timestamps
+    end
+
+    add_index :simplec_embedded_images, [:embeddable_type, :embeddable_id],
+      name: 'simplec_embedded_images_type_id_index'
+  end
+end

data/lib/simplec/action_controller/extensions.rb

@@ -0,0 +1,56 @@
+module Simplec
+  module ActionController
+    module Extensions
+
+      def self.included(receiver)
+        receiver.helper_method :subdomain, :page,
+          :simplec_path, :simplec_url
+      end
+
+      def subdomain(name=nil)
+        name          ||= request.subdomain
+        @_subdomains  ||= Hash.new
+        return @_subdomains[name] if @_subdomains[name]
+        @_subdomains[name] = Subdomain.find_by!(name: name)
+      end
+
+      def page(path, options={})
+        @_page ||= Hash.new
+        return @_page[path] if @_page[path]
+
+        _subdomain = subdomain
+        _subdomain = Subdomain.find_by!(
+          name: options[:subdomain]
+        ) if options[:subdomain]
+
+        @_page[path] = _subdomain.pages.find_by!(path: path)
+      end
+
+      def simplec_path(page_or_path, options={})
+        # TODO cache page_paths
+        _page = page_or_path.is_a?(Page) ?
+          page_or_path : page(page_or_path, options)
+
+        unless _page
+          raise ActiveRecord::RecordNotFound if options[:raise]
+          return nil
+        end
+
+        _page.path
+      end
+
+      def simplec_url(page_or_path, options={})
+        # TODO cache page_urls
+        _page = page_or_path.is_a?(Page) ?
+          page_or_path : page(page_or_path, options)
+
+        unless _page
+          raise ActiveRecord::RecordNotFound if options[:raise]
+          return nil
+        end
+
+        URI.join(root_url(subdomain: _page.subdomain.try(:name)), _page.path).to_s
+      end
+    end
+  end
+end

data/lib/simplec/action_view/helper.rb

@@ -0,0 +1,118 @@
+module Simplec
+  module ActionView
+    module Helper
+
+      def head(page)
+        content_for :title, page.title
+        content_for :meta_description, page.meta_description
+      end
+
+      def title
+        content_for :title
+      end
+
+      def meta_description_tag
+        tag :meta, name: 'description', content: content_for(:meta_description)
+      end
+
+      def template(page)
+        _template = page.type.demodulize.downcase
+        render "pages/#{_template}"
+      end
+
+      def page_field(f, options={})
+        render "simplec/fields/#{options[:type]}", options.merge(f: f)
+      end
+
+      # Retreive a document.
+      #
+      # slug - matching a Document slug.
+      # options[:subdomain] - a string matching a Subdomain name, find a document
+      #                       from another subdomain
+      # options[:raise] - if true, casuse a 404 if document isn't found
+      #
+      # Example:
+      #
+      #   -# Save as...
+      #   <%= link_to doc('/permission/general').name,
+      #     doc('/permission/general').path,
+      #     download: true %>
+      #
+      #   -# Display in new window...
+      #   <%= link_to doc('/permission/general').name,
+      #     doc('/permission/general').path,
+      #     target: '_blank' %>
+      #
+      def doc(slug, options={})
+        @_docs ||= Hash.new
+        key = "[#{options[:subdomain]}][#{slug}]"
+        return @_docs[key] if @_docs[key]
+        @_docs[key] = subdomain(options[:subdomain]).
+          documents.find_by(slug: slug)
+        raise ActiveRecord::RecordNotFound if options[:raise] && !@_docs[key]
+        @_docs[key]
+      end
+
+      # Retreive a document.
+      #
+      # slug - matching a Document slug.
+      # options[:subdomain] - a string matching a Subdomain name, find a document
+      #                       set from another subdomain
+      # options[:raise] - if true, casuse a 404 if document set isn't found
+      #
+      # Example:
+      #
+      #   <% docset('/faith').each do |doc| %>
+      #     <%= link_to doc.name, doc.path %>
+      #   <% end %>
+      #
+      def docset(slug, options={})
+        @_docsets ||= Hash.new
+        key = "[#{options[:subdomain]}][#{slug}]"
+        return @_docsets[key] if @_docsets[key]
+        set = subdomain(options[:subdomain]).
+          document_sets.find_by(slug: slug)
+        raise ActiveRecord::RecordNotFound if options[:raise] && !set
+        @_docsets[key] = set.documents
+      end
+
+      # page_or_path - a page object or a path of a page
+      # options[:subdomain] - a string matching a Subdomain name, find a page
+      #                       from another subdomain
+      # options[:raise] - if true, casuse a 404 if a page set isn't found
+      #
+      # Example:
+      #
+      #   <% subpages('/give-volunteer', conditions: ->{ order(title: :asc) }).each do |page| %>
+      #     ... do something with page ...
+      #   <% end%>
+      def subpages(page_or_path, options={})
+        if options[:conditions] && !options[:conditions].respond_to?(:call)
+          raise ArgumentError, <<-ERROR
+          #{options[:conditions]} was passed as :conditions but is not callable.
+"Pass a callable instead: `conditions: -> { where(approved: true) }`
+          ERROR
+        end
+
+        @_subpages ||= Hash.new # TODO apply new conditions after cache
+        key = "[#{options[:subdomain]}][#{page_or_path}]"
+
+        unless @_subpages[key]
+          page = page_or_path.is_a?(Page) ? page_or_path : nil
+          page ||= subdomain(options[:subdomain]).pages.find_by(path: page_or_path)
+
+          unless page
+            raise ActiveRecord::RecordNotFound if options[:raise]
+            return @_subpages[key] = Array.new
+          end
+
+          @_subpages[key] = page.subpages
+        end
+
+        @_subpages[key].respond_to?(:merge) && options[:conditions] ?
+          @_subpages[key].merge(options[:conditions]) : @_subpages[key]
+      end
+    end
+
+  end
+end

data/lib/simplec/embedded_image_actions.rb

@@ -0,0 +1,37 @@
+module Simplec
+  module EmbeddedImageActions
+    module ClassMethods; end
+
+    module InstanceMethods
+
+			def create
+				@embedded_image = EmbeddedImage.new(embedded_image_params)
+				if @embedded_image.save
+					respond_to do |format|
+						format.json {
+							render :show, status: 201, location: @embedded_image.url
+						}
+					end
+				else
+					respond_to do |format|
+						format.json {
+							render status: 422, json: @embedded_image.errors
+						}
+					end
+				end
+			end
+
+			private
+
+			def embedded_image_params
+				params.permit(:asset_url, :asset_name)
+			end
+
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+end

data/lib/simplec/engine.rb

@@ -0,0 +1,18 @@
+require 'simplec/action_controller/extensions'
+require 'simplec/action_view/helper'
+
+module Simplec
+  class Engine < ::Rails::Engine
+    isolate_namespace Simplec
+
+    initializer "simplec_controller_extensions" do
+      ActiveSupport.on_load(:action_controller_base) {
+        prepend Simplec::ActionController::Extensions
+        helper Simplec::ActionView::Helper
+      }
+      ActiveSupport.on_load(:active_record) {
+        Dir["#{Rails.root}/app/models/page/*.rb"].each {|file| require_dependency file }
+      }
+    end
+  end
+end

data/lib/simplec/version.rb

@@ -0,0 +1,3 @@
+module Simplec
+  VERSION = '0.1.2'
+end

data/lib/simplec.rb

@@ -0,0 +1,5 @@
+require "simplec/engine"
+
+module Simplec
+  # TODO configuration options
+end

data/lib/tasks/simplec_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simplec do
+#   # Task goes here
+# end