doc_contract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5eb3ce664185e17d8c932c25bce2b271961673dbf91cc8bdc468c362f821981a
+  data.tar.gz: 9bb96322248d535055d6b5f7ad257388b6d2ef3ce41dd0057600fcc49545e5ee
+SHA512:
+  metadata.gz: 1be23ad090e9720299542b7fd16242c1aa2b3c4965535773ac166bd5de9fa65d97a2bd717df25667e6c7f185b50cb1d369b690721bce3e3ef91a4236a56a6441
+  data.tar.gz: d61685f08d14746fc7125932de2fe348e1e8403cc30a8705daf4916ee4dedab49c1bb074ba4fef586f4217b494697de91e4d87938b9ed77a0e63d39261b86ba7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Benjamin ter Kuile
+
+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,191 @@
+# DocContract
+DocContract is a `rails` `engine` that is an application wrapper around the https://pandoc.org/
+pdf creation library.
+
+The objective is to create and maintain contracts for customers as easy as possible
+and thereby removing redundancy, which gives reason to errors and to create for
+example a maintenance contract for a new year by just setting the `yaml` configuration to:
+```yaml
+year: 2022
+```
+
+![Scheme](/spec/dummy/public/DocContract-scheme.png)
+
+The structure of contract maintenance is that you create a contract template for a customer,
+for example a maintenance contract by creating a configuration (`yaml`) and a `markdown`
+formatted contract. The markdown is then [handlebars](https://handlebarsjs.com/guide/expressions.html)
+processed to prevent search/replace, summation and redundancy errors.
+
+Then the [LaTeX](https://www.latex-project.org/) based [pandoc](https://pandoc.org/) system using the [eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template)
+template is further used to convert the readable `markdown` to a nicely formatted PDF contract.
+
+This `engine` is inpired by the [walle/gimli](https://github.com/walle/gimli)
+gem but was no longer viable due to lack of maintenance and apparently a better renderer 
+that is [pandoc](https://pandoc.org/)
+
+## Usage
+Create a contract template consisting of a configuration `yaml` and a `markdown` formatted
+contract. The `yaml` might look like:
+
+```yaml
+titlepage:          true
+title:              Maintenance contract {{customer}} {{year}}
+subtitle:           To the future and beyond!
+date:               2022-01-24
+year:               2021
+full_customer_name: E-corp located in Gotham City
+customer:           E-corp
+contractor:         Path-E-Tech Management
+full_contractor_name: Path-E-Tech Management L.L.C. located in Gotham City
+production_url:     https://contracts.path-e-tech.com
+staging_url:        https://contracts-staging.path-e-tech.com
+support_email:      support@path-e-tech.com
+author:             Dullbert
+header-left:        "{{title}}"
+header-right:       "{{contractor}}"
+footer-left:        "{{customer}} | {{today}}"
+toc:                true
+toc-own-page:       true
+numbersections:     true
+footer-right:       '\thepage\ of \pageref{LastPage}'
+geometry:           margin=2.5cm
+urlcolor:           blue
+header-includes:    '\usepackage{lastpage}'
+offer_items:
+  - label: Maintenance of the platform infrastructure
+    amount: 2_000
+  - label: Maintenance of the application API
+    amount: 2_000
+  - label: Do migrations for the Infrastructure adapter
+    amount: 2_500
+```
+
+And a basic markdown:
+
+```markdown
+# Introduction
+
+## Client
+
+This maintenance contract is requested by:
+{{full_customer_name}}, hereafter {{customer}},
+
+And created by:
+{{full_contractor_name}}, hereafter {{contractor}}.
+
+
+## Behest
+contract stuff
+
+\newpage
+# Quote breakdown
+
+## Fixed costs
+
+Subject                     | Cost/y
+---                         | ---:
+{{#each offer_items}}{{this.label}} | {{euro this.amount}}
+{{/each}}**Total** | **{{euro offer_items_total}}**
+
+The total costs for {{year}} for {{to_sentence (map offer_items 'label')}} will thereby be {{to_words offer_items_total}} ({{euro offer_items_total}}). All the amounts include
+a VAT of 21%.
+
+## Variable costs
+And more contract stuff
+```
+
+## Installation
+
+### Install the system dependencies
+The largest dependency is the [LaTeX](https://www.latex-project.org/) installation:
+```bash
+$ sudo apt-get install texlive-full
+$ sudo apt-get install pandoc
+```
+*NOTE*: For trimmed down version of `texlive-full` do trial and error or check docs
+
+Or for mac:
+```bash
+$ brew install mactex
+$ brew install pandoc
+```
+
+And to be able to use the `pandoc-latex-environment`
+also install that one:
+```bash
+$ pip install pandoc-latex-environment
+```
+
+### Add the engine to your `rails` app
+Add this line to your application's Gemfile:
+
+```ruby
+gem "doc_contract"
+```
+
+And then execute:
+```bash
+$ bundle
+$ bundle exec rails db:migrate
+```
+
+### Mount the engine to your routes
+In your `config/routes.rb` file add:
+```ruby
+  mount DocContract::Engine => '/doc-contract'
+```
+
+### Add the authorizations
+In your `app/models/ability.rb` file add the authorizations.
+This is a custom operation that you have to adjust to your needs.
+To allow all users full controll to the contracts add:
+```ruby
+    can :manage, DocContract::ContractTemplate
+    can :manage, DocContract::ContractInstance
+```
+
+If the `Ability` file does not yet exist, generate it using:
+```bash
+rails generate cancan:ability
+```
+
+### Other languages (i18n)
+To use for a lets say Spanish based website add [rails-i18n](https://github.com/svenfuchs/rails-i18n) to your `Gemfile`
+
+```ruby
+gem 'rails-i18n'
+```
+
+And configure your application in `config/application.rb` to handle the languages:
+
+```ruby
+  config.i18n.available_locales = %i[en es]
+  config.i18n.default_locale = :en
+```
+
+## Customization
+
+### The main page
+The main page of this engine is a bit of a placeholder page. The contents of this page can be found in [app/views/doc\_contract/application/main.html.slim](app/views/doc\_contract/application/main.html.slim).
+To put your own version of this page create a view having this path in the main application. To only deactivate the README content there
+put the following in your `config/application.rb` file:
+
+```ruby
+  config.doc_contract.show_readme_on_main_page = false
+```
+
+### The link home content
+The default value for `config/application.rb` is:
+
+```ruby
+  config.doc_contract.link_home_content = '<i class="arrow left icon"></i> Back'
+```
+To change for example the icon, see the options at the [fomantic-ui](https://fomantic-ui.com/elements/icon.html) site.
+
+### Screenshot
+![Edit template scnreenshot](/spec/dummy/public/DocContract-template-edit.png)
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/doc_contract_manifest.js

@@ -0,0 +1,3 @@
+//= link 'doc_contract/application.css'
+//= link 'doc_contract/application.js'
+//= link 'doc_contract/pandoc.css'

data/app/assets/javascripts/doc_contract/application.coffee

@@ -0,0 +1,68 @@
+#= require jquery
+#= require jquery_ujs
+#= require semantic-ui
+#= require ace-rails-ap
+
+latex_template_infos =
+  eisvogel: '
+    Look at: 
+      <a href="https://github.com/Wandmalfarbe/pandoc-latex-template" target="_blank">
+        https://github.com/Wandmalfarbe/pandoc-latex-template
+      </a>'
+$ ->
+  $('.ui.dropdown').dropdown() # assume fomantic that has the clearable class option, a lot better than the below custom code
+
+  $('.preview-markdown').click ->
+    markdown = $('#contract_template_markdown').val()
+    target = $(@).data('target')
+    modal = $('#markdown-preview-modal')
+    modal.modal 'show'
+    $.post target, {markdown: markdown}, (response) ->
+      content = modal.find('.content')
+      content.html response.markdown
+      false
+  $('.preview-html').click ->
+    markdown = $('#contract_template_markdown').val()
+    target = $(@).data('target')
+    modal = $('#html-preview-modal')
+    modal.modal 'show'
+    $.post target, {markdown: markdown}, (response) ->
+      content = modal.find('.content')
+      content.html response.html
+      false
+
+  latex_template = $('select#contract_template_latex_template')
+  latex_template.change ->
+    el = $(@)
+    $('.contract_template_latex_template_info').remove()
+    if info_html = latex_template_infos[el.val()]
+      info = $('<button><i class="info icon"></button>').addClass('contract_template_latex_template_info circular ui olive icon button')
+      info.popup
+        html: info_html
+        hoverable: true
+      el.after info
+  latex_template.change() if latex_template.length
+
+  contract_config_yml = $('#contract_template_config_yml,#contract_instance_config_yml')
+  if contract_config_yml.length
+    config_yml_editor = ace.edit 'contract_config_yml_editor',
+      mode: 'ace/mode/yaml'
+      theme: 'ace/theme/monokai'
+      value: contract_config_yml.val()
+      tabSize: 2
+      useSoftTabs: true
+    config_yml_editor.getSession().on 'change', (something, session) ->
+      contract_config_yml.val session.getValue()
+      false
+    contract_config_yml.hide()
+
+  contract_markdown = $('#contract_template_markdown')
+  if contract_markdown.length
+    markdown_editor = ace.edit 'contract_template_markdown_editor',
+      mode: 'ace/mode/markdown'
+      theme: 'ace/theme/monokai'
+      value: contract_markdown.val()
+    markdown_editor.getSession().on 'change', (something, session) ->
+      contract_markdown.val session.getValue()
+      false
+    contract_markdown.hide()

data/app/assets/stylesheets/doc_contract/application.sass

@@ -0,0 +1,52 @@
+@import "semantic-ui"
+main
+  min-height: calc(100% - 57px - 1rem) // 34px for footer inclusion
+  padding-top: 40px
+  > .page-title
+    padding-top: 12px
+  > .container .page-title
+    padding-top: 12px
+
+#contract_template_markdown_editor, #contract_config_yml_editor
+  //position: absolute
+  width: 100%
+  height: 600px
+
+#readme_container
+  pre
+    max-height: 500px
+    overflow: auto
+    margin: 10px
+    border: 1px solid #777
+.contract-markdown-show-container
+  @import "./pandoc"
+.contract-markdown-show-container
+  max-height: 600px
+  overflow-y: scroll
+
+pre.scrolling.content
+  margin: 0
+
+/* tables */
+table.ui.table
+  .actions
+    text-align: right
+  thead
+    tr.search
+      th, td
+        padding-top: 2px
+        padding-bottom: 2px
+        .clear-filters-button
+          display: none
+      &.conditions-present
+        th, td
+          background-color: #d2e1ec
+          .clear-filters-button
+            display: inline-block
+      .column-filter.actions
+        min-width: 85px
+        padding-right: 3px
+  tbody
+    td.actions
+      min-width: 112px
+      padding-right: 3px

data/app/assets/stylesheets/doc_contract/pandoc.css

@@ -0,0 +1,15 @@
+body, table {
+  font-size: 12px;
+}
+
+table {
+  border: 0px;
+  border-collapse: collapse;
+}
+th {
+  text-align: left;
+}
+
+h2, h3, h4 {
+  padding-top: 1em;
+}

data/app/controllers/concerns/doc_contract/shared_template_and_instance_methods.rb

@@ -0,0 +1,71 @@
+module DocContract
+  module SharedTemplateAndInstanceMethods
+    # POST /doc-contract/contract_templates/:id/processed_markdown?markdown=...
+    def processed_markdown
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+      # Allow preview using the markdown parameter. Fallback to actual saved
+      # version when param is not given
+      @record.markdown = params[:markdown] if params[:markdown].present?
+      render json: {markdown: @record.processed_markdown}
+    end
+
+    def processed_html
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+      # Allow preview using the markdown parameter. Fallback to actual saved
+      # version when param is not given
+      @record.markdown = params[:markdown] if params[:markdown].present?
+      render json: {html: @record.processed_html}
+    end
+
+    def get_pdf
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+      # Allow preview using the markdown parameter. Fallback to actual saved
+      # version when param is not given
+      @record.markdown = params[:markdown] if params[:markdown].present?
+      @tempfile_markdown = Tempfile.new(['pandoc-markdown', '.md'])
+      config_addittions = {}
+      if nbackground = @record.try(:titlepage_background) || @record.contract_template.titlepage_background.presence
+        config_addittions['titlepage-background'] = "vendor/assets/doc-contract/titlepage-backgrounds/background#{nbackground}.pdf"
+      end
+      template_markdown = @record.template_markdown(config_addittions)
+      @tempfile_markdown.write template_markdown
+      #@tempfile_markdown.rewind
+      @tempfile_markdown.close
+      @tempfile_pdf = Tempfile.create(['pandoc-pdf-', '.pdf'])
+      @tempfile_pdf.close
+      command = %( pandoc --template=vendor/assets/doc-contract/pandoc-templates/eisvogel.tex --css=app/assets/stylesheets/doc_contract/pandoc.css #{@tempfile_markdown.path} -o #{@tempfile_pdf.path} )
+      command << " --variable top-level-division=chapter" if @record.config['book']
+      #command << " --variable titlepage=true" if false # done through YAML config
+      command << " --listings" # if some conditions TODO: make this a database boolean
+      command << " --filter pandoc-latex-environment" if template_markdown['pandoc-latex-environment:']
+
+      stdout, stderr, status = nil
+      Dir.chdir DocContract::Engine.root do
+        stdout, stderr, status = Open3.capture3(command)
+      end
+      if status.success?
+        send_file @tempfile_pdf.path
+      else
+        redirect_back fallback_location: record_class, flash: {error: stderr}
+      end
+    ensure
+      @tempfile_markdown.unlink rescue nil
+      @tempfile_pdf.unlink rescue nil
+    end
+
+    private
+
+    def record_class
+      result = controller_path.classify.safe_constantize
+      raise "Cannot determine record_class from controller_path: #{controller_path}" unless result
+      result
+    end
+
+    def record_params
+      params.require(record_class.name.demodulize.underscore).permit!
+    end
+  end
+end

data/app/controllers/doc_contract/application_controller.rb

@@ -0,0 +1,20 @@
+module DocContract
+  class ApplicationController < ApplicationController
+    helper_method :query, :readme_html
+    def main
+    end
+
+    private
+
+    def query
+      params[:q]
+    end
+
+    def readme_html
+      result = DocContract::Engine.root.join('README.md').read
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, tables: true, fenced_code_blocks: true)
+      markdown.render result
+    end
+
+  end
+end

data/app/controllers/doc_contract/contract_instances_controller.rb

@@ -0,0 +1,56 @@
+module DocContract
+  class ContractInstancesController < ApplicationController
+    include SharedTemplateAndInstanceMethods
+    helper_method :record_class
+    respond_to :html
+
+    def index
+      authorize! :index, record_class
+      @q = record_class.search query
+      @q.sorts = "created_at desc" if @q.sorts.empty?
+      @records = @q.result.includes(:contract_template).page(params[:page]).per(100)
+      respond_with(@records)
+    end
+
+    def new
+      @record = record_class.new
+    end
+
+    def edit
+      @record = record_class.find(params[:id])
+      authorize! :edit, @record
+    end
+
+    def create
+      authorize! :create, record_class
+      @record = record_class.new record_params
+      if @record.save
+        redirect_to @record
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      @record = record_class.find params[:id]
+      authorize! :update, @record
+      if @record.update record_params
+        redirect_to @record
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    def show
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+    end
+
+    def destroy
+      @record = record_class.find params[:id]
+      authorize! :destroy, @record
+      @record.destroy
+      redirect_to record_class
+    end
+  end
+end

data/app/controllers/doc_contract/contract_templates_controller.rb

@@ -0,0 +1,69 @@
+module DocContract
+  class ContractTemplatesController < ApplicationController
+    include SharedTemplateAndInstanceMethods
+    helper_method :record_class
+    respond_to :html
+
+    def index
+      authorize! :index, record_class
+      @q = record_class.search query
+      @q.sorts = 'created_at desc' if @q.sorts.empty?
+      @records = @q.result.page(params[:page]).per(100)
+      respond_with(@records)
+    end
+
+    def new
+      @record = record_class.new
+    end
+
+    def edit
+      @record = record_class.find(params[:id])
+      authorize! :edit, @record
+    end
+
+    def create
+      authorize! :create, record_class
+      @record = record_class.new record_params
+      if @record.save
+        redirect_to @record, status: :see_other
+      else
+        render action: 'new'
+      end
+    end
+
+    def update
+      @record = record_class.find params[:id]
+      authorize! :update, @record
+      if @record.update record_params
+        redirect_to @record, status: :see_other
+      else
+        render action: 'edit'
+      end
+    end
+
+    def show
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+    end
+
+    def destroy
+      @record = record_class.find params[:id]
+      authorize! :destroy, @record
+      @record.destroy
+      redirect_to record_class, status: :see_other
+    end
+
+    private
+
+    def record_class
+      result = controller_path.classify.safe_constantize
+      raise "Cannot determine record_class from controller_path: #{controller_path}" unless result
+
+      result
+    end
+
+    def record_params
+      params.require(record_class.name.demodulize.underscore).permit!
+    end
+  end
+end