hmrc_ir_mark_calculator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05ea7f0cdf02514c42fe9ba0f8a41522cdc5d51c16966a5aca08859a5c68810f
+  data.tar.gz: 3006f438daec9513327793cc557c99b61b6d213a79c2cf38c537c3a980ad60bf
+SHA512:
+  metadata.gz: 786f1375f000b7c1fc62c589ab2f70c5ad0d7ab1bb129f845a3f8a3106aa0f83bfa74e384f22074c6865d2a7b9ac5bee4980939f3bad39e26af51ba1e5a08a8b
+  data.tar.gz: e3763990cb5c901c41025a4f2b265144d37cf5e231d60f1268650ce6e2e50cc0c321e681c7713542224629efc1a5f0782b30197888a7c3928f300ef36013c79b

data/README.md

@@ -0,0 +1,51 @@
+# Building the project
+
+### Step 1
+
+Compile the Java code into Java class files by running the following in the root of the project directory
+
+`javac -cp 'lib/dependencies/*' java-src/*.java`
+
+### Step 2
+
+Create the build/ directory
+
+`mkdir -p build/uk/gov/hmrc/mark`
+
+### Step 3
+
+Move the class files into the build directory
+`mv java-src/*.class build/uk/gov/hmrc/mark`
+
+### Step 4
+
+Bundle the files into a .jar file
+`cd build/ && jar cfv markcalc.jar uk/gov/hmrc/mark && cd -`
+
+### Step 5
+
+Move the new .jar file into the lib/ directory
+`mv build/markcalc.jar lib/dependencies/`
+
+### Step 6
+
+Delete the build directory
+`rm -rf build/`
+
+### Step 7
+
+Update and add new tests to cover changes
+
+### Step 8
+
+Run specs `rake test`
+
+### Step 9
+
+Bump the version of the gem in the `.gemspec` file
+
+#### Note: All commands must be run in the root of the project
+
+## Dependencies
+
+You will need Java 17.0.1 or later installed.

data/lib/hmrc_ir_mark_calculator/logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# Logging for the calculator
+# Provides an escape hatch to set a custom logger
+# otherwise the default ruby logger will be used
+#
+module IrMarkLogger
+  attr_writer :logger
+
+  def logger
+    @logger ||= Logger.new($stdout).tap do |log|
+      log.progname = name
+    end
+  end
+end

data/lib/hmrc_ir_mark_calculator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'hmrc_ir_mark_calculator/logger'
+
+# A Java wrapper that creates an IRmark from an HMRC submission file
+# It accepts the path to the file, which should contain the same contents
+# being sent to HMRC, inlcuding the GovTalkMessage, and body
+#
+# It needs the absolute path to the Full CT600 File that has been prepared
+# for submission. Providing a relative path may not work as expected.
+class HmrcIrMarkCalculator
+  attr_reader :file_path
+
+  extend IrMarkLogger
+
+  def initialize(file_path)
+    @file_path = file_path
+  end
+
+  def run
+    self.class.logger.info("Using #{cmd} to generate IRmark for file #{file_path}")
+
+    create_mark
+  rescue StandardError => e
+    handle_error(e.message)
+  end
+
+  private
+
+  def create_mark
+    Open3.popen3(cmd) do |_stdin, stdout, stderr, _wait_thr|
+      original_result = stdout.read
+
+      original_result =~ /{(.*)}/
+      result = ::Regexp.last_match(1)
+
+      return handle_success(result) unless result.nil?
+
+      error = stderr&.read
+      return handle_error(error, original_result)
+    end
+  end
+
+  def handle_error(error, original_result = '')
+    self.class.logger.error(
+      "There was an error generating the IRmark for file #{file_path}. #{error} #{original_result}"
+    )
+    { error: error, success: false }
+  end
+
+  def handle_success(result)
+    self.class.logger.info("Output of the IRmark for file #{file_path} is #{result}")
+
+    { result: result, success: true }
+  end
+
+  def cmd
+    "#{change_directory} && #{set_env!} && #{ir_mark}"
+  end
+
+  def set_env!
+    "export CLASSPATH='dependencies/jce-jdk13-114.jar:dependencies/xmlsec-1.4.1.jar:"\
+      "dependencies/xalan_enhanced.jar:dependencies/commons-logging-1.1.1.jar:dependencies/markcalc.jar'"
+  end
+
+  def ir_mark
+    "java uk.gov.hmrc.mark.IRMarkCalculator #{file_path}"
+  end
+
+  def change_directory
+    "cd #{dir}"
+  end
+
+  def dir
+    __dir__
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: hmrc_ir_mark_calculator
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Midorya Izuku
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies: []
+description: IRmark calculator for HMRC Corporate Tax Submissions
+email: midorya@izuku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dependencies/commons-logging-1.1.1.jar
+- lib/dependencies/jce-jdk13-114.jar
+- lib/dependencies/markcalc.jar
+- lib/dependencies/xalan_enhanced.jar
+- lib/dependencies/xmlsec-1.4.1.jar
+- lib/hmrc_ir_mark_calculator.rb
+- lib/hmrc_ir_mark_calculator/logger.rb
+homepage: https://midoryaizuku.com
+licenses: []
+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.4.19
+signing_key:
+specification_version: 4
+summary: IRmark calculator for HMRC Corporate Tax Submissions
+test_files: []