mr_poole 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55b01d175e1b4409aa3952570665706d4cb48b12
-  data.tar.gz: e3e8070ed4000eae92275b01c2ba420ff7424432
+  metadata.gz: d0bb58fc7fc0fff02dd0be8fae3c1de6a74dd8a4
+  data.tar.gz: 7b4e5d81046fe6e405948da87c791745b22aa453
 SHA512:
-  metadata.gz: 6e7f154e7cc3cab30bfecc709f5fc132d39fa69a0e62742bc9f6436bef2aa901f8633f87ae474a3524913997c795c3c5af2c1c86dde696866b0e623af808afb1
-  data.tar.gz: 357f0267e6992c9b944f1ff8b1ff01947ad28da1e6a36e2880f9ffde82b585cb03e304da7f1e883810d9650c6aef2027ff9763090af0d677eef1edf9cc6a4033
+  metadata.gz: 663fca7eb25273cae3c580d32ec9ae7c33b5cb44458ddba6558c5b0ee1b17894a0c950e6970d7c5ad19dad89f1466f49f6d43924b8795e626df947bc9ab46df7
+  data.tar.gz: cecba65c4d0ff57bc87ea30796cf4b1e69911a4c030712c11b30bdd967c5307e747297a78ed4cc818ee60772bddc69cda878fab434d913ee4fd83487c927c2a5

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v0.6.0 (2014-04-02)
+
+- Ability to open new posts in editor specified in config file. Thanks
+  [qrohlf](//github.com/qrohlf)!
+
 ### v0.5.1 (2014-01-31)
 
 - Bug fixes for older rubies (1.8.7, 1.9.2).

data/README.md

@@ -21,7 +21,7 @@ Mr. Poole is primarily a command-line application: the gem installs an
 executable called `poole` in your path. It has four subcommands: post, draft,
 publish, and unpublish. All four of these commands echo a filename to STDOUT,
 so you can do something like `poole post "Title" | vim` and start editing
-immediately.
+immediately. Alternatively, you can also have Mr. Poole auto open new posts in your preferred `$EDITOR` (see [Configuration](#configuration)).
 
 ### Post
 
@@ -128,6 +128,7 @@ should provide a `poole` key, which may take the following subkeys:
 - `default_layout` - path to a default layout to use
 - `default_extension` - file extension to use
 - `word_separator` - character to use for slug generation
+- `auto_open` - set to `true`to automatically open new posts in your `$EDITOR`
 
 Any options you provide in `_config.yml` will override poole's built-in
 defaults. Mr. Poole defaults to using Markdown (with extension "md"), and the

data/lib/mr_poole/cli.rb

@@ -30,56 +30,40 @@ module MrPoole
     end
 
     def handle_post
-      options = do_creation_options
-      options.title ||= @params.first
-
-      @helper.post_usage unless options.title
-      fn = @commands.post(options)
-      puts "#{@src_dir}/#{fn}"
+      do_create('post')
     end
 
     def handle_draft
-      options = do_creation_options
-      options.title ||= @params.first
-
-      @helper.draft_usage unless options.title
-      fn = @commands.draft(options)
-      puts "#{@src_dir}/#{fn}"
+      do_create('draft')
     end
 
     def handle_publish
-      options = OpenStruct.new
-      opt_parser = OptionParser.new do |opts|
-        opts.on('-d', '--keep-draft', "Keep the draft post") do |d|
-          options.keep_draft = d
-        end
-        opts.on('-t', '--keep-timestamp', "Keep the existing timestamp") do |t|
-          options.keep_timestamp = t
-        end
-      end
-      opt_parser.parse! @params
-
-      path = @params.first
-      @helper.publish_usage unless path
-      fn = @commands.publish(path, options)
-      puts "#{@src_dir}/#{fn}"
+      do_move('publish')
     end
 
     def handle_unpublish
-      options = OpenStruct.new
-      opt_parser = OptionParser.new do |opts|
-        opts.on('-p', '--keep-post', "Do not delete post") do |p|
-          options.keep_post = p
-        end
-        opts.on('-t', '--keep-timestamp', "Keep the existing timestamp") do |t|
-          options.keep_timestamp = t
-        end
-      end
-      opt_parser.parse! @params
+      do_move('unpublish')
+    end
+
+    private
+
+    # action is a string, either 'post' or 'draft'
+    def do_create(action)
+      options = do_creation_options
+      options.title ||= @params.first
+
+      @helper.send("#{action}_usage") unless options.title
+      fn = @commands.send(action, options)
+      puts "#{@src_dir}/#{fn}"
+    end
 
+    # action is a string, either 'publish' or 'unpublish'
+    def do_move(action)
+      options = do_move_options(action)
       path = @params.first
-      @helper.unpublish_usage unless path
-      fn = @commands.unpublish(path, options)
+
+      @helper.send("#{action}_usage") unless path
+      fn = @commands.send(action, path, options)
       puts "#{@src_dir}/#{fn}"
     end
 
@@ -109,5 +93,28 @@ module MrPoole
       options
     end
 
+    # pass a string, either publish or unpublish
+    def do_move_options(type)
+      options = OpenStruct.new
+      opt_parser = OptionParser.new do |opts|
+        if type == 'publish'
+          opts.on('-d', '--keep-draft', "Keep draft post") do |d|
+            options.keep_draft = d
+          end
+        else
+          opts.on('-p', '--keep-post', "Do not delete post") do |p|
+            options.keep_post = p
+          end
+        end
+
+        opts.on('-t', '--keep-timestamp', "Keep existing timestamp") do |t|
+          options.keep_timestamp = t
+        end
+      end
+
+      opt_parser.parse! @params
+      options
+    end
+
   end
 end

data/lib/mr_poole/commands.rb

@@ -34,7 +34,7 @@ module MrPoole
       f = File.open(path, "w")
       f.write(head)
       f.close
-
+      @helper.open_in_editor(path) # open file if config key set
       path    # return the path, in case we want to do anything useful
     end
 
@@ -62,7 +62,7 @@ module MrPoole
       f = File.open(path, "w")
       f.write(head)
       f.close
-
+      @helper.open_in_editor(path) # open file if config key set
       path    # return the path, in case we want to do anything useful
     end
 

data/lib/mr_poole/helper.rb

@@ -89,6 +89,22 @@ module MrPoole
       exit
     end
 
+    def open_in_editor(path)
+      # don't do anything if the user hasn't explicitly enabled the feature
+      return unless @config.auto_open
+
+      if editor = ENV['EDITOR']
+        `#{editor} #{path}`
+      else
+        puts "You have enabled the auto_open feature in your config.yml,"
+        puts "but have no editor configured."
+        puts ''
+        puts "Please set your $EDITOR environment variable to the "
+        puts "editor that poole should use to open new posts/drafts."
+        puts ''
+      end
+    end
+
     def version_statement
       puts ''
       puts "This is Mr. Poole, version #{MrPoole::VERSION}, running on ruby version #{RUBY_VERSION}"

data/lib/mr_poole/version.rb

@@ -1,3 +1,3 @@
 module MrPoole
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/command_spec.rb

@@ -13,44 +13,44 @@ module MrPoole
 
     describe "#post" do
       context 'title only' do
-        it "should create a new post in the _posts directory" do
+        it "creates a new post in the _posts directory" do
           fn = c.post({:title => "test_post"})
           expect(File.exists?(fn)).to be_true
         end
 
-        it "should return path to the newly created post" do
+        it "returns path to the newly created post" do
           returned = c.post({:title => "test_post"})
           determined = Dir.glob("_posts/*.md").first
           expect(returned).to eq(determined)
         end
 
-        it "should create a timestamped post in the _posts directory" do
+        it "creates a timestamped post in the _posts directory" do
           fn = c.post({:title => "test_post" })
           expect(fn).to match(/#{date_regex}-test_post[.]md$/)
         end
 
-        it "should downcase a title" do
+        it "downcases a title" do
           fn = c.post({:title => "Test_Post_With_Uppercase"})
           expect(fn).to match(/#{date_regex}-test_post_with_uppercase[.]md/)
         end
 
-        it "should sub underscores for spaces in title" do
+        it "subs underscores for spaces in title" do
           fn = c.post({:title => "Test Post with Spaces"})
           expect(fn).to match(/#{date_regex}-test_post_with_spaces[.]md/)
         end
 
-        it "should remove non-word characters for slug" do
+        it "removes non-word characters for slug" do
           fn = c.post({:title => "On (function() {}()) in JavaScript"})
           expect(fn).to match(/#{date_regex}-on_function_in_javascript[.]md/)
         end
 
-        it "should update the title in the file itself" do
+        it "updates the title in the file itself" do
           fn = c.post({:title => "Testing Post {}"})
           content = File.open(fn, 'r').read
           expect(content).to match(/title: Testing Post \{\}/)
         end
 
-        it "should update the date in the file itself" do
+        it "updates the date in the file itself" do
           fn = c.post({:title => "Date test post"})
 
           # date in filename should match date in file itself
@@ -61,17 +61,17 @@ module MrPoole
       end   # end context title only
 
       context 'title and slug' do
-        it "should create a post named for slug" do
+        it "creates a post named for slug" do
           fn = c.post({:title => "Test Post", :slug => 'unique_slug'})
           expect(fn).to match(/#{date_regex}-unique_slug[.]md$/)
         end
 
-        it "should sub any weird characters in slug" do
+        it "subs any weird characters in slug" do
           fn = c.post({:title => "Test Post with Spaces", :slug => "(stupid] {slüg/"})
           expect(fn).to match(/#{date_regex}-stupid_slg[.]md/)
         end
 
-        it "should update the title in the file itself" do
+        it "updates the title in the file itself" do
           fn = c.post({:title => "Testing Post {}", :slug => 'shouldnt_be_in_title'})
           content = File.open(fn, 'r').read
           expect(content).to match(/title: Testing Post \{\}/)
@@ -81,7 +81,7 @@ module MrPoole
       context 'with custom layout' do
         let(:layout_path) { write_custom_layout }
 
-        it "should exit if layout path doesn't exist" do
+        it "exits if layout path doesn't exist" do
           expect {
             capture_stdout do
               c.post({:title => 'test_post', :layout => 'bogus_path.md'})
@@ -89,13 +89,13 @@ module MrPoole
           }.to raise_error(SystemExit)
         end
 
-        it 'should not use the default layout' do
+        it 'does not use the default layout' do
           fn = c.post({:title => 'test_post', :layout => layout_path})
           content = File.open(fn, 'r').read
           expect(content).not_to match(/layout: post/)
         end
 
-        it 'should use the custom layout' do
+        it 'uses the custom layout' do
           fn = c.post({:title => 'test_post', :layout => layout_path})
           content = File.open(fn, 'r').read
           expect(content).to match(/tags: testing/)
@@ -105,62 +105,62 @@ module MrPoole
 
     describe "#draft" do
       context 'title only' do
-        it "should create a _drafts directory" do
+        it "creates a _drafts directory" do
           c.draft({:title => 'draft post'})
           expect(File.exists?('_drafts')).to be_true
         end
 
-        it "should return path to the newly created draft" do
+        it "returns path to the newly created draft" do
           returned = c.draft({:title => "test_draft"})
           determined = Dir.glob("_drafts/*.md").first
           expect(returned).to eq(determined)
         end
 
-        it "should create a new draft in the _drafts directory" do
+        it "creates a new draft in the _drafts directory" do
           fn = c.draft({:title => 'draft post'})
           expect(File.exists?(fn)).to be_true
         end
 
-        it "should create a non-timestamped draft" do
+        it "creates a non-timestamped draft" do
           fn = c.draft({:title => 'draft post'})
           expect(fn).not_to match(/#{date_regex}/)
         end
 
-        it "should downcase and underscore title for slug" do
+        it "downcases and underscore title for slug" do
           fn = c.draft({:title => "Test Post with Spaces"})
           expect(fn).to match(/test_post_with_spaces[.]md/)
         end
 
-        it "should remove non-word characters for slug" do
+        it "removes non-word characters for slug" do
           fn = c.draft({:title => "On (function() {}()) in JavaScript"})
           expect(fn).to match(/on_function_in_javascript[.]md/)
         end
 
-        it "should update the title in the file itself" do
+        it "updates the title in the file itself" do
           fn = c.draft({:title => "Testing Draft {}"})
           content = File.open(fn, 'r').read
           expect(content).to match(/title: Testing Draft \{\}/)
         end
 
-        it "should not update the date in the file itself" do
+        it "does not update the date in the file itself" do
           fn = c.draft({:title => "Date test post"})
           content = File.open(fn, 'r').read
-          expect(content).to match(/date: \d{4}-\d{2}-\d{2}\n/)
+          expect(content).to match(/date: #{date_regex}/)
         end
       end   # end context title only
 
       context 'title and slug' do
-        it "should create a draft named for slug" do
+        it "creates a draft named for slug" do
           fn = c.draft({:title => "Test Draft", :slug => 'unique_slug'})
           expect(fn).to match(/unique_slug[.]md$/)
         end
 
-        it "should sub any weird characters in slug" do
+        it "subs any weird characters in slug" do
           fn = c.draft({:title => "Test Post with Spaces", :slug => "(stupid] {slüg/"})
           expect(fn).to match(/stupid_slg[.]md/)
         end
 
-        it "should update the title in the file itself" do
+        it "updates the title in the file itself" do
           fn = c.draft({:title => "Testing Post {}", :slug => 'shouldnt_be_in_title'})
           content = File.open(fn, 'r').read
           expect(content).to match(/title: Testing Post \{\}/)
@@ -170,7 +170,7 @@ module MrPoole
       context 'with custom layout' do
         let(:layout_path) { write_custom_layout }
 
-        it "should exit if layout path doesn't exist" do
+        it "exits if layout path doesn't exist" do
           expect {
             capture_stdout do
               c.draft({:title => 'test_post', :layout => 'bogus_path.md'})
@@ -178,80 +178,53 @@ module MrPoole
           }.to raise_error(SystemExit)
         end
 
-        it 'should not use the default layout' do
+        it 'does not use the default layout' do
           fn = c.draft({:title => 'test_post', :layout => layout_path})
           content = File.open(fn, 'r').read
           expect(content).not_to match(/layout: post/)
         end
 
-        it 'should use the custom layout' do
+        it 'uses the custom layout' do
           fn = c.draft({:title => 'test_post', :layout => layout_path})
           content = File.open(fn, 'r').read
           expect(content).to match(/tags: testing/)
         end
       end   # context custom layout
-
-      # I'm not sure why I originally decided to test all the slug generation
-      # code in the draft section, but here we go anyway.
-      context 'with custom word_separator in config file' do
-        before(:each) { write_config_file_custom_word_sep }
-
-        it "should downcase and underscore title for slug" do
-          fn = c.draft({:title => "Test Post with Spaces"})
-          expect(fn).to match(/test-post-with-spaces[.]md/)
-        end
-
-        it "should remove non-word characters for slug" do
-          fn = c.draft({:title => "On (function() {}()) in JavaScript"})
-          expect(fn).to match(/on-function-in-javascript[.]md/)
-        end
-
-        it "explicit slug overrides custom word_separator" do
-          fn = c.draft({:title => "Test Draft", :slug => 'unique_slug'})
-          expect(fn).to match(/unique_slug[.]md$/)
-        end
-
-        it "should sub any weird characters in slug" do
-          fn = c.draft({:title => "Test Post with Spaces", :slug => "(stupid] {slüg/"})
-          expect(fn).to match(/stupid-slg[.]md/)
-        end
-
-      end   # end context custom word_separator
     end   # end describe draft
 
     describe "#publish" do
       let(:d_path) { c.draft({:title => 'test_draft'}) }
 
-      it 'should return path to newly created post' do
+      it 'returns path to newly created post' do
         returned = c.publish(d_path)
         determined = Dir.glob("_posts/*.md").first
         expect(returned).to eq(determined)
       end
 
-      it 'should create a timestamped post in the _posts folder' do
+      it 'creates a timestamped post in the _posts folder' do
         fn = c.publish(d_path)
         expect(fn).to match(/#{date_regex}-test_draft[.]md$/)
       end
 
-      it 'should remove file in the _drafts folder' do
+      it 'removes file in the _drafts folder' do
         c.publish(d_path)
         expect(File.exist?(d_path)).to be_false
       end
 
-      it 'should create post with matching slug' do
+      it 'creates post with matching slug' do
         post = c.publish(d_path)
         draft_slug = File.basename(d_path, '.md')
         post_slug = post.match(/#{date_regex}-(.*)[.]md/)[1]
         expect(post_slug).to eq(draft_slug)
       end
 
-      it 'should update timestamp in actual file' do
+      it 'updates timestamp in actual file' do
         post = c.publish(d_path)
         content = File.open(post, 'r').read
         expect(content).to match(/date: #{date_regex} \d{2}:\d{2}\n/)
       end
 
-      it 'should copy contents of draft into post' do
+      it 'copies contents of draft into post' do
         # first add some content to the draft
         f = File.open(d_path, 'a')
         f.write("Some new content for my blog\n")
@@ -266,41 +239,41 @@ module MrPoole
     describe "#unpublish" do
       let(:p_path) { c.post({:title => 'test_post'}) }
 
-      it 'should return path to newly created draft' do
+      it 'returns path to newly created draft' do
         returned = c.unpublish(p_path)
         determined = Dir.glob("_drafts/*.md").first
         expect(returned).to eq(determined)
       end
 
-      it 'should create a _drafts directory' do
+      it 'creates a _drafts directory' do
         c.unpublish(p_path)
         expect(File.exists?('_drafts')).to be_true
       end
 
-      it 'should create an untimestamped draft in the _drafts folder' do
+      it 'creates an untimestamped draft in the _drafts folder' do
         fn = c.unpublish(p_path)
         expect(fn).not_to match(/#{date_regex}/)
       end
 
-      it 'should remove file in the _posts folder' do
+      it 'removes file in the _posts folder' do
         c.unpublish(p_path)
         expect(File.exist?(p_path)).to be_false
       end
 
-      it 'should create draft with matching slug' do
+      it 'creates draft with matching slug' do
         draft = c.unpublish(p_path)
         post_slug = p_path.match(/#{date_regex}-(.*)[.]md$/)[1]
         draft_slug = File.basename(draft, '.md')
         expect(draft_slug).to eq(post_slug)
       end
 
-      it 'should delete timestamp in actual file' do
+      it 'deletes timestamp in actual file' do
         draft = c.unpublish(p_path)
         content = File.open(draft, 'r').read
         expect(content).to match(/date:\s*\n/)
       end
 
-      it 'should copy contents of post into draft' do
+      it 'copies contents of post into draft' do
         # first add some content to the draft
         f = File.open(p_path, 'a')
         f.write("Some new content for my blog\n")
@@ -316,47 +289,45 @@ module MrPoole
     context 'with custom extension' do
       let(:commands) { Commands.new('textile') }
 
-      it 'post should use custom extension' do
+      it 'uses custom extension for post' do
         fn = commands.post({:title => 'post title'})
         expect(fn).to match(/textile$/)
       end
 
-      it 'draft should use custom extension' do
+      it 'uses custom extension for draft' do
         fn = commands.draft({:title => 'post title'})
         expect(fn).to match(/textile$/)
       end
 
-      it 'publish should use custom extension' do
+      it 'uses custom extension for publish' do
         draft_path = commands.draft({:title => 'post title'})
         fn = commands.publish(draft_path)
         expect(fn).to match(/textile$/)
       end
 
-      it 'unpublish should use custom extension' do
+      it 'uses custom extension for unpublish' do
         post_path = commands.post({:title => 'post title'})
         fn = commands.unpublish(post_path)
         expect(fn).to match(/textile$/)
       end
-
-    end
+    end   # end context custom extension
 
     context 'with layout override' do
-
-      it "post should inherit layout's file extension" do
+      it "inherit layout's file extension for post" do
         layout_path = write_custom_layout_textile
         fn = c.post({:title => 'post title', :layout => layout_path})
         expect(fn).not_to match(/md/)
         expect(fn).to match(/textile$/)
       end
 
-      it "draft should inherit layout's file extension" do
+      it "inherits layout's file extension for draft" do
         layout_path = write_custom_layout_textile
         fn = c.draft({:title => 'post title', :layout => layout_path})
         expect(fn).not_to match(/md/)
         expect(fn).to match(/textile$/)
       end
 
-      it "publish should inherit draft's extension" do
+      it "inherits draft's extension for pubilsh" do
         layout_path = write_custom_layout_textile
         draft_path = c.draft({:title => 'post title', :layout => layout_path})
         fn = c.publish(draft_path)
@@ -364,14 +335,33 @@ module MrPoole
         expect(fn).to match(/textile$/)
       end
 
-      it "unpublish should inherit post's extension" do
+      it "inherits post's extension for unpublish" do
         layout_path = write_custom_layout_textile
         post_path = c.post({:title => 'post title', :layout => layout_path})
         fn = c.publish(post_path)
         expect(fn).not_to match(/md/)
         expect(fn).to match(/textile$/)
       end
+    end   # end context layout override
+
+    context 'with custom word_separator' do
+      before(:each) { write_config_file_custom_word_sep }
+
+      it "uses hyphens for post" do
+        fn = c.post({:title => "Test Post with Spaces"})
+        expect(fn).to match(/test-post-with-spaces[.]md/)
+      end
+
+      it "uses hyphens for draft" do
+        fn = c.draft({:title => "On (function() {}()) in JavaScript"})
+        expect(fn).to match(/on-function-in-javascript[.]md/)
+      end
+
+      it "is overidden by explicit slug" do
+        fn = c.post({:title => "Test Post", :slug => 'unique_slug'})
+        expect(fn).to match(/unique_slug[.]md$/)
+      end
 
-    end
+    end   # end context custom word separator
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mr_poole
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael McClimon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler