nyan-cat-chef-formatter 0.1.0

data/LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Andrea Campi
+Copyright (c) 2011 Matt Sears
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+Nyan Cat <3 Chef
+================
+
+A formatter for [Chef](http://opscode.com) dedicated to the wonderful Nyan Cat!
+
+    Starting Chef Client, version 10.14.4
+    Compiling cookbooks
+    .............................................................done.
+    Converging 138 resources
+    278/278: _-_-_+-_-_-_-_+_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-__,------,
+    270/278: _-_-_+-_-_-_-_+_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-__|  /\_/\
+      8/278: _-_-_+-_-_-_-_+_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_~|_( - .-)
+      0/278: _-_-_+-_-_-_-_+-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_ ""  ""
+
+    System converged.
+
+This formatter will display the total number of processed resources, as the
+number of unchanged, updated and failed resources.
+
+The rainbow changes colors as it runs.
+
+This is inspired by [Nyan Cat RSpec Formatter](https://github.com/mattsears/nyan-cat-formatter).
+Actually no, scratch that: this is basically a ripoff. So sue me.
+
+Usage
+=====
+
+Install the gem:
+
+    gem install nyan-cat-chef-formatter
+
+If you are using Omnibus Chef you need to specify the full path to the `gem`
+binary:
+
+    /opt/chef/embedded/bin/gem install nyan-cat-chef-formatter
+
+Or write a cookbook to install it using the `chef_gem` resource, if that's
+how you roll.
+
+Then add the following to your `/etc/chef/client.rb` file:
+
+    gem 'nyan-cat-chef-formatter'
+    require 'nyan-cat-chef-formatter'
+
+This enables the formatter, but doesn't use it by default. To see Nyan in all its
+glory, run:
+
+    chef-client -Fnyan -lfatal
+
+Enjoy!
+
+For serious Nyan addicts only!
+------------------------------
+
+To enable the Nyan formatter by default, add the following line to
+`/etc/chef/client.rb`:
+
+    formatter :nyan
+
+Contributing
+----------
+
+Once you've made your great commits:
+
+1. Fork Nyan Cat
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Create a Pull Request from your branch
+5. That's it!
+
+Author
+----------
+[Andrea Campi](https://www.github.com/andreacampi) :: @andreacampi
+[Matt Sears](https://wwww.mattsears.com) :: @mattsears

data/lib/nyan-cat-chef-formatter.rb

@@ -0,0 +1,248 @@
+require 'chef/formatters/minimal'
+
+class Chef
+  module Formatters
+    class NyanCat < Formatters::Minimal
+
+      cli_name(:nyan)
+
+      ESC      = "\e["
+      NND      = "#{ESC}0m"
+      PASS     = '='
+      PASS_ARY = ['-', '_']
+      FAIL     = '*'
+      ERROR    = '!'
+      UPDATED  = '+'
+
+      # attr_reader :current, :example_results, :color_index, :pending_count,
+      #             :failure_count, :example_count
+      # 
+      def initialize(out, err)
+        super
+
+        @started = @finished = false
+      end
+
+      def run_start(version)
+        super
+
+        @total_count = 0
+        @current = @color_index = @failure_count = @updated_count = 0
+        @ticks = []
+      end
+
+      # Called before convergence starts
+      def converge_start(run_context)
+        @total_count = run_context.resource_collection.all_resources.size # + 150
+        @started = true
+        puts "Converging #{run_context.resource_collection.all_resources.size} resources"
+      end
+
+      def converge_complete
+        @finished = true
+        dump_progress
+        super
+      end
+
+      def resource_failed_retriable(resource, action, retry_count, exception)
+        return unless @started
+        @failure_count += 1
+        tick FAIL
+      end
+
+      def resource_failed(resource, action, exception)
+        return unless @started
+        @failure_count += 1
+        tick FAIL
+      end
+
+      def resource_skipped(resource, action, conditional)
+        return unless @started
+        tick PASS
+      end
+
+      def resource_up_to_date(resource, action)
+        return unless @started
+        tick PASS
+      end
+
+      # Called after a resource has been completely converged.
+      def resource_updated(resource, action)
+        updated_resources << resource
+        return unless @started
+        @updated_count += 1
+        tick UPDATED
+      end
+
+      def tick(mark = PASS)
+        @ticks << mark
+        @current += 1
+        @total_count = @current if @current > @total_count
+        dump_progress
+      end
+
+      # Determine which Ascii Nyan Cat to display. If tests are complete,
+      # Nyan Cat goes to sleep. If there are failing or pending examples,
+      # Nyan Cat is concerned.
+      #
+      # @return [String] Nyan Cat
+      def nyan_cat
+        if self.failed? && self.finished?
+          ascii_cat('x')[@color_index%2].join("\n") #'~|_(x.x)'
+        elsif self.failed?
+          ascii_cat('o')[@color_index%2].join("\n") #'~|_(o.o)'
+        elsif self.finished?
+          ascii_cat('-')[@color_index%2].join("\n") # '~|_(-.-)'
+        else
+          ascii_cat('^')[@color_index%2].join("\n") # '~|_(^.^)'
+        end
+      end
+
+      # Displays the current progress in all Nyan Cat glory
+      #
+      # @return nothing
+      def dump_progress
+        padding = @total_count.to_s.length * 2 + 2
+        line = nyan_trail.split("\n").each_with_index.inject([]) do |result, (trail, index)|
+          value = "#{scoreboard[index]}/#{@total_count}:"
+          result << format("%s %s", value, trail)
+        end.join("\n")
+        output.print line + eol
+      end
+
+      # Determines how we end the trail line. If complete, return a newline etc.
+      #
+      # @return [String]
+      def eol
+        return "\n" if @finished
+        length = (nyan_cat.split("\n").length - 1)
+        length > 0 ? format("\e[1A" * length + "\r") : "\r"
+      end
+
+      # Calculates the current flight length
+      #
+      # @return [Fixnum]
+      def current_width
+        padding    = @total_count.to_s.length * 2 + 6
+        cat_length = nyan_cat.split("\n").group_by(&:size).max.first
+        padding    + (@current >= @total_count ? @total_count : @current) + cat_length
+      end
+
+      # A Unix trick using stty to get the console columns
+      #
+      # @return [Fixnum]
+      def terminal_width
+        if defined? JRUBY_VERSION
+          default_width = 80
+        else
+          default_width = `stty size`.split.map { |x| x.to_i }.reverse.first - 1
+        end
+        @terminal_width ||= default_width
+      end
+
+      # Creates a data store of pass, failed, and pending example results
+      # We have to pad the results here because sprintf can't properly pad color
+      #
+      # @return [Array]
+      def scoreboard
+        padding = @total_count.to_s.length
+        [ @current.to_s.rjust(padding),
+          green((@current - @updated_count - @failure_count).to_s.rjust(padding)),
+          blue(@updated_count.to_s.rjust(padding)),
+          red(@failure_count.to_s.rjust(padding)) ]
+      end
+
+      # Creates a rainbow trail
+      #
+      # @return [String] the sprintf format of the Nyan cat
+      def nyan_trail
+        marks = @ticks.map{ |mark| highlight(mark) }
+        marks.shift(current_width - terminal_width) if current_width >= terminal_width
+        nyan_cat_lines = nyan_cat.split("\n").each_with_index.map do |line, index|
+          format("%s#{line}", marks.join)
+        end.join("\n")
+      end
+
+      # Ascii version of Nyan cat. Two cats in the array allow Nyan to animate running.
+      #
+      # @param o [String] Nyan's eye
+      # @return [Array] Nyan cats
+      def ascii_cat(o = '^')
+        [[ "_,------,   ",
+            "_|  /\\_/\\ ",
+            "~|_( #{o} .#{o})  ",
+            " \"\"  \"\" "
+          ],
+          [ "_,------,   ",
+            "_|   /\\_/\\",
+            "^|__( #{o} .#{o}) ",
+            "  \"\"  \"\"    "
+          ]]
+      end
+
+      # Colorizes the string with raindow colors of the rainbow
+      #
+      # @params string [String]
+      # @return [String]
+      def rainbowify(string)
+        c = colors[@color_index % colors.size]
+        @color_index += 1
+        "#{ESC}38;5;#{c}m#{string}#{NND}"
+      end
+
+      # Calculates the colors of the rainbow
+      #
+      # @return [Array]
+      def colors
+        @colors ||= (0...(6 * 7)).map do |n|
+          pi_3 = Math::PI / 3
+          n *= 1.0 / 6
+          r  = (3 * Math.sin(n           ) + 3).to_i
+          g  = (3 * Math.sin(n + 2 * pi_3) + 3).to_i
+          b  = (3 * Math.sin(n + 4 * pi_3) + 3).to_i
+          36 * r + 6 * g + b + 16
+        end
+      end
+
+      # Determines how to color the example.  If pass, it is rainbowified, otherwise
+      # we assign red if failed or yellow if an error occurred.
+      #
+      # @return [String]
+      def highlight(mark = PASS)
+        case mark
+        when PASS; rainbowify PASS_ARY[@color_index%2]
+        when FAIL; "\e[31m#{mark}\e[0m"
+        when ERROR; "\e[33m#{mark}\e[0m"
+        when UPDATED; "\e[34m#{mark}\e[0m"
+        else mark
+        end
+      end
+
+      # Converts a float of seconds into a minutes/seconds string
+      #
+      # @return [String]
+      def format_duration(duration)
+        seconds = ((duration % 60) * 100.0).round / 100.0   # 1.8.7 safe .round(2)
+        seconds = seconds.to_i if seconds.to_i == seconds   # drop that zero if it's not needed
+
+        message = "#{seconds} second#{seconds == 1 ? "" : "s"}"
+        message = "#{(duration / 60).to_i} minute#{(duration / 60).to_i == 1 ? "" : "s"} and " + message if duration >= 60
+
+        message
+      end
+
+      def finished?
+        @finished
+      end
+
+      def failed?
+        @failure_count.to_i > 0
+      end
+
+      def green(text); "\e[32m#{text}\e[0m"; end
+      def red(text); "\e[31m#{text}\e[0m"; end
+      def yellow(text); "\e[33m#{text}\e[0m"; end
+      def blue(text); "\e[34m#{text}\e[0m"; end
+    end
+  end
+end

data/nyan-cat-chef-formatter.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nyan-cat-chef-formatter"
+  s.version     = "0.1.0"
+  s.authors     = ["Andrea Campi"]
+  s.email       = ["andrea.campi@zephirworks.com"]
+  s.homepage    = "https://github.com/andreacampi/nyan-cat-chef-formatter"
+  s.summary     = %q{Nyan Cat inspired Chef formatter}
+  s.description = %q{Nyan Cat inspired Chef formatter}
+
+  s.rubyforge_project = "nyan-cat-chef-formatter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: nyan-cat-chef-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrea Campi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies: []
+description: Nyan Cat inspired Chef formatter
+email:
+- andrea.campi@zephirworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/nyan-cat-chef-formatter.rb
+- nyan-cat-chef-formatter.gemspec
+homepage: https://github.com/andreacampi/nyan-cat-chef-formatter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nyan-cat-chef-formatter
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Nyan Cat inspired Chef formatter
+test_files: []