gistribute 0.0.1 → 0.1

data/README.md

@@ -15,42 +15,30 @@ a tweak to one of the files that you're sharing.
 
 ## How It Works
 
-Gistribute looks at the files in each Gist and checks for one or two lines of
-metadata at the top of the file. The metadata must begin with ```%%```, but
-you may put anything before that and it won't be parsed.
-
-The first line of metadata contains the location on the client's computer that
-you wish to install the file to. The second contains the name of the file as it
-will be printed on the user's screen as it is installed. If the second line is
-excluded, Gistribute will use the name of the file in the Gist.
+Gistribute looks at the filename that you enter on Gist to find all of the
+data that it needs to download the file to the other user's computer. It
+allows you to choose what Gistribute will call the file when it is installing
+it, and where it will install the file.
 
 ## Usage
 
-An example follows:
-
-```VimL
-"%% ~/.vimrc
-"%% Vim configuration
-" This is an example .vimrc file being shared via Gistribute.
-" Notice the two comments at the top containing the metadata.
+If, for example, you were sharing a .vimrc file, and you wanted Gistribute to
+call it "Vim configuration" when it was installing it, you would name the file
+`Vim configuration||~|.vimrc`. If the filename contains the sequence `||`,
+anything before that will be considered the description of that file, and
+anything after it the installation path. If there is no `||`, Gistribute will
+use the name of the file (without the path to it) as the default description.
 
-set nocompatible
-filetype indent plugin on
-syntax on
-```
+The file path separator is the pipe character because GitHub Gist doesn't
+allow slashes in filenames- this quirk is the result of Gist actually saving
+those files to a Git repository on their servers, and handling slashes in
+file names can't possibly be very nice.
 
-If, for example, the resulting Gist link was https://gist.github.com/123456,
+If the resulting Gist link was, for example, https://gist.github.com/123456,
 the user would be able to run either of these commands to download the file
-to ```~/.vimrc```:
+to `~/.vimrc`:
 
-    $ gistribute 123456
-    $ gistribute https://gist.github.com/123456
-
-**Gistribute will strip the metadata from the files.** Don't worry about having
-messy files on the user's computer because of the metadata sitting at the top,
-as this is taken care of. Be aware, however, that if you leave a blank line
-between the metadata and the first line of the file, the resulting downloaded
-file **will** have a blank line at the top.
-
-If there are files in the Gist without metadata, they will be ignored by
-Gistribute.
+```Shell
+$ gistribute 123456
+$ gistribute https://gist.github.com/123456
+```

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1

data/bin/gistribute

@@ -6,13 +6,13 @@ if %w[-v --version].include? ARGV.first
 end
 
 require "json"
+require "fileutils"
 require "open-uri"
-require "colorize"
 require "nutella"
 
 print "Downloading data..."
 
-# The user can paste in either just the ID or the entire URL to the Gist.
+# The user can pass in either just the ID or the entire URL to the Gist.
 id = ARGV.first[/(^|\/)([[:xdigit:]]+)/, 2]
 
 begin
@@ -52,38 +52,35 @@ end
 #   }
 # }
 
-puts <<-EOS.heredoc
-
-
-  Finished downloading Gist from: #{gist["html_url"]}
-  Gist uploaded by #{
-    gist["user"] ? "user #{gist["user"]["login"]}" : "an anonymous user"
-  }.
-
-  Beginning install...
+# Regular expression word wrap to keep lines less than 80 characters. Then
+# check to see if it's empty- if not, put newlines on each side so that it
+# will be padded when displayed in the output.
+desc = gist["description"].gsub(/(.{1,79})(\s+|\Z)/, "\\1\n").strip
+desc = "\n#{desc}\n" unless desc.empty?
+
+puts <<EOS
+\n
+Finished downloading Gist from: #{gist["html_url"]}
+Gist uploaded by #{
+  gist["user"] ? "user #{gist["user"]["login"]}" : "an anonymous user"
+}.
+#{desc}
+Beginning install...
 EOS
 
 gist["files"].each do |filename, data|
-  lines = data["content"].lines.to_a
-
-  # Parse out all metadata after %% on the first two lines, strip out
-  # (lead|trail)ing whitespace while we're at it.
-  metadata = lines[0..1].map { |line| line[/%%\s*(.*\S)\s*/, 1] }
-
-  # Skip non-Gistribute files.
-  next if metadata.first.nil?
+  metadata = filename.split("||").map &:strip
 
-  puts " #{"*".green} Installing #{metadata[1] || filename}..."
+  # | as path separator in the Gist's file name, as Gist doesn't allow the
+  # usage of /.
+  path = metadata.last.gsub /[~|]/, "|" => "/", "~" => Dir.home
+  # Default description is the name of the file.
+  description = metadata.size == 1 ? File.basename(path) : metadata.first
 
-  # TODO: Is there a better way to handle ~?
-  path = metadata.first.gsub "~", Dir.home
+  puts " #{"*".green} Installing #{description}..."
 
   # Handle directories that don't exist.
   FileUtils.mkdir_p File.dirname(path)
 
-  File.open(path, "w") do |f|
-    # Remove all lines with metadata- lines that don't match will return nil,
-    # so compact it and drop that many off the top of the file.
-    f << lines[metadata.compact.size..-1].join
-  end
+  File.write path, data["content"]
 end

data/gistribute.gemspec

@@ -19,6 +19,5 @@ Gem::Specification.new do |gem|
   ]
 
   gem.add_dependency "json", "~> 1.7"
-  gem.add_dependency "nutella", "~> 0.10"
-  gem.add_dependency "colorize", "~> 0.5"
+  gem.add_dependency "nutella", "~> 0.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gistribute
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,23 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.11'
 description: Distribute files simply using GitHub Gist.
 email: vinny.diehl@gmail.com
 executables: