dossier 2.0.0

data/spec/support/reports/employee_report.rb

@@ -0,0 +1,78 @@
+class EmployeeReport < Dossier::Report
+
+  set_callback :build_query, :before, :example_before_hook
+  set_callback :execute,     :after  do
+    # do some stuff
+  end
+
+  # Valid for users to choose via a multi-select
+  def self.valid_columns
+    %w[id name hired_on suspended]
+  end
+
+  def sql
+    "SELECT #{columns} FROM employees WHERE 1=1".tap do |sql|
+      sql << "\n AND division in (:divisions)"  if divisions.any?
+      sql << "\n AND salary > :salary"          if salary?
+      sql << "\n AND (#{names_like})"           if names_like.present?
+      sql << "\n ORDER BY name #{order}"
+    end
+  end
+
+  def columns
+    valid_columns.join(', ').presence || '*'
+  end
+
+  def valid_columns
+    self.class.valid_columns & Array.wrap(options[:columns])
+  end
+
+  def order
+    options[:order].to_s.upcase === 'DESC' ? 'DESC' : 'ASC'
+  end
+
+  def salary
+    10_000
+  end
+
+  def name
+    "%#{names.pop}%"
+  end
+
+  def divisions
+    @divisions ||= options.fetch(:divisions) { [] }
+  end
+
+  def salary?
+    options[:salary].present?
+  end
+
+  def names_like
+    names.map { |name| "name like :name" }.join(' or ')
+  end
+
+  def names
+    @names ||= options.fetch(:names) { [] }.dup
+  end
+
+  def format_salary(amount)
+    formatter.number_to_currency(amount) # unless format.csv?
+  end
+
+  def format_hired_on(date)
+    date.to_s(:db)
+  end
+
+  def format_name(name)
+    "Employee #{name}"
+  end
+
+  def format_suspended(value)
+    value.to_i == 1 ? 'Yes' : 'No'
+  end
+
+  def example_before_hook
+    # do some stuff
+  end
+
+end

data/spec/support/reports/employee_with_custom_client.rb

@@ -0,0 +1,10 @@
+class EmployeeWithCustomClientReport < Dossier::Report
+
+  def sql
+    "SELECT * FROM `employees`"
+  end
+
+  def dossier_client
+    Dossier::Factory.sqlite3_client 
+  end
+end

data/spec/support/reports/sqlite_employee_report.rb

@@ -0,0 +1,15 @@
+class SqliteEmployeeReport < Dossier::Report
+
+  def sql
+    "SELECT * FROM `employees` WHERE name LIKE :name"
+  end
+
+  def name
+    '%Jimmy%'
+  end
+
+  def format_salary(salary)
+    formatter.number_to_currency(salary)
+  end
+
+end

data/spec/support/reports/supended_employee_report.rb

@@ -0,0 +1,7 @@
+class SuspendedEmployeeReport < Dossier::Report
+
+  def sql
+    "SELECT * FROM employees WHERE suspended = true"
+  end
+
+end

data/spec/support/reports/test_report.rb

@@ -0,0 +1,4 @@
+class TestReport < Dossier::Report
+
+end
+

data/spec/support/reports/total_report.rb

@@ -0,0 +1,35 @@
+class TotalReport < Dossier::Report
+
+  def sql
+    <<-SQL.strip_heredoc
+      SELECT
+        business_id, 
+        sum( IF( `year` = '2011', amount, 0 ) ) AS 2011_total,  
+        sum( IF( `year` = '2010', amount, 0 ) ) AS 2010_total, 
+        sum( IF( `year` = '2009', amount, 0 ) ) AS 2009_total 
+      FROM 
+        totals
+      WHERE
+        business_id IN (:businesses)
+      GROUP BY
+        business_id
+    SQL
+  end
+
+  def businesses
+    options.fetch(:businesses) { '' }.split(',')
+  end
+
+  def format_2011_total(value)
+    formatter.currency(value)
+  end
+
+  def format_2010_total(value)
+    formatter.currency(value)
+  end
+
+  def format_2009_total(value)
+    formatter.currency(value)
+  end
+
+end

metadata

@@ -0,0 +1,361 @@
+--- !ruby/object:Gem::Specification
+name: dossier
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Hunter
+- Nathan Long
+- Rodney Turnham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Easy SQL based report generation with the ability to accept request parameters
+  and render multiple formats.
+email:
+- adamhunter@me.com
+- nathanmlong@gmail.com
+- rodney.turnham@tma1.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/dossier/application.js
+- app/assets/stylesheets/dossier/application.css
+- app/controllers/dossier/application_controller.rb
+- app/controllers/dossier/reports_controller.rb
+- app/helpers/dossier/application_helper.rb
+- app/views/dossier/reports/show.html.haml
+- config/routes.rb
+- lib/dossier/adapter/active_record/result.rb
+- lib/dossier/adapter/active_record.rb
+- lib/dossier/client.rb
+- lib/dossier/configuration.rb
+- lib/dossier/engine.rb
+- lib/dossier/formatter.rb
+- lib/dossier/query.rb
+- lib/dossier/report.rb
+- lib/dossier/result.rb
+- lib/dossier/stream_csv.rb
+- lib/dossier/version.rb
+- lib/dossier.rb
+- lib/tasks/dossier_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- spec/dossier/adapter/active_record/result_spec.rb
+- spec/dossier/adapter/active_record_spec.rb
+- spec/dossier/client_spec.rb
+- spec/dossier/configuration_spec.rb
+- spec/dossier/formatter_spec.rb
+- spec/dossier/query_spec.rb
+- spec/dossier/report_spec.rb
+- spec/dossier/result_spec.rb
+- spec/dossier_spec.rb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/site_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/dossier/reports/suspended_employee.html.haml
+- spec/dummy/app/views/dossier/reports/total.html.haml
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml.example
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/setup_load_paths.rb
+- spec/dummy/config.ru
+- spec/dummy/db/schema.rb
+- spec/dummy/dossier_test
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/fixtures/customized_employee_report.html
+- spec/fixtures/db/mysql2.yml.example
+- spec/fixtures/db/sqlite3.yml.example
+- spec/fixtures/employee_report.csv
+- spec/fixtures/employee_report.html
+- spec/fixtures/employee_report_with_footer.html
+- spec/fixtures/employee_with_custom_client.html
+- spec/requests/employee_report_spec.rb
+- spec/requests/employee_with_custom_client_spec.rb
+- spec/routing/dossier_routes_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory.rb
+- spec/support/reports/employee_report.rb
+- spec/support/reports/employee_with_custom_client.rb
+- spec/support/reports/sqlite_employee_report.rb
+- spec/support/reports/supended_employee_report.rb
+- spec/support/reports/test_report.rb
+- spec/support/reports/total_report.rb
+homepage: 
+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'
+      segments:
+      - 0
+      hash: 2096972700425199909
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2096972700425199909
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SQL based report generation.
+test_files:
+- spec/dossier/adapter/active_record/result_spec.rb
+- spec/dossier/adapter/active_record_spec.rb
+- spec/dossier/client_spec.rb
+- spec/dossier/configuration_spec.rb
+- spec/dossier/formatter_spec.rb
+- spec/dossier/query_spec.rb
+- spec/dossier/report_spec.rb
+- spec/dossier/result_spec.rb
+- spec/dossier_spec.rb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/site_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/dossier/reports/suspended_employee.html.haml
+- spec/dummy/app/views/dossier/reports/total.html.haml
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml.example
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/setup_load_paths.rb
+- spec/dummy/config.ru
+- spec/dummy/db/schema.rb
+- spec/dummy/dossier_test
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/fixtures/customized_employee_report.html
+- spec/fixtures/db/mysql2.yml.example
+- spec/fixtures/db/sqlite3.yml.example
+- spec/fixtures/employee_report.csv
+- spec/fixtures/employee_report.html
+- spec/fixtures/employee_report_with_footer.html
+- spec/fixtures/employee_with_custom_client.html
+- spec/requests/employee_report_spec.rb
+- spec/requests/employee_with_custom_client_spec.rb
+- spec/routing/dossier_routes_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory.rb
+- spec/support/reports/employee_report.rb
+- spec/support/reports/employee_with_custom_client.rb
+- spec/support/reports/sqlite_employee_report.rb
+- spec/support/reports/supended_employee_report.rb
+- spec/support/reports/test_report.rb
+- spec/support/reports/total_report.rb