mangdown 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c55c78329762e6af9921776a2c8c643ea563ec5
-  data.tar.gz: 3556d64b7a4dfb176e13929c3560b37d09c9c8f6
+  metadata.gz: 238181d8ba1817789cb0a1dc8a69a3dafd6cf811
+  data.tar.gz: 26f7195a357234d613f65ebb98779d2643ccf0f7
 SHA512:
-  metadata.gz: 22dba31e19428a793823ad4afd6ec132c02307254d349bccd23b1b9036d08e20d2487b2571629ec7952826bbe8d2d7d533da2304a948314c3bb26fd3718b4b1b
-  data.tar.gz: 683f50a23e461e3ffd0728217c6fe6a15247495f8aa06621fcb914683252654c7659c40bc7de0d6950c47f74a138aec966a63c76cd305aef483026fd2edf49e5
+  metadata.gz: 7df1eb96cd3eb36838ae7b2551a3ccd54dc7a17fb9ab4925ecc4f3989cd5fa0b9f1d5579ec0c819eb42ddd419916524ec67007a2ad6c15c6eeca565adf96bdf4
+  data.tar.gz: 7ff2cd14861ac3bce9b72f06050cc679cd8638bcb630af5096b14c35c1f86f40e031149f6db3529d4ea96989ad7503b968785276e28706c48447e67e102e9997

data/lib/mangdown/adapter/mangareader.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 module Mangdown
+  # Mangdown adapter for mangareader
   class Mangareader < Adapter::Base
-
     site :mangareader
 
     attr_reader :root
@@ -31,12 +33,12 @@ module Mangdown
 
     # Only valid mangas should be returned (using is_manga?(uri))
     def manga_list
-      doc.css('ul.series_alpha li a').map { |a| 
+      doc.css('ul.series_alpha li a').map do |a|
         uri = "#{root}#{a[:href]}"
         manga = { uri: uri, name: a.text.strip, site: site }
 
         manga if is_manga?(uri)
-      }.compact
+      end.compact
     end
 
     def manga
@@ -45,17 +47,17 @@ module Mangdown
 
     # Only valid chapters should be returned (using is_chapter?(uri))
     def chapter_list
-      doc.css('div#chapterlist td a').map { |a|
+      doc.css('div#chapterlist td a').map do |a|
         uri = root + a[:href].sub(root, '')
         chapter = { uri: uri, name: a.text.strip, site: site }
 
         chapter if is_chapter?(uri)
-      }.compact
+      end.compact
     end
 
     def chapter
-      { uri: uri, 
-        manga: manga_name, 
+      { uri: uri,
+        manga: manga_name,
         name: chapter_name,
         chapter: chapter_number,
         site: site }
@@ -63,20 +65,20 @@ module Mangdown
 
     def page_list
       last_page = doc.css('select')[1].css('option').length
-      (1..last_page).map { |page|  
-        slug = manga_name.gsub(' ', '-').gsub(/[:,!]/, '')
+      (1..last_page).map do |page|
+        slug = manga_name.tr(' ', '-').gsub(/[:,!]/, '')
         uri = "#{root}/#{slug}/#{chapter_number}/#{page}"
-        uri = URI.escape(uri).downcase 
-
-        { uri: uri, name: page, site: site } }
+        uri = CGI.escape(uri).downcase
+        { uri: uri, name: page, site: site }
+      end
     end
 
     def page
       page_image = doc.css('img')[0]
       uri = page_image[:src]
-      name = page_image[:alt].sub(/([^\d]*)(\d+)(\.\w+)?$/) { 
+      name = page_image[:alt].sub(/([^\d]*)(\d+)(\.\w+)?$/) do
         Regexp.last_match[1].to_s + Regexp.last_match[2].to_s.rjust(3, '0')
-      }
+      end
 
       { uri: uri, name: name, site: site }
     end
@@ -97,25 +99,24 @@ module Mangdown
       if @name
         @name.sub(/\s(\d+)$/) { |num| ' ' + num.to_i.to_s.rjust(5, '0') }
       else
-        doc.css("").text # Not implimented
+        doc.css('').text # Not implimented
       end
     end
 
     def chapter_manga_name
       if @name
-        @name.slice(/(^.+)\s/, 1) 
+        @name.slice(/(^.+)\s/, 1)
       else
-        doc.css("").text # Not implimented
+        doc.css('').text # Not implimented
       end
     end
 
     def chapter_number
       if @name
-        @name.slice(/\d+\z/).to_i 
+        @name.slice(/\d+\z/).to_i
       else
-        doc.css("").text # Not implimented
+        doc.css('').text # Not implimented
       end
     end
   end
 end
-

data/lib/mangdown/adapter/no_adapter_error.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Mangdown
   module Adapter
-    class NoAdapterError < StandardError
+    # No matching Mangdown adpter found
+    class NoAdapterError < Mangdown::Error
       def initialize(site)
         super("Bad Site: No Adapter Specified for Site: #{site.inspect}")
       end

data/lib/mangdown/adapter/not_implemented_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Mangdown
+  module Adapter
+    class NotImplementedError < Mangdown::Error
+    end
+  end
+end

data/lib/mangdown/adapter/proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mangdown
   module Adapter
     # Wraps Adapters to provide error reporting
@@ -17,17 +19,25 @@ module Mangdown
 
         adapter.public_send(method, *args, &block)
       rescue => e
-        logger.error({
+        logger.error(debug_error)
+        raise Mangdown::Error, "Adapter failed: #{e.message}"
+      end
+
+      def respond_to_missing?(method, include_all)
+        @adapter.respond_to?(method, include_all)
+      end
+
+      def debug_error(error)
+        {
           msg: 'Adapter method failed',
           adapter: adapter.class,
           uri: adapter.uri,
           doc: adapter.doc.to_s,
           method: method,
-          error: e,
-          error_msg: e.message,
-          backtrace: e.backtrace
-        }.to_s)
-        raise Mangdown::Error, "Adapter failed: #{e.message}"
+          error: error,
+          error_msg: error.message,
+          backtrace: error.backtrace
+        }.to_s
       end
     end
   end

data/lib/mangdown/adapter.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Mangdown
   module Adapter
+    # Abstract Adapter class
     class Base
-      # Returns something truthy if this adapter should be used for the 
+      # Returns something truthy if this adapter should be used for the
       # given url or adapter name
       def self.for?(url_or_adapter_name)
         url_or_adapter_name[site.to_s]
@@ -10,7 +13,7 @@ module Mangdown
       def self.site(site = nil)
         site ? @_site = site : @_site
       end
-      
+
       attr_reader :uri, :name
       def initialize(uri, doc, name)
         @uri = uri
@@ -27,53 +30,53 @@ module Mangdown
       end
 
       # Overwrite if you want to check the uri if it belongs to a manga list
-      def is_manga_list?(uri = @uri)
-        raise NotImplementedError
+      def is_manga_list?(_uri = @uri)
+        raise Adapter::NotImplementedError
       end
 
       # Must return true/false if uri represents a manga for adapter
-      def is_manga?(uri = @uri)
-        raise NotImplementedError
+      def is_manga?(_uri = @uri)
+        raise Adapter::NotImplementedError
       end
 
       # Must return true/false if uri represents a chapter for adapter
-      def is_chapter?(uri = @uri)
-        raise NotImplementedError
+      def is_chapter?(_uri = @uri)
+        raise Adapter::NotImplementedError
       end
 
       # Must return true/false if uri represents a page for adapter
-      def is_page?(uri = @uri)
-        raise NotImplementedError
+      def is_page?(_uri = @uri)
+        raise Adapter::NotImplementedError
       end
 
       # Return Array of Hash with keys: :uri, :name, :site
       def manga_list
-        raise NotImplementedError
+        raise Adapter::NotImplementedError
       end
 
       # Return Hash with keys: :uri, :name, :site
       def manga
-        raise NotImplementedError
+        raise Adapter::NotImplementedError
       end
 
       # Return Array of Hash with keys: :uri, :name, :site
       def chapter_list
-        raise NotImplementedError
+        raise Adapter::NotImplementedError
       end
 
       # Return Hash with keys: :uri, :name, :chapter, :manga, :site
       def chapter
-        raise NotImplementedError
+        raise Adapter::NotImplementedError
       end
 
       # Return Array of Hash with keys: :uri, :name, :site
       def page_list
-        raise NotImplementedError
+        raise Adapter::NotImplementedError
       end
 
       # Return Hash with keys: :uri, :name, :site
       def page
-        raise NotImplementedError
+        raise Adapter::NotImplementedError
       end
 
       def doc

data/lib/mangdown/chapter.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Mangdown
+  # Mangdown chapter object, which holds pages
   class Chapter
     include Equality
     include Enumerable
@@ -7,20 +10,13 @@ module Mangdown
     attr_accessor :adapter
 
     def initialize(uri, name, manga, chapter = nil)
-      @name = name 
+      @name = name
       @manga = manga
       @chapter = chapter
-      @uri = URI.escape(uri)
+      @uri = CGI.escape(uri)
       @pages = []
     end
 
-    def inspect
-      "#<#{self.class} @name=#{name} @uri=#{uri} " +
-      "@pages=[#{pages.first(3).join(',')}"       +
-      "#{",..." if pages.length > 3}]>"
-    end
-    alias_method :to_s, :inspect
-
     def each(&block)
       @pages.each(&block)
     end
@@ -79,7 +75,7 @@ module Mangdown
     def load_pages
       return @pages if @pages.any?
 
-      fetch_each_page do |page| @pages << page end
+      fetch_each_page { |page| @pages << page }
       @pages.sort_by!(&:name)
     end
 
@@ -87,13 +83,13 @@ module Mangdown
 
     def setup_download_dir!(dir)
       set_path(dir)
-      FileUtils.mkdir_p(to_path) unless Dir.exists?(to_path)
+      FileUtils.mkdir_p(to_path) unless Dir.exist?(to_path)
     end
 
     def fetch_each_page
       pages = build_page_hashes
-      page_data = Hash.new { |h, k| h[k] = "" }
-      Tools.hydra_streaming(pages, adapter.hydra_opts) do |status, page, data=nil|
+      page_data = Hash.new { |h, k| h[k] = +'' }
+      Tools.hydra_streaming(pages, adapter.hydra_opts) do |status, page, data = nil|
         case status
         when :before
           true
@@ -108,7 +104,8 @@ module Mangdown
 
     def build_page_hashes
       adapter.page_list.map do |page|
-        page.merge!(chapter: name, manga: manga)
+        page[:chapter] = name
+        page[:manga] = manga
         MDHash.new(page)
       end
     end
@@ -116,7 +113,8 @@ module Mangdown
     def get_page(uri, doc)
       adapter = Mangdown.adapter!(uri, nil, doc)
       page = adapter.page
-      page.merge!(chapter: name, manga: manga)
+      page[:chapter] = name
+      page[:manga] = manga
 
       MDHash.new(page)
     end

data/lib/mangdown/client.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require_relative '../mangdown'
 
+# Simple client for Mangdown
 module M
-  extend self
+  module_function
 
   DATA_FILE_PATH = Dir.home + '/.manga_list.yml'
   HELP_FILE_PATH = File.expand_path(
     '../../README.md', File.dirname(__FILE__)
   )
 
-  MANGA_PAGES = ['http://www.mangareader.net/alphabetical']
+  MANGA_PAGES = ['http://www.mangareader.net/alphabetical'].freeze
 
   # return a list of hash with :uri and :name of mangas found in list
   def find(search)
@@ -19,7 +22,9 @@ module M
 
   # cbz all subdirectories in a directory
   def cbz(dir)
-    Dir.exist?(dir) ? Mangdown::CBZ.all(dir) : raise(Errno::ENOENT, dir) 
+    Mangdown::CBZ.all(dir)
+  rescue => error
+    raise Mangdown::Error, "Failed to package #{dir}: #{error.message}"
   end
 
   # display help file
@@ -33,6 +38,7 @@ module M
   end
 
   private
+
   # convenience method to access the data file path
   def path
     DATA_FILE_PATH
@@ -40,12 +46,12 @@ module M
 
   # check if the data file is current
   def file_current?(f)
-    File.exists?(f) && File.mtime(f) > (Time.now - 604800)
+    File.exist?(f) && File.mtime(f) > (Time.now - 604_800)
   end
 
   # attempt to get the list from the data file
   def data_from_file
-    YAML.load(File.read(path)) if file_current?(path)
+    YAML.safe_load(File.read(path)) if file_current?(path)
   end
 
   # get saved current manga list, if data is less than a week old
@@ -54,13 +60,13 @@ module M
     data = data_from_file
     return Mangdown::MangaList.from_data(data) if data
 
-    list = MANGA_PAGES.inject([]) { |manga, uri|
+    list = MANGA_PAGES.inject([]) do |manga, uri|
       list = Mangdown::MDHash.new(uri: uri).to_manga_list
-      list.merge(manga) }
-    File.open(path, 'w+') { |f| f.write(list.to_yaml) } 
+      list.merge(manga)
+    end
+    File.open(path, 'w+') { |f| f.write(list.to_yaml) }
     list
-  rescue Object => error
-    puts "#{path} may be corrupt: #{error.message}"
-    raise
+  rescue => error
+    raise Mangdown::Error, "#{path} may be corrupt: #{error.message}"
   end
 end

data/lib/mangdown/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Top level library error
+module Mangdown
+  class Error < StandardError
+  end
+end

data/lib/mangdown/manga.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Mangdown
-  # mangdown manga object, which holds chapters
+  # Mangdown manga object, which holds chapters
   class Manga
     include Equality
     include Enumerable
@@ -10,17 +12,10 @@ module Mangdown
 
     def initialize(uri, name)
       @name = name
-      @uri = URI.escape(uri)
+      @uri = CGI.escape(uri)
       @chapters = []
     end
 
-    def inspect
-      "#<#{self.class} @name=#{name} @uri=#{uri} " +
-      "@chapters=[#{chapters.first(3).join(',')}" +
-      "#{",..." if chapters.length > 3}]>"
-    end
-    alias_method :to_s, :inspect
-
     def cbz
       CBZ.all(to_path)
     end
@@ -28,7 +23,7 @@ module Mangdown
     def download(*args)
       download_to(nil, *args)
     end
-    
+
     # download using enumerable
     def download_to(dir, start = 0, stop = -1, opts = { force_download: false })
       start, stop = validate_indeces!(start, stop)
@@ -40,7 +35,7 @@ module Mangdown
       chapters[start..stop].each do |md_hash|
         chapter = md_hash.to_chapter
         chapter_result = chapter.download_to(to_path, opts)
-        
+
         if chapter_result[:failed].any?
           failed << chapter
         elsif chapter_result[:succeeded].any?
@@ -48,18 +43,17 @@ module Mangdown
         elsif chapter_result[:skipped].any?
           skipped << chapter
         end
-        if chapter_result[:failed].any?
-          logger.error({
-            msg: "Chapter was not fully downloaded",
-            uri: chapter.uri,
-            chapter: chapter.name
-          }.to_s)
-        end
+        next unless chapter_result[:failed].any?
+        logger.error({
+          msg: 'Chapter was not fully downloaded',
+          uri: chapter.uri,
+          chapter: chapter.name
+        }.to_s)
       end
       { failed: failed, succeeded: succeeded, skipped: skipped }
     end
 
-    def to_manga 
+    def to_manga
       self
     end
 
@@ -68,19 +62,19 @@ module Mangdown
     end
 
     def set_path(dir = nil)
-      dir ||= DOWNLOAD_DIR 
+      dir ||= DOWNLOAD_DIR
       path = File.join(dir, name)
       @path = Tools.relative_or_absolute_path(path)
     end
 
     def each(&block)
       @chapters.each(&block)
-    end 
+    end
 
     def load_chapters
       @chapters += adapter.chapter_list.map do |chapter|
-         chapter.merge!(manga: name)
-         MDHash.new(chapter)
+        chapter[:manga] = name
+        MDHash.new(chapter)
       end
     end
 
@@ -88,26 +82,26 @@ module Mangdown
 
     def chapter_indeces(start, stop)
       length = chapters.length
-      [start, stop].map { |i| i < 0 ? length + i : i }
+      [start, stop].map { |i| i.negative? ? length + i : i }
     end
 
     def setup_download_dir!(dir)
-      set_path(dir) 
+      set_path(dir)
       FileUtils.mkdir_p(to_path) unless Dir.exist?(to_path)
     end
 
     def validate_indeces!(start, stop)
-      chapter_indeces(start, stop).tap { |i_start, i_stop|
+      chapter_indeces(start, stop).tap do |i_start, i_stop|
         last = chapters.length - 1
 
         if i_start > last || i_stop > last
           error = "This manga has chapters in the range (0..#{last})"
-          raise ArgumentError, error
+          raise Mangdown::Error, error
         elsif i_stop < i_start
           error = 'Last index must be greater than or equal to first index'
-          raise ArgumentError, error
-        end 
-      }
+          raise Mangdown::Error, error
+        end
+      end
     end
   end
 end

data/lib/mangdown/manga_list.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Mangdown
+  # Mangdown manga list, which holds manga
   class MangaList
     include Enumerable
 
     def self.from_data(manga)
-      new(manga) 
+      new(manga)
     end
 
     attr_reader :manga
@@ -17,7 +20,7 @@ module Mangdown
 
     def each(&block)
       manga.each(&block)
-    end 
+    end
 
     def to_yaml
       @manga.map(&:to_hash).to_yaml
@@ -26,15 +29,15 @@ module Mangdown
     def load_manga(uri)
       adapter = Mangdown.adapter!(uri)
 
-      manga = adapter.manga_list.map { |manga| MDHash.new(manga) }
-      
+      manga = adapter.manga_list.map { |m| MDHash.new(m) }
+
       merge(manga)
     end
 
     def merge(other)
       @manga += other.to_ary
 
-      return self
+      self
     end
   end
 end

data/lib/mangdown/md_hash.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module Mangdown
+  # Mangdown hash like object that can be converted to other Mangdown objects.
   class MDHash
     include Equality
     include Properties
 
+    attr_reader :adapter
+
     properties :name, :uri, :manga, :chapter, :site
 
     def initialize(options = {})
@@ -15,7 +20,7 @@ module Mangdown
 
       @adapter = Mangdown.adapter!(uri, site, nil, name)
 
-      @uri = URI.escape(uri)
+      @uri = CGI.escape(uri)
       @site = adapter.site
     end
 
@@ -29,10 +34,8 @@ module Mangdown
 
     def to_manga
       type_error('manga') unless adapter.is_manga?
-      
-      if name.to_s.empty?
-        fill_properties(adapter.manga)
-      end
+
+      fill_properties(adapter.manga) if name.to_s.empty?
 
       manga = Manga.new(uri, name)
       manga.adapter = adapter
@@ -55,20 +58,16 @@ module Mangdown
       chapter
     end
 
-    def to_page 
+    def to_page
       type_error('page') unless adapter.is_page?
 
       Page.new(uri, name, manga, chapter)
-    end 
+    end
 
     private
 
-    def adapter
-      @adapter
-    end
-
     def type_error(type)
-      raise NoMethodError, "This is not a known #{type} type"
+      raise Mangdown::Error, "This is not a known #{type} type"
     end
   end
 end

data/lib/mangdown/page.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Mangdown
+  # Mangdown page
   class Page
     include Equality
     include Logging
@@ -9,13 +12,13 @@ module Mangdown
       @name = Tools.valid_path_name(name)
       @chapter = chapter
       @manga = manga
-      @uri = URI.escape(uri) 
+      @uri = CGI.escape(uri)
     end
 
-    # explicit conversion to page 
+    # explicit conversion to page
     def to_page
       self
-    end 
+    end
 
     def to_path
       @path ||= set_path
@@ -27,16 +30,13 @@ module Mangdown
     def set_path(dir = nil)
       dir ||= File.join(manga, chapter)
       dir = Tools.valid_path_name(dir)
-      if Dir.exist?(dir)
-        file = Dir.entries(dir).find { |f| f[name] }
-      end
+      file = Dir.entries(dir).find { |f| f[name] } if Dir.exist?(dir)
       path = File.join(dir, file || name)
       @path = Tools.relative_or_absolute_path(path)
     end
 
     # downloads to specified directory
-    def download_to(dir = Dir.pwd, opts = { force_download: false })
-      # cleanup existing file (all extensions)
+    def download_to(dir = Dir.pwd, force_download: false)
       delete_files!(dir) if opts[:force_download]
 
       return if file_exist?(dir)
@@ -56,8 +56,8 @@ module Mangdown
       }.to_s)
     end
 
-    def append_file_data(dir, data)
-      File.open(to_path, 'ab') { |file| file.write(data) } 
+    def append_file_data(_dir, data)
+      File.open(to_path, 'ab') { |file| file.write(data) }
     end
 
     def append_file_ext(dir = nil)
@@ -75,10 +75,9 @@ module Mangdown
       Dir.entries(dir).any? { |file| file.to_s[to_path.basename.to_s] }
     end
 
+    # cleanup existing file (all extensions)
     def delete_files!(dir)
-      while set_path(dir) && File.exist?(to_path)
-        File.delete(to_path)
-      end
+      File.delete(to_path) while set_path(dir) && File.exist?(to_path)
     end
   end
 end

data/lib/mangdown/support/cbz.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Mangdown
+  # Package manga or chapter directories into .cbz archive files
   module CBZ
     class << self
       extend Tools
@@ -6,7 +9,7 @@ module Mangdown
       def all(main_dir)
         main_dir = String(main_dir)
         main_dir = validate_file_or_dir_names(main_dir)
-        each_dir_or_page(main_dir) { |dir| validate_file_or_dir_names(dir)}
+        each_dir_or_page(main_dir) { |dir| validate_file_or_dir_names(dir) }
         cbz_sub_dirs(main_dir)
       end
 
@@ -19,14 +22,14 @@ module Mangdown
       private
 
       def cbz_dir(dir)
-        dir = dir.to_s.sub(/\/*$/, "")
-        
+        dir = dir.to_s.sub(/\/*$/, '')
+
         zip_filename = dir + '.cbz'
         return if File.exist?(zip_filename)
 
         ::Zip::File.open(zip_filename, ::Zip::File::CREATE) do |zip|
           file_matcher = File.join(dir, '**', '**')
-          dir << "/"
+          dir << '/'
 
           Dir.glob(file_matcher).each do |file|
             filename = file.sub(dir, '')
@@ -39,14 +42,14 @@ module Mangdown
         each_dir_or_page(dir) do |sub_dir|
           cbz_dir(sub_dir)
         end
-      end 
+      end
 
       def each_dir_or_page(dir)
-        Dir.glob(dir + '/*').each do |filename| 
+        Dir.glob(dir + '/*').each do |filename|
           next if filename.include?('.cbz')
           yield(filename)
         end
-      end 
+      end
 
       def validate_file_or_dir_names(dir)
         each_dir_or_page(dir) do |filename|

data/lib/mangdown/support/equality.rb

@@ -1,9 +1,12 @@
-module Mangdown 
+# frozen_string_literal: true
+
+module Mangdown
+  # Mangdown object equality
   module Equality
     include Comparable
 
     def <=>(other)
-      self.name <=> other.name
+      name <=> other.name
     end
   end
 end

data/lib/mangdown/support/logging.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module Mangdown
+  # Configure and access the Mangdown logger
   module Logging
-
     private
 
     def logger

data/lib/mangdown/support/properties.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module Mangdown
+  # Provide hash-like access for object attributes
   module Properties
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     def properties
-      keys = self.class.property_names
+      keys = self.class.properties
       values = keys.map { |name| self[name] }
       Hash[keys.zip(values)]
     end
@@ -33,15 +36,15 @@ module Mangdown
       properties.to_s
     end
 
+    # Macro for setting property names
     module ClassMethods
       def properties(*names)
-        @properties = names
+        @properties ||= []
+        return @properties if names.empty?
+
+        @properties.concat(names).uniq!
         attr_accessor(*names)
       end
-      
-      def property_names
-        @properties || []
-      end
     end
   end
 end

data/lib/mangdown/support/tools.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'typhoeus'
 
 Typhoeus::Config.verbose = $DEBUG
 
 module Mangdown
+  # Common helpers
   module Tools
     class << self
-  
       def get_doc(uri)
         data = get(uri)
-        @doc = ::Nokogiri::HTML(data)
+        @doc = Nokogiri::HTML(data)
       end
 
       def get(uri)
@@ -17,7 +19,7 @@ module Mangdown
       end
 
       def get_root(uri)
-        uri = ::URI.parse(uri)
+        uri = URI.parse(uri)
         @root = "#{uri.scheme}://#{uri.host}"
       end
 
@@ -28,9 +30,9 @@ module Mangdown
       def valid_path_name(name)
         name.to_s.sub(/(\d+)(\.\w+)*\Z/) do
           digits, ext = Regexp.last_match[1..2]
-          digits.to_i.to_s.rjust(5, "0") + ext.to_s
+          digits.to_i.to_s.rjust(5, '0') + ext.to_s
         end
-      end 
+      end
 
       def image_extension(path)
         path = path.to_s
@@ -44,7 +46,7 @@ module Mangdown
       def hydra_streaming(objects, hydra_opts = {})
         hydra = Typhoeus::Hydra.new(hydra_opts)
 
-        requests = objects.map { |obj| 
+        requests = objects.map do |obj|
           next unless yield(:before, obj)
 
           request = typhoeus(obj.uri)
@@ -53,15 +55,15 @@ module Mangdown
             yield(status, obj)
           end
           request.on_body do |chunk|
-            yield(:body, obj, chunk) 
+            yield(:body, obj, chunk)
           end
-          request.on_complete do |response|
+          request.on_complete do |_response|
             yield(:complete, obj)
           end
 
           hydra.queue(request)
           request
-        }.compact
+        end.compact
 
         hydra.run
         requests
@@ -73,7 +75,9 @@ module Mangdown
 
       def typhoeus_options
         {
-          headers: { "User-Agent" => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.62 Safari/537.36' }
+          headers: {
+            'User-Agent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.62 Safari/537.36'
+          }
         }
       end
 

data/lib/mangdown/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mangdown
-  VERSION = "0.15.1"
+  VERSION = '0.16.0'
 end

data/lib/mangdown.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'nokogiri'
 require 'yaml'
 require 'zip'
 require 'filemagic'
+require 'cgi'
+
+require_relative 'mangdown/error'
 
 require_relative 'mangdown/support/logging'
 require_relative 'mangdown/support/equality'
@@ -18,31 +23,34 @@ require_relative 'mangdown/md_hash'
 require_relative 'mangdown/adapter'
 require_relative 'mangdown/adapter/proxy'
 require_relative 'mangdown/adapter/no_adapter_error'
+require_relative 'mangdown/adapter/not_implemented_error'
 require_relative 'mangdown/adapter/mangareader.rb'
 
+# Find, download and package manga from the web
 module Mangdown
-  ADAPTERS = {}
-
   DOWNLOAD_DIR ||= Dir.home + '/manga'
 
-  def self.register_adapter(name, adapter)
-    ADAPTERS[name] = adapter
+  module_function
+
+  def register_adapter(name, adapter)
+    adapters[name] = adapter
   end
 
-  def self.adapter(name)
-    ADAPTERS[name]
+  def adapter(name)
+    adapters[name]
   end
 
-  def self.adapter!(uri, site = nil, doc = nil, name = nil)
+  def adapter!(uri, site = nil, doc = nil, name = nil)
     adapter_name = (uri || site).to_s
-    klass = ADAPTERS.values.find { |adapter| adapter.for?(adapter_name) }
+    klass = adapters.values.find { |adapter| adapter.for?(adapter_name) }
 
     raise Adapter::NoAdapterError, adapter_name unless klass
 
     Adapter::Proxy.new(klass.new(uri, doc, name))
   end
 
-  class Error < StandardError
+  def adapters
+    @adapters ||= {}
   end
 end
 

data/test/lib/mangdown/chapter_test.rb

@@ -22,18 +22,6 @@ module Mangdown
       assert_equal 'adapter', @chapter.adapter
     end
 
-    def test_inspect_differs_from_object_inspect
-      unbound_inspect = Object.instance_method(:inspect)
-
-      refute_equal unbound_inspect.bind(@chapter).call(), @chapter.inspect
-    end
-
-    def test_to_s_differs_from_object_to_s
-      unbound_to_s = Object.instance_method(:to_s)
-
-      refute_equal unbound_to_s.bind(@chapter).call(), @chapter.to_s
-    end
-
     def test_cbz
       CBZ.class_eval do
         class << self

data/test/lib/mangdown/manga_test.rb

@@ -17,20 +17,6 @@ module Mangdown
       assert_equal 'adapter', manga.adapter
     end
 
-    def test_inspect_differs_from_object_inspect
-      unbound_inspect = Object.instance_method(:inspect)
-      manga = Manga.new('uri', 'name')
-
-      refute_equal unbound_inspect.bind(manga).call(), manga.inspect
-    end
-
-    def test_to_s_differs_from_object_to_s
-      unbound_to_s = Object.instance_method(:to_s)
-      manga = Manga.new('uri', 'name')
-
-      refute_equal unbound_to_s.bind(manga).call(), manga.to_s
-    end
-
     def test_cbz
       CBZ.class_eval do
         class << self

data/test/lib/mangdown_test.rb

@@ -7,15 +7,15 @@ class MangdownTest < Minitest::Test
   end
 
   def test_register_adapter
-    adapters_before = Mangdown::ADAPTERS.length
+    adapters_before = Mangdown.adapters.length
 
     bogus = Class.new(Mangdown::Adapter::Base)
 
     Mangdown.register_adapter(:bogus_adapter, bogus)
 
-    assert Mangdown::ADAPTERS.length == adapters_before + 1
+    assert Mangdown.adapters.length == adapters_before + 1
 
-    Mangdown::ADAPTERS.delete(:bogus_adapter)
+    Mangdown.adapters.delete(:bogus_adapter)
   end
 
   def test_adapter
@@ -32,13 +32,13 @@ class MangdownTest < Minitest::Test
       "test", nil, doc, "test"
     ).adapter
 
-    adapters = Mangdown::ADAPTERS.dup
-    Mangdown::ADAPTERS.clear
+    adapters = Mangdown.adapters.dup
+    Mangdown.adapters.clear
 
     assert_raises(Mangdown::Adapter::NoAdapterError) { 
       Mangdown.adapter!(nil) 
     }
 
-    Mangdown::ADAPTERS.merge!(adapters)
+    Mangdown.adapters.merge!(adapters)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mangdown
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - jphager2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2017-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -134,9 +134,11 @@ files:
 - lib/mangdown/adapter.rb
 - lib/mangdown/adapter/mangareader.rb
 - lib/mangdown/adapter/no_adapter_error.rb
+- lib/mangdown/adapter/not_implemented_error.rb
 - lib/mangdown/adapter/proxy.rb
 - lib/mangdown/chapter.rb
 - lib/mangdown/client.rb
+- lib/mangdown/error.rb
 - lib/mangdown/manga.rb
 - lib/mangdown/manga_list.rb
 - lib/mangdown/md_hash.rb