gistribute 0.0.1 → 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 943e1cbafa8fcd6769fdf9e11c4770a7589335247b4232fa4f37c7720cfb3769
+  data.tar.gz: 1d4fe35b75840e4d8f9a2510616790fdafe9e7b216422514736f9d82943f7dc4
+SHA512:
+  metadata.gz: 84563d81f9d47098a8a6a48b64c20a606f0831a34cf2d9fc3b150c0dd6e25cc9728103e0e3e7648a5e154f81c1ddc7ac2a7670d8d753689693f9d6f4b966dc52
+  data.tar.gz: ad01c45e1e7adcd4650ac23fcf0ed6c3f72112837639874350a3a22e1bc655e1369e26341d11b5d9a388d89e2e5f525697474235a7f503e16d08f63879be70ca

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2012 Vinny Diehl
+Copyright (C) 2012-2023 Vinny Diehl
 
 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

data/README.md

@@ -11,46 +11,36 @@ a tweak to one of the files that you're sharing.
 
 ## Installation
 
-    $ gem install gistribute
+```sh
+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.
+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:
+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.
 
-```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
-```
+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.
+```sh
+gistribute 123456
+gistribute https://gist.github.com/123456
+```

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.2

data/bin/gistribute

@@ -1,27 +1,28 @@
 #!/usr/bin/env ruby
 
+require "colorize"
+require "fileutils"
+require "json"
+require "open-uri"
+
+# Print to STDOUT to clear line
+CLEAR = "\r\e[K"
+
 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"
-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
-  gist = JSON.parse open("https://api.github.com/gists/#{id}").read
+  gist = JSON.parse(URI.open("https://api.github.com/gists/#{id}").read)
 rescue OpenURI::HTTPError => msg
-  print <<-EOS.heredoc.red
-
-
-    There was an error downloading the requested Gist.
+  print <<~EOS.red
+    #{CLEAR}There was an error downloading the requested Gist.
     The error is as follows:
   EOS
   puts msg
@@ -39,8 +40,8 @@ end
 #   "html_url" => "Link to the Gist",
 #   "description" => "The description for the Gist",
 #
-#   "user" => nil, # IF ANONYMOUS
-#   "user" => {    # IF TIED TO A USER
+#   "owner" => nil, # IF ANONYMOUS
+#   "owner" => {    # IF TIED TO A USER
 #     "login" => "username"
 #   },
 #
@@ -52,38 +53,34 @@ end
 #   }
 # }
 
-puts <<-EOS.heredoc
-
+# 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?
 
-  Finished downloading Gist from: #{gist["html_url"]}
+puts <<~EOS
+  #{CLEAR}Finished downloading Gist from: #{gist["html_url"]}
   Gist uploaded by #{
-    gist["user"] ? "user #{gist["user"]["login"]}" : "an anonymous user"
+    gist["owner"] ? "user #{gist["owner"]["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

@@ -14,11 +14,12 @@ Gem::Specification.new do |gem|
   gem.bindir = "bin"
   gem.executables = %w[gistribute]
 
-  gem.files = Dir["bin/**/*"] + %w[
+  gem.test_files = Dir["spec/**/*"]
+  gem.files = Dir["bin/**/*"] + gem.test_files + %w[
     LICENSE Rakefile README.md VERSION gistribute.gemspec
   ]
 
-  gem.add_dependency "json", "~> 1.7"
-  gem.add_dependency "nutella", "~> 0.10"
-  gem.add_dependency "colorize", "~> 0.5"
+  gem.add_dependency "colorize", "~> 1.0"
+  gem.add_development_dependency "fuubar", "~> 2.0"
+  gem.add_development_dependency "rspec", "~> 3.12"
 end

data/spec/gistribute_spec.rb

@@ -0,0 +1,33 @@
+require "fileutils"
+
+TEMP = "/tmp/gistribute_spec"
+
+describe "gistribute" do
+  # Make sure we start and end with a clean `/tmp`
+  before { FileUtils.rm_rf TEMP }
+  after { FileUtils.rm_rf TEMP }
+
+  BAD_LINK = "bad_link"
+  let(:output_404) { `gistribute #{BAD_LINK}` }
+
+  let(:output) { `gistribute https://gist.github.com/4346763` }
+  let(:output_only_id) { `gistribute 4346763` }
+
+  let :version do
+    File.read(File.expand_path("../../VERSION", __FILE__)).strip
+  end
+
+  %w[--version -v].each do |flag|
+    context "with the #{flag} flag" do
+      it "outputs the version" do
+        expect(`gistribute #{flag}`).to eq "Gistribute #{version}\n"
+      end
+    end
+  end
+
+  context "with a single file Gist" do
+    it "allows both the full URL and the Gist ID" do
+      expect(output).to eq output_only_id
+    end
+  end
+end

metadata

@@ -1,64 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gistribute
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: '0.2'
 platform: ruby
 authors:
 - Vinny Diehl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: nutella
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
+        version: '3.12'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.12'
 description: Distribute files simply using GitHub Gist.
 email: vinny.diehl@gmail.com
 executables:
@@ -66,36 +59,35 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/gistribute
 - LICENSE
-- Rakefile
 - README.md
+- Rakefile
 - VERSION
+- bin/gistribute
 - gistribute.gemspec
+- spec/gistribute_spec.rb
 homepage: https://github.com/gbchaosmaster/gistribute
 licenses:
 - MIT
-post_install_message: 
+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.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
 summary: GitHub Gist based file distribution.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/gistribute_spec.rb