webcomics 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acc162cea31a18739e9d28f85e36b301632667e3
-  data.tar.gz: 0cd91dcb5ac11bdca46f9dbe52bb0653b313483e
+  metadata.gz: e7f24b4b88e65cdbb40396fedae879b6ad3f7c98
+  data.tar.gz: a7ff820f56bdb16d30d5e9b4b392dfdf51d6a88a
 SHA512:
-  metadata.gz: 69a88a539c423e2d88f4d608dfc4ef1049f919a6fd7e3eda177033fa41fca1fb618fadb2434bb8ad86eda51e190228365ed6f8680f5ff8542c4f6da058bad2c3
-  data.tar.gz: 669b0f4e92db6069ab8f8f843861c844774fa98b6e9d6edbd1438552c20341eeab42d2fce7b8d913efb7775ba158022826d57378f1365d816dacbbe4a06dd287
+  metadata.gz: eb23e4c9ebfa39f4b0956ab23184154d25dda7545d4a4fee321d8e283879d209f52d5ed593e62df9d4ad3f75acdb8700248d998dc7b7b68d43c7d092d46bc38e
+  data.tar.gz: 0c5527550e1013089a2179e94c8b88285ecea6839a5128bf20643e986b852f4c2af61ae9b326ec4d4d9568213a67534144688ee44fea353210ab310728e2bb7e

data/lib/comics_cbz.rb

@@ -0,0 +1,55 @@
+require 'zip'
+
+module WebComics
+  class CBZ < ComicsDir
+    attr_accessor :cbz
+
+    def self.cbz_or_zip?(file)
+      if File.extname(file) == ".cbz" || File.extname(file) == ".zip"
+      	return true
+      else
+      	return false
+      end
+    end
+
+    def list_cbz_files
+      files_list = []
+      list_files.each do |cbz|
+        files_list.push(cbz) if CBZ.cbz_or_zip?(cbz)
+      end
+
+      files_list
+    end
+
+    def list_pages_inside(xml_ignore = true)
+      files_list = []
+      Zip::File.open("#{@series}/#{@cbz}") do |cbz|
+        cbz.each do |pages|
+          files_list.push(pages.name)
+        end
+      end
+
+      return CBZ.ignore_xml(files_list) if xml_ignore
+
+      files_list
+    end
+
+    def extract(index = 0)
+      @page = nil
+      Zip::File.open("#{@series}/#{@cbz}") do |cbz|
+        @page = cbz.extract(list_pages_inside[index], list_pages_inside[index])
+      end
+
+      @page
+    end
+
+    def self.ignore_xml(list)
+      files_list = []
+      list.each do |entry|
+        files_list.push(entry) if File.extname(entry) != ".xml"
+      end
+
+      files_list
+    end
+  end
+end

data/lib/comics_db.rb

@@ -1,7 +1,24 @@
-require "fileutils"
+module WebComics
+  class ComicsDB
+    attr_accessor :db_record
+    attr_accessor :assets
 
+    def exists?
+      asset_names = []
+
+      Dir.entries(@assets).each do |a|
+        asset_names.push(a) if a == @db_record
+      end
+
+      !asset_names.empty?
+    end
+  end
+end
+
+# This class is kept here for backwards compadibity with older versions.
 class ComicsDB
   def self.exists?(db_table, assets)
+    warn "[DEPRECATION] `ComicsDB.exists?(db_table, assets) is deprecated. Please use `WebComics::ComicsDB.exists?` instead."
     asset_names = []
 
     Dir.entries(assets).each do |a|

data/lib/comics_dir.rb

@@ -1,10 +1,90 @@
+module WebComics
+  class ComicsDir
+    attr_accessor :series
 
+    def self.comics_entries(dir)
+      entries = Dir.entries(dir)
+      entries.delete(".")
+      entries.delete("..")
+
+      entries
+    end
+
+    def self.trim(entries)
+      trimed_entries = []
+      entries.each do |e|
+        trimed_entries.push(File.basename(e, ".*"))
+      end
+
+      trimed_entries
+    end
+
+    def directory?
+      File.directory?(@series)
+    end
+
+    def list_directories
+      dirs_list = []
+      ComicsDir.comics_entries(@series).each do |d|
+        dirs_list.push(d) if File.directory?("#{@series}/#{d}")
+      end
+
+      dirs_list
+    end
+
+    def file?
+      File.file?(@series)
+    end
+
+    def list_files
+      files_list = []
+      ComicsDir.comics_entries(@series).each do |d|
+        files_list.push(d) if File.file?("#{@series}/#{d}")
+      end
+
+      files_list
+    end
+
+    def filter_alphanum_dirs
+      alphanum_dirs = []
+      list_directories.each do |d|
+        alphanum_dirs.push(d) if d =~ /[0-9]/ && d =~ /[a-z]/ || d =~ /[A-Z]/
+      end
+
+      alphanum_dirs
+    end
+
+    def filter_alpha_dirs
+      alpha_dirs = []
+      list_directories.each do |d|
+        alpha_dirs.push(d) if d =~ /[a-z]/ || d =~ /[A-Z]/
+        alpha_dirs.delete_if { |d| d =~ /[0-9]/ }
+      end
+
+      alpha_dirs
+    end
+
+    def filter_num_dirs
+      num_dirs = []
+      list_directories.each do |d|
+        num_dirs.push(d) if d =~ /[0-9]/
+        num_dirs.delete_if { |d| d =~ /[a-z]/ || d =~ /[A-Z]/ }
+      end
+
+      num_dirs
+    end
+  end
+end
+
+# This class is kept here for backwards compadibity with older versions.
 class ComicsDir
   def initialize(series)
+    warn "[DEPRECATION] `ComicsDir.new(series)` is deprecated. Please use `WebComics::ComicsDir.new` instead."
     @series = series
   end
 
   def comics_entries(dir)
+    warn "[DEPRECATION] `ComicsDir#comics_entries(dir)` is deprecated. Please use `WebComics::ComicsDir.comics_entries(dir)` instead."
     entries = Dir.entries(dir)
     entries.delete(".")
     entries.delete("..")
@@ -13,6 +93,7 @@ class ComicsDir
   end
 
   def trim(entries)
+    warn "[DEPRECATION] `ComicsDir#trim(entries)` is deprecated. Please use `WebComics::ComicsDir.trim(entries)` instead."
     trimed_entries = []
     entries.each do |e|
       trimed_entries.push(File.basename(e, ".*"))
@@ -22,10 +103,12 @@ class ComicsDir
   end
 
   def directory?(dir)
+    warn "[DEPRECATION] `ComicsDir#directory?(dir)` is deprecated. Please use `WebComics::ComicsDir#directory?` instead."
     File.directory?(dir)
   end
 
   def list_directories(dir)
+    warn "[DEPRECATION] `ComicsDir#list_directories(dir)` is deprecated. Please use `WebComics::ComicsDir#list_directories` instead."
     dirs_list = []
     comics_entries("#{dir}/#{@series}").each do |d|
       dirs_list.push(d) if directory?("#{dir}/#{@series}/#{d}")
@@ -35,10 +118,12 @@ class ComicsDir
   end
 
   def file?(f)
+    warn "[DEPRECATION] `ComicsDir#file?(f)` is deprecated. Please use `WebComics::ComicsDir#file?` instead."
     File.file?(f)
   end
 
   def list_files(dir)
+    warn "[DEPRECATION] `ComicsDir#list_files(dir)` is deprecated. Please use `WebComics::ComicsDir#list_files` instead."
     files_list = []
     comics_entries(dir).each do |d|
       files_list.push(d) if file?("#{dir}/#{d}")
@@ -48,6 +133,7 @@ class ComicsDir
   end
 
   def filter_alphanum_dirs(dir)
+    warn "[DEPRECATION] `ComicsDir#filter_alphanum_dirs(dir)` is deprecated. Please use `WebComics::ComicsDir#filter_alphanum_dirs` instead."
     alphanum_dirs = []
     list_directories(dir).each do |d|
       alphanum_dirs.push(d) if d =~ /[0-9]/ && d =~ /[a-z]/ || d =~ /[A-Z]/
@@ -57,6 +143,7 @@ class ComicsDir
   end
 
   def filter_alpha_dirs(dir)
+    warn "[DEPRECATION] `ComicsDir#filter_alpha_dirs(dir)` is deprecated. Please use `WebComics::ComicsDir#filter_alpha_dirs` instead."
     alpha_dirs = []
     list_directories(dir).each do |d|
       alpha_dirs.push(d) if d =~ /[a-z]/ || d =~ /[A-Z]/
@@ -67,6 +154,7 @@ class ComicsDir
   end
 
   def filter_num_dirs(dir)
+    warn "[DEPRECATION] `ComicsDir#filter_num_dirs(dir)` is deprecated. Please use `WebComics::ComicsDir#filter_num_dirs` instead."
     num_dirs = []
     list_directories(dir).each do |d|
       num_dirs.push(d) if d =~ /[0-9]/

data/lib/comics_engine.rb

@@ -1,42 +1,83 @@
-require_relative "comics_dir"
-require_relative "comics_db"
 require "fileutils"
 
+module WebComics
+  class ComicsEngine < CBZ
+    FILE_EXT_ARRY = [".jpg", ".png", ".tiff", ".bmp", ".gif"]
+
+    def filter(entries)
+      entries.each_index do |i|
+        entries.delete_if { |e| e.include?(FILE_EXT_ARRY[i]) || e.include?("#") }
+      end
+    end
+
+    def assets_dirs
+      filter(ComicsDir.comics_entries(@series))
+    end
+
+    def list_pages_cbz
+      list_pages_inside.sort
+    end
+
+    def list_pages
+      if CBZ.cbz_or_zip?("#{@series}/#{@cbz}")
+        list_pages_cbz
+      else
+        img_list = []
+        FileUtils.cd(@series) do
+          ComicsDir.comics_entries(".").each do |e|
+            img_list.push(e) if File.extname(e) == ".jpg" || File.extname(e) == ".png"
+          end
+        end
+
+        img_list.sort
+      end
+    end
+
+  end
+end
+
 class ComicsEngine
-  def initialize(table_name, assets)
+  def initialize(table_name = nil, assets)
+    warn "[DEPRECATION] `ComicsEngine.new(table_name = nil, assets)` is deprecated. Please use `WebComics::ComicsEngine.new` instead."
     @table_name = table_name
     @assets = assets
     @comics_dir = ComicsDir.new(@assets)
   end
 
   def dbtable_assets_match?
+    warn "[DEPRECATION] `ComicsEngine#dbtable_assets_match?` is deprecated."
     ComicsDB.exists?(@table_name, @assets)
   end
 
   def add_appendage
+    warn "[DEPRECATION] `ComicsEngine#add_appendage` is deprecated."
     @o_assets = @assets
-    @assets = "#{@assets}/#{@table_name}"
+    @assets = "#{@assets}/#{@table_name}"  
   end
 
   def remove_appendage
+    warn "[DEPRECATION] `ComicsEngine#remove_appendage` is deprecated."
     @assets.slice(@o_assets)
   end
 
   def filter(entries)
+    warn "[DEPRECATION] `ComicsEngine#filter(entries)` is deprecated."
     entries.delete_if do |e|
       e.include?(".") || e.include?("#")
     end
   end
 
   def assets_dirs
+    warn "[DEPRECATION] `ComicsEngine#assets_dirs` is deprecated. Please use `WebComics::ComicsEngine#assets_dirs` instead."
     filter(@comics_dir.comics_entries(@assets))
   end
 
   def list_pages
+    warn "[DEPRECATION] `ComicsEngine#list_pages` is deprecated. Please use `WebComics::ComicsEngine#list_pages(file = "")` instead."
     img_list = []
     FileUtils.cd(@assets) do
       @comics_dir.comics_entries(".").each do |e|
-      img_list.push(e) if File.extname(e) == ".jpg" || File.extname(e) == ".png"
+        img_list.push(e) if File.extname(e) == ".jpg" || File.extname(e) == ".png"
       end
     end
 

data/lib/version.rb

@@ -0,0 +1,3 @@
+module WebComics
+  VERSION = "1.1.0"
+end

data/lib/webcomics.rb

@@ -1,3 +1,5 @@
+require_relative "version"
 require_relative "comics_dir"
 require_relative "comics_db"
+require_relative "comics_cbz"
 require_relative "comics_engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webcomics
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Ralph Desir
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,19 +39,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
-description: A gem for creating framework agnostic web comics.
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A gem for creating comic book reader websites.
 email: battleroundscool@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/comics_cbz.rb
 - lib/comics_db.rb
 - lib/comics_dir.rb
 - lib/comics_engine.rb
+- lib/version.rb
 - lib/webcomics.rb
 homepage: https://github.com/Mav7/Ruby-WebComics
 licenses:
-- GPLv2
+- GPL-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -69,9 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Web comics library
 test_files: []
-has_rdoc: