rexport 1.2.1 → 1.4.0

data/lib/rexport/rexport_model.rb

@@ -1,15 +1,19 @@
-module Rexport #:nodoc:
+# frozen_string_literal: true
+
+module Rexport # :nodoc:
   class RexportModel
     attr_accessor :klass, :path
 
+    delegate :name, to: :klass
+
     def initialize(klass, path: nil)
       self.klass = klass
-      self.path = path.to_s unless path.blank?
+      self.path = path&.to_s
       initialize_rexport_fields
     end
 
     def rexport_fields
-      @rexport_fields ||= HashWithIndifferentAccess.new
+      @rexport_fields ||= ActiveSupport::HashWithIndifferentAccess.new
     end
 
     def rexport_fields_array
@@ -17,7 +21,7 @@ module Rexport #:nodoc:
     end
 
     def field_path(field_name)
-      [path, field_name].compact * '.'
+      [path, field_name].compact * "."
     end
 
     def collection_from_association(association)
@@ -29,13 +33,7 @@ module Rexport #:nodoc:
     end
 
     def filter_column(field)
-      return field.method unless field.method.include?('.')
-      association = field.method.split('.').first
-      klass.reflect_on_association(association.to_sym).foreign_key
-    end
-
-    def name
-      klass.name
+      foreign_key_for(field.association_name) || field.method
     end
 
     # Adds a data item to rexport_fields
@@ -55,33 +53,23 @@ module Rexport #:nodoc:
     #   :filter - if true will send type: :association to add_report_field
     def add_association_methods(options = {})
       options.stringify_keys!
-      options.assert_valid_keys(%w(associations methods filter))
-
-      methods = options.reverse_merge('methods' => 'name')['methods']
-      methods = [methods] if methods.kind_of?(String)
-
-      associations = options['associations']
-      associations = [associations] if associations.kind_of?(String)
+      options.assert_valid_keys(%w[associations methods filter])
 
-      type = options['filter'] ? :association : nil
-
-      associations.each do |association|
-        methods.each do |method|
-          add_rexport_field("#{association}_#{method}", method: "#{association}.#{method}", type: type)
-        end
-      end
+      add_rexport_fields_for(
+        associations: [options["associations"]].flatten,
+        methods:      [options["methods"] || "name"].flatten,
+        type:         (options["filter"] ? :association : nil)
+      )
     end
 
     # Returns an array of export methods corresponding with field_names
     def get_rexport_methods(*field_names)
       field_names.flatten.map do |f|
-        begin
-          components = f.to_s.split('.')
-          field_name = components.pop
-          components.push(get_rexport_model(components).get_rexport_method(field_name)) * '.'
-        rescue NoMethodError
-          'undefined_rexport_field'
-        end
+        components = f.to_s.split(".")
+        field_name = components.pop
+        components.push(get_rexport_model(components).get_rexport_method(field_name)) * "."
+      rescue NoMethodError
+        "undefined_rexport_field"
       end
     end
 
@@ -101,15 +89,23 @@ module Rexport #:nodoc:
 
     # Returns the export method for a given field_name
     def get_rexport_method(field_name)
-      if rexport_fields[field_name]
-        rexport_fields[field_name].method
-      else
-        raise NoMethodError
-      end
+      rexport_fields[field_name]&.method || raise(NoMethodError)
     end
 
     private
 
+    def add_rexport_fields_for(associations:, methods:, type:)
+      associations.each do |association|
+        methods.each do |method|
+          add_rexport_field("#{association}_#{method}", method: "#{association}.#{method}", type: type)
+        end
+      end
+    end
+
+    def foreign_key_for(association_name)
+      klass.reflect_on_association(association_name).foreign_key if association_name.present?
+    end
+
     def initialize_rexport_fields
       klass.content_columns.each { |field| add_rexport_field(field.name, type: field.type) }
       klass.initialize_local_rexport_fields(self) if klass.respond_to?(:initialize_local_rexport_fields)

data/lib/rexport/tree_node.rb

@@ -1,4 +1,6 @@
-module Rexport #:nodoc:
+# frozen_string_literal: true
+
+module Rexport # :nodoc:
   # A basic tree for building up ActiveRecord find :include parameters
   class TreeNode
     attr_accessor :name, :children
@@ -13,7 +15,8 @@ module Rexport #:nodoc:
     # Add one or more children to the tree
     def add_child(*names)
       names.flatten!
-      return unless name = names.shift
+      return unless (name = names.shift)
+
       node = children.find { |c| c.name == name }
       node ? node.add_child(names) : (children << TreeNode.new(name, names))
     end

data/lib/rexport/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rexport
-  VERSION = '1.2.1'
+  VERSION = "1.4.0"
 end

data/lib/rexport.rb

@@ -1,19 +1,22 @@
-require 'rexport/data_field'
-require 'rexport/data_fields'
-require 'rexport/export_filter_methods'
-require 'rexport/export_filters_controller_methods'
-require 'rexport/export_item_methods'
-require 'rexport/export_item_sortings_controller_methods'
-require 'rexport/export_items_controller_methods'
-require 'rexport/export_methods'
-require 'rexport/exports_controller_methods'
-require 'rexport/rexport_model'
-require 'rexport/tree_node'
+# frozen_string_literal: true
+
+require "rexport/data_field"
+require "rexport/data_fields"
+require "rexport/export_filter_methods"
+require "rexport/export_filters_controller_methods"
+require "rexport/export_item_methods"
+require "rexport/export_item_sortings_controller_methods"
+require "rexport/export_items_controller_methods"
+require "rexport/export_methods"
+require "rexport/exports_controller_methods"
+require "rexport/formatter"
+require "rexport/rexport_model"
+require "rexport/tree_node"
 
 module Rexport
   SAMPLE_SIZE = 5
 
   class Engine < ::Rails::Engine
-    config.paths['app/views'] << File.join(File.dirname(__FILE__),'../app/views')
+    config.paths["app/views"] << File.join(File.dirname(__FILE__), "../app/views")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rexport
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Aaron Baldwin
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,58 +25,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.3
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 description: Rexport integrates into a Rails application making model data available
   for export into CSV files.
 email:
-- developers@brightwayslearning.org
+- baldwina@brightwayslearning.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/helpers/exports_helper.rb
 - app/views/export_filters/_export_filter.html.erb
@@ -104,22 +62,17 @@ files:
 - lib/rexport/export_items_controller_methods.rb
 - lib/rexport/export_methods.rb
 - lib/rexport/exports_controller_methods.rb
+- lib/rexport/formatter.rb
 - lib/rexport/rexport_model.rb
 - lib/rexport/tree_node.rb
 - lib/rexport/version.rb
-- test/factories.rb
-- test/test_helper.rb
-- test/unit/data_field_test.rb
-- test/unit/data_fields_test.rb
-- test/unit/export_filter_methods_test.rb
-- test/unit/export_item_methods_test.rb
-- test/unit/export_methods_test.rb
-- test/unit/rexport_model_test.rb
-- test/unit/tree_node_test.rb
 homepage: https://github.com/wwidea/rexport
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/wwidea/rexport
+  source_code_uri: https://github.com/wwidea/rexport
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -128,24 +81,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Ruby on Rails gem to manage exports.
-test_files:
-- test/factories.rb
-- test/test_helper.rb
-- test/unit/data_field_test.rb
-- test/unit/data_fields_test.rb
-- test/unit/export_filter_methods_test.rb
-- test/unit/export_item_methods_test.rb
-- test/unit/export_methods_test.rb
-- test/unit/rexport_model_test.rb
-- test/unit/tree_node_test.rb
+test_files: []

data/README.rdoc

@@ -1,17 +0,0 @@
-=Rexport
-
-Ruby on Rails gem to manage exports
-
-
-==Installation
-1. install gem
-2. copy migration into application db/migrate folder and run
-3. create models and mix in corresponding module
-* export => export_methods
-* export_item => export_item_methods
-* export_filter => export_filter_methods
-
-
-==License
-
-Copyright (c) 2008-2018 Brightways Learning, released under the MIT license

data/test/factories.rb

@@ -1,111 +0,0 @@
-module Rexport
-  module Factories
-
-    FactoryBot.define do
-
-      factory :status do
-        name { 'active' }
-      end
-
-      factory :family do
-        name { 'The Sample Family' }
-      end
-
-      factory :student do
-        family        { |family| family.association(:family) }
-        name          { 'Sammy Sample' }
-        date_of_birth { Date.parse('2008-12-08') }
-      end
-
-      factory :enrollment do
-        status      { |status|  status.association(:status) }
-        student     { |student| student.association(:student) }
-        grade       { 1 }
-        updated_at  { Time.now }
-      end
-
-      factory :second_grade_enrollment, class: 'Enrollment' do
-        status  { |status| status.association(:status) }
-        grade   { 2 }
-      end
-
-      factory :export do
-        name              { 'Enrollment Export' }
-        model_class_name  { 'Enrollment' }
-        export_items do |items|
-          %w(family_name_export_item grade_export_item status_name_export_item bogus_export_item).map do |item|
-            items.association(item)
-          end
-        end
-      end
-
-      factory :filtered_export, class: 'Export' do
-        name              { 'Filtered Enrollment Export' }
-        model_class_name  { 'Enrollment' }
-        export_items do |items|
-          %w(grade_export_item status_name_export_item).map do |item|
-            items.association(item)
-          end
-        end
-        export_filters do |filters|
-          %w(grade_filter status_filter).map do |filter|
-            filters.association(filter)
-          end
-        end
-      end
-
-      factory :invalid_filtered_export, class: 'Export' do
-        name              { 'Invalid Filtered Enrollment Export' }
-        model_class_name  { 'Enrollment' }
-        export_items do |items|
-          %w(grade_export_item status_name_export_item).map do |item|
-            items.association(item)
-          end
-        end
-        export_filters do |filters|
-          %w(invalid_filter).map do |filter|
-            filters.association(filter)
-          end
-        end
-      end
-
-      factory :family_name_export_item, class: 'ExportItem' do
-        position       { 1 }
-        name           { 'Family Name' }
-        rexport_field  { 'student.family.name' }
-      end
-
-      factory :grade_export_item, class: 'ExportItem' do
-        position       { 2 }
-        rexport_field  { 'grade' }
-      end
-
-      factory :status_name_export_item, class: 'ExportItem' do
-        position       { 3 }
-        name           { 'Status' }
-        rexport_field  { 'status_name' }
-      end
-
-      factory :bogus_export_item, class: 'ExportItem' do
-        position       { 4 }
-        name           { 'Bogus Item' }
-        rexport_field  { 'bogus_field' }
-      end
-
-      factory :grade_filter, class: 'ExportFilter' do
-        filter_field   { 'grade' }
-        value          { '1' }
-      end
-
-      factory :status_filter, class: 'ExportFilter' do
-        filter_field   { 'status.name' }
-        value          { 'active' }
-      end
-
-      factory :invalid_filter, class: 'ExportFilter' do
-        filter_field   { 'invalid' }
-        value          { '1' }
-      end
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,167 +0,0 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/test/'
-end
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "rails"
-require 'active_record'
-require "rexport"
-
-require 'minitest/autorun'
-require 'factory_bot'
-require 'mocha/minitest'
-require File.dirname(__FILE__) + '/factories'
-
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
-
-class ActiveSupport::TestCase
-  include FactoryBot::Syntax::Methods
-  include Rexport::Factories
-
-  def setup
-    suppress_output { setup_db }
-    Enrollment.instance_variable_set('@rexport_fields', nil)
-    Student.instance_variable_set('@rexport_fields', nil)
-  end
-
-  def teardown
-    teardown_db
-  end
-
-  private
-
-  def setup_db
-    ActiveRecord::Schema.define(version: 1) do
-      create_table :enrollments do |t|
-        t.integer :student_id, :status_id, :grade
-        t.boolean :active
-        t.timestamps
-      end
-
-      create_table :students do |t|
-        t.integer :family_id
-        t.string :name
-        t.date :date_of_birth
-        t.timestamps
-      end
-
-      create_table :families do |t|
-        t.string :name
-        t.timestamps
-      end
-
-      create_table :statuses do |t|
-        t.string :name
-      end
-
-      create_table :exports do |t|
-        t.string :name
-        t.string :model_class_name
-        t.text :description
-      end
-
-      create_table :export_items do |t|
-        t.integer :export_id
-        t.string :name, :rexport_field
-        t.integer :position
-      end
-
-      create_table :export_filters do |t|
-        t.integer :export_id
-        t.string :filter_field, :value
-      end
-
-      create_table :self_referential_checks do |t|
-      end
-    end
-  end
-
-  def teardown_db
-    ActiveRecord::Base.connection.data_sources.each do |table|
-      ActiveRecord::Base.connection.drop_table(table)
-    end
-  end
-
-  def suppress_output
-    original_stdout = $stdout.clone
-    $stdout.reopen File.new('/dev/null', 'w')
-    yield
-  ensure
-    $stdout.reopen original_stdout
-  end
-end
-
-class ActiveRecord::Base
-  class << self
-    def acts_as_list(options = {})
-    end
-  end
-end
-
-class Enrollment < ActiveRecord::Base
-  include Rexport::DataFields
-  belongs_to :student
-  belongs_to :status
-  belongs_to :ilp_status, class_name: 'Status', foreign_key: 'ilp_status_id'
-  belongs_to :self_referential_check
-
-  def foo
-    'bar'
-  end
-
-  private
-
-  def self.initialize_local_rexport_fields(rexport_model)
-    rexport_model.add_rexport_field(:foo_method, method: :foo)
-    rexport_model.add_rexport_field(:bad_method, method: 'bad_method')
-    rexport_model.add_association_methods(associations: %w(status ilp_status))
-  end
-end
-
-class Student < ActiveRecord::Base
-  include Rexport::DataFields
-  belongs_to :family
-  has_many :enrollments
-
-  def self.find_family_for_rexport
-    Family.order(:name)
-  end
-end
-
-class Family < ActiveRecord::Base
-  include Rexport::DataFields
-  has_many :students
-
-  def foo
-    'bar'
-  end
-
-  private
-
-  def self.initialize_local_rexport_fields(rexport_model)
-    rexport_model.add_rexport_field(:foo_method, method: :foo)
-  end
-end
-
-class Status < ActiveRecord::Base
-  # does not include Rexport
-  has_many :enrollments
-end
-
-class Export < ActiveRecord::Base
-  include Rexport::ExportMethods
-end
-
-class ExportItem < ActiveRecord::Base
-  include Rexport::ExportItemMethods
-end
-
-class ExportFilter < ActiveRecord::Base
-  include Rexport::ExportFilterMethods
-end
-
-class SelfReferentialCheck < ActiveRecord::Base
-  include Rexport::DataFields
-  belongs_to :enrollment
-end

data/test/unit/data_field_test.rb

@@ -1,25 +0,0 @@
-require 'test_helper'
-
-class DataFieldTest < ActiveSupport::TestCase
-  test 'should stringify name' do
-    assert_equal 'foo', Rexport::DataField.new(:foo).name
-  end
-
-  test 'should use name for method' do
-    assert_equal 'foo', Rexport::DataField.new(:foo).method
-  end
-
-  test 'should save method' do
-    assert_equal 'bar', Rexport::DataField.new(:foo, method: :bar).method
-  end
-
-  test 'should save type' do
-    assert_equal :type_test, Rexport::DataField.new(:test, type: :type_test).type
-  end
-
-  test 'should_sort_data_fields' do
-    a = Rexport::DataField.new(:a)
-    b = Rexport::DataField.new(:b)
-    assert_equal [a,b], [b,a].sort
-  end
-end