scribo 1.0.38

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fed1fcd709cca14b78b592dea59e90e7b9f5878fb1e68c91dbd3bf4e1f1f4c9e
+  data.tar.gz: b24bc25e2c1e55c0313fc284d8e62f9a59ffcc6712707848f7a296bbcc9be7a8
+SHA512:
+  metadata.gz: 4f2ade1bb9a68e21915299b22e3f571dfbc83774cd2cc906acea2829d7108eb0058e5f6f63c8bed2bf48fe702ea77b59e47591ea5d341406185fc6473fa82bc4
+  data.tar.gz: f5d01119bdf9aa97d19f0cfd116dbd43bcac04d150bde68742d554e541a2203defaafd6a165188d1ba710d8ebb285f17197f7b85d70aad77bc1428ffd5c6449b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Tom de Grunt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# Scribo
+
+A easy to use, embeddable CMS for Ruby on Rails.
+Scribo is designed to work with your models and can also render your content inside customer designed layouts.
+
+## Features
+
+Scribo is designed to be easy to use and we try to keep it as simple as possible.
+It's designed to have the least possible impact on your database, we only use two models/tables (Site and Content).
+It also makes no assumptions about your data models, it does come feature packed though:
+
+- Pages
+- Blog (with permalinks & categories)
+- Static assets
+- Data files (think: make a page based on an Excel sheet)
+- Layouts
+- [Liquid](http://liquidmarkup.org) templating
+- Mostly [Jekyll](https://jekyllrb.com) compatibile
+- Use of [YAML](https://yaml.org) in front-matter and configuration
+- Use of [Jekyll themes](https://jekyllrb.com/docs/themes/)
+
+## Documentation
+
+- [YAML](https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml) cheatsheet
+- Quick [YAML](https://learnxinyminutes.com/docs/yaml/) introduction
+
+## API
+
+The API uses token authorization, the token is obtained by making an sgid from the `scribable`.
+So for a `scribable` model `Account`, you could create it as follows:
+
+```ruby
+token = Account.first.to_sgid(for: 'scribo', expires_in: nil).to_s
+```
+
+This token can be used in the below request.
+
+### POST /api/sites/import
+
+This allows you to import a site (in ZIP format) using an API token.
+
+```shell
+curl -H 'Authorization: Token {token}' -X POST -F 'files[]=@site.zip' https://endpoint/api/sites/import
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scribo'
+```
+
+Migrate your database:
+
+```bash
+$ bin/rails db:migrate
+```
+
+Then add Scribo to your routes file.
+Scribo consumes all URLs, so make sure you put the following line at the bottom of your routes.rb.
+
+```ruby
+mount Scribo::Engine, at: '/'
+```
+
+## Using your controllers with scribo
+
+In your controller add the following:
+
+```ruby
+render(scribo: current_site, path: '/index', restricted: false, owner: Account.first)
+```
+
+This will look for `index` in the `current_site`.
+
+## Testing
+
+bin/rails db:drop
+bin/rails db:create
+bin/rails db:migrate
+
+The admin side of Scribo can be accessed here: https://localhost:3000/sites/
+Run `yarn watch` and you can develop using the above URL.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/entropydecelerator/scribo.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Scribo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test
+
+# Adds the Auxilium semver task
+spec = Gem::Specification.find_by_name 'auxilium'
+load "#{spec.gem_dir}/lib/tasks/semver.rake"
+

data/app/assets/config/scribo_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/scribo .js
+//= link_directory ../stylesheets/scribo .css

data/app/assets/javascripts/scribo/scribo.js

@@ -0,0 +1 @@
+../../../../frontend/dist/scribo.js

data/app/assets/stylesheets/scribo/scribo.css

@@ -0,0 +1 @@
+../../../../frontend/dist/scribo.css

data/app/controllers/concerns/maintenance_standards.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module MaintenanceStandards
+  # Informs the user and redirects when needed
+  #
+  # @param result [Boolean] was update or create succesful
+  # @param path [URL] where to redirect to
+  # @param notice [String] What to show on success
+  # @param error [String] What to show on error
+  # @param render_action [Symbol] What to render
+  #
+  def flash_and_redirect(result, path, notice, error, render_action = :edit)
+    if result
+      if params[:commit] == 'continue'
+        flash.now[:notice] = notice
+      else
+        redirect_to(path, notice: notice) && return
+      end
+    else
+      flash.now[:error] = error
+    end
+    render render_action
+  end
+end

data/app/controllers/scribo/admin/sites/contents_controller.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_admin_controller'
+
+module Scribo
+  module Admin
+    class Sites::ContentsController < ApplicationAdminController
+      before_action :set_objects
+
+      # Render the IDE
+      def index; end
+
+      def edit; end
+
+      def update
+        @content.update(content_params)
+        render :edit
+      end
+
+      def show
+        render :edit
+      end
+
+      def destroy
+        @content.destroy
+        head 200
+      end
+
+      def move
+        if params[:to]
+          new_parent = @site.contents.find(params[:to])
+          @content.update!(parent: new_parent)
+        else
+          @content.update!(parent_id: nil)
+        end
+      rescue
+        Signum.error(Current.user, text: t('.move_fail'))
+      end
+
+      def rename
+        @content.update(path: params[:to]) if params[:to]
+      end
+
+      def create
+        parent = params[:parent] ? @site.contents.find(params[:parent]) : nil
+        @content = @site.contents.create!(path: params[:path], kind: params[:kind], parent: parent)
+      rescue  
+        Signum.error(Current.user, text: t('.create_fail', kind: params[:kind]))
+      end
+
+      def upload
+        @parent = Scribo::Content.find(params[:content][:parent_id]) if params[:content][:parent_id]
+
+        params[:content][:files]&.each do |file|
+          content = @site.contents.create!(kind: Scribo::Utility.kind_for_path(file.original_filename),
+                                           path: file.original_filename, data_with_frontmatter: file.read)
+          content.update!(parent: @parent)  if @parent
+        rescue
+          Signum.error(Current.user, text:t('.upload_fail'))
+        end
+
+        @contents = @site.contents.roots.reorder(:path) # unless params[:content][:parent_id]
+      end
+
+      private
+
+      def set_objects
+        @site          = Scribo::Site.find(params[:site_id])
+        @content       = if params[:id]
+                           @site.contents.find(params[:id])
+                         else
+                           params[:content] ? @site.contents.new(content_params) : @site.contents.new
+                         end
+
+        @contents = @site.contents.roots.where(kind: 'folder').reorder(:path) + @site.contents.roots.where("kind <> 'folder'").reorder(:path)
+        @readme = @site.contents.roots.where("path ilike '%readme%'").first
+      end
+
+      def content_params
+        params.require(:content).permit(:data_with_frontmatter).tap do |whitelisted|
+          whitelisted[:data_with_frontmatter] = params[:content][:data_with_frontmatter].read.force_encoding('utf-8') if params[:content][:data_with_frontmatter].respond_to?(:read)
+        end
+      end
+    end
+  end
+end

data/app/controllers/scribo/admin/sites_controller.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_admin_controller'
+
+module Scribo
+  module Admin
+    class SitesController < ApplicationAdminController
+      before_action :set_objects, except: [:index]
+
+      def new
+        if params[:template_id]
+          url = Scribo.config.templates.find { |t| t[:id] == params[:template_id] }&.[](:url)
+          redirect_to(admin_sites_path) && return unless url
+
+          file = Down.download(url)
+          @site = Scribo::SiteImportService.new(file.path, scribable: Scribo.config.scribable_for_request(request)).call
+          redirect_to(admin_site_contents_path(@site))
+          nil
+        else
+          @site = Scribo::Site.create!(scribable: Scribo.config.scribable_for_request(request))
+          Scribo.config.after_site_create(@site)
+          redirect_to(admin_site_contents_path(@site))
+          nil
+        end
+      end
+
+      def create
+        flash_and_redirect @site.save, admin_site_contents_path(@site), 'Site created successfully',
+                           'There were problems creating the site'
+      end
+
+      def index
+        @sites = Site.adminable
+      end
+
+      def destroy
+        flash_and_redirect @site.destroy, admin_sites_url, 'Site deleted successfully',
+                           'There were problems deleting the site'
+      end
+
+      def import
+        @sites = Site.adminable
+        params[:files].each do |file|
+          Scribo::SiteImportService.new(file.path, scribable: Scribo.config.scribable_for_request(request)).call
+        end
+      end
+
+      def export
+        name, data = Scribo::SiteExportService.new(@site).call
+        send_data data, type: 'application/zip', filename: name
+      end
+
+      private
+
+      def set_objects
+        @sites = Site.adminable
+        @site = Site.adminable.find(params[:id]) if params[:id]
+      end
+    end
+  end
+end

data/app/controllers/scribo/api/sites_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_controller'
+module Scribo
+  module Api
+    class SitesController < ApplicationController
+      skip_before_action :verify_authenticity_token
+
+      def import
+        sgid = request.authorization&.split&.last
+        head(400) && return unless sgid
+
+        scribable = ::GlobalID::Locator.locate_signed(sgid, for: 'scribo')
+
+        head(401) && return unless scribable
+
+        params[:files].each do |file|
+          Scribo::SiteImportService.new(file.path, scribable: scribable).call
+        end
+      end
+    end
+  end
+end

data/app/controllers/scribo/application_admin_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_controller'
+require_dependency 'concerns/maintenance_standards'
+
+module Scribo
+  class ApplicationAdminController < ApplicationController
+    include MaintenanceStandards
+    include Scribo.config.admin_authentication_module.constantize if Scribo.config.admin_authentication_module
+  end
+end

data/app/controllers/scribo/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Scribo
+  class ApplicationController < Scribo.config.base_controller.constantize
+  end
+end

data/app/controllers/scribo/contents_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_controller'
+require_dependency 'scribo/action_dispatch/request_drop'
+
+module Scribo
+  class ContentsController < ApplicationController
+    protect_from_forgery except: :show
+
+    def show
+      render scribo: request
+    rescue StandardError => e
+      Scribo.config.logger.error '-' * 80
+      Scribo.config.logger.error '=> Content rendering errors: ' + e.message
+      Scribo.config.logger.error '=> ' + e.backtrace.map(&:to_s).join("\n")
+      Scribo.config.logger.error '-' * 80
+      render body: e.message, status: 500
+    end
+  end
+end

data/app/drops/scribo/action_dispatch/request_drop.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../application_drop'
+
+module Scribo
+  module ActionDispatch
+    class RequestDrop < ::Scribo::ApplicationDrop
+      delegate :fullpath, :host, :scheme, :ip, :media_type, :query_parameters, :uuid, :request_method, to: :@object
+
+      def headers
+        @object.headers.to_h
+      end
+    end
+  end
+end

data/app/drops/scribo/active_model/errors_drop.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Scribo
+  module ActiveModel
+    class ErrorsDrop < Liquid::Drop
+      def initialize(object)
+        @object = object
+      end
+      delegate :base, :details, to: :@object
+
+      def messages
+        @object.messages.stringify_keys
+      end
+    end
+  end
+end

data/app/drops/scribo/application_drop.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Scribo
+  class ApplicationDrop < Liquid::Drop
+    def initialize(object)
+      @object = object
+    end
+  end
+end

data/app/drops/scribo/array_drop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_drop'
+
+module Scribo
+  class ArrayDrop < ApplicationDrop
+    delegate :each, :map, :size, :length, :first, :last, :empty?, :join, to: :@object
+
+    def ==(other)
+      @object.include?(other) || @object == other
+    end
+  end
+end

data/app/drops/scribo/content_drop.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_drop'
+
+module Scribo
+  # https://jekyllrb.com/docs/variables/#page-variables
+  class ContentDrop < ApplicationDrop
+    delegate :url, :path, :excerpt, :categories, :tags, :dir, to: :@object
+    delegate :site, to: :@object
+
+    def initialize(object)
+      @object = object
+      @properties = object.properties
+    end
+
+    def date
+      @object.date
+    end
+
+    def id
+      @object.full_path
+    end
+
+    # FIXME: This breaks when the collection_path is set (https://jekyllrb.com/docs/collections/#setup)
+    def collection
+      base_dir = @object.dir.split('/').first.gsub('_', '')
+      base_dir if @object.site.collections.include?(base_dir)
+    end
+
+    # Find out how to merge properties with this drop
+    def name
+      @properties&.[]('name') || @object.path
+    end
+
+    def layout
+      @object.layout_name
+    end
+
+    def next
+      @object.right_sibling
+    end
+
+    def previous
+      @object.left_sibling
+    end
+
+    def content
+      Scribo::ContentRenderService.new(@object, @context.registers['controller'], {}).call
+    end
+
+    def [](property)
+      if respond_to?(property)
+        send(property)
+      elsif @properties.present?
+        @properties[property]
+      end
+    end
+
+    def categories
+      Scribo::ArrayDrop.new(@properties&.[]('categories'))
+    end
+
+    def tags
+      Scribo::ArrayDrop.new(@properties&.[]('tags'))
+    end
+
+    def liquid_method_missing(method)
+      return nil unless @properties
+
+      @properties[method.to_s]
+    end
+  end
+end

data/app/drops/scribo/data_drop.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_dependency 'scribo/application_drop'
+require 'csv'
+
+module Scribo
+  class DataDrop < ApplicationDrop
+    attr_accessor :data_path
+
+    def initialize(object, data_path = [])
+      @object = object
+      @data_path = data_path
+    end
+
+    def [](name)
+      method_missing(name)
+    end
+
+    def method_missing(method)
+      content = @object.contents.data((data_path + [method.to_s]).join('/')).first
+
+      return Scribo::DataDrop.new(@object, data_path + [content.path]) if content&.kind == 'folder'
+
+      case content&.content_type
+      when 'text/x-yaml'
+        Scribo::Utility.yaml_safe_parse(content.data)
+      when 'application/json'
+        ::JSON.parse(content.data)
+      when 'text/csv'
+        CSV.parse(content.data, headers: true, liberal_parsing: true, quote_char: '"', col_sep: ';',
+                                row_sep: "\r\n").map(&:to_h)
+      end
+    end
+  end
+end

data/app/drops/scribo/form_drop.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Scribo
+  class FormDrop < Liquid::Drop
+    def initialize(model, attribute = nil)
+      @model     = model
+      @attribute = attribute
+    end
+
+    attr_reader :model, :attribute
+
+    def class_name
+      model.class.name.gsub(/Drop$/, '')
+    end
+
+    def errors
+      errors = if @model&.instance_variable_get('@object')
+                 @model.instance_variable_get('@object').errors
+               else
+                 ::ActiveModel::Errors.new([])
+               end
+
+      ::Scribo::ActiveModel::ErrorsDrop.new errors
+    end
+  end
+end

data/app/drops/scribo/include_drop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Scribo
+  class IncludeDrop < Liquid::Drop
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def liquid_method_missing(method)
+      @attributes[method.to_s]
+    end
+  end
+end