mr_common 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb005c3dea79627be3524d98f143154af85c90fdeb4013dcce4f8e391b68ca39
-  data.tar.gz: ee4ee1651df5e88554ca34c7e43c5426fff69d77fe32cc65f8c74607cd51ff0e
+  metadata.gz: 5e0885e32d5643b86e1da2fe11974a06eb9c5a327fd82bd7bebcf8d85484e8ef
+  data.tar.gz: 0e20a6e34659744854a5ed28eac632c92c4b5f7d969ad201d8fa31e31a21944a
 SHA512:
-  metadata.gz: 12f522e9b24e11d31b97f8ada700461fd997e568ab84c4f8e9a9d9d89d7e2f5f74c5d302ac15d95b0ba6e3d089d87b26ff9d19c261b95acf2dad949e9524c9a6
-  data.tar.gz: c2d7a1b9c9e8e8b7c8b5503ce16c0ce17dbc343ad6e7dcbaeb6cbe96079b46a8486d4e1aad581f74f72e96bff9ea3f73c813bfe6e87d346e8e8e73c5f7e68f97
+  metadata.gz: a1070f2831e2216c89b387e6a1fa4c0c0e88519f2d01a0fd93af120cefeeabeed64fc40fe572fbf809c67610f93f86dcbf8936f288b9ced626dc6be1a22cd48e
+  data.tar.gz: 3af9a459afe31200e94a344ac87299f9b09bc3c6a2d2e30156e7ae61a21bcb3dc0ded109747ac462db7a34c87c3120841bdac00219f340e946c10ac7dc4deac7

data/README.md

@@ -10,6 +10,8 @@ Common utilities extracted from starter-reg-site for use elsewhere
 * MrCommon::Concerns::CSVExportable - include to add `.as_csv` to any ActiveRecord model
 
 ## Installation
+Ensure devise is installed and a User class defines the instance method `mr_common_admin?`
+
 Add to Gemfile
 
 ```ruby
@@ -24,10 +26,16 @@ mount MrCommon::Engine, at: '/common'
 # If you plan to use the default registration model, 
 # set the host app's root route to the default registration 
 # form, and override the the templates. (See MrCommon::Reminder for more instructions )
-# root to: "mr_common/registrations/public#new"
+root to: "mr_common/registrations/public#new"
+```
+
+Generate view overrides in the host project
+
+```
+$ bin/rails g mr_common:views
 ```
 
-Configure initializer
+Configure an initializer if you need different values than the defaults listed here
 ```ruby
 # config/initializers/mr_common.rb
 MrCommon.base_controller_name = "::ApplicationController"

data/app/controllers/mr_common/registrations/export_controller.rb

@@ -4,7 +4,10 @@ module MrCommon
   module Registrations
     class ExportController < BaseController
       def index
-        send_data Registration.as_csv, filename: "Registrations-#{Date.today}.csv"
+        send_data(
+          Registration.as_csv(format_rules: Registration.try(:csv_format_rules)),
+          filename: "Registrations-#{Date.today}.csv"
+        )
       end
     end
   end

data/app/models/concerns/mr_common/csv_exportable.rb

@@ -5,17 +5,8 @@ module MrCommon
     extend ActiveSupport::Concern
 
     class_methods do
-      def as_csv
-        CSV.generate do |csv|
-          csv << csv_column_names
-          all.each do |item|
-            csv << item.attributes.values_at(*csv_column_names)
-          end
-        end
-      end
-
-      def csv_column_names
-        column_names
+      def as_csv(adapter: nil, format_rules: nil)
+        CSVExporter.new(self, adapter: adapter, format_rules: format_rules).generate_csv
       end
     end
   end

data/app/models/mr_common/csv_exporter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MrCommon
+  class CSVExporter
+    attr_reader :exportable
+    attr_reader :adapter
+    attr_reader :format_rules
+
+    def initialize(exportable, adapter: nil, format_rules: nil)
+      @exportable = exportable
+      @adapter = adapter ? adapter.new(exportable) : DefaultCSVExportAdapter.new(exportable)
+      @format_rules = format_rules || {}
+    end
+
+    def generate_csv
+      CSV.generate do |csv|
+        csv << adapter.headers
+
+        adapter.collection.each do |item|
+          row = adapter.row_from_item(item)
+          csv << format_row(row)
+        end
+      end
+    end
+
+    def format_row(row)
+      format_rules.each do |column_name, proc|
+        idx = adapter.headers.index(column_name.to_s)
+        row[idx] = proc.call(row[idx])
+      end
+
+      row
+    end
+  end
+end

data/app/models/mr_common/default_csv_export_adapter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module MrCommon
+  class DefaultCSVExportAdapter
+    attr_reader :exportable
+
+    def initialize(exportable)
+      @exportable = exportable
+    end
+
+    def collection
+      exportable.all
+    end
+
+    def row_from_item(item)
+      item.attributes.values_at(*headers)
+    end
+
+    def headers
+      exportable.column_names
+    end
+  end
+end

data/lib/mr_common/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MrCommon
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end