stove 3.2.6 → 3.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14e6b97b12766451d286f30909803c1c5a7bf56f
-  data.tar.gz: 20fdbce7e94c7bb0e2a53ce63b193751e351c9e1
+  metadata.gz: e408d2205fca9b0b14a446ae29746f36b39b9411
+  data.tar.gz: 4c3f9baa7f8de64aa63b484264db3aed57cdf7b4
 SHA512:
-  metadata.gz: 05df808d14a6d6b31bc1b1898963b20a88174e3ec09bb7315607ee17eeeb1329688c0aa81d39378859e2b6e015340a0fc22ea9f5f55a9745277b082de28183d7
-  data.tar.gz: 16765a9d38f934e7f8d97f80c097d1ae9d85b5c0c506e9f4eccf262e394c7ba138955739581efa875a56165e881c0d84b602fb8627dade640f2237f40ddb3a2e
+  metadata.gz: 108c86f18357afa93cdcb735f8dbc2a8fa688a4d2fe44aff21132469862e667b424eb4a7586b89d22d47602853d52b9ebbf616743e4e116df0e75ce8a58a3a3b
+  data.tar.gz: db000dddde6faf57a6073c23d3322c6c800565bbab6a60ac4166c13b56453fb95a708096f50992a34734b66e3a11be3a355ce4da2878a8ecd51413c54d0981c9

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .rspec
+vendor/

data/.travis.yml

@@ -2,6 +2,11 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2
+
+branches:
+  only:
+    - master
 
 bundler_args: --jobs 7
 

data/CHANGELOG.md

@@ -2,6 +2,16 @@ Stove CHANGELOG
 ===============
 This is the Changelog for the Stove gem.
 
+v3.2.7 (2015-04-16)
+-------------------
+- Use chef.io instead of getchef.com
+- Ignore `vendor/` directory
+- Do not publish extended metadata fields like `issues_url` and `source_url` by
+  default (GH-64, GH-72). These fields can be optionally added using the
+  new `--extended-metadata` flag.
+- Add support for Ruby 2.2
+- Use binmode when reading and writing the tgz (GH-64)
+
 v3.2.6 (2015-03-18)
 -------------------
 - Include new metadata methods for Supermarket

data/README.md

@@ -38,18 +38,24 @@ $ stove login --username sethvargo --key ~/.chef/sethvargo.pem
 
 These values will be saved in Stove's configuration file (`~/.stove`) and persisted across your workstation.
 
-The default publishing endpoint is the [Chef Supermarket](https://supermarket.getchef.com), but this is configurable. If you want to publish to an internal community site, you can specify the `--endpoint` value:
+The default publishing endpoint is the [Chef Supermarket](https://supermarket.chef.io), but this is configurable. If you want to publish to an internal community site, you can specify the `--endpoint` value:
 
 ```bash
 $ stove --endpoint https://internal-cookbook-store.example.com
 ```
 
-or for a private supermarket using the [supermarket](https://supermarket.getchef.com/cookbooks/supermarket) cookbook:
+or for a private supermarket using the [supermarket](https://supermarket.chef.io/cookbooks/supermarket) cookbook:
 
 ```bash
 $ stove --endpoint https://internal-cookbook-store.example.com/api/v1
 ```
 
+Please note: depending on which version of Chef and which version of Supermarket you are running, you may support the new "extended" metadata fields. By default, Stove reads but does not write these new fields when uploading cookbooks because it is not backwards compatible. If you are running Chef 12+ and have the latest version of Supermarket installed, you can specify the `--extended-metadata` flag to include these values in the generated metadata:
+
+```bash
+$ stove --extended-metadata
+```
+
 Usage
 -----
 There are two ways to use Stove. You can either use the `stove` command directly or use the embedded rake task.

data/lib/stove/cli.rb

@@ -116,6 +116,10 @@ module Stove
           options[:key] = v
         end
 
+        opts.on('--extended-metadata', 'Include non-backwards compatible metadata keys such as `issues_url`') do
+          options[:extended_metadata] = true
+        end
+
         opts.separator ''
         opts.separator 'Git Options:'
 
@@ -161,9 +165,10 @@ module Stove
     def options
       @options ||= {
         # Upload options
-        :endpoint => nil,
-        :username => Config.username,
-        :key      => Config.key,
+        :endpoint          => nil,
+        :username          => Config.username,
+        :key               => Config.key,
+        :extended_metadata => false,
 
         # Git options
         :remote => 'origin',

data/lib/stove/community.rb

@@ -10,7 +10,7 @@ module Stove
     #
     # @return [String]
     #
-    DEFAULT_ENDPOINT = 'https://supermarket.getchef.com/api/v1'
+    DEFAULT_ENDPOINT = 'https://supermarket.chef.io/api/v1'
 
     #
     # Get and cache a community cookbook's JSON response from the given name
@@ -50,15 +50,15 @@ module Stove
     # @param [Cookbook] cookbook
     #   the cookbook to upload
     #
-    def upload(cookbook)
+    def upload(cookbook, extended_metadata = false)
       connection.post('cookbooks', {
-        'tarball'  => cookbook.tarball,
+        'tarball'  => cookbook.tarball(extended_metadata),
 
         # This is for legacy, backwards-compatability reasons. The new
         # Supermarket site does not require a category, but many of the testing
         # tools still assume a cookbook category is present. We just hardcode
         # "Other" here.
-        'cookbook' => { 'category' => 'Other' }.to_json,
+        'cookbook' => JSON.fast_generate(category: 'Other'),
       })
     end
 

data/lib/stove/cookbook.rb

@@ -94,8 +94,8 @@ module Stove
     #
     # @return [File]
     #
-    def tarball
-      @tarball ||= Packager.new(self).tarball
+    def tarball(extended_metadata = false)
+      @tarball ||= Packager.new(self, extended_metadata).tarball
     end
 
     private

data/lib/stove/cookbook/metadata.rb

@@ -72,6 +72,9 @@ module Stove
       def_attribute :description
       def_attribute :long_description
 
+      # These attributes are available for reading, but are not written by
+      # default. In order to maintain backwards and forwards compatability,
+      # these attributes are here.
       def_attribute :source_url
       def_attribute :issues_url
 
@@ -158,14 +161,12 @@ module Stove
         end
       end
 
-      def to_hash
-        {
+      def to_hash(extended_metadata = false)
+        hash = {
           'name'             => self.name,
           'version'          => self.version,
           'description'      => self.description,
           'long_description' => self.long_description,
-          'source_url'       => self.source_url,
-          'issues_url'       => self.issues_url,
           'maintainer'       => self.maintainer,
           'maintainer_email' => self.maintainer_email,
           'license'          => self.license,
@@ -180,10 +181,13 @@ module Stove
           'groupings'        => self.groupings,
           'recipes'          => self.recipes,
         }
-      end
 
-      def to_json(*args)
-        JSON.pretty_generate(self.to_hash)
+        if extended_metadata
+          hash['source_url'] = self.source_url
+          hash['issues_url'] = self.issues_url
+        end
+
+        return hash
       end
 
       private

data/lib/stove/packager.rb

@@ -33,12 +33,20 @@ module Stove
     # @erturn [Stove::Cookbook]
     attr_reader :cookbook
 
+    # Whether to include the new extended metadata attributes.
+    #
+    # @return [true, false]
+    attr_reader :extended_metadata
+
     # Create a new packager instance.
     #
     # @param [Stove::Cookbook]
     #   the cookbook to package
-    def initialize(cookbook)
+    # @param [true, false] extended_metadata
+    #   include new extended metadata attributes
+    def initialize(cookbook, extended_metadata = false)
       @cookbook = cookbook
+      @extended_metadata = extended_metadata
     end
 
     # A map from physical file path to tarball file path
@@ -70,14 +78,14 @@ module Stove
     def tarball
       # Generate the metadata.json on the fly
       metadata_json = File.join(cookbook.path, 'metadata.json')
-      File.open(metadata_json, 'wb') do |file|
-        file.write(cookbook.metadata.to_json)
-      end
+      json = JSON.fast_generate(cookbook.metadata.to_hash(extended_metadata))
+      File.open(metadata_json, 'wb') { |f| f.write(json) }
 
       io  = tar(File.dirname(cookbook.path), packaging_slip)
       tgz = gzip(io)
 
-      tempfile = Tempfile.new([cookbook.name, '.tar.gz'], Dir.tmpdir, mode: File::RDWR|File::CREAT|File::EXCL|File::BINARY)
+      tempfile = Tempfile.new([cookbook.name, '.tar.gz'], Dir.tmpdir)
+      tempfile.binmode
 
       while buffer = tgz.read(1024)
         tempfile.write(buffer)

data/lib/stove/plugins/community.rb

@@ -12,7 +12,7 @@ module Stove
     end
 
     run('Publishing the release to the Chef community site') do
-      Community.upload(cookbook)
+      Community.upload(cookbook, options[:extended_metadata])
     end
   end
 end

data/lib/stove/version.rb

@@ -1,3 +1,3 @@
 module Stove
-  VERSION = '3.2.6'
+  VERSION = '3.2.7'
 end

data/spec/support/generators.rb

@@ -38,7 +38,7 @@ module Stove
         end
         File.open(root.join('Berksfile'), 'wb') do |f|
           f.write <<-EOH.gsub(/^ {11}/, '')
-            source 'https://supermarket.getchef.com'
+            source 'https://supermarket.chef.io'
             metadata
           EOH
         end

data/spec/unit/cookbook/metadata_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class Stove::Cookbook
+  describe Metadata do
+    describe '#to_hash' do
+      context 'when the extra metadata is not included' do
+        it 'does not include the new metadata fields' do
+          hash = subject.to_hash(false)
+          expect(hash).to_not include('issues_url')
+          expect(hash).to_not include('source_url')
+        end
+      end
+
+      context 'when the extra metadata is included' do
+        it 'includes the new metadata fields' do
+          hash = subject.to_hash(true)
+          expect(hash).to include('issues_url')
+          expect(hash).to include('source_url')
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stove
 version: !ruby/object:Gem::Version
-  version: 3.2.6
+  version: 3.2.7
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-api
@@ -161,6 +161,7 @@ files:
 - spec/integration/cookbook_spec.rb
 - spec/spec_helper.rb
 - spec/support/generators.rb
+- spec/unit/cookbook/metadata_spec.rb
 - spec/unit/error_spec.rb
 - stove.gemspec
 - templates/errors/abstract_method.erb
@@ -193,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A command-line utility for releasing Chef community cookbooks
@@ -211,5 +212,5 @@ test_files:
 - spec/integration/cookbook_spec.rb
 - spec/spec_helper.rb
 - spec/support/generators.rb
+- spec/unit/cookbook/metadata_spec.rb
 - spec/unit/error_spec.rb
-has_rdoc: