tramway-export 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2db1abd681f33aec113b89d0d4e79e2329258884e3f7cb2258c8640f2f3a23e9
+  data.tar.gz: c58acc9906fa3d6535fdb89d75b7cd10ada709e6994979d492eb3f6334859022
+SHA512:
+  metadata.gz: 68b188497c5fcb65fe07ba35f0a161843951dc7d44d27abc8395c1f85e59a80cf5e1c576e78193e9040c34410df970a17d4a8ef1ecd3fa0850c6dffaaf40de59
+  data.tar.gz: b377e4d1a07c3898ed589aa7a91b59b527ae4c738411bc7aaa7b3b760b51e2cf46b46dbeed85ee3c9327a91078ce754f43687cef09b3ee75a2de4c366cf896da

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Pavel Kalashnikov
+
+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,28 @@
+# Tramway::Export
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tramway-export'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tramway-export
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Tramway::Export'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/tramway_export_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/tramway/export .js
+//= link_directory ../stylesheets/tramway/export .css

data/app/assets/javascripts/tramway/export/application.js

@@ -0,0 +1,2 @@
+//= require rails-ujs
+//= require_tree .

data/app/assets/stylesheets/tramway/export/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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/tramway/export/application_controller.rb

@@ -0,0 +1,9 @@
+module Tramway
+  module Export
+    class ApplicationController < Tramway::Core::ApplicationController
+      protect_from_forgery with: :exception
+
+      include Tramway::ClassNameHelpers
+    end
+  end
+end

data/app/controllers/tramway/export/exports_controller.rb

@@ -0,0 +1,25 @@
+require 'xls_exporter'
+
+class Tramway::Export::ExportsController < Tramway::Export::ApplicationController
+  def show
+    scope = params[:scope].present? ? params[:scope] : :all
+    model_class = model_class_name(params[:model])
+    xlsx_decorator_class = xlsx_decorator_class_name(params[:model])
+    records = xlsx_decorator_class.decorate model_class.active.order(id: :desc).send scope
+
+    book = ::XlsExporter.export do
+      add_sheet 'List'
+
+      export_models records, *xlsx_decorator_class.columns
+    end
+    stream = StringIO.new
+    book.write stream 
+    send_data stream.string, content_type: 'application/xlsx', filename: xlsx_decorator_class.filename
+  end
+
+  private
+  
+  def xlsx_decorator_class_name(model_name)
+    "#{model_name}XlsxDecorator".constantize
+  end
+end

data/app/decorators/tramway/export/application_decorator.rb

@@ -0,0 +1,27 @@
+class Tramway::Export::ApplicationDecorator
+  def initialize(object)
+    @object = object
+  end
+
+  class << self
+    def columns
+      []
+    end
+
+    def filename
+      'export.xlsx'
+    end
+
+    def decorate(array)
+      array.map do |obj|
+        new obj
+      end
+    end
+  end
+
+  private
+
+  def object
+    @object
+  end
+end

data/app/decorators/tramway/export/xlsx/application_decorator.rb

@@ -0,0 +1,8 @@
+module Tramway
+  module Export
+    module Xlsx
+      class ApplicationDecorator < Tramway::Export::ApplicationDecorator
+      end
+    end
+  end
+end

data/app/helpers/tramway/export/application_helper.rb

@@ -0,0 +1,7 @@
+module Tramway
+  module Export
+    module ApplicationHelper
+      include AuthManagement
+    end
+  end
+end

data/app/jobs/tramway/export/application_job.rb

@@ -0,0 +1,6 @@
+module Tramway
+  module Export
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/tramway/export/application_mailer.rb

@@ -0,0 +1,8 @@
+module Tramway
+  module Export
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/tramway/export/application_record.rb

@@ -0,0 +1,7 @@
+module Tramway
+  module Export
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/tramway/export/_button.html.haml

@@ -0,0 +1,10 @@
+- if Tramway::Export.exportable_model? model_class, project: @application_engine
+  - model_name = model_class.name.underscore
+  - id = "export-#{model_name}"
+  .btn-group{ role: :group }
+    %button{ id: id, type: :button, class: 'btn btn-primary dropdown-toggle', data: { toggle: :dropdown, aria: { haspopup: :true, expanded: :false } } }
+      = fa_icon(:download)
+    .dropdown-menu{ aria: { labelledby: id } }
+      - decorator_class.collections.each do |collection|
+        = link_to collection_human_name(model_name: model_name, collection_name: collection), Tramway::Export::Engine.routes.url_helpers.exports_path(model: model_class, scope: collection), class: 'dropdown-item'
+

data/config/routes.rb

@@ -0,0 +1,7 @@
+Tramway::Export::Engine.routes.draw do
+  resources :exports, only: [] do
+    collection do
+      get :show
+    end
+  end
+end

data/lib/tasks/tramway/export_tasks.rake

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

data/lib/tramway/export/engine.rb

@@ -0,0 +1,7 @@
+module Tramway
+  module Export
+    class Engine < ::Rails::Engine
+      isolate_namespace Tramway::Export
+    end
+  end
+end

data/lib/tramway/export/version.rb

@@ -0,0 +1,5 @@
+module Tramway
+  module Export
+    VERSION = '0.1.0'
+  end
+end

data/lib/tramway/export.rb

@@ -0,0 +1,17 @@
+require "tramway/export/engine"
+
+module Tramway
+  module Export
+    class << self
+      def set_exportable_models(*models, project:)
+        @exportable_models ||= {}
+        @exportable_models[project] ||= []
+        @exportable_models[project] += models
+      end
+
+      def exportable_model?(model_class, project:)
+        @exportable_models[project.to_sym]&.include? model_class
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: tramway-export
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Kalashnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xls_exporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails engine for exporting data
+email:
+- kalashnikovisme@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/tramway_export_manifest.js
+- app/assets/javascripts/tramway/export/application.js
+- app/assets/stylesheets/tramway/export/application.css
+- app/controllers/tramway/export/application_controller.rb
+- app/controllers/tramway/export/exports_controller.rb
+- app/decorators/tramway/export/application_decorator.rb
+- app/decorators/tramway/export/xlsx/application_decorator.rb
+- app/helpers/tramway/export/application_helper.rb
+- app/jobs/tramway/export/application_job.rb
+- app/mailers/tramway/export/application_mailer.rb
+- app/models/tramway/export/application_record.rb
+- app/views/tramway/export/_button.html.haml
+- config/routes.rb
+- lib/tasks/tramway/export_tasks.rake
+- lib/tramway/export.rb
+- lib/tramway/export/engine.rb
+- lib/tramway/export/version.rb
+homepage: https://github.com/ulmic/tramway-dev
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Rails engine for exporting data
+test_files: []