mr_poole 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30428d35eafd9d58388483a2a69f299e7014f89a
-  data.tar.gz: b1f25c5ba6677ddc1568f3d62310a751f0a6b68a
+  metadata.gz: bb4818933c757b8aa91900c8c95dac0d225afd49
+  data.tar.gz: 88de70683c306da09dd89bfe901ce5c08f10e9b8
 SHA512:
-  metadata.gz: 83cbc63e84de3ac30014a48b4ba1d376ea12add90644c3c320d9456737d26931a03050f09b38cbd1b1f642b20da5f654740e2b286d0e0cf24e423c8e4c0b30b1
-  data.tar.gz: 0bc63bef197d7b5d5d5e4f9a8840e9faaf42aab26f0fbdd2b2ff334380d50ac1b6b5b51dd0debdf0c161fcc330606165e2d62d6a7a88634f3a757581ba6a36a0
+  metadata.gz: daa89c474db50ae3deb18407cc2c2fb9ad9709e60456e79bffce23f55e11b607c07a20b7eea9cb62e2c1ad50373a55c5437ed79278cf63d6873af3d3ccce8b1d
+  data.tar.gz: 2fdb742701f6e8a8f947d440e27157889e16927e97580736a283be1697b0cf23bc517eb10b07d74089ae70155416a828f9b82cf7df4def7501d65b312d3d00d6

data/CHANGES.md

@@ -0,0 +1,12 @@
+# Changelog
+
+### v0.2.0 (2013-09-21)
+
+- Hooked into Jekyll's `_config.yml` for customizations
+- Added support for custom layouts
+- Added support for custom file extensions
+- Improvements to tests
+
+### v0.1.0 (2013-09-21)
+
+- Initial release

data/README.md

@@ -20,13 +20,23 @@ publish, and unpublish.
     poole post [OPTIONS] TITLE
 
 Generates a timestamped post in your `_posts` directory, with the format
-`YYYY-MM-DD-slug.md` (other formats to be suppored in the future). With no
-options, will generate a slug based on your title by replacing spaces with
-underscores, downcasing, and removing any special character. With option
-`--slug` (or `-s`), you can provide a custom slug.
+`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.
 
-Poole generates a simple file (in the future, this will be customizable) that
-looks like this:
+Options:
+
+```
+--slug (-s)     Define a custom slug for post, used for generated file name
+
+--title (-t)    Define a title for post. This option may be omitted provided
+                that TITLE is given as the last argument to poole
+
+--layout (-l)   Path to a custom layout file to use
+```
+
+By default, poole generates a simple file that looks like this (but see section
+on configuration for more options).
 
 ```yaml
 ---
@@ -41,8 +51,8 @@ date: (current date automatically inserted here)
     poole draft [OPTIONS] TITLE
 
 Just like `poole post`, except that it creates an untimestamped post in your
-`_drafts` directory (creating it if it doesn't exist yet). Also takes
-`--slug`/`-s` as an option. In the generated file, no date is inserted.
+`_drafts` directory (creating it if it doesn't exist yet). Uses same options
+as `post`. In the generated file, no date is inserted.
 
 ### Publish
 
@@ -65,7 +75,7 @@ The life, universe, and everything.
 
 A call to `poole publish` will generate a file named
 `_posts/yyyy-mm-dd-test_draft.md` and delete the draft. (TODO: add flags for
-no-delete drafts, and no-update timstamp.) Also updates the date filed in the
+no-delete drafts, and no-update timestamp.) Also updates the date filed in the
 header with a date, and HH:MM, producing this file:
 
 ```
@@ -95,13 +105,31 @@ The actual work is done in `MrPoole::Commands`: calls into that class return
 the path name for newly created files, so you can do something useful with
 them if you want to. This should get better in the future.
 
+## Configuration
+
+You may also include directives for `poole` in Jekyll's `_config.yml` file. You
+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
+
+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
+default layout is given above in the "Post" section. The default layout is
+actually just YAML front matter for Jekyll, so it can be used with any
+extension.
+
+Note that command-line options override anything set in your config file. For
+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.
+
 
 ## To do
 
-- Configuration: custom templates, hooking into jekyll's `_config.yml`
-- Support for multiple output formats (right now, only markdown is supported)
-- Better option handling (allow custom templates, more flexible date
-  substitution)
+- Configuration: hooking into jekyll's `_config.yml` (mostly done)
+- Support for multiple output formats (done, but needs better tests)
+- Better option handling (more flexible date substitution)
 - Better documentation (this is an open source project, after all)
 
 ## Installation
@@ -118,7 +146,7 @@ Or install it yourself as:
 
     $ gem install mr_poole
 
-## Contact
+A## Contact
 
 Contact me on Github, at michael@mcclimon.org, or on twitter, @mmcclimon.
 

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
+desc "Run rspec tests with short output"
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = "--color --format doc"
+  t.rspec_opts = "--color"
+end
+
+desc "Run rspec tests with long output"
+RSpec::Core::RakeTask.new(:dspec) do |t|
+  t.rspec_opts = "--color --format documentation"
 end

data/lib/mr_poole/cli.rb

@@ -9,7 +9,10 @@ module MrPoole
       @helper.ensure_jekyll_dir
 
       @params = args
-      @commands = Commands.new
+      @config = Config.new
+
+      ext = @config.default_extension || 'md'
+      @commands = Commands.new(ext)
     end
 
     def execute(action)
@@ -27,7 +30,7 @@ module MrPoole
       options.title ||= @params.first
 
       @helper.post_usage unless options.title
-      @commands.post(options.title, options.slug)
+      @commands.post(options)
     end
 
     def handle_draft
@@ -35,7 +38,7 @@ module MrPoole
       options.title ||= @params.first
 
       @helper.draft_usage unless options.title
-      @commands.draft(options.title, options.slug)
+      @commands.draft(options)
     end
 
     def handle_publish
@@ -66,6 +69,7 @@ module MrPoole
       options = OpenStruct.new
       options.slug = nil
       options.title = nil
+      options.layout = nil
 
       opt_parser = OptionParser.new do |opts|
         opts.on('-s', '--slug [SLUG]', "Use custom slug") do |s|
@@ -75,8 +79,14 @@ module MrPoole
         opts.on('-t', '--title [TITLE]', "Specifiy title") do |t|
           options.title = t
         end
+
+        opts.on('-l', '--layout PATH', "Specify a custom layout file") do |l|
+          options.layout = l
+        end
       end
 
+      options.layout ||= @config.default_layout
+
       opt_parser.parse! @params
       options
     end

data/lib/mr_poole/commands.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'shellwords'
 
 module MrPoole
   class Commands
@@ -7,25 +6,30 @@ module MrPoole
     POSTS_FOLDER = '_posts'
     DRAFTS_FOLDER = '_drafts'
 
-    def initialize
+    def initialize(extension='md')
       @helper = Helper.new
-      @default_layout = @helper.get_default_layout
+      @ext = extension
     end
 
     # Generate a timestamped post
-    def post(title, slug='')
+    def post(opts)
       date = @helper.get_date_stamp
 
       # still want to escape any garbage in the slug
-      slug = title if slug.nil? || slug.empty?
+      slug = if opts[:slug].nil? || opts[:slug].empty?
+               opts[:title]
+             else
+               opts[:slug]
+             end
       slug = @helper.get_slug_for(slug)
 
       # put the metadata into the layout header
-      head = @default_layout
-      head.sub!(/^title:\s*$/, "title: #{title}")
+      head, ext = @helper.get_layout(opts[:layout])
+      head.sub!(/^title:\s*$/, "title: #{opts[:title]}")
       head.sub!(/^date:\s*$/, "date: #{date}")
+      ext ||= @ext
 
-      path = File.join(POSTS_FOLDER, "#{date}-#{slug}.md")
+      path = File.join(POSTS_FOLDER, "#{date}-#{slug}.#{ext}")
       f = File.open(path, "w")
       f.write(head)
       f.close
@@ -34,17 +38,23 @@ module MrPoole
     end
 
     # Generate a non-timestamped draft
-    def draft(title, slug='')
+    def draft(opts)
       # the drafts folder might not exist yet...create it just in case
       FileUtils.mkdir_p(DRAFTS_FOLDER)
 
-      slug = title if slug.nil? || slug.empty?
+      slug = if opts[:slug].nil? || opts[:slug].empty?
+               opts[:title]
+             else
+               opts[:slug]
+             end
       slug = @helper.get_slug_for(slug)
 
-      head = @default_layout
-      head.sub!(/^title:\s*$/, "title: #{title}")
+      # put the metadata into the layout header
+      head, ext = @helper.get_layout(opts[:layout])
+      head.sub!(/^title:\s*$/, "title: #{opts[:title]}")
+      ext ||= @ext
 
-      path = File.join(DRAFTS_FOLDER, "#{slug}.md")
+      path = File.join(DRAFTS_FOLDER, "#{slug}.#{ext}")
       f = File.open(path, "w")
       f.write(head)
       f.close
@@ -54,7 +64,7 @@ module MrPoole
 
     # Todo make this take a path instead?
     def publish(draftpath)
-      slug = File.basename(draftpath, '.md')
+      tail = File.basename(draftpath)
 
       begin
         infile = File.open(draftpath, "r")
@@ -65,7 +75,7 @@ module MrPoole
       date = @helper.get_date_stamp
       time = @helper.get_time_stamp
 
-      outpath = File.join(POSTS_FOLDER, "#{date}-#{slug}.md")
+      outpath = File.join(POSTS_FOLDER, "#{date}-#{tail}")
       outfile = File.open(outpath, "w")
 
       infile.each_line do |line|

data/lib/mr_poole/config.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+require 'ostruct'
+
+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
+      end
+    end
+
+    def empty?
+      @config.to_h.empty?
+    end
+
+    def inspect
+      @config.inspect
+    end
+
+    def method_missing(sym, *args)
+      @config.send(sym)
+    end
+
+  end
+end

data/lib/mr_poole/helper.rb

@@ -15,22 +15,28 @@ module MrPoole
       end
     end
 
-    # Configure the default layout.
-    #
-    # If a user has $HOME/.poole_default_layout, will use the contents of
-    # that file, otherwise will use a simple template
-    def get_default_layout
-      config_path = File.join(Dir.home, '.poole_default_layout')
+    # Get a layout as a string. If layout_path is non-nil,  will open that
+    # file and read it, otherwise will return a default one, and a file
+    # extension to use
+    def get_layout(layout_path)
 
-      if File.exists?(config_path)
-        return File.open(config_path, 'r').read
+      if layout_path.nil?
+        contents  = "---\n"
+        contents << "title:\n"
+        contents << "layout: post\n"
+        contents << "date:\n"
+        contents << "---\n"
+        ext = nil
       else
-        s  = "---\n"
-        s << "title:\n"
-        s << "layout: post\n"
-        s << "date:\n"
-        s << "---\n"
+        begin
+          contents = File.open(layout_path, "r").read()
+          ext = layout_path.match(/\.(.*?)$/)[1]
+        rescue Errno::ENOENT
+          bad_path(layout_path)
+        end
       end
+
+      return contents, ext
     end
 
     # Given a post title (mixed case, spaces, etc.), generates a slug for
@@ -75,6 +81,7 @@ module MrPoole
       puts '  --title   Define a title for post (also available with -t)'
       puts '            This option may be omitted provided that TITLE is given as'
       puts '            the last argument to poole'
+      puts '  --layout  Path to a custom layout file to use (also availabe with -l)'
       exit
     end
 
@@ -88,6 +95,7 @@ module MrPoole
       puts '  --title   Define a title for post (also available with -t)'
       puts '            This option may be omitted provided that TITLE is given as'
       puts '            the last argument to poole'
+      puts '  --layout  Path to a custom layout file to use (also availabe with -l)'
       exit
     end
 

data/lib/mr_poole/version.rb

@@ -1,3 +1,3 @@
 module MrPoole
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/mr_poole.rb

@@ -3,6 +3,7 @@ require 'fileutils'
 require 'mr_poole/commands'
 require 'mr_poole/helper'
 require 'mr_poole/cli'
+require 'mr_poole/config'
 
 module MrPoole
 end