metal_archives 2.2.3 → 3.2.0

data/lib/metal_archives/models/artist.rb

@@ -8,7 +8,7 @@ module MetalArchives
   ##
   # Represents a single performer (but not a solo artist)
   #
-  class Artist < MetalArchives::BaseModel
+  class Artist < Base
     ##
     # :attr_reader: id
     #
@@ -63,24 +63,24 @@ module MetalArchives
     ##
     # :attr_reader: date_of_birth
     #
-    # Returns rdoc-ref:NilDate
+    # Returns rdoc-ref:Date
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    property :date_of_birth, type: NilDate
+    property :date_of_birth, type: Date
 
     ##
     # :attr_reader: date_of_death
     #
-    # Returns rdoc-ref:NilDate
+    # Returns rdoc-ref:Date
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    property :date_of_death, type: NilDate
+    property :date_of_death, type: Date
 
     ##
     # :attr_reader: cause_of_death
@@ -102,7 +102,7 @@ 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)
     #
-    enum :gender, values: %i(male female)
+    enum :gender, values: [:male, :female]
 
     ##
     # :attr_reader: biography
@@ -165,7 +165,7 @@ module MetalArchives
     # [+bands+]
     #     - +:band+: rdoc-ref:Band
     #     - +:active+: Boolean
-    #     - +:date_active+: +Array+ of rdoc-ref:Range containing rdoc-ref:NilDate
+    #     - +:years_active+: +Array+ of rdoc-ref:Range containing +Integer+
     #     - +:role+: +String+
     #
     property :bands, type: Hash, multiple: true
@@ -173,6 +173,41 @@ module MetalArchives
     # TODO: guest/session bands
     # TODO: misc bands
 
+    ##
+    # Serialize to hash
+    #
+    def to_h
+      {
+        type: "artist",
+        id: id,
+        name: name,
+        aliases: aliases || [],
+        country: country&.alpha3,
+        location: location,
+        date_of_birth: date_of_birth&.iso8601,
+        date_of_death: date_of_death&.iso8601,
+        cause_of_death: cause_of_death,
+        gender: gender,
+        biography: biography,
+        trivia: trivia,
+        photo: photo,
+        links: links || [],
+        bands: bands || [],
+      }
+    end
+
+    ##
+    # Deserialize from hash
+    #
+    def self.from_h(hash)
+      return unless hash.fetch(:type) == "artist"
+
+      new(hash.slice(:id, :name, :aliases, :location, :cause_of_death, :gender, :biography, :trivial, :photo, :links, :bands))
+        .tap { |m| m.country = ISO3166::Country[hash[:country]] }
+        .tap { |m| m.date_of_birth = Date.parse(hash[:date_of_birth]) if hash[:date_of_birth] }
+        .tap { |m| m.date_of_death = Date.parse(hash[:date_of_death]) if hash[:date_of_death] }
+    end
+
     protected
 
     ##
@@ -184,28 +219,24 @@ module MetalArchives
     #
     def assemble # :nodoc:
       ## Base attributes
-      url = "#{MetalArchives.config.default_endpoint}artist/view/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/artist/view/id/#{id}"
 
-      properties = Parsers::Artist.parse_html response.body
+      properties = Parsers::Artist.parse_html response.to_s
 
       ## Biography
-      url = "#{MetalArchives.config.default_endpoint}artist/read-more/id/#{id}/field/biography"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/artist/read-more/id/#{id}/field/biography"
 
-      properties[:biography] = response.body
+      properties[:biography] = response.to_s
 
       ## Trivia
-      url = "#{MetalArchives.config.default_endpoint}artist/read-more/id/#{id}/field/trivia"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/artist/read-more/id/#{id}/field/trivia"
 
-      properties[:trivia] = response.body
+      properties[:trivia] = response.to_s
 
       ## Related links
-      url = "#{MetalArchives.config.default_endpoint}link/ajax-list/type/person/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/link/ajax-list/type/person/id/#{id}"
 
-      properties[:links] = Parsers::Artist.parse_links_html response.body
+      properties[:links] = Parsers::Artist.parse_links_html response.to_s
 
       properties
     end
@@ -220,7 +251,7 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        return cache[id] if cache.include? id
+        return MetalArchives.cache[cache(id)] if MetalArchives.cache.include? cache(id)
 
         Artist.new id: id
       end
@@ -262,11 +293,10 @@ module MetalArchives
       def find_by(query)
         raise MetalArchives::Errors::ArgumentError unless query.include? :name
 
-        url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
         params = Parsers::Artist.map_params query
 
-        response = HTTPClient.get url, params
-        json = JSON.parse response.body
+        response = MetalArchives.http.get "/search/ajax-artist-search/", params
+        json = JSON.parse response.to_s
 
         return nil if json["aaData"].empty?
 
@@ -314,7 +344,6 @@ module MetalArchives
       def search(name)
         raise MetalArchives::Errors::ArgumentError unless name.is_a? String
 
-        url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
         query = { name: name }
 
         params = Parsers::Artist.map_params query
@@ -325,8 +354,8 @@ module MetalArchives
           if @max_items && @start >= @max_items
             []
           else
-            response = HTTPClient.get url, params.merge(iDisplayStart: @start)
-            json = JSON.parse response.body
+            response = MetalArchives.http.get "/search/ajax-artist-search/", params.merge(iDisplayStart: @start)
+            json = JSON.parse response.to_s
 
             @max_items = json["iTotalRecords"]
 

data/lib/metal_archives/models/band.rb

@@ -8,7 +8,7 @@ module MetalArchives
   ##
   # Represents an band (person or group)
   #
-  class Band < MetalArchives::BaseModel
+  class Band < Base
     ##
     # :attr_reader: id
     #
@@ -63,24 +63,24 @@ module MetalArchives
     ##
     # :attr_reader: date_formed
     #
-    # Returns rdoc-ref:NilDate
+    # Returns rdoc-ref:Date
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    property :date_formed, type: NilDate
+    property :date_formed, type: Date
 
     ##
-    # :attr_reader: date_active
+    # :attr_reader: years_active
     #
-    # Returns +Array+ of rdoc-ref:Range containing rdoc-ref:NilDate
+    # Returns +Array+ of rdoc-ref:Range containing +Integer+
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    property :date_active, type: MetalArchives::Range, multiple: true
+    property :years_active, type: Range, multiple: true
 
     ##
     # :attr_reader: genres
@@ -113,7 +113,7 @@ 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)
     #
-    property :label, type: MetalArchives::Label
+    property :label, type: Label
 
     ##
     # :attr_reader: independent
@@ -146,7 +146,7 @@ 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)
     #
-    enum :status, values: %i(active split_up on_hold unknown changed_name disputed)
+    enum :status, values: [:active, :split_up, :on_hold, :unknown, :changed_name, :disputed]
 
     ##
     # :attr_reader: releases
@@ -157,9 +157,24 @@ 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)
     #
-    property :releases, type: MetalArchives::Release, multiple: true
+    property :releases, type: Release, multiple: true
 
-    # TODO: members
+    ##
+    # :attr_reader: members
+    #
+    # Returns +Array+ of +Hash+ containing the following keys
+    #
+    # [Raises]
+    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
+    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
+    #
+    # [+members+]
+    #     - +:artist+: rdoc-ref:Artist
+    #     - +:current+: Boolean
+    #     - +:years_active+: +Array+ of rdoc-ref:Range containing +Integer+
+    #     - +:role+: +String+
+    #
+    property :members, type: Artist, multiple: true
 
     ##
     # :attr_reader: similar
@@ -225,34 +240,29 @@ module MetalArchives
     #
     def assemble # :nodoc:
       ## Base attributes
-      url = "#{MetalArchives.config.default_endpoint}band/view/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/band/view/id/#{id}"
 
-      properties = Parsers::Band.parse_html response.body
+      properties = Parsers::Band.parse_html response.to_s
 
       ## Comment
-      url = "#{MetalArchives.config.default_endpoint}band/read-more/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/band/read-more/id/#{id}"
 
-      properties[:comment] = response.body
+      properties[:comment] = response.to_s
 
       ## Similar artists
-      url = "#{MetalArchives.config.default_endpoint}band/ajax-recommendations/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/band/ajax-recommendations/id/#{id}"
 
-      properties[:similar] = Parsers::Band.parse_similar_bands_html response.body
+      properties[:similar] = Parsers::Band.parse_similar_bands_html response.to_s
 
       ## Related links
-      url = "#{MetalArchives.config.default_endpoint}link/ajax-list/type/band/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/link/ajax-list/type/band/id/#{id}"
 
-      properties[:links] = Parsers::Band.parse_related_links_html response.body
+      properties[:links] = Parsers::Band.parse_related_links_html response.to_s
 
       ## Releases
-      url = "#{MetalArchives.config.default_endpoint}band/discography/id/#{id}/tab/all"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/band/discography/id/#{id}/tab/all"
 
-      properties[:releases] = Parsers::Band.parse_releases_html response.body
+      properties[:releases] = Parsers::Band.parse_releases_html response.to_s
 
       properties
     end
@@ -267,7 +277,7 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        return cache[id] if cache.include? id
+        return MetalArchives.cache[cache(id)] if MetalArchives.cache.include? cache(id)
 
         Band.new id: id
       end
@@ -309,7 +319,7 @@ module MetalArchives
       #     - +:exact+: +Boolean+
       #     - +:genre+: +String+
       #     - +:country+: +ISO3166::Country+
-      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:NilDate
+      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:Date
       #     - +:comment+: +String+
       #     - +:status+: see rdoc-ref:Band.status
       #     - +:lyrical_themes+: +String+
@@ -318,11 +328,10 @@ module MetalArchives
       #     - +:independent+: boolean
       #
       def find_by(query)
-        url = "#{MetalArchives.config.default_endpoint}search/ajax-advanced/searching/bands"
         params = Parsers::Band.map_params query
 
-        response = HTTPClient.get url, params
-        json = JSON.parse response.body
+        response = MetalArchives.http.get "/search/ajax-advanced/searching/bands", params
+        json = JSON.parse response.to_s
 
         return nil if json["aaData"].empty?
 
@@ -349,7 +358,7 @@ module MetalArchives
       #     - +:exact+: +Boolean+
       #     - +:genre+: +String+
       #     - +:country+: +ISO3166::Country+
-      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:NilDate
+      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:Date
       #     - +:comment+: +String+
       #     - +:status+: see rdoc-ref:Band.status
       #     - +:lyrical_themes+: +String+
@@ -381,7 +390,7 @@ module MetalArchives
       #     - +:exact+: +Boolean+
       #     - +:genre+: +String+
       #     - +:country+: +ISO3166::Country+
-      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:NilDate
+      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:Date
       #     - +:comment+: +String+
       #     - +:status+: see rdoc-ref:Band.status
       #     - +:lyrical_themes+: +String+
@@ -390,8 +399,6 @@ module MetalArchives
       #     - +:independent+: boolean
       #
       def search_by(query)
-        url = "#{MetalArchives.config.default_endpoint}search/ajax-advanced/searching/bands"
-
         params = Parsers::Band.map_params query
 
         l = lambda do
@@ -400,8 +407,8 @@ module MetalArchives
           if @max_items && @start >= @max_items
             []
           else
-            response = HTTPClient.get url, params.merge(iDisplayStart: @start)
-            json = JSON.parse response.body
+            response = MetalArchives.http.get "/search/ajax-advanced/searching/bands", params.merge(iDisplayStart: @start)
+            json = JSON.parse response.to_s
 
             @max_items = json["iTotalRecords"]
 

data/lib/metal_archives/models/{base_model.rb → base.rb}

@@ -4,48 +4,49 @@ module MetalArchives
   ##
   # Abstract model class
   #
-  class BaseModel
+  class Base
     ##
     # Generic shallow copy constructor
     #
-    def initialize(hash = {})
-      raise Errors::NotImplementedError, "no :id property in model" unless respond_to? :id?, true
+    def initialize(attributes = {})
+      raise Errors::NotImplementedError, "no :id property in model" unless respond_to? :id
 
-      hash.each do |property, value|
-        instance_variable_set("@#{property}", value) if self.class.properties.include? property
-      end
+      set(**attributes)
+    end
+
+    ##
+    # Set properties
+    #
+    def set(**attributes)
+      attributes.each { |key, value| instance_variable_set(:"@#{key}", value) }
     end
 
     ##
     # Returns true if two objects have the same type and id
     #
-    def ==(obj)
-      obj.instance_of?(self.class) && id == obj.id
+    def ==(other)
+      other.is_a?(self.class) &&
+        id == other.id
     end
 
     ##
     # Fetch, parse and load the data
     #
     # [Raises]
-    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no id
-    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
+    # - rdoc-ref:Errors::InvalidIDError when no id
+    # - rdoc-ref:Errors::APIError when receiving a status code >= 400 (except 404)
     #
     def load!
       raise Errors::InvalidIDError, "no id present" unless id
 
       # Use constructor to set attributes
-      initialize assemble
-
-      # Set empty properties to nil
-      self.class.properties.each do |prop|
-        instance_variable_set("@#{prop}", nil) unless instance_variable_defined? "@#{prop}"
-      end
+      set(**assemble)
 
       @loaded = true
-      self.class.cache[id] = self
+      MetalArchives.cache[self.class.cache(id)] = self
     rescue StandardError => e
       # Don't cache invalid requests
-      self.class.cache.delete id
+      MetalArchives.cache.delete self.class.cache(id)
       raise e
     end
 
@@ -53,14 +54,21 @@ module MetalArchives
     # Whether or not the object is currently loaded
     #
     def loaded?
-      !@loaded.nil?
+      @loaded ||= false
     end
 
     ##
     # Whether or not the object is currently cached
     #
     def cached?
-      loaded? && self.class.cache.include?(id)
+      loaded? && MetalArchives.cache.include?(self.class.cache(id))
+    end
+
+    ##
+    # String representation
+    #
+    def inspect
+      "#<#{self.class.name} @id=#{@id} @name=\"#{@name}\">"
     end
 
     protected
@@ -71,8 +79,8 @@ module MetalArchives
     # Override this method
     #
     # [Raises]
-    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
-    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
+    # - rdoc-ref:Errors::InvalidIDError when no or invalid id
+    # - rdoc-ref:Errors::APIError when receiving a status code >= 400 (except 404)
     #
     def assemble
       raise Errors::NotImplementedError, "method :assemble not implemented"
@@ -80,15 +88,17 @@ module MetalArchives
 
     class << self
       ##
-      # +Array+ of declared properties
+      # Declared properties
       #
-      attr_accessor :properties
+      def properties
+        @properties ||= {}
+      end
 
       ##
-      # Get class-level object cache
+      # Generate cache key for id
       #
-      def cache
-        @cache ||= MetalArchives::LRUCache.new MetalArchives.config.cache_size
+      def cache(id)
+        "#{self.class.name}//#{id}"
       end
 
       protected
@@ -110,42 +120,38 @@ module MetalArchives
       #       turns it into an +Array+ of +type+)
       #
       def property(name, opts = {})
-        (@properties ||= []) << name
+        properties[name] = opts
 
         # property
         define_method(name) do
-          load! unless loaded? && instance_variable_defined?("@#{name}") || name == :id
-          instance_variable_get("@#{name}")
+          # Load only when not loaded or id property
+          load! unless loaded? || name == :id
+
+          instance_variable_get(:"@#{name}")
         end
 
         # property?
         define_method("#{name}?") do
-          load! unless loaded? && instance_variable_defined?("@#{name}") || name == :id
-
-          property = instance_variable_get("@#{name}")
-          property.respond_to?(:empty?) ? !property.empty? : !property.nil?
+          send(name).present?
         end
 
         # property=
         define_method("#{name}=") do |value|
-          if value.nil?
-            instance_variable_set "@#{name}", value
-            return
-          end
+          return instance_variable_set(:"@#{name}", value) if value.nil?
 
           # 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
+            raise 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
+              raise 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
+            raise Errors::TypeError, "invalid type #{value.class}, must be #{type} for #{name}" unless value.is_a? type
           end
 
-          instance_variable_set "@#{name}", value
+          instance_variable_set(:"@#{name}", value)
         end
       end
 
@@ -166,19 +172,20 @@ module MetalArchives
       def enum(name, opts)
         raise ArgumentError, "opts[:values] is required" unless opts && opts[:values]
 
-        (@properties ||= []) << name
+        properties[name] = opts
 
         # property
         define_method(name) do
-          load! unless loaded? && instance_variable_defined?("@#{name}")
-          instance_variable_get("@#{name}")
+          load! unless loaded?
+
+          instance_variable_get(:"@#{name}")
         end
 
         # property?
         define_method("#{name}?") do
           load! unless loaded? && instance_variable_defined?("@#{name}")
 
-          property = instance_variable_get("@#{name}")
+          property = instance_variable_get(:"@#{name}")
           property.respond_to?(:empty?) ? !property.empty? : !property.nil?
         end
 
@@ -186,16 +193,16 @@ module MetalArchives
         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
+            raise 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
+              raise 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
+            raise Errors::TypeError, "invalid enum value #{value} for #{name}" unless opts[:values].include? value
           end
 
-          instance_variable_set name, value
+          instance_variable_set(:"@#{name}", value)
         end
       end