gistribute 0.0.1.pre1 → 0.0.1

data/README.md

@@ -2,4 +2,55 @@
 
 Gistribute is a simple file distribution system based on GitHub's Gist service.
 
-More coming soon.
+I decided to make Gistribute when I found myself sharing configuration files
+and such with others by placing all of them into a Gist along with a little
+Bash script that curled all of the files, via their raw URLs, to the right
+location on the other's computer. This program removed the need to make that
+script, and the need to update the raw URLs in that script whenever you make
+a tweak to one of the files that you're sharing.
+
+## Installation
+
+    $ gem install gistribute
+
+## 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.
+
+## 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.
+
+set nocompatible
+filetype indent plugin on
+syntax on
+```
+
+If, for example, the resulting Gist link was https://gist.github.com/123456,
+the user would be able to run either of these commands to download the file
+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.

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/gistribute

@@ -1,5 +1,10 @@
 #!/usr/bin/env ruby
 
+if %w[-v --version].include? ARGV.first
+  puts "Gistribute #{File.read(File.expand_path("../../VERSION", __FILE__)).strip}"
+  exit 0
+end
+
 require "json"
 require "open-uri"
 require "colorize"
@@ -7,19 +12,23 @@ require "nutella"
 
 print "Downloading data..."
 
+# The user can paste in either just the ID or the entire URL to the Gist.
+id = ARGV.first[/(^|\/)([[:xdigit:]]+)/, 2]
+
 begin
-  # TODO: Let the user paste the entire Gist URL and parse out the ID.
-  gist = JSON.parse open("https://api.github.com/gists/#{ARGV.first}").read
+  gist = JSON.parse open("https://api.github.com/gists/#{id}").read
 rescue OpenURI::HTTPError => msg
-  puts <<-EOS.heredoc.red
+  print <<-EOS.heredoc.red
 
 
     There was an error downloading the requested Gist.
     The error is as follows:
   EOS
-
   puts msg
 
+  puts "The ID that was queried is:".red
+  puts id
+
   exit -1
 end
 
@@ -43,19 +52,19 @@ end
 #   }
 # }
 
-user = gist["user"] ? "user #{gist["user"]["login"]}" : "an anonymous user"
-
 puts <<-EOS.heredoc
 
 
   Finished downloading Gist from: #{gist["html_url"]}
-  Gist uploaded by #{user}.
+  Gist uploaded by #{
+    gist["user"] ? "user #{gist["user"]["login"]}" : "an anonymous user"
+  }.
 
   Beginning install...
 EOS
 
 gist["files"].each do |filename, data|
-  lines = data["content"].split "\n"
+  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.
@@ -66,10 +75,15 @@ gist["files"].each do |filename, data|
 
   puts " #{"*".green} Installing #{metadata[1] || filename}..."
 
-  # TODO: Handle ~ better. Also, handle EOF newlines.
-  File.open(metadata.first.gsub(/~/, Dir.home), "w") do |f|
+  # TODO: Is there a better way to handle ~?
+  path = metadata.first.gsub "~", Dir.home
+
+  # 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("\n")
+    f << lines[metadata.compact.size..-1].join
   end
 end

data/gistribute.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.executables = %w[gistribute]
 
   gem.files = Dir["bin/**/*"] + %w[
-    LICENSE Rakefile README.md gistribute.gemspec
+    LICENSE Rakefile README.md VERSION gistribute.gemspec
   ]
 
   gem.add_dependency "json", "~> 1.7"

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: gistribute
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre1
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Vinny Diehl
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - Rakefile
 - README.md
+- VERSION
 - gistribute.gemspec
 homepage: https://github.com/gbchaosmaster/gistribute
 licenses:
@@ -87,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24