as_csv 2.0.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5286ae39a5fc09dac9e92a8cd97e3c3ff88b9115
-  data.tar.gz: 97362f687b28ee4734d89aaf0a6e36f0dd31f6c0
+SHA256:
+  metadata.gz: 8af870672a5c660bf534d462e8bc5cb16b4212a944c6ea471196f54cc5c422f6
+  data.tar.gz: fb419f709a93da5293e05315b2ffa0cb41c3adb9d3dc81b61534717198e3dfbd
 SHA512:
-  metadata.gz: fcde99eea906d30932c5a1ca484b2f0832f628e41d4f98735723657973c9688a4b7e558d04cf803b8f37f71e12b411345d0396d6c95f6c71a40a32cefc02fb5c
-  data.tar.gz: 8bbb23771b9173494b54e3aa001dcab49d83f87bb4b922b49c3667dbb57bae53b31ccc50c905297cfdd44a8060b702f30136af27ef2967b448df3169f24cd073
+  metadata.gz: 821778f8b9ba8e2ec23297361cd1d5311a824a9c153fabf1a5c2bbe6a9c669ef62c28f3b45825e1496ace0fd2e866a17dd51613a81f74fefeb4ef5550cc83567
+  data.tar.gz: 3057fef0b1dea2f0d353e2094a377544527d0e1209ca2139e7cfe6019c425dab4f0262d7069b45437c2b84b33b8e4c8cff44c39c792d1d1e8d3d86ff0029c390

data/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.1] - 2022-11-08
+
+### Fixed
+
+- Improved support for Rails 7 by using a proper Railtie.
+
+## [3.0.0] - 2022-11-08
+
+### Added
+
+- Added support for Ruby 3.
+- Added support for Rails 5, 6, and 7.
+- Added `Enumerable#as_csv` to support ActiveRecord::Relation.
+
+### Changed
+
+- Serialization follows modern Rails pattern.
+- Simplified tests.
+- CI now only checks Ruby 2.6, 2.7, and 3.0, along with Rails 5, 6 and 7.
+
+### Removed
+
+- Dropped explicit dependency on responders gem
+
 ## [2.0.2] - 2015-03-21
 
 ### Changed
@@ -20,6 +44,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Pretty sure this is actually backwards compat. Sorry.
 
+[3.0.0]: https://github.com/danielfone/as_csv/compare/v2.0.2...v3.0.0
 [2.0.2]: https://github.com/danielfone/as_csv/compare/v2.0.1...v2.0.2
 [2.0.1]: https://github.com/danielfone/as_csv/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/danielfone/as_csv/compare/v1.0.2...v2.0.0

data/README.md

@@ -1,44 +1,23 @@
 # AsCSV
 
 [![Gem Version](https://badge.fury.io/rb/as_csv.svg)](http://badge.fury.io/rb/as_csv)
-[![Build Status](https://travis-ci.org/danielfone/as_csv.svg)](https://travis-ci.org/danielfone/as_csv)
-[![Dependency Status](https://gemnasium.com/danielfone/as_csv.svg)](https://gemnasium.com/danielfone/as_csv)
 [![Code Climate](https://codeclimate.com/github/danielfone/as_csv/badges/gpa.svg)](https://codeclimate.com/github/danielfone/as_csv)
 
 This gem allows you to expose CSV in your apps as you'd expose JSON or XML.
 
 Rails is not strictly required, but currently the magic only works with Rails > 3.x.x.
 
-Ruby 1.8 will work, but by default the order of the columns will not be guaranteed.
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'as_csv', '~> 2.0'
+gem 'as_csv', '~> 3.0'
 ```
 
 ## Basic Usage
 
-Simply add `respond_to :csv` in a controller
-
-```ruby
-class WidgetsController < ApplicationController
-  respond_to :xml, :json, :csv
-
-  def index
-    respond_with Widget.all
-  end
-
-  def show
-    respond_with Widget.find(params[:id])
-  end
-
-end
-```
-
-Alternatively:
+Simply render CSV in a controller
 
 ```ruby
 class WidgetsController < ApplicationController
@@ -184,5 +163,3 @@ bar2|bar2-description||xyz98765
 6. Commit your changes (`git commit -am 'Add some feature'`)
 7. Push to the branch (`git push origin my-new-feature`)
 8. Create new Pull Request
-
-

data/lib/as_csv/active_model/serialization/csv.rb

@@ -0,0 +1,17 @@
+require 'as_csv/csv_builder'
+
+module AsCSV
+  module ActiveModel
+    module Serialization
+      module CSV
+        def as_csv(options={})
+          attributes
+        end
+
+        def to_csv(*args)
+          AsCSV::CSVBuilder.new(self, *args).to_csv
+        end
+      end
+    end
+  end
+end

data/lib/as_csv/core_ext/enumerable.rb

@@ -0,0 +1,10 @@
+require 'csv'
+require 'as_csv/csv_builder'
+
+module Enumerable
+
+  def to_csv(opts={})
+    AsCSV::CSVBuilder.new(self, opts).to_csv
+  end
+
+end

data/lib/as_csv/csv_builder.rb

@@ -12,7 +12,7 @@ module AsCSV
     end
 
     def to_csv
-      rows.collect { |row| CSV.generate_line row, csv_options }.join
+      rows.collect { |row| CSV.generate_line(row, **csv_options) }.join
     end
 
     private

data/lib/as_csv/railtie.rb

@@ -1,16 +1,27 @@
-require 'as_csv/csv_builder'
+require 'as_csv/active_model/serialization/csv'
 
-module ActiveModel::Serialization
-  def as_csv(options={})
-    attributes
-  end
+# Use the Railtie to hook into the Rails initialization process
+module AsCsv
+  class Railtie < Rails::Railtie
 
-  def to_csv(*args)
-    AsCSV::CSVBuilder.new(self, *args).to_csv
-  end
-end
+    initializer "as_csv" do
+
+      # Include the CSV serialization module into ActiveRecord::Base and
+      # ActiveModel::Serialization
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, AsCSV::ActiveModel::Serialization::CSV
+        ActiveModel::Serialization.send :include, AsCSV::ActiveModel::Serialization::CSV
+      end
 
-ActionController::Renderers.add :csv do |obj, options|
-  response.headers['Content-Disposition'] = 'attachment'
-  obj.respond_to?(:to_csv) ? obj.to_csv(options) : obj
+      # Add a :csv renderer to ActionController::Renderers
+      ActiveSupport.on_load :action_controller do
+        ActionController::Renderers.add :csv do |obj, options|
+          response.headers['Content-Disposition'] = 'attachment'
+          obj.respond_to?(:to_csv) ? obj.to_csv(options) : obj
+        end
+      end
+
+    end
+
+  end
 end

data/lib/as_csv/version.rb

@@ -1,3 +1,3 @@
 module AsCSV
-  VERSION = "2.0.2"
+  VERSION = "3.0.1"
 end

data/lib/as_csv.rb

@@ -1,3 +1,4 @@
 require "as_csv/version"
 require "as_csv/core_ext/array"
-require "as_csv/railtie"
+require "as_csv/core_ext/enumerable"
+require "as_csv/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_csv
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.1
 platform: ruby
 authors:
 - Daniel Fone
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,56 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: responders
-  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'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +70,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -115,70 +101,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- as_csv.gemspec
 - lib/as_csv.rb
+- lib/as_csv/active_model/serialization/csv.rb
 - lib/as_csv/core_ext/array.rb
+- lib/as_csv/core_ext/enumerable.rb
 - lib/as_csv/csv_builder.rb
 - lib/as_csv/railtie.rb
 - lib/as_csv/version.rb
-- script/rspec
-- spec/controllers/render_widgets_controller_spec.rb
-- spec/controllers/respond_with_widgets_controller_spec.rb
-- spec/core_ext/array_spec.rb
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/images/rails.png
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/render_widgets_controller.rb
-- spec/dummy/app/controllers/respond_with_widgets_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/models/widget.rb
-- spec/dummy/app/models/widget_with_options.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/seeds.rb
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/index.html
-- spec/dummy/public/robots.txt
-- spec/dummy/script/rails
-- spec/lib/csv_builder_spec.rb
-- spec/models/active_model_spec.rb
-- spec/models/widget_spec.rb
-- spec/models/widget_with_options_spec.rb
-- spec/rails_helper.rb
-- spec/spec_helper.rb
-- spec/support/widgets_controller_mixin.rb
 homepage: https://github.com/danielfone/as_csv
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,54 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.3.23
+signing_key:
 specification_version: 4
 summary: Instant CSV support for Rails
-test_files:
-- spec/controllers/render_widgets_controller_spec.rb
-- spec/controllers/respond_with_widgets_controller_spec.rb
-- spec/core_ext/array_spec.rb
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/images/rails.png
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/render_widgets_controller.rb
-- spec/dummy/app/controllers/respond_with_widgets_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/models/widget.rb
-- spec/dummy/app/models/widget_with_options.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/seeds.rb
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/index.html
-- spec/dummy/public/robots.txt
-- spec/dummy/script/rails
-- spec/lib/csv_builder_spec.rb
-- spec/models/active_model_spec.rb
-- spec/models/widget_spec.rb
-- spec/models/widget_with_options_spec.rb
-- spec/rails_helper.rb
-- spec/spec_helper.rb
-- spec/support/widgets_controller_mixin.rb
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-spec/dummy/db/*.sqlite3
-spec/dummy/log/*.log
-spec/dummy/tmp/
-spec/dummy/.sass-cache
-.rbx
-Gemfile.lock

data/.rspec

@@ -1 +0,0 @@
---color

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-script: bundle exec rspec
-rvm:
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in as_csv.gemspec
-gemspec
-
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/as_csv.gemspec

@@ -1,26 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path '../lib/as_csv/version', __FILE__
-
-Gem::Specification.new do |gem|
-  gem.name          = "as_csv"
-  gem.version       = AsCSV::VERSION
-  gem.authors       = ["Daniel Fone"]
-  gem.email         = %w[daniel@fone.net.nz]
-  gem.description   = %q{Instant CSV support for Rails}
-  gem.summary       = %q{Instant CSV support for Rails}
-  gem.homepage      = "https://github.com/danielfone/as_csv"
-
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = %w[lib]
-
-  gem.add_runtime_dependency "activemodel", '>= 3.0'
-  gem.add_runtime_dependency "actionpack", '>= 3.0'
-  gem.add_runtime_dependency "responders"
-
-  # Tests
-  gem.add_development_dependency "rails", ">= 3.0"
-  gem.add_development_dependency "sqlite3" unless defined? JRUBY_VERSION
-  gem.add_development_dependency "rspec-rails", "~> 3.0"
-  gem.add_development_dependency "simplecov"
-end

data/script/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')

data/spec/controllers/render_widgets_controller_spec.rb

@@ -1,5 +0,0 @@
-require 'rails_helper'
-
-describe RenderWidgetsController, :widgets_controllers do
-  exercise_controller
-end

data/spec/controllers/respond_with_widgets_controller_spec.rb

@@ -1,5 +0,0 @@
-require 'rails_helper'
-
-describe RespondWithWidgetsController, :widgets_controllers do
-  exercise_controller
-end

data/spec/core_ext/array_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-require 'as_csv/core_ext/array'
-
-describe Array do
-  subject(:array) do
-    [
-      double(:foo, :as_csv => {:header => '1'}),
-      double(:foo, :as_csv => {:header => '2'}),
-      double(:foo, :as_csv => {:header1 => '3'}),
-    ]
-  end
-
-  describe '#to_csv' do
-    subject { array.to_csv }
-
-    it 'should use :as_csv on its elements if present' do
-      should eq "header,header1\n1,\n2,\n,3\n"
-    end
-
-    context 'with mixed elements' do
-      before { array << 1 }
-      it 'should raise a TypeError' do
-        expect { subject }.to raise_error TypeError
-      end
-    end
-
-    context 'with literals' do
-      before { array.clear; array << 1 }
-      it 'should not use :as_csv' do
-        should eq "1\n"
-      end
-    end
-  end
-
-end