metal_archives 0.8.0 → 1.0.0

data/lib/metal_archives/parsers/parser.rb

@@ -1,88 +1,90 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'countries'
 
 module MetalArchives
-##
-# Mapping layer from and to MA Web Service
-#
-module Parsers # :nodoc:
   ##
-  # Parser base class
+  # Mapping layer from and to MA Web Service
   #
-  class Parser
-    class << self
-      ##
-      # Parse a country
-      #
-      # Returns +ISO3166::Country+
-      #
-      def parse_country(input)
-        ISO3166::Country.find_country_by_name (input)
-      end
+  module Parsers # :nodoc:
+    ##
+    # Parser base class
+    #
+    class Parser
+      class << self
+        ##
+        # Parse a country
+        #
+        # Returns +ISO3166::Country+
+        #
+        def parse_country(input)
+          ISO3166::Country.find_country_by_name input
+        end
 
-      ##
-      # Sanitize a string
-      #
-      # Return +String+
-      #
-      def sanitize(input)
-        input.gsub(/^"/, '').gsub(/"$/, '').strip
-      end
+        ##
+        # Sanitize a string
+        #
+        # Return +String+
+        #
+        def sanitize(input)
+          input.gsub(/^"/, '').gsub(/"$/, '').strip
+        end
 
-      ##
-      # Opinionated parsing of genres
-      #
-      # Returns an +Array+ of +String+
-      #
-      # The following components are omitted:
-      # - Metal
-      # - (early)
-      # - (later)
-      #
-      # All genres are capitalized.
-      #
-      # For examples on how genres are parsed, refer to +ParserTest#test_parse_genre+
-      #
-      def parse_genre(input)
-        genres = []
-        # Split fields
-        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,
-          # concatenate it to all genre strings present in +temp+. If it does
-          # have a slash present, duplicate all genre strings, and concatenate
-          # the first component (before the slash) to the first half, and the
-          # last component to the last half. +temp+ now has an array of genre
-          # combinations.
-          #
-          # 'Traditional Heavy/Power Metal' => ['Traditional Heavy', 'Traditional Power']
-          # 'Traditional/Classical Heavy/Power Metal' => [
-          #                                       'Traditional Heavy', 'Traditional Power',
-          #                                       'Classical Heavy', 'Classical Power']
-          #
-          temp = ['']
-          genre.downcase.split.reject { |g| ['(early)', '(later)', 'metal'].include? g }.each do |g|
-            unless g.include? '/'
-              temp.map! { |t| t.empty? ? g.capitalize : "#{t.capitalize} #{g.capitalize}" }
-            else
-              # Duplicate all WIP genres
-              temp2 = temp.dup
+        ##
+        # Opinionated parsing of genres
+        #
+        # Returns an +Array+ of +String+
+        #
+        # The following components are omitted:
+        # - Metal
+        # - (early)
+        # - (later)
+        #
+        # All genres are capitalized.
+        #
+        # For examples on how genres are parsed, refer to +ParserTest#test_parse_genre+
+        #
+        def parse_genre(input)
+          genres = []
+          # Split fields
+          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,
+            # concatenate it to all genre strings present in +temp+. If it does
+            # have a slash present, duplicate all genre strings, and concatenate
+            # the first component (before the slash) to the first half, and the
+            # last component to the last half. +temp+ now has an array of genre
+            # combinations.
+            #
+            # 'Traditional Heavy/Power Metal' => ['Traditional Heavy', 'Traditional Power']
+            # 'Traditional/Classical Heavy/Power Metal' => [
+            #                                       '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? '/'
+                # Duplicate all WIP genres
+                temp2 = temp.dup
 
-              # Assign first and last components to temp and temp2 respectively
-              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}" }
+                # Assign first and last components to temp and temp2 respectively
+                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}" }
 
-              # Add both genre trees
-              temp += temp2
+                # Add both genre trees
+                temp += temp2
+              else
+                temp.map! { |t| t.empty? ? g.capitalize : "#{t.capitalize} #{g.capitalize}" }
+              end
             end
+            genres += temp
           end
-          genres += temp
+          genres.uniq
         end
-        genres.uniq
       end
     end
   end
 end
-end

data/lib/metal_archives/utils/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MetalArchives
   ##
   # Enumerable collection over a paginated resource
@@ -20,7 +22,7 @@ module MetalArchives
     # Calls the given block once for each element, passing that element as a parameter.
     # If no block is given, an Enumerator is returned.
     #
-    def each(&block)
+    def each
       return to_enum :each unless block_given?
 
       loop do
@@ -33,5 +35,9 @@ module MetalArchives
         break if items.empty?
       end
     end
+
+    def empty?
+      first.nil?
+    end
   end
 end

data/lib/metal_archives/utils/lru_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MetalArchives
   ##
   # Generic LRU memory cache
@@ -44,11 +46,16 @@ module MetalArchives
       @cache.include? key
     end
 
+    def delete(key)
+      @cache.delete key
+    end
+
     private
-      def pop
-        to_remove = @keys.shift @keys.size - @size
 
-        to_remove.each { |key| @cache.delete key }
-      end
+    def pop
+      to_remove = @keys.shift @keys.size - @size
+
+      to_remove.each { |key| @cache.delete key }
+    end
   end
 end

data/lib/metal_archives/utils/nil_date.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module MetalArchives
+  ##
+  # Date with nullable year, month and day
+  #
+  # WARNING: No validation on actual date is performed
+  #
+  class NilDate
+    attr_accessor :year, :month, :day
+
+    def initialize(year = nil, month = nil, day = nil)
+      @year = year
+      @month = month
+      @day = day
+    end
+
+    def year?
+      !@year.nil?
+    end
+
+    def month?
+      !@month.nil?
+    end
+
+    def day?
+      !@day.nil?
+    end
+
+    ##
+    # Return a +Date+ object
+    #
+    def date
+      raise MetalArchives::Errors::ArgumentError, 'invalid date' unless year?
+
+      ::Date.new @year, month || 1, day || 1
+    end
+
+    ##
+    # Parse YYYY[-MM[-DD]]
+    #
+    def self.parse(value)
+      split = value.split('-')
+
+      year = Integer(split[0]) unless split.empty?
+      month = Integer(split[1]) if split.length > 1
+      day = Integer(split[2]) if split.length > 2
+
+      return MetalArchives::NilDate.new year, month, day
+    rescue
+      raise MetalArchives::Errors::ArgumentError, 'invalid date'
+    end
+  end
+end

data/lib/metal_archives/utils/range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MetalArchives
   ##
   # Range which can start and/or end with +nil+
@@ -32,27 +34,33 @@ module MetalArchives
     # Whether start of range is present
     #
     def begin?
-    !!@begin
+      !!@begin
     end
 
     ##
     # Whether end of range is present
     #
     def end?
-    !!@end
+      !!@end
     end
 
     ##
     # Comparison operator
     #
     def <=>(other)
-      comparison = self.begin <=> other.begin
+      comp_begin = self.begin <=> other.begin
+      comp_end = self.end <=> other.end
+      # Return nil if begin or end is uncomparable
+      return nil if comp_begin.nil? || comp_end.nil?
+
+      # Compare end if begin is equal
+      return comp_end if comp_begin.zero?
+
+      # Compare begin if end is equal
+      return comp_begin if comp_begin.zero?
 
-      if comparison == 0
-        return self.end <=> other.end
-      else
-        return comparison
-      end
+      # Compare actual range
+      (self.end - self.begin) <=> (other.end - other.begin)
     end
   end
 end

data/lib/metal_archives/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module MetalArchives
   ##
   # MetalArchives API version
   #
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/metal_archives.gemspec

@@ -1,12 +1,17 @@
-require File.expand_path('../lib/metal_archives/version', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'metal_archives/version'
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Florian Dejonckheere']
   gem.email         = ['florian@floriandejonckheere.be']
-  gem.summary       = %q{Metal Archives Ruby API}
+  gem.summary       = 'Metal Archives Ruby API'
   gem.homepage      = 'http://github.com/floriandejonckheere/metal_archives'
 
-  gem.files         = %x{git ls-files}.split($\)
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = []
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.name          = 'metal_archives'
@@ -14,13 +19,18 @@ Gem::Specification.new do |gem|
   gem.version       = MetalArchives::VERSION
   gem.license       = 'MIT'
 
-  gem.add_development_dependency 'byebug', '~> 9.0'
-  gem.add_development_dependency 'rake', '~> 11.0'
-  gem.add_development_dependency 'rdoc', '~> 5.0'
-  gem.add_development_dependency 'test-unit', '~> 3.0'
+  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'
 
-  gem.add_dependency 'faraday', '~> 0.9'
-  gem.add_dependency 'faraday_throttler', '~> 0.0.3'
-  gem.add_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
-  gem.add_dependency 'countries', '~> 1.2', '>= 1.2.5'
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'faraday_throttler'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'countries'
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::Configuration do
+  describe 'properties' do
+    it 'has the correct properties' do
+      expect(subject).to respond_to :app_name
+      expect(subject).to respond_to :app_name=
+      expect(subject).to respond_to :app_version
+      expect(subject).to respond_to :app_version=
+      expect(subject).to respond_to :app_contact
+      expect(subject).to respond_to :app_contact=
+      expect(subject).to respond_to :endpoint
+      expect(subject).to respond_to :endpoint=
+      expect(subject).to respond_to :default_endpoint
+      expect(subject).to respond_to :middleware
+      expect(subject).to respond_to :middleware=
+      expect(subject).to respond_to :request_rate
+      expect(subject).to respond_to :request_rate=
+      expect(subject).to respond_to :request_timeout
+      expect(subject).to respond_to :request_timeout=
+      expect(subject).to respond_to :logger
+      expect(subject).to respond_to :logger=
+      expect(subject).to respond_to :debug
+      expect(subject).to respond_to :debug=
+      expect(subject).to respond_to :cache_size
+      expect(subject).to respond_to :cache_size=
+    end
+
+    it 'has default properties' do
+      expect(subject.default_endpoint).to eq 'https://www.metal-archives.com/'
+      expect(subject.logger).not_to be_nil
+      expect(subject.debug).to be false
+      expect(subject.cache_size).to be_an Integer
+    end
+
+    it 'overrides defaults' do
+      subject.endpoint = 'http://my-proxy.com/'
+      logger = Logger.new STDERR
+      subject.logger = logger
+      subject.debug = true
+      subject.cache_size = 0
+
+      expect(subject.endpoint).to eq 'http://my-proxy.com/'
+      expect(subject.logger).to be logger
+      expect(subject.debug).to be true
+      expect(subject.cache_size).to eq 0
+    end
+  end
+
+  describe 'configuration' do
+    after(:each) do
+      # Reset configuration
+      load 'support/metal_archives.rb'
+    end
+
+    it 'is invalid without app_name' do
+      proc = -> do
+        MetalArchives.configure do |c|
+          c.app_version = MetalArchives::VERSION
+          c.app_contact = 'user@example.com'
+        end
+      end
+
+      expect(proc).to raise_error MetalArchives::Errors::InvalidConfigurationError
+    end
+
+    it 'is invalid without app_version' do
+      proc = -> do
+        MetalArchives.configure do |c|
+          c.app_name = 'MetalArchivesGemTestSuite'
+          c.app_contact = 'user@example.com'
+        end
+      end
+
+      expect(proc).to raise_error MetalArchives::Errors::InvalidConfigurationError
+    end
+
+    it 'is invalid without app_contact' do
+      proc = -> do
+        MetalArchives.configure do |c|
+          c.app_name = 'MetalArchivesGemTestSuite'
+          c.app_version = MetalArchives::VERSION
+        end
+      end
+
+      expect(proc).to raise_error MetalArchives::Errors::InvalidConfigurationError
+    end
+
+    it 'is valid' do
+      proc = -> do
+        MetalArchives.configure do |c|
+          c.app_name = 'MetalArchivesGemTestSuite'
+          c.app_version = MetalArchives::VERSION
+          c.app_contact = 'user@example.com'
+        end
+      end
+
+      expect(proc).not_to raise_error
+    end
+  end
+end