companies_house_hub 0.0.2 → 0.0.3

data/lib/companies_house_hub.rb

@@ -29,4 +29,12 @@ module CompaniesHouseHub
   def configure
     yield configuration
   end
+
+  def root
+    File.expand_path('../', __dir__)
+  end
+
+  def load_yml(name)
+    YAML.load_file(File.join(root, 'data', "#{name}.yml"))
+  end
 end

data/lib/companies_house_hub/filing_history_formatter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module CompaniesHouseHub
+  class FilingHistoryFormatter
+    def initialize(filing_history)
+      @filing_history = filing_history
+    end
+
+    def formatted(format = 'pdf')
+      name = descriptions[@filing_history.description]
+      name = name.downcase
+
+      # If "made_up_date" exists then replace it with the filing date and don't include filing.date
+      # in the file name (made_up_date will be used).
+      if name.match?(/{.*}/)
+        name = replace_placeholders(name)
+        date = nil
+      end
+
+      cleanup(name)
+
+      [name, date].compact.join('-') << ".#{format}"
+    end
+
+    private
+
+    def descriptions
+      CompaniesHouseHub.load_yml('filing_history_descriptions')['description']
+    end
+
+    def cleanup(name)
+      name.tr!('*', '')
+      name.tr!("\s", '-')
+    end
+
+    # Replaces the placeholders in yaml descriptions with what we get from Companies House (and is
+    # stored in FilingHistory#description_values).
+    def replace_placeholders(text)
+      matches = text.scan(/\{([a-z_]+)\}/).flatten
+
+      return text unless matches.any?
+
+      replaced = text.dup
+
+      matches.each do |match|
+        value = @filing_history.description_values[match.to_sym]
+        replaced.sub!(/{#{match}}/, value)
+      end
+
+      replaced
+    end
+  end
+end

data/lib/companies_house_hub/models/filing_history.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require 'companies_house_hub/filing_history_formatter'
+
 module CompaniesHouseHub
   class FilingHistory < BaseModel
     DOCUMENT_URL = 'https://beta.companieshouse.gov.uk'
     FIND_PATH = '/company/:company_number/filing-history'
     DEFAULT_PER_PAGE = 100
 
-    attr_reader :description, :action_date, :date, :type, :barcode, :links
+    attr_reader :description, :action_date, :date, :type, :barcode, :links, :description_values
 
     def self.all(options = {})
       options[:items_per_page] ||= DEFAULT_PER_PAGE
@@ -25,6 +27,11 @@ module CompaniesHouseHub
       @type = json.dig(:type)
       @barcode = json.dig(:barcode)
       @links = json.dig(:links)
+      @description_values = json.dig(:description_values)
+    end
+
+    def formatted_name
+      FilingHistoryFormatter.new(self).formatted
     end
 
     def url(format = 'pdf')

data/lib/companies_house_hub/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompaniesHouseHub
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: companies_house_hub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ricardo Otero
@@ -123,9 +123,11 @@ files:
 - Rakefile
 - bin/console
 - companies_house_hub.gemspec
+- data/filing_history_descriptions.yml
 - lib/companies_house_hub.rb
 - lib/companies_house_hub/base_model.rb
 - lib/companies_house_hub/configuration.rb
+- lib/companies_house_hub/filing_history_formatter.rb
 - lib/companies_house_hub/models/address.rb
 - lib/companies_house_hub/models/company.rb
 - lib/companies_house_hub/models/filing_history.rb