renalware-forms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 347e9f7644d2f72db868d81b7c16a22403285db8bed1bdf545041f53fcae2b79
+  data.tar.gz: b909b6addb49a49c618324e41c34cadb19eb04ce9140d1a48562cbbab0deea0f
+SHA512:
+  metadata.gz: d2d1937839e25b9ceabc0e4eb03e21e571a831f795fce8cea0194cdfd5f6c2147d53d18174bee50125854872bcee892c865522cecbe7bb0a8c46b573ea2d0440
+  data.tar.gz: 95f1eb71ec37fbaac84f61956a9193812feb613ee9188966cf1c4d139d10e5fbb30d4f1ba7202b114a2f7a346a5ec3c749637a0f919bfe7d1cf59d8a9fc2524a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Tim Crowe
+
+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,66 @@
+# Renalware::Forms
+
+This gem
+- is a library of pre-defined generic PDF forms that Renalware can populate and present
+to the user, for example when a user needs to print and sign a list of drugs to be delivered for
+homecare.
+- provides a API for creating these PDFs, and others (see renalware-forms-* gems) so that form
+creation is abstracted from Renalware.
+
+The PDFs are constructed using Prawn, chosen mainly for its speed.
+
+The gem exposes an API for a caller to specify the type and version of the PDF they require, along
+with data to populate it (patient name and address etc).
+
+See other gems ie `renalware-forms-<provider>` for instances where we have built custom forms
+based on this gem.
+
+## Future enhancements
+
+To be more extensible and remove the need for developer input when adding new forms, an alternative
+implementation is possible where the request to create for example "Fresenius Homecare
+Supply Version 1.1" will load a PDF file with the corrersponding name. If the PDF is created for
+example in Acrobat or LibreOffice and specifically-named form fields are inserted, these can be
+populated with the supplied the data the caller also provides. It could even allow the path to a
+custom PDF form to be supplied by the caller. Using a shared library of PDF files stored inside this
+gem will provide more re-usue opportunity across sites, though there could be nothing stopping a
+hospital developing a custom form stored outside of this gem, and not sharing it.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'renalware-forms'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install renalware-forms
+```
+## Testing
+
+You can generate example instances of all the PDFs in this gem from the command line.
+
+You can see a list available tasks:
+
+```bash
+$ bundle exec rake -T
+```
+
+For example:
+
+```bash
+$ bundle exec rake forms:generic:homecare:v1
+```
+
+will create the version 1 PDF with test data and open it in Linux (will require a change
+for it to open on a Mac).
+
+## 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,19 @@
+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    = "Renalware::Forms"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+Dir.glob("lib/tasks/**/*.rake").each { |r| load r }
+
+require "bundler/gem_tasks"

data/lib/renalware/forms.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "prawn"
+require "prawn/table"
+require "attr_extras"
+require "active_support"
+
+module Renalware
+  module Forms
+    extend ActiveSupport::Autoload
+
+    autoload :Helpers
+    autoload :Base
+    autoload :Homecare
+    autoload :Generic
+  end
+end

data/lib/renalware/forms/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Renalware::Forms
+  class Base
+    include Prawn::View
+    EMPTY_CHECKBOX = "o     " # in ZapfDingbats
+    CHECKBOX = "3    "
+
+    # lower case o is an empty checkbox in ZapfDingbats
+    def cell_with_leading_checkbox(text, checked: false, **options)
+      if checked
+        {
+          content: "<font name='ZapfDingbats'>#{CHECKBOX}</font>#{text}",
+          inline_format: true,
+          **options
+        }
+      else
+        {
+          content: "<font name='ZapfDingbats'>#{EMPTY_CHECKBOX}</font>#{text}",
+          inline_format: true,
+          **options
+        }
+      end
+    end
+  end
+end

data/lib/renalware/forms/generic.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Renalware::Forms
+  module Generic
+    extend ActiveSupport::Autoload
+
+    autoload :Homecare
+  end
+end

data/lib/renalware/forms/generic/homecare.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Renalware::Forms
+  module Generic
+    module Homecare
+      extend ActiveSupport::Autoload
+
+      autoload :V1
+    end
+  end
+end

data/lib/renalware/forms/generic/homecare/v1.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Renalware::Forms::Generic
+  module Homecare
+    module V1
+      extend ActiveSupport::Autoload
+
+      autoload :Base
+      autoload :Document
+    end
+  end
+end

data/lib/renalware/forms/generic/homecare/v1/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Renalware::Forms::Generic
+  module Homecare::V1
+    class Base < Renalware::Forms::Base
+      pattr_initialize :document, :args
+    end
+  end
+end

data/lib/renalware/forms/generic/homecare/v1/document.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Renalware::Forms::Generic
+  module Homecare::V1
+    class Document < Base
+      pattr_initialize :args
+
+      def self.build(args)
+        new(args).tap(&:build)
+      end
+
+      def document
+        @document ||= Prawn::Document.new(page_size: "A4", page_layout: :portrait, margin: 15)
+      end
+
+      def build; end
+    end
+  end
+end

data/lib/renalware/forms/helpers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+module Renalware
+  module Forms
+    module Helpers
+      def render_and_open(prawn_pdf_doc)
+        filename = File.join(Dir.pwd, "./tmp", "#{Time.now.to_i}.pdf")
+        prawn_pdf_doc.render_file filename
+        open_pdf filename
+      end
+
+      def open_pdf(filename)
+        # Open the test file in ubuntu - just use "open" if mac?
+        # You may need to fo
+        # `sudo apt-get install appmenu-gtk2-module appmenu-gtk3-module`
+
+        `gio open #{filename}`
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/renalware/forms/homecare.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "prawn"
+require "prawn/table"
+require "attr_extras"
+require "active_support"
+
+module Renalware::Forms
+  module Homecare
+    extend ActiveSupport::Autoload
+
+    autoload :Pdf
+    autoload :Args
+    autoload :Generic
+  end
+end

data/lib/renalware/forms/homecare/args.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "virtus"
+require "active_model"
+
+module Renalware::Forms
+  class Homecare::Args
+    include Virtus::Model
+    include ActiveModel::Validations
+
+    # The first 2 attrbutes are used to drive what PDF to build
+    attribute :provider, String
+    attribute :version, Integer
+
+    attribute :title, String
+    attribute :given_name, String
+    attribute :family_name, String
+    attribute :nhs_number, String
+    attribute :born_on, Date
+    attribute :fmc_patient, String
+    attribute :telephone, String
+    attribute :hospital_number, String
+    attribute :address, String
+    attribute :postcode, String
+    attribute :modality, String
+    attribute :prescriber_name, String
+    attribute :prescription_date, Date
+    attribute :hospital_name, String
+    attribute :hospital_department, String
+    attribute :hospital_address, Array[String]
+    attribute :po_number, String
+    attribute :no_known_allergies, Boolean
+    attribute :allergies, Array[String]
+    attribute :administration_route, String
+    attribute :administration_frequency, String
+    attribute :prescription_duration, String
+    attribute :administration_device, String
+
+    # validates! will raise eg ActiveModel::StrictValidationFailed: Family name can't be blank
+    validates! :family_name, presence: true
+    validates! :given_name, presence: true
+
+    def formatted_address
+      format_address_array address
+    end
+
+    def formatted_hospital_address
+      format_address_array hospital_address
+    end
+
+    def formatted_hospital_name_and_address
+      arr = [hospital_name] + hospital_address
+      format_address_array arr
+    end
+
+    def format_address_array(add)
+      return unless add&.is_a?(Array)
+
+      add.compact.reject { |line| line == "" }&.uniq&.join("\n")
+    end
+
+    def formatted_prescription_date
+      return unless prescription_date
+
+      prescription_date
+    end
+
+    def allergies_as_list
+      Array(allergies).uniq.compact.join("<br>")
+    end
+
+    def self.test_data(provider: :generic, version: 1)
+      new.tap do |args|
+        args.provider = provider
+        args.version = version
+        args.title = "Mr"
+        args.given_name = "Jack"
+        args.family_name = "JONES"
+        args.nhs_number = "0123456789"
+        args.born_on = Date.parse("2001-01-01")
+        args.fmc_patient = "123"
+        args.telephone = "07000 000001"
+        args.hospital_number = "ABC123"
+        args.address = ["line1", "", nil, "line2", "line3.   "]
+        args.postcode = "TW1 1UU"
+        args.modality = "HD"
+        args.prescriber_name = "Dr X Yz"
+        args.prescription_date = Date.today.to_s
+        args.hospital_name = "THE ROYAL LONDON HOSPITAL"
+        args.hospital_department = ""
+        args.hospital_address = [
+          nil,
+          "WHITECHAPEL",
+          "",
+          "LONDON",
+          "E1 1FR"
+        ]
+        args.no_known_allergies = false
+        args.allergies = ["Nuts", nil, "Penicillin", "Mown grass"]
+        args.administration_frequency = "Daily"
+        args.administration_route = "Per Oral"
+        args.prescription_duration = "1 month"
+        args.administration_device = "device?"
+
+        raise ArgumentError, args.errors unless args.valid?
+      end
+    end
+  end
+end

data/lib/renalware/forms/homecare/pdf.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Renalware::Forms
+  class Homecare::Pdf
+    # Given an Args instance containing a provider (eg :fresenius) and a version (eg 1),
+    # get the document class for e.g. Renalware::Forms::Fresenius::Homecare::Document
+    # and use it to build a new PDF with the data (patient name etc supplied in args)
+    def self.generate(args)
+      raise ArgumentError unless args
+      raise(ArgumentError, "Missing provider") unless args.provider
+      raise(ArgumentError, "Missing provider") if args.provider == ""
+      raise(ArgumentError, "Version must be >0") if args.version.to_i == 0
+
+      provider = args.provider.to_s.capitalize
+      version = "V#{args.version.to_i}"
+      document_klass_name = "#{provider}::Homecare::#{version}::Document"
+      document_klass = Renalware::Forms.const_get(document_klass_name)
+      document_klass.build(args)
+    rescue NameError
+      raise(
+        ArgumentError,
+        "No PDF forms found for provider=#{args.provider} version=#{args.version} "\
+        "trying to resolve Renalware::Forms::#{document_klass_name}"
+      )
+    end
+  end
+end

data/lib/renalware/forms/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Renalware
+  module Forms
+    VERSION = "0.1.0"
+  end
+end

data/lib/tasks/homecare.rake

@@ -0,0 +1,18 @@
+
+require "./lib/renalware/forms"
+require "tempfile"
+
+namespace :forms do
+  namespace :generic do
+    namespace :homecare do
+      include Renalware::Forms::Helpers
+
+      desc "Generate test Generic Homecare Supply PDF V1"
+      task :v1 do
+        args = Renalware::Forms::Homecare::Args.test_data(provider: :generic, version: 1)
+        pdf = Renalware::Forms::Homecare::Pdf.generate(args)
+        render_and_open pdf
+      end
+    end
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1,4 @@
+desc "Starts irb so we can debug the gem"
+task :console do
+  exec "irb -r ./lib/renalware/forms"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: renalware-forms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Airslie Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The home for various forms for external providers e.g. home care prescriptions
+email:
+- dev@aisrlie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/renalware/forms.rb
+- lib/renalware/forms/base.rb
+- lib/renalware/forms/generic.rb
+- lib/renalware/forms/generic/homecare.rb
+- lib/renalware/forms/generic/homecare/v1.rb
+- lib/renalware/forms/generic/homecare/v1/base.rb
+- lib/renalware/forms/generic/homecare/v1/document.rb
+- lib/renalware/forms/helpers.rb
+- lib/renalware/forms/homecare.rb
+- lib/renalware/forms/homecare/args.rb
+- lib/renalware/forms/homecare/pdf.rb
+- lib/renalware/forms/version.rb
+- lib/tasks/homecare.rake
+- lib/tasks/tasks.rake
+homepage: http://airslie.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: PDF library for Renalware forms
+test_files: []