custom_report 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWJjMGQwNmExZjAwNGNmZTExNTNhYzdiZDU4ZTI3OWY1MjcyODFkNg==
+  data.tar.gz: !binary |-
+    MWFlMWRiMzM2N2Q3YzJkMTMwNTg3OGUyM2ExOTRkZWQ3NDk0MzcwMg==
+SHA512:
+  metadata.gz: !binary |-
+    NTZkYWFhYmI3MWE0YTA2ZjU4MjUwODRkZTU1OTU0YzA3YWJjM2YzNjYwMDQ2
+    ZDU4ZGMxODcxNTY0MTk3Yzg0NmYwNDYzMTcwYjhlMjJhM2RlY2M0Mzk2MmM2
+    ODIyZDg5NWQxMWUzMDUwNDljOTU1ZDM0MTBiMmFjNWQ4OWEzMzk=
+  data.tar.gz: !binary |-
+    MmUxMmZlN2M2MzE4OTlhYTljMTNmMjM4YTA2NjA2NTQ1MTgzODdjZDFkMzk3
+    Y2RlNWM0NTMxZjkxMzM5OWQwMDk4N2ZkMDYyYTgyZjY0OGUxMGMwNzhjMTRk
+    N2RjMzFhZDRiMGYxMDJhMDhiZDEyODAwMDFjOGZhZjBlY2YwNjA=

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.2.8"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+gem "slim-rails"
+gem "protected_attributes"
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/Gemfile.lock

@@ -0,0 +1,107 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.1)
+      actionpack (= 4.0.1)
+      mail (~> 2.5.4)
+    actionpack (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+    activerecord (4.0.1)
+      activemodel (= 4.0.1)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.1)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    polyglot (0.3.3)
+    protected_attributes (1.0.3)
+      activemodel (>= 4.0.0, < 5.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.1)
+      actionmailer (= 4.0.1)
+      actionpack (= 4.0.1)
+      activerecord (= 4.0.1)
+      activesupport (= 4.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.1)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.1)
+      actionpack (= 4.0.1)
+      activesupport (= 4.0.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    slim (2.0.1)
+      temple (~> 0.6.6)
+      tilt (>= 1.3.3, < 2.1)
+    slim-rails (2.0.3)
+      actionpack (>= 3.0, < 4.1)
+      activesupport (>= 3.0, < 4.1)
+      railties (>= 3.0, < 4.1)
+      slim (~> 2.0)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    temple (0.6.7)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  protected_attributes
+  rails (>= 3.2.8)
+  slim-rails
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# CustomReport
+
+Create and view custom reports
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'custom_report'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install custom_report
+
+## Usage
+
+In config/initializers/custom_report.rb
+
+    CustomReport.layout = "admin_bootstrap"
+    CustomReport.includes = AuthenticatedAdminSystem
+    CustomReport.admin_class = "Administrator"
+    CustomReport.before_filters = [:authenticate_or_request_admin]
+
+In your routes
+
+    mount CustomReport::Engine => "/custom_report"
+
+This creates the path
+
+    /custom_report/reports
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CustomReport'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/custom_report/reports_controller.rb

@@ -0,0 +1,211 @@
+module CustomReport
+  class ReportsController < ::ApplicationController
+    layout CustomReport.layout
+
+    if CustomReport.includes
+      Array(CustomReport.includes).each do |inc|
+        include inc
+      end
+    end
+
+    if CustomReport.before_filters
+      Array(CustomReport.before_filters).each do |filter|
+        before_filter filter
+      end
+    end
+
+    def index
+      @custom_reports = custom_reports
+    end
+
+    def show
+      @report = custom_report
+      respond_to do |format|
+        format.html {
+          get_the_report
+        }
+        format.csv {
+          params[:dont_paginate] = 1
+          get_the_report
+          render_csv @results, :filename => "#{custom_report.name.parameterize}-#{Time.now.strftime("%Y%m%d%H%M%S")}", :columns => @columns
+        }
+      end
+    end
+
+    def get_the_report
+      begin
+        @filters = []
+
+        @filters.each do |filter|
+          if filter.first == "options"
+            filter.each do |key|
+              next if key == "options"
+              params[key.to_sym] = true
+            end
+          end
+        end
+        @filters.reject! {|f| f.first == "options" }
+
+        @filter_args = params[:filters] || {}
+        @results = @report.generate(params, @filter_args)
+        @iterator = @report.iterator
+        @columns = @report.columns_hash
+        @check_items = @report.report_check_items.group_by(&:item_id)
+
+        @report.update_column(:last_opened, Time.current)
+      rescue Exception => e
+        render :text => "<strong>Error:</strong> <p>#{e.class}: #{e.message}</p><p style='font-family: monospace;'>#{e.backtrace.join("<br>")}</p>"
+      end
+    end
+
+    def new
+      @report = CustomReport::Report.new
+    end
+
+    def create
+      @report = CustomReport::Report.new(
+        :name => params[:report][:name],
+        :category => params[:report][:category],
+        :description => params[:report][:description],
+        :scope => params[:report][:scope],
+        :columns_yaml => params[:report][:columns_yaml]
+        )
+      @report.save
+      redirect_to report_path(@report)
+    end
+
+    def edit
+      set_return_path
+      @report = CustomReport::Report.find(params[:id])
+    end
+
+    def update
+      set_return_path
+      if custom_report.update_attributes({"has_checklist" => "false"}.merge(params[:report]).merge(:administrator_type => CustomReport.admin_class))
+        redirect_to @return_path
+      else
+        render "edit"
+      end
+    end
+
+    def unarchive
+      custom_report.update_column(:deleted_at, nil)
+      redirect_to custom_reports_path(:show_archived => 1)
+    end
+
+    def format_column(entity, column, column_index)
+      format = column[:format] || "text"
+      raw = entity[column_index].to_s
+
+      case format
+      when "text"
+        raw
+      when "strong"
+        "<strong>#{raw}</strong>"
+      when "impersonate"
+        view_context.link_to "Impersonate", impersonate_path(:email => raw)
+      when "eval"
+        raw.html_safe
+      else
+        "unknown formatter: #{format}"
+      end
+    end
+    helper_method :format_column
+
+    def custom_reports
+      scope = CustomReport::Report.order("category,name")
+      scope = scope.where(:administrator_id => params[:show_for]) if params[:show_for].present?
+      scope = scope.where("custom_report_reports.deleted_at IS NULL") unless params[:show_archived].present?
+      scope.group_by(&:category)
+    end
+
+    def custom_report
+      if params[:id]
+        CustomReport::Report.includes(:report_check_items).find params[:id]
+      elsif params[:report]
+        CustomReport::Report.new(params[:report])
+      else
+        CustomReport::Report.new(:name => "Custom Report", :columns => [["Column 1", "some_method"], ["Column 2", "some_other_method"]])
+      end
+    end
+
+    def toggle_check_item
+      @item = CustomReport::ReportCheckItem.where(:report_id => params[:id], :item_id => params[:item_id]).first
+
+      unless @item
+        @item = CustomReport::ReportCheckItem.new
+        @item.report_id = params[:id]
+        @item.item_id = params[:item_id]
+        @item.save!
+      else
+        @item.destroy
+      end
+      render :nothing => true
+    end
+
+    def remove_all_check_items
+      CustomReport::ReportCheckItem.where(:report_id => params[:id]).delete_all
+
+      render :js => "$('.check_item').attr('checked',false);"
+    end
+
+    def destroy
+      custom_report.update_column(:deleted_at, Time.current)
+      redirect_to reports_path
+    end
+
+    private
+
+    def set_return_path
+      @return_path = params[:return_path] || reports_path
+    end
+
+    def my_object
+      "custom_report"
+    end
+
+    def render_csv(iterator, options = {})
+      filename = options[:filename] || "#{params[:action]}-#{Time.now.strftime("%Y%m%d%H%M%S")}"
+      filename << '.csv'
+
+      if request and request.env['HTTP_USER_AGENT'] =~ /msie/i
+        headers['Pragma'] = 'public'
+        headers["Content-type"] = "text/plain"
+        headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
+        headers['Content-Disposition'] = "attachment; filename=\"#{filename}\""
+        headers['Expires'] = "0"
+      else
+        headers["Content-Type"] ||= 'text/csv'
+        headers["Content-Disposition"] = "attachment; filename=\"#{filename}\""
+      end
+
+      text = CSV.generate do |csv|
+        csv << @columns.map { |column| column[:name] }
+
+        iterator.each do |entity|
+          csv << @columns.each_with_index.map do |column, index|
+            format_column(entity, column, index)
+          end
+        end
+      end
+
+      render :layout => false, :inline => text
+    end
+
+    def method_missing(name, *args, &block)
+      main_app.send(name, *args, &block)
+    end
+    helper_method :method_missing
+
+    def administrator_class
+      if CustomReport.admin_class
+        CustomReport.admin_class.constantize
+      else
+        nil
+      end
+    end
+    helper_method :administrator_class
+  end
+
+
+end

data/app/models/custom_report/report.rb

@@ -0,0 +1,77 @@
+module CustomReport
+  class Report < ActiveRecord::Base
+    belongs_to :administrator, :polymorphic => true
+    has_many :report_check_items
+
+    validates_presence_of :name
+
+    validate :unharmful
+
+    serialize :columns
+
+    attr_accessor :iterator
+
+    def generate(options = {}, filter_args = {})
+      result = []
+      ActiveRecord::Base.transaction do
+        # Create the scope
+        begin
+          @iterator = eval(self.scope) unless self.scope.include?("destroy")
+
+          unless options[:dont_paginate]
+            @iterator = @iterator.paginate :page => options[:page], :per_page => (options[:per_page] || 20)
+          end
+
+          # Return an array of hashes
+          result = @iterator.map do |entity|
+            self.columns.map do |column|
+              evaluate(entity, column)
+            end
+          end
+
+        ensure
+          # Always roll back
+          raise ActiveRecord::Rollback
+        end
+      end
+      result
+    end
+
+    def evaluate(entity, column)
+      accessor = if column.is_a?(Hash) and column.size == 1
+        column.values.first
+      else
+        column[1]
+      end
+
+      unless accessor.include?("destroy")
+        entity.instance_eval(accessor)
+      end
+    end
+
+    def columns_yaml=(values)
+      self.columns = YAML::load(values)
+    end
+
+    def columns_yaml
+      self.columns.to_yaml
+    end
+
+    def columns_hash
+      columns.map do |c|
+        if c.is_a?(Array)
+          { :name => c[0], :format => c[2] }
+        else
+          { :name => c.keys.first, :format => nil }
+        end
+      end
+    end
+
+    def unharmful
+      if scope.include?(".destroy")
+        errors.add(:scope, 'Scope cannot destroy - unsafe!')
+      end
+    end
+
+  end
+end

data/app/models/custom_report/report_check_item.rb

@@ -0,0 +1,11 @@
+module CustomReport
+  class ReportCheckItem < ActiveRecord::Base
+    attr_accessible :custom_report_id, :item_id
+
+    belongs_to :report
+
+    validates_presence_of :report_id
+    validates_presence_of :item_id
+
+  end
+end

data/app/views/custom_report/reports/_form.html.slim

@@ -0,0 +1,37 @@
+css:
+  textarea.columns {
+    border: 1px solid #999999;
+    font-family: Consolas,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New, monospace;
+  }
+  textarea {
+    width: 600px;
+  }
+
+= form_for @report, :role => "form" do |f|
+  = hidden_field_tag "return_path", @return_path
+  div.form-group
+    = f.label :name
+    = f.text_field :name, :class => "form-control"
+  - if administrator_class
+    div.form-group
+      = f.label :administrator_id, "Administrator"
+      = f.select :administrator_id, options_for_select([["Everybody", nil]] + administrator_class.all.map { |x| [x.name, x.id] }, f.object.new_record? ? nil : f.object.administrator_id), :class => "form-control"
+  div.form-group
+    = f.label :category
+    = f.text_field :category
+  div.form-group
+    = f.label :description
+    = f.text_area :description, :rows => 5
+  div.form-group
+    = f.label :scope
+    = f.text_area :scope, :size => 110
+  div.form-group
+    = f.label :columns_yaml, "Columns"
+    = f.text_area :columns_yaml, :class => "columns", :cols => 80
+  = f.submit "Save report", :class => "btn btn-default"
+  h3 Advanced
+  div.form-group
+    = f.label :has_checklist
+    = f.check_box(:has_checklist,{}, true, false)
+
+  = f.submit "Save report", :class => "btn btn-default"

data/app/views/custom_report/reports/edit.html.slim

@@ -0,0 +1,3 @@
+h1 Edit Report
+
+= render "form"

data/app/views/custom_report/reports/index.html.slim

@@ -0,0 +1,39 @@
+h1 All reports
+span
+  = link_to "New report", new_report_path, :class => "btn btn-small"
+
+table.table
+  tr
+    th Name
+    th For
+    th Updated at
+    th Last opened
+    th
+    th
+    th
+
+  - @custom_reports.each do |category, reports|
+    tr
+      td colspan="7" style="background-color: #eee; font-weight: bold; border-bottom: 1px solid #ccc;"
+        = category.presence || "No category"
+    - reports.each do |report|
+      tr
+        td
+          = link_to report.name, [report], :style => "color: blue;"
+          = " (deleted)" if report.deleted_at.present?
+        td
+          = report.administrator.try(:name) || report.administrator.try(:personal_name)
+        td
+          = l report.updated_at
+        td
+          = report.last_opened.present? ? l(report.last_opened) : ""
+        td
+          = link_to "CSV", report_path(report, :format => :csv), :class => "btn btn-small"
+        td
+          = link_to "Edit", edit_report_path(report), :class => "btn btn-small"
+        td
+          - if report.deleted_at.nil?
+            = link_to "Archive", report_path(report, :return_path => request.path), :method => :delete, :confirm => "Really?", :class => "btn btn-small btn-warning"
+
+
+= link_to "Show archived", reports_path(:show_archived => true), :class => "btn btn-default"

data/app/views/custom_report/reports/new.html.slim

@@ -0,0 +1,3 @@
+h1 New Report
+
+= render "form"

data/app/views/custom_report/reports/show.html.slim

@@ -0,0 +1,41 @@
+css:
+  form {
+    margin: 0;
+  }
+
+h1
+  = @report.name
+p
+  = link_to "Edit this report", edit_report_path(@report, :return_path => request.fullpath), :class => "btn btn-primary"
+  = " "
+  = link_to "List Reports", reports_path, :class => "btn btn-default"
+p
+  = (@report.description || "").gsub("\n", "<br>").html_safe
+
+= will_paginate @iterator if @iterator.respond_to?(:total_pages)
+
+table.table.table-striped.table-condensed
+  thead
+    tr
+      - @columns.each do |column|
+        th = h column[:name]
+      - if @report.has_checklist
+        th
+          = link_to "Uncheck all", remove_all_check_items_report_path, :method => :post, :remote => true
+
+  tbody
+    - @results.each do |entity|
+      tr
+        - @columns.each_with_index do |column, index|
+          td
+            = format_column(entity, column, index).html_safe
+
+        - if @report.has_checklist
+          td
+            = form_tag toggle_check_item_report_path, :method => :post, :remote => true  do
+              = check_box_tag :item_id, entity[0], @check_items.has_key?(entity[0]) && !@check_items[entity[0]].empty?, :onchange => "$(this).submit();", :class => "check_item"
+
+= will_paginate @iterator if @iterator.respond_to?(:total_pages)
+
+p
+  = link_to "[Download CSV]", request.path + ".csv" + "?#{request.query_string}"

data/config/routes.rb

@@ -0,0 +1,10 @@
+CustomReport::Engine.routes.draw do
+  resources :reports do
+    member do
+      post :remove_all_check_items
+      post :toggle_check_item
+    end
+  end
+
+  root :to => "reports#index"
+end