doc_contract 0.1.0

data/app/helpers/doc_contract/application_helper.rb

@@ -0,0 +1,178 @@
+module DocContract
+  module ApplicationHelper
+    # Return active or nil based on the given route spec
+    #   %li{ class: active_class('users') # true if controller is users, false otherwise
+    #   %li{ class: active_class('pages#about') # true if controller is pages and action is about
+    #NOTE: Taken from the dunlop-core gem. That is the best maintained version
+    def active_class(*route_specs)
+      options = route_specs.extract_options!
+      return nil if Array.wrap(options[:except]).any?{|exception| current_route_spec?(exception) }
+      return 'active' if route_specs.any?{|rs| current_route_spec?(rs, options) }
+      nil
+    end
+
+    # Check if the current route matches the route given as argument.
+    # The syntax is meant to be a bit similar to specifying routes in
+    # `config/routes.rb`.
+    #   current_route_spec?('products') #=> true if controller name is products, false otherwise
+    #   current_route_spec?('products#show') #=> true if controller_name is products AND action_name is show
+    #   current_route_spec?('#show') #=> true if action_name is show, false otherwise
+    #NOTE: this helper is tested through the active_class helper
+    #NOTE: Taken from the dunlop-core gem. That is the best maintained version
+    def current_route_spec?(route_spec, options = {})
+      return route_spec.match([controller_path, action_name].join('#')) if route_spec.is_a?(Regexp)
+      controller, action = route_spec.split('#')
+      return action == params[:id] if controller_path == 'high_voltage/pages'
+      actual_controller_parts = controller_path.split('/')
+      if controller #and controller_path == controller
+        tested_controller_parts = controller.split('/')
+        return if tested_controller_parts.size > actual_controller_parts.size
+        if actual_controller_parts[0...tested_controller_parts.size] == tested_controller_parts
+          # controller spec matches
+          return true unless action
+          action_name == action
+        end
+      else
+        action_name == action
+      end
+    end
+
+    #NOTE: Taken from the dunlop-core gem. That is the best maintained version
+    def page_title(*args, &blk)
+      extra_content = capture(&blk) if blk.present?
+      if resource_title?(args)
+        @scope_model = args[1].is_a?(ActiveRecord::Base) ? args[1].class : args[1]
+        content = page_title_for_resource(args)
+      else
+        content = page_title_for_string(args)
+      end
+      content += extra_content if extra_content.present?
+      title_tag = content_tag(:h2, content, class: 'page-title ui header')
+      content_for :page_title, title_tag
+      title_tag
+    end
+
+    def resource_title?(args)
+      args.first.is_a?(Symbol) &&
+        (args[1].respond_to?(:model_name) || args[1].class.respond_to?(:model_name))
+    end
+
+    def page_title_for_string(args)
+      title = html_escape(args.first)
+      options = args.last.is_a?(Hash) ? args.last : {}
+      if back_options = options[:back]
+        url =
+          case back_options
+          when Array then polymorphic_path(back_options)
+          when true then :back
+          else back_options
+          end
+        if url
+          back_link = link_to content_tag(:i, nil, class: 'left arrow icon'), url, class: 'title-back-link'
+          title = back_link.safe_concat(title)
+        end
+      end
+      title
+    end
+
+    def page_title_for_resource(args)
+      options = args.extract_options!
+      model = args[1].respond_to?(:model_name) ? args[1] : args[1].class
+      if args.first == :index
+        title = t('action.index.label', models: model.model_name.human_plural).html_safe
+      else
+        title = t("action.#{args.first}.label", model: model.model_name.human).html_safe
+      end
+      if back_options = options[:back]
+        url =
+          case back_options
+          when Array then polymorphic_path(back_options)
+          when true then :back
+          else back_options
+          end
+        if url
+          back_link = link_to content_tag(:i, nil, class: 'left arrow icon'), url, class: 'title-back-link'
+          title = back_link.safe_concat(title)
+        end
+      end
+      title
+    end
+
+    def search_result_info(records)
+      from_item = (records.current_page - 1) * records.limit_value + 1
+      to_item = [from_item + records.size - 1, records.total_count].min
+      from_item = 0 if records.total_count.zero?
+      "#{from_item} - #{to_item} / #{records.total_count}"
+    end
+
+    def at(attribute_name, scope_model=nil)
+      scope_model ||= @scope_model
+      scope_model.human_attribute_name(attribute_name)
+    end
+
+    # Search helpers from dunlop
+    def search_row(options = {}, &blk)
+      classes = Array.wrap(options[:class])
+      classes |= ['search']
+      classes << 'conditions-present' if @q.conditions.present?
+      content = capture(&blk)
+      content_tag(:tr, content,  class: classes )
+    end
+
+    # This helper returns the link for showing a record inside a table
+    def table_show_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :show, record
+      end
+      link_to(content_tag(:i,nil, class: 'folder open icon'), path || record, class: 'table-link show ui mini basic primary icon button')
+    end
+
+    # This helper returns the link for showing a record inside a table
+    def table_download_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :download, record
+      end
+      link_to(content_tag(:i,nil, class: 'download icon'), path || [:download, record], class: 'table-link download ui mini violet icon button')
+    end
+
+    # This helper returns the link for editing a record inside a table
+    def table_edit_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :update, record
+      end
+      link_to(content_tag(:i, nil, class: 'write icon'), path || [:edit, record], class: 'table-link edit ui mini basic yellow icon button')
+    end
+
+    def table_destroy_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :destroy, record
+      end
+      confirm_text = "Are you sure you want to delete #{record.class.model_name.human}"
+      record_name = nil
+      record_name = record.presentation_name if record.respond_to?(:presentation_name)
+      record_name ||= record.name if record.respond_to?(:name)
+      record_name ||= record.title if record.respond_to?(:title)
+      confirm_text << " #{record_name}" if record_name.present?
+      confirm_text << "?"
+      link_to(content_tag(:i, nil, class: 'trash icon'), path || record, method: :delete, data: { confirm: confirm_text }, class: 'table-link destroy ui mini negative icon button')
+    end
+
+    # https://coderwall.com/p/7gqmog/display-flash-messages-with-semantic-ui-in-rails
+    def flash_class(level)
+      case level.to_sym
+      when :success       then "ui positive message"
+      when :error, :alert then "ui negative message"
+      when :notice        then "ui info message"
+      else "ui #{level} message"
+      end
+    end
+  end
+end

data/app/models/concerns/yaml_validator.rb

@@ -0,0 +1,9 @@
+class YamlValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.blank?
+    object = YAML.load(value) rescue nil
+    unless object
+      record.errors.add attribute, (options[:message] || "is not valid YAML")
+    end
+  end
+end

data/app/models/doc_contract/contract_instance.rb

@@ -0,0 +1,39 @@
+module DocContract
+  class ContractInstance < ApplicationRecord
+    validates :name, presence: true
+    belongs_to :contract_template
+
+    def config
+      own_config = YAML.load(config_yml.to_s) || {}
+      own_config.reverse_merge contract_template.config
+    end
+
+    def markdown
+      contract_template.markdown
+    end
+
+    def markdown=(value)
+      contract_template.markdown = value
+    end
+
+    def processed_markdown(config_addittions = {})
+      config = self.config
+      config.merge! config_addittions unless config_addittions.blank?
+      DocContract::Handlebars.compile(markdown, config)
+    end
+
+    def template_markdown(config_addittions = {})
+      config = self.config
+      config.merge! config_addittions unless config_addittions.blank?
+      result = DocContract::Handlebars.compile(markdown, config)
+      # prefix the markdown with the config (eisvogel pandoc)
+      "#{config.to_yaml}...\n\n"+result
+    end
+
+    def processed_html
+      result = processed_markdown.sub(/.*\n...\n\n/m, '')
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, tables: true)
+      markdown.render result
+    end
+  end
+end

data/app/models/doc_contract/contract_template.rb

@@ -0,0 +1,37 @@
+module DocContract
+  class ContractTemplate < ApplicationRecord
+    HANDLEBARS_REGEX = /{{((#)?[a-z\._ ]+)}}/
+    has_many :contract_instances, dependent: :delete_all
+
+    validates :name, presence: true
+    validates :config_yml, yaml: true
+
+    def config
+      YAML.load(config_yml.to_s) || {}
+    end
+
+    def processed_markdown(config_addittions = {})
+      config = self.config
+      config.merge! config_addittions unless config_addittions.blank?
+      DocContract::Handlebars.compile(markdown, config)
+    end
+
+    def template_markdown(config_addittions = {})
+      config = self.config
+      config.merge! config_addittions unless config_addittions.blank?
+      result = DocContract::Handlebars.compile(markdown, config)
+      # prefix the markdown with the config (eisvogel pandoc)
+      "#{config.to_yaml}...\n\n"+result
+    end
+
+    def processed_html
+      result = processed_markdown.sub(/.*\n...\n\n/m, '')
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, tables: true)
+      markdown.render result
+    end
+
+    def present_handlebars_expressions
+      markdown.scan(HANDLEBARS_REGEX).map(&:first).uniq
+    end
+  end
+end

data/app/views/doc_contract/application/_button-destroy-record.html.slim

@@ -0,0 +1 @@
+= link_to t('action.destroy.label', model: (record_class).model_name.human), record, class: 'ui red button', method: :delete, data: { confirm: t('general.are_you_sure') }

data/app/views/doc_contract/application/_button-edit-record.html.slim

@@ -0,0 +1 @@
+= link_to t('action.edit.label', model: (record_class).model_name.human), polymorphic_path(record, action: :edit), class: 'ui yellow button'

data/app/views/doc_contract/application/_button-new-record.html.slim

@@ -0,0 +1 @@
+= link_to t('action.new.label', model: (record_class).model_name.human), polymorphic_path(record_class, action: :new), class: 'ui primary basic button'

data/app/views/doc_contract/application/_button-preview-html.html.slim

@@ -0,0 +1,9 @@
+.ui.pink.button.preview-html data-target=polymorphic_path(record, action: :processed_html) Preview html
+#html-preview-modal.ui.overlay.fullscreen.modal
+  .header html preview handlebars interpreted
+  pre.scrolling.content
+    .ui.active.inline.loader
+  .actions
+    - unless params[:action] == 'edit'
+      = link_to t('Edit'), [record, action: :edit], class: 'ui yellow button'
+    .ui.cancel.button Close

data/app/views/doc_contract/application/_button-preview-markdown.html.slim

@@ -0,0 +1,9 @@
+.ui.pink.button.preview-markdown data-target=polymorphic_path(record, action: :processed_markdown) Preview markdown
+#markdown-preview-modal.ui.overlay.fullscreen.modal
+  .header Markdown preview handlebars interpreted
+  pre.scrolling.content
+    .ui.active.inline.loader
+  .actions
+    - unless params[:action] == 'edit'
+      = link_to t('Edit'), [record, action: :edit], class: 'ui yellow button'
+    .ui.cancel.button Close

data/app/views/doc_contract/application/_button-preview-pdf.html.slim

@@ -0,0 +1 @@
+= link_to 'PDF', polymorphic_path(@record, action: :get_pdf), class: 'ui button'

data/app/views/doc_contract/application/_definition_table_attribute_errors.html.slim

@@ -0,0 +1,7 @@
+- if errors = @record.errors[attribute].presence
+  .ui.visible.negative.message
+    .content
+      h3.header Errors found
+      ul
+        - errors.each do |error|
+          li= error

data/app/views/doc_contract/application/_messages.html.slim

@@ -0,0 +1,4 @@
+- flash.each do |key, value|
+  .closable.visible class=flash_class(key)
+    i.close.icon
+    = value

data/app/views/doc_contract/application/_navigation.html.slim

@@ -0,0 +1,18 @@
+.ui.inverted.menu.fixed
+  = link_to main_app.root_path, class: 'header item'
+    = Rails.application.config.doc_contract.link_home_content.to_s.html_safe
+  - if current_user.present?
+    = link_to DocContract::ContractTemplate.model_name.human_plural, [DocContract::ContractTemplate], class: ['item', active_class('doc_contract/contract_templates')]
+    = link_to DocContract::ContractInstance.model_name.human_plural, [DocContract::ContractInstance], class: ['item', active_class('doc_contract/contract_instances')]
+  .right.menu
+    - if current_user.present?
+      .ui.dropdown.item
+        span= current_user.respond_to?(:nickname) ? current_user.nickname : current_user.email
+        i.dropdown.icon
+        .menu
+          = link_to main_app.destroy_user_session_path, method: :delete, class: 'item'
+            i.sign.out.icon
+            span.text= t 'user.sign_out'
+    - else
+      = link_to t('devise.sessions.new.sign_in'), main_app.new_user_session_path, class: 'item'
+

data/app/views/doc_contract/application/main.html.slim

@@ -0,0 +1,6 @@
+.ui.two.item.menu
+  = link_to DocContract::ContractTemplate.model_name.human_plural, [DocContract::ContractTemplate], class: ['item', active_class('doc_contract/contract_templates')]
+  = link_to DocContract::ContractInstance.model_name.human_plural, [DocContract::ContractInstance], class: ['item', active_class('doc_contract/contract_instances')]
+- if Rails.application.config.doc_contract.show_readme_on_main_page
+  hr
+  #readme_container== readme_html

data/app/views/doc_contract/contract_instances/_form.html.slim

@@ -0,0 +1,25 @@
+/table.ui.attached.compact.definition.table
+= form_with model: @record, class: 'ui form' do |f|
+  table.ui.top.attached.compact.definition.table
+    tbody
+      tr
+        td= at :name
+        td: .ui.input= f.text_field :name
+      tr
+        td
+          = DocContract::ContractTemplate.model_name.human
+          = render 'definition_table_attribute_errors', attribute: :contract_template_id
+        td
+          = f.collection_select :contract_template_id, DocContract::ContractTemplate.all, :id, :name, class: 'ui input'
+      tr
+        td
+          = at :config_yml
+          = render 'definition_table_attribute_errors', attribute: :config_yml
+        td
+          = f.text_area :config_yml
+          #contract_config_yml_editor= raw @record.config_yml
+  .ui.bottom.attached.segment
+    = f.submit class: 'ui primary button'
+    - unless @record.new_record?
+      = render 'button-preview-markdown', record: @record
+      = render 'button-destroy-record', record: @record

data/app/views/doc_contract/contract_instances/edit.html.slim

@@ -0,0 +1,3 @@
+.ui.container
+  = page_title :edit, @record, back: @record
+  = render 'form'

data/app/views/doc_contract/contract_instances/index.html.slim

@@ -0,0 +1,34 @@
+.ui.container
+  = page_title :index, record_class
+  - if @records.any? or @q.conditions.present?
+    = search_form_for(@q, html: {class: 'ui form'}) do |f|
+      = hidden_field_tag :per_page, params[:per_page], id: 'q_per_page'
+      table.ui.compact.top.attached.striped.table
+        thead
+          tr
+            th= at :name
+            th= DocContract::ContractTemplate.model_name.human
+            th.column-filter.actions
+              = search_result_info @records
+          = search_row class: 'ui mini form' do
+            th= f.text_field :name_cont, placeholder: 'name contains'
+            th= f.text_field :contract_template_name_cont, placeholder: 'template contains'
+            th.column-filter.actions
+              button.ui.mini.primary.icon.button
+                i.filter.icon
+              = link_to polymorphic_path(record_class, reset_q: true), class: 'clear-filters-button ui mini basic yellow icon button' do
+                i.close.icon
+        tbody
+          - @records.each do |record|
+            tr
+              td= link_to record.name, record
+              td= link_to record.contract_template.name, record.contract_template
+              td.actions
+                = table_show_link record
+                = table_edit_link record
+    .ui.bottom.attached.segment
+      = render 'button-new-record'
+    = paginate @records
+  - else
+    p= t 'collection.empty', models: record_class.model_name.human_plural
+    = render 'button-new-record'

data/app/views/doc_contract/contract_instances/new.html.slim

@@ -0,0 +1,3 @@
+.ui.container
+  = page_title :new, record_class, back: [record_class]
+  = render 'form'

data/app/views/doc_contract/contract_instances/show.html.slim

@@ -0,0 +1,25 @@
+.ui.container
+  = page_title :show, @record, back: [record_class]
+  table.ui.top.attached.compact.definition.table
+    tbody
+      tr
+        td= at :name
+        td= @record.name
+      tr
+        td= DocContract::ContractTemplate.model_name.human
+        td= link_to @record.contract_template.name, @record.contract_template
+      tr
+        td= at :config_yml
+        td
+          pre=raw @record.config_yml
+      tr
+        td Markdown tags
+        td
+          ul
+            - @record.contract_template.markdown.scan(/{{{?((#[a-z]+ )?[a-z]+.[a-z]*)}?}}/).uniq.each do |founds|
+              li= founds[0]
+  .ui.bottom.attached.segment
+    = render 'button-preview-markdown', record: @record
+    /= render 'button-preview-html', record: @record
+    = render 'button-preview-pdf', record: @record
+    = render 'button-edit-record', record: @record

data/app/views/doc_contract/contract_templates/_form.html.slim

@@ -0,0 +1,34 @@
+/table.ui.attached.compact.definition.table
+= form_with model: @record, class: 'ui form' do |f|
+  table.ui.top.attached.compact.definition.table
+    tbody
+      tr
+        td.collapsing= at :name
+        td: .ui.input= f.text_field :name
+      tr
+        td.collapsing= at :latex_template
+        td: .ui.input= f.select :latex_template, %w[eisvogel]
+      tr
+        td.collapsing= at :titlepage_background
+        td= f.select :titlepage_background, (1..11), include_blank: ' -- '
+      tr
+        td.collapsing
+          = at :config_yml
+          = render 'definition_table_attribute_errors', attribute: :config_yml
+        td
+          = f.text_area :config_yml
+          #contract_config_yml_editor= raw @record.config_yml
+      tr
+        td.collapsing
+          = at :markdown
+          = render 'definition_table_attribute_errors', attribute: :markdown
+        td
+          = f.text_area :markdown
+          #contract_template_markdown_editor= raw @record.markdown
+          /textarea.hidden= @record.markdown
+  .ui.bottom.attached.segment
+    = f.submit class: 'ui primary button'
+    - unless @record.new_record?
+      = render 'button-preview-markdown', record: @record
+      = render 'button-preview-html', record: @record
+      = render 'button-destroy-record', record: @record

data/app/views/doc_contract/contract_templates/edit.html.slim

@@ -0,0 +1,3 @@
+.ui.container
+  = page_title :edit, @record, back: @record
+  = render 'form'

data/app/views/doc_contract/contract_templates/index.html.slim

@@ -0,0 +1,31 @@
+.ui.container
+  = page_title :index, record_class
+  - if @records.any? or @q.conditions.present?
+    = search_form_for(@q, html: {class: 'ui form'}) do |f|
+      = hidden_field_tag :per_page, params[:per_page], id: 'q_per_page'
+      table.ui.compact.top.attached.striped.table
+        thead
+          tr
+            th= at :name
+            th.column-filter.actions
+              = search_result_info @records
+          = search_row class: 'ui mini form' do
+            th= f.text_field :name_cont, placeholder: 'name contains'
+            th.column-filter.actions
+              button.ui.mini.primary.icon.button
+                i.filter.icon
+              = link_to polymorphic_path(record_class, reset_q: true), class: 'clear-filters-button ui mini basic yellow icon button' do
+                i.close.icon
+        tbody
+          - @records.each do |record|
+            tr
+              td= link_to record.name, record
+              td.actions
+                = table_show_link record
+                = table_edit_link record
+    .ui.bottom.attached.segment
+      = render 'button-new-record'
+    = paginate @records
+  - else
+    p= t 'collection.empty', models: record_class.model_name.human_plural
+    = render 'button-new-record'

data/app/views/doc_contract/contract_templates/new.html.slim

@@ -0,0 +1,3 @@
+.ui.container
+  = page_title :new, record_class, back: [record_class]
+  = render 'form'

data/app/views/doc_contract/contract_templates/show.html.slim

@@ -0,0 +1,28 @@
+.ui.container
+  = page_title :show, @record, back: [record_class]
+  table.ui.top.attached.compact.definition.table
+    tbody
+      tr
+        td= at :name
+        td= @record.name
+      tr
+        td= at :latex_template
+        td= @record.latex_template
+      tr
+        td= at :config_yml
+        td
+          pre=raw @record.config_yml
+      tr
+        td Markdown tags
+        td
+          ul
+            - @record.present_handlebars_expressions.each do |expression|
+              li= expression
+      tr
+        td Raw preview
+        td: .contract-markdown-show-container=raw @record.processed_html
+  .ui.bottom.attached.segment
+    = render 'button-preview-markdown', record: @record
+    /= render 'button-preview-html', record: @record
+    = render 'button-preview-pdf', record: @record
+    = render 'button-edit-record', record: @record

data/app/views/doc_contract/kaminari/_first_page.html.slim

@@ -0,0 +1,2 @@
+= link_to url, title: t('views.pagination.first').html_safe, class: 'item', remote: remote do
+  i.angle.double.left.icon

data/app/views/doc_contract/kaminari/_gap.html.slim

@@ -0,0 +1,2 @@
+.item
+  = t('views.pagination.truncate').html_safe

data/app/views/doc_contract/kaminari/_last_page.html.slim

@@ -0,0 +1,2 @@
+= link_to url, title: t('views.pagination.last').html_safe, class: 'item', remote: remote do
+  i.angle.double.right.icon

data/app/views/doc_contract/kaminari/_next_page.html.slim

@@ -0,0 +1,2 @@
+= link_to url, title: t('views.pagination.next').html_safe, class: 'item', remote: remote do
+  i.right.angle.icon

data/app/views/doc_contract/kaminari/_page.html.slim

@@ -0,0 +1,6 @@
+- if page.current?
+  = link_to url, title: page, class: 'item active', remote: remote do
+    = page
+- else
+  = link_to url, title: page, class: 'item', remote: remote do
+    = page

data/app/views/doc_contract/kaminari/_paginator.html.slim

@@ -0,0 +1,11 @@
+= paginator.render do
+  nav.ui.pagination.menu
+    == first_page_tag unless current_page.first?
+    == prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.left_outer? || page.right_outer? || page.inside_window?
+        == page_tag page
+      - elsif !page.was_truncated?
+        == gap_tag
+    == next_page_tag unless current_page.last?
+    == last_page_tag unless current_page.last?

data/app/views/doc_contract/kaminari/_prev_page.html.slim

@@ -0,0 +1,2 @@
+= link_to url, title: t('views.pagination.previous').html_safe, class: 'item', remote: remote do
+  i.left.angle.icon

data/app/views/layouts/doc_contract/application.html.slim

@@ -0,0 +1,23 @@
+doctype html
+html lang="en"
+  head
+    title= content_for?(:title) ? yield(:title) : 'DocContract Engine'
+    meta name="description" content="#{content_for?(:description) ? yield(:description) : 'Application'}"
+    = csrf_meta_tags
+    = csp_meta_tag
+
+    meta charset="utf-8"
+    meta content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0" name="viewport"
+
+    = stylesheet_link_tag    'doc_contract/application', media: 'all'
+    = javascript_include_tag 'doc_contract/application'
+    = content_for :head
+  body
+    header= render 'navigation'
+    /.environment-ribbon class=Rails.env
+      span= Rails.env
+    main role="main"
+      = render 'messages'
+      = yield
+    hr
+    p DocContract Engine

data/config/initializers/human_plural.rb

@@ -0,0 +1,16 @@
+module ActiveModel
+  class Name
+    def human_plural
+      # Try to find the plural name of a model. If none can be found try to find a non namespaced version and return that one
+      default = Proc.new do |path|
+        if path.present? and path['/'] # non namespaced model a/b/c => a
+          unnamespaced_path = path.sub(/\.(\w+)\/[\w\\]+/, '.\1')
+          I18n.t(unnamespaced_path, default: Proc.new{ human.pluralize })
+        else
+          human.pluralize
+        end
+      end
+      I18n.t("#{@klass.i18n_scope}.models.plural.#{i18n_key}", default: default )
+    end
+  end
+end