knife-changelog 0.1.1.pre.alpha.pre.23 → 0.2.0.pre.alpha.pre.25

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2RmNzcwYWViYWY1MWMwYjM4MzllNjdlYTU5ODhhZWI0ZThhNWJjZg==
+    ZmRkMTY4NGNiN2Y2NTE2YTUyN2RlZjg4MDBiMmUyYmQyNzZlYThjNg==
   data.tar.gz: !binary |-
-    ZDgyMWM2N2RhNWZmZWFmYjlmZDliM2VhZjIyMzNlYmNmMDZjY2U0OA==
+    NmM0YWZlM2MwZWZhZTdiMWVlNWZiYmU1MTc0ZmM0YmUyNTE3M2JhMw==
 SHA512:
   metadata.gz: !binary |-
-    OTY4NzI4NmNhNjkzZjJiMjI5MmJhYjRjZDJmNjEwMTUxZGFlNzc0OTlhNTUw
-    MzJiNjgwZjQxM2JhZTFhYzc0OTJiYmIxZGVhM2E5ZmUzZDQ1MWQzMGFmODJk
-    NjczMTJlOGE2MDg0M2I3NjE2Y2RkMGM5OGZhZGQ5MzVkNDkzZjI=
+    ZWZhMDQ2MGMyNGVmOTQ0MjNkNzdjY2NiM2Y4MTA3NWRjOTlkNGY5OWM3NTZm
+    NGM0MzI1Mzg2NjhhYzMwZjgzYmIzYmJkODU5MTYxNDZiOWYxZjJlNjNmNThk
+    NmVmNmNmM2Q0NDU3ODZmNWM4ZjIwYzgwZjgxOTliMDY1Zjk3ZGU=
   data.tar.gz: !binary |-
-    ZmFjOTI0NGIzZmEyMmY2NTNlNjYzYTYxZTQzMDI1MmIwMGYzNmZmMTM3YTc3
-    YjAwOGRhNTBjYTYzZTkxNTI5MDhiNmZhOTRmMDhhNjNhOGUzZjYyMjBlNDA1
-    ZDhkNWFhMTM1MGQ3ZTNmZGYxNjllNWQ5ZjRiNDJhNDJjYjczYjQ=
+    N2E0NWIzZWJmYzQ4NmE1NmQwOTAyMjBjZTdlMTg3YjllMTQ5MjI5ZGU1Y2Zm
+    MTU2NzEyOWZmZTBjNmMyMjBjYzNlZjBjMjIwMTM3NjM4NmM1MmUyZmE5N2I5
+    ZmI3ZjJkMmQ1OGQ2MGJlNWE5MDJhNjRmYjJjMGFlZGZiMzNhOGM=

data/knife-changelog.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
 
 
   spec.add_dependency  'berkshelf'
+  spec.add_dependency  'rest-client'
   spec.add_dependency  'mixlib-shellout'
   spec.add_dependency  'chef',  '~> 11.16'
 end

data/lib/chef/knife/changelog.rb

@@ -1,4 +1,5 @@
 require "knife/changelog/version"
+require "knife/changelog/changelog"
 require "berkshelf"
 require 'chef/knife'
 require 'mixlib/shellout'
@@ -11,9 +12,8 @@ class Chef
 
       def initialize(options)
         super
-        @tmp_prefix = 'knife-changelog'
-        @berksfile = Berkshelf::Berksfile.from_options({})
-        @tmp_dirs = []
+        berksfile = Berkshelf::Berksfile.from_options({})
+        @changelog = KnifeChangelog::Changelog.new(berksfile, config)
       end
 
       option :linkify,
@@ -39,185 +39,10 @@ class Chef
 
 
       def run
-        begin
-          Log.info config
-          if @name_args.empty?
-            cks = @berksfile.cookbooks.collect {|c| c.cookbook_name }
-          else
-            cks = @name_args
-          end
-          cks.each do |cookbook|
-            Log.debug "Checking changelog for #{cookbook} (cookbook)"
-            execute cookbook
-          end
-          (config[:submodules] || '').split(',').each do |submodule|
-            Log.debug "Checking changelog for #{submodule} (submodule)"
-            execute(submodule, true)
-          end
-        ensure
-          clean
-        end
+        Log.info config
+        @changelog.run(@name_args)
       end
-
-      def clean
-        @tmp_dirs.each do |dir|
-          FileUtils.rm_r dir
-        end
-      end
-
-      def ck_dep(name)
-        @berksfile.lockfile.find(name)
-      end
-
-      def ck_location(name)
-       ck_dep(name).location
-      end
-
-      def version_for(name)
-        # FIXME uses public methods instead
-        @berksfile.lockfile.graph.instance_variable_get(:@graph)[name].version
-      end
-
-      def execute(name, submodule=false)
-        changelog = if submodule
-                      handle_submodule(name)
-                    else
-                      loc = ck_location(name)
-                      case loc
-                      when NilClass
-                        handle_source name, ck_dep(name)
-                      when Berkshelf::GitLocation
-                        handle_git loc
-                      when Berkshelf::PathLocation
-                        Log.debug "path location are always at the last version"
-                        ""
-                      else
-                        raise "Cannot handle #{loc.class} yet"
-                      end
-                    end
-        print_changelog(name, changelog)
-      end
-
-      def print_changelog(name, changelog)
-        unless changelog.empty?
-          puts "###  Changelog for #{name}"
-          puts changelog
-          puts "\n\n"
-        end
-      end
-
-      def handle_source(name, dep)
-        ck = noauth_rest.get_rest("https://supermarket.getchef.com/api/v1/cookbooks/#{name}")
-        url = ck['source_url'] || ck ['external_url']
-        Chef::Log.debug("Using #{url} as source url")
-        case url.strip
-        when nil,""
-          Log.warn "No external url for #{name}, can't find any changelog source"
-          ""
-        when /github.com\/(.*)(.git)?/
-          url = "https://github.com/#{$1.chomp('/')}.git"
-          options = {
-            :git => url,
-            :revision => version_for(name),
-          }
-          location = Berkshelf::GitLocation.new dep, options
-          handle_git(location)
-        else
-          fail "External url #{url} points to unusable location!"
-        end
-      end
-
-      def revision_exists?(dir, revision)
-        Log.debug "Testing existence of #{revision}"
-        revlist = Mixlib::ShellOut.new("git rev-list --quiet #{revision}", :cwd => dir)
-        revlist.run_command
-        not revlist.error?
-      end
-
-      def detect_cur_revision(dir, rev)
-        unless revision_exists?(dir, rev)
-          prefixed_rev = 'v' + rev
-          return prefixed_rev if revision_exists?(dir, prefixed_rev)
-          fail "#{rev} is not a valid revision"
-        end
-        rev
-      end
-
-      def handle_submodule(name)
-        subm_url = Mixlib::ShellOut.new("git config --list| grep ^submodule | grep ^submodule.#{name}.url")
-        subm_url.run_command
-        subm_url.error!
-        url = subm_url.stdout.lines.first.split('=')[1].chomp
-        subm_revision = Mixlib::ShellOut.new("git submodule status #{name}")
-        subm_revision.run_command
-        subm_revision.error!
-        revision = subm_revision.stdout.strip.split(' ').first
-        loc = Berkshelf::Location.init(nil, {git: url,revision: revision})
-        handle_git(loc)
-      end
-
-      def handle_git(location)
-        tmp_dir = shallow_clone(@tmp_prefix,location.uri)
-
-        rev_parse = location.instance_variable_get(:@rev_parse)
-        cur_rev = location.revision.rstrip
-        cur_rev = detect_cur_revision(tmp_dir, cur_rev)
-        ls_tree = Mixlib::ShellOut.new("git ls-tree -r #{rev_parse}", :cwd => tmp_dir)
-        ls_tree.run_command
-        changelog = ls_tree.stdout.lines.find { |line| line =~ /\s(changelog.*$)/i }
-        if changelog and not config[:ignore_changelog_file]
-          Log.info "Found changelog file : " + $1
-          generate_from_changelog_file($1, cur_rev, rev_parse, tmp_dir)
-        else
-          generate_from_git_history(tmp_dir, location, cur_rev, rev_parse)
-        end
-      end
-
-      def generate_from_changelog_file(filename, current_rev, rev_parse, tmp_dir)
-        diff = Mixlib::ShellOut.new("git diff #{current_rev}..#{rev_parse} -- #{filename}", :cwd => tmp_dir)
-        diff.run_command
-        diff.stdout.lines.collect {|line| $1 if line =~ /^\+([^+].*)/}.compact
-      end
-
-      def generate_from_git_history(tmp_dir, location, current_rev, rev_parse)
-        log = Mixlib::ShellOut.new("git log --no-merges --abbrev-commit --pretty=oneline #{current_rev}..#{rev_parse}", :cwd => tmp_dir)
-        log.run_command
-        c = log.stdout.lines
-        n = https_url(location)
-        c = linkify(n, c) if config[:linkify] and n
-        c = c.map { |line| "* " + line } if config[:markdown]
-        c
-      end
-
-      def linkify(url, changelog)
-        changelog.map do |line|
-          line.gsub(/^([a-f0-9]+) /, '[\1](%s/commit/\1) ' % [url.chomp('.git')])
-        end
-      end
-
-      def https_url(location)
-        if location.uri =~ /^\w+:\/\/(.*@)?(.*)(\.git?)/
-          "https://%s" % [ $2 ]
-        else
-          fail "Cannot guess http url from git remote url"
-        end
-      end
-
-      def short(location)
-        if location.uri =~ /([\w-]+)\/([\w-]+)(\.git)?$/
-          "%s/%s" % [$1,$2]
-        end
-      end
-
-      def shallow_clone(tmp_prefix, uri)
-        dir = Dir.mktmpdir(tmp_prefix)
-        @tmp_dirs << dir
-        clone = Mixlib::ShellOut.new("git clone --bare #{uri} bare-clone", :cwd => dir)
-        clone.run_command
-        clone.error!
-        ::File.join(dir, 'bare-clone')
-      end
-
     end
+
   end
 end

data/lib/knife/changelog/changelog.rb

@@ -0,0 +1,195 @@
+require 'chef/log'
+require 'chef/knife'
+require 'rest-client'
+require 'json'
+
+class KnifeChangelog
+  class Changelog
+    def initialize(berksfile, config = {})
+      @tmp_prefix = 'knife-changelog'
+      @berksfile = berksfile
+      @config   = config
+      @tmp_dirs = []
+    end
+
+    def run(cookbooks)
+      begin
+        if cookbooks.empty?
+          cks = @berksfile.cookbooks.collect {|c| c.cookbook_name }
+        else
+          cks = cookbooks
+        end
+        cks.each do |cookbook|
+          Chef::Log.debug "Checking changelog for #{cookbook} (cookbook)"
+          execute cookbook
+        end
+        (@config[:submodules] || '').split(',').each do |submodule|
+          Chef::Log.debug "Checking changelog for #{submodule} (submodule)"
+          execute(submodule, true)
+        end
+      ensure
+        clean
+      end
+    end
+
+    def clean
+      @tmp_dirs.each do |dir|
+        FileUtils.rm_r dir
+      end
+    end
+
+    def ck_dep(name)
+      @berksfile.lockfile.locks[name]
+    end
+
+    def ck_location(name)
+      ck_dep(name).location
+    end
+
+    def version_for(name)
+      # FIXME uses public methods instead
+      @berksfile.lockfile.graph.instance_variable_get(:@graph)[name].version
+    end
+
+    def execute(name, submodule=false)
+      changelog = if submodule
+                    handle_submodule(name)
+                  else
+                    loc = ck_location(name)
+                    case loc
+                    when NilClass
+                      handle_source name, ck_dep(name)
+                    when Berkshelf::GitLocation
+                      handle_git loc
+                    when Berkshelf::PathLocation
+                      Chef::Log.debug "path location are always at the last version"
+                      ""
+                    else
+                      raise "Cannot handle #{loc.class} yet"
+                    end
+                  end
+      print_changelog(name, changelog)
+    end
+
+    def print_changelog(name, changelog)
+      unless changelog.empty?
+        puts "###  Changelog for #{name}"
+        puts changelog
+        puts "\n\n"
+      end
+    end
+
+    def handle_source(name, dep)
+      ck = JSON.parse(RestClient.get "https://supermarket.getchef.com/api/v1/cookbooks/#{name}")
+      url = ck['source_url'] || ck ['external_url']
+      Chef::Log.debug("Using #{url} as source url")
+      case url.strip
+      when nil,""
+        Chef::Log.warn "No external url for #{name}, can't find any changelog source"
+        ""
+      when /github.com\/(.*)(.git)?/
+        url = "https://github.com/#{$1.chomp('/')}.git"
+        options = {
+          :git => url,
+          :revision => version_for(name),
+        }
+        location = Berkshelf::GitLocation.new dep, options
+        handle_git(location)
+      else
+        fail "External url #{url} points to unusable location!"
+      end
+    end
+
+    def revision_exists?(dir, revision)
+      Chef::Log.debug "Testing existence of #{revision}"
+      revlist = Mixlib::ShellOut.new("git rev-list --quiet #{revision}", :cwd => dir)
+      revlist.run_command
+      not revlist.error?
+    end
+
+    def detect_cur_revision(dir, rev)
+      unless revision_exists?(dir, rev)
+        prefixed_rev = 'v' + rev
+        return prefixed_rev if revision_exists?(dir, prefixed_rev)
+        fail "#{rev} is not a valid revision"
+      end
+      rev
+    end
+
+    def handle_submodule(name)
+      subm_url = Mixlib::ShellOut.new("git config --list| grep ^submodule | grep ^submodule.#{name}.url")
+      subm_url.run_command
+      subm_url.error!
+      url = subm_url.stdout.lines.first.split('=')[1].chomp
+      subm_revision = Mixlib::ShellOut.new("git submodule status #{name}")
+      subm_revision.run_command
+      subm_revision.error!
+      revision = subm_revision.stdout.strip.split(' ').first
+      loc = Berkshelf::Location.init(nil, {git: url,revision: revision})
+      handle_git(loc)
+    end
+
+    def handle_git(location)
+      tmp_dir = shallow_clone(@tmp_prefix,location.uri)
+
+      rev_parse = location.instance_variable_get(:@rev_parse)
+      cur_rev = location.revision.rstrip
+      cur_rev = detect_cur_revision(tmp_dir, cur_rev)
+      ls_tree = Mixlib::ShellOut.new("git ls-tree -r #{rev_parse}", :cwd => tmp_dir)
+      ls_tree.run_command
+      changelog = ls_tree.stdout.lines.find { |line| line =~ /\s(changelog.*$)/i }
+      if changelog and not @config[:ignore_changelog_file]
+        Chef::Log.info "Found changelog file : " + $1
+        generate_from_changelog_file($1, cur_rev, rev_parse, tmp_dir)
+      else
+        generate_from_git_history(tmp_dir, location, cur_rev, rev_parse)
+      end
+    end
+
+    def generate_from_changelog_file(filename, current_rev, rev_parse, tmp_dir)
+      diff = Mixlib::ShellOut.new("git diff #{current_rev}..#{rev_parse} -- #{filename}", :cwd => tmp_dir)
+      diff.run_command
+      diff.stdout.lines.collect {|line| $1 if line =~ /^\+([^+].*)/}.compact
+    end
+
+    def generate_from_git_history(tmp_dir, location, current_rev, rev_parse)
+      log = Mixlib::ShellOut.new("git log --no-merges --abbrev-commit --pretty=oneline #{current_rev}..#{rev_parse}", :cwd => tmp_dir)
+      log.run_command
+      c = log.stdout.lines
+      n = https_url(location)
+      c = linkify(n, c) if @config[:linkify] and n
+      c = c.map { |line| "* " + line } if @config[:markdown]
+      c
+    end
+
+    def linkify(url, changelog)
+      changelog.map do |line|
+        line.gsub(/^([a-f0-9]+) /, '[\1](%s/commit/\1) ' % [url.chomp('.git')])
+      end
+    end
+
+    def https_url(location)
+      if location.uri =~ /^\w+:\/\/(.*@)?(.*)(\.git?)/
+        "https://%s" % [ $2 ]
+      else
+        fail "Cannot guess http url from git remote url"
+      end
+    end
+
+    def short(location)
+      if location.uri =~ /([\w-]+)\/([\w-]+)(\.git)?$/
+        "%s/%s" % [$1,$2]
+      end
+    end
+
+    def shallow_clone(tmp_prefix, uri)
+      dir = Dir.mktmpdir(tmp_prefix)
+      @tmp_dirs << dir
+      clone = Mixlib::ShellOut.new("git clone --bare #{uri} bare-clone", :cwd => dir)
+      clone.run_command
+      clone.error!
+      ::File.join(dir, 'bare-clone')
+    end
+
+  end
+end

data/lib/knife/changelog/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Changelog
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.1.pre.alpha.pre.23
+  version: 0.2.0.pre.alpha.pre.25
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,7 @@ files:
 - Rakefile
 - knife-changelog.gemspec
 - lib/chef/knife/changelog.rb
+- lib/knife/changelog/changelog.rb
 - lib/knife/changelog/version.rb
 - resources/Berksfile
 - resources/Berksfile.lock