metal_archives 0.8.0 → 1.0.0

data/lib/metal_archives/models/base_model.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MetalArchives
   ##
   # Abstract model class
@@ -7,7 +8,7 @@ module MetalArchives
     # Generic shallow copy constructor
     #
     def initialize(hash = {})
-      raise Errors::NotImplementedError, 'no :id property in model' unless self.respond_to? :id?, true
+      raise Errors::NotImplementedError, 'no :id property in model' unless respond_to? :id?, true
 
       hash.each do |property, value|
         instance_variable_set("@#{property}", value) if self.class.properties.include? property
@@ -18,7 +19,7 @@ module MetalArchives
     # Returns true if two objects have the same type and id
     #
     def ==(obj)
-      obj.instance_of? self.class and self.id == obj.id
+      obj.instance_of?(self.class) && id ==(obj.id)
     end
 
     ##
@@ -33,9 +34,31 @@ module MetalArchives
 
       # Use constructor to set attributes
       initialize assemble
+
+      @loaded = true
+      self.class.cache[id] = self
+    rescue => e
+      # Don't cache invalid requests
+      self.class.cache.delete id
+      raise e
+    end
+
+    ##
+    # Whether or not the object is currently loaded
+    #
+    def loaded?
+      !@loaded.nil?
+    end
+
+    ##
+    # Whether or not the object is currently cached
+    #
+    def cached?
+      loaded? && self.class.cache.include?(id)
     end
 
     protected
+
       ##
       # Fetch the data and assemble the model
       #
@@ -45,9 +68,9 @@ module MetalArchives
       # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
       # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
       #
-      def assemble
-        raise Errors::NotImplementedError, 'method :assemble not implemented'
-      end
+    def assemble
+      raise Errors::NotImplementedError, 'method :assemble not implemented'
+    end
 
     class << self
       ##
@@ -63,6 +86,7 @@ module MetalArchives
       end
 
       protected
+
         ##
         # Defines a model property.
         #
@@ -79,39 +103,44 @@ module MetalArchives
         #       Whether or not the property has multiple values (which
         #       turns it into an +Array+ of +type+)
         #
-        def property(name, opts = {})
-          (@properties ||= []) << name
+      def property(name, opts = {})
+        (@properties ||= []) << name
 
-          # property
-          define_method(name) do
-            load! unless instance_variable_defined?("@#{name}") or name == :id
-            instance_variable_get("@#{name}")
-          end
+        # property
+        define_method(name) do
+          load! unless instance_variable_defined?("@#{name}") || name ==(:id)
+          instance_variable_get("@#{name}")
+        end
 
-          # property?
-          define_method("#{name}?") do
-            load! unless instance_variable_defined?("@#{name}") or name == :id
+        # property?
+        define_method("#{name}?") do
+          load! unless instance_variable_defined?("@#{name}") || name ==(:id)
 
-            property = instance_variable_get("@#{name}")
-            property.respond_to?(:empty?) ? !property.empty? : !!property
+          property = instance_variable_get("@#{name}")
+          property.respond_to?(:empty?) ? !property.empty? : !!property
+        end
+
+        # property=
+        define_method("#{name}=") do |value|
+          if value.nil?
+            instance_variable_set "@#{name}", value
+            return
           end
 
-          # property=
-          define_method("#{name}=") do
-            # Check value type
-            type = opts[:type] || String
-            if opts[:multiple]
-              raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be Array for #{name}" unless value.is_a? Array
-              value.each do |val|
-                raise MetalArchives::Errors::TypeError, "invalid type #{val.class}, must be #{type} for #{name}" unless val.is_a? type
-              end
-            else
-              raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be #{type} for #{name}" unless value.is_a? type
+          # Check value type
+          type = opts[:type] || String
+          if opts[:multiple]
+            raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be Array for #{name}" unless value.is_a? Array
+            value.each do |val|
+              raise MetalArchives::Errors::TypeError, "invalid type #{val.class}, must be #{type} for #{name}" unless val.is_a? type
             end
-
-            instance_variable_set name, value
+          else
+            raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be #{type} for #{name}" unless value.is_a? type
           end
+
+          instance_variable_set "@#{name}", value
         end
+      end
 
         ##
         # Defines a model enum property.
@@ -127,40 +156,40 @@ module MetalArchives
         #       Whether or not the property has multiple values (which
         #       turns it into an +Array+ of +type+)
         #
-        def enum(name, opts)
-          raise ArgumentError, 'opts[:values] is required' unless opts and opts[:values]
+      def enum(name, opts)
+        raise ArgumentError, 'opts[:values] is required' unless opts and opts[:values]
 
-          (@properties ||= []) << name
+        (@properties ||= []) << name
 
-          # property
-          define_method(name) do
-            load! unless instance_variable_defined?("@#{name}")
-            instance_variable_get("@#{name}")
-          end
+        # property
+        define_method(name) do
+          load! unless instance_variable_defined?("@#{name}")
+          instance_variable_get("@#{name}")
+        end
 
-          # property?
-          define_method("#{name}?") do
-            load! unless instance_variable_defined?("@#{name}")
+        # property?
+        define_method("#{name}?") do
+          load! unless instance_variable_defined?("@#{name}")
 
-            property = instance_variable_get("@#{name}")
-            property.respond_to?(:empty?) ? !property.empty? : !!property
-          end
+          property = instance_variable_get("@#{name}")
+          property.respond_to?(:empty?) ? !property.empty? : !!property
+        end
 
-          # property=
-          define_method("#{name}=") do |value|
-            # Check enum type
-            if opts[:multiple]
-              raise MetalArchives::Errors::TypeError, "invalid enum value #{value}, must be Array for #{name}" unless value.is_a? Array
-              value.each do |val|
-                raise MetalArchives::Errors::TypeError, "invalid enum value #{val} for #{name}" unless opts[:values].include? val
-              end
-            else
-              raise MetalArchives::Errors::TypeError, "invalid enum value #{value} for #{name}" unless opts[:values].include? value
+        # property=
+        define_method("#{name}=") do |value|
+          # Check enum type
+          if opts[:multiple]
+            raise MetalArchives::Errors::TypeError, "invalid enum value #{value}, must be Array for #{name}" unless value.is_a? Array
+            value.each do |val|
+              raise MetalArchives::Errors::TypeError, "invalid enum value #{val} for #{name}" unless opts[:values].include? val
             end
-
-            instance_variable_set name, value
+          else
+            raise MetalArchives::Errors::TypeError, "invalid enum value #{value} for #{name}" unless opts[:values].include? value
           end
+
+          instance_variable_set name, value
         end
+      end
 
         ##
         # Defines a model boolean property. This method is an alias for <tt>enum name, :values => [true, false]</tt>
@@ -173,9 +202,9 @@ module MetalArchives
         #       Whether or not the property has multiple values (which
         #       turns it into an +Array+ of +type+)
         #
-        def boolean(name, opts = {})
-          enum name, opts.merge(:values => [true, false])
-        end
+      def boolean(name, opts = {})
+        enum name, opts.merge(:values => [true, false])
+      end
     end
   end
 end

data/lib/metal_archives/models/label.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'countries'
 
 module MetalArchives
-
   ##
   # Represents a record label
   #
@@ -82,7 +83,7 @@ module MetalArchives
     #
     # Returns +:active+, +:closed+ or +:unknown+
     #
-    enum :status, :values => [:active, :closed, :unknown]
+    enum :status, :values => %i[active closed unknown]
 
     class << self
       ##
@@ -90,7 +91,7 @@ module MetalArchives
       #
       # Returns +Array+ of rdoc-ref:Label
       #
-      def search(name)
+      def search(_name)
         results = []
         results
       end
@@ -102,9 +103,9 @@ module MetalArchives
       #
       def find_by_name(name, id)
         client.find_resource(
-            :band,
-              :name => name,
-              :id => id
+          :band,
+          :name => name,
+          :id => id
         )
       end
     end

data/lib/metal_archives/parsers/artist.rb

@@ -1,126 +1,137 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'date'
 require 'countries'
 
+require 'metal_archives/middleware/rewrite_endpoint'
+
 module MetalArchives
-module Parsers
-  ##
-  # Artist parser
-  #
-  class Artist < Parser # :nodoc:
-    class << self
-      ##
-      # Map attributes to MA attributes
-      #
-      # Returns +Hash+
-      #
-      # [+params+]
-      #     +Hash+
-      #
-      def map_params(query)
-        params = {
-          :query => query[:name] || ''
-        }
-
-        params
-      end
+  module Parsers
+    ##
+    # Artist parser
+    #
+    class Artist < Parser # :nodoc:
+      class << self
+        ##
+        # Map attributes to MA attributes
+        #
+        # Returns +Hash+
+        #
+        # [+params+]
+        #     +Hash+
+        #
+        def map_params(query)
+          params = {
+            :query => query[:name] || ''
+          }
+
+          params
+        end
+
+        ##
+        # Parse main HTML page
+        #
+        # Returns +Hash+
+        #
+        # [Raises]
+        # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
+        #
+        def parse_html(response)
+          props = {}
+          doc = Nokogiri::HTML response
+
+          # Photo
+          unless doc.css('.member_img').empty?
+            photo_uri = URI doc.css('.member_img img').first.attr('src')
+            props[:photo] = Middleware::RewriteEndpoint.rewrite photo_uri
+          end
+
+          doc.css('#member_info dl').each do |dl|
+            dl.css('dt').each do |dt|
+              content = sanitize(dt.next_element.content)
+
+              next if content == 'N/A'
 
-      ##
-      # Parse main HTML page
-      #
-      # Returns +Hash+
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
-      #
-      def parse_html(response)
-        props = {}
-        doc = Nokogiri::HTML response
-
-        doc.css('#member_info dl').each do |dl|
-          dl.css('dt').each do |dt|
-            content = sanitize(dt.next_element.content)
-
-            next if content == 'N/A'
-
-            case sanitize(dt.content)
-            when 'Real/full name:'
-              props[:name] = content
-            when 'Age:'
-              date = content.gsub(/ [0-9]* \(born ([^\)]*)\)/, '\1')
-              props[:date_of_birth] = Date.parse date
-            when 'R.I.P.:'
-              props[:date_of_death] = Date.parse content
-            when 'Died of:'
-              props[:cause_of_death] = content
-            when 'Place of origin:'
-              props[:country] = ISO3166::Country.find_country_by_name(sanitize(dt.next_element.css('a').first.content))
-              location = dt.next_element.xpath('text()').map { |x| x.content }.join('').strip.gsub(/[()]/, '')
-              props[:location] = location unless location.empty?
-            when 'Gender:'
-              case content
-              when 'Male'
-                props[:gender] = :male
-              when 'Female'
-                props[:gender] = :female
+              case sanitize(dt.content)
+              when 'Real/full name:'
+                props[:name] = content
+              when 'Age:'
+                date = content.strip.gsub(/[0-9]* *\(born ([^\)]*)\)/, '\1')
+                props[:date_of_birth] = Date.parse date
+              when 'R.I.P.:'
+                props[:date_of_death] = Date.parse content
+              when 'Died of:'
+                props[:cause_of_death] = content
+              when 'Place of origin:'
+                props[:country] = ISO3166::Country.find_country_by_name(sanitize(dt.next_element.css('a').first.content))
+                location = dt.next_element.xpath('text()').map(&:content).join('').strip.gsub(/[()]/, '')
+                props[:location] = location unless location.empty?
+              when 'Gender:'
+                case content
+                when 'Male'
+                  props[:gender] = :male
+                when 'Female'
+                  props[:gender] = :female
+                else
+                  raise Errors::ParserError, "Unknown gender: #{content}"
+                end
               else
-                raise Errors::ParserError, "Unknown gender: #{content}"
+                raise Errors::ParserError, "Unknown token: #{dt.content}"
               end
-            else
-              raise Errors::ParserError, "Unknown token: #{dt.content}"
             end
           end
-        end
 
-        props[:aliases] = []
-        alt = sanitize doc.css('.band_member_name').first.content
-        props[:aliases] << alt unless props[:name] == alt
+          # Aliases
+          props[:aliases] = []
+          alt = sanitize doc.css('.band_member_name').first.content
+          props[:aliases] << alt unless props[:name] == alt
 
-        props
-      rescue => e
-        e.backtrace.each { |b| MetalArchives::config.logger.error b }
-        raise Errors::ParserError, e
-      end
+          props
+        rescue => e
+          e.backtrace.each { |b| MetalArchives.config.logger.error b }
+          raise Errors::ParserError, e
+        end
 
-      ##
-      # Parse links HTML page
-      #
-      # Returns +Hash+
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
-      #
-      def parse_links_html(response)
-        links = []
+        ##
+        # Parse links HTML page
+        #
+        # Returns +Hash+
+        #
+        # [Raises]
+        # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
+        #
+        def parse_links_html(response)
+          links = []
 
-        doc = Nokogiri::HTML response
+          doc = Nokogiri::HTML response
 
-        # Default to official links
-        type = :official
+          # Default to official links
+          type = :official
 
-        doc.css('#linksTablemain tr').each do |row|
-          if row['id'] =~ /^header_/
-            type = row['id'].gsub(/^header_/, '').downcase.to_sym
-          else
-            a = row.css('td a').first
+          doc.css('#linksTablemain tr').each do |row|
+            if row['id'].match?(/^header_/)
+              type = row['id'].gsub(/^header_/, '').downcase.to_sym
+            else
+              a = row.css('td a').first
 
-            # No links have been added yet
-            next unless a
+              # No links have been added yet
+              next unless a
 
-            links << {
+              links << {
                 :url => a['href'],
                 :type => type,
                 :title => a.content
-            }
+              }
+            end
           end
-        end
 
-        links
-      rescue => e
-        e.backtrace.each { |b| MetalArchives::config.logger.error b }
-        raise Errors::ParserError, e
+          links
+        rescue => e
+          e.backtrace.each { |b| MetalArchives.config.logger.error b }
+          raise Errors::ParserError, e
+        end
       end
     end
   end
 end
-end