metal_archives 2.2.0 → 2.2.3

data/lib/metal_archives/parsers/label.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'nokogiri'
+require "date"
+require "nokogiri"
 
 module MetalArchives
   module Parsers
@@ -18,46 +18,46 @@ module MetalArchives
           props = {}
           doc = Nokogiri::HTML(response)
 
-          props[:name] = doc.css('#label_info .label_name').first.content
+          props[:name] = doc.css("#label_info .label_name").first.content
 
           props[:contact] = []
-          doc.css('#label_contact a').each do |contact|
+          doc.css("#label_contact a").each do |contact|
             props[:contact] << {
-              :title => contact.content,
-              :content => contact.attr(:href)
+              title: contact.content,
+              content: contact.attr(:href),
             }
           end
 
-          doc.css('#label_info dl').each do |dl|
-            dl.search('dt').each do |dt|
+          doc.css("#label_info dl").each do |dl|
+            dl.search("dt").each do |dt|
               content = sanitize(dt.next_element.content)
 
-              next if content == 'N/A'
+              next if content == "N/A"
 
               case sanitize(dt.content)
-              when 'Address:'
+              when "Address:"
                 props[:address] = content
-              when 'Country:'
-                props[:country] = ParserHelper.parse_country css('a').first.content
-              when 'Phone number:'
+              when "Country:"
+                props[:country] = ParserHelper.parse_country css("a").first.content
+              when "Phone number:"
                 props[:phone] = content
-              when 'Status:'
-                props[:status] = content.downcase.tr(' ', '_').to_sym
-              when 'Specialised in:'
+              when "Status:"
+                props[:status] = content.downcase.tr(" ", "_").to_sym
+              when "Specialised in:"
                 props[:specializations] = ParserHelper.parse_genre content
-              when 'Founding date :'
+              when "Founding date :"
                 begin
                   dof = Date.parse content
                   props[:date_founded] = NilDate.new dof.year, dof.month, dof.day
                 rescue ArgumentError => e
                   props[:date_founded] = NilDate.parse content
                 end
-              when 'Sub-labels:'
+              when "Sub-labels:"
                 # TODO
-              when 'Online shopping:'
-                if content == 'Yes'
+              when "Online shopping:"
+                if content == "Yes"
                   props[:online_shopping] = true
-                elsif content == 'No'
+                elsif content == "No"
                   props[:online_shopping] = false
                 end
               else

data/lib/metal_archives/parsers/parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'countries'
+require "date"
+require "countries"
 
 module MetalArchives
   ##
@@ -28,7 +28,7 @@ module MetalArchives
         # Return +String+
         #
         def sanitize(input)
-          input.gsub(/^"/, '').gsub(/"$/, '').strip
+          input.gsub(/^"/, "").gsub(/"$/, "").strip
         end
 
         ##
@@ -48,7 +48,7 @@ module MetalArchives
         def parse_genre(input)
           genres = []
           # Split fields
-          input.split(',').each do |genre|
+          input.split(",").each do |genre|
             ##
             # Start with a single empty genre string. Split the genre by spaces
             # and process each component. If a component does not have a slash,
@@ -63,14 +63,14 @@ module MetalArchives
             #                                       'Traditional Heavy', 'Traditional Power',
             #                                       'Classical Heavy', 'Classical Power']
             #
-            temp = ['']
-            genre.downcase.split.reject { |g| ['(early)', '(later)', 'metal'].include? g }.each do |g|
-              if g.include? '/'
+            temp = [""]
+            genre.downcase.split.reject { |g| ["(early)", "(later)", "metal"].include? g }.each do |g|
+              if g.include? "/"
                 # Duplicate all WIP genres
                 temp2 = temp.dup
 
                 # Assign first and last components to temp and temp2 respectively
-                split = g.split '/'
+                split = g.split "/"
                 temp.map! { |t| t.empty? ? split.first.capitalize : "#{t.capitalize} #{split.first.capitalize}" }
                 temp2.map! { |t| t.empty? ? split.last.capitalize : "#{t.capitalize} #{split.last.capitalize}" }
 
@@ -84,6 +84,21 @@ module MetalArchives
           end
           genres.uniq
         end
+
+        ##
+        # Parse year range
+        #
+        def parse_year_range(input)
+          r = input.split("-")
+          date_start = (r.first == "?" ? nil : NilDate.new(r.first.to_i))
+          date_end = if r.length > 1
+                       (r.last == "?" || r.last == "present" ? nil : NilDate.new(r.last.to_i))
+                     else
+                       date_start.dup
+                     end
+
+          MetalArchives::Range.new date_start, date_end
+        end
       end
     end
   end

data/lib/metal_archives/parsers/release.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'date'
+require "json"
+require "date"
 
 module MetalArchives
   module Parsers
@@ -11,52 +11,56 @@ module MetalArchives
     class Release < Parser # :nodoc:
       class << self
         TYPE_TO_QUERY = {
-          :full_length => 1,
-          :live => 2,
-          :demo => 3,
-          :single => 4,
-          :ep => 5,
-          :video => 6,
-          :boxed_set => 7,
-          :split => 8,
-          :compilation => 10,
-          :split_video => 12,
-          :collaboration => 13
+          full_length: 1,
+          live: 2,
+          demo: 3,
+          single: 4,
+          ep: 5,
+          video: 6,
+          boxed_set: 7,
+          split: 8,
+          compilation: 10,
+          split_video: 12,
+          collaboration: 13,
         }.freeze
 
         TYPE_TO_SYM = {
-          'Full-length' => :full_length,
-          'Live album' => :live,
-          'Demo' => :demo,
-          'Single' => :single,
-          'EP' => :ep,
-          'Video' => :video,
-          'Boxed set' => :boxed_set,
-          'Split' => :split,
-          'Compilation' => :compilation,
-          'Split video' => :split_video,
-          'Collaboration' => :collaboration
+          "Full-length" => :full_length,
+          "Live album" => :live,
+          "Demo" => :demo,
+          "Single" => :single,
+          "EP" => :ep,
+          "Video" => :video,
+          "Boxed set" => :boxed_set,
+          "Split" => :split,
+          "Compilation" => :compilation,
+          "Split video" => :split_video,
+          "Collaboration" => :collaboration,
         }.freeze
 
         FORMAT_TO_QUERY = {
-          :cd => 'CD',
-          :cassette => 'Cassette',
-          :vinyl => 'Vinyl*',
-          :vhs => 'VHS',
-          :dvd => 'DVD',
-          :digital => 'Digital',
-          :blu_ray => 'Blu-ray*',
-          :other => 'Other'
+          cd: "CD",
+          cassette: "Cassette",
+          vinyl: "Vinyl*",
+          vhs: "VHS",
+          dvd: "DVD",
+          "2dvd": "2DVD",
+          digital: "Digital",
+          blu_ray: "Blu-ray*",
+          other: "Other",
+          unknown: "Unknown",
         }.freeze
 
         FORMAT_TO_SYM = {
-          'CD' => :cd,
-          'Cassette' => :cassette,
-          'VHS' => :vhs,
-          'DVD' => :dvd,
-          'Digital' => :digital,
-          'Other' => :other
-        }
+          "CD" => :cd,
+          "Cassette" => :cassette,
+          "VHS" => :vhs,
+          "DVD" => :dvd,
+          "2DVD" => :"2dvd",
+          "Digital" => :digital,
+          "Other" => :other,
+          "Unknown" => :unknown,
+        }.freeze
 
         ##
         # Map attributes to MA attributes
@@ -68,23 +72,23 @@ module MetalArchives
         #
         def map_params(query)
           params = {
-            :bandName => query[:band_name] || '',
-            :releaseTitle => query[:title] || '',
-            :releaseYearFrom => query[:from_year] || '',
-            :releaseMonthFrom => query[:from_month] || '',
-            :releaseYearTo => query[:to_year] || '',
-            :releaseMonthTo => query[:to_month] || '',
-            :country => map_countries(query[:country]) || '',
-            :location => query[:location] || '',
-            :releaseLabelName => query[:label_name] || '',
-            :releaseCatalogNumber => query[:catalog_id] || '',
-            :releaseIdentifiers => query[:identifier] || '',
-            :releaseRecordingInfo => query[:recording_info] || '',
-            :releaseDescription => query[:version_description] || '',
-            :releaseNotes => query[:notes] || '',
-            :genre => query[:genre] || '',
-            :releaseType => map_types(query[:types]),
-            :releaseFormat => map_formats(query[:formats])
+            bandName: query[:band_name] || "",
+            releaseTitle: query[:title] || "",
+            releaseYearFrom: query[:from_year] || "",
+            releaseMonthFrom: query[:from_month] || "",
+            releaseYearTo: query[:to_year] || "",
+            releaseMonthTo: query[:to_month] || "",
+            country: map_countries(query[:country]) || "",
+            location: query[:location] || "",
+            releaseLabelName: query[:label_name] || "",
+            releaseCatalogNumber: query[:catalog_id] || "",
+            releaseIdentifiers: query[:identifier] || "",
+            releaseRecordingInfo: query[:recording_info] || "",
+            releaseDescription: query[:version_description] || "",
+            releaseNotes: query[:notes] || "",
+            genre: query[:genre] || "",
+            releaseType: map_types(query[:types]),
+            releaseFormat: map_formats(query[:formats]),
           }
 
           params
@@ -102,38 +106,38 @@ module MetalArchives
           props = {}
           doc = Nokogiri::HTML response
 
-          props[:title] = sanitize doc.css('#album_info .album_name a').first.content
+          props[:title] = sanitize doc.css("#album_info .album_name a").first.content
 
-          doc.css('#album_info dl').each do |dl|
-            dl.search('dt').each do |dt|
+          doc.css("#album_info dl").each do |dl|
+            dl.search("dt").each do |dt|
               content = sanitize dt.next_element.content
 
-              next if content == 'N/A'
+              next if content == "N/A"
 
               case sanitize(dt.content)
-              when 'Type:'
+              when "Type:"
                 props[:type] = map_type content
-              when 'Release date:'
+              when "Release date:"
                 begin
                   props[:date_released] = NilDate.parse content
                 rescue MetalArchives::Errors::ArgumentError => e
                   dr = Date.parse content
                   props[:date_released] = NilDate.new dr.year, dr.month, dr.day
                 end
-              when 'Catalog ID:'
+              when "Catalog ID:"
                 props[:catalog_id] = content
-              when 'Identifier:'
+              when "Identifier:"
                 props[:identifier] = content
-              when 'Version desc.:'
+              when "Version desc.:"
                 props[:version_description] = content
-              when 'Label:'
+              when "Label:"
                 # TODO: label
-              when 'Format:'
+              when "Format:"
                 props[:format] = map_format content
-              when 'Limitation:'
+              when "Limitation:"
                 props[:limitation] = content.to_i
-              when 'Reviews:'
-                next if content == 'None yet'
+              when "Reviews:"
+                next if content == "None yet"
                 # TODO: reviews
               else
                 raise MetalArchives::Errors::ParserError, "Unknown token: #{dt.content}"
@@ -142,7 +146,7 @@ module MetalArchives
           end
 
           props
-        rescue => e
+        rescue StandardError => e
           e.backtrace.each { |b| MetalArchives.config.logger.error b }
           raise Errors::ParserError, e
         end
@@ -158,7 +162,7 @@ module MetalArchives
         #     +Array+ containing one or more +String+s
         #
         def map_countries(countries)
-          countries && countries.map { |c| c.alpha2 }
+          countries&.map(&:alpha2)
         end
 
         ##
@@ -220,6 +224,7 @@ module MetalArchives
         # Returns +Symbol+, see rdoc-ref:Release.format
         #
         def map_format(format)
+          return :cd if format =~ /CD/
           return :vinyl if format =~ /[Vv]inyl/
           return :blu_ray if format =~ /[Bb]lu.?[Rr]ay/
 

data/lib/metal_archives/{utils/range.rb → range.rb}

@@ -34,14 +34,14 @@ module MetalArchives
     # Whether start of range is present
     #
     def begin?
-      !!@begin
+      !@begin.nil?
     end
 
     ##
     # Whether end of range is present
     #
     def end?
-      !!@end
+      !@end.nil?
     end
 
     ##
@@ -59,6 +59,9 @@ module MetalArchives
       # Compare begin if end is equal
       return comp_begin if comp_begin.zero?
 
+      return nil unless self.begin.is_a?(Integer) && self.end.is_a?(Integer)
+      return nil unless other.begin.is_a?(Integer) && other.end.is_a?(Integer)
+
       # Compare actual range
       (self.end - self.begin) <=> (other.end - other.begin)
     end

data/lib/metal_archives/version.rb

@@ -4,5 +4,16 @@ module MetalArchives
   ##
   # MetalArchives API version
   #
-  VERSION = '2.2.0'
+  module Version
+    MAJOR = 2
+    MINOR = 2
+    PATCH = 3
+    PRE   = nil
+
+    VERSION = [MAJOR, MINOR, PATCH].compact.join(".")
+
+    STRING = [VERSION, PRE].compact.join("-")
+  end
+
+  VERSION = MetalArchives::Version::STRING
 end

data/metal_archives.env.example

@@ -0,0 +1,7 @@
+## Metal Archives endpoint
+# MA_ENDPOINT=https://www.metal-archives.com/
+# MA_ENDPOINT_USER=my_user
+# MA_ENDPOINT_PASSWORD=my_password
+
+## WebMock
+# WEBMOCK_ALLOW_HOST=metal-archives.com

data/metal_archives.gemspec

@@ -1,36 +1,48 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/metal_archives/version"
 
-require 'metal_archives/version'
+Gem::Specification.new do |spec|
+  spec.name          = "metal_archives"
+  spec.version       = MetalArchives::VERSION
+  spec.authors       = ["Florian Dejonckheere"]
+  spec.email         = ["florian@floriandejonckheere.be"]
 
-Gem::Specification.new do |gem|
-  gem.authors       = ['Florian Dejonckheere']
-  gem.email         = ['florian@floriandejonckheere.be']
-  gem.summary       = 'Metal Archives Ruby API'
-  gem.homepage      = 'http://github.com/floriandejonckheere/metal_archives'
+  spec.summary       = "Metal Archives Ruby API"
+  spec.description   = "Ruby API layer that transparently queries, scrapes and caches Metal Archives' website"
+  spec.homepage      = "http://github.com/floriandejonckheere/metal_archives"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.8")
 
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = []
-  gem.test_files    = gem.files.grep(%r{^spec/})
-  gem.name          = 'metal_archives'
-  gem.require_paths = %w[lib]
-  gem.version       = MetalArchives::VERSION
-  gem.license       = 'MIT'
+  spec.metadata["source_code_uri"] = "https://github.com/floriandejonckheere/metal_archives"
 
-  gem.add_development_dependency 'byebug'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rdoc'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'factory_girl'
-  gem.add_development_dependency 'faker'
-  gem.add_development_dependency 'rubocop'
-  gem.add_development_dependency 'coveralls'
-  gem.add_development_dependency 'debase'
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r(^bin/)) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  gem.add_dependency 'faraday'
-  gem.add_dependency 'faraday_throttler'
-  gem.add_dependency 'nokogiri'
-  gem.add_dependency 'countries'
+  spec.add_runtime_dependency "countries"
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "faraday_throttler"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "zeitwerk"
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "debase"
+  spec.add_development_dependency "factory_bot"
+  spec.add_development_dependency "fasterer"
+  spec.add_development_dependency "ffaker"
+  spec.add_development_dependency "flay"
+  spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "pronto"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "reek"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
 end