mangdown 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ceaa6642dfcb70513d084ec3b636d2c0855a9928
-  data.tar.gz: e6f2920b7f48afb586aeb038543a2f32ac6e1267
+  metadata.gz: 087f4e2f6ce88163a9edb3f661b8cfaacdab3056
+  data.tar.gz: bb4f4ac0cd6c9b8197c99d982b7df0daf8826875
 SHA512:
-  metadata.gz: e6ef238870bac0cd688769574919aea5ab8dffcd59b52f17ce1cbe315310179394c572972ffa34045a036a4f1d7eb200700a12ff9fb2e00756bb8b3afceddc8a
-  data.tar.gz: f9c15ca24c70f1abd1eabbe33af7a90ed68f300fe5397877a8a76ab3ee1966d9cd2e2b4337871a637c0a0dcd3bbbbc6c86b6df7bd1feefe2dc3933849ae3f606
+  metadata.gz: f8e9352f01b656133205c0e3ae98f4f9f1cbe04313c2a8b4131d2bdf20016f495d90d6472e895c8e7e67f095f68cc88e35f4d34e291af6265861c914891fc331
+  data.tar.gz: 717a840d6823ae74e27be19c0eb95e916d572fdc248d25c19b5565c6e95bf34c60e55b316a88264025e24a6b906f3fa69e4ff74fc40dfdab0d8699ffca5c7c56

data/README.md

@@ -1,5 +1,18 @@
 ![Gitten badge](http://gittens.r15.railsrumble.com//badge/jphager2/mangdown)
 
+## Adapters [New]
+Check out lib/mangdown/adapter.rb and lib/mangdown/adapters/mangareader.rb for examples of how to build an adapter.
+
+### Register an adapter
+
+```
+# Register an adapter (AdapterClass) with the name :name
+Mangdown.register_adapter(:name, AdpaterClass)
+```
+
+### Bundled adapters
+There is only one adapter bundled with mangdown, but it is fairly simple to create one, so go ahead and give it a try. Feel free to file an issue if you have any problems.
+
 There is a simple built-in client, "M", that you can use for finding manga:
 
 ```ruby

data/lib/mangdown/adapter/mangareader.rb

@@ -64,7 +64,7 @@ module Mangdown
       (1..last_page).map { |page|  
         slug = manga_name.gsub(' ', '-').gsub(/[:,]/, '')
         uri = "#{root}/#{slug}/#{chapter_number}/#{page}"
-        uri = Mangdown::Uri.new(uri).downcase 
+        uri = URI.escape(uri).downcase 
 
         { uri: uri, name: page, site: site } }
     end

data/lib/mangdown/adapter.rb

@@ -12,7 +12,7 @@ module Mangdown
         site ? @_site = site : @_site
       end
       
-      attr_reader :uri, :doc, :name
+      attr_reader :uri, :name
       def initialize(uri, doc, name)
         @uri = uri
         @doc = doc
@@ -73,7 +73,6 @@ module Mangdown
         raise NotImplementedError
       end
 
-      private
       def doc
         @doc ||= Tools.get_doc(uri)
       end

data/lib/mangdown/chapter.rb

@@ -1,6 +1,5 @@
 module Mangdown
   class Chapter
-
     include Equality
     include Enumerable
 
@@ -11,7 +10,7 @@ module Mangdown
       @name = name 
       @manga = manga
       @chapter = chapter
-      @uri = Mangdown::Uri.new(uri)
+      @uri = URI.escape(uri)
       @pages = []
     end
 
@@ -22,12 +21,10 @@ module Mangdown
     end
     alias_method :to_s, :inspect
 
-    # enumerates through pages
     def each(&block)
       @pages.each(&block)
     end
 
-    # explicit conversion to chapter
     def to_chapter
       self
     end
@@ -47,7 +44,6 @@ module Mangdown
       CBZ.one(dir)
     end
 
-    # download all pages in a chapter
     def download_to(dir = nil, opts = { force_download: false })
       pages = map(&:to_page)
       failed = []
@@ -88,30 +84,36 @@ module Mangdown
     end
 
     private
+
     def setup_download_dir!(dir)
       set_path(dir)
       FileUtils.mkdir_p(to_path) unless Dir.exists?(to_path)
     end
 
-    # get page objects for all pages in a chapter
     def fetch_each_page
       pages = build_page_hashes
-      Tools.hydra(pages) do |page, body|
-        page = get_page(page.uri, Nokogiri::HTML(body))
-        yield(page)
+      page_data = Hash.new { |h, k| h[k] = "" }
+      Tools.hydra_streaming(pages) do |status, page, data=nil|
+        case status
+        when :before
+          true
+        when :body
+          page_data[page] << data
+        when :complete
+          page = get_page(page.uri, Nokogiri::HTML(page_data[page]))
+          yield(page)
+        end
       end
     end
 
-    # get the docs for number of pages 
     def build_page_hashes
-      adapter.page_list.map { |page|
+      adapter.page_list.map do |page|
         page.merge!(chapter: name, manga: manga)
-        MDHash.new(page) }
+        MDHash.new(page)
+      end
     end
 
-    # get the page name and uri
     def get_page(uri, doc)
-      # Local binding for adapter
       adapter = Mangdown.adapter!(uri, nil, doc)
       page = adapter.page
       page.merge!(chapter: name, manga: manga)

data/lib/mangdown/manga.rb

@@ -1,18 +1,16 @@
-require 'progress_bar'
-
 module Mangdown
   # mangdown manga object, which holds chapters
   class Manga
-
     include Equality
     include Enumerable
+    include Logging
 
     attr_reader :uri, :chapters, :name
     attr_accessor :adapter
 
     def initialize(uri, name)
       @name = name
-      @uri = Mangdown::Uri.new(uri)
+      @uri = URI.escape(uri)
       @chapters = []
     end
 
@@ -27,7 +25,6 @@ module Mangdown
       CBZ.all(to_path)
     end
 
-    # download to current directory convenience method
     def download(*args)
       download_to(nil, *args)
     end
@@ -40,7 +37,6 @@ module Mangdown
       succeeded = []
       skipped = []
 
-      bar = progress_bar(start, stop)
       chapters[start..stop].each do |md_hash|
         chapter = md_hash.to_chapter
         chapter_result = chapter.download_to(to_path, opts)
@@ -53,15 +49,12 @@ module Mangdown
           skipped << chapter
         end
         if chapter_result[:failed].any?
-          STDERR.puts("error: #{chapter.name} was not fully downloaded") 
-        else
-          bar.increment!
+          logger.error "#{chapter.name} was not fully downloaded"
         end
       end
       { failed: failed, succeeded: succeeded, skipped: skipped }
     end
 
-    # explicit conversion to manga
     def to_manga 
       self
     end
@@ -76,19 +69,19 @@ module Mangdown
       @path = Tools.relative_or_absolute_path(path)
     end
 
-    # each for enumerating through chapters
     def each(&block)
       @chapters.each(&block)
     end 
 
-    # push MDHashes of manga chapters to @chapters 
     def load_chapters
-      @chapters += adapter.chapter_list.map { |chapter|
+      @chapters += adapter.chapter_list.map do |chapter|
          chapter.merge!(manga: name)
-         MDHash.new(chapter) }
+         MDHash.new(chapter)
+      end
     end
 
     private
+
     def chapter_indeces(start, stop)
       length = chapters.length
       [start, stop].map { |i| i < 0 ? length + i : i }
@@ -112,10 +105,5 @@ module Mangdown
         end 
       }
     end
-
-    # create a progress bar object for start and stop indexes
-    def progress_bar(start, stop)
-      ProgressBar.new(stop - start + 1)
-    end
   end
 end

data/lib/mangdown/manga_list.rb

@@ -8,6 +8,9 @@ module Mangdown
 
     attr_reader :manga
 
+    alias to_a manga
+    alias to_ary manga
+
     def initialize(manga = [])
       @manga = manga.map! { |hash| MDHash.new(hash) }
     end
@@ -28,12 +31,8 @@ module Mangdown
       merge(manga)
     end
 
-    def to_a
-      manga
-    end
-
     def merge(other)
-      @manga += other.to_a
+      @manga += other.to_ary
 
       return self
     end

data/lib/mangdown/md_hash.rb

@@ -7,83 +7,68 @@ module Mangdown
 
     def initialize(options = {})
       uri = options.fetch(:uri)
-      name = options[:name]
       site = options[:site]
+
+      @name = options[:name]
+      @manga = options[:manga]
+      @chapter = options[:chapter]
+
       @adapter = Mangdown.adapter!(uri, site, nil, name)
 
-      self.name = name
-      self.uri = Mangdown::Uri.new(uri)
-      self.site = @adapter.site
-      self.manga = options[:manga]
-      self.chapter = options[:chapter]
+      @uri = URI.escape(uri)
+      @site = adapter.site
     end
 
-    # explicit conversion to manga list
     def to_manga_list
-      # Seems weird to do it this way, but this is to intentially make it 
-      # more tedious to create a Mangadown::Manga object 
-      # (outsite of this method)
-      #
-      if @adapter.is_manga_list?
-        list = MangaList.new
-        list.load_manga(uri)
-        list
-      else
-        raise NoMethodError, 'This is not a known manga list type'
-      end
+      type_error('manga_list') unless adapter.is_manga_list?
+
+      list = MangaList.new
+      list.load_manga(uri)
+      list
     end
 
-    # explicit conversion to manga 
     def to_manga
-      # Seems weird to do it this way, but this is to intentially make it 
-      # more tedious to create a Mangadown::Manga object 
-      # (outsite of this method)
-      #
-      if @adapter.is_manga?
-        if name.to_s.empty?
-          properties.merge!(@adapter.manga) { |_, before, after| 
-            before || after }
-        end
-
-        manga = Manga.new(uri, name)
-        manga.adapter = @adapter
-        manga.load_chapters
-        manga
-      else
-        raise NoMethodError, 'This is not a known manga type'
+      type_error('manga') unless adapter.is_manga?
+      
+      if name.to_s.empty?
+        fill_properties(adapter.manga)
       end
+
+      manga = Manga.new(uri, name)
+      manga.adapter = adapter
+      manga.load_chapters
+      manga
     end
 
-    # explicit conversion to chapter 
     def to_chapter
-      # Seems weird to do it this way, but this is to intentially make it 
-      # more tedious to create a Mangadown::Chapter object 
-      # (outsite of this method)
-      #
-      if @adapter.is_chapter?
-        if name.to_s.empty? || manga.to_s.empty? || chapter.to_s.empty?
-          properties.merge!(@adapter.chapter) { |_, before, after| 
-            before || after }
-        end
-        # Get a local binding
-        number = chapter
-
-        chapter = Chapter.new(uri, name, manga, number)
-        chapter.adapter = @adapter
-        chapter.load_pages
-        chapter
-      else
-        raise NoMethodError, 'This is not a known chapter type'
+      type_error('chapter') unless adapter.is_chapter?
+
+      if name.to_s.empty? || manga.to_s.empty? || chapter.to_s.empty?
+        fill_properties(adapter.chapter)
       end
+
+      number = chapter
+
+      chapter = Chapter.new(uri, name, manga, number)
+      chapter.adapter = adapter
+      chapter.load_pages
+      chapter
     end
 
-    # explicit conversion to page 
     def to_page 
-      if @adapter.is_page?
-        Page.new(uri, name, manga, chapter)
-      else
-        raise NoMethodError, 'This is not a known page type'
-      end
+      type_error('page') unless adapter.is_page?
+
+      Page.new(uri, name, manga, chapter)
     end 
+
+    private
+
+    def adapter
+      @adapter
+    end
+
+    def type_error(type)
+      raise NoMethodError, "This is not a known #{type} type"
+    end
   end
 end

data/lib/mangdown/page.rb

@@ -1,7 +1,7 @@
 module Mangdown
   class Page
-
     include Equality
+    include Logging
 
     attr_reader :uri, :name, :manga, :chapter
 
@@ -9,7 +9,7 @@ module Mangdown
       @name = Tools.valid_path_name(name)
       @chapter = chapter
       @manga = manga
-      @uri = Mangdown::Uri.new(uri) 
+      @uri = URI.escape(uri) 
     end
 
     # explicit conversion to page 
@@ -46,7 +46,7 @@ module Mangdown
       append_file_data(dir, image)
       append_file_ext(dir)
     rescue => error # SocketError not defined?
-      STDERR.puts( "#{error.message} | #{name} | #{uri}" )
+      logger.error "#{error.message} | #{name} | #{uri}"
     end
 
     def append_file_data(dir, data)
@@ -56,7 +56,7 @@ module Mangdown
     def append_file_ext(dir = nil)
       set_path(dir) if dir
       path = to_path
-      ext = Tools.file_type(path)
+      ext = Tools.image_extension(path)
       filename = "#{path}.#{ext}"
 
       FileUtils.mv(path, filename)

data/lib/mangdown/support/cbz.rb

@@ -0,0 +1,65 @@
+module Mangdown
+  module CBZ
+    class << self
+      extend Tools
+
+      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)}
+        cbz_sub_dirs(main_dir)
+      end
+
+      def one(dir)
+        dir = String(dir)
+        dir = validate_file_or_dir_names(dir)
+        cbz_dir(dir)
+      end
+
+      private
+
+      def cbz_dir(dir)
+        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.glob(file_matcher).each do |file|
+            filename = file.sub(dir, '')
+            zip.add(filename, file)
+          end
+        end
+      end
+
+      def cbz_sub_dirs(dir)
+        each_dir_or_page(dir) do |sub_dir|
+          cbz_dir(sub_dir)
+        end
+      end 
+
+      def each_dir_or_page(dir)
+        Dir.glob(dir + '/*').each do |filename| 
+          next if filename.include?('.cbz')
+          yield(filename)
+        end
+      end 
+
+      def validate_file_or_dir_names(dir)
+        each_dir_or_page(dir) do |filename|
+          rename_with_valid_name(filename)
+        end
+        rename_with_valid_name(dir)
+      end
+
+      def rename_with_valid_name(filename)
+        checked_name = Tools.valid_path_name(filename)
+        File.rename(filename, checked_name)
+        checked_name
+      end
+    end
+  end
+end

data/lib/mangdown/support/logging.rb

@@ -0,0 +1,25 @@
+require 'logger'
+
+module Mangdown
+  module Logging
+
+    private
+
+    def logger
+      Mangdown.logger
+    end
+  end
+
+  class << self
+    def logger
+      @logger ||= configure_logger(file: STDOUT)
+    end
+
+    def configure_logger(options = {})
+      logger_args = options.fetch(:logger_args) { [options[:file]] }
+      @logger = Logger.new(*logger_args)
+      @logger.level = options.fetch(:level, Logger::DEBUG)
+      @logger
+    end
+  end
+end

data/lib/mangdown/support/properties.rb

@@ -0,0 +1,47 @@
+module Mangdown
+  module Properties
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def properties
+      keys = self.class.property_names
+      values = keys.map { |name| self[name] }
+      Hash[keys.zip(values)]
+    end
+    alias to_hash properties
+
+    def fill_properties(other)
+      other.each do |property, value|
+        self[property] = value if self[property].to_s.empty?
+      end
+    end
+
+    def [](key)
+      instance_variable_get("@#{key}")
+    end
+
+    def []=(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def inspect
+      properties.inspect
+    end
+
+    def to_s
+      properties.to_s
+    end
+
+    module ClassMethods
+      def properties(*names)
+        @properties = names
+        attr_accessor(*names)
+      end
+      
+      def property_names
+        @properties || []
+      end
+    end
+  end
+end

data/lib/mangdown/support/tools.rb

@@ -0,0 +1,77 @@
+require 'pathname'
+require 'typhoeus'
+
+module Mangdown
+  module Tools
+    class << self
+  
+      def get_doc(uri)
+        data = get(uri)
+        @doc = ::Nokogiri::HTML(data)
+      end
+
+      def get(uri)
+        Typhoeus.get(uri).body
+      end
+
+      def get_root(uri)
+        uri = ::URI.parse(uri)
+        @root = "#{uri.scheme}://#{uri.host}"
+      end
+
+      def relative_or_absolute_path(*sub_paths)
+        Pathname.new(Dir.pwd).join(*sub_paths)
+      end
+
+      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
+        end
+      end 
+
+      def image_extension(path)
+        path = path.to_s
+
+        return unless File.exist?(path)
+
+        mime = FileMagic.new(:mime).file(path)
+        mime_to_extension(mime)
+      end
+
+      def hydra_streaming(objects)
+        hydra = Typhoeus::Hydra.hydra
+
+        requests = objects.map { |obj| 
+          next unless yield(:before, obj)
+
+          request = Typhoeus::Request.new(obj.uri)
+          request.on_headers do |response|
+            status = response.success? ? :succeeded : :failed
+            yield(status, obj)
+          end
+          request.on_body do |chunk|
+            yield(:body, obj, chunk) 
+          end
+          request.on_complete do |response|
+            yield(:complete, obj)
+          end
+
+          hydra.queue(request)
+          request
+        }.compact
+
+        hydra.run
+        requests
+      end
+
+      private
+
+      def mime_to_extension(mime)
+        return unless mime.start_with?('image')
+
+        mime.split(';').first.split('/').last
+      end
+    end
+  end
+end

data/lib/mangdown/version.rb

@@ -1,3 +1,3 @@
 module Mangdown
-  VERSION = "0.14.0"
+  VERSION = "0.14.1"
 end

data/lib/mangdown.rb

@@ -4,15 +4,15 @@ require 'yaml'
 require 'zip'
 require 'filemagic'
 
-require_relative 'mangdown/equality'
-require_relative 'mangdown/properties'
-require_relative 'mangdown/tools'
-require_relative 'mangdown/uri'
+require_relative 'mangdown/support/logging'
+require_relative 'mangdown/support/equality'
+require_relative 'mangdown/support/properties'
+require_relative 'mangdown/support/tools'
+require_relative 'mangdown/support/cbz'
 require_relative 'mangdown/page'
 require_relative 'mangdown/chapter'
 require_relative 'mangdown/manga'
 require_relative 'mangdown/manga_list.rb'
-require_relative 'mangdown/cbz'
 require_relative 'mangdown/md_hash'
 
 require_relative 'mangdown/adapter'