excavate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ac901b1d15ed4e916d2e76c0b902070918d518169f177fdf338df564a002e4
-  data.tar.gz: f3d5f8d33256c59bd63d3d517e66ab46eda8cf1e02f3d26a732add451e8d92a7
+  metadata.gz: '05638165852fcf0b41aa72e491d285182a11d2b5989cdee78393ff3f8719a017'
+  data.tar.gz: b3a9e906c6dd35274e0e2b7a7e90f5c10ea8447b0f77c0b0cd59b277d224c06d
 SHA512:
-  metadata.gz: 2e9dcda07eec36ef7c4dbcced2927e26ad2b4daff57f3544a79aeac7c5a4da4fb44fd3d16e5868ae17387614ea549838aa61565fd283d19036e6aa0e02f8e54a
-  data.tar.gz: 9fd35d2d181083bf78a5c4250fb9ee22ff925f8b9d5964243f2d1f810f90dc04183973c9ff0d1c7c778879512e70749a5757ac4b9d81029e2b5a56331ba35c12
+  metadata.gz: 3eea36c08d18780f9131875d3ca78c33bdf558c957425d9b936f08eb1512bb298724f68f418edb3b3db0c941e228e11473826ad6a16b6fcf399935f73be03514
+  data.tar.gz: 371061bead10a3716b931a9877153c3ea47e8666030fbb0dc7885217da32428f7f43298ec0a98a7fc0f2ef2ffd7a51af5e7371eedbee06f19d34b7a5995b8e3d

data/README.adoc

@@ -33,21 +33,38 @@ To extract an archive containing other archives inside:
 
 [source,ruby]
 ----
-archive = "path/to/archive.cab"
 target = Dir.mktmpdir
-Excavate::Archive.new(archive).extract(target, recursive_packages: true)
+Excavate::Archive.new("path/to/archive.cab").extract(target, recursive_packages: true)
 ----
 
 The same but allowing to choose only necessary files inside:
 
 [source,ruby]
 ----
+target = Dir.mktmpdir
 Excavate::Archive.new("path/to/archive.cab").files(recursive_packages: true) do |path|
-  FileUtils.mv(path, Dir.mktmpdir) if path.end_with?(".txt")
+  FileUtils.mv(path, target) if path.end_with?(".txt")
 end
 ----
 
 
+== CLI
+
+`excavate` can be used via command line. To extract an archive including the nested ones:
+
+[source,sh]
+----
+$ excavate --recursive path/to/archive.cab
+----
+
+If you'd like to skip extraction of nested archives, just use:
+
+[source,sh]
+----
+$ excavate path/to/archive.cab
+----
+
+
 == Development
 
 We are following Sandi Metz's Rules for this gem, you can read the

data/excavate.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "ruby-ole", "~> 1.0"
   spec.add_runtime_dependency "rubyzip", "~> 2.3"
   spec.add_runtime_dependency "seven_zip_ruby", "~> 1.0"
+  spec.add_runtime_dependency "thor", "~> 1.0"
 end

data/exe/excavate

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "excavate/cli"
+
+status_code = Excavate::CLI.start
+exit status_code.is_a?(Integer) ? status_code : 1

data/lib/excavate.rb

@@ -9,4 +9,6 @@ require_relative "excavate/utils"
 module Excavate
   class Error < StandardError; end
   class UnknownArchiveError < Error; end
+  class TargetExistsError < Error; end
+  class TargetNotEmptyError < Error; end
 end

data/lib/excavate/archive.rb

@@ -24,16 +24,31 @@ module Excavate
       FileUtils.rm_rf(target)
     end
 
-    def extract(target, recursive_packages: false)
+    def extract(target = nil, recursive_packages: false)
+      source = File.expand_path(@archive)
+      target ||= default_target(source)
+      raise(TargetNotEmptyError, "Target directory `#{File.basename(target)}` is not empty.") unless Dir.empty?(target)
+
       if recursive_packages
-        extract_recursively(@archive, target)
+        extract_recursively(source, target)
       else
-        extract_once(@archive, target)
+        extract_once(source, target)
       end
+
+      target
     end
 
     private
 
+    def default_target(source)
+      target = File.expand_path(File.basename(source, ".*"))
+      raise(TargetExistsError, "Target directory `#{File.basename(target)}` already exists.") if File.exist?(target)
+
+      FileUtils.mkdir(target)
+
+      target
+    end
+
     def extract_recursively(archive, target)
       extract_once(archive, target)
 

data/lib/excavate/cli.rb

@@ -0,0 +1,50 @@
+require "thor"
+
+require_relative "../excavate"
+
+module Excavate
+  class CLI < Thor
+    STATUS_SUCCESS = 0
+    STATUS_UNKNOWN_ERROR = 1
+    STATUS_TARGET_EXISTS = 2
+    STATUS_TARGET_NOT_EMPTY = 3
+
+    def self.exit_on_failure?
+      false
+    end
+
+    def self.start(given_args = ARGV, config = {})
+      args = if all_commands.key?(given_args[0])
+               given_args
+             else
+               given_args.dup.unshift("extract")
+             end
+
+      super(args, config)
+    end
+
+    desc "extract ARCHIVE", "Extract ARCHIVE to a new directory"
+    option :recursive, aliases: :r, type: :boolean, default: false, desc: "Also extract all nested archives."
+    def extract(archive)
+      target = Excavate::Archive.new(archive).extract(recursive_packages: options[:recursive])
+      success("Successfully extracted to #{File.basename(target)}/")
+    rescue TargetExistsError => e
+      error(e.message, STATUS_TARGET_EXISTS)
+    rescue TargetNotEmptyError => e
+      error(e.message, STATUS_TARGET_NOT_EMPTY)
+    end
+    default_task :extract
+
+    private
+
+    def success(message)
+      say(message)
+      STATUS_SUCCESS
+    end
+
+    def error(message, status)
+      say(message, :red)
+      status
+    end
+  end
+end

data/lib/excavate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Excavate
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excavate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arr-pm
@@ -80,10 +80,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Extract nested archives with a single command.
 email:
 - open.source@ribose.com
-executables: []
+executables:
+- excavate
 extensions: []
 extra_rdoc_files: []
 files:
@@ -97,8 +112,10 @@ files:
 - README.adoc
 - Rakefile
 - excavate.gemspec
+- exe/excavate
 - lib/excavate.rb
 - lib/excavate/archive.rb
+- lib/excavate/cli.rb
 - lib/excavate/extractors.rb
 - lib/excavate/extractors/cab_extractor.rb
 - lib/excavate/extractors/cpio/cpio.rb
@@ -121,7 +138,7 @@ metadata:
   homepage_uri: https://github.com/fontist/excavate
   source_code_uri: https://github.com/fontist/excavate
   changelog_uri: https://github.com/fontist/excavate
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -137,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Extract nested archives with a single command.
 test_files: []