tartlet 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce665847ebe3cd35e93082033fb1367e0a44d5b5
+  data.tar.gz: 562bbab7333270c377d5a89f1ddab78681544b7d
+SHA512:
+  metadata.gz: 4cbda51b351f997b7dcbdaeb0016655e1876a80830106cea7f96cdd5ad0d6c27acc8ff24dfdb7dadd092206b2ef1f10a05492a40f84a3ac0d9ed822f4fc734eb
+  data.tar.gz: e9d9fd713f503b0f8fdeb9e8eec1d76b6d594325890177c44741296552ba9580848506d82eca5b415a4399fc703a9248d5cb425c76ea5ddf5a8e8b1f221c64b5

data/README.md

@@ -43,9 +43,6 @@ gzipped tarball `archive.tar.gz`
 
         $ tartlet compress foo bar baz
 
-    ***TODO***: do a clobbering check before making the tarball to ensure file
-	            safety
-
 * `extract` - takes a single zipped tarball and extracts it into the current
 directory
 
@@ -53,12 +50,6 @@ directory
 
         $ tartlet extract archive.tar.gz
 
-    ***TODO***: take a list of tarballs and extract them each into their own
-	            folder
-
-    ***TODO***: do a clobbering check before extracting the tarball to ensure
-	            file safety
-
 ### Options
 
 Options can be placed anywhere in the command, eg. `tartlet -d compress -o
@@ -112,3 +103,22 @@ stdout the tar command that would be produced by tartlet
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## TODO Features:
+
+* Clobber Checks:
+
+	* **compress** - Make sure that the target archive doesn't already exist
+	  before creating the file.
+	
+	* **extract** - Make sure that the files in the tarball don't already exist
+	  in the output directory.
+
+* Multiple Extract:
+
+	Allow a list of files to extract, and extract all of them into separate
+	directories
+
+* RDoc Comments:
+
+	Comments. Comments everywhere.

data/bin/tartlet

@@ -9,7 +9,7 @@ class App
   include Methadone::CLILogging
   include Methadone::SH
 
-  COMMANDS = %w(compress extract)
+  COMMANDS = %w(compress extract list)
 
   main do |command, *files| # Add args you want: |like,so|
 
@@ -24,10 +24,10 @@ class App
       outfile = options['output'].nil? ? Tartlet::OUTFILE : options['output']
       
       # Get the tar command
-      cmd = Tartlet::compressSingle(files,!options['tarball'],outfile)
+      cmd = Tartlet::compressSingle(files, !options['tarball'], outfile)
 
       # Either output or run the command
-      if options['dry'] then puts cmd else sh cmd end
+        if options['dry'] then puts cmd else sh(cmd) {|o,e| puts o; puts e} end
 
     ## Extract the tarballs into their respective folders
     when "extract"
@@ -44,12 +44,25 @@ class App
         target = options['output'].nil? ? Tartlet::TARGET : options['output']
 
         # Get the tar command
-        cmd = Tartlet::extractSingle(files[0],!options['tarball'],target)
+        cmd = Tartlet::extractSingle(files[0], !options['tarball'], target)
 
         # Either output or run the command
-        if options['dry'] then puts cmd else sh cmd end
+        if options['dry'] then puts cmd else sh(cmd) {|o,e| puts o; puts e} end
 
       end
+
+    ## List files in tarball
+    when "list"
+
+      if files.length > 1
+        help_now!("One file at a time, bub!")
+      else
+        # Get the tar command
+        cmd = Tartlet::listSingle(files[0], !options['tarball'])
+
+        # Either output or run the command
+        if options['dry'] then puts cmd else sh(cmd) {|o,e| puts o; puts e} end
+      end
     else
       help_now!("#{command} is not a valid command. Must be one of {#{COMMANDS.join(",")}}")
     end

data/lib/tartlet.rb

@@ -34,4 +34,8 @@ module Tartlet
     return command
   end
 
+  def Tartlet.listSingle(file, zip = true)
+    return "tar -#{zip ? 'z' : ''}tvf #{file}"
+  end
+
 end

data/lib/tartlet/version.rb

@@ -1,3 +1,3 @@
 module Tartlet
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/tartlet.gemspec

@@ -4,101 +4,7 @@ require File.expand_path('../lib/tartlet/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Jake M"]
   gem.email         = ["jakemaskiewicz@gmail.com"]
-  gem.description   = %q{
-## Description
-
-Tar horror stories. Everyone has one. You used the wrong flags and accidentally
-overwrote one of your source files without a backup. Or you extracted a tarball
-over your current directory and deleted half the updates to your project. You
-spent 30 minutes scouring Google for the right set of flags to extract a zipped
-tarball instead of an unzipped one. Why are there so many flags!?!
-
-Enter Tartlet. Tartlet is a small commandline wrapper around tar that handles
-the obnoxious flags for you. Need to extract an archive?
-
-    tartlet extract thinmints.tar.gz
-
-Mmmmmmm. Delicious extracted cookies. Need to compress a set of files?
-
-    tartlet compress butter sugar flour --output cookie
-
-Mmmmmmmmm. Chocolaty compressed cookies. Tartlet makes it easy to make archives
-(and apparently I'm craving cookies- please hold).
-
-## Installation
-
-
-Install via gem as:
-
-    $ gem install tart
-
-## Usage
-
-Tartlet takes a command and then a list of files, with optional flags thrown
-anywhere.
-
-### Commands
-
-* `compress` - takes a list of files, and by default compresses them into
-gzipped tarball `archive.tar.gz`
-
-    ex:
-
-        $ tartlet compress foo bar baz
-
-* `extract` - takes a single zipped tarball and extracts it into the current
-directory
-
-    ex:
-
-        $ tartlet extract archive.tar.gz
-
-### Options
-
-Options can be placed anywhere in the command, eg. `tartlet -d compress -o
-target file1 file2` is the same as `tartlet compress file1 file2 -d -o target`
-which is the same as `tartlet compress -d file1 -o target file2`. I prefer to
-put -d before the command, -t after the command but before the files, and -o at
-the very end, but put them in whatever order makes sense to you.
-
-* `-o VALUE`, `--output VALUE` - instead of using the default output
-(archive.tar.gz or the current directory), direct output to **VALUE**. For
-compression archive name, tartlet will automatically append the proper file
-suffix (.tar or .tar.gz) if it is not already provided.
-
-    ex:
-
-        # extract contents of archive into folder 'dirname'
-        $ tartlet extract archive.tar.gz -o dirname
-
-        # compress list of files into tarball 'files.tar.gz'
-        $ tartlet compress foo bar baz -o files.tar.gz
-        -- or --
-        $ tartlet compress foo bar baz -o files
-
-* `--tarball`, `-tar`, or `-t` - treat tarball as not-gzipped, e.g.
-`archive.tar` (vs the default assumption of a gzipped tarball, eg
-`archive.tar.gz`)
-
-    ex:
-
-        # extract contents of archive into current directory
-        $ tartlet extract --tarball archive.tar
-
-        # compress files into non-zipped tarball
-        $ tartlet compress --tarball foo bar baz
-
-* `--dry-run`, `--dry`, `-d` - don't execute any commands, simply print to
-stdout the tar command that would be produced by tartlet
-
-    ex:
-
-        $ tartlet --dry compress foo bar baz --tarball -o files
-        tar -cf files.tar foo bar baz
-
-        $ tartlet extract --dry-run lotsoffiles.tar.gz -o safefolder
-        tar -xzf lotsoffiles.tar.gz -C safefolder
-  }
+  gem.description   = %q{Tartlet is a command line utility that can be called with a single command (compress or extract) and a list of files to run tar without the headache.}
   gem.summary       = %q{A wrapper for tar that provides sensible defaults}
   gem.homepage      = "https://github.com/jakemask/tartlet"
 

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: tartlet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Jake M
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: methadone
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,48 +62,12 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.6
-description: ! "\n## Description\n\nTar horror stories. Everyone has one. You used
-  the wrong flags and accidentally\noverwrote one of your source files without a backup.
-  Or you extracted a tarball\nover your current directory and deleted half the updates
-  to your project. You\nspent 30 minutes scouring Google for the right set of flags
-  to extract a zipped\ntarball instead of an unzipped one. Why are there so many flags!?!\n\nEnter
-  Tartlet. Tartlet is a small commandline wrapper around tar that handles\nthe obnoxious
-  flags for you. Need to extract an archive?\n\n    tartlet extract thinmints.tar.gz\n\nMmmmmmm.
-  Delicious extracted cookies. Need to compress a set of files?\n\n    tartlet compress
-  butter sugar flour --output cookie\n\nMmmmmmmmm. Chocolaty compressed cookies. Tartlet
-  makes it easy to make archives\n(and apparently I'm craving cookies- please hold).\n\n##
-  Installation\n\n\nInstall via gem as:\n\n    $ gem install tart\n\n## Usage\n\nTartlet
-  takes a command and then a list of files, with optional flags thrown\nanywhere.\n\n###
-  Commands\n\n* `compress` - takes a list of files, and by default compresses them
-  into\ngzipped tarball `archive.tar.gz`\n\n    ex:\n\n        $ tartlet compress
-  foo bar baz\n\n* `extract` - takes a single zipped tarball and extracts it into
-  the current\ndirectory\n\n    ex:\n\n        $ tartlet extract archive.tar.gz\n\n###
-  Options\n\nOptions can be placed anywhere in the command, eg. `tartlet -d compress
-  -o\ntarget file1 file2` is the same as `tartlet compress file1 file2 -d -o target`\nwhich
-  is the same as `tartlet compress -d file1 -o target file2`. I prefer to\nput -d
-  before the command, -t after the command but before the files, and -o at\nthe very
-  end, but put them in whatever order makes sense to you.\n\n* `-o VALUE`, `--output
-  VALUE` - instead of using the default output\n(archive.tar.gz or the current directory),
-  direct output to **VALUE**. For\ncompression archive name, tartlet will automatically
-  append the proper file\nsuffix (.tar or .tar.gz) if it is not already provided.\n\n
-  \   ex:\n\n        # extract contents of archive into folder 'dirname'\n        $
-  tartlet extract archive.tar.gz -o dirname\n\n        # compress list of files into
-  tarball 'files.tar.gz'\n        $ tartlet compress foo bar baz -o files.tar.gz\n
-  \       -- or --\n        $ tartlet compress foo bar baz -o files\n\n* `--tarball`,
-  `-tar`, or `-t` - treat tarball as not-gzipped, e.g.\n`archive.tar` (vs the default
-  assumption of a gzipped tarball, eg\n`archive.tar.gz`)\n\n    ex:\n\n        # extract
-  contents of archive into current directory\n        $ tartlet extract --tarball
-  archive.tar\n\n        # compress files into non-zipped tarball\n        $ tartlet
-  compress --tarball foo bar baz\n\n* `--dry-run`, `--dry`, `-d` - don't execute any
-  commands, simply print to\nstdout the tar command that would be produced by tartlet\n\n
-  \   ex:\n\n        $ tartlet --dry compress foo bar baz --tarball -o files\n        tar
-  -cf files.tar foo bar baz\n\n        $ tartlet extract --dry-run lotsoffiles.tar.gz
-  -o safefolder\n        tar -xzf lotsoffiles.tar.gz -C safefolder\n  "
+description: Tartlet is a command line utility that can be called with a single command
+  (compress or extract) and a list of files to run tar without the headache.
 email:
 - jakemaskiewicz@gmail.com
 executables:
@@ -123,7 +79,6 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- README.rdoc
 - Rakefile
 - bin/tartlet
 - features/step_definitions/tartlet_steps.rb
@@ -135,27 +90,26 @@ files:
 - test/tc_something.rb
 homepage: https://github.com/jakemask/tartlet
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A wrapper for tar that provides sensible defaults
 test_files:
 - features/step_definitions/tartlet_steps.rb

data/README.rdoc

@@ -1,115 +0,0 @@
-= tartlet - a wrapper for tar that provides sensible defaults
-
-Author::  Jacob Maskiewicz (jakemaskiewicz@gmail.com)
-Copyright:: Copyright (c) 2013 Jacob Maskiewicz
-
-
-== Description
-
-Tar horror stories. Everyone has one. You used the wrong flags and accidentally
-overwrote one of your source files without a backup. Or you extracted a tarball
-over your current directory and deleted half the updates to your project. You
-spent 30 minutes scouring Google for the right set of flags to extract a zipped
-tarball instead of an unzipped one. Why are there so many flags!?!
-
-Enter Tartlet. Tartlet is a small commandline wrapper around tar that handles
-the obnoxious flags for you. Need to extract an archive?
-
-    tartlet extract thinmints.tar.gz
-
-Mmmmmmm. Delicious extracted cookies. Need to compress a set of files?
-
-    tartlet compress butter sugar flour --output cookie
-
-Mmmmmmmmm. Chocolaty compressed cookies. Tartlet makes it easy to make archives
-(and apparently I'm craving cookies- please hold).
-
-== Installation
-
-
-Install via gem as:
-
-    $ gem install tart
-
-== Usage
-
-Tartlet takes a command and then a list of files, with optional flags thrown
-anywhere.
-
-=== Commands
-
-* <tt>compress</tt> - takes a list of files, and by default compresses them into gzipped tarball <tt>archive.tar.gz</tt>
-
-ex:
-
-	$ tartlet compress foo bar baz
-
-***TODO***: do a clobbering check before making the tarball to ensure file
-			safety
-
-* <tt>extract</tt> - takes a single zipped tarball and extracts it into the current directory
-
-ex:
-
-	$ tartlet extract archive.tar.gz
-
-***TODO***: take a list of tarballs and extract them each into their own
-			folder
-
-***TODO***: do a clobbering check before extracting the tarball to ensure
-			file safety
-
-=== Options
-
-Options can be placed anywhere in the command, eg. <tt>tartlet -d compress -o
-target file1 file2</tt> is the same as <tt>tartlet compress file1 file2 -d -o target</tt>
-which is the same as <tt>tartlet compress -d file1 -o target file2</tt>. I prefer to
-put -d before the command, -t after the command but before the files, and -o at
-the very end, but put them in whatever order makes sense to you.
-
-* <tt>-o VALUE</tt>, <tt>--output VALUE</tt> - instead of using the default output (archive.tar.gz or the current directory), direct output to **VALUE**. For compression archive name, tartlet will automatically append the proper file suffix (.tar or .tar.gz) if it is not already provided.
-
-ex:
-
-	# extract contents of archive into folder 'dirname'
-	$ tartlet extract archive.tar.gz -o dirname
-
-	# compress list of files into tarball 'files.tar.gz'
-	$ tartlet compress foo bar baz -o files.tar.gz
-	-- or --
-	$ tartlet compress foo bar baz -o files
-
-* <tt>--tarball</tt>, <tt>-tar</tt>, or <tt>-t</tt> - treat tarball as not-gzipped, e.g. <tt>archive.tar</tt> (vs the default assumption of a gzipped tarball, eg <tt>archive.tar.gz</tt>)
-
-ex:
-
-	# extract contents of archive into current directory
-	$ tartlet extract --tarball archive.tar
-
-	# compress files into non-zipped tarball
-	$ tartlet compress --tarball foo bar baz
-
-* <tt>--dry-run</tt>, <tt>--dry</tt>, <tt>-d</tt> - don't execute any commands, simply print to stdout the tar command that would be produced by tartlet
-
-ex:
-
-	$ tartlet --dry compress foo bar baz --tarball -o files
-	tar -cf files.tar foo bar baz
-
-	$ tartlet extract --dry-run lotsoffiles.tar.gz -o safefolder
-	tar -xzf lotsoffiles.tar.gz -C safefolder
-
-
-
-== Links
-
-* {Source on Github}[https://github.com/jakemask/tartlet]
-* RDoc[LINK TO RDOC.INFO]
-
-== Contributing
-
-1. Fork the {Github Source}[https://github.com/jakemask/tartlet]
-2. Create your feature branch (<tt>git checkout -b my-new-feature</tt>)
-3. Commit your changes (<tt>git commit -am 'Added some feature'</tt>)
-4. Push to the branch (<tt>git push origin my-new-feature</tt>)
-5. Create new Pull Request