renalware-forms 0.1.11 → 0.1.15

data/lib/renalware/forms.rb

@@ -1,19 +1,15 @@
 # frozen_string_literal: true
 
-require "zeitwerk"
 require "prawn"
 require "prawn/table"
 require "attr_extras"
-require_relative "./forms/version"
-
-# Set up autoloading with zeitwerk
-# As we are nested in lib/renalware/forms, be sure to push an absolute
-# path to the lib folder.
-loader = Zeitwerk::Loader.new
-loader.push_dir File.expand_path("../", __dir__)
-loader.setup
 
 module Renalware
   module Forms
   end
 end
+
+require_relative "forms/base"
+require_relative "forms/helpers"
+require_relative "forms/generic"
+require_relative "forms/homecare"

data/lib/tasks/tasks.rake

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

data/renalware-forms.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "renalware/forms/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "renalware-forms"
+  spec.version     = Renalware::Forms::VERSION
+  spec.authors     = ["Airslie Ltd"]
+  spec.email       = ["dev@aisrlie.com"]
+  spec.homepage    = "http://airslie.com"
+  spec.summary     = "PDF library for Renalware forms"
+  spec.description = "The home for various forms for external providers eg home care prescriptions"
+  spec.license     = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = ["README.md"]
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "attr_extras", "~> 6.2"
+  spec.add_dependency "prawn", "~> 2.2"
+  spec.add_dependency "prawn-table", "~> 0.2"
+  spec.add_dependency "rake"
+  spec.add_dependency "virtus"
+  spec.add_development_dependency "pdf-reader"
+  spec.add_development_dependency "rspec"
+end

data/spec/renalware/forms/args_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Homecare
+  RSpec.describe Args do
+    describe "#patient_name" do
+      subject {
+        hash = default_test_arg_values.update(
+          given_name: "John",
+          family_name: "SMITH",
+          title: title
+        )
+        described_class.new(hash).patient_name
+      }
+
+      context "when title present" do
+        let(:title) { "Mr" }
+
+        it { is_expected.to eq("SMITH, John (Mr)") }
+      end
+
+      context "when title missing" do
+        let(:title) { "" }
+
+        it { is_expected.to eq("SMITH, John") }
+      end
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/allergies_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::Allergies do
+    context "when the patient has iit recoreded that they have no known allergies" do
+      it do
+        hash = default_test_arg_values.update(no_known_allergies: true)
+        args = Renalware::Forms::Homecare::Args.new(hash)
+        doc = test_prawn_doc
+
+        described_class.new(doc, args).build
+
+        text = extract_text_from_prawn_doc(doc)
+        expect(text).to include("No Known Allergies")
+      end
+    end
+
+    it do
+      hash = default_test_arg_values.update(
+        no_known_allergies: false,
+        allergies: %w(nuts penicillin)
+      )
+      args = Renalware::Forms::Homecare::Args.new(hash)
+      doc = test_prawn_doc
+
+      described_class.new(doc, args).build
+
+      text = extract_text_from_prawn_doc(doc)
+
+      expect(text).not_to include("No Known Allergies")
+      expect(text).to include("Known Allergies")
+      expect(text).to include("nuts")
+      expect(text).to include("penicillin")
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/delivery_frequencies_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::DeliveryFrequencies do
+    def extract_pdf_text(args)
+      doc = test_prawn_doc
+      described_class.new(doc, args).build
+      extract_text_from_prawn_doc(doc)
+    end
+
+    it do
+      hash = default_test_arg_values.update(delivery_frequencies: ["Once", "3 weeks", "6 weeks"])
+      args = Renalware::Forms::Homecare::Args.new(hash)
+
+      text = extract_pdf_text(args)
+
+      expect(text).to include("Frequency of deliveries")
+      expect(text).to match(/❏ +Once/)
+      expect(text).to match(/❏ +3 weeks/)
+      expect(text).to match(/❏ +6 weeks/)
+    end
+
+    context "when there are no frequencies supplied" do
+      it "displays the defaults" do
+        args = Renalware::Forms::Homecare::Args.new(**default_test_arg_values)
+
+        text = extract_pdf_text(args)
+
+        expect(text).to match(/Frequency of deliveries/)
+        expect(text).to match(/❏ +3 months/)
+        expect(text).to match(/❏ +6 months/)
+      end
+    end
+
+    context "when there is a selected delivery_frequency" do
+      it "indicates that frequency has been selected by checking a box" do
+        hash = default_test_arg_values.update(
+          delivery_frequencies: ["3 months", "6 months", "12 months"],
+          selected_delivery_frequency: "6 months"
+        )
+        args = Renalware::Forms::Homecare::Args.new(hash)
+
+        text = extract_pdf_text(args)
+
+        expect(text).to match(/❏ +3 months/)
+        expect(text).to match(/■ +6 months/)
+        expect(text).to match(/❏ +12 months/)
+      end
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/heading_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::Heading do
+    it do
+      hash = default_test_arg_values.update(
+        po_number: "P123",
+        hospital_number: "H123",
+        drug_type: "ESA"
+      )
+      args = Renalware::Forms::Homecare::Args.new(hash)
+      doc = test_prawn_doc
+
+      described_class.new(doc, args).build
+
+      text = extract_text_from_prawn_doc(doc)
+
+      expect(text).to include(args.po_number)
+      expect(text).to include(args.hospital_number)
+      expect(text).to include(args.drug_type)
+      expect(text).to include("Home Delivery Medication List")
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/mediations_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::Medications do
+    it do
+      args = Renalware::Forms::Homecare::Args.new(**default_test_arg_values)
+      args.medications << Renalware::Forms::Homecare::Args::Medication.new(
+        date: "2020-01-01",
+        drug: "Drug1",
+        dose: "Dose1",
+        route: "Route1",
+        frequency: "Freq1"
+      )
+      args.medications << Renalware::Forms::Homecare::Args::Medication.new(
+        date: "2020-02-02",
+        drug: "Drug2",
+        dose: "Dose2",
+        route: "Route2",
+        frequency: "Freq2"
+      )
+      doc = test_prawn_doc
+
+      described_class.new(doc, args).build
+
+      text = extract_text_from_prawn_doc(doc)
+
+      expect(text).to include("2020-01-01")
+      expect(text).to include("Drug1")
+      expect(text).to include("Dose1")
+      expect(text).to include("Route1")
+      expect(text).to include("Freq1")
+      expect(text).to include("Drug2")
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/patient_details_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::PatientDetails do
+    it do
+      hash = default_test_arg_values.update(
+        given_name: "John",
+        family_name: "SMITH",
+        title: "Mr",
+        modality: "HD",
+        born_on: "2001-01-01",
+        nhs_number: "0123456789",
+        hospital_number: "X123",
+        address: %w(aa bb cc),
+        postcode: "POSTCODE"
+      )
+      args = Renalware::Forms::Homecare::Args.new(hash)
+      doc = test_prawn_doc
+
+      described_class.new(doc, args).build
+
+      text = extract_text_from_prawn_doc(doc)
+
+      expect(text).to include("SMITH, John (Mr)")
+      expect(text).to include("HD")
+      expect(text).to include("2001-01-01")
+      expect(text).to include("0123456789")
+      expect(text).to include("X123")
+      expect(text).to include("aa")
+      expect(text).to include("bb")
+      expect(text).to include("cc")
+      expect(text).to include("POSTCODE")
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/prescription_durations_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::PrescriptionDurations do
+    def extract_pdf_text(args)
+      doc = test_prawn_doc
+      described_class.new(doc, args).build
+      extract_text_from_prawn_doc(doc)
+    end
+
+    it do
+      hash = default_test_arg_values.update(
+        prescription_durations: ["3 months", "6 months", "12 months"]
+      )
+      args = Renalware::Forms::Homecare::Args.new(hash)
+
+      text = extract_pdf_text(args)
+
+      expect(text).to include("Repeat prescription for")
+      expect(text).to match(/❏ +3 months/)
+      expect(text).to match(/❏ +6 months/)
+      expect(text).to match(/❏ +12 months/)
+    end
+
+    it "works where there are no prescription_durations supplied" do
+      args = Renalware::Forms::Homecare::Args.new(default_test_arg_values)
+
+      text = extract_pdf_text(args)
+
+      expect(text).to include("Repeat prescription for")
+    end
+
+    context "when there is a selected prescription_duration" do
+      it "indicates that duration has been selected eg for checking a box" do
+        args = Renalware::Forms::Homecare::Args.new(
+          default_test_arg_values.update(
+            prescription_durations: ["3 months", "6 months", "12 months"],
+            selected_prescription_duration: "6 months"
+          )
+        )
+
+        text = extract_pdf_text(args)
+
+        expect(text).to match(/❏ +3 months/)
+        expect(text).to match(/■ +6 months/)
+        expect(text).to match(/❏ +12 months/)
+      end
+    end
+  end
+end

data/spec/renalware/forms/homecare/generic/v1/signoff_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Renalware::Forms::Generic
+  RSpec.describe Homecare::V1::Signoff do
+    it do
+      args = Renalware::Forms::Homecare::Args.new(
+        **default_test_arg_values.update(consultant: "Dr Pepper")
+      )
+      doc = test_prawn_doc
+
+      described_class.new(doc, args).build
+
+      text = extract_text_from_prawn_doc(doc)
+      expect(text).to include("Dr Pepper")
+    end
+  end
+end

data/spec/renalware/forms/homecare/pdf_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Renalware::Forms::Homecare::Pdf do
+  describe "#generate" do
+    # describe "argument validation" do
+    # it "throws an error if args is nil" do
+    #   expect { described_class.generate(nil) }.to raise_error(ArgumentError)
+    # end
+
+    # it "throws an error if arg.provider is nil" do
+    #   args = Renalware::Forms::Homecare::Args.new(provider: nil)
+
+    #   expect {
+    #     described_class.generate(args)
+    #   }.to raise_error(ArgumentError, "Missing provider")
+    # end
+
+    # it "throws an error if arg.provider is an empty string" do
+    #   args = Renalware::Forms::Homecare::Args.new(provider: "")
+
+    #   expect {
+    #     described_class.generate(args)
+    #   }.to raise_error(ArgumentError, "Missing provider")
+    # end
+
+    # it "throws an error if arg.version is not a number" do
+    #   args = Renalware::Forms::Homecare::Args.new(provider: :a, version: nil)
+
+    #   expect {
+    #     described_class.generate(args)
+    #   }.to raise_error(ArgumentError, "Version must be >0")
+    # end
+
+    # it "throws an error no matching provider found" do
+    #   args = Renalware::Forms::Homecare::Args.new(provider: :generico, version: 1)
+
+    #   expect {
+    #     described_class.generate(args)
+    #   }.to raise_error(
+    #     ArgumentError,
+    #     "No PDF forms found for provider=generico version=1 "\
+    #     "trying to resolve Renalware::Forms::Generico::Homecare::V1::Document"
+    #   )
+    # end
+
+    # it "throws an error no matching version found" do
+    #   args = Renalware::Forms::Homecare::Args.new(provider: :generic, version: 1000)
+
+    #   expect {
+    #     described_class.generate(args)
+    #   }.to raise_error(
+    #     ArgumentError,
+    #     "No PDF forms found for provider=generic version=1000 "\
+    #     "trying to resolve Renalware::Forms::Generic::Homecare::V1000::Document"
+    #   )
+    # end
+    # end
+
+    context "when arguments are valid" do
+      it "create render a PDF for a Generic::Homecare::V1::Document" do
+        args = Renalware::Forms::Homecare::Args.new(**default_test_arg_values)
+
+        pdf_data = described_class.generate(args).render
+
+        expect(pdf_data).to start_with("%PDF-")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+
+require "simplecov"
+SimpleCov.start
+
+require "tempfile"
+require "pdf-reader"
+require "./lib/renalware/forms"
+
+def pdf_reader_from(prawn_doc)
+  file = Tempfile.new("pdf")
+  prawn_doc.render_file file
+  PDF::Reader.new(file)
+end
+
+def test_prawn_doc
+  Prawn::Document.new(
+    page_size: "A4",
+    page_layout: :portrait,
+    margin: 15
+  )
+end
+
+def default_test_arg_values
+  {
+    provider: :generic,
+    version: 1,
+    modality: "HD",
+    telephone: "",
+    hospital_number: nil,
+    nhs_number: nil,
+    consultant: nil,
+    postcode: nil,
+    hospital_department: nil,
+    hospital_telephone: nil,
+    prescriber_name: nil,
+    po_number: "134",
+    administration_device: nil,
+    given_name: "John",
+    family_name: "SMITH",
+    title: "Mr",
+    no_known_allergies: true,
+    allergies: [],
+    drug_type: :esa,
+    born_on: "2019-01-01",
+    prescription_date: "2019-01-01"
+  }.dup
+end
+
+def extract_text_from_prawn_doc(doc)
+  pdf_reader_from(doc).pages.map(&:text).join
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renalware-forms
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.15
 platform: ruby
 authors:
 - Airslie Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-types
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,35 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-struct
-  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: zeitwerk
-  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: rspec
+  name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pdf-reader
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,16 +122,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The home for various forms for external providers e.g. home care prescriptions
+description: The home for various forms for external providers eg home care prescriptions
 email:
 - dev@aisrlie.com
-executables: []
+executables:
+- rspec
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".semaphore/semaphore.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
+- bin/rspec
+- default.yml
 - lib/renalware/forms.rb
 - lib/renalware/forms/base.rb
 - lib/renalware/forms/generic.rb
@@ -183,6 +167,17 @@ files:
 - lib/renalware/forms/version.rb
 - lib/tasks/homecare.rake
 - lib/tasks/tasks.rake
+- renalware-forms.gemspec
+- spec/renalware/forms/args_spec.rb
+- spec/renalware/forms/homecare/generic/v1/allergies_spec.rb
+- spec/renalware/forms/homecare/generic/v1/delivery_frequencies_spec.rb
+- spec/renalware/forms/homecare/generic/v1/heading_spec.rb
+- spec/renalware/forms/homecare/generic/v1/mediations_spec.rb
+- spec/renalware/forms/homecare/generic/v1/patient_details_spec.rb
+- spec/renalware/forms/homecare/generic/v1/prescription_durations_spec.rb
+- spec/renalware/forms/homecare/generic/v1/signoff_spec.rb
+- spec/renalware/forms/homecare/pdf_spec.rb
+- spec/spec_helper.rb
 homepage: http://airslie.com
 licenses:
 - MIT
@@ -195,14 +190,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: PDF library for Renalware forms