br-approvals 0.0.22

data/lib/approvals/writer.rb

@@ -0,0 +1,39 @@
+require 'approvals/writers/text_writer'
+require 'approvals/writers/array_writer'
+require 'approvals/writers/hash_writer'
+require 'approvals/writers/html_writer'
+require 'approvals/writers/xml_writer'
+require 'approvals/writers/json_writer'
+require 'approvals/writers/binary_writer'
+
+module Approvals
+  module Writer
+    extend Writers
+
+    REGISTRY = {
+      json: Writers::JsonWriter.new,
+      xml: Writers::XmlWriter.new,
+      html: Writers::HtmlWriter.new,
+      hash: Writers::HashWriter.new,
+      array: Writers::ArrayWriter.new,
+      txt: Writers::TextWriter.new,
+    }
+
+
+    class << self
+      def for(format)
+        begin
+          REGISTRY[format] || Object.const_get(format).new
+        rescue NameError => e
+          error = ApprovalError.new(
+            "Approval Error: #{ e }. Please define a custom writer as outlined"\
+            " in README section 'Customizing formatted output': "\
+            "https://github.com/kytrinyx/approvals#customizing-formatted-output"
+          )
+          raise error
+        end
+      end
+    end
+
+  end
+end

data/lib/approvals/writers/array_writer.rb

@@ -0,0 +1,17 @@
+module Approvals
+  module Writers
+    class ArrayWriter < TextWriter
+
+      def format(data)
+        filter(data).map.with_index do |value, i|
+          "[#{i.inspect}] #{value.inspect}\n"
+        end.join
+      end
+
+      def filter data
+        filter = ::Approvals::Filter.new(Approvals.configuration.excluded_json_keys)
+        filter.apply(data)
+      end
+    end
+  end
+end

data/lib/approvals/writers/binary_writer.rb

@@ -0,0 +1,49 @@
+module Approvals
+  module Writers
+    class BinaryWriter
+      EXCEPTION_WRITER = Proc.new do |data, file|
+        raise "BinaryWriter#callback missing"
+      end
+
+      def initialize(opts = {})
+        @autoregister = opts[:autoregister] || true
+        @detect = opts[:detect]
+        @extension = opts[:extension] || ''
+        @write = opts[:write] || EXCEPTION_WRITER
+        self.format = opts[:format] || :binary
+      end
+
+      attr_reader :format
+
+      def format=(sym)
+        unregister if autoregister
+
+        @format = sym
+
+        register if autoregister
+
+      end
+
+      def register
+        if @format
+          Writer::REGISTRY[@format] = self
+          Approval::BINARY_FORMATS << @format
+          Approval::IDENTITIES[@format] = @detect if @detect
+        end
+      end
+
+      def unregister
+        if @format
+          Writer::REGISTRY.delete!(@format)
+          Approval::BINARY_FORMATS.delete!(@format)
+          Approval::IDENTITIES.delete!(@format)
+        end
+      end
+
+      def write(data,path)
+        @write.call(data,path)
+      end
+
+    end
+  end
+end

data/lib/approvals/writers/hash_writer.rb

@@ -0,0 +1,20 @@
+module Approvals
+  module Writers
+    class HashWriter < TextWriter
+
+      def format(data)
+        lines = filter(data).map do |key, value|
+          "\t#{key.inspect} => #{value.inspect}"
+        end.join("\n")
+
+        "{\n#{lines}\n}\n"
+      end
+
+      def filter data
+        filter = ::Approvals::Filter.new(Approvals.configuration.excluded_json_keys)
+        filter.apply(data)
+      end
+
+    end
+  end
+end

data/lib/approvals/writers/html_writer.rb

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

data/lib/approvals/writers/json_writer.rb

@@ -0,0 +1,31 @@
+module Approvals
+  module Writers
+    class JsonWriter < TextWriter
+      def extension
+        'json'
+      end
+
+      def format(data)
+        hash_or_array = filter(parse_data(data))
+
+        JSON.pretty_generate(hash_or_array) + "\n"
+      end
+
+      private
+
+      def parse_data(data)
+        if data.respond_to?(:to_str)
+          # if the data is a string, assume it has been already json-ified
+          JSON.parse(data)
+        else
+          JSON.parse(data.to_json)
+        end
+      end
+
+      def filter data
+        filter = ::Approvals::Filter.new(Approvals.configuration.excluded_json_keys)
+        filter.apply(data)
+      end
+    end
+  end
+end

data/lib/approvals/writers/text_writer.rb

@@ -0,0 +1,21 @@
+module Approvals
+  module Writers
+    class TextWriter
+      def extension
+        'txt'
+      end
+
+      def write(data, path)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'w') do |f|
+          f.write format(data)
+        end
+      end
+
+      def format(data)
+        data.to_s
+      end
+
+    end
+  end
+end

data/lib/approvals/writers/xml_writer.rb

@@ -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

@@ -0,0 +1,172 @@
+require 'spec_helper'
+require 'approvals/namers/rspec_namer'
+
+describe Approvals do
+
+  let(:namer) { |example| Approvals::Namers::RSpecNamer.new(example) }
+
+  it "fails" do
+    allow(Approvals::Dotfile).to receive(:path).and_return('/dev/null')
+
+    expect do
+      Approvals.verify "this one doesn't exist", :namer => namer
+    end.to 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 hash" do
+    hash = {
+      :meal => 'breakfast',
+      :proteins => '90%',
+      :price => 38,
+      :delicious => true
+    }
+    Approvals.verify hash, :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
+
+  context "custom writer" do
+    let(:hello) { Object.new }
+
+    class MyCustomWriter < Approvals::Writers::TextWriter
+      def format(data)
+        filter(data)
+      end
+
+      def filter(data)
+        data.to_s.chars.reject {|c| c =~ /[a-zA-Z0-9]/}
+      end
+    end
+
+    it "verifies a complex object" do
+      Approvals.verify hello, :namer => namer, :format => "MyCustomWriter"
+    end
+
+    it "raises an error with an uninitialized custom writer class" do
+      expect{
+        Approvals.verify hello, :namer => namer, :format => "UninitializedWriter"
+      }.to raise_error.with_message(
+        /Please define a custom writer as outlined in README section 'Customizing formatted output':/
+      )
+    end
+ 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 a malformed html fragment" do
+    html = <<-HTML
+<!DOCTYPE html>
+<html>
+<title>Hoi</title>
+<script async defer src="http://foo.com/bar.js"></script>
+<h1>yo</h1>
+    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 json and is newline agnostic" do
+    json = '{"pet":{"species":"turtle","color":"green","name":"Anthony"}}'
+    Approvals.verify json, :format => :json, :namer => namer
+  end
+
+  it "verifies an array as json when format is set to json" do
+    people = [
+      {"name" => "Alice", "age" => 28},
+      {"name" => "Bob", "age" => 22}
+    ]
+
+    Approvals.verify(people, 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
+
+  it "passes approved files through ERB" do
+    $what  = 'greatness'
+    string = "We have, I fear, confused power with greatness."
+    Approvals.verify string, :namer => namer
+  end
+
+  # Bugfix: If only the approved file gets passed through ERB,
+  # then <% (received) is not equal to <% (approved).
+  it "passes the received files through ERB" do
+    string = "<%"
+    Approvals.verify string, :namer => namer
+  end
+
+  describe "supports excluded keys option" do
+    let(:hash) { {:object => {:id => rand(100), :created_at => Time.now, :name => 'test', deleted_at: nil}} }
+
+    before do
+      Approvals.configure do |c|
+        c.excluded_json_keys = {
+          :id => /(\A|_)id$/,
+          :date => /_at$/
+        }
+      end
+    end
+
+    it "verifies json with excluded keys" do
+      Approvals.verify JSON.dump(hash), :format => :json, :namer => namer
+    end
+
+    it "also supports an array of hashes" do
+      Approvals.verify JSON.dump([hash]), :format => :json, :namer => namer
+    end
+
+    it "supports the array writer" do
+      Approvals.verify [hash], :format => :array, :namer => namer
+    end
+
+    it "supports the hash writer" do
+      Approvals.verify hash, :format => :array, :namer => namer
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'approvals/configuration'
+
+describe Approvals::Configuration do
+
+  it "defaults to 'fixtures/approvals/'" do
+    expect(Approvals.configuration.approvals_path).to eq('fixtures/approvals/')
+  end
+
+  describe "when set" do
+    before(:each) do
+      Approvals.configure do |c|
+        c.approvals_path = 'output/dir/'
+      end
+    end
+
+    after(:each) do
+      Approvals.configure do |c|
+        c.approvals_path = nil
+      end
+    end
+
+    it "overrides the output directory" do
+      expect(Approvals.configuration.approvals_path).to eq('output/dir/')
+    end
+  end
+
+end

data/spec/dotfile_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'approvals/dotfile'
+
+describe Approvals::Dotfile do
+  let(:dotfile) { '/tmp/.approvals' }
+
+  before(:each) do
+    allow(Approvals::Dotfile).to receive(:path).and_return dotfile
+    Approvals::Dotfile.reset
+  end
+
+  it "appends the text" do
+    Approvals::Dotfile.append('text')
+    expect(File.readlines(dotfile).map(&:chomp)).to eq ['text']
+  end
+
+  it "appends the text exactly once" do
+    Approvals::Dotfile.append('text')
+    Approvals::Dotfile.append('text')
+    expect(File.readlines(dotfile).map(&:chomp)).to eq ['text']
+  end
+end

data/spec/executable_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'approvals/executable'
+
+describe Approvals::Executable do
+
+  it "reflects the its value in inspect" do
+    executable = Approvals::Executable.new('SELECT 1')
+    expect(executable.inspect).to eq 'SELECT 1'
+  end
+
+  it "takes a block" do
+    executable = Approvals::Executable.new('SELECT 1') do |command|
+      "execute query: #{command}"
+    end
+    expect(executable.on_failure.call('SELECT 1')).to eq 'execute query: SELECT 1'
+  end
+end