raport 0.1.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2924d1fab1b2f7bacc642f5c9fa2c80fa8e2f2a
+  data.tar.gz: f148c28cf17d07a2b44e23da21dd08ddc48b7ff9
+SHA512:
+  metadata.gz: c834f1e09bd1a6f81d22f842d5321a0c7f45479b28a0a4d87acabdb31cf59a6438b0dc4f24c2426731de6ed0575bd57f568ae52d080edd74052d51da31acc440
+  data.tar.gz: 515453848901845411dc4a26ef0b52357ee5706e6b9c4277c67c136c5d53d0bb925ab5d4dedab8529338bea16588e1183f80e73b872afe055d88ec157392b478

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Dominic Breuker
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Raport
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Raport'
+  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'
+
+
+load 'rails/tasks/statistics.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/module Raport/nraport/application_controller.rb"

@@ -0,0 +1,4 @@
+module Raport
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/raport/application_helper.rb

@@ -0,0 +1,9 @@
+module Raport
+  module ApplicationHelper
+    
+    def link_to_report(format = :csv, html_options = nil, &block)
+      html_options.kind_of?(Hash) ? html_options.deep_merge!(data: { report: true }) : html_options = { data: { report: true } }
+      link_to ['.', format].join, url_for(params.merge(format: format)), html_options, &block
+    end
+  end
+end

data/app/jobs/raport/reports_job.rb

@@ -0,0 +1,10 @@
+module Raport
+  class ReportsJob < ActiveJob::Base
+    
+    def perform(report)
+      I18n.with_locale(report.locale) do 
+        Raport::Report::Renderer.new(report).render
+      end
+    end
+  end
+end

data/app/models/raport/report.rb

@@ -0,0 +1,248 @@
+module Raport
+  class Report < ActiveRecord::Base
+
+    #
+    # Constants
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Attribute Settings
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    store :query, accessors: [:joins, :where, :select]
+
+    #
+    # Plugins
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    mount_uploader :file, FileUploader
+
+    #
+    # Concerns
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Scopes
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # State Machine
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    state_machine :state, initial: :pending do
+      state :pending
+      state :active
+      state :finished do
+        validates :file, presence: true
+      end
+      state :failed
+
+      event :pend do
+        transition all => :pending
+      end
+
+      after_transition on: :pend do |report, transition|
+        report.enqueue!
+      end
+
+      event :activate do
+        transition pending: :active
+      end
+
+      event :finish do
+        transition [:active, :failed] => :finished
+      end
+
+      event :flop do
+        transition active: :failed
+      end
+    end
+
+    #
+    # Scopes
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    state_machine.states.each { |state| scope state.name, -> { where(state: state.name.to_s) } }
+
+    scope :by_name, -> (name) { where(name: name) }
+    scope :by_user, -> (user) { where(user_type: user.class.name, user_id: user.id) }
+    scope :active, -> { where(state: [:pending, :activated]) }
+    scope :pendable, -> { where(state: [:finished, :flop]) }
+    scope :daily, -> { by_name(:daily) }
+
+    #
+    # Associations
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    belongs_to :user, polymorphic: true, class_name: ::Admin
+
+    #
+    # Nested Attributes
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Validations
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    validates :name, :query, :resource_class_name, :template, :user_id, :action_name, presence: true
+
+    #
+    # Callbacks
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    before_validation :set_name, on: :create
+
+    after_create :enqueue!
+
+    #
+    # Delegates
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    delegate :email, to: :user, allow_nil: true
+
+    #
+    # Instance Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    def perform!
+      ReportJob.new(id).perform
+    end
+
+    def enqueue!
+      ReportsJob.perform_later(self)
+    end
+
+    def template_path
+      @template_path ||= File.path(template).gsub('app/views', '').split('.').first
+    end
+
+    def format
+      @format ||= template.scan(/\.(.*?)\./).first.first.to_sym
+    end
+
+    def collection
+      @collection ||= begin
+        query = select.present? ? resource_class.select(*select) : resource_class
+        query = query.joins(*joins) if joins.any?
+        query = query.where(where) if where.present?
+        query.uniq
+      end
+    end
+
+    def resource_class
+      @resource_class ||= resource_class_name.constantize
+    end
+
+    def default_filename
+      [I18n.l(Time.zone.now, format: :dashed), action_name ? resource_class.human_attribute_name(action_name) : nil, resource_class.model_name.human(count: :other)].join('-')
+    end
+
+    def filename
+      @filename ||= [name || default_filename, format].join('.').gsub('.csv.csv', '.csv')
+    end
+
+    def tmp_filename
+      @tmp_filename ||= [filename, tmp_file_identifier].join('.')
+    end
+
+    def tmp_file_identifier
+      'tempfile'
+    end
+
+    def permalink(format = nil)
+      [Rails.application.routes.url_helpers.admin_report_path(self.to_param, locale: I18n.locale), format].compact.join('.')
+    end
+    
+    def status_css_classes
+      Admin::BaseController.helpers.status_css_class(state).join(' ')
+    end
+    
+    def display_status_name
+      self.class.human_state_name(state)
+    end
+
+    #
+    # Class Methods
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    #
+    # Protected
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    protected
+
+    #
+    # Private
+    # ---------------------------------------------------------------------------------------
+    #
+    #
+    #
+    #
+
+    private
+
+    def set_name
+      self.name = filename unless name
+    end
+  end
+end

data/app/models/raport.rb

@@ -0,0 +1,5 @@
+module Raport
+  def self.table_name_prefix
+    'raport_'
+  end
+end

data/app/services/raport/report/renderer.rb

@@ -0,0 +1,64 @@
+module Raport
+  class Report
+    class Renderer
+      
+      attr_accessor :report
+      
+      attr_reader :tmpfile, :view
+      
+      def initialize(report)
+        @report = report
+        @view ||= begin
+          view = ActionView::Base.new
+          view.view_paths = ActionController::Base.view_paths
+          view.extend ApplicationHelper
+          view
+        end
+        @tmpfile ||= begin
+          tmpfile = Tempfile.new(report.tmp_filename)
+          tmpfile.write(render_view)
+          tmpfile
+        end
+      end
+      
+      def render
+        begin
+          report.activate
+          report.file = tmpfile
+          report.finish
+        rescue => e
+          report.last_error = [e.message, e.backtrace.join("\n")].join("\n")
+          report.flop
+          raise
+        ensure
+          tmpfile.close
+
+          case tmpfile.class.name
+            when 'Tempfile' then tmpfile.unlink
+            when 'File' then File.unlink(tmpfile.path)
+          end
+        end
+      end
+      
+      private
+      
+      def view_attributes
+        view_attributes = {
+          layout: false,
+          formats: [report.format],
+          template: report.template_path,
+          locals: {
+            collection: report.collection,
+            resource_class: report.resource_class,
+            params: {}
+          }
+        }
+      end
+    
+      def render_view
+        view.render(view_attributes)
+      end
+      
+    end
+  end
+end

data/app/uploaders/raport/file_uploader.rb

@@ -0,0 +1,27 @@
+class Raport::FileUploader < CarrierWave::Uploader::Base
+
+  include CarrierWave::MiniMagick
+
+  storage Settings.carrierwave.storage
+
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  process :set_content_type
+
+  def set_content_type
+    new_content_type = 'binary/octet-stream'
+
+    if file.respond_to?(:content_type=)
+      file.content_type = new_content_type
+    else
+      file.instance_variable_set(:@content_type, new_content_type)
+    end
+  end
+
+  def filename
+    model.respond_to?(:filename) ? model.filename : super
+  end
+
+end

data/config/locales/de.yml

@@ -0,0 +1,27 @@
+de:
+  activerecord:
+    models:
+      raport/report: 
+        one: Bericht
+        other: Berichte
+    attributes:
+      raport/report:
+        name: Name
+        state: Status
+        file: Datei
+        user_id: Besitzer
+        created_at: angelegt
+    state_machines:
+      states:
+        active: aktiv
+        pending: wartend
+        finished: fertig
+        failed: gescheitert
+      events:
+        pend: Starten
+        activate: Aktivieren
+        finish: Beenden
+        flop: Abbrechen
+  time:
+    formats:
+      dashed: "%d-%m-%Y-%H-%M-%S"

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/20151022084502_create_raport_reports.rb

@@ -0,0 +1,18 @@
+class CreateRaportReports < ActiveRecord::Migration
+  def change
+    create_table :raport_reports do |t|
+      t.string :name
+      t.string :state
+      t.string :resource_class_name
+      t.string :file
+      t.string :locale
+      t.text :query, limit: 16777215
+      t.string :template
+      t.string :action_name
+      t.references :user, polymorphic: true, index: true
+      t.datetime :invalid_at
+
+      t.timestamps null: true
+    end
+  end
+end

data/lib/raport/concerns/controllers/reportify.rb

@@ -0,0 +1,62 @@
+module Raport
+  module Reportify
+    extend ActiveSupport::Concern
+    
+    # TODO move this to configuration
+    REPORTABLE_FORMATS  = [:csv]
+  
+    included do
+      helper_method :report_attributes
+      
+      respond_to *REPORTABLE_FORMATS, :html
+      
+      report only: :index
+    end
+  
+    def create_report
+      if REPORTABLE_FORMATS.include?(request.format.to_sym)
+        @report = current_admin.reports.create(report_attributes)
+
+        respond_to do |format|
+          format.any do 
+            if request.xhr?
+              render json: @report.errors.empty? ? @report.as_json(methods: :permalink) : { errors: @report.errors }.to_json
+            else
+              redirect_to polymorphic_path([current_namespace, @report])
+            end
+          end
+        end
+      end
+    end
+  
+    protected
+  
+    def report_attributes
+      {
+        action_name: action_name,
+        select: collection.select_values,
+        joins: collection.joins_values,
+        where: formatted_sql_values(collection.where_values),
+        resource_class_name: resource_class.name, 
+        template: current_template, 
+        locale: I18n.locale
+      }
+    end
+  
+    private
+
+    def formatted_sql_values(values)
+      values.kind_of?(Array) ? values.map { |value| value.respond_to?(:to_sql) ? value.to_sql : value }.join(' AND ') : nil
+    end
+  
+    def current_template
+      lookup_context.find(action_name, lookup_context.prefixes, false, [], formats: [request.format.to_sym]).inspect
+    end
+  
+    class_methods do
+      def report(options = {}, &block)
+        before_action :create_report, options, &block
+      end
+    end
+  end
+end

data/lib/raport/engine.rb

@@ -0,0 +1,19 @@
+require 'raport/concerns/controllers/reportify'
+
+module Raport
+  class Engine < ::Rails::Engine
+    isolate_namespace Raport
+    
+    config.to_prepare do
+      ApplicationController.helper(Raport::ApplicationHelper)
+    end
+      
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/raport/gem_version.rb

@@ -0,0 +1,14 @@
+module Raport
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+    PRE   = 'pre'
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/raport/version.rb

@@ -0,0 +1,7 @@
+require_relative 'gem_version'
+
+module Raport
+  def self.version
+    gem_version
+  end
+end

data/lib/raport.rb

@@ -0,0 +1,4 @@
+require "raport/engine"
+
+module Raport
+end

data/lib/tasks/raport_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :raport do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,5 @@
+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
+end