tolaria 1.0.0

data/lib/tolaria/managed_class.rb

@@ -0,0 +1,90 @@
+# This class wraps an ActiveRecord::Base descendant
+# and stores information that Tolaria needs to track about it
+
+module Tolaria
+  class ManagedClass
+
+    # The ActiveRecord::Base model we’re managing
+    attr_accessor :klass
+
+    # The navigation category and order to use for this resource
+    attr_accessor :category
+
+    # Items are sorted with lowest priority first in the menu
+    attr_accessor :priority
+
+    # The FontAwesome icon to use for this resource
+    attr_accessor :icon
+
+    # An array of options to pass to `params.permit` for this model
+    attr_accessor :permitted_params
+
+    # The default sort order for this resource
+    attr_accessor :default_order
+
+    # Enable or disable automatic pagination for this model.
+    attr_accessor :paginated
+
+    # An auto-generated controller name for this resource in the Admin namespace
+    attr_accessor :controller_name
+
+    # An array of the route actions allowed on this resource.
+    # Tolaria will pass this array as the `only:` option to the router
+    attr_accessor :allowed_actions
+
+    # A stored symbol for the `params.permit` key for this resource
+    attr_accessor :param_key
+
+    # A factory method that registers a new model in Tolaria and configures
+    # its menu and param settings. Developers should use `ActiveRecord::Base.manage_with_tolaria`
+    def self.create(klass, icon:"file-o", permit_params:[], priority:10, category:"Settings", default_order:"id DESC", paginated:true, allowed_actions:%i[index show new create edit update destroy])
+
+      managed_class = self.new
+      managed_class.klass = klass
+
+      # Assign the passed in setting
+      managed_class.icon = icon.to_s.freeze
+      managed_class.priority = priority.to_i
+      managed_class.category = category.to_s.freeze
+      managed_class.default_order = default_order.to_s.freeze
+      managed_class.paginated = paginated.present?
+      managed_class.permitted_params = permit_params.freeze
+      managed_class.allowed_actions = allowed_actions.freeze
+
+      # Set auto-generated attributes
+      managed_class.controller_name = "#{managed_class.model_name.name.pluralize}Controller".freeze
+      managed_class.param_key = managed_class.model_name.singular.to_sym
+
+      return managed_class
+
+    end
+
+    # True if the given symbol is in the managed class's allowed_actions array.
+    def allows?(action)
+      self.allowed_actions.include?(action)
+    end
+
+    # True if this managed class should be paginated
+    def paginated?
+      self.paginated
+    end
+
+    # True if there are no resources in the database for this class
+    def no_resources?
+      self.klass.count.eql?(0)
+    end
+
+    # Defer to the ActiveRecord::Base model_name system for producing
+    # pleasant user-interface names for this resource
+    def model_name
+      self.klass.model_name
+    end
+
+    # Delegate model_name methods to model_name
+    delegate :route_key, to: :model_name
+    delegate :singular, to: :model_name
+    delegate :singular_route_key, to: :model_name
+    delegate :plural, to: :model_name
+
+  end
+end

data/lib/tolaria/markdown.rb

@@ -0,0 +1,28 @@
+module Tolaria
+
+  # A class to contain a workflow for rendering Markdown.
+  # If no renderer has been configured, defer to simple_format.
+  class MarkdownRendererProxy
+
+    include ::ActionView::Helpers::TextHelper
+
+    # Calls the configured Markdown renderer, if none exists
+    # then uses simple_format to return more than nothing.
+    def render(document)
+      if Tolaria.config.markdown_renderer.nil?
+        return simple_format(document)
+      else
+        @markdown_renderer ||= Tolaria.config.markdown_renderer.constantize
+        return @markdown_renderer.render(document)
+      end
+    end
+
+  end
+
+  # Calls the configured Markdown renderer
+  def self.render_markdown(document)
+    @markdown_renderer ||= Tolaria::MarkdownRendererProxy.new
+    return @markdown_renderer.render(document)
+  end
+
+end

data/lib/tolaria/random_tokens.rb

@@ -0,0 +1,16 @@
+module Tolaria
+  module RandomTokens
+
+    # Returns a 32-character random, alphanumeric string suitable for stronger
+    # tokens use like cookies and API keys
+    def self.auth_token
+      SecureRandom.base64(32).delete("+/=")[0..31]
+    end
+
+    # Returns a six-digit numeric code suitable for use as a one-time passphrase
+    def self.passcode
+      "%06d" % SecureRandom.random_number(1_000_000)
+    end
+
+  end
+end

data/lib/tolaria/reload.rb

@@ -0,0 +1,21 @@
+module Tolaria
+
+  # To provide admin pane development magic, Tolaria has this method
+  # to force Rails to autoload/reload all model files.
+  def self.reload!
+
+    # Re/Initalize HelpLinks
+    self.initialize_help_links!
+
+    # Manage the models included with the engine
+    Administrator.generate_tolaria_bindings!
+
+    # Reference each ActiveRecord::Base model so Rails autoloads it or
+    # reloads changed files. Call generate_tolaria_bindings! on them.
+    Dir["#{Rails.root}/app/models/*.rb"].each do |file|
+      File.basename(file, ".rb").camelize.safe_constantize.try(:generate_tolaria_bindings!)
+    end
+
+  end
+
+end

data/lib/tolaria/routes.rb

@@ -0,0 +1,33 @@
+module Tolaria
+
+  # The developer calls `Tolaria.draw_routes(self)` inside the
+  # router’s scope. Tolaria automatically adds routes for managed classes.
+  def self.draw_routes(router)
+
+    self.reload!
+
+    router.instance_exec(managed_classes) do |managed_classes|
+      namespace :admin do
+
+        # Create routes for AdminController
+        root to:"admin#root", as:"root"
+        get "help/:slug", to:"admin#help_link", as:"help_link"
+        post "api/markdown", to:"admin#markdown"
+
+        # Create routes for the authentication/passcode flow
+        get "signin", to:"sessions#new", as:"new_session"
+        post "signin/code", to:"sessions#request_code"
+        post "signin", to:"sessions#create"
+        delete "signout", to:"sessions#destroy", as:"destroy_session"
+
+        # Create routes for every managed class
+        managed_classes.each do |managed_class|
+          resources managed_class.plural, only:managed_class.allowed_actions
+        end
+
+      end
+    end
+
+  end
+
+end

data/lib/tolaria/version.rb

@@ -0,0 +1,13 @@
+module Tolaria
+
+  # Returns Tolaria’s version number
+  def self.version
+    Gem::Version.new("1.0.0")
+  end
+
+  module VERSION
+    MAJOR, MINOR, TINY, PRE = Tolaria.version.segments
+    STRING = Tolaria.version.to_s
+  end
+
+end

data/test/demo/Rakefile

@@ -0,0 +1,4 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require File.expand_path("../config/application", __FILE__)
+Rails.application.load_tasks

data/test/demo/app/assets/javascripts/application.js

@@ -0,0 +1 @@
+// Empty on purpose

data/test/demo/app/assets/stylesheets/application.scss

@@ -0,0 +1 @@
+// Empty on purpose

data/test/demo/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/demo/app/controllers/homepage_controller.rb

@@ -0,0 +1,4 @@
+class HomepageController < ApplicationController
+  def homepage
+  end
+end

data/test/demo/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/demo/app/models/blog_post.rb

@@ -0,0 +1,43 @@
+class BlogPost < ActiveRecord::Base
+
+  has_and_belongs_to_many :topics, join_table:"blog_post_topics"
+  has_many :footnotes
+  accepts_nested_attributes_for :footnotes, allow_destroy: true
+
+  validates_presence_of :title
+  validates_presence_of :summary
+  validates_presence_of :published_at
+  validates_presence_of :body
+
+  manage_with_tolaria using: {
+    icon: "pencil-square-o",
+    priority: 1,
+    default_order: "id DESC",
+    category: "Prose",
+    paginated: true,
+    permit_params: [
+      :title,
+      :summary,
+      :body,
+      :published_at,
+      :color,
+      :portrait,
+      :attachment,
+      topic_ids: [],
+      footnotes_attributes: [
+        :_destroy,
+        :id,
+        :url,
+        :description,
+      ]
+    ],
+  }
+
+  after_initialize :initalize_published_at!
+  def initalize_published_at!
+    self.published_at ||= Time.current
+  rescue ActiveModel::MissingAttributeError
+    # Swallow this exception
+  end
+
+end

data/test/demo/app/models/footnote.rb

@@ -0,0 +1,5 @@
+class Footnote < ActiveRecord::Base
+  belongs_to :blog_post
+  validates_presence_of :description
+  validates_presence_of :url
+end

data/test/demo/app/models/image.rb

@@ -0,0 +1,19 @@
+class Image < ActiveRecord::Base
+
+  validates_presence_of :title
+  validates_presence_of :attachment_address
+
+  manage_with_tolaria using: {
+    icon: :image,
+    priority: 1,
+    category: "Media",
+    permit_params: [
+      :title,
+      :alternate_text,
+      :credit,
+      :keywords,
+      :attachment_address,
+    ],
+  }
+
+end

data/test/demo/app/models/legal_page.rb

@@ -0,0 +1,24 @@
+class LegalPage < ActiveRecord::Base
+
+  validates_presence_of :title
+  validates_presence_of :summary
+  validates_presence_of :slug
+
+  manage_with_tolaria using: {
+    icon: "gavel",
+    priority: 100,
+    category: "Prose",
+    permit_params: [
+      :title,
+      :slug,
+      :summary,
+      :body
+    ],
+  }
+
+  before_validation :set_slug!
+  def set_slug!
+    self.slug = self.slug.parameterize if self.slug.present?
+  end
+
+end

data/test/demo/app/models/miscellany.rb

@@ -0,0 +1,12 @@
+class Miscellany < ActiveRecord::Base
+
+  manage_with_tolaria using:{
+    icon: "cogs",
+    category: "Settings",
+    allowed_actions: [:index, :show, :edit],
+    permit_params: [
+      :value
+    ],
+  }
+
+end

data/test/demo/app/models/topic.rb

@@ -0,0 +1,22 @@
+class Topic < ActiveRecord::Base
+
+  has_and_belongs_to_many :blog_posts, join_table:"blog_post_topics"
+
+  validates_presence_of :label
+  validates_presence_of :slug
+
+  before_validation :set_slug!
+  def set_slug!
+    self.slug = self.label.parameterize if self.label.present?
+  end
+
+  manage_with_tolaria using:{
+    icon: :leaf,
+    category: "Prose",
+    permit_params: [
+      :label,
+      :slug,
+    ],
+  }
+
+end

data/test/demo/app/models/video.rb

@@ -0,0 +1,16 @@
+class Video < ActiveRecord::Base
+
+  validates_presence_of :title
+  validates_presence_of :youtube_id
+
+  manage_with_tolaria using:{
+    icon: "youtube-play",
+    category: "Media",
+    permit_params: [
+      :title,
+      :yotube_id,
+      :description,
+    ],
+  }
+
+end

data/test/demo/app/views/admin/blog_posts/_form.html.erb

@@ -0,0 +1,48 @@
+<%= f.label :title, "Post Title" %>
+<%= f.slug_field :title, placeholder:"Post title", pattern:"/blog/255-*" %>
+<%= f.hint "The title of this post. The title is featured prominently across the site and used to construct the page URL. A good title is both summarizing and enticing, much like a newspaper headline." %>
+
+<%= f.label :published_at, "Publishing Date" %>
+<%= f.timestamp_field :published_at %>
+<%= f.hint %{
+  The date this post should be published.
+  Published posts with a date set in the future will be scheduled to appear on that date.
+} %>
+
+<%= f.label :title, "Topics" %>
+<%= f.searchable_select :topic_ids, Topic.order("label ASC"), :id, :label, multiple:true, placeholder:"Select topics" %>
+<%= f.hint "Chose some topics for this blog post" %>
+
+<%= f.label :color, "Background Color" %>
+<%= f.swatch_field :color, placeholder:"#CC0000" %>
+<%= f.hint "Choose a background color for this campaign" %>
+
+<%= f.label :summary %>
+<%= f.text_area :summary, rows:3, placeholder:"Summary for search engines and social media" %>
+<%= f.hint "Summarize this post in less than 300 characters. The summary is used for blog listings and the SEO/social metadata for the page." %>
+
+<%= f.label :portrait, "Portrait" %>
+<%= f.image_field :portrait, preview_url:"http://f.cl.ly/items/0H2g1v100l470l2c381A/slack-imgs.com.jpeg" %>
+<%= f.hint "Attach a portrait of this author, at least 600×600 pixels in size. The subject should be centered." %>
+
+<%= f.label :attachment, "File Download" %>
+<%= f.attachment_field :attachment %>
+<%= f.hint "Attach a portrait of this author, at least 600×600 pixels in size. The subject should be centered." %>
+
+<%= f.label :body, "Body" %>
+<%= f.markdown_composer :body %>
+<%= f.hint "The body of this post. You can use Markdown!" %>
+
+<%= f.has_many :footnotes do |ff| %>
+
+  <%= ff.has_many_header allow_destroy:true %>
+
+  <%= ff.label :description %>
+  <%= ff.text_field :description %>
+  <%= ff.hint "The name or other description of this reference" %>
+
+  <%= ff.label :url, "URL" %>
+  <%= ff.text_field :url, class:"monospace" %>
+  <%= ff.hint "A full URL to the source or reference material" %>
+
+<% end %>