clark_kent 0.0.1 → 0.1.0

data/test/controllers/clark_kent/reports_controller_test.rb

@@ -3,46 +3,69 @@ require 'test_helper'
 module ClarkKent
   class ReportsControllerTest < ActionController::TestCase
     setup do
-      @report = reports(:one)
+      @report = ClarkKent::Report.first
+      @routes = Engine.routes
+      @current_user = User.first
     end
 
     test "should get index" do
-      get :index
+      get :index, current_user_id: @current_user.id
       assert_response :success
-      assert_not_nil assigns(:reports)
     end
 
     test "should get new" do
-      get :new
+      get :new, current_user_id: @current_user.id
       assert_response :success
     end
 
     test "should create report" do
       assert_difference('Report.count') do
-        post :create, report: { name: @report.name, resource_type: @report.resource_type, sharing_scope_id: @report.sharing_scope_id, sharing_scope_type: @report.sharing_scope_type }
+        post :create,
+          report: {
+            name: 'delete me', resource_type: @report.resource_type,
+            sharing_scope_id: @report.sharing_scope_id, sharing_scope_type: @report.sharing_scope_type },
+          current_user_id: @current_user.id
       end
-
-      assert_redirected_to report_path(assigns(:report))
+      report = Report.find_by(name: 'delete me')
+      report.destroy
+      assert_response :success
     end
 
     test "should show report" do
-      get :show, id: @report
+      get :show, id: @report, current_user_id: @current_user.id
+      assert_response :success
+    end
+
+    test "should show report results" do
+      get :show, id: @report, current_user_id: @current_user.id, run_report: true, created_at_until: Date.today, created_at_from: Date.yesterday
       assert_response :success
+      assert_match 'Guitar strings', @response.body
+    end
+
+    test "should show report run errors" do
+      get :show, id: @report, current_user_id: @current_user.id, run_report: true
+      assert_response :success
+      assert_match 'At least one date range is required.', @response.body
     end
 
     test "should get edit" do
-      get :edit, id: @report
+      get :edit, id: @report, current_user_id: @current_user.id
       assert_response :success
     end
 
     test "should update report" do
-      patch :update, id: @report, report: { name: @report.name, resource_type: @report.resource_type, sharing_scope_id: @report.sharing_scope_id, sharing_scope_type: @report.sharing_scope_type }
-      assert_redirected_to report_path(assigns(:report))
+      patch :update, id: @report,
+        report: {
+          name: @report.name, resource_type: @report.resource_type,
+          sharing_scope_id: @report.sharing_scope_id, sharing_scope_type: @report.sharing_scope_type },
+        current_user_id: @current_user.id
+      assert_response :success
     end
 
     test "should destroy report" do
+      report = Report.create(name: 'delete me', resource_type: 'Order')
       assert_difference('Report.count', -1) do
-        delete :destroy, id: @report
+        delete :destroy, id: report, current_user_id: @current_user.id
       end
 
       assert_redirected_to reports_path

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

@@ -2,4 +2,16 @@ class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
+  def prepare_filters
+    fc_struct = Struct.new(:orders,:departments,:users)
+    @filter_collections = fc_struct.new(::Order.all, ::Department.all, ::User.all)
+  end
+
+  def current_user
+
+    @current_user ||= ::User.where(id: params[:current_user_id]).first || ::User.where("id is not null").first
+    @current_user
+  end
+
+  helper_method :current_user
 end

data/test/dummy/app/models/department.rb

@@ -0,0 +1,4 @@
+class Department < ActiveRecord::Base
+  has_many :users
+  has_many :clark_kent_reports, as: :sharing_scope, class_name: '::ClarkKent::Report'
+end

data/test/dummy/app/models/order.rb

@@ -0,0 +1,6 @@
+class Order < ActiveRecord::Base
+  include Reporting::Order
+  belongs_to :user
+
+  paginates_per 10
+end

data/test/dummy/app/models/reporting/order.rb

@@ -0,0 +1,54 @@
+module Reporting
+  module Order
+    include ClarkKent::ReportConfig
+    # This mapping tells ClarkKent how to use params for filtering a report. It is only used for pre-defined,
+    # standard filtering methods provided by ClarkKent: simple_equality_arel, order_arel, before_date_arel, and after_date_arel. Params that need custom filtering should define their own arel methods that follow
+    # the convention <param name>_arel(query, field_name, match_value). nb. ranges can be handled with dual params like date_before/date_after
+    # or amount_below/amount_above etc.
+    AREL_METHODS ||= {
+      'user_id' => 'simple_equality_arel',
+      'amount_above' => 'above_number_arel',
+      'amount_below' => 'below_number_arel'
+    }
+
+    # These are the options for permanent filters built into a report. nb dates don't make sense as permanent report filters
+    # except in the case of ClarkKent::ReportEmails.
+    REPORT_DEFINITION_OPTIONS ||= ['user_id', 'created_at']
+
+    # This is the full set of report filter options for use at report runtime. REPORT_DEFINITION_OPTIONS must refer to some subset of these
+    REPORT_FILTER_OPTIONS ||= [
+      filter_config(kind: 'date_filter', param: 'created_at', in_required_date_group: true),
+      filter_config(kind: 'object_filter', param: 'user_id', collection: :users, label: 'user'),
+      filter_config(kind: 'string_filter', param: 'user_email')
+    ]
+
+    # These are the available column options for building reports from this resource
+    REPORT_COLUMN_OPTIONS ||= {
+      user_name: column_config(
+        custom_select: "
+        (SELECT u.name
+          FROM users u
+          WHERE u.id = orders.user_id)
+        as user_name"),
+      id: column_config(order_sql: 'orders.id'),
+      amount: column_config(order_sql: 'orders.amount', summarizable: true),
+      description: column_config(order_sql: 'orders.description')
+    }
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.include ClarkKent::Reportable
+    end
+
+    module ClassMethods
+
+      def user_email_arel(query, field_name, match_value)
+        query = query.
+          joins(:user).
+          where(users: {email: match_value})
+      end
+
+    end # ClassMethods
+
+  end
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  has_many :orders
+  has_many :clark_kent_reports, as: :sharing_scope, class_name: '::ClarkKent::Report'
+  belongs_to :department
+
+  def full_name
+    name
+  end
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -3,12 +3,15 @@
 <head>
   <title>Dummy</title>
   <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= stylesheet_link_tag "clark_kent/application.css" %>
   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'clark_kent/application' %>
   <%= csrf_meta_tags %>
 </head>
 <body>
-
-<%= yield %>
+  <div class="container">
+    <%= yield %>
+  </div>
 
 </body>
 </html>

data/test/dummy/config/initializers/zz_clark_kent.rb

@@ -0,0 +1,11 @@
+
+resource_option_struct = Struct.new(:id, :name)
+
+ClarkKent.config({
+  resource_options: [
+    {id: 'Order', name: 'Order'}
+  ],
+  user_class_name: 'User',
+  other_sharing_scopes: [['Department',:department]],
+  base_controller_name: '::ApplicationController'
+})

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
 
-  mount ClarkKent::Engine => "/clark_kent"
+  mount ClarkKent::Engine => "/reports"
 end

data/test/dummy/db/migrate/20150309232850_create_orders.rb

@@ -0,0 +1,10 @@
+class CreateOrders < ActiveRecord::Migration
+  def change
+    create_table :orders do |t|
+      t.integer :user_id
+      t.integer :amount
+      t.string :description
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20150309232855_create_users.rb

@@ -0,0 +1,9 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+      t.integer :age
+    end
+  end
+end

data/test/dummy/db/migrate/20150310143940_create_departments.rb

@@ -0,0 +1,8 @@
+class CreateDepartments < ActiveRecord::Migration
+  def change
+    create_table :departments do |t|
+      t.string :name
+    end
+    add_column :users, :department_id, :integer
+  end
+end

data/test/dummy/db/migrate/20150313144011_create_clark_kent_report_filter.clark_kent.rb

@@ -0,0 +1,18 @@
+# This migration comes from clark_kent (originally 20131226170042)
+class CreateClarkKentReportFilter < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_report_filters do |t|
+    	t.integer :filterable_id
+      t.string :filterable_type, :string, default: 'ClarkKent::Report'
+    	t.string :filter_name
+    	t.string :filter_value
+      t.string :type
+      t.string :duration
+      t.string :kind_of_day
+      t.string :offset
+      t.timestamps
+    end
+  	add_index :clark_kent_report_filters, :filterable_id
+    add_index :clark_kent_report_filters, :filterable_type
+  end
+end

data/test/dummy/db/migrate/20150313144012_create_clark_kent_report_column.clark_kent.rb

@@ -0,0 +1,13 @@
+# This migration comes from clark_kent (originally 20131226170112)
+class CreateClarkKentReportColumn < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_report_columns do |t|
+    	t.integer :report_id
+    	t.string :column_name
+    	t.integer :column_order
+    	t.string :report_sort
+      t.string :summary_method
+    end
+  	add_index :clark_kent_report_columns, :report_id
+  end
+end

data/test/dummy/db/migrate/20150313144013_create_clark_kent_report_emails.clark_kent.rb

@@ -0,0 +1,10 @@
+# This migration comes from clark_kent (originally 20140114010048)
+class CreateClarkKentReportEmails < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_report_emails do |t|
+    	t.integer :report_id
+    	t.string :when_to_send
+      t.string :name
+    end
+  end
+end

data/test/dummy/db/migrate/20150313144014_create_clark_kent_user_report_email.clark_kent.rb

@@ -0,0 +1,8 @@
+# This migration comes from clark_kent (originally 20140129051754)
+class CreateClarkKentUserReportEmail < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_user_report_emails do |t|
+    	t.integer ClarkKent.user_class_name.underscore + '_id', :report_email_id
+    end
+  end
+end

data/test/dummy/db/migrate/20150313144015_create_clark_kent_reports.clark_kent.rb

@@ -0,0 +1,15 @@
+# This migration comes from clark_kent (originally 20150304233739)
+class CreateClarkKentReports < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_reports do |t|
+      t.string :name
+      t.string :resource_type
+      t.string :sharing_scope_type
+      t.integer :sharing_scope_id
+
+      t.timestamps
+    end
+    add_index :clark_kent_reports, :sharing_scope_type
+    add_index :clark_kent_reports, :sharing_scope_id
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,40 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150304233739) do
+ActiveRecord::Schema.define(version: 20150313144015) do
+
+  create_table "clark_kent_report_columns", force: true do |t|
+    t.integer "report_id"
+    t.string  "column_name"
+    t.integer "column_order"
+    t.string  "report_sort"
+    t.string  "summary_method"
+  end
+
+  add_index "clark_kent_report_columns", ["report_id"], name: "index_clark_kent_report_columns_on_report_id"
+
+  create_table "clark_kent_report_emails", force: true do |t|
+    t.integer "report_id"
+    t.string  "when_to_send"
+    t.string  "name"
+  end
+
+  create_table "clark_kent_report_filters", force: true do |t|
+    t.integer  "filterable_id"
+    t.string   "filterable_type", default: "ClarkKent::Report"
+    t.string   "string",          default: "ClarkKent::Report"
+    t.string   "filter_name"
+    t.string   "filter_value"
+    t.string   "type"
+    t.string   "duration"
+    t.string   "kind_of_day"
+    t.string   "offset"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "clark_kent_report_filters", ["filterable_id"], name: "index_clark_kent_report_filters_on_filterable_id"
+  add_index "clark_kent_report_filters", ["filterable_type"], name: "index_clark_kent_report_filters_on_filterable_type"
 
   create_table "clark_kent_reports", force: true do |t|
     t.string   "name"
@@ -22,4 +55,31 @@ ActiveRecord::Schema.define(version: 20150304233739) do
     t.datetime "updated_at"
   end
 
+  add_index "clark_kent_reports", ["sharing_scope_id"], name: "index_clark_kent_reports_on_sharing_scope_id"
+  add_index "clark_kent_reports", ["sharing_scope_type"], name: "index_clark_kent_reports_on_sharing_scope_type"
+
+  create_table "clark_kent_user_report_emails", force: true do |t|
+    t.integer "user_id"
+    t.integer "report_email_id"
+  end
+
+  create_table "departments", force: true do |t|
+    t.string "name"
+  end
+
+  create_table "orders", force: true do |t|
+    t.integer  "user_id"
+    t.integer  "amount"
+    t.string   "description"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", force: true do |t|
+    t.string  "name"
+    t.string  "email"
+    t.integer "age"
+    t.integer "department_id"
+  end
+
 end