middleman-releases 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4708e9ec139e70cf7e23fb7525e748610806d93f
-  data.tar.gz: 7f0caf4bafede62ebaf8209fe2942d36eb6b231f
+  metadata.gz: 329c68d01efd17938005668a2ceb7795961dc671
+  data.tar.gz: 2a589586cc4e9c6682af4bd0284fe0c1ac72676b
 SHA512:
-  metadata.gz: 7948959551c9c9d1b68ed6456f49ce34def09b992620f5b12de72505dd67ec2e854e6eeeffd0525b5083f69fe10ddaffc7edefcaf7e12b0546519eb790e3acfc
-  data.tar.gz: d950b26abf9a1e94abdfa3a2651565edd17869e5d0deb7ea409e12e3ee78a88e1b4103af82b9b57e39bf37c61f545f8e35e34e7c85ef55400ec8b8cd7b2f8a43
+  metadata.gz: 4801fb20b7707f9204ed3a72fa7e684ea9c7f5b198def70d664db4dc4f2bc2a990c930f130441ccef37e71c263813242ff4f3ffa3854155453f00458c1a76985
+  data.tar.gz: e15546dbaffa81f7bcb1f4e8dc3a85135b0d5ceb6cec0aacecb3f3e171e7499390d8bd8939d238282c1669daee545b734bc8815b14ba09d057834a750151be7e

data/README.md

@@ -23,6 +23,14 @@ In your template file, you can optionally access a release instance using the he
 = current_release.title
 ```
 
+## Generate New Software Release
+This gem includes a CLI command to generate a new software release from a template file.
+
+```shell
+# Sets the date and git tag of the release, opens for editing immediately
+$> bundle exec middleman release v4.0.0 --date "2017-04-01 17:00pm EST" --edit
+```
+
 
 ## Configuration
 Configuration options can be defined in your `config.rb` file.
@@ -30,5 +38,7 @@ Configuration options can be defined in your `config.rb` file.
 ```ruby
 activate :releases do |releases|
   # releases.layout = 'custom_layout'
+  # releases.releases_dir = 'releases'
+  # releases.new_release_template = File.expand_path('../custom_template.tt', __FILE__)
 end
 ```

data/lib/middleman-releases.rb

@@ -3,6 +3,7 @@ require "middleman-core"
 Middleman::Extensions.register :releases do
   require 'releases/instance'
   require 'releases/extension'
+  require 'releases/commands/release'
 
   Releases::Extension
 end

data/lib/releases/commands/release.rb

@@ -0,0 +1,74 @@
+require 'middleman-core/cli'
+require 'date'
+
+module Middleman
+  module Cli
+
+    ##
+    # This class provides an "release" command for the middleman CLI.
+    #
+    # @usage bundle exec middleman release --help
+    # @usage bundle exec middleman release v3.1.4
+    # @usage bundle exec middleman release v3.1.4  --date "2017-03-19 4:00pm EST" --edit
+    #
+    ##
+    class Release < ::Thor::Group
+      include Thor::Actions
+
+      check_unknown_options!
+
+      # Template files are relative to this file
+      # @return [String]
+      def self.source_root
+        File.dirname( __FILE__ )
+      end
+
+      argument :tag, type: :string
+
+      class_option "date",
+      aliases: "-d",
+      desc:    "The date to create the post with (defaults to now)"
+
+      class_option "edit",
+      aliases: "-e",
+      desc:    "Edit the newly created software release",
+      default: false,
+      type:    :boolean
+
+      def release
+        @tag   = tag
+        @date  = options[:date] ? ::Time.zone.parse(options[:date]) : Time.zone.now
+
+        app = ::Middleman::Application.new do
+          config[:mode]              = :config
+          config[:disable_sitemap]   = true
+          config[:watcher_disable]   = true
+          config[:exit_before_ready] = true
+        end
+
+        releases_manager = app.extensions[:releases]
+
+        release_dir_name       = @tag
+        absolute_release_path = File.join( app.source_dir, releases_manager.options.releases_dir, release_dir_name, "index.html.markdown" )
+
+        template releases_manager.options.new_release_template, absolute_release_path
+
+        # Edit option process
+        if options[ :edit ]
+          editor = ENV.fetch('MM_EDITOR', ENV.fetch('EDITOR', nil ))
+
+          if editor
+            system( "#{ editor } #{ absolute_release_path }" )
+          else
+            throw "Could not find a suitable editor. Try setting the environment variable MM_EDITOR."
+          end
+        end
+      end
+
+      protected
+
+      # Add to CLI
+      Base.register(self, 'release', 'release TAG [options]', 'Create a new software release')
+    end
+  end
+end

data/lib/releases/commands/release.tt

@@ -0,0 +1,7 @@
+---
+title: <%= @tag %>
+tag: <%= @tag %>
+date: <%= @date %>
+---
+
+Provide some *markdown* release notes.

data/lib/releases/extension.rb

@@ -2,6 +2,7 @@ module Releases
   class Extension < ::Middleman::Extension
     option :layout, 'release', 'Layout for rendering an individual release'
     option :releases_dir, 'releases', 'Directory containing releases'
+    option :new_release_template, File.expand_path('../commands/release.tt', __FILE__), 'Path (relative to project root) to an ERb template that will be used to generate new software releases from the "middleman release" command.'
 
     expose_to_template :releases, :latest_release
 

data/middleman-releases.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "middleman-releases"
-  s.version     = "0.2.3"
+  s.version     = "0.3.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Matt Millsaps-Brewer"]
   s.email       = ["matt@madebylotus.com"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-releases
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Millsaps-Brewer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -37,6 +37,8 @@ files:
 - Rakefile
 - features/support/env.rb
 - lib/middleman-releases.rb
+- lib/releases/commands/release.rb
+- lib/releases/commands/release.tt
 - lib/releases/extension.rb
 - lib/releases/instance.rb
 - middleman-releases.gemspec