bin/pastiepacker
@@ -25,8 +25,10 @@ setup.rb
tasks/deployment.rake
tasks/environment.rake
tasks/website.rake
-test/fixtures/README.txt
-test/fixtures/lib/myapp.rb
+test/fixtures/private_pastie.html
+test/fixtures/sample_app/History.txt
+test/fixtures/sample_app/README.txt
+test/fixtures/sample_app/lib/myapp.rb
test/test_app.rb
test/test_conversion.rb
test/test_helper.rb
Manifest.txt
@@ -1,36 +1,64 @@
= pastiepacker
-* FIX (url)
+* http://pastiepacker.rubyforge.org
== DESCRIPTION:
-FIX (describe your package)
+Prepare to pack or unpack piles of files with the pastiepacker.
== FEATURES/PROBLEMS:
-* FIX (list of features or problems)
-
== SYNOPSIS:
- FIX (code sample of usage)
+To pack a folder: pastiepacker
+ Packing options:
+ -p, --private Posted pasties are private
+ Ignored for unpacking
+ Default: false
+ -f, --format=FORMAT Possess pasties with a particular persona
+ Supported formats:
+ c++, css, diff, html_rails, html, javascript,
+ php, plain_text, python, ruby, ruby_on_rails,
+ sql, shell-unix-generic
+ Ignored for unpacking
+ Default: ruby
+
+To only pack a selection of files ending with *txt* you can pass a list of file names via STDIN:
+
+ find * | grep "txt$" | pastiepacker
+
+It outputs the url of the prepared pastie, so you can pipe it to xargs:
+
+ pastiepacker | xargs open
+
+To unpack a packed pastie: pastiepacker http://pastie.caboo.se/175183
+- This unpacks the files into a subfolder 175138/
+To unpack a private pastie: pastiepacker http://pastie.caboo.se/private/5hwfheniddqmyasmfcxaw
+- This unpacks the files into a subfolder 5hwfheniddqmyasmfcxaw/
+
== REQUIREMENTS:
-* FIX (list of requirements)
+* ruby
+* rubygems
+
+To test if you have these, the following should work:
+
+ gem env
== INSTALL:
-* FIX (sudo gem install, anything else)
+* sudo gem install pastiepacker
== LICENSE:
(The MIT License)
-Copyright (c) 2008 FIX
+Copyright (c) 2008 Dr Nic Williams
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
+"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
@@ -39,10 +67,10 @@ the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
README.txt
@@ -1,11 +1,166 @@
-<html>
- <head>
- <meta http-equiv="Content-type" content="text/html; charset=utf-8">
- <title>pastiepacker</title>
-
- </head>
- <body id="body">
- <p>This page has not yet been created for RubyGem <code>pastiepacker</code></p>
- <p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
- </body>
-</html>
\ No newline at end of file
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>
+ Pastie Packer
+ </title>
+ <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+ <script type="text/javascript">
+ window.onload = function() {
+ settings = {
+ tl: { radius: 10 },
+ tr: { radius: 10 },
+ bl: { radius: 10 },
+ br: { radius: 10 },
+ antiAlias: true,
+ autoPad: true,
+ validTags: ["div"]
+ }
+ var versionBox = new curvyCorners(settings, document.getElementById("version"));
+ versionBox.applyCornersToAll();
+ }
+ </script>
+</head>
+<body>
+<div id="main">
+
+ <h1>Pastie Packer</h1>
+ <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/pastiepacker"; return false'>
+ <p>Get Version</p>
+ <a href="http://rubyforge.org/projects/pastiepacker" class="numbers">1.0.0</a>
+ </div>
+ <h1>→ ‘pastiepacker’</h1>
+
+
+ <p><span class="caps">TODO</span>: put this into pastie + use screenshot instead (raw text as alt=”...”)</p>
+
+
+ <p>Prepare to <em>pack</em> or <em>unpack</em> piles of files with <strong>pastiepacker</strong>. The easiest, best distributing, viewable archiving tool since pencil and paper.</p>
+
+
+ <h2>What</h2>
+
+
+ <p>A <a href="http://pastie.caboo.se">pastie</a> is a snippet of text/code stored on a single webpage. This makes it very easy to share the text over IM or <span class="caps">IRC</span> – you just copy+paste the url. As a bonus, pasties are syntax highlighted making them easier to read than if shared as plain text.</p>
+
+
+ <p>The <strong>pastiepacker</strong> is a command-line tool to “pack” a selection of files (or by default, a whole recursive folder of files) into a single pastie. So a whole/part of a project can be quickly shared.</p>
+
+
+ <p>It can also “unpack” a packed pastie back into files. The pastiepacker is therefore a simple, useful distributed archiving tool, using pasties for storage.</p>
+
+
+ <p>For example, this pastie <a href="http://xxx"><span class="caps">XXX</span></a> shows a selection of files packed into a pastie. It just happens to be the source for pastiepacker itself!</p>
+
+
+ <p>You can pack a whole folder or a selection of files. Any <span class="caps">README</span>/readme.* files are placed at the front of the pastie, because that seems helpful. The packed pasties include information on how to unpack the pastie back into raw files.</p>
+
+
+ <p>Only ascii files are packed.</p>
+
+
+ <h2>Installing</h2>
+
+
+ <p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">pastiepacker</span></pre></p>
+
+
+ <h2>The basics: packing files into a pastie</h2>
+
+
+ <p>To pack a folder: <code>pastiepacker</code></p>
+
+
+ <p>Packing options:</p>
+
+
+<pre>
+-p, --private Posted pasties are private
+ Ignored for unpacking
+ Default: false
+-f, --format=FORMAT Possess pasties with a particular persona
+ Supported formats:
+ c++, css, diff, html_rails, html, javascript,
+ php, plain_text, python, ruby, ruby_on_rails,
+ sql, shell-unix-generic
+ Ignored for unpacking
+ Default: ruby
+</pre>
+
+ <p>To only pack a selection of files ending with <strong>txt</strong> you can pass a list of file names via <span class="caps">STDIN</span>:</p>
+
+
+<pre> find * | grep "txt$" | pastiepacker</pre>
+
+ <p><strong>pastiepacker</strong> outputs the url of the prepared pastie, so you can pipe it to xargs:</p>
+
+
+<pre> pastiepacker | xargs open</pre>
+
+ <p>If the selection of files (within the current folder or the selection of files via <span class="caps">STDIN</span>) contains a readme file (readme.txt, <span class="caps">README</span>.txt, <span class="caps">README</span>.markdown, etc), that file will be packed at the top of the pastie, for the convenience of readers.</p>
+
+
+ <h2>The basics: unpacking pasties into files</h2>
+
+
+ <p>To unpack a packed pastie:</p>
+
+
+<pre> pastiepacker http://pastie.caboo.se/175183</pre>
+
+ <p>This unpacks the files into a subfolder 175138/</p>
+
+
+ <p>To unpack a private pastie:</p>
+
+
+<pre> pastiepacker http://pastie.caboo.se/private/5hwfheniddqmyasmfcxaw</pre>
+
+ <p>This unpacks the files into a subfolder 5hwfheniddqmyasmfcxaw/</p>
+
+
+ <h2>Forum</h2>
+
+
+ <p><a href="http://groups.google.com/group/pastiepacker">http://groups.google.com/group/pastiepacker</a></p>
+
+
+ <p><span class="caps">TODO</span> – create Google Group – pastiepacker</p>
+
+
+ <h2>How to submit patches</h2>
+
+
+ <p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+ <p>The trunk repository is <code>svn://rubyforge.org/var/svn/pastiepacker/trunk</code> for anonymous access.</p>
+
+
+ <h2>License</h2>
+
+
+ <p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+ <h2>Contact</h2>
+
+
+ <p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a> via the <a href="http://groups.google.com/group/pastiepacker">forum</a></p>
+ <p class="coda">
+ <a href="drnicwilliams@gmail.com">Dr Nic Williams</a>, 5th April 2008<br>
+ Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>,
+ by Daniel Cadenas via <a href="http://depgraph.rubyforge.org/">DepGraph</a>
+ </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>
website/index.html
@@ -1,20 +1,71 @@
-h1. pastiepacker
+h1. Pastie Packer
h1. → 'pastiepacker'
+TODO: put this into pastie + use screenshot instead (raw text as alt="...")
+
+Prepare to _pack_ or _unpack_ piles of files with *pastiepacker*. The easiest, best distributing, viewable archiving tool since pencil and paper.
h2. What
+A "pastie":http://pastie.caboo.se is a snippet of text/code stored on a single webpage. This makes it very easy to share the text over IM or IRC - you just copy+paste the url. As a bonus, pasties are syntax highlighted making them easier to read than if shared as plain text.
+
+The *pastiepacker* is a command-line tool to "pack" a selection of files (or by default, a whole recursive folder of files) into a single pastie. So a whole/part of a project can be quickly shared.
+
+It can also "unpack" a packed pastie back into files. The pastiepacker is therefore a simple, useful distributed archiving tool, using pasties for storage.
+
+For example, this pastie "XXX":http://xxx shows a selection of files packed into a pastie. It just happens to be the source for pastiepacker itself!
+
+You can pack a whole folder or a selection of files. Any README/readme.* files are placed at the front of the pastie, because that seems helpful. The packed pasties include information on how to unpack the pastie back into raw files.
+
+Only ascii files are packed.
h2. Installing
<pre syntax="ruby">sudo gem install pastiepacker</pre>
-h2. The basics
+h2. The basics: packing files into a pastie
+
+To pack a folder: <code>pastiepacker</code>
+
+Packing options:
+
+<pre>
+-p, --private Posted pasties are private
+ Ignored for unpacking
+ Default: false
+-f, --format=FORMAT Possess pasties with a particular persona
+ Supported formats:
+ c++, css, diff, html_rails, html, javascript,
+ php, plain_text, python, ruby, ruby_on_rails,
+ sql, shell-unix-generic
+ Ignored for unpacking
+ Default: ruby
+</pre>
+
+To only pack a selection of files ending with *txt* you can pass a list of file names via STDIN:
+
+<pre> find * | grep "txt$" | pastiepacker</pre>
+
+*pastiepacker* outputs the url of the prepared pastie, so you can pipe it to xargs:
+
+<pre> pastiepacker | xargs open</pre>
+
+If the selection of files (within the current folder or the selection of files via STDIN) contains a readme file (readme.txt, README.txt, README.markdown, etc), that file will be packed at the top of the pastie, for the convenience of readers.
+
+h2. The basics: unpacking pasties into files
+
+To unpack a packed pastie:
+
+<pre> pastiepacker http://pastie.caboo.se/175183</pre>
+
+This unpacks the files into a subfolder 175138/
+To unpack a private pastie:
-h2. Demonstration of usage
+<pre> pastiepacker http://pastie.caboo.se/private/5hwfheniddqmyasmfcxaw</pre>
+This unpacks the files into a subfolder 5hwfheniddqmyasmfcxaw/
h2. Forum
website/index.txt
bin/pastie_packer
4b6be67c62215edff9d6f12eba16dc1ad19da656
Dr Nic Williams
drnicwilliams@gmail.com
http://github.com/drnic/pastie-packer/commit/2f5a1bba1f6a39a80512dfb64db2915e9eab7147
2f5a1bba1f6a39a80512dfb64db2915e9eab7147
2008-04-04T22:50:29-07:00
2008-04-04T22:50:29-07:00
add help to readme/website; renamed bin/pastiepacker
7e382fa613c8335b7d3be09a3d30454f228d617e
Dr Nic Williams
drnicwilliams@gmail.com