rar 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 142dbffb47cce75ea7de10b407a2a103486330eb
+  data.tar.gz: 5c66d66bcae8e0bb1a2a3bf6c0ee98953cf21899
+SHA512:
+  metadata.gz: a096bd80b400449335222afcd3b4624a26201512de8e0c100885358938100c3cf64f3135e30fbc34864c6b6c8b26c2e0563b4df8c7f18707b4d2b6a4be1587c1
+  data.tar.gz: 08dbe55dfc63e46c61d02953833e47b454ae74486fe5a742ab7b3d1b21d0944a3df299ccfa53fe636d5fd08770de411424d60c912bbfdc8e2eff75fb149817db

data/.yardopts

@@ -0,0 +1,5 @@
+--output-dir documentation/
+--readme README.md
+--title RAR
+--protected
+library/**/*.rb

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014, Mikkel Kroman <mk@uplink.io>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# RAR
+
+RAR is a Ruby wrapper for the command-line application `rar`, also known as
+WinRAR for Windows. A free evaluation copy can be obtained from [RarLab](http://rarlab.com).
+
+## Installation
+
+`gem install rar`
+
+And you're all set. Extra dependencies will automatically be installed.
+
+## Usage
+
+### Creating an archive
+
+Creating an archive and adding arbitrary files to it is simple!
+
+    require 'rar'
+
+    archive = RAR::Archive.new 'archive.rar'
+
+    archive.add_file 'some-file.txt'
+    archive.add_file 'some-other-file.jpg'
+
+    archive.create!
+
+### Adding command-line options
+
+RAR provides a mapping of verbosely named options for ease of use.
+
+    archive = RAR::Archive.new 'archive.rar', volume_size: 15_000_000
+
+    archive.add_file 'some-file.txt'
+    archive.add_file 'some-large-file.bin'
+
+    archive.create!
+
+This example splits the archive into multiple volumes with a size of 15MB.
+
+To see more options, take a look at the documentation.
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request
+
+## History
+
+__v0.1__
+
++ Initial release.

data/library/rar.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'open3'
+require 'shellwords'
+
+require 'rar/version'
+require 'rar/archive'
+require 'rar/command_line_options'
+
+# RAR is a Ruby wrapper for the command-line application rar, also known as
+# WinRAR for Windows. A free evaluation copy can be obtained from RarLab.
+#
+# 
+module RAR
+  # A list of messages of what the process exit code might indicate.
+  ExitCodeMessages = {
+    0 => 'Successful operation.',
+    1 => 'Non fatal error(s) occurred.',
+    2 => 'A fatal error occurred.',
+    3 => 'Invalid checksum. Data is damaged.',
+    4 => 'Attempt to modify an archive locked by \'k\' command.',
+    5 => 'Write error.',
+    6 => 'File open error.',
+    7 => 'Wrong command line option.',
+    8 => 'Not enough memory.',
+    9 => 'File creation error.',
+    10 => 'No files matching the specified mask and options were found.',
+    11 => 'Wrong password.',
+    255 => 'User stopped the process.'
+  }
+
+  # The standard error for unexpected exit codes.
+  CommandLineError = Class.new StandardError
+
+  # Set the path to the executable `rar` file.
+  #
+  # @return [String] the new path to the executable.
+  def self.executable= executable
+    @executable = executable
+  end
+
+  # @return [String] the path to the executable `rar` file.
+  def self.executable
+    @executable || 'rar'
+  end
+end

data/library/rar/archive.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module RAR
+  # The Archive class.
+  #
+  # It is the main entry-point to creating a new archive.
+  class Archive
+    # @return [Array] the list of files.
+    attr_accessor :files
+
+    # @return [Hash] the list of options.
+    attr_accessor :options
+
+    # Create a new archive.
+    #
+    # @param [String] filename The archive's file name.
+    # @param [CommandLineOptions, optional] options The options to pass to the
+    #   command line.
+    #
+    # @option options [String] :extra A string of command line options that will
+    #   be passed directly to the command line.
+    # @option options [Boolean] :force Assume Yes on all queries.
+    # @option options [Boolean] :old_format Use the old style volume naming
+    #   scheme.
+    # @option options [Fixnum, String] :volume_size The volume size in case of
+    #   multiple volumes.
+    # @option options [Fixnum] :compression Set compression level.
+    #   (0-store...3-default...5-maximal)
+    # @option options [Boolean] :exclude_path Exclude paths from names.
+    def initialize filename, options = {}
+      @files = []
+      @options = CommandLineOptions.new.merge options
+      @filename = filename
+    end
+
+    # Add a file to the list of files.
+    #
+    # @return [Array] the list of files.
+    # @raise ERRNO::ENOENT if the file doesn't exist.
+    def add_file path
+      if File.exist? path
+        @files << path
+      else
+        raise Errno::ENOENT, "File '#{path}' doesn't exist"
+      end
+    end
+
+    # Create the final archive.
+    #
+    # @raise CommandLineError if the exit code indicates an error.
+    # @return true if the command executes without a hitch.
+    def create!
+      `#{command_line}`
+
+      if $? > 1
+        if message = ExitCodeMessage[$?]
+          raise CommandLineError, message
+        else
+          raise CommandLineError, "Unknown exit code: #{$?}"
+        end
+      else
+        true
+      end
+    end
+
+    private
+
+    # @return [String] the concatenated list of command-line switches.
+    def command_line_options
+      Shellwords.join @options.to_a
+    end
+
+    # @return [String] the concatenated command-line with all the switches.
+    def command_line
+      %{#{RAR.executable} a #{command_line_options} #{Shellwords.escape @filename} #{Shellwords.join @files}}
+    end
+  end
+end

data/library/rar/command_line_options.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module RAR
+  # CommandLineOptions is a convenience class to making adding new command-line
+  # switches trivial.
+  class CommandLineOptions < Hash
+    # The mappings that convert an option to an actual command line switch.
+    OptionsMap = {
+      extra:        ->(extra) { extra },
+      force:        ->(force) { '-y' if force },
+      old_format:   ->(old_format) { '-vn' if old_format },
+      volume_size:  ->(volume_size) { "-v#{volume_size}" },
+      compression:  ->(compression = 0) { "-m#{compression}" },
+      exclude_path: ->(exclude_path) { 'ep' },
+    }
+
+    # @return [Array] the list of command line options.
+    def to_a
+      map do |key, value|
+        if block = OptionsMap[key]
+          block.call value
+        end
+      end.compact
+    end
+  end
+end

data/library/rar/version.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module RAR
+  # The library version constant.
+  Version = "0.1"
+
+  # Returns the current library version number.
+  #
+  # @return [String] the current library version number.
+  def self.version
+    Version
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rar
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Mikkel Kroman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: |2
+      RAR is a Ruby wrapper for the command-line application rar, also known as WinRAR for Windows.
+email: mk@uplink.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- library/rar.rb
+- library/rar/archive.rb
+- library/rar/command_line_options.rb
+- library/rar/version.rb
+homepage: https://github.com/mkroman/rar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- library
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RAR is a Ruby wrapper for the command-line application rar, also known as
+  WinRAR for Windows.
+test_files: []
+has_rdoc: