dossier 2.12.2 → 2.13.1

data/spec/dossier/configuration_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Dossier::Configuration do
   
-  let(:connection_options){ YAML.load_file(Rails.root.join('config', 'dossier.yml'))[Rails.env].symbolize_keys }
+  let(:connection_options){ YAML.load(ERB.new(File.read Rails.root.join('config', 'dossier.yml')).result)[Rails.env].symbolize_keys }
   let(:old_database_url) { ENV.delete "DATABASE_URL"}  
   
   before :each do 
@@ -10,13 +10,17 @@ describe Dossier::Configuration do
     @config = Dossier.configuration
   end
 
+  after :each do
+    ENV.delete "DATABASE_URL" if ENV.has_key? "DATABASE_URL"
+  end
+
   after :each do
     ENV["DATABASE_URL"] = old_database_url
   end
 
   describe "defaults" do
     it "uses the rails configuration directory for the config path" do
-      @config.config_path.should eq(Rails.root.join("config", "dossier.yml"))
+      expect(@config.config_path).to eq(Rails.root.join("config", "dossier.yml"))
     end
   end
 
@@ -30,20 +34,36 @@ describe Dossier::Configuration do
     end
 
     it "uses config/dossier.yml to setup the client" do
-      ENV.delete "DATABASE_URL" if ENV.has_key? "DATABASE_URL"
       expect(Dossier::Client).to receive(:new).with(connection_options)
       Dossier.configure
     end
 
-    it "will raise an exception if config/dossier.yml cannot be read" do
-      config_path = Rails.root.join('config')
-      FileUtils.mv config_path.join('dossier.yml'), config_path.join('dossier.yml.test')
-      expect { Dossier.configure }.to raise_error(Dossier::ConfigurationMissingError)
-      FileUtils.mv config_path.join('dossier.yml.test'), config_path.join('dossier.yml')
+    describe "missing a dossier.yml" do
+      let(:config_path) { Rails.root.join('config') }
+
+      before :each do
+        FileUtils.mv config_path.join('dossier.yml'),
+          config_path.join('dossier.yml.test')
+      end
+
+      after :each do
+        FileUtils.mv config_path.join('dossier.yml.test'),
+          config_path.join('dossier.yml')
+      end
+
+      it "will not raise an exception if config/dossier.yml cannot be read and DATABSE_URL is set" do
+        ENV['DATABASE_URL'] = "mysql2://localhost/dossier_test"
+        expect { Dossier.configure }.not_to raise_error
+      end
+
+      it "will raise an error if connection options is blank" do
+        expect { Dossier.configure }.to(
+          raise_error(Dossier::ConfigurationMissingError))
+      end
     end
 
     it "will setup the connection options" do
-      @config.connection_options.should be_a(Hash)
+      expect(@config.connection_options).to be_a(Hash)
     end
   end
 

data/spec/dossier/{naming_spec.rb → model_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Dossier::Naming do
+describe Dossier::Model do
   describe "report naming" do
     let(:klass) { HelloMyFriendsReport }
     let(:name)  { 'hello_my_friends' }
@@ -13,6 +13,11 @@ describe Dossier::Naming do
       expect(described_class.name_to_class(name)).to eq(klass)
     end
 
+    it "has a to_model" do
+      instance = klass.new
+      expect(instance.to_model).to eq(instance)
+    end
+
     describe "with namespaces" do
       let(:klass) { Cats::Are::SuperFunReport }
       let(:name)  { 'cats/are/super_fun' }

data/spec/dossier/query_spec.rb

@@ -6,8 +6,8 @@ describe Dossier::Query do
   let(:query)  { Dossier::Query.new(report) }
 
   before :each do
-    report.stub(:salary).and_return(2)
-    report.stub(:ids).and_return([1,2,3])
+    allow(report).to receive(:salary).and_return(2)
+    allow(report).to receive(:ids).and_return([1,2,3])
   end
 
   describe "replacing symbols by calling methods of the same name" do
@@ -17,10 +17,10 @@ describe Dossier::Query do
       context "when the methods return single values" do
 
         before :each do
-          report.stub(:sql).and_return("SELECT * FROM employees WHERE id = :id OR girth < :girth OR hired_on = :hired_on")
-          report.stub(:id).and_return(92)
-          report.stub(:girth).and_return(3.14)
-          report.stub(:hired_on).and_return('2013-03-29')
+          allow(report).to receive(:sql).and_return("SELECT * FROM employees WHERE id = :id OR girth < :girth OR hired_on = :hired_on")
+          allow(report).to receive(:id).and_return(92)
+          allow(report).to receive(:girth).and_return(3.14)
+          allow(report).to receive(:hired_on).and_return('2013-03-29')
         end
 
         it "escapes the values" do
@@ -39,8 +39,8 @@ describe Dossier::Query do
       context "when the methods return arrays" do
 
         before :each do
-          report.stub(:sql).and_return("SELECT * FROM employees WHERE stuff IN :stuff")
-          report.stub(:stuff).and_return([38, 'blue', 'mandible', 2])
+          allow(report).to receive(:sql).and_return("SELECT * FROM employees WHERE stuff IN :stuff")
+          allow(report).to receive(:stuff).and_return([38, 'blue', 'mandible', 2])
         end
 
         it "escapes each value in the array" do
@@ -60,14 +60,14 @@ describe Dossier::Query do
     context "when it's another string that includes :" do
 
       it "does not escape a namespaced constant" do
-        report.stub(:sql).and_return("SELECT * FROM employees WHERE type = 'Foo::Bar'") 
-        query.should_not_receive(:Bar)
+        allow(report).to receive(:sql).and_return("SELECT * FROM employees WHERE type = 'Foo::Bar'") 
+        expect(query).not_to receive(:Bar)
         query.to_s
       end
 
       it "does not escape a top-level constant" do
-        report.stub(:sql).and_return("SELECT * FROM employees WHERE type = '::Foo'") 
-        query.should_not_receive(:Foo)
+        allow(report).to receive(:sql).and_return("SELECT * FROM employees WHERE type = '::Foo'") 
+        expect(query).not_to receive(:Foo)
         query.to_s
       end
 

data/spec/dossier/report_spec.rb

@@ -5,7 +5,7 @@ describe Dossier::Report do
   let(:report) { TestReport.new(:foo => 'bar') }
 
   it "has a report name" do
-    TestReport.report_name.should eq('test')
+    expect(TestReport.report_name).to eq('test')
   end
 
   it "has a template name that is the report name" do
@@ -29,15 +29,15 @@ describe Dossier::Report do
     end
 
     it "takes options when initializing" do
-      report.options.should eq('foo' => 'bar')
+      expect(report.options).to eq('foo' => 'bar')
     end
 
     it 'generates column headers' do
-      report.format_header('Foo').should eq 'Foo'
+      expect(report.format_header('Foo')).to eq 'Foo'
     end
 
     it 'allows for column header customization' do
-      report_with_custom_header.format_header(:generic).should eq 'customized'
+      expect(report_with_custom_header.format_header(:generic)).to eq 'customized'
     end
 
     it "has a formatted title" do
@@ -62,8 +62,8 @@ describe Dossier::Report do
     end
 
     it "has callbacks for execute" do
-      Dossier.client.stub(:execute).and_return([])
-      report.stub(:before_test_for_build_query)
+      allow(Dossier.client).to receive(:execute).and_return([])
+      allow(report).to receive(:before_test_for_build_query)
       expect(report).to receive(:after_test_for_execute)
       report.run
     end
@@ -86,7 +86,7 @@ describe Dossier::Report do
       it "will cache the results of the run in `results`" do
         report = EmployeeReport.new
         report.run
-        report.results.should_not be_nil
+        expect(report.results).not_to be_nil
       end
     end
 

data/spec/dossier/responder_spec.rb

@@ -2,18 +2,18 @@ require 'spec_helper'
 
 describe Dossier::Responder do
 
-  def stub_out_report_results(report)
+  def mock_out_report_results(report)
     report.tap { |r|
-      r.stub(:results).and_return(results)
-      r.stub(:raw_results).and_return(results)
+      allow(r).to receive(:results).and_return(results)
+      allow(r).to receive(:raw_results).and_return(results)
     }
   end
 
   let(:results)    { double(arrays: [%w[hi], %w[there]], hashes: [{hi: 'there'}]) }
   let(:report)     { EmployeeReport.new }
-  let(:reports)    { [stub_out_report_results(report)] }
+  let(:reports)    { [mock_out_report_results(report)] }
   let(:controller) { 
-    ActionController::Base.new.tap { |controller| controller.stub(:headers).and_return({}) }
+    ActionController::Base.new.tap { |controller| allow(controller).to receive(:headers).and_return({}) }
   }
   let(:responder)  { described_class.new(controller, reports, {}) }
 

data/spec/dossier/result_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Dossier::Result do
 
-  module AbstractStub
+  module AbstractMock
     def each
       adapter_results.rows.each do |row|
         yield row
@@ -17,7 +17,7 @@ describe Dossier::Result do
   let(:report)         { TestReport.new }
   let(:result_row)     { {'mascot' => 'platapus', 'cheese' => 'bleu'} }
   let(:adapter_result) { double(:adapter_result, rows: [result_row.values], headers: result_row.keys) }
-  let(:result_class)   { Class.new(described_class) { include AbstractStub } }
+  let(:result_class)   { Class.new(described_class) { include AbstractMock } }
   let(:result)         { result_class.new(adapter_result, report) }
 
   it "requires each to be overridden" do
@@ -51,7 +51,7 @@ describe Dossier::Result do
       end
 
       it "can return an array of arrays" do
-        result.stub(:headers).and_return(%w[mascot cheese])
+        allow(result).to receive(:headers).and_return(%w[mascot cheese])
         expect(result.arrays).to eq([%w[mascot cheese], %w[platapus bleu]])
       end
 
@@ -122,7 +122,7 @@ describe Dossier::Result do
         let(:adapter_result_rows) { 7.times.map { result_row.values } }
 
         before :each do
-          adapter_result.stub(:rows).and_return(adapter_result_rows)
+          allow(adapter_result).to receive(:rows).and_return(adapter_result_rows)
         end
 
         it "has 4 result rows" do
@@ -157,7 +157,7 @@ describe Dossier::Result do
         end
 
         it "does not format the results" do
-          result.should_not_receive(:format)
+          expect(result).not_to receive(:format)
           result.each { |result| }
         end
 

data/spec/dossier/stream_csv_spec.rb

@@ -57,16 +57,18 @@ describe Dossier::StreamCSV do
   describe "exceptions" do
     let(:output) { String.new }
     let(:error)  { "Woooooooo cats are fluffy!" }
-    before(:each) { collection[0].stub(:to_csv).and_return { raise error } }
+    before(:each) {
+      allow(collection[0]).to receive(:to_csv).and_raise(error)
+    }
 
     it "provides a backtrace if local request" do
-      Rails.application.config.stub(:consider_all_requests_local).and_return(true)
+      allow(Rails.application.config).to receive(:consider_all_requests_local).and_return(true)
       streamer.each { |line| output << line }
       expect(output).to include(error)
     end
 
     it "provides a simple error if not a local request" do
-      Rails.application.config.stub(:consider_all_requests_local).and_return(false)
+      allow(Rails.application.config).to receive(:consider_all_requests_local).and_return(false)
       streamer.each { |line| output << line }
       expect(output).to match(/something went wrong/)
     end

data/spec/dossier/version_spec.rb

@@ -0,0 +1,8 @@
+RSpec.describe Dossier::VERSION do
+
+  it "is a string" do
+    expect(subject).to be_a String
+  end
+
+end
+

data/spec/dossier_spec.rb

@@ -2,17 +2,17 @@ require 'spec_helper'
 
 describe Dossier do
   it "is a module" do
-    Dossier.should be_a(Module)
+    expect(Dossier).to be_a(Module)
   end
 
   it "is configurable"  do
     Dossier.configure
-    Dossier.configuration.should_not be_nil
+    expect(Dossier.configuration).to_not be_nil
   end
 
   it "has a configuration" do
     Dossier.configure
-    Dossier.configuration.should be_a(Dossier::Configuration)
+    expect(Dossier.configuration).to be_a(Dossier::Configuration)
   end
 
   it "allows configuration via a block" do
@@ -20,7 +20,7 @@ describe Dossier do
     Dossier.configure do |config|
       config.client = some_client
     end
-    Dossier.configuration.client.should eq(some_client)
+    expect(Dossier.configuration.client).to eq(some_client)
   end
 
   it "exposes the configurations client via Dossier.client" do

data/spec/dummy/Rakefile

@@ -0,0 +1,4 @@
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks
+

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+ApplicationController = Class.new(ActionController::Base) do
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/reports/cats/are/super_fun_report.rb

@@ -2,7 +2,19 @@ module Cats
   module Are
     class SuperFunReport < Dossier::Report
       def sql
-        "select 'cats', 'are', 'super', 'fun'"
+        "select #{selections.join(', ')}"
+      end
+
+      def selections
+        columns = %w(cats are super fun)
+        selections = columns.map { |x| "'#{x}' as #{x}" }
+        if ENV['DOSSIER_DB'].to_s === 'postgresql'
+          selections.map! { |x| 
+            parts = x.split(' as ')
+            "'#{parts[0][1..-2]}'::character(7) as #{parts[1]}" 
+          }
+        end
+        selections
       end
     end
   end

data/spec/dummy/app/reports/employee_report.rb

@@ -55,12 +55,17 @@ class EmployeeReport < Dossier::Report
     @names ||= options.fetch(:names) { [] }.dup
   end
 
+  def display_column?(name)
+    name != 'id'
+  end
+
   def format_salary(amount, row)
     return "Who's Asking?" if row[:division] == "Corporate Malfeasance"
     formatter.number_to_currency(amount)
   end
 
   def format_hired_on(date)
+    date = Date.parse(date) if String === date
     date.to_s(:db)
   end
 
@@ -69,11 +74,19 @@ class EmployeeReport < Dossier::Report
   end
 
   def format_suspended(value)
-    value.to_i == 1 ? 'Yes' : 'No'
+    value.to_s.in?(%w(1 t)) ? 'Yes' : 'No'
   end
 
   def example_before_hook
     # do some stuff
   end
 
+  def raw_results
+    super
+    results = query_results.rows.map { |qr|
+      qr.tap { |q| q[4] = format_suspended(q[4]) }
+    }
+    @raw_results ||= Result::Unformatted.new(results, self)
+  end
+
 end

data/spec/dummy/app/reports/employee_with_custom_view_report.rb

@@ -6,7 +6,7 @@ class EmployeeWithCustomViewReport < Dossier::Report
   end
 
   def sql
-    "SELECT * FROM employees WHERE suspended = true"
+    "SELECT * FROM employees WHERE suspended = :suspended"
   end
 
   def dragon_color
@@ -17,6 +17,10 @@ class EmployeeWithCustomViewReport < Dossier::Report
     @formatter ||= CustomFormatter
   end
 
+  def suspended
+    true
+  end
+
   module CustomFormatter
     extend Dossier::Formatter
     def margery_butts(word)

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require APP_PATH
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/application'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,30 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+
+require "rails/all"
+
+Bundler.require
+
+module Dummy
+  class Application < ::Rails::Application
+    config.cache_classes = true
+    config.active_support.deprecation = :stderr
+    config.eager_load = false
+    config.action_controller.allow_forgery_protection = false
+
+    # Raise exceptions instead of rendering exception templates
+    config.action_dispatch.show_exceptions = false
+    # because this belongs here for some reason...??? also in spec_helper
+    # thanks rails 5 :/
+    config.active_support.test_order = :random
+
+    config.secret_token = config.secret_key_base = 
+      'http://s3-ec.buzzfed.com/static/enhanced/webdr03/2013/5/25/8/anigif_enhanced-buzz-11857-1369483324-0.gif'
+  end
+end
+
+Dummy::Application.initialize!