RubyGems - approvals - Versions diffs - 0.0.1 - Mend

approvals 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (69) hide show

data/.gitignore +7 -0
data/.travis.yml +4 -0
data/Gemfile +4 -0
data/License.txt +22 -0
data/README.md +133 -0
data/Rakefile +1 -0
data/TODO +2 -0
data/approvals.gemspec +23 -0
data/bin/approvals +9 -0
data/lib/approvals.rb +24 -0
data/lib/approvals/approval.rb +97 -0
data/lib/approvals/configuration.rb +24 -0
data/lib/approvals/dsl.rb +7 -0
data/lib/approvals/error.rb +5 -0
data/lib/approvals/extensions/rspec.rb +11 -0
data/lib/approvals/extensions/rspec/dsl.rb +9 -0
data/lib/approvals/extensions/rspec/example.rb +17 -0
data/lib/approvals/extensions/rspec/example_group.rb +15 -0
data/lib/approvals/namers/default_namer.rb +20 -0
data/lib/approvals/namers/rspec_namer.rb +27 -0
data/lib/approvals/reporters.rb +3 -0
data/lib/approvals/reporters/first_working_reporter.rb +21 -0
data/lib/approvals/reporters/image_reporter.rb +16 -0
data/lib/approvals/reporters/image_reporter/html_image_reporter.rb +35 -0
data/lib/approvals/reporters/image_reporter/image_magick_reporter.rb +20 -0
data/lib/approvals/utilities.rb +4 -0
data/lib/approvals/utilities/cli.rb +28 -0
data/lib/approvals/utilities/dotfile.rb +38 -0
data/lib/approvals/utilities/executable.rb +14 -0
data/lib/approvals/utilities/scrubber.rb +43 -0
data/lib/approvals/utilities/system_command.rb +13 -0
data/lib/approvals/writer.rb +26 -0
data/lib/approvals/writers.rb +5 -0
data/lib/approvals/writers/array_writer.rb +15 -0
data/lib/approvals/writers/html_writer.rb +15 -0
data/lib/approvals/writers/json_writer.rb +17 -0
data/lib/approvals/writers/text_writer.rb +22 -0
data/lib/approvals/writers/xml_writer.rb +15 -0
data/spec/approvals_spec.rb +64 -0
data/spec/configuration_spec.rb +27 -0
data/spec/extensions/rspec_approvals_spec.rb +49 -0
data/spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_verifies_a_string.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_verifies_an_array.approved.txt +4 -0
data/spec/fixtures/approvals/approvals_verifies_an_executable.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_verifies_html.approved.html +11 -0
data/spec/fixtures/approvals/approvals_verifies_json.approved.json +7 -0
data/spec/fixtures/approvals/approvals_verifies_xml.approved.xml +9 -0
data/spec/fixtures/approvals/verifications_a_string.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_a_complex_object.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_a_string.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_an_array.approved.txt +4 -0
data/spec/fixtures/approvals/verifies_an_executable.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_html.approved.html +11 -0
data/spec/fixtures/approvals/verifies_json.approved.json +7 -0
data/spec/fixtures/approvals/verifies_xml.approved.xml +9 -0
data/spec/fixtures/one.png +0 -0
data/spec/fixtures/two.png +0 -0
data/spec/namers/default_namer_spec.rb +35 -0
data/spec/namers/rspec_namer_spec.rb +31 -0
data/spec/namers_spec.rb +16 -0
data/spec/reporters/first_working_reporter_spec.rb +29 -0
data/spec/reporters/html_image_reporter_spec.rb +22 -0
data/spec/reporters/image_magick_reporter_spec.rb +16 -0
data/spec/utilities/dotfile_spec.rb +22 -0
data/spec/utilities/executable_spec.rb +15 -0
data/spec/utilities/scrubber_spec.rb +24 -0
data/spec/utilities/system_command_spec.rb +13 -0
metadata +147 -0

data/lib/approvals/namers/default_namer.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module Approvals
+  module Namers
+    class DefaultNamer
+      attr_reader :name
+      def initialize(name = nil)
+        raise ArgumentError.new("DefaultNamer: You must specify a name") if name.nil?
+        @name = normalize(name)
+      end
+      def normalize(string)
+        string.strip.squeeze(" ").gsub(/[\ :-]+/, '_').gsub(/[\W]/, '').downcase
+      end
+      def output_dir
+        @output_dir ||= Approvals.configuration.approvals_path
+      end
+    end
+  end
+end

data/lib/approvals/namers/rspec_namer.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module Approvals
+  module Namers
+    class RSpecNamer
+      attr_reader :name
+      def initialize(example)
+        @name = normalize example.full_description
+      end
+      def normalize(string)
+        string.strip.squeeze(" ").gsub(/[\ :-]+/, '_').gsub(/[\W]/, '').downcase
+      end
+      def output_dir
+        unless @output_dir
+          begin
+            @output_dir = ::RSpec.configuration.approvals_path
+          rescue NoMethodError => e
+          end
+          @output_dir ||= 'spec/fixtures/approvals/'
+        end
+        @output_dir
+      end
+    end
+  end
+end

data/lib/approvals/reporters.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'singleton'
+require 'approvals/reporters/first_working_reporter'
+require 'approvals/reporters/image_reporter'

data/lib/approvals/reporters/first_working_reporter.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module Approvals
+  module Reporters
+    class FirstWorkingReporter
+      attr_accessor :reporters
+      def initialize(*reporters)
+        self.reporters = reporters
+      end
+      def working_in_this_environment?
+        reporters.any?(&:working_in_this_environment?)
+      end
+      def report(received, approved)
+        reporter = reporters.find(&:working_in_this_environment?)
+        reporter.report(received, approved) unless reporter.nil?
+      end
+    end
+  end
+end

data/lib/approvals/reporters/image_reporter.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require 'approvals/reporters/image_reporter/image_magick_reporter'
+require 'approvals/reporters/image_reporter/html_image_reporter'
+module Approvals
+  module Reporters
+    class ImageReporter < FirstWorkingReporter
+      include Singleton
+      def initialize
+        super(ImageMagickReporter.instance, HtmlImageReporter.instance)
+      end
+    end
+  end
+end

data/lib/approvals/reporters/image_reporter/html_image_reporter.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module Approvals
+  module Reporters
+    class HtmlImageReporter
+      include Singleton
+      def working_in_this_environment?
+        true
+      end
+      def report(received, approved)
+        display html(received, approved)
+      end
+      def html(received, approved)
+        template(File.expand_path(received), File.expand_path(approved))
+      end
+      def display(page)
+        filename = "#{Approvals.tmp_path}tmp-#{rand(Time.now.to_i)}.html"
+        File.open(filename, 'w') do |file|
+          file.write page
+        end
+        system("open #{filename}")
+      end
+      private
+      def template(received, approved)
+        <<-HTML.gsub(/^\ {8}/, '').chomp
+        <html><head><title>Approval</title></head><body><center><table style="text-align: center;" border="1"><tr><td><img src="file://#{received}"></td><td><img src="file://#{approved}"></td></tr><tr><td>received</td><td>approved</td></tr></table></center></body></html>
+        HTML
+      end
+    end
+  end
+end

data/lib/approvals/reporters/image_reporter/image_magick_reporter.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module Approvals
+  module Reporters
+    class ImageMagickReporter
+      include Singleton
+      def working_in_this_environment?
+        SystemCommand.exists? "compare"
+      end
+      def create_command_line(received, approved)
+        "compare #{received} #{approved} -compose Src x:"
+      end
+      def report(received, approved)
+        system(create_command_line(received, approved))
+      end
+    end
+  end
+end

data/lib/approvals/utilities.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'approvals/utilities/system_command'
+require 'approvals/utilities/scrubber'
+require 'approvals/utilities/dotfile'
+require 'approvals/utilities/executable'

data/lib/approvals/utilities/cli.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module Approvals
+  class CLI < Thor
+    desc "verify", "Go through all failing approvals with a diff tool"
+    method_option :diff, :type => :string, :default => 'vimdiff', :aliases => '-d', :desc => 'The difftool to use'
+    method_option :ask, :type => :boolean, :default => false, :aliases => "-a", :desc => 'Offer to approve the received file for you.'
+    def verify
+      approvals = File.read('.approvals').split("\n")
+      rejected = []
+      approvals.each do |approval|
+        system("#{options[:diff]} #{approval}")
+        if options[:ask] && yes?("Approve?")
+            system("mv #{approval}")
+        else
+          rejected << approval
+        end
+      end
+      File.open('.approvals', 'w') do |f|
+        f.write rejected.join("\n")
+      end
+    end
+  end
+end

data/lib/approvals/utilities/dotfile.rb ADDED Viewed

@@ -0,0 +1,38 @@
+module Approvals
+  class Dotfile
+    class << self
+      def reset
+        File.delete(path) if File.exists?(path)
+        touch
+      end
+      def path
+        '.approvals'
+      end
+      def touch
+        FileUtils.touch(path)
+      end
+      def append(text)
+        unless includes?(text)
+          write text
+        end
+      end
+      def includes?(text)
+        system("cat #{path} | grep -q \"^#{text}$\"")
+      end
+      def write(text)
+        File.open(path, 'a+') do |f|
+          f.write "#{text}\n"
+        end
+      end
+    end
+  end
+end

data/lib/approvals/utilities/executable.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Approvals
+  class Executable
+    attr_accessor :command, :on_failure
+    def initialize(command, &block)
+      self.command = command
+      self.on_failure = block
+    end
+    def to_s
+      command
+    end
+  end
+end

data/lib/approvals/utilities/scrubber.rb ADDED Viewed

@@ -0,0 +1,43 @@
+module Approvals
+  class Scrubber
+    def initialize(string, hash = nil)
+      @hash = hash
+      @string = scrub(string)
+    end
+    def hash
+      @hash ||= {
+        'current_dir' => File.expand_path('.')
+      }
+    end
+    def scrub(string)
+      hash.each do |key, value|
+        string = string.gsub(value, wrap(key))
+      end
+      string
+    end
+    def unscrub(string = @string)
+      hash.each do |key, value|
+        string = string.gsub(wrap(key), value)
+      end
+      string
+    end
+    def wrap(string)
+      "{{#{string}}}"
+    end
+    def to_s
+      @string
+    end
+    #def to_executable(&block)
+    #  Approvals::Executable.new(@string) do |scrubbed|
+    #    block.call(unscrub(scrubbed))
+    #  end
+    #end
+  end
+end

data/lib/approvals/utilities/system_command.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module Approvals
+  module SystemCommand
+    class << self
+      def exists?(executable)
+        `which #{executable}` != ""
+      end
+    end
+  end
+end

data/lib/approvals/writer.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require 'approvals/writers/text_writer'
+require 'approvals/writers/array_writer'
+require 'approvals/writers/html_writer'
+require 'approvals/writers/xml_writer'
+require 'approvals/writers/json_writer'
+module Approvals
+  module Writer
+    extend Writers
+    class << self
+      def for(format)
+        case format
+        when :json then JsonWriter.instance
+        when :xml then XmlWriter.instance
+        when :html then HtmlWriter.instance
+        when :hash then HashWriter.instance
+        when :array then ArrayWriter.instance
+        else
+          TextWriter.instance
+        end
+      end
+    end
+  end
+end

data/lib/approvals/writers.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'approvals/writers/text_writer'
+require 'approvals/writers/array_writer'
+require 'approvals/writers/html_writer'
+require 'approvals/writers/xml_writer'
+require 'approvals/writers/json_writer'

data/lib/approvals/writers/array_writer.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Approvals
+  module Writers
+    class ArrayWriter < TextWriter
+      def format(data)
+        s = ""
+        data.each_with_index do |value, i|
+          s << "[#{i.inspect}] #{value.inspect}\n"
+        end
+        s
+      end
+    end
+  end
+end

data/lib/approvals/writers/html_writer.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Approvals
+  module Writers
+    class HtmlWriter < TextWriter
+      def extension
+        'html'
+      end
+      def format(data)
+        Nokogiri::XML(data.to_s.strip,&:noblanks).to_xhtml(:indent => 2, :encoding => 'UTF-8')
+      end
+    end
+  end
+end

data/lib/approvals/writers/json_writer.rb ADDED Viewed

@@ -0,0 +1,17 @@
+require 'json'
+module Approvals
+  module Writers
+    class JsonWriter < TextWriter
+      def extension
+        'json'
+      end
+      def format(data)
+        JSON.pretty_generate(JSON.parse(data))
+      end
+    end
+  end
+end

data/lib/approvals/writers/text_writer.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Approvals
+  module Writers
+    class TextWriter
+      include Singleton
+      def extension
+        'txt'
+      end
+      def write(data, path)
+        File.open(path, 'w') do |f|
+          f.write format(data)
+        end
+      end
+      def format(data)
+        data.inspect
+      end
+    end
+  end
+end

data/lib/approvals/writers/xml_writer.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Approvals
+  module Writers
+    class XmlWriter < TextWriter
+      def extension
+        'xml'
+      end
+      def format(data)
+        Nokogiri::XML(data.to_s.strip,&:noblanks).to_xml(:indent => 2, :encoding => 'UTF-8')
+      end
+    end
+  end
+end

data/spec/approvals_spec.rb ADDED Viewed

@@ -0,0 +1,64 @@
+require 'approvals'
+require 'approvals/namers/rspec_namer'
+describe Approvals do
+  let(:namer) { Approvals::Namers::RSpecNamer.new(self.example) }
+  it "fails" do
+    ->{ Approvals.verify "this one doesn't exist", :namer => namer }.should raise_error Approvals::ApprovalError
+  end
+  it "verifies a string" do
+    string = "We have, I fear, confused power with greatness."
+    Approvals.verify string, :namer => namer
+  end
+  it "verifies an array" do
+    array = [
+      "abc",
+      123,
+      :zomg_fooooood,
+      %w(cheese burger ribs steak bacon)
+    ]
+    Approvals.verify array, :namer => namer
+  end
+  it "verifies a complex object" do
+    hello = Object.new
+    def hello.to_s
+      "Hello, World!"
+    end
+    def hello.inspect
+      "#<The World Says: Hello!>"
+    end
+    Approvals.verify hello, :namer => namer
+  end
+  it "verifies html" do
+    html = <<-HTML
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"><html><head><title>Approval</title></head><body><h1>An Approval</h1><p>It has a paragraph</p></body></html>
+    HTML
+    Approvals.verify html, :format => :html, :namer => namer
+  end
+  it "verifies xml" do
+    xml = "<xml char=\"kiddo\"><node><content name='beatrice' /></node><node aliases='5'><content /></node></xml>"
+    Approvals.verify xml, :format => :xml, :namer => namer
+  end
+  it "verifies json" do
+    json = '{"pet":{"species":"turtle","color":"green","name":"Anthony"}}'
+    Approvals.verify json, :format => :json, :namer => namer
+  end
+  it "verifies an executable" do
+    executable = Approvals::Executable.new('SELECT 1') do |command|
+      puts "your slip is showing (#{command})"
+    end
+    Approvals.verify executable, :namer => namer
+  end
+end