comma 5.0.0 → 5.1.0

data/gemfiles/rails8.1.3.1.gemfile.lock

@@ -0,0 +1,322 @@
+PATH
+  remote: ..
+  specs:
+    comma (5.1.0)
+      activesupport (>= 4.2.0)
+      csv (>= 3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    action_text-trix (2.1.19)
+      railties
+    actioncable (8.1.3.1)
+      actionpack (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.1.3.1)
+      actionpack (= 8.1.3.1)
+      activejob (= 8.1.3.1)
+      activerecord (= 8.1.3.1)
+      activestorage (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      mail (>= 2.8.0)
+    actionmailer (8.1.3.1)
+      actionpack (= 8.1.3.1)
+      actionview (= 8.1.3.1)
+      activejob (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.1.3.1)
+      actionview (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.1.3.1)
+      action_text-trix (~> 2.1.15)
+      actionpack (= 8.1.3.1)
+      activerecord (= 8.1.3.1)
+      activestorage (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.1.3.1)
+      activesupport (= 8.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.1.3.1)
+      activesupport (= 8.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (8.1.3.1)
+      activesupport (= 8.1.3.1)
+    activerecord (8.1.3.1)
+      activemodel (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      timeout (>= 0.4.0)
+    activestorage (8.1.3.1)
+      actionpack (= 8.1.3.1)
+      activejob (= 8.1.3.1)
+      activerecord (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      marcel (~> 1.0)
+    activesupport (8.1.3.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (1.0.3)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (4.1.2)
+    builder (3.3.0)
+    cgi (0.5.2)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crass (1.0.7)
+    csv (3.3.6)
+    date (3.5.1)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    erb (6.0.7)
+    erubi (1.13.1)
+    globalid (1.4.0)
+      activesupport (>= 6.1)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    io-console (0.9.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.21.2)
+    logger (1.7.0)
+    loofah (2.25.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.9.1)
+      logger
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.2.1)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
+    minitest (5.27.0)
+    mize (0.6.1)
+    mutex_m (0.3.0)
+    net-imap (0.6.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.3.0)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.5)
+    nokogiri (1.19.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.19.4-x86_64-linux-gnu)
+      racc (~> 1.4)
+    ostruct (0.6.3)
+    parallel (1.28.0)
+    parser (3.3.12.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    racc (1.8.1)
+    rack (3.2.7)
+    rack-session (2.1.2)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.3.1)
+      rack (>= 3)
+    rails (8.1.3.1)
+      actioncable (= 8.1.3.1)
+      actionmailbox (= 8.1.3.1)
+      actionmailer (= 8.1.3.1)
+      actionpack (= 8.1.3.1)
+      actiontext (= 8.1.3.1)
+      actionview (= 8.1.3.1)
+      activejob (= 8.1.3.1)
+      activemodel (= 8.1.3.1)
+      activerecord (= 8.1.3.1)
+      activestorage (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 8.1.3.1)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.7.1)
+      loofah (~> 2.25, >= 2.25.2)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.3.1)
+      actionpack (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbs (4.1.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    readline (0.0.4)
+      reline
+    regexp_parser (2.12.0)
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-activemodel-mocks (1.3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      rspec-mocks (>= 2.99, < 4.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-its (2.0.0)
+      rspec-core (>= 3.13.0)
+      rspec-expectations (>= 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (8.0.4)
+      actionpack (>= 7.2)
+      activesupport (>= 7.2)
+      railties (>= 7.2)
+      rspec-core (>= 3.13.0, < 5.0.0)
+      rspec-expectations (>= 3.13.0, < 5.0.0)
+      rspec-mocks (>= 3.13.0, < 5.0.0)
+      rspec-support (>= 3.13.0, < 5.0.0)
+    rspec-support (3.13.7)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (2.9.6)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.9.6-x86_64-linux-gnu)
+    sync (0.5.0)
+    term-ansicolor (1.11.3)
+      tins (~> 1)
+    thor (1.5.0)
+    timeout (0.6.1)
+    tins (1.56.0)
+      bigdecimal
+      irb
+      mize (~> 0.6)
+      readline
+      sync
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    websocket-driver (0.8.2)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.8.3)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  appraisal (~> 1.0.0)
+  base64
+  benchmark
+  bigdecimal
+  cgi
+  comma!
+  coveralls
+  drb
+  logger
+  minitest (= 5.27.0)
+  mutex_m
+  ostruct
+  rails (= 8.1.3.1)
+  rake (~> 13.0.1)
+  rspec (~> 3.13)
+  rspec-activemodel-mocks
+  rspec-its
+  rspec-rails
+  rubocop (~> 1.30.0)
+  rubocop-performance
+  sqlite3
+
+BUNDLED WITH
+   2.5.5

data/lib/comma/array.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
 class Array
-  def to_comma(style = :default)
-    Comma::Generator.new(self, style).run(:each)
-  end
+  include Comma::CollectionExport
 end

data/lib/comma/collection_export.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Comma
+  module CollectionExport
+    def to_comma(style = :default)
+      Comma::Generator.new(self, style).run(:each)
+    end
+  end
+end

data/lib/comma/data_extractor.rb

@@ -49,28 +49,24 @@ module Comma
       end
     end
 
-    def method_missing(sym, *args, &block)
-      @results << ExtractValueFromInstance.new(@instance).extract(sym, &block) if
-        args.blank?
-
-      args.each do |arg|
-        case arg
-        when Hash
-          arg.each do |k, _v|
-            @results << ExtractValueFromAssociationOfInstance.new(@instance, sym).extract(k, &block)
-          end
-        when Symbol
-          @results << ExtractValueFromAssociationOfInstance.new(@instance, sym).extract(arg, &block)
-        when String
-          @results << ExtractValueFromInstance.new(@instance).extract(sym, &block)
-        else
-          raise "Unknown data symbol #{arg.inspect}"
-        end
-      end
-    end
-
     def __static_column__(_header = nil, &block)
       @results << (block ? yield(@instance) : nil)
     end
+
+    private
+
+    def extract_column(method, association: nil, **, &block)
+      value_extractor(association).extract(method, &block)
+    end
+
+    def value_extractor(association)
+      return ExtractValueFromInstance.new(@instance) unless association
+
+      ExtractValueFromAssociationOfInstance.new(@instance, association)
+    end
+
+    def column_kind
+      'data'
+    end
   end
 end

data/lib/comma/data_mapper_collection.rb

@@ -3,9 +3,7 @@
 if defined?(DataMapper)
   module DataMapper
     class Collection
-      def to_comma(style = :default)
-        Comma::Generator.new(self, style).run(:each)
-      end
+      include Comma::CollectionExport
     end
   end
 end

data/lib/comma/extractor.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 module Comma
+  class CircularStyleReference < StandardError; end
+
   class Extractor
     def initialize(instance, style, formats)
       @instance = instance
       @style = style
       @formats = formats
       @results = []
+      @style_stack = [style]
     end
 
     def results
@@ -19,8 +22,36 @@ module Comma
     end
 
     def __use__(style)
-      # TODO: prevent infinite recursion
-      instance_eval(&@formats[style])
+      if @style_stack.include?(style)
+        chain = (@style_stack + [style]).join(' -> ')
+        raise Comma::CircularStyleReference, "Circular __use__ reference detected: #{chain}"
+      end
+
+      format = @formats.fetch(style) { raise "No comma format defined for style #{style}" }
+
+      @style_stack.push(style)
+      begin
+        instance_eval(&format)
+      ensure
+        @style_stack.pop
+      end
+    end
+
+    def method_missing(sym, *args, &block)
+      @results << extract_column(sym, &block) if args.empty?
+
+      args.each do |arg|
+        case arg
+        when Hash
+          arg.each { |k, v| @results << extract_column(k, association: sym, label: v, &block) }
+        when Symbol
+          @results << extract_column(arg, association: sym, label: arg, &block)
+        when String
+          @results << extract_column(sym, label: arg, &block)
+        else
+          raise "Unknown #{column_kind} symbol #{arg.inspect}"
+        end
+      end
     end
 
     private

data/lib/comma/generator.rb

@@ -4,14 +4,10 @@ module Comma
   class Generator
     def initialize(instance, style)
       @instance = instance
-      @style    = style
-      @options  = {}
-
-      return unless @style.is_a?(Hash)
-
-      @options                  = @style.clone
-      @style                    = @options.delete(:style) || Comma::DEFAULT_OPTIONS[:style]
-      @filename                 = @options.delete(:filename)
+      parsed = Comma::Options.parse(style)
+      @style = parsed[:style]
+      @filename = parsed[:filename]
+      @options = parsed[:csv]
     end
 
     def run(iterator_method)

data/lib/comma/header_extractor.rb

@@ -16,31 +16,22 @@ module Comma
     end
     self.value_humanizer = DEFAULT_VALUE_HUMANIZER
 
-    def method_missing(sym, *args, &_block)
-      model_class = @instance.class
-      @results << value_humanizer.call(sym, model_class) if args.blank?
-      args.each do |arg|
-        case arg
-        when Hash
-          arg.each do |_k, v|
-            @results << value_humanizer.call(v, get_association_class(model_class, sym))
-          end
-        when Symbol
-          @results << value_humanizer.call(arg, get_association_class(model_class, sym))
-        when String
-          @results << value_humanizer.call(arg, model_class)
-        else
-          raise "Unknown header symbol #{arg.inspect}"
-        end
-      end
-    end
-
     def __static_column__(header = '', &_block)
       @results << header
     end
 
     private
 
+    def extract_column(method, association: nil, label: nil, **)
+      model_class = @instance.class
+      target_class = association ? get_association_class(model_class, association) : model_class
+      value_humanizer.call(label || method, target_class)
+    end
+
+    def column_kind
+      'header'
+    end
+
     def get_association_class(model_class, association)
       return unless model_class.respond_to?(:reflect_on_association)
 

data/lib/comma/mongoid.rb

@@ -6,9 +6,7 @@ begin
 
   module Mongoid
     class Criteria
-      def to_comma(style = :default)
-        Comma::Generator.new(self, style).run(:each)
-      end
+      include Comma::CollectionExport
     end
   end
 rescue LoadError => e

data/lib/comma/object.rb

@@ -4,19 +4,43 @@ require 'comma/data_extractor'
 require 'comma/header_extractor'
 
 class Object
-  class_attribute :comma_formats
-
   class << self
     def comma(style = :default, &block)
-      (self.comma_formats ||= {})[style] = block
+      own_comma_formats[style] = block
+    end
+
+    def comma_formats
+      classes_with_own_formats.reverse_each.each_with_object({}) do |klass, formats|
+        formats.merge!(klass.instance_variable_get(:@own_comma_formats))
+      end
+    end
+
+    private
+
+    def own_comma_formats
+      @own_comma_formats ||= {}
     end
 
-    def inherited(subclass)
-      super
-      subclass.comma_formats = self.comma_formats ? self.comma_formats.dup : {}
+    # `self` here is always a Class: `comma`/`comma_formats` live on Object's
+    # singleton class, which only plain Class objects mirror, so a bare
+    # Module can never reach this method to begin with. `Class#superclass`
+    # in turn only ever yields another Class or nil, so `klass` stays a
+    # Class for the whole walk.
+    def classes_with_own_formats
+      classes = []
+      klass = self
+      while klass
+        classes << klass if klass.instance_variable_defined?(:@own_comma_formats)
+        klass = klass.superclass
+      end
+      classes
     end
   end
 
+  def comma_formats
+    self.class.comma_formats
+  end
+
   def to_comma(style = :default)
     extract_with(Comma::DataExtractor, style)
   end
@@ -28,13 +52,15 @@ class Object
   private
 
   def extract_with(extractor_class, style = :default)
-    raise_unless_style_exists(style)
-    extractor_class.new(self, style, self.comma_formats).results
+    formats = comma_formats
+    raise_unless_style_exists(formats, style)
+    extractor_class.new(self, style, formats).results
   end
 
-  def raise_unless_style_exists(style)
-    return if self.comma_formats && self.comma_formats[style]
+  def raise_unless_style_exists(formats, style)
+    return if formats[style]
 
-    raise "No comma format for class #{self.class} defined for style #{style}"
+    receiver = is_a?(Module) ? self : self.class
+    raise "No comma format for class #{receiver} defined for style #{style}"
   end
 end

data/lib/comma/options.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Comma
+  module Options
+    module_function
+
+    def parse(input)
+      return { style: input, filename: nil, csv: {} } unless input.is_a?(Hash)
+
+      csv = input.dup
+      style = csv.delete(:style) || Comma::DEFAULT_OPTIONS[:style]
+      filename = csv.delete(:filename)
+      csv[:write_headers] = csv[:write_headers] != 'false' if csv[:write_headers].is_a?(String)
+
+      { style: style, filename: filename, csv: csv }
+    end
+  end
+end

data/lib/comma/rails/renderer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+if defined?(ActionController::Renderers) && ActionController::Renderers.respond_to?(:add)
+  ActionController::Renderers.add :csv do |obj, options|
+    filename    = options[:filename]  || 'data'
+    extension   = options[:extension] || 'csv'
+    mime_type = if Rails.gem_version >= Gem::Version.new('5.0.0')
+                  options[:mime_type] || Mime[:csv]
+                else
+                  options[:mime_type] || Mime::CSV
+                end
+    with_bom = options.delete(:with_bom) || false
+
+    # Capture any CSV optional settings passed to comma or comma specific options
+    csv_options = options.slice(*CSV_HANDLER::DEFAULT_OPTIONS.merge(Comma::DEFAULT_OPTIONS).keys)
+    data = obj.to_comma(csv_options)
+    data = "\xEF\xBB\xBF#{data}" if with_bom
+    disposition = "attachment; filename=\"#{filename}.#{extension}\""
+    send_data data, type: mime_type, disposition: disposition
+  end
+end

data/lib/comma/rails.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load(:active_record) do
+  require 'comma/relation' if defined?(ActiveRecord::Relation)
+end
+
+ActiveSupport.on_load(:mongoid) do
+  require 'comma/mongoid'
+end
+
+ActiveSupport.on_load(:action_controller) do
+  require 'comma/rails/renderer'
+end

data/lib/comma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Comma
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end