chef-taste 1.0.0 → 1.1.0

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  Excludes:
+    - vendor/**
+    - test/**
+Documentation:
+  Enabled: false
+SignalException:
+  EnforcedStyle: only_raise
+Encoding:
+  Enabled: false
+LineLength:
+  Max: 120
+MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+script:
+  - bundle exec rubocop

data/README.md

@@ -1,5 +1,10 @@
 # Chef::Taste
 
+[![Gem Version](https://badge.fury.io/rb/chef-taste.png)](http://badge.fury.io/rb/chef-taste)
+[![Build Status](https://travis-ci.org/arangamani/chef-taste.png?branch=master)](https://travis-ci.org/arangamani/chef-taste)
+[![Dependency Status](https://gemnasium.com/arangamani/chef-taste.png)](https://gemnasium.com/arangamani/chef-taste)
+[![Code Climate](https://codeclimate.com/github/arangamani/chef-taste.png)](https://codeclimate.com/github/arangamani/chef-taste)
+
 Chef Taste is a simple command line utility to check a cookbook's dependency status.
 It will list the dependent cookbooks in a tabular format with the version information,
 status, and the changelog (if possible) for out-of-date cookbooks.
@@ -40,7 +45,13 @@ finding the tags being used and the latest tag and displaying a compare view tha
 compares these two tags. This URL is then shortened using goo.gl URL shortener to fit the table.
 
 The details are obtained only for cookbooks available in the community site. Other cookbooks are
-displayed but will simply have `N/A` in their details.
+displayed but will simply be empty in the details column.
+
+### Display Format
+
+Two display formats are supported: table and json
+1. The table format will display the dependency status as an ASCII table
+2. The json format will display the dependency status as a JSON object
 
 ### Examples
 
@@ -57,7 +68,7 @@ kannanmanickam@mac fried_rice$ taste
 | ntp        | ~> 1.4.0    | 1.4.0  | 1.5.0  |   ✖    | http://goo.gl/qsfgwA |
 | swap       | = 0.3.5     | 0.3.5  | 0.3.6  |   ✖    | http://goo.gl/vZtUQJ |
 | windows    | >= 0.0.0    | 1.11.0 | 1.11.0 |   ✔    |                      |
-| awesome_cb | >= 0.0.0    | N/A    | N/A    |  N/A   |                      |
+| awesome_cb | >= 0.0.0    |        |        |        |                      |
 +------------+-------------+--------+--------+--------+----------------------+
 Status: out-of-date ( ✖ )
 ```
@@ -65,21 +76,36 @@ Status: out-of-date ( ✖ )
 #### 2. noodles cookbook
 
 ```bash
-kannanmanickam@mac noodles$ taste
-+---------+-------------+--------+--------+--------+----------------------+
-| Name    | Requirement | Used   | Latest | Status | Changelog            |
-+---------+-------------+--------+--------+--------+----------------------+
-| mysql   | ~> 3.0.12   | 3.0.12 | 3.0.12 |   ✔    |                      |
-| apache2 | ~> 1.7.0    | 1.7.0  | 1.8.4  |   ✖    | http://goo.gl/9ejcpi |
-| windows | >= 0.0.0    | 1.11.0 | 1.11.0 |   ✔    |                      |
-+---------+-------------+--------+--------+--------+----------------------+
-Status: out-of-date ( ✖ )
+kannanmanickam@mac noodles$ taste --format json
+{
+  "mysql": {
+    "requirement": "~> 3.0.12",
+    "used": "3.0.12",
+    "latest": "4.0.4",
+    "status": "out-of-date",
+    "changelog": "http://goo.gl/e1nBfW"
+  },
+  "apache2": {
+    "requirement": "~> 1.7.0",
+    "used": "1.7.0",
+    "latest": "1.8.4",
+    "status": "out-of-date",
+    "changelog": "http://goo.gl/9ejcpi"
+  },
+  "windows": {
+    "requirement": ">= 0.0.0",
+    "used": "1.11.0",
+    "latest": "1.11.0",
+    "status": "up-to-date",
+    "changelog": null
+  }
+}
 ```
 
 #### 3. curry cookbook
 
 ```bash
-kannanmanickam@mac curry$ taste
+kannanmanickam@mac curry$ taste --format table
 +-----------------+-------------+-------+--------+--------+-----------+
 | Name            | Requirement | Used  | Latest | Status | Changelog |
 +-----------------+-------------+-------+--------+--------+-----------+

data/bin/taste

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$:.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
 require 'chef/taste'
 
 Chef::Taste::Cli.start

data/chef-taste.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rubocop", "~> 0.14"
   spec.add_development_dependency "rake"
 
   spec.add_dependency "solve", "~> 0.8.0"
@@ -27,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "terminal-table", "~> 1.4.5"
   spec.add_dependency "googl", "~> 0.6.3"
   spec.add_dependency "octokit", "~> 2.5.0"
-  spec.add_dependency "colorize", "~> 0.5.8"
+  spec.add_dependency "colorize", "~> 0.6.0"
 end

data/lib/chef/taste/changelog.rb

@@ -39,9 +39,11 @@ module Chef
         # @return [String] the goo.gl shortened URL for the changelog
         #
         def compute(dep)
+          # The source url is of the form https://HOSTING_PROVIDER/USER/REPO
+          matched = dep.source_url.match(%r(^(https?:\/\/)?(.*?)\/(.*?)\/(.*?)$))
           changelog_url =
-            if dep.source_url =~ /^(https?:\/\/)?github.com\/(.*)\/(.*)$/
-              GithubChangelog.new("#{$2}/#{$3}", dep.version_used, dep.latest).compute
+            if matched[2] == 'github.com'
+              GithubChangelog.new("#{matched[3]}/#{matched[4]}", dep.version_used, dep.latest).compute
             else
               nil
             end
@@ -85,8 +87,8 @@ module Chef
           to_tag = nil
           tags.each do |tag|
             tag_name = tag.name
-            from_tag = tag_name if tag_name =~ /v?#{from_version}/
-            to_tag = tag_name if tag_name =~ /v?#{to_version}/
+            from_tag = tag_name if tag_name =~ /^v?#{from_version}$/
+            to_tag = tag_name if tag_name =~ /^v?#{to_version}$/
           end
           compare_url(from_tag, to_tag) if from_tag && to_tag
         end

data/lib/chef/taste/cli.rb

@@ -33,13 +33,24 @@ module Chef
       # The default task
       default_task :check
 
+      method_option :format, type: :string,
+                             desc: 'The format to use for display',
+                             enum: %w(table json),
+                             default: 'table',
+                             aliases: '-t'
       desc 'check', 'Check status of dependent cookbooks'
       # The check command
       def check
         dependencies = DependencyChecker.check
-        Display.print(dependencies)
+        if dependencies.empty?
+          puts 'No dependent cookbooks'.yellow
+        else
+          Display.print(dependencies, options[:format])
+        end
       rescue NotACookbookError
-        puts "The path is not a cookbook path".red
+        puts 'The path is not a cookbook path'.red
+      rescue UnsupportedDisplayFormatError
+        puts 'The display format is not supported'.red
       end
     end
   end

data/lib/chef/taste/dependency.rb

@@ -61,12 +61,26 @@ module Chef
       def initialize(name, requirement)
         @name = name
         @requirement = requirement
-        @version_used = 'N/A'
-        @latest = 'N/A'
-        @status = 'N/A'
+        @version_used = nil
+        @latest = nil
+        @status = nil
         @source_url = nil
         @changelog = nil
       end
+
+      # Converts the dependency option to a hash
+      #
+      # @return [Hash] the hash representation of the dependency object
+      #
+      def to_hash
+        {}.tap do |hash|
+          hash[:requirement] = requirement
+          hash[:used] = version_used
+          hash[:latest] = latest
+          hash[:status] = status
+          hash[:changelog] = changelog
+        end
+      end
     end
   end
 end

data/lib/chef/taste/dependency_checker.rb

@@ -40,7 +40,7 @@ module Chef
         # @raise NotACookbook the current/given path is not a cookbook
         #
         def check(path = Dir.pwd)
-          raise NotACookbookError, "Path is not a cookbook" unless File.exists?(File.join(path, 'metadata.rb'))
+          raise NotACookbookError, 'Path is not a cookbook' unless File.exists?(File.join(path, 'metadata.rb'))
           ridley = Ridley::Chef::Cookbook::Metadata.from_file(File.join(path, 'metadata.rb'))
           dependencies =
             ridley.dependencies.map do |name, version|
@@ -57,24 +57,35 @@ module Chef
         #
         def populate_fields(dependencies)
           rest = Berkshelf::CommunityREST.new
-          dependencies.each do |dep|
+          dependencies.each do |dependency|
             # Skip cookbooks that are not available in the community site. It might be an external cookbook.
-            #
-            next unless cookbook_exists?(dep.name)
+            next unless cookbook_exists?(dependency.name)
+
+            dependency.latest = rest.latest_version(dependency.name)
 
-            dep.latest = rest.latest_version(dep.name)
             # Obtain the version used based on the version constraint
-            #
-            dep.version_used = rest.satisfy(dep.name, dep.requirement)
-            dep.source_url = rest.get(dep.name).body['external_url']
+            dependency.version_used = rest.satisfy(dependency.name, dependency.requirement)
+            dependency.source_url = rest.get(dependency.name).body['external_url']
+
+            # Calculate the status and changelog based on the version being used and the latest version
+            update_status(dependency)
+          end
+        end
 
-            # Calculate the status based on the version being used and the latest version
-            #
-            if Solve::Version.new(dep.version_used).eql?(Solve::Version.new(dep.latest))
-              dep.status = TICK_MARK
+        # Updates the status of the dependency based on the version used and the latest version available in the
+        # community site. It also obtains the changelog of the dependency is out-of-date
+        #
+        # @param dependency [Dependency] the cookbook dependency
+        #
+        def update_status(dependency)
+          if dependency.version_used && dependency.latest
+            used_version = Solve::Version.new(dependency.version_used)
+            latest_version = Solve::Version.new(dependency.latest)
+            if used_version.eql?(latest_version)
+              dependency.status = 'up-to-date'
             else
-              dep.status = X_MARK
-              dep.changelog = Changelog.compute(dep)
+              dependency.status = 'out-of-date'
+              dependency.changelog = Changelog.compute(dependency)
             end
           end
         end

data/lib/chef/taste/display.rb

@@ -30,51 +30,99 @@ module Chef
     # Displays the status of the dependency cookbooks
     #
     class Display
+      class << self
+        # Prints the status of dependent cookbooks in specified format
+        #
+        # @param dependencies [Array<Dependency>] list of cookbook dependency objects
+        # @param format [String] the format used for display
+        #
+        def print(dependencies, format)
+          case format
+          when 'table'
+            TableDisplay.print(dependencies)
+          when'json'
+            JSONDisplay.print(dependencies)
+          else
+            raise UnsupportedDisplayFormatError, "Display format '#{format}' is not supported"
+          end
+        end
+      end
+    end
+
+    # Displays the cookbook dependency status in a table format
+    #
+    class TableDisplay
       class << self
         # Prints the status of dependent cookbooks as a table
         #
         # @param dependencies [Array<Dependency>] list of cookbook dependency objects
         #
         def print(dependencies)
-          if dependencies.empty?
-            puts "No dependent cookbooks"
-          else
-            rows = []
-            headings = [
-              'Name',
-              'Requirement',
-              'Used',
-              'Latest',
-              'Status',
-              'Changelog'
+          rows = []
+          headings = %w(Name Requirement Used Latest Status Changelog)
+          dependencies.each do |dependency|
+            status_symbol, color = status_to_symbol_and_color(dependency.status)
+            rows << [
+              dependency.name,
+              dependency.requirement,
+              dependency.version_used,
+              dependency.latest,
+              { value: status_symbol.send(color), alignment: :center },
+              dependency.changelog
             ]
-            dependencies.each do |dependency|
-              color =
-                if dependency.status == TICK_MARK
-                  'green'
-                elsif dependency.status == X_MARK
-                  'red'
-                else
-                  'white'
-                end
-              rows << [
-                dependency.name,
-                dependency.requirement,
-                dependency.version_used,
-                dependency.latest,
-                {:value => dependency.status.send(color), :alignment => :center},
-                dependency.changelog
-              ]
-            end
+          end
+
+          # If any of the cookbook is out-of-date
+          table = Terminal::Table.new headings: headings, rows: rows
+          puts table
+          if dependencies.any? { |dep| dep.status == 'out-of-date' }
+            puts "Status: out-of-date ( #{X_MARK} )".red
+          else
+            puts "Status: up-to-date ( #{TICK_MARK} )".green
+          end
+        end
+
+        # Given the status of the cookbook, this method will convert it to the unicode symbol
+        # and color. The up-to-date cookbook will receive a green color TICK mark whereas
+        # the out-of-date cookbook will receive a red color 'X' mark.
+        #
+        # @param status [String] the status of the cookbook
+        #
+        # @return [String, String] status symbol and color
+        #
+        def status_to_symbol_and_color(status)
+          case status
+          when 'up-to-date'
+            return TICK_MARK, 'green'
+          when'out-of-date'
+            return X_MARK, 'red'
+          else
+            return '', 'white'
+          end
+        end
+      end
+    end
+
+    # Displays the cookbook dependency status in JSON format
+    #
+    class JSONDisplay
+      class << self
+        # Prints the status of dependent in JSON
+        #
+        # @param dependencies [Array<Dependency>] list of cookbook dependency objects
+        #
+        def print(dependencies)
+          puts JSON.pretty_generate(dependencies_hash(dependencies))
+        end
 
-            # If any of the cookbook is out-of-date
-            out_of_date = dependencies.any? { |dep| dep.status == X_MARK }
-            table = Terminal::Table.new headings: headings, rows: rows
-            puts table
-            if out_of_date
-              puts "Status: out-of-date ( #{X_MARK} )".red
-            else
-              puts "Status: up-to-date ( #{TICK_MARK} )".green
+        # Converts the dependency objects to JSON object
+        #
+        # @param dependencies [Array<Dependency>] list of cookbook dependency objects
+        #
+        def dependencies_hash(dependencies)
+          {}.tap do |hash|
+            dependencies.each do |dependency|
+              hash[dependency.name] = dependency.to_hash
             end
           end
         end

data/lib/chef/taste/errors.rb

@@ -28,5 +28,9 @@ module Chef
     # The current/given path is not a cookbook
     #
     class NotACookbookError < StandardError; end
+
+    # The given display type is not supported
+    #
+    class UnsupportedDisplayFormatError < ArgumentError; end
   end
 end

data/lib/chef/taste/version.rb

@@ -30,6 +30,6 @@ module Chef
   #
   module Taste
     # The version string
-    VERSION = "1.0.0"
+    VERSION = '1.1.0'
   end
 end

data/test/cookbooks/curry/recipes/default.rb

@@ -3,6 +3,6 @@
 # Recipe:: default
 #
 # Copyright (C) 2013 YOUR_NAME
-# 
+#
 # All rights reserved - Do Not Redistribute
 #

data/test/cookbooks/fried_rice/metadata.rb

@@ -8,5 +8,6 @@ version          '0.1.0'
 
 depends 'ntp', '~> 1.4.0'
 depends 'swap', '= 0.3.5'
+depends 'marker', '~> 0.1.0'
 depends 'windows'
 depends 'awesome_cb'

data/test/cookbooks/fried_rice/recipes/default.rb

@@ -3,6 +3,6 @@
 # Recipe:: default
 #
 # Copyright (C) 2013 YOUR_NAME
-# 
+#
 # All rights reserved - Do Not Redistribute
 #

data/test/cookbooks/noodles/recipes/default.rb

@@ -3,6 +3,6 @@
 # Recipe:: default
 #
 # Copyright (C) 2013 YOUR_NAME
-# 
+#
 # All rights reserved - Do Not Redistribute
 #

data/test/cookbooks/water/metadata.rb

@@ -5,4 +5,3 @@ license          'All rights reserved'
 description      'Installs/Configures water'
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 version          '0.1.0'
-

data/test/cookbooks/water/recipes/default.rb

@@ -3,6 +3,6 @@
 # Recipe:: default
 #
 # Copyright (C) 2013 YOUR_NAME
-# 
+#
 # All rights reserved - Do Not Redistribute
 #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-taste
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +162,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -154,7 +170,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.6.0
 description: This gem checks if updated versions of dependent cookbooks are available
   for the cookbook
 email:
@@ -165,6 +181,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -237,12 +255,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3889125353596550255
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3889125353596550255
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -294,4 +318,3 @@ test_files:
 - test/cookbooks/water/chefignore
 - test/cookbooks/water/metadata.rb
 - test/cookbooks/water/recipes/default.rb
-has_rdoc: