gistribute 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54d0c1a3f95efadf4af148ba00f9c52f66bc80b4f979d357a7430c5c412e96ab
-  data.tar.gz: 49fafdc9abd4ba1d994f796cf047c925159ee3d9bf9128386a8e3341fff04194
+  metadata.gz: 97e259b2b9206eb05470a31911d121166d9ed55d94ea1eb2b2be860c9befec47
+  data.tar.gz: 97e818cbd5638d50782e2a95a910da6ab6c83724a6dcefbe01bd4699c4757f68
 SHA512:
-  metadata.gz: 4d01816a4228bf6041d1b6753b77655ce613166e4bdc8772a9d2e8482d1031fde7b3607c9664ccbd855b85d4e84ed82805dec1401f9d7a9c99af75fdd7991e4a
-  data.tar.gz: 83041e56c9d92034509149eb5a1968cdfea92dba1b15d3d66751b3597d2c602940e078a9eed2af3fd92f191cc9a05d9ad41687be5538180c9180c2bf53bef08e
+  metadata.gz: 7f45614e316c434a25cb92bca518faee4e3101ae8beadbc7ce60fbd4b73ac90ff5b5350fec966c078af5c79eb04dae91ee7609c754b443f2fa37b2bb0e4ad18d
+  data.tar.gz: f3977be4e4fbd3dbb29fb0b5569afdbea87f3bf9b8bf9e8569fd4dc155bed0410265688499f35fdc355c6a9c88a07a7c28de07f0b05682865e2e71f1e9a7f6c7

data/README.md

@@ -32,6 +32,13 @@ use the name of the file (without the path to it) as the default description.
 
 ## Usage
 
+For a detailed description of the available options, try one of the following:
+
+```sh
+gistribute upload -h
+gistribute install -h
+```
+
 ### Uploads
 
 To upload a gistribution, use the `upload` subcommand and pass in as many files

data/VERSION

@@ -1 +1 @@
-0.3
+0.3.1

data/lib/cli/install.rb

@@ -26,6 +26,7 @@ module Gistribute
       # 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.
       gist_description = gist.description.gsub(/(.{1,79})(\s+|\Z)/, "\\1\n").strip
+        .sub(/^\[gistribut(e|ion)\] ?/, "")
       gist_description = "\n#{gist_description}\n" unless gist_description.empty?
 
       # Process files

data/lib/cli/upload.rb

@@ -31,7 +31,7 @@ module Gistribute
     end
 
     def process_file(file)
-      file = File.expand_path(file)
+      file = @subcommand_options.relative ? file : File.expand_path(file)
 
       if File.directory?(file)
         # Recursively process every file in the directory

data/lib/cli.rb

@@ -62,6 +62,7 @@ module Gistribute
           opt :description, "description for the Gist", type: :string
           opt :private, "use a private Gist"
           opt :yes, "upload files without prompting"
+          opt :relative, "use relative file paths"
         end
 
         educate_on_error

data/spec/gistribute/cli_install_spec.rb

@@ -8,14 +8,19 @@ MULTI_FILENAMES = ["file1", "dir/file2"].freeze
 SINGLE_FILE_CONTENTS = "Line 1\nLine 2\n"
 
 # Test Gists
-PUB_SINGLE_FILE_ID = "4346763"
-SEC_SINGLE_FILE_ID = "5fa3c6bab88036e95d62cadf15128ec3"
-NO_TITLE_ID = "5865a130f9cf40acd9f0e85d15e601a7"
-NO_PIPE_SPACING_ID = "5677679b0db25054521753e5d59bed3d"
-NON_EXISTENT_DIR_ID = "8c86bf9cda921ebe7ad1bf0c46afb108"
-MULTI_FILE_ID = "8d4a2a4c8fe0b1427fed39c939857a40"
-CWD_ID = "3c7006e629fcc54262ef02a5b2204735"
-HOME_ID = "acb6caa80886101a68c5c85e4c100ddb"
+
+GIST_IDS = {
+  pub_single_file: "4346763",
+  sec_single_file: "5fa3c6bab88036e95d62cadf15128ec3",
+  no_title: "5865a130f9cf40acd9f0e85d15e601a7",
+  no_pipe_spacing: "5677679b0db25054521753e5d59bed3d",
+  non_existent_dir: "8c86bf9cda921ebe7ad1bf0c46afb108",
+  multi_file: "8d4a2a4c8fe0b1427fed39c939857a40",
+  cwd: "3c7006e629fcc54262ef02a5b2204735",
+  home: "acb6caa80886101a68c5c85e4c100ddb",
+  gist_description: "332d3f90378380a00614a088d9c179c5",
+  no_gist_description: "b35c3fcf05af11b7efc1a5dbd11d23be"
+}
 
 def test_single_file(id, path)
   before { run "install", id }
@@ -46,10 +51,10 @@ describe Gistribute::CLI do
       before { simulate_user_input "y\n" }
 
       {
-        "public single file": PUB_SINGLE_FILE_ID,
-        "secret single file": SEC_SINGLE_FILE_ID,
-        "no title": NO_TITLE_ID,
-        "no || spacing": NO_PIPE_SPACING_ID
+        "public single file": GIST_IDS[:pub_single_file],
+        "secret single file": GIST_IDS[:sec_single_file],
+        "no title": GIST_IDS[:no_title],
+        "no || spacing": GIST_IDS[:no_pipe_spacing]
       }.each do |description, id|
         context "when run with a #{description} Gist" do
           test_single_file id, TEMP
@@ -57,7 +62,7 @@ describe Gistribute::CLI do
       end
 
       context "when given a directory that doesn't exist" do
-        before { run "install", NON_EXISTENT_DIR_ID }
+        before { run "install", GIST_IDS[:non_existent_dir] }
 
         let(:file_contents) { File.read "#{TEMP}/#{NEW_DIR_FILENAME}" }
 
@@ -67,7 +72,7 @@ describe Gistribute::CLI do
       end
 
       context "when run with a multi-file Gist" do
-        before { run "install", MULTI_FILE_ID }
+        before { run "install", GIST_IDS[:multi_file] }
 
         let(:file1_contents) { File.read "#{TEMP}/#{MULTI_FILENAMES[0]}" }
         let(:file2_contents) { File.read "#{TEMP}/#{MULTI_FILENAMES[1]}" }
@@ -81,11 +86,11 @@ describe Gistribute::CLI do
       end
 
       context "when given a file for the current working directory" do
-        test_single_file CWD_ID, Dir.pwd
+        test_single_file GIST_IDS[:cwd], Dir.pwd
       end
 
       context "when given a file for the home directory" do
-        test_single_file HOME_ID, Dir.home
+        test_single_file GIST_IDS[:home], Dir.home
       end
 
       context "when given a bad ID (404)" do
@@ -105,12 +110,35 @@ describe Gistribute::CLI do
           expect($stderr).to have_received(:puts).with("bad")
         end
       end
+
+      context "when given a Gist with only a description" do
+        before { run "install", GIST_IDS[:gist_description] }
+
+        it "prints the description" do
+          expect($stdout).to have_received(:write)
+            .with(a_string_including("test description"))
+        end
+
+        it "removes the `[gistribution]` from the beginning" do
+          expect($stdout).not_to have_received(:write)
+            .with(a_string_including("[gistribution]"))
+        end
+      end
+
+      context "when given a Gist with only `[gistribution]` in the description" do
+        before { run "install", GIST_IDS[:no_gist_description] }
+
+        it "doesn't print the description" do
+          expect($stdout).not_to have_received(:write)
+            .with(a_string_including("[gistribution]"))
+        end
+      end
     end
 
     context "when user inputs nothing at the installation prompt" do
       before do
         simulate_user_input "\n"
-        run "install", PUB_SINGLE_FILE_ID
+        run "install", GIST_IDS[:pub_single_file]
       end
 
       it "saves the file" do
@@ -122,7 +150,7 @@ describe Gistribute::CLI do
       context "when user inputs `#{ch}` at the installation prompt" do
         before do
           simulate_user_input "#{ch}\n"
-          run "install", PUB_SINGLE_FILE_ID
+          run "install", GIST_IDS[:pub_single_file]
         end
 
         it "doesn't save the file" do
@@ -147,7 +175,7 @@ describe Gistribute::CLI do
       context "when the user inputs `y` at the file overwrite prompts" do
         before do
           simulate_user_input "y\n", "y\n", "y\n"
-          run "install", MULTI_FILE_ID
+          run "install", GIST_IDS[:multi_file]
         end
 
         it "downloads the files into the correct locations" do
@@ -158,7 +186,7 @@ describe Gistribute::CLI do
       context "when the user inputs `n` at the file overwrite prompts" do
         before do
           simulate_user_input "y\n", "n\n", "n\n"
-          run "install", MULTI_FILE_ID
+          run "install", GIST_IDS[:multi_file]
         end
 
         it "doesn't download the files" do
@@ -169,7 +197,7 @@ describe Gistribute::CLI do
       context "with the `--force` flag" do
         before do
           simulate_user_input "y\n"
-          run "install", "--force", MULTI_FILE_ID
+          run "install", "--force", GIST_IDS[:multi_file]
         end
 
         it "overwrites the files without prompting" do
@@ -181,7 +209,7 @@ describe Gistribute::CLI do
     end
 
     context "when ran with the --yes flag" do
-      before { run "install", "--yes", PUB_SINGLE_FILE_ID }
+      before { run "install", "--yes", GIST_IDS[:pub_single_file] }
 
       let(:file_contents) { File.read "#{TEMP}/#{FILENAME}" }
 

data/spec/gistribute/cli_upload_spec.rb

@@ -157,5 +157,44 @@ describe Gistribute::CLI do
         expect(octokit_client).to have_received(:create_gist)
       end
     end
+
+    context "with the `--relative` flag" do
+      context "with a single file" do
+        before do
+          File.write(FILENAME, SINGLE_FILE_CONTENT)
+          simulate_user_input "Test File\n", "y\n"
+          run "upload", "--relative", FILENAME
+        end
+
+        after { File.delete FILENAME }
+
+        it "uploads with a relative file path" do
+          expect(octokit_client).to have_received(:create_gist)
+            .with(a_hash_including(files: { "Test File || #{FILENAME}" => anything }))
+        end
+      end
+
+      context "with a single directory" do
+        let(:test_dir) { "test_dir" }
+
+        before do
+          FileUtils.mkdir test_dir
+          [1, 2].each { |n| FileUtils.touch "#{test_dir}/file#{n}" }
+
+          simulate_user_input "File 1\n", "File 2\n", "y\n"
+          run "upload", "--relative", test_dir
+        end
+
+        after { FileUtils.rm_rf test_dir }
+
+        it "uploads with a relative file path" do
+          expect(octokit_client).to have_received(:create_gist)
+            .with(a_hash_including(files: {
+              "File 1 || #{test_dir}|file1" => anything,
+              "File 2 || #{test_dir}|file2" => anything
+            }))
+        end
+      end
+    end
   end
 end

data/spec/gistribute_spec.rb

@@ -4,7 +4,9 @@ require "spec_helper"
 
 describe Gistribute do
   describe "::parse_id" do
-    [PUB_SINGLE_FILE_ID, SEC_SINGLE_FILE_ID].each do |id|
+    %i[pub_single_file sec_single_file].each do |gist|
+      id = GIST_IDS[gist]
+
       [
         "https://gist.github.com/username/#{id}",
         "https://gist.github.com/#{id}",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gistribute
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - Vinny Diehl