as_csv 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4d42e156f1d67a08429e702174565e9b9790dd26
-  data.tar.gz: 34f15ff95d6a14f7498f86af25ef0e245aa20ea2
+SHA256:
+  metadata.gz: de71beec63d08a1f5458d90b0c1467356f2fa04ee5c2ba4fc02677567c9ddbe3
+  data.tar.gz: f2be9c1aa77fcbd6d3bbfc8b2a47df0581cd34aa4540ed9a885801cbff698de8
 SHA512:
-  metadata.gz: 370cafb8ca291e3eaae5b5e83343e388602c23d00ab1ca90e24e20026f3d4df21a604ee8e339223468b7d382c305ba2fc093ece5dd3ecb285246a021da552b2e
-  data.tar.gz: 06e15f34dd43979e0aa577b5de352cbe26fb7445aa28edf301fbffaa6d3e1aa88d8bf244121ef9c3751e4800f3db72415eebb56de9767b2734cd9849b8c55e09
+  metadata.gz: 740b0966dfe962994b91c0989d776f9cc638b9bd03246ff1f352aab3d056a5385f5f95178c455b1703c0acca420d8702b8c4ddbd7ae9b244f9acba9a1581327c
+  data.tar.gz: e6ef60c4b2334f72c091d627ec297081b334e6b0796becca4d1bfe36b65e4cdfc268882f01a469e20f1bd8f4b15f9648e41bb05e856cd037e1d12a5539130105

data/CHANGELOG.md

@@ -3,21 +3,44 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased][unreleased]
+## [3.0.0] - 2022-11-08
 
-- Nothing currently
+### 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
+
+- CSV responses will now be sent with 'Content-Disposition: attachment'
 
 ## [2.0.1] - 2015-03-21
 
 ### Added
 
-- Allow options to be passed-through to CSV. e.g. `puts (Foo.all + Bar.all).to_csv csv_options: {col_sep:'|'}`
-- This changelog (sorry if you care about what happened before then)
+- Allow options to be passed-through to CSV. e.g. `puts (Foo.all + Bar.all).to_csv csv_options: {col_sep:'|'}` ([#4])
+- This changelog
 
 ## [2.0.0] - Sometime
 
 - Pretty sure this is actually backwards compat. Sorry.
 
-[unreleased]: https://github.com/danielfone/as_csv/compare/v2.0.1...HEAD
+[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
+
+[#4]: https://github.com/danielfone/as_csv/pull/4

data/README.md

@@ -1,43 +1,23 @@
 # AsCSV
 
-[![Build Status](https://travis-ci.org/danielfone/as_csv.png)](https://travis-ci.org/danielfone/as_csv)
-[![Dependency Status](https://gemnasium.com/danielfone/as_csv.png)](https://gemnasium.com/danielfone/as_csv)
-[![Code Climate](https://codeclimate.com/github/danielfone/as_csv.png)](https://codeclimate.com/github/danielfone/as_csv)
+[![Gem Version](https://badge.fury.io/rb/as_csv.svg)](http://badge.fury.io/rb/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.
-
-Ruby 1.8 will work, but by default the order of the columns will not be guaranteed.
+Rails is not strictly required, but currently the magic only works with Rails > 3.x.x.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'as_csv'
+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
@@ -159,7 +139,7 @@ bar1,bar1-description,,acb12345
 bar2,bar2-description,,xyz98765
 ```
 
-### stdlib CSV options
+### Stdlib CSV options
 If you need to pass any [options](http://docs.ruby-lang.org/en/2.0.0/CSV.html#method-c-new)
 to the underlying CSV library:
 
@@ -183,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,15 +1,8 @@
-require 'as_csv/csv_builder'
+require 'as_csv/active_model/serialization/csv'
 
-module ActiveModel::Serialization
-  def as_csv(options={})
-    attributes
-  end
-
-  def to_csv(*args)
-    AsCSV::CSVBuilder.new(self, *args).to_csv
-  end
-end
+ActiveModel::Serialization.send :include, AsCSV::ActiveModel::Serialization::CSV
 
 ActionController::Renderers.add :csv do |obj, options|
+  response.headers['Content-Disposition'] = 'attachment'
   obj.respond_to?(:to_csv) ? obj.to_csv(options) : obj
 end

data/lib/as_csv/version.rb

@@ -1,3 +1,3 @@
 module AsCSV
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end

data/lib/as_csv.rb

@@ -1,3 +1,4 @@
 require "as_csv/version"
 require "as_csv/core_ext/array"
+require "as_csv/core_ext/enumerable"
 require "as_csv/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_csv
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Daniel Fone
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2022-11-08 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.6
-signing_key: 
+rubygems_version: 3.3.22
+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