dossier 2.12.2 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e46d866c27e0bcc065d6fd0e0912ed6b1ecbb72
-  data.tar.gz: a76bd7e9487ae6de1114b5b9aa2ac32d616d11cd
+  metadata.gz: ebb6c964daa51f25b6c3b0856cd7e9d1006ed2b0
+  data.tar.gz: 700abc7cba17e2218185f16bd51ace2711a493cb
 SHA512:
-  metadata.gz: 1a333bec0fa762f56180e6d2e6916dbd2043ee8d0dbc634d114a74a178702558e8d30afb22e22292fa46cdd3ec97fa98e25f3d7915487d6fb9e5216b0695fef4
-  data.tar.gz: 7ac2295c362089079c2010b20dea42c600f0c23dc8208a1d7040fd0d9d2308bc6646b17dc8e0340228054314a2639d6d98498fd7d129000e5cc90c947ae7fba0
+  metadata.gz: f31cf8a46a495fc85aa2dbd89e467a463044e8d1fdb1712602c497d66c1162be21133ef4362a8679a991aa588f6c3319a8aa8925c249fa9698eaff70c57ba791
+  data.tar.gz: f7e0953538b0091ba7c2c40c4494e91a65032a01d189e7d3366ffeef5dd2a631c12c4a45d759eb0765a29c9bedbf2443076b49bf272b656049981c37430c02c3

data/README.md

@@ -5,11 +5,11 @@ Dossier is a Rails engine that turns SQL into reports. Reports can be easily ren
 - If you **hate** SQL, you can use whatever tool you like to generate it; for example, ActiveRecord's `to_sql`.
 - If you **love** SQL, you can use every feature your database supports.
 
-[![Gem Version](https://badge.fury.io/rb/dossier.png)](https://rubygems.org/gems/dossier)
-[![Code Climate](https://codeclimate.com/github/adamhunter/dossier.png)](https://codeclimate.com/github/adamhunter/dossier)
-[![Build Status](https://travis-ci.org/adamhunter/dossier.png?branch=master)](https://travis-ci.org/adamhunter/dossier)
-[![Coverage Status](https://coveralls.io/repos/adamhunter/dossier/badge.png?branch=master)](https://coveralls.io/r/adamhunter/dossier?branch=master)
-[![Dependency Status](https://gemnasium.com/adamhunter/dossier.png)](https://gemnasium.com/adamhunter/dossier)
+[![Gem Version](https://badge.fury.io/rb/dossier.svg)](http://badge.fury.io/rb/dossier)
+[![Code Climate](https://codeclimate.com/github/tma1/dossier/badges/gpa.svg)](https://codeclimate.com/github/tma1/dossier)
+[![Build Status](https://travis-ci.org/tma1/dossier.svg?branch=master)](https://travis-ci.org/tma1/dossier)
+[![Coverage Status](https://coveralls.io/repos/tma1/dossier/badge.svg?branch=master&service=github)](https://coveralls.io/github/tma1/dossier?branch=master)
+[![Dependency Status](https://gemnasium.com/tma1/dossier.svg)](https://gemnasium.com/tma1/dossier)
 
 ## Setup
 
@@ -137,6 +137,27 @@ class MoneyLaunderingReport < Dossier::Report
 end
 ```
 
+## Hidden Columns
+
+You may override `display_column?` in your report class in order to hide columns from the formatted results. For instance, you might select an employee's ID and name in order to generate a link from their name to their profile page, without actually displaying the ID value itself:
+
+```ruby
+class EmployeeReport < Dossier::Report
+  # ...
+
+  def display_column?(name)
+    name != 'id'
+  end
+
+  def format_name(value, row)
+    url = formatter.url_formatter.url_helpers.employee_path(row['id'])
+    formatter.url_formatter.link_to(value, url)
+  end
+end
+```
+
+By default, all selected columns are displayed.
+
 ## Report Options and Footers
 
 You may want to specify parameters for a report: which columns to show, a range of dates, etc. Dossier supports this via URL parameters, anything in `params[:options]` will be passed into your report's `initialize` method and made available via the `options` reader.
@@ -160,9 +181,13 @@ It's up to you to use these options in generating your SQL query.
 
 However, Dossier does support one URL parameter natively: if you supply a `footer` parameter with an integer value, the last N rows will be accesible via `report.results.footers` instead of `report.results.body`. The built-in `show` view renders those rows inside an HTML footer. This is an easy way to display a totals row or something similar.
 
+## Styling
+
+The default report views use a `<table class="dossier report">` for easy CSS styling.
+
 ## Additional View Customization
 
-To further customize your results view, run the the generator provided. The default will provide 'app/views/dossier/reports/show'.
+To further customize your results view, run the generator provided. The default will provide 'app/views/dossier/reports/show'.
 
 ```ruby
 rails generate dossier:views

data/Rakefile

@@ -1,13 +1,20 @@
-#!/usr/bin/env rake
-
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-Bundler::GemHelper.install_tasks
+require 'rdoc/task'
 
-require 'rails/all'
-require 'dummy/application/tasks'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dossier'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+2.13.1

data/app/controllers/dossier/reports_controller.rb

@@ -17,7 +17,7 @@ module Dossier
     private
 
     def report_class
-      Dossier::Naming.name_to_class(params[:report])
+      Dossier::Model.name_to_class(params[:report])
     end
 
     def report

data/app/views/dossier/reports/show.html.haml

@@ -4,7 +4,7 @@
 
 = render_options(report)
 
-%table
+%table.dossier.report
   %thead
     %tr
       - report.results.headers.each do |header|

data/lib/dossier.rb

@@ -1,5 +1,5 @@
 require "dossier/engine"
-require "dossier/naming"
+require "dossier/model"
 require "dossier/view_context_with_report_formatter"
 require "dossier/version"
 

data/lib/dossier/client.rb

@@ -7,7 +7,10 @@ module Dossier
 
     def initialize(options)
       self.options = options.symbolize_keys
-      self.adapter = dossier_adapter.new(self.options.except(:dossier_adapter))
+    end
+
+    def adapter
+      @adapter ||= dossier_adapter.new(self.options.except(:dossier_adapter))
     end
 
     def dossier_adapter

data/lib/dossier/configuration.rb

@@ -4,6 +4,8 @@ require 'yaml'
 module Dossier
   class Configuration
 
+    DB_KEY = 'DATABASE_URL'.freeze
+
     attr_accessor :config_path, :client
 
     def initialize
@@ -12,25 +14,28 @@ module Dossier
     end
    
     def connection_options
-      yaml_config.merge(dburl_config || {})
+      yaml_config.merge(dburl_config || {}).presence || raise_empty_conn_config
     end
 
     def yaml_config
-      YAML.load(ERB.new(File.read(@config_path)).result)[Rails.env].symbolize_keys
+      YAML.load(ERB.new(File.read(config_path)).result)[Rails.env].symbolize_keys
+    rescue Errno::ENOENT
+      {}
     end
    
     def dburl_config
-      Dossier::ConnectionUrl.new.to_hash if ENV.has_key? "DATABASE_URL"
+      Dossier::ConnectionUrl.new.to_hash if ENV.has_key? DB_KEY
     end
 
     private
 
     def setup_client!
       @client = Dossier::Client.new(connection_options)
+    end
 
-    rescue Errno::ENOENT => e
+    def raise_empty_conn_config
       raise ConfigurationMissingError.new(
-        "#{e.message}. #{@config_path} must exist for Dossier to connect to the database."
+        "Your connection options are blank, you are missing both #{config_path} and ENV['#{DB_KEY}']"
       )
     end
 

data/lib/dossier/{naming.rb → model.rb}

@@ -1,5 +1,5 @@
 module Dossier
-  module Naming
+  module Model
 
     # not using ActiveSupport::Concern because ClassMethods
     # must be extended after ActiveModel::Naming
@@ -28,11 +28,19 @@ module Dossier
       report_name
     end
 
+    def to_model
+      self
+    end
+
+    def persisted?
+      true
+    end
+
     delegate :report_name, :formatted_title, to: "self.class"
 
     module ClassMethods
       def report_name
-        Dossier::Naming.class_to_name(self)
+        Dossier::Model.class_to_name(self)
       end
 
       def formatted_title

data/lib/dossier/multi_report.rb

@@ -1,5 +1,5 @@
 class Dossier::MultiReport
-  include Dossier::Naming
+  include Dossier::Model
 
   attr_accessor :options
 

data/lib/dossier/query.rb

@@ -15,7 +15,7 @@ module Dossier
     private
 
     def compile
-      string.gsub(/\w*\:[a-z]{1}\w*/) { |match| escape(report.public_send(match[1..-1])) }
+      string.gsub(/\w*(?<!:):(?!:)[a-z]{1}\w*/) { |match| escape(report.public_send(match[1..-1])) }
     end
 
     def escape(value)

data/lib/dossier/report.rb

@@ -1,6 +1,6 @@
 module Dossier
   class Report
-    include Dossier::Naming
+    include Dossier::Model
     include ActiveSupport::Callbacks
 
     define_callbacks :build_query, :execute
@@ -38,13 +38,13 @@ module Dossier
     end
 
     def results
-      execute unless defined?(@results)
-      @results
+      execute unless query_results
+      @results ||= Result::Formatted.new(query_results, self)
     end
 
     def raw_results
-      execute unless defined?(@raw_results)
-      @raw_results
+      execute unless query_results
+      @raw_results ||= Result::Unformatted.new(query_results, self)
     end
 
     def run
@@ -59,6 +59,10 @@ module Dossier
       value
     end
 
+    def display_column?(column)
+      true
+    end
+
     def dossier_client
       Dossier.client
     end
@@ -78,15 +82,14 @@ module Dossier
     def execute
       build_query
       run_callbacks :execute do
-        self.results = dossier_client.execute(query, self.class.name)
+        self.query_results = dossier_client.execute(query, self.class.name)
       end
     end
 
-    def results=(results)
-      results.freeze
-      @raw_results = Result::Unformatted.new(results, self)
-      @results     = Result::Formatted.new(results, self)
+    def query_results=(query_results)
+      @query_results = query_results.freeze
     end
+    attr_reader :query_results
 
   end
 end

data/lib/dossier/responder.rb

@@ -1,3 +1,5 @@
+require 'responders' unless defined? ::ActionController::Responder
+
 module Dossier
   class Responder < ::ActionController::Responder
     alias :report :resource

data/lib/dossier/result.rb

@@ -52,7 +52,11 @@ module Dossier
     class Formatted < Result
 
       def headers
-        @formatted_headers ||= raw_headers.map { |h| report.format_header(h) }
+        @formatted_headers ||= raw_headers.select { |h|
+          report.display_column?(h)
+        }.map { |h|
+          report.format_header(h)
+        }
       end
 
       def each
@@ -63,19 +67,32 @@ module Dossier
         unless row.kind_of?(Enumerable)
           raise ArgumentError.new("#{row.inspect} must be a kind of Enumerable") 
         end
+        
+        displayable_columns(row).map { |value, i|
+          column = raw_headers.at(i)
+          apply_formatter(row, column, value)
+        }
+      end
+
+      private
 
-        row.each_with_index.map do |value, i|
+      def displayable_columns(row)
+        row.each_with_index.select { |value, i|
           column = raw_headers.at(i)
-          method = "format_#{column}"
-
-          if report.respond_to?(method)
-            args = [method, value]
-            # Provide the row as context if the formatter takes two arguments
-            args << row_hash(row) if report.method(method).arity == 2
-            report.public_send(*args)
-          else
-            report.format_column(column, value)
-          end
+          report.display_column?(column)
+        }
+      end
+
+      def apply_formatter(row, column, value)
+        method = "format_#{column}"
+
+        if report.respond_to?(method)
+          args = [method, value]
+          # Provide the row as context if the formatter takes two arguments
+          args << row_hash(row) if report.method(method).arity == 2
+          report.public_send(*args)
+        else
+          report.format_column(column, value)
         end
       end
     end

data/lib/dossier/version.rb

@@ -1,3 +1,3 @@
 module Dossier
-  VERSION = "2.12.2"
+  VERSION = File.read(File.expand_path '../../../VERSION', __FILE__).chomp
 end

data/lib/generators/dossier/views/templates/show.html.haml

@@ -4,7 +4,7 @@
 
 = render_options(report)
 
-%table
+%table.dossier.report
   %thead
     %tr
       - report.results.headers.each do |header|

data/spec/dossier/adapter/active_record_spec.rb

@@ -16,7 +16,7 @@ describe Dossier::Adapter::ActiveRecord do
     end
 
     it "returns the connection's escaped value" do
-      ar_connection.stub(:quote).and_return(clean_value)
+      allow(ar_connection).to receive(:quote).and_return(clean_value)
       expect(adapter.escape(dirty_value)).to eq(clean_value)
     end
 
@@ -34,18 +34,18 @@ describe Dossier::Adapter::ActiveRecord do
     end
 
     it "builds an adapter result" do
-      ar_connection.stub(:exec_query).and_return(connection_results)
+      allow(ar_connection).to receive(:exec_query).and_return(connection_results)
       expect(adapter_result_class).to receive(:new).with(connection_results)
       adapter.execute(:query)
     end
 
     it "returns the adapter result" do
-      ar_connection.stub(:exec_query).and_return(connection_results)
+      allow(ar_connection).to receive(:exec_query).and_return(connection_results)
       expect(adapter.execute(:query)).to be_a(adapter_result_class)
     end
 
     it "rescues any errors and raises a Dossier::ExecuteError" do
-      ar_connection.stub(:exec_query).and_raise(StandardError.new('wat'))
+      allow(ar_connection).to receive(:exec_query).and_raise(StandardError.new('wat'))
       expect{ adapter.execute(:query) }.to raise_error(Dossier::ExecuteError)
     end
 

data/spec/dossier/client_spec.rb

@@ -32,48 +32,48 @@ describe Dossier::Client do
 
         it "uses an adapter by that name" do
           expect(Dossier::Adapter::SpecAdapter).to receive(:new).with(username: 'Timmy')
-          described_class.new(dossier_adapter: 'spec_adapter', username: 'Timmy')
+          described_class.new(dossier_adapter: 'spec_adapter', username: 'Timmy').adapter
         end
 
       end
 
       context "when not given a connection or a dossier_adapter option" do
 
-        let(:client)   { described_class.new(username: 'Jimmy') }
+        let(:loaded_orms) { raise 'implement in nested describe' }
+        let(:client)   { 
+          described_class.new(username: 'Jimmy').tap { |c|
+            allow(c).to receive(:loaded_orms).and_return(loaded_orms)
+          }
+        }
 
         describe "if there is one known ORM loaded" do
-          
-          before :each do
-            described_class.any_instance.stub(:loaded_orms).and_return([double(:class, name: 'ActiveRecord::Base')])
-          end
+
+          let(:loaded_orms) { [double(:class, name: 'ActiveRecord::Base')] }
 
           it "uses that ORM's adapter" do
-            expect(Dossier::Adapter::ActiveRecord).to receive(:new).with(username: 'Jimmy')
-            described_class.new(username: 'Jimmy')
+            expect(Dossier::Adapter::ActiveRecord).to(
+              receive(:new).with(username: 'Jimmy'))
+            client.adapter
           end
 
         end
 
         context "if there are no known ORMs loaded" do
-
-          before :each do
-            described_class.any_instance.stub(:loaded_orms).and_return([])
-          end
+          
+          let(:loaded_orms) { [] }
 
           it "raises an error" do
-            expect{described_class.new(username: 'Jimmy')}.to raise_error(Dossier::Client::IndeterminableAdapter)
+            expect{ client.adapter }.to raise_error(Dossier::Client::IndeterminableAdapter)
           end
 
         end
 
         describe "if there are multiple known ORMs loaded" do
-
-          before :each do
-            described_class.any_instance.stub(:loaded_orms).and_return([:orm1, :orm2])
-          end
+          
+          let(:loaded_orms) { [:orm1, :orm2] }
 
           it "raises an error" do
-            expect{described_class.new(username: 'Jimmy')}.to raise_error(Dossier::Client::IndeterminableAdapter)
+            expect{ client.adapter }.to raise_error(Dossier::Client::IndeterminableAdapter)
           end
 
         end
@@ -90,7 +90,7 @@ describe Dossier::Client do
     let(:adapter) { double(:adapter) }
 
     before :each do
-      client.stub(:adapter).and_return(adapter)
+      allow(client).to receive(:adapter).and_return(adapter)
     end
 
     it "delegates `escape` to its adapter" do