mint_reporter 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a1afefaf2a8bdf1dfaa1bf1d367ba5aa182a7cf
+  data.tar.gz: 9fdabc7a849df057a33ec1071311fedecaf5f29a
+SHA512:
+  metadata.gz: 77d9eed2712f0ec4d023cd08493c2109d0e4535a1c605ccf61c5da6c1be3cb01536627bece77ea859bc30fb7d3f5f0da036c5211bac257eeba63934f4a582bec
+  data.tar.gz: 86e9447ad4065e4181dbc59e7486b271bb72df0a0d70effe409e597588ca2329b632deac2bb049719afd8dd09f72e4c6cdf46f40c9763b23cd5514635bd95dc6

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MintReporter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+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

data/app/controllers/admin/reports_controller.rb

@@ -0,0 +1,3 @@
+class Admin::ReportsController < Admin::AdminController
+  # This class generated by mint_admin_tab generator
+end

data/app/models/report.rb

@@ -0,0 +1,86 @@
+class Report < ActiveRecord::Base
+  include AASM
+
+  # CSV Attachment
+  validates_inclusion_of :type, :in => MintReporter.config.reports
+  has_attached_file(:csv, MintReporter.config.paperclip_storage_options)
+  do_not_validate_attachment_file_type :csv
+  after_commit :generate_csv, :on => :create
+
+  ### AASM States ###
+  aasm :column => 'state' do
+    initial_state :pending
+
+    state :pending
+    state :generating_csv
+    state :csv_generated
+    state :csv_ready
+    state :csv_failed
+
+    event :generating_csv do
+      transitions :from => [
+        :pending,
+        :generating_csv,
+        :csv_failed
+      ], :to => :generating_csv
+    end
+    event :csv_generated do
+      transitions :from => [:generating_csv, :csv_generated, :csv_failed],
+       :to => :csv_generated
+    end
+    event :csv_ready  do
+      transitions :from => [:csv_generated, :csv_ready], :to => :csv_ready
+    end
+    event :csv_failure do
+      transitions :from => [:generating_csv, :csv_ready, :csv_failed],
+       :to => :csv_failed
+    end
+  end
+
+  def generate_csv
+    CSVGenerationWorker.perform_async(id)
+  end
+
+  def generate_csv!
+    generating_csv!
+    file = Tempfile.new(["report-#{id}", '.csv'])
+    begin
+      CSV.open(file, "wb") do |csv|
+        csv << csv_column_names
+
+        scoped_records.each do |record|
+          csv << csv_row(record)
+        end
+      end
+      self.csv = file
+      save
+      file.close
+      csv_generated!
+    rescue Exception => e
+      csv_failure!
+      raise e
+    end
+  end
+
+  def csv_column_names
+    raise MintReporter::Undefined,
+      "Subclasses of Report must implement csv_column_names"
+  end
+
+  def csv_row(record)
+    raise MintReporter::Undefined,
+      "Subclasses of Report must implement csv_row"
+  end
+
+  def records
+    raise MintReporter::Undefined,
+      "Subclasses of Report must implement records"
+  end
+
+  private
+
+  def scoped_records
+    records.where(:created_at => from_date..to_date).
+      order(:created_at => :desc)
+  end
+end

data/app/views/admin/reports/_form.html.erb

@@ -0,0 +1,40 @@
+<% if @report.errors.any? %>
+ <div>
+   <h2>
+    <%= pluralize(@report.errors.count, "error") %>
+    prohibited this report from being saved:
+  </h2>
+
+   <ul>
+   <% @report.errors.full_messages.each do |msg| %>
+     <li><%= msg %></li>
+   <% end %>
+   </ul>
+ </div>
+<% end %>
+
+<%= form_for [:admin, @report], :as => :report,
+    :html => {:class => 'report'} do |f| %>
+  <fieldset>
+    <ol>
+      <li>
+        <%= f.label :type %>
+        <%= f.select :type, MintReporter.config.reports %>
+      </li>
+      <li>
+        <%= f.label :from_date %>
+        <%= f.datetime_select :from_date %>
+      </li>
+      <li>
+        <%= f.label :to_date %>
+        <%= f.datetime_select :to_date %>
+      </li>
+    </ol>
+  </fieldset>
+  <div class="submit">
+    <%= f.submit 'Save' %>
+    <span class="alt">or <%=
+      link_to 'cancel', admin_cancel_path(@report)
+    %></span>
+  </div>
+<% end %>

data/app/views/admin/reports/edit.html.erb

@@ -0,0 +1,14 @@
+<% content_for :body_class, 'admin-reports edit' %>
+<% content_for :body_id,    'admin-reports-edit' %>
+<% content_for :page_title, 'Reports - Edit' %>
+
+<% content_for :page_header do %>
+  <h2>
+    <%= link_to 'Reports',
+          admin_reports_path %>
+    &gt; <%=h @report.id %>
+    &gt; edit
+  </h2>
+<% end %>
+
+<%= render 'form' %>

data/app/views/admin/reports/index.html.erb

@@ -0,0 +1,96 @@
+<% content_for :body_class, 'admin-reports index' %>
+<% content_for :body_id,    'admin-reports-index' %>
+<% content_for :page_title, 'Reports' %>
+
+<% content_for :page_header do %>
+  <h2><%= yield :page_title %></h2>
+  <ul class="actions">
+    <li>
+      <%= link_to "Create a new report",
+        new_admin_report_path, :class => 'new' %>
+    </li>
+  </ul>
+<% end %>
+
+<% if @reports.any? %>
+<div class="table-section">
+  <table cellspacing="0" class="stripe">
+    <thead>
+      <tr>
+        <th>Id</th>
+        <th>Type</th>
+        <th>From Date</th>
+        <th>To Date</th>
+        <th>State</th>
+        <th>Report</th>
+        <th>Created at</th>
+        <th>Controls</th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @reports.each do |report| %>
+      <tr>
+        <td>
+          <%= report.id %>
+        </td>
+        <td>
+          <%= report.type %>
+        </td>
+        <td>
+          <span title="<%= time_ago_in_words(report.from_date).html_safe %> ago"><%= admin_time_string(report.from_date).html_safe %></span>        </td>
+        </td>
+        <td>
+          <span title="<%= time_ago_in_words(report.to_date).html_safe %> ago"><%= admin_time_string(report.to_date).html_safe %></span>        </td>
+        </td>
+        <td>
+          <%= report.state %>
+        </td>
+        <td>
+          <% if report.csv.present? %>
+            <%= link_to("download", report.csv.url) %>
+          <% else %>
+            N/A
+          <% end %>
+        </td>
+        <td>
+    <% if report.created_at %>
+          <span title="<%= time_ago_in_words(report.created_at).html_safe %> ago"><%= admin_time_string(report.created_at).html_safe %></span>
+    <% else %>
+    -
+    <% end %>
+        </td>
+        <td class="controls">
+          <ul>
+            <li>
+              <%= link_to 'details',
+                    admin_report_path(report) %>
+            </li>
+            <li>
+              <%= link_to 'edit',
+                    edit_admin_report_path(report) %>
+            </li>
+            <li>
+              <%= form_button_to 'delete',
+                    admin_report_path(report),
+                    :class   => 'text',
+                    :method  => :delete,
+                    :data    =>  {
+                      :confirm => 'Are you sure you want to delete this?'
+                    } %>
+            </li>
+          </ul>
+        </td>
+      </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>
+
+<%= will_paginate @reports %>
+
+<% else %>
+<div class="empty">
+  There are no reports available.
+</div>
+<% end %>

data/app/views/admin/reports/new.html.erb

@@ -0,0 +1,13 @@
+<% content_for :body_class, 'admin-reports new' %>
+<% content_for :body_id,    'admin-reports-new' %>
+<% content_for :page_title, 'Reports - New' %>
+
+<% content_for :page_header do %>
+  <h2>
+    <%= link_to 'Reports',
+          admin_reports_path %>
+    &gt; new
+  </h2>
+<% end %>
+
+<%= render 'form' %>

data/app/views/admin/reports/show.html.erb

@@ -0,0 +1,51 @@
+
+<% content_for :body_class, 'admin-reports show' %>
+<% content_for :body_id,    'admin-reports-show' %>
+<% content_for :page_title, 'Reports' %>
+
+<% content_for :page_header do %>
+  <h2>
+    <%= link_to yield(:page_title), admin_reports_path %> &gt;
+    <%=h @report.id %>
+  </h2>
+  <ul class="actions">
+    <li>
+      <%= link_to 'edit',
+            edit_admin_report_path(@report) %>
+    </li>
+    <li>
+      <%= form_button_to 'delete',
+            admin_report_path(@report),
+            :method  => :delete,
+            :data    => {
+              :confirm => 'Are you sure you want to delete this permanently?'
+            } %>
+    </li>
+  </ul>
+<% end %>
+
+<div id="admin-content">
+  <dl>
+    <dt>state</dt>
+    <dd><%= @report.state %></dd>
+    <dt>report</dt>
+    <% if @report.csv.present? %>
+      <dd><%= link_to('download', @report.csv.url) %>
+    <% else %>
+      <dd>N/A</dd>
+    <% end %>
+    <dt>from_date</dt>
+    <dd><%= @report.from_date %></dd>
+    <dt>to_date</dt>
+    <dd><%= @report.to_date %></dd>
+  </dl>
+
+  <dl class="supplemental">
+    <dt>id</dt>
+    <dd><%=h @report.id %></dd>
+    <dt>created_at</dt>
+    <dd><%=h @report.created_at %></dd>
+    <dt>updated_at</dt>
+    <dd><%=h @report.updated_at %></dd>
+  </dl>
+</div><!-- #admin-content -->

data/app/workers/csv_generation_worker.rb

@@ -0,0 +1,8 @@
+class CSVGenerationWorker
+  include Sidekiq::Worker
+  sidekiq_options :retry => false
+
+  def perform(report_id)
+    Report.find(report_id).generate_csv!
+  end
+end

data/config/initializers/mime_types.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/xls", :xls

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :admin do
+    resources :reports
+  end
+end

data/db/migrate/20140703143528_create_reports.rb

@@ -0,0 +1,16 @@
+class CreateReports < ActiveRecord::Migration
+  def change
+    create_table :reports do |t|
+      t.string :type
+      t.datetime :from_date
+      t.datetime :to_date
+      t.string :csv_file_name
+      t.string :csv_content_type
+      t.integer :csv_file_size
+      t.datetime :csv_updated_at
+      t.string :state
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/mint_report/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate a standard Mint report
+
+Example:
+    rails generate mint_report MyReport
+
+    This will create:
+        app/models/reports/my_report.rb

data/lib/generators/mint_report/mint_report_generator.rb

@@ -0,0 +1,7 @@
+class MintReportGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_mint_report_file
+    template "mint_report.rb", "app/models/reports/#{file_name}.rb"
+  end
+end

data/lib/generators/mint_report/templates/mint_report.rb

@@ -0,0 +1,9 @@
+class <%= class_name %> < Report
+  def csv_column_names
+    super
+  end
+
+  def csv_row(record)
+    super
+  end
+end

data/lib/mint_reporter.rb

@@ -0,0 +1,17 @@
+require "mint_reporter/engine"
+
+require "aasm"
+require "csv"
+require "mint_admin"
+require "paperclip"
+require "sidekiq"
+
+module MintReporter
+  def self.config(&block)
+    @@config ||= MintReporter::Engine::Configuration.new
+    yield @@config if block
+    @@config
+  end
+
+  class Undefined < StandardError ; end
+end