mr_poole 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eec4c40ee2d85be9a8dc6646397716f639dc7251
-  data.tar.gz: 5d5d5d3da895a594bed5bc5b315406f419b3a332
+  metadata.gz: db31487041b5c6ed8e580f7d8a8b003bb65c775a
+  data.tar.gz: 9999f65961a392b2b3121ccb0edff2c87d69d06a
 SHA512:
-  metadata.gz: 79d2435f0d2c597b47fa137c0d02756c733c6003f67f065525605a7ebbb4c8d5e899fa35ed8fc7fb13b2240b83d1741e99d6fc7f3ce4e11478ceb2221adf6632
-  data.tar.gz: a92a2c785b51e9a013c9e51cb9301deb31c7e9232db59775d82d0e42402af83eac9a023f731b6833f4ad4a6415b0a1bbcc157483ec8426a7c2ef0d9bab728b80
+  metadata.gz: f5f0071a2daf4825b72f3eecc81cf54afcc1d032fcaf6ba07f4a29bacbad69ea4d2c4ec1aebc62fd72ceb817b94a3d593ee9349463d789401a77e2cbbb850cdb
+  data.tar.gz: 83515d8083a1734d9a50c5c7a097acc12a7ab5e1f0b2e0a681eee3b809cfea58fd73467479139f7805578758f09a0a4fdee669f0d6c383aef968d0e6bffd7b1c

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v0.5.0 (2014-01-31)
+
+- Add word_separator configuration option (to use hyphens). Thanks to [Harry
+  Schwartz](http://github.com/hrs) for the inspiration!
+
 ### v0.4.3 (2014-01-28)
 
 - Make echoed paths reflect custom source directory. Now you can `poole post

data/README.md

@@ -30,7 +30,7 @@ immediately.
 Generates a timestamped post in your `_posts` directory, with the format
 `YYYY-MM-DD-slug.md`. With no options, will generate a slug based on your title
 by replacing spaces with underscores, downcasing, and removing any special
-character.
+character (see configuration section if you don't like the underscores).
 
 Options:
 
@@ -127,6 +127,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
 
 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
@@ -139,6 +140,17 @@ example, if you have your default extension set to `textile`, but then pass the
 `--layout` flag to post/draft with a Markdown template, the generated post will
 use the Markdown extension.
 
+*Important!* If you want to use hyphens for the `word_separator` option, you'll
+need to escape it (because a single dash is the beginning a YAML bulleted
+list). If you don't, the YAML parser will choke (I don't have any control over
+this).
+
+```
+poole:
+  word_separator: "-"   # correct
+  word_separator: -     # WRONG...don't do this!
+```
+
 
 ## To do
 

data/lib/mr_poole/cli.rb

@@ -9,7 +9,7 @@ module MrPoole
       @src_dir = @helper.ensure_jekyll_dir
 
       @params = args
-      @config = Config.new
+      @config = @helper.config
 
       ext = @config.default_extension || 'md'
       @commands = Commands.new(ext)

data/lib/mr_poole/config.rb

@@ -5,11 +5,17 @@ module MrPoole
   class Config
 
     def initialize
-      if File.exists?('_config.yml')
-        yaml = YAML.load(File.read('_config.yml'))
-        @config = OpenStruct.new(yaml["poole"])
-      else
-        @config = OpenStruct.new
+      begin
+        if File.exists?('_config.yml')
+          yaml = YAML.load(File.read('_config.yml'))
+          @config = OpenStruct.new(yaml["poole"])
+          @config.srcdir = yaml['source'] if yaml['source']
+        else
+          @config = OpenStruct.new
+        end
+      rescue Psych::SyntaxError
+        bad_yaml_message
+        exit
       end
     end
 
@@ -25,5 +31,11 @@ module MrPoole
       @config.send(sym)
     end
 
+    private
+
+    def bad_yaml_message
+      puts 'Error reading YAML file _config.yml!'
+      puts '  (Did you forget to escape a hyphen?)'
+    end
   end
 end

data/lib/mr_poole/helper.rb

@@ -4,8 +4,10 @@ require 'pathname'
 module MrPoole
   class Helper
 
+    attr_accessor :config
+
     def initialize
-      # nothing to do here
+      @config = Config.new
     end
 
     # Check for a _posts directory in current directory. If there's not one,
@@ -70,7 +72,8 @@ module MrPoole
     # Given a post title (mixed case, spaces, etc.), generates a slug for
     # This clobbers any non-ASCII text (TODO don't do that)
     def get_slug_for(title)
-      title.downcase.gsub(/[^a-z0-9_\s-]/, '').gsub(/\s+/, '_')
+      word_sep = @config.word_separator || '_'
+      title.downcase.gsub(/[^a-z0-9_\s-]/, '').gsub(/\s+/, word_sep)
     end
 
     def get_date_stamp
@@ -159,13 +162,7 @@ module MrPoole
     # If a user has a custom 'source' defined in their _config.yml, change
     # to that directory for everything else
     def check_custom_src_dir!
-      srcdir = nil
-
-      if File.exists?('_config.yml')
-        yaml = YAML.load(File.read('_config.yml'))
-        srcdir = yaml['source']
-      end
-
+      srcdir = @config.srcdir
       Dir.chdir(srcdir) if srcdir
     end
 

data/lib/mr_poole/version.rb

@@ -1,3 +1,3 @@
 module MrPoole
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/spec/command_spec.rb

@@ -190,6 +190,33 @@ module MrPoole
           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

data/spec/config_spec.rb

@@ -17,6 +17,13 @@ def write_config_file_no_poole
   f.close
 end
 
+def write_config_file_bad_yaml
+  c = File.open('_config.yml', 'w')
+  c.puts 'poole:'
+  c.puts '  word_separator: -'
+  c.close
+end
+
 module MrPoole
   describe Config do
     before(:each) { @olddir, @tmpdir = make_jekyll_dir }
@@ -39,6 +46,19 @@ module MrPoole
         config = Config.new
         expect(config).not_to be_empty
       end
+
+      it "exits with on bad YAML" do
+        write_config_file_bad_yaml
+        expect {
+          capture_stdout { cli = CLI.new([]) }
+        }.to raise_error(SystemExit)
+      end
+
+      it "prints a reasonable error message on bad YAML" do
+        write_config_file_bad_yaml
+        msg = aborted_poole_output(['post', 'title']).call
+        expect(msg).to match(/error.*yaml/i)
+      end
     end
 
     describe '#inspect' do

data/spec/spec_helper.rb

@@ -150,6 +150,12 @@ def write_config_file_custom_layout
   filename
 end
 
+def write_config_file_custom_src_dir
+  c = File.open('_config.yml', 'w')
+  c.puts 'source: src'
+  c.close
+end
+
 def write_config_file_custom_extension
   c = File.open('_config.yml', 'w')
   c.puts 'poole:'
@@ -157,8 +163,9 @@ def write_config_file_custom_extension
   c.close
 end
 
-def write_config_file_custom_src_dir
+def write_config_file_custom_word_sep
   c = File.open('_config.yml', 'w')
-  c.puts 'source: src'
+  c.puts 'poole:'
+  c.puts '  word_separator: "-"'
   c.close
 end

metadata

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