emeril 0.5.0 → 0.5.1

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.5.1 / 2013-05-23
+
+### New features
+
+* Pull request [#1][]: Add ability to bypass publishing to the community site. ([@thbishop][])
+
+
 ## 0.5.0 / 2013-05-20
 
 The initial release, **BAM**!
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#1]: https://github.com/fnichol/emeril/issues/1
+[@thbishop]: https://github.com/thbishop

data/README.md

@@ -1,8 +1,9 @@
 # <a name="title"></a> Emeril: Tag And Release Chef Cookbooks As A Library
 
+[![Gem Version](https://badge.fury.io/rb/emeril.png)](http://badge.fury.io/rb/emeril)
 [![Build Status](https://travis-ci.org/fnichol/emeril.png?branch=master)](https://travis-ci.org/fnichol/emeril)
-[![Dependency Status](https://gemnasium.com/fnichol/emeril.png)](https://gemnasium.com/fnichol/emeril)
 [![Code Climate](https://codeclimate.com/github/fnichol/emeril.png)](https://codeclimate.com/github/fnichol/emeril)
+[![Dependency Status](https://gemnasium.com/fnichol/emeril.png)](https://gemnasium.com/fnichol/emeril)
 
 Kick it up a notch! Emeril is a library that helps you release your Chef
 cookbooks from Rake, Thor, or a Ruby library. If `rake release` is all you
@@ -23,13 +24,20 @@ bundle exec rake release
 
 Need more details? Read on&hellip;
 
+## <a name="screencast"></a> Screencast
+
+Here is a short screencast demonstating how Emeril can be used to release
+a cookbook to the Community Site.
+
+[![Emeril screencast](https://raw.github.com/fnichol/emeril/master/images/emeril-vid.png)](http://vimeo.com/fnichol/emeril)
+
 ## <a name="how-it-works"></a> How It Works
 
 Emeril has 2 primary tasks and goals:
 
 1. Tag a Git commit with a semantic version tag with the form `"v1.2.5"` (by
    default)
-2. Publish a versioned release of the cookbook to the
+2. Optionally publish a versioned release of the cookbook to the
    [Community Site][community_site]
 
 The Git tagging is currently accomplished via shell out, so Git must be
@@ -131,6 +139,17 @@ Emeril::RakeTasks.new do |t|
 end
 ```
 
+If your cookbook is not on the Community Site, you can skip the publishing step
+with the block form:
+
+```ruby
+require 'emeril/rake_tasks'
+
+Emeril::RakeTasks.new do |t|
+  t.config[:publish_to_community] = false
+end
+```
+
 ### <a name="usage-rake"></a> Thor Tasks
 
 To add the default Thor task (`thor emeril:release`), add the following to your
@@ -158,6 +177,17 @@ Emeril::ThorTasks.new do |t|
 end
 ```
 
+If your cookbook is not on the Community Site, you can skip the publishing step
+with the block form:
+
+```ruby
+require 'emeril/thor_tasks'
+
+Emeril::ThorTasks.new do |t|
+  t.config[:publish_to_community] = false
+end
+```
+
 ### <a name="usage-ruby"></a> Ruby Library
 
 The Ruby API is fairly straight forward, but keep in mind that loading or

data/lib/emeril/releaser.rb

@@ -7,8 +7,8 @@ require 'emeril/publisher'
 
 module Emeril
 
-  # Tags a git commit with a version string and pushes the cookbook to the
-  # Community Site.
+  # Tags a git commit with a version string and (optionally) pushes the
+  # cookbook to the Community Site.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   #
@@ -24,6 +24,9 @@ module Emeril
     #   cookbook
     # @option options [GitTagger] git_tagger a git tagger
     # @option options [Publisher] publisher a publisher
+    # @option options [Boolean] publish_to_community a boolean which
+    #   controls if the cookbook will published on the Community Site (the
+    #   default is to publish)
     # @raise [ArgumentError] if any required options are not set
     #
     def initialize(options = {})
@@ -34,13 +37,14 @@ module Emeril
       @category = options.fetch(:category) { default_category }
       @git_tagger = options.fetch(:git_tagger) { default_git_tagger }
       @publisher = options.fetch(:publisher) { default_publisher }
+      @publish_to_community = options.fetch(:publish_to_community) { true }
     end
 
     # Tags and releases a cookbook.
     #
     def run
       git_tagger.run
-      publisher.run
+      publisher.run if publish_to_community
     end
 
     private
@@ -48,7 +52,7 @@ module Emeril
     DEFAULT_CATEGORY = "Other".freeze
 
     attr_reader :logger, :tag_prefix, :source_path, :metadata,
-      :category, :git_tagger, :publisher
+      :category, :git_tagger, :publisher, :publish_to_community
 
     def default_metadata
       metadata_file = File.expand_path(File.join(source_path, "metadata.rb"))

data/lib/emeril/version.rb

@@ -2,5 +2,5 @@
 
 module Emeril
 
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/emeril/releaser_spec.rb

@@ -137,5 +137,22 @@ describe Emeril::Releaser do
 
       releaser.run
     end
+
+    describe 'when disabling community site publishing' do
+      it 'does not call #run on publisher' do
+        releaser = Emeril::Releaser.new(
+          :metadata => metadata,
+          :category => category,
+          :git_tagger => git_tagger,
+          :publisher => publisher,
+          :publish_to_community => false
+        )
+        publisher.unstub(:run)
+        publisher.expects(:run).never
+
+        releaser.run
+      end
+
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emeril
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -253,6 +253,7 @@ files:
 - README.md
 - Rakefile
 - emeril.gemspec
+- images/emeril-vid.png
 - lib/emeril.rb
 - lib/emeril/category.rb
 - lib/emeril/git_tagger.rb
@@ -294,7 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -303951411398259497
+      hash: 2430301425435120469
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24