doc_contract 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8bf71ecf102ece032fb389c712f87952492ffab66f2316b9f2a08a14c78a377
-  data.tar.gz: 315c59f51e3f2639cb3dc98a714b8be9cbe528bb407ce5bea0076bbeacf0a038
+  metadata.gz: a3a6c918f368226c070e81509c178e61d83f45cd1f239a126ae66a355f50c512
+  data.tar.gz: 7bb72324e156c3fc3451e7379b9ab642ce395808ca0d3c2117819fd0231a86c8
 SHA512:
-  metadata.gz: 2d5e249c5e2e04e8d1129ae3e58a1fff499632cf2887e0d603c7fb6b4935961bbdd3a1bd690fa6746754375356011f64215d842c715e58828f8d9fcf2cb59551
-  data.tar.gz: a1c6c894ac00bd866f5e86d2e4ed657763e5c4114a80c38a62fc1d2c161fa35b0f4074514463eb8820a922ed3e69389cf2fa492dd2902477c0094db0bfa5f834
+  metadata.gz: 23ab0131768cc5d6579447c141de09915656d3d1249d8f966f1e55daa8b455189e3d4793ef995169ddf56aecceea914826bbf2156277f301974762229a1821b1
+  data.tar.gz: 76096e9d5a43835fd96dd94ca9a5ddc75b85ab12c3ceb60c3e66655a55404e05d5fcdc6d9cd97105b631c4d88acbda606b8c06710d266c44af56b4b3d3596ea5

data/README.md

@@ -173,16 +173,17 @@ To put your own version of this page create a view having this path in the main
 put the following in your `config/application.rb` file:
 
 ```ruby
-  config.doc_contract.show_readme_on_main_page = false
+  config.x.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'
+  config.x.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.
+Note that the value is a `lambda` to allow the use of for example `I18n`.
 
 ### Screenshot
 ![Edit template scnreenshot](/spec/dummy/public/DocContract-template-edit.png)

data/Rakefile

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

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

@@ -11,6 +11,8 @@ latex_template_infos =
       </a>'
 $ ->
   $('.ui.dropdown').dropdown() # assume fomantic that has the clearable class option, a lot better than the below custom code
+  $('.message .close').on 'click', ->
+    $(@).closest('.message').transition('fade')
 
   $('.preview-markdown').click ->
     markdown = $('#contract_template_markdown').val()

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DocContract
   module SharedTemplateAndInstanceMethods
     # POST /doc-contract/contract_templates/:id/processed_markdown?markdown=...
@@ -19,12 +20,17 @@ module DocContract
       render json: {html: @record.processed_html}
     end
 
-    def get_pdf
+    # rubocop:disable Metrics/MethodLength
+    # for now keep as a whole story
+    def 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?
+      return redirect_to @record unless @record.markdown.present?
+
       @tempfile_markdown = Tempfile.new(['pandoc-markdown', '.md'])
       config_addittions = {}
       if nbackground = @record.try(:titlepage_background) || @record.contract_template.titlepage_background.presence
@@ -36,31 +42,42 @@ module DocContract
       @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 = %(
+        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}
+      ).strip.gsub(/\n\s*/, ' ')
+      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:']
+      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
+      begin
+        @tempfile_markdown.unlink
+        @tempfile_pdf.unlink
+      rescue
+        nil
+      end
     end
+    # rubocop:enable Metrics/MethodLength
 
     private
 
     def record_class
       result = controller_path.classify.safe_constantize
       raise "Cannot determine record_class from controller_path: #{controller_path}" unless result
+
       result
     end
 

data/app/controllers/doc_contract/application_controller.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module DocContract
-  class ApplicationController < ApplicationController
+  class ApplicationController < ::ApplicationController
     helper_method :query, :readme_html
 
     def main
+      # root landing action
     end
 
     private

data/app/controllers/doc_contract/contract_instances_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DocContract
   class ContractInstancesController < ApplicationController
     include SharedTemplateAndInstanceMethods
@@ -7,23 +8,19 @@ module DocContract
     def index
       authorize! :index, record_class
       @q = record_class.ransack query
-      @q.sorts = "created_at desc" if @q.sorts.empty?
+      @q.sorts = 'name asc' 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
+      authorize! :create, @record
     end
 
     def create
-      authorize! :create, record_class
       @record = record_class.new record_params
+      authorize! :create, @record
       if @record.save
         redirect_to @record
       else
@@ -31,9 +28,19 @@ module DocContract
       end
     end
 
+    def show
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+    end
+
+    def edit
+      @record = record_class.find(params[:id])
+      authorize! :edit, @record
+    end
+
     def update
       @record = record_class.find params[:id]
-      authorize! :update, @record
+      authorize! :edit, @record
       if @record.update record_params
         redirect_to @record
       else
@@ -41,11 +48,6 @@ module DocContract
       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

data/app/controllers/doc_contract/contract_templates_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DocContract
   class ContractTemplatesController < ApplicationController
     include SharedTemplateAndInstanceMethods
@@ -7,23 +8,19 @@ module DocContract
     def index
       authorize! :index, record_class
       @q = record_class.ransack query
-      @q.sorts = 'created_at desc' if @q.sorts.empty?
+      @q.sorts = 'name asc' 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
+      authorize! :create, @record
     end
 
     def create
-      authorize! :create, record_class
       @record = record_class.new record_params
+      authorize! :create, @record
       if @record.save
         redirect_to @record, status: :see_other
       else
@@ -31,9 +28,19 @@ module DocContract
       end
     end
 
+    def show
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+    end
+
+    def edit
+      @record = record_class.find(params[:id])
+      authorize! :edit, @record
+    end
+
     def update
       @record = record_class.find params[:id]
-      authorize! :update, @record
+      authorize! :edit, @record
       if @record.update record_params
         redirect_to @record, status: :see_other
       else
@@ -41,29 +48,11 @@ module DocContract
       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

data/app/helpers/doc_contract/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DocContract
   module ApplicationHelper
     # Return active or nil based on the given route spec
@@ -6,8 +8,9 @@ module DocContract
     #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) }
+      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
 
@@ -19,17 +22,21 @@ module DocContract
     #   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 = {})
+    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
@@ -78,11 +85,11 @@ module DocContract
     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
+      title = if args.first == :index
+                t('action.index.label', models: model.model_name.human_plural).html_safe
+              else
+                t("action.#{args.first}.label", model: model.model_name.human).html_safe
+              end
       if back_options = options[:back]
         url =
           case back_options
@@ -105,7 +112,7 @@ module DocContract
       "#{from_item} - #{to_item} / #{records.total_count}"
     end
 
-    def at(attribute_name, scope_model=nil)
+    def at(attribute_name, scope_model = nil)
       scope_model ||= @scope_model
       scope_model.human_attribute_name(attribute_name)
     end
@@ -116,7 +123,7 @@ module DocContract
       classes |= ['search']
       classes << 'conditions-present' if @q.conditions.present?
       content = capture(&blk)
-      content_tag(:tr, content,  class: classes )
+      content_tag(:tr, content, class: classes)
     end
 
     # This helper returns the link for showing a record inside a table
@@ -126,7 +133,11 @@ module DocContract
       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')
+      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
@@ -136,7 +147,11 @@ module DocContract
       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')
+      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
@@ -161,16 +176,22 @@ module DocContract
       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')
+      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"
+      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

data/app/models/concerns/yaml_validator.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 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")
+
+    object = begin
+      YAML.safe_load(value, permitted_classes: [Symbol, Date])
+    rescue # Psych::SyntaxError
+      nil
     end
+
+    record.errors.add attribute, (options[:message] || 'is not valid YAML') unless object
   end
 end

data/app/models/doc_contract/application_record.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DocContract
+  class ApplicationRecord < ActiveRecord::Base
+
+    self.abstract_class = true
+
+    RANSACKABLE_ATTRIBUTES = [].freeze
+    RANSACKABLE_ASSOCIATIONS = [].freeze
+
+    def self.ransackable_attributes(_auth_object = nil)
+      if const_defined? :RANSACKABLE_ATTRIBUTES
+        const_get :RANSACKABLE_ATTRIBUTES
+      else
+        RANSACKABLE_ATTRIBUTES
+      end
+    end
+
+    def self.ransackable_associations(_auth_object = nil)
+      if const_defined? :RANSACKABLE_ASSOCIATIONS
+        const_get :RANSACKABLE_ASSOCIATIONS
+      else
+        RANSACKABLE_ASSOCIATIONS
+      end
+    end
+  end
+end

data/app/models/doc_contract/contract_instance.rb

@@ -1,10 +1,17 @@
+# frozen_string_literal: true
+
 module DocContract
   class ContractInstance < ApplicationRecord
-    validates :name, presence: true
+
     belongs_to :contract_template
 
+    validates :name, presence: true
+
+    RANSACKABLE_ATTRIBUTES = %w[name].freeze
+    RANSACKABLE_ASSOCIATIONS = %w[contract_template].freeze
+
     def config
-      own_config = YAML.load(config_yml.to_s) || {}
+      own_config = YAML.safe_load(config_yml.to_s, permitted_classes: [Symbol, Date]) || {}
       own_config.reverse_merge contract_template.config
     end
 
@@ -27,7 +34,7 @@ module DocContract
       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
+      "#{config.to_yaml}...\n\n#{result}"
     end
 
     def processed_html

data/app/models/doc_contract/contract_template.rb

@@ -1,13 +1,24 @@
+# frozen_string_literal: true
 module DocContract
   class ContractTemplate < ApplicationRecord
-    HANDLEBARS_REGEX = /{{((#)?[a-z\._ ]+)}}/
+
+    HANDLEBARS_REGEX = /{{((#)?[a-z._ ]+)}}/
+
+    RANSACKABLE_ATTRIBUTES = %w[name].freeze
+    #RANSACKABLE_ASSOCIATIONS = %w[].freeze
+
     has_many :contract_instances, dependent: :delete_all
 
     validates :name, presence: true
     validates :config_yml, yaml: true
 
     def config
-      YAML.load(config_yml.to_s) || {}
+      YAML.safe_load(config_yml.to_s, permitted_classes: [Symbol, Date]) || {}
+    end
+
+    # Do not fail when an instance trait tries to access fallback template properties
+    def contract_template
+      self
     end
 
     def processed_markdown(config_addittions = {})
@@ -21,7 +32,7 @@ module DocContract
       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
+      "#{config.to_yaml}...\n\n#{result}"
     end
 
     def processed_html
@@ -31,7 +42,7 @@ module DocContract
     end
 
     def present_handlebars_expressions
-      markdown.scan(HANDLEBARS_REGEX).map(&:first).uniq
+      markdown.to_s.scan(HANDLEBARS_REGEX).map(&:first).uniq
     end
   end
 end

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

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

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

@@ -1,9 +1,13 @@
 .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
+    = Rails.application.config.x.doc_contract.link_home_content.call.to_s.html_safe
+  = link_to doc_contract.root_path, class: 'header item'
+    = Rails.application.config.x.doc_contract.application_title.call.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')]
+    - if can? :read, DocContract::ContractTemplate
+      = link_to DocContract::ContractTemplate.model_name.human_plural, [DocContract::ContractTemplate], class: ['item', active_class('doc_contract/contract_templates')]
+    - if can? :read, DocContract::ContractInstance
+      = 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

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

@@ -1,6 +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
+- if Rails.application.config.x.doc_contract.show_readme_on_main_page
   hr
   #readme_container== readme_html

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

@@ -4,7 +4,10 @@
     tbody
       tr
         td= at :name
-        td: .ui.input= f.text_field :name
+        td
+          .ui.input.error= f.text_field :name
+          - if @record.errors[:name].present?
+            .ui.left.pointing.red.basic.label= @record.errors[:name].to_sentence
       tr
         td
           = DocContract::ContractTemplate.model_name.human

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

@@ -6,8 +6,8 @@
       table.ui.compact.top.attached.striped.table
         thead
           tr
-            th= at :name
-            th= DocContract::ContractTemplate.model_name.human
+            th= sort_link @q, :name, at(:name), default_order: :asc
+            th= sort_link @q, :contract_template_name, DocContract::ContractTemplate.model_name.human
             th.column-filter.actions
               = search_result_info @records
           = search_row class: 'ui mini form' do

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

@@ -6,7 +6,7 @@
       table.ui.compact.top.attached.striped.table
         thead
           tr
-            th= at :name
+            th= sort_link @q, :name, at(:name), default_order: :asc
             th.column-filter.actions
               = search_result_info @records
           = search_row class: 'ui mini form' do

data/config/environment.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+### NOTE:
+# This is a dummy file to let the vim-rails vim plugin work with the rails engine

data/config/initializers/human_plural.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 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 })
+      default = proc do |path|
+        if path.present? and path['/'] # non namespaced model a.b.c/d/e => a.b.c
+          unnamespaced_path = path.sub(%r{\.(\w+)/[\w\\]+}, '.\1')
+          I18n.t(unnamespaced_path, default: proc{ human.pluralize })
         else
           human.pluralize
         end
       end
-      I18n.t("#{@klass.i18n_scope}.models.plural.#{i18n_key}", default: default )
+      I18n.t("#{@klass.i18n_scope}.models.plural.#{i18n_key}", default: default)
     end
   end
 end

data/config/routes.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 DocContract::Engine.routes.draw do
   resources :contract_templates do
     member do
       post :processed_markdown
       post :processed_html
-      get :get_pdf
+      get :pdf
     end
   end
   resources :contract_instances do
     member do
       post :processed_markdown
       post :processed_html
-      get :get_pdf
+      get :pdf
     end
   end
   root 'application#main'

data/db/migrate/20220118150923_create_doc_contract_contract_templates.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateDocContractContractTemplates < ActiveRecord::Migration[7.0]
   def change
     create_table :doc_contract_contract_templates do |t|

data/db/migrate/20220121160034_add_markdown_to_doc_contract_contract_templates.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class AddMarkdownToDocContractContractTemplates < ActiveRecord::Migration[7.0]
   def change
     add_column :doc_contract_contract_templates, :markdown, :text

data/db/migrate/20220121165825_add_config_yml_to_doc_contract_contract_templates.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class AddConfigYmlToDocContractContractTemplates < ActiveRecord::Migration[7.0]
   def change
     add_column :doc_contract_contract_templates, :config_yml, :text

data/db/migrate/20220122151402_create_doc_contract_contract_instances.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateDocContractContractInstances < ActiveRecord::Migration[7.0]
   def change
     create_table :doc_contract_contract_instances do |t|

data/db/migrate/20220125183437_add_titlepage_background_to_contract_templates.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class AddTitlepageBackgroundToContractTemplates < ActiveRecord::Migration[7.0]
   def change
     add_column :doc_contract_contract_templates, :titlepage_background, :string

data/lib/doc_contract/engine.rb

@@ -1,27 +1,42 @@
-require 'numbers_and_words'
+# frozen_string_literal: true
 require 'cancancan'
-require 'ransack'
+require 'jquery-rails'
 require 'kaminari'
+require 'numbers_and_words'
+require 'ransack'
+require 'redcarpet'
+
 module DocContract
   class Engine < ::Rails::Engine
+
     #isolate_namespace self.name.deconstantize.safe_constantize
     isolate_namespace DocContract
-    initializer "doc_contract.assets.precompile" do |main_app|
+
+    initializer 'doc_contract.assets.precompile' do |main_app|
       #app.config.assets.precompile << "config/engine_name_manifest.js"
-      main_app.config.assets.precompile << "doc_contract/application.css"
-      main_app.config.assets.precompile << "doc_contract/application.js"
-      main_app.config.doc_contract = ActiveSupport::OrderedOptions.new
-      main_app.config.doc_contract.show_readme_on_main_page = true
-      main_app.config.doc_contract.link_home_content = '<i class="arrow left icon"></i> Back'
+      main_app.config.assets.precompile << 'doc_contract/application.css'
+      main_app.config.assets.precompile << 'doc_contract/application.js'
+
+      # Engine specific config
+      # Allow setting false, so check for nil
+      main_app.config.x.doc_contract.show_readme_on_main_page = true if main_app.config.x.doc_contract.show_readme_on_main_page.nil?
+      main_app.config.x.doc_contract.application_title ||= -> { 'DOC-contract' }
+      main_app.config.x.doc_contract.link_home_content ||= -> { '<i class="arrow left icon"></i> Back' }
     end
 
     # add migrations to containing application
     initializer 'doc_contract.append_migrations' do |app|
       unless app.root.to_s.match root.to_s
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
         end
       end
     end
+
+    initializer 'doc_contract.ensure_set_field_error_proc' do |app|
+      app.config.action_view.field_error_proc ||= proc do |html_tag, _instance|
+        %|<div class="field_with_errors field error has-error">#{html_tag}</div>|.html_safe
+      end
+    end
   end
 end

data/lib/doc_contract/handlebars.rb

@@ -1,25 +1,32 @@
+# frozen_string_literal: true
+
 module DocContract
   class Handlebars
+
     COMPILE_ATTRIBUTES = %w[
       title subtitle
       header-left header-center header-right
       footer-left footer-center footer-right
-    ]
+    ].freeze
+
     class DummyEscaper
+
       def self.escape(value)
         value
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.renderer
-      return @@handlebars_renderer if class_variable_defined? :@@handlebars_renderer
+      return @handlebars_renderer if @handlebars_renderer
+
       renderer = ::Handlebars::Handlebars.new
       renderer.set_escaper DummyEscaper # Do not escape HTML
-      currency_helper = Proc.new do |context, value, currency_symbol|
-        if Integer === value or value.to_i == value
-          sprintf("#{currency_symbol} %.0f,-", value) #.gsub(/(\d)(?=\d{3}+,)/, '\1.')
+      currency_helper = proc do |_context, value, currency_symbol|
+        if value.is_a?(Integer) or value.to_i == value
+          format("#{currency_symbol} %.0f,-", value) #.gsub(/(\d)(?=\d{3}+,)/, '\1.')
         else
-          sprintf("#{currency_symbol} %.2f", value.to_f) #.gsub(/(\d)(?=\d{3}+,)/, '\1.')
+          format("#{currency_symbol} %.2f", value.to_f) #.gsub(/(\d)(?=\d{3}+,)/, '\1.')
         end
       end
       #renderer.register_helper(:euro) do |context, value|
@@ -29,15 +36,15 @@ module DocContract
       #    sprintf("€ %.2f", value.to_f) #.gsub(/(\d)(?=\d{3}+,)/, '\1.')
       #  end
       #end
-      eval_boolean = Proc.new do |context, values, compare_lambda|
-        blocks, comparables = values.partition{|v| v.is_a? ::Handlebars::Tree::Block}
+      eval_boolean = proc do |context, values, compare_lambda|
+        blocks, comparables = values.partition{ |v| v.is_a? ::Handlebars::Tree::Block }
         true_blk, false_blk = blocks
-        comparables = comparables.map{|v| v.is_a?(Parslet::Slice) ? v.to_s : v}
-        if compare_lambda.arity == 1
-          are_equal = compare_lambda.call(comparables)
-        else
-          are_equal = compare_lambda.call(*comparables)
-        end
+        comparables = comparables.map{ |v| v.is_a?(Parslet::Slice) ? v.to_s : v }
+        are_equal = if compare_lambda.arity == 1
+                      compare_lambda.call(comparables)
+                    else
+                      compare_lambda.call(*comparables)
+                    end
         if true_blk.items.present? # assumed internal helper usecase without blocks
           are_equal ? true_blk.fn(context) : false_blk.try(:fn, context)
         else
@@ -47,31 +54,38 @@ module DocContract
       renderer.register_helper(:euro) { |context, value| currency_helper.call context, value, '€' }
       renderer.register_helper(:dollar) { |context, value| currency_helper.call context, value, '$' }
       renderer.register_helper(:peso) { |context, value| currency_helper.call context, value, '$' }
-      renderer.register_helper(:plus) {|context, value, addition, *rest| value.to_f + addition.to_f }
-      renderer.register_helper(:sum) {|context, *values, bkl| (values.first.is_a?(Array) ? values.first : values).map(&:to_f).sum }
-      renderer.register_helper(:eq)  { |context, *values| eval_boolean.call context, values, ->(vals){ vals.uniq.length <= 1 } }
+      renderer.register_helper(:plus) { |_context, value, addition, *_rest| value.to_f + addition.to_f }
+      renderer.register_helper(:sum)  { |_context, *values, _bkl| (values.first.is_a?(Array) ? values.first : values).map(&:to_f).sum }
+      renderer.register_helper(:eq)   { |context, *values| eval_boolean.call context, values, ->(vals){ vals.uniq.length <= 1 } }
       renderer.register_helper(:neq)  { |context, *values| eval_boolean.call context, values, ->(vals){ vals.uniq.length > 1 } }
-      renderer.register_helper(:gt)  { |context, *values| eval_boolean.call context, values, ->(a, b){ a > b } }
-      renderer.register_helper(:includes)  { |context, *values| eval_boolean.call context, values, ->(vals){ vals.first.include? vals.last } }
-      renderer.register_helper(:map) do |context, array, key|
+      renderer.register_helper(:gt)   { |context, *values| eval_boolean.call context, values, ->(a, b){ a > b } }
+      renderer.register_helper(:includes) { |context, *values| eval_boolean.call context, values, ->(vals){ vals.first.include? vals.last } }
+      renderer.register_helper(:map) do |_context, array, key|
         return [] unless array.present?
-        array.map{|e| e[key.to_s] || e[key.to_sym]}
+
+        array.map{ |e| e[key.to_s] || e[key.to_sym] }
       end
-      renderer.register_helper(:upcase) {|context, value| value.to_s.upcase }
-      renderer.register_helper(:downcase) {|context, value| value.to_s.downcase }
-      renderer.register_helper(:to_sentence) do |context, array, nester|
+      renderer.register_helper(:upcase) { |_context, value| value.to_s.upcase }
+      renderer.register_helper(:downcase) { |_context, value| value.to_s.downcase }
+      renderer.register_helper(:to_sentence) do |_context, array, nester|
         case nester
         when String, Parslet::Slice
-          array.map{|e| e[nester.to_s] || e[nester.to_sym]}.to_sentence
+          array.map{ |e| e[nester.to_s] || e[nester.to_sym] }.to_sentence
         else
           array.to_sentence
         end
       end
-      renderer.register_helper(:to_words) { |context, value| value.to_words }
-      @@handlebars_renderer = renderer
+      renderer.register_helper(:to_words) { |_context, value| value.to_words }
+      renderer.register_helper(:first_present) do |_context, *args|
+        args.find(&:present?)
+      end
+      @handlebars_renderer = renderer
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.compile(text, object, process_attributes: true)
+      return '' unless text.present?
+
       object ||= {}
       if process_attributes
         object.stringify_keys!
@@ -83,13 +97,14 @@ module DocContract
 
     def self.enrich_object(object)
       object['today'] = Date.today.iso8601 if object['today'].blank?
-      object.keys.each do |k|
+      iteration_keys = object.keys
+      iteration_keys.each do |k|
         if k =~ /_items$/ and object[k].is_a?(Array)
-          amounts_sum = object[k].map{|o| (o[:amount] || o['amount']).to_f}.sum
+          amounts_sum = object[k].map{ |o| (o[:amount] || o['amount']).to_f }.sum
           object["#{k}_total"] = amounts_sum
         end
         if COMPILE_ATTRIBUTES.include? k
-          #TODO check self reference, maybe even circular?
+          #TODO: check self reference, maybe even circular?
           object[k] = compile(object[k], object, process_attributes: false)
         end
       end

data/lib/doc_contract/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DocContract
-  VERSION = "0.1.5"
+  VERSION = '0.2.0'
 end

data/lib/doc_contract.rb

@@ -1,6 +1,7 @@
-require "doc_contract/version"
-require "doc_contract/engine"
-require "doc_contract/handlebars"
+# frozen_string_literal: true
+require 'doc_contract/version'
+require 'doc_contract/engine'
+require 'doc_contract/handlebars'
 require 'ruby-handlebars'
 require 'open3'
 

data/lib/tasks/doc_contract_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :doc_contract do
 #   # Task goes here

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: doc_contract
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Benjamin ter Kuile
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-handlebars
+  name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cancancan
+  name: numbers_and_words
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ransack
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: ransack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: numbers_and_words
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: ruby-handlebars
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot_rails
+  name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coffee-rails
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -187,6 +187,7 @@ files:
 - app/controllers/doc_contract/contract_templates_controller.rb
 - app/helpers/doc_contract/application_helper.rb
 - app/models/concerns/yaml_validator.rb
+- app/models/doc_contract/application_record.rb
 - app/models/doc_contract/contract_instance.rb
 - app/models/doc_contract/contract_template.rb
 - app/views/doc_contract/application/_button-destroy-record.html.slim
@@ -217,6 +218,7 @@ files:
 - app/views/doc_contract/kaminari/_paginator.html.slim
 - app/views/doc_contract/kaminari/_prev_page.html.slim
 - app/views/layouts/doc_contract/application.html.slim
+- config/environment.rb
 - config/initializers/human_plural.rb
 - config/locales/en.yml
 - config/routes.rb
@@ -262,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Create nice and easy contracts based on pandoc