gist_directory 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00bc8e4663843087d2257991dca4102c3279c847
-  data.tar.gz: 7c5ad3b33b8536f334a63d86fa6ca14e3d01292b
+  metadata.gz: 0080a71489798fc02f6e2a875949d6b490dc5ab9
+  data.tar.gz: f2216c59729f4a82451b568214bc78a1299ac892
 SHA512:
-  metadata.gz: 05c47bccc6c9a2046e4893bdd4b78e740e1fecad5a5610bf5023db6e8ef0f0f2e16df7979d42067e79dcb7aebec1e4a3738769db3c3e76eed960a54692b7b52b
-  data.tar.gz: bcbdb0028c86be4ea66d6bc958fe6e5059eb5d01a0945170d618bbb6d64ccc6b6d02262aae549c35fcaffb41aa1729518bdc1469de2a9b2247adc706d46a0bc2
+  metadata.gz: 9d348e279867f93f0911e24fcac2a8526e9bafcc6946f91acad84180a037b16bed1cb8d414d0d775e468127a7368adedaf98b953272498e09833dc6b3a9ed935
+  data.tar.gz: b362c710f3887e208150d6fb9782aef57452ad0c01161c425bd0c243b4c98162e9dcb2ffe016b43bc03c4f7c04f75da227e6c02596d561139fdc1ce9592e8c54

data/README.md

@@ -1,18 +1,29 @@
 # gist_directory
 
-Create collections of public gists in a local directory
+Create and maintain collections of public gists in a local directory
+
+# Dependencies
+
+```
+npm install gulp-octodown-livereload
+```
 
 # Usage
 
-Create a gist called `food.md` in a directory called `food`
+Create a gist called `bacon.md` in a directory called `food`
 under your home directory:
 
 ```shell
-gist_directory create ~/food
+gist_directory create ~/food/bacon.md
 ```
 
-Create a gist called `bacon.txt`:
+Edit in your favourite editor (creating if necessary):
 
 ```shell
-gist_directory create ~/food bacon.txt
+gist_directory edit ~/food/bacon.md
 ```
+
+View compiled Markdown in your browser (ith livereload):
+
+```shell
+gist_directory view ~/food/bacon.md

data/bin/gist_directory

@@ -6,15 +6,17 @@ require "gist_directory"
 
 def usage
   puts <<-EOT
-#{$0} create DIRECTORY [FILE]"
+#{$0} create|edit|view [FILE_PATH]"
 
-DIRECTORY:
-Creates a Gist with a single file.
+create:
+* if the directory already contains a Gist, add the file
+* otherwise, creates a new Gist containing the file
 
-FILE:
+edit:
+* opens the file for editing
 
-By default, a Markdown file called basename([DIRECTORY]) + ".md" is created.
-Supply an optional filename to use instead of this default.
+view (Markdown only):
+* opens the converted file in your browser and watches for changes.
   EOT
 end
 
@@ -24,10 +26,17 @@ if ARGV.size < 2
 end
 
 command = ARGV[0]
-path = ARGV[1]
-directory = File.basename(path)
-file = ARGV[2] || directory + ".md"
-
-raise "Unknown command '#{command}'" unless command  == "create"
-
-GistDirectory.new(path: path).create(filename: file)
+filename = ARGV[1]
+
+gist = GistDirectory.new(filename: filename)
+
+case command
+when "create"
+  gist.create
+when "edit"
+  gist.edit
+when "view"
+  gist.view
+else
+  raise "Unknown command '#{command}'"
+end

data/lib/gist_directory.rb

@@ -1,50 +1,111 @@
 require "gist"
 require "git"
 
+class GistFile
+  attr_reader :pathname
+
+  def initialize(pathname)
+    @pathname = File.expand_path(pathname)
+  end
+
+  def create
+    if ! File.directory?(path)
+      create_gist
+    else
+      create_file_if_missing
+    end
+  end
+
+  def edit
+    create
+    raise "Please set the EDITOR environment variable" if ! ENV.include?("EDITOR")
+
+    exec "$SHELL $EDITOR '#{pathname}'"
+  end
+
+  def view
+    exec "$SHELL gulp-octodown-livereload '#{pathname}'"
+  end
+
+  private
+
+  def create_gist
+    result = Gist.gist(content_for_empty_file, filename: basename, public: true)
+    gist_hash = result["id"]
+
+    Git.clone("git@gist.github.com:#{gist_hash}", path)
+  end
+
+  def create_file_if_missing
+    raise "The file #{pathname} already exists" if exists?
+    create_empty_file pathname
+    add
+  end
+
+  def create_empty_file(pathname)
+    File.open(pathname, "w") { |f| f.puts content_for_empty_file }
+  end
+
+  def add
+    git = Git.open(path)
+    git.add(pathname)
+    git.commit("Added '#{basename}'")
+    git.push
+  end
+
+  def exists?
+    File.exist?(pathname)
+  end
+
+  def path
+    File.dirname(pathname)
+  end
+
+  def basename
+    File.basename(pathname)
+  end
+
+  def content_for_empty_file
+    "Empty Gist"
+  end
+end
+
 class GistDirectory
   MAJOR    = 0
-  MINOR    = 0
-  REVISION = 3
+  MINOR    = 1
+  REVISION = 1
   VERSION  = [MAJOR, MINOR, REVISION].map(&:to_s).join('.')
 
-  attr_reader :path
-  attr_reader :git
+  attr_reader :filename
 
-  def initialize(path: nil)
-    @path = File.expand_path(path)
+  def initialize(filename: nil)
+    @filename = File.expand_path(filename)
   end
 
-  def create(filename: nil)
-    raise "No filename supplied" if filename.nil?
+  def path
+    @path = File.dirname(filename)
+  end
 
+  def create
     if path_exists?
       fail_unless_gist_directory
-      fail_if_filename_exists filename
-      add_file_to_directory filename: filename
-    else
-      do_gist_create filename: filename
     end
-  end
-
-  private
 
-  def add_file_to_directory(filename: nil)
-    do_file_add filename: filename
+    file.create
   end
 
-  def do_gist_create(filename: nil)
-    result = Gist.gist(content_for_empty_file, filename: filename, public: true)
-    gist_hash = result["id"]
+  def edit
+    file.edit
+  end
 
-    Git.clone("git@gist.github.com:#{gist_hash}", path)
+  def view
+    file.view
   end
 
-  def do_file_add(filename: nil)
-    absolute = filepath(filename: filename)
-    File.open(absolute, "w") { |f| f.puts content_for_empty_file }
-    git.add(absolute)
-    git.commit("Added '#{filename}'")
-    git.push
+  private
+
+  def file
+    @file ||= GistFile.new(filename)
   end
 
   def fail_unless_gist_directory
@@ -52,35 +113,30 @@ class GistDirectory
       raise "#{path} exists and does not contain a Gist repository"
     end
   end
-  
-  def fail_if_filename_exists(filename)
-    absolute = filepath(filename: filename)
-    if File.exist?(absolute)
-      raise "A file called #{filename} already exists in #{path}"
-    end
-  end
 
-  def git
-    @git ||= Git.open(path)
+  def is_gist_directory?
+    return false if ! is_git_directory?
+    origin = origin_remote
+    return false if origin.nil?
+    is_gist_url? origin.url
   end
 
-  def filepath(filename: nil)
-    File.join(path, filename)
+  def is_git_directory?
+    git_path = File.join(path, ".git")
+    File.directory?(git_path)
   end
 
-  def path_exists?
-    File.directory?(path)
+  def origin_remote
+    git = Git.open(path)
+    git.remotes.select { |r| r.name == "origin" }[0]
   end
 
-  def is_gist_directory?
-    return false unless File.directory?(File.join(path, ".git"))
-    origin = git.remotes.select { |r| r.name == "origin" }[0]
-    return false if origin.nil?
-    m = %r(^git@gist\.github\.com:\w+$).match(origin.url)
+  def is_gist_url?(url)
+    m = %r(^git@gist\.github\.com:\w+$).match(url)
     ! m.nil?
   end
 
-  def content_for_empty_file
-    "Empty Gist"
+  def path_exists?
+    File.directory?(path)
   end
 end

data/spec/gist_directory_spec.rb

@@ -3,26 +3,27 @@ require "gist_directory"
 RSpec.describe GistDirectory do
   let(:path) { "/foo/bar" }
   let(:path_exists) { false }
-  let(:filename) { "baz.txt" }
+  let(:filename) { File.join(path, "baz.txt") }
   let(:gist_result) { {"id" => gist_hash} }
   let(:gist_hash) { "gist_sha1_hash" }
   let(:git) { double(Git) }
-  subject { described_class.new(path: path) }
+  subject { described_class.new(filename: filename) }
 
   before do
     allow(File).to receive(:directory?).and_call_original
     allow(File).to receive(:directory?).with(path) { path_exists }
     allow(Gist).to receive(:gist) { gist_result }
     allow(Git).to receive(:clone)
-    allow(Git).to receive(:open) { git }
+    allow(Git).to receive(:open).and_raise("Unexpected path")
+    allow(Git).to receive(:open).with(path) { git }
   end
 
   describe "#create" do
     context "when the path doesn't exist" do
       it "creates a Gist, adding the file" do
-        subject.create(filename: filename)
+        subject.create
         expect(Gist).to have_received(:gist).with(
-          "Empty Gist", {filename: filename, public: true}
+          "Empty Gist", {filename: File.basename(filename), public: true}
         )
       end
     end
@@ -38,14 +39,13 @@ RSpec.describe GistDirectory do
       context "and contains a Git repo" do
         let(:dot_git_exists) { true }
         let(:remotes) { [double(Git::Remote, name: "origin", url: repo_url)] }
-        let(:filepath) { File.join(path, filename) }
         let(:file) { double(File, puts: nil) }
 
         before do
           allow(File).to receive(:open).and_call_original
-          allow(File).to receive(:open).with(filepath, "w").and_yield(file)
+          allow(File).to receive(:open).with(filename, "w").and_yield(file)
           allow(File).to receive(:exist?).and_call_original
-          allow(File).to receive(:exist?).with(filepath) { file_exists }
+          allow(File).to receive(:exist?).with(filename) { file_exists }
           allow(git).to receive(:remotes) { remotes }
           allow(git).to receive(:add)
           allow(git).to receive(:commit)
@@ -59,13 +59,13 @@ RSpec.describe GistDirectory do
             let(:file_exists) { false }
 
             it "creates the file" do
-              subject.create(filename: filename)
+              subject.create
               expect(file).to have_received(:puts)
             end
 
             it "adds the file" do
-              subject.create(filename: filename)
-              expect(git).to have_received(:add).with(filepath)
+              subject.create
+              expect(git).to have_received(:add).with(filename)
               expect(git).to have_received(:commit)
             end
           end
@@ -75,7 +75,7 @@ RSpec.describe GistDirectory do
 
             it "fails" do
               expect do
-                subject.create(filename: filename)
+                subject.create
               end.to raise_error(RuntimeError, /#{filename} already exists/)
             end
           end
@@ -86,7 +86,7 @@ RSpec.describe GistDirectory do
 
           it "fails" do
             expect do
-              subject.create(filename: filename)
+              subject.create
             end.to raise_error(RuntimeError, /not contain a Gist repository/)
           end
         end
@@ -97,7 +97,7 @@ RSpec.describe GistDirectory do
 
         it "fails" do
           expect do
-            subject.create(filename: filename)
+            subject.create
           end.to raise_error(RuntimeError, /not contain a Gist repository/)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gist_directory
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git