atdis 0.3.13 → 0.4.0

data/lib/atdis/models/address.rb

@@ -1,17 +1,23 @@
+# frozen_string_literal: true
+
 module ATDIS
   module Models
     class Address < Model
-      set_field_mappings ({
+      field_mappings(
         street: String,
         suburb: String,
         postcode: String,
         state: String
-      })
+      )
 
       # Mandatory parameters
-      validates :street, :suburb, :postcode, :state, presence_before_type_cast: {spec_section: "4.3.3"}
+      validates :street, :suburb, :postcode, :state,
+                presence_before_type_cast: { spec_section: "4.3.3" }
 
-      validates :postcode, format: { with: /\A[0-9]{4}\z/, message: ATDIS::ErrorMessage.new("is not a valid postcode", "4.3.3")}
+      validates :postcode, format: {
+        with: /\A[0-9]{4}\z/,
+        message: ATDIS::ErrorMessage.new("is not a valid postcode", "4.3.3")
+      }
     end
   end
 end

data/lib/atdis/models/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "atdis/models/info"
 require "atdis/models/reference"
 require "atdis/models/location"
@@ -8,21 +10,22 @@ require "atdis/models/person"
 module ATDIS
   module Models
     class Application < Model
-      set_field_mappings ({
-        info:      Info,
+      field_mappings(
+        info: Info,
         reference: Reference,
         locations: Location,
-        events:    Event,
+        events: Event,
         documents: Document,
-        people:    Person,
-        extended:  Object,
-      })
+        people: Person,
+        extended: Object
+      )
 
       # Mandatory attributes
-      validates :info, :reference, :locations, :events, :documents, presence_before_type_cast: {spec_section: "4.3"}
+      validates :info, :reference, :locations, :events, :documents,
+                presence_before_type_cast: { spec_section: "4.3" }
 
-      validates :people, array: {spec_section: "4.3"}
-      validates :locations, :events, filled_array: {spec_section: "4.3"}
+      validates :people, array: { spec_section: "4.3" }
+      validates :locations, :events, filled_array: { spec_section: "4.3" }
 
       # This model is only valid if the children are valid
       validates :info, :reference, :locations, :events, :documents, :people, valid: true

data/lib/atdis/models/authority.rb

@@ -1,19 +1,24 @@
+# frozen_string_literal: true
+
 module ATDIS
   module Models
     class Authority < Model
-      set_field_mappings ({
-        ref:  URI,
+      field_mappings(
+        ref: URI,
         name: String
-      })
+      )
 
       # ref is a "Unique Authority Identifier" and should have the form http://www.council.nsw.gov.au/atdis/1.0
       # It should also be consistent for each council.
 
       # Mandatory attributes
-      validates :ref, :name, presence_before_type_cast: {spec_section: "4.3.1"}
+      validates :ref, :name, presence_before_type_cast: { spec_section: "4.3.1" }
 
-      validates :ref, http_url: {spec_section: "4.3.1"}
-      validates :ref, format: { with: /atdis\/1.0\z/, message: ATDIS::ErrorMessage.new("is not a valid Unique Authority Identifier", "4.3.1")}
+      validates :ref, http_url: { spec_section: "4.3.1" }
+      validates :ref, format: {
+        with: %r{atdis\/1.0\z},
+        message: ATDIS::ErrorMessage.new("is not a valid Unique Authority Identifier", "4.3.1")
+      }
     end
   end
 end

data/lib/atdis/models/document.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module ATDIS
   module Models
     class Document < Model
-      set_field_mappings ({
-        ref:          String,
-        title:        String,
+      field_mappings(
+        ref: String,
+        title: String,
         document_url: URI
-      })
+      )
 
       # Mandatory parameters
-      validates :ref, :title, :document_url, presence_before_type_cast: {spec_section: "4.3.5"}
+      validates :ref, :title, :document_url, presence_before_type_cast: { spec_section: "4.3.5" }
       # Other validations
-      validates :document_url, http_url: {spec_section: "4.3.5"}
+      validates :document_url, http_url: { spec_section: "4.3.5" }
     end
   end
 end

data/lib/atdis/models/event.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module ATDIS
   module Models
     class Event < Model
-      set_field_mappings ({
-        id:          String,
-        timestamp:   DateTime,
+      field_mappings(
+        id: String,
+        timestamp: DateTime,
         description: String,
-        event_type:  String,
-        status:      String
-      })
+        event_type: String,
+        status: String
+      )
 
       # Mandatory parameters
-      validates :id, :timestamp, :description, presence_before_type_cast: {spec_section: "4.3.4"}
+      validates :id, :timestamp, :description, presence_before_type_cast: { spec_section: "4.3.4" }
 
-      validates :timestamp, date_time: {spec_section: "4.3.8"}
+      validates :timestamp, date_time: { spec_section: "4.3.8" }
     end
   end
 end

data/lib/atdis/models/info.rb

@@ -1,91 +1,115 @@
+# frozen_string_literal: true
+
 require "atdis/models/authority"
 
 module ATDIS
   module Models
     class Info < Model
-      set_field_mappings ({
-        dat_id:                  String,
-        development_type:        String,
-        application_type:        String,
-        last_modified_date:      DateTime,
-        description:             String,
-        authority:               Authority,
-        lodgement_date:          DateTime,
-        determination_date:      DateTime,
-        determination_type:      String,
-        status:                  String,
+      field_mappings(
+        dat_id: String,
+        development_type: String,
+        application_type: String,
+        last_modified_date: DateTime,
+        description: String,
+        authority: Authority,
+        lodgement_date: DateTime,
+        determination_date: DateTime,
+        determination_type: String,
+        status: String,
         notification_start_date: DateTime,
-        notification_end_date:   DateTime,
-        officer:                 String,
-        estimated_cost:          String,
-        related_apps:            URI
-      })
+        notification_end_date: DateTime,
+        officer: String,
+        estimated_cost: String,
+        related_apps: URI
+      )
 
       # Mandatory parameters
       # determination_date is not in this list because even though it is mandatory
       # it can be null if there is no value
       validates :dat_id, :development_type, :last_modified_date, :description,
-        :authority, :lodgement_date, :status,
-        presence_before_type_cast: {spec_section: "4.3.1"}
+                :authority, :lodgement_date, :status,
+                presence_before_type_cast: { spec_section: "4.3.1" }
       # Other validations
-      validates :application_type, inclusion: { in: [
-        "DA", "CDC", "S96", "Review", "Appeal", "Other"
-        ],
-        message: ATDIS::ErrorMessage.new("does not have one of the allowed types", "4.3.1")}
+      validates :application_type,
+                inclusion: {
+                  in: %w[DA CDC S96 Review Appeal Other],
+                  message: ATDIS::ErrorMessage.new(
+                    "does not have one of the allowed types",
+                    "4.3.1"
+                  )
+                }
       validates :last_modified_date, :lodgement_date, :determination_date,
-        :notification_start_date, :notification_end_date,
-        date_time: {spec_section: "4.3.1"}
+                :notification_start_date, :notification_end_date,
+                date_time: { spec_section: "4.3.1" }
       # We don't need to separately validate presence because this covers it
-      validates :determination_type, inclusion: { in: [
-        "Pending", "Refused by Council", "Refused under delegation", "Withdrawn",
-        "Approved by Council", "Approved under delegation", "Rejected"
-        ],
-        message: ATDIS::ErrorMessage.new("does not have one of the allowed types", "4.3.1")
-      }
+      validates :determination_type,
+                inclusion: {
+                  in: [
+                    "Pending", "Refused by Council", "Refused under delegation", "Withdrawn",
+                    "Approved by Council", "Approved under delegation", "Rejected"
+                  ],
+                  message: ATDIS::ErrorMessage.new(
+                    "does not have one of the allowed types",
+                    "4.3.1"
+                  )
+                }
       validate :notification_dates_consistent!
-      validates :related_apps, array: {spec_section: "4.3.1"}
-      validates :related_apps, array_http_url: {spec_section: "4.3.1"}
+      validates :related_apps, array: { spec_section: "4.3.1" }
+      validates :related_apps, array_http_url: { spec_section: "4.3.1" }
       validate :related_apps_url_format
       validate :dat_id_is_url_encoded!
 
       # This model is only valid if the children are valid
       validates :authority, valid: true
 
-      # TODO Validate contents of estimated_cost
+      # TODO: Validate contents of estimated_cost
 
       def dat_id_is_url_encoded!
-        if dat_id && !Info.url_encoded?(dat_id)
-          errors.add(:dat_id, ErrorMessage.new("should be url encoded", "4.3.1"))
-        end
+        return unless dat_id && !Info.url_encoded?(dat_id)
+
+        errors.add(:dat_id, ErrorMessage.new("should be url encoded", "4.3.1"))
       end
 
-      def self.url_encoded?(s)
+      def self.url_encoded?(str)
         url_encoded = true
-        s.each_char do |c|
+        str.each_char do |c|
           # These characters are the valid ones in a url encoded string
-          unless c =~ /[a-zA-Z0-9\-_.~%+]/
-            url_encoded = false
-          end
+          url_encoded = false unless c =~ /[a-zA-Z0-9\-_.~%+]/
         end
         url_encoded
       end
 
       def related_apps_url_format
-        if related_apps.respond_to?(:all?) && !related_apps.all? {|url| url.to_s =~ /atdis\/1.0\/[^\/]+\.json/}
-          errors.add(:related_apps, ErrorMessage.new("contains url(s) not in the expected format", "4.3.1"))
-        end
+        return unless related_apps.respond_to?(:all?) &&
+                      !related_apps.all? { |url| url.to_s =~ %r{atdis\/1.0\/[^\/]+\.json} }
+
+        errors.add(
+          :related_apps,
+          ErrorMessage.new("contains url(s) not in the expected format", "4.3.1")
+        )
       end
 
       def notification_dates_consistent!
         if notification_start_date_before_type_cast && notification_end_date_before_type_cast.blank?
-          errors.add(:notification_end_date, ErrorMessage["can not be blank if notification_start_date is set", "4.3.1"])
+          errors.add(
+            :notification_end_date,
+            ErrorMessage["can not be blank if notification_start_date is set", "4.3.1"]
+          )
         end
         if notification_start_date_before_type_cast.blank? && notification_end_date_before_type_cast
-          errors.add(:notification_start_date, ErrorMessage["can not be blank if notification_end_date is set", "4.3.1"])
-        end
-        if notification_start_date && notification_end_date && notification_start_date > notification_end_date
-          errors.add(:notification_end_date, ErrorMessage["can not be earlier than notification_start_date", "4.3.1"])
+          errors.add(
+            :notification_start_date,
+            ErrorMessage["can not be blank if notification_end_date is set", "4.3.1"]
+          )
         end
+        return unless notification_start_date &&
+                      notification_end_date &&
+                      notification_start_date > notification_end_date
+
+        errors.add(
+          :notification_end_date,
+          ErrorMessage["can not be earlier than notification_start_date", "4.3.1"]
+        )
       end
     end
   end

data/lib/atdis/models/land_title_ref.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require "atdis/models/torrens_title"
 
 module ATDIS
   module Models
     class LandTitleRef < Model
-      set_field_mappings ({
+      field_mappings(
         torrens: TorrensTitle,
-        other:   Hash
-      })
+        other: Hash
+      )
 
       # This model is only valid if the children are valid
       validates :torrens, valid: true
@@ -15,11 +17,17 @@ module ATDIS
 
       def check_title_presence
         if torrens.nil? && other.nil?
-          errors.add(:torrens, ATDIS::ErrorMessage.new("or other needs be present", "4.3.3"))
-        end
-        if torrens && other
-          errors.add(:torrens, ATDIS::ErrorMessage.new("and other can't both be present", "4.3.3"))
+          errors.add(
+            :torrens,
+            ATDIS::ErrorMessage.new("or other needs be present", "4.3.3")
+          )
         end
+        return unless torrens && other
+
+        errors.add(
+          :torrens,
+          ATDIS::ErrorMessage.new("and other can't both be present", "4.3.3")
+        )
       end
     end
   end

data/lib/atdis/models/location.rb

@@ -1,20 +1,22 @@
-require 'atdis/models/address'
+# frozen_string_literal: true
+
+require "atdis/models/address"
 require "atdis/models/land_title_ref"
 require "rgeo/geo_json"
 
 module ATDIS
   module Models
     class Location < Model
-      set_field_mappings ({
-        address:        Address,
+      field_mappings(
+        address: Address,
         land_title_ref: LandTitleRef,
-        geometry:       RGeo::GeoJSON
-      })
+        geometry: RGeo::GeoJSON
+      )
 
       # Mandatory parameters
-      validates :address, :land_title_ref, presence_before_type_cast: {spec_section: "4.3.3"}
+      validates :address, :land_title_ref, presence_before_type_cast: { spec_section: "4.3.3" }
 
-      validates :geometry, geo_json: {spec_section: "4.3.3"}
+      validates :geometry, geo_json: { spec_section: "4.3.3" }
 
       # This model is only valid if the children are valid
       validates :address, :land_title_ref, valid: true

data/lib/atdis/models/page.rb

@@ -1,19 +1,22 @@
+# frozen_string_literal: true
+
 require "atdis/models/response"
 require "atdis/models/pagination"
 
 module ATDIS
   module Models
     class Page < Model
-      set_field_mappings ({
-        response:   Response,
-        count:      Fixnum,
-        pagination: Pagination,
-      })
+      field_mappings(
+        response: Response,
+        count: Integer,
+        pagination: Pagination
+      )
 
       # Mandatory parameters
-      validates :response, presence_before_type_cast: {spec_section: "4.3"}
-      # section 6.5 is not explicitly about this but it does contain an example which should be helpful
-      validates :response, array: {spec_section: "6.4"}
+      validates :response, presence_before_type_cast: { spec_section: "4.3" }
+      # section 6.5 is not explicitly about this but it does contain an example
+      # which should be helpful
+      validates :response, array: { spec_section: "6.4" }
       validate :count_is_consistent, :all_pagination_is_present
 
       # This model is only valid if the children are valid
@@ -22,30 +25,42 @@ module ATDIS
 
       # If some of the pagination fields are present all of the required ones should be present
       def all_pagination_is_present
-        if pagination && count.nil?
-          errors.add(:count, ErrorMessage["should be present if pagination is being used", "6.4"])
-        end
+        return unless pagination && count.nil?
+
+        errors.add(:count, ErrorMessage["should be present if pagination is being used", "6.4"])
       end
 
       def count_is_consistent
-        if count
-          if response.respond_to?(:count)
-            errors.add(:count, ErrorMessage["is not the same as the number of applications returned", "6.4"]) if count != response.count
-          end
-          if pagination.respond_to?(:per_page) && pagination.per_page
-            errors.add(:count, ErrorMessage["should not be larger than the number of results per page", "6.4"]) if count > pagination.per_page
+        return if count.nil?
+
+        if response.respond_to?(:count)
+          if count != response.count
+            errors.add(
+              :count,
+              ErrorMessage["is not the same as the number of applications returned", "6.4"]
+            )
           end
         end
+        return unless pagination.respond_to?(:per_page) && pagination.per_page
+
+        return unless count > pagination.per_page
+
+        errors.add(
+          :count,
+          ErrorMessage["should not be larger than the number of results per page", "6.4"]
+        )
       end
 
       def previous_url
         raise "Can't use previous_url when loaded with read_json" if url.nil?
-        ATDIS::SeparatedURL.merge(url, page: pagination.previous) if pagination && pagination.previous
+
+        ATDIS::SeparatedURL.merge(url, page: pagination.previous) if pagination&.previous
       end
 
       def next_url
         raise "Can't use next_url when loaded with read_json" if url.nil?
-        ATDIS::SeparatedURL.merge(url, page: pagination.next) if pagination && pagination.next
+
+        ATDIS::SeparatedURL.merge(url, page: pagination.next) if pagination&.next
       end
 
       def previous_page