acts_as_table_csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39b160ffc4a93b79254c6b33905013a8654334773ef0a44bee15fd111d3e62d6
+  data.tar.gz: de211a8b138223ba2c927c3d7b88846465a521022c501498e67f962ba0d58a5b
+SHA512:
+  metadata.gz: b9a058e1673e8d4c8358969a979864cd58ab20612e2ab3aab7cd8d02560092a1a937ec034c5ce5d7431d7b0cdf7febe0d154b2f08d0530b311206fae2d5ddf32
+  data.tar.gz: a63100f72aa8eff2b8879cf7baeb9ee956f0e7fde352cfa798c0623b456f819225c6f6de780288dde7e18ba3754483ccbfad10f36296dce6ab634957b54d45ef

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --markup-provider redcarpet

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2020, Battelle Memorial Institute
+All rights reserved.
+
+1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission
+   to any person or entity lawfully obtaining a copy of this software and
+   associated documentation files (hereinafter "the Software") to redistribute
+   and use the Software in source and binary forms, with or without
+   modification.  Such person or entity may use, copy, modify, merge, publish,
+   distribute, sublicense, and/or sell copies of the Software, and may permit
+   others to do so, subject to the following conditions:
+
+   * Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimers.
+   * Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+   * Other than as used herein, neither the name Battelle Memorial Institute or
+     Battelle may be used in any form whatsoever without the express written
+     consent of Battelle.
+
+2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL BATTELLE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,76 @@
+# CSV Support for ActsAsTable
+
+This is an [ActsAsTable](https://github.com/pnnl/acts_as_table) extension that adds support for parsing/serializing [Comma-Separated Values](https://tools.ietf.org/html/rfc4180) (CSV) data.
+
+* https://github.com/pnnl/acts_as_table_csv
+
+## Documentation
+
+* {ActsAsTable::CSV}
+  * {ActsAsTable::CSV::Reader}
+  * {ActsAsTable::CSV::Writer}
+
+## Dependencies
+
+* [ActsAsTable](https://github.com/pnnl/acts_as_table) (~> 0.0.1)
+
+## Installation
+
+The recommended installation method is via [RubyGems](http://rubygems.org/).
+To install the latest, official release of the `ActsAsTable::CSV` gem, do:
+```bash
+% [sudo] gem install acts_as_table_csv
+```
+
+## Examples
+
+```ruby
+require 'acts_as_table'
+```
+
+### Writing CSV data
+
+```ruby
+# @return [ActsAsTable::RowModel]
+@row_model = ...
+
+# @return [Array<ActiveRecord::Base>]
+@bases = ...
+
+ActsAsTable.for(:csv).writer(@row_model, $stdout) do |writer|
+  @bases.each do |base|
+    writer << base
+  end
+end
+```
+
+### Reading CSV data
+
+```ruby
+# @return [ActsAsTable::RowModel]
+@row_model = ...
+
+# @return [ActsAsTable::Table]
+@table = @row_model.tables.new
+
+ActsAsTable.for(:csv).reader(@row_model, $stdin) do |reader|
+  reader.each_row do |row|
+    # @return [Array<ActsAsTable::Record>]
+    records = @table.from_row(row)
+
+    records.each do |record|
+      record.position = reader.lineno
+    end
+  end
+end
+```
+
+## Author
+
+* [Mark Borkum](https://github.com/markborkum)
+
+## License
+
+This software is licensed under a 3-clause BSD license.
+
+For more information, see the accompanying {file:LICENSE} file.

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/lib/acts_as_table/csv.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/module'
+
+module ActsAsTable
+  # ActsAsTable serialization format module for comma-separated values (CSV) format.
+  module CSV
+    extend ::ActiveSupport::Autoload
+
+    autoload :Reader, 'acts_as_table/csv/reader'
+    autoload :Writer, 'acts_as_table/csv/writer'
+
+    # Returns the symbolic name for this ActsAsTable serialization format.
+    #
+    # @return [Symbol]
+    def self.format
+      :csv
+    end
+
+    # Returns a new ActsAsTable reader object for this serialization format.
+    #
+    # @param [Array<Object>] args
+    # @yieldparam [ActsAsTable::CSV::Reader] reader
+    # @yieldreturn [void]
+    # @return [ActsAsTable::CSV::Reader]
+    def self.reader(*args, &block)
+      Reader.new(*args, &block)
+    end
+
+    # Returns a new ActsAsTable writer object for this serialization format.
+    #
+    # @param [Array<Object>] args
+    # @yieldparam [ActsAsTable::CSV::Writer] writer
+    # @yieldreturn [void]
+    # @return [ActsAsTable::CSV::Writer]
+    def self.writer(*args, &block)
+      Writer.new(*args, &block)
+    end
+  end
+end

data/lib/acts_as_table/csv/reader.rb

@@ -0,0 +1,48 @@
+require 'csv'
+
+module ActsAsTable::CSV
+  # ActsAsTable reader object for comma-separated values (CSV) format.
+  class Reader < ActsAsTable::Reader
+    # Returns a new ActsAsTable reader object for comma-separated values (CSV) format using the given ActsAsTable row model, input stream and options.
+    #
+    # @param [ActsAsTable::RowModel] row_model
+    # @param [IO] input
+    # @param [Hash<Symbol, Object>] options
+    # @yieldparam [ActsAsTable::CSV::Reader] reader
+    # @yieldreturn [void]
+    # @return [ActsAsTable::CSV::Reader]
+    #
+    # @note Delegates input stream and options to constructor for +CSV+ object.
+    # @see ::CSV.new
+    def initialize(row_model, input = $stdin, **options, &block)
+      # @return [Hash<Symbol, Object>]
+      csv_options = (options[:csv] || {}).merge({
+        headers: false,
+      })
+
+      @csv = ::CSV.new(input, **csv_options)
+
+      super(row_model, input, **options, &block)
+    end
+
+    # Returns a pair, where the first element is the next row or +nil+ if input stream is at end of file and the second element indicates if input stream is at end of file.
+    #
+    # @return [Object]
+    def read_row
+      # @return [Array<#to_s>, nil]
+      row = @csv.shift
+
+      if row.nil?
+        [row, true]
+      else
+        row = row.collect(&:to_s).collect(&:strip).collect { |s| s.empty? ? nil : s }
+
+        if row.all?(&:nil?)
+          row = nil
+        end
+
+        [row, false]
+      end
+    end
+  end
+end

data/lib/acts_as_table/csv/writer.rb

@@ -0,0 +1,38 @@
+require 'csv'
+
+module ActsAsTable::CSV
+  # ActsAsTable writer object for comma-separated values (CSV) format.
+  class Writer < ActsAsTable::Writer
+    # Returns a new ActsAsTable writer object for comma-separated values (CSV) format using the given ActsAsTable row model, output stream and options.
+    #
+    # @param [ActsAsTable::RowModel] row_model
+    # @param [IO] output
+    # @param [Hash<Symbol, Object>] options
+    # @yieldparam [ActsAsTable::CSV::Writer] writer
+    # @yieldreturn [void]
+    # @return [ActsAsTable::CSV::Writer]
+    #
+    # @note Delegates output stream and options to constructor for +CSV+ object.
+    # @see ::CSV.new
+    def initialize(row_model, output = $stdout, **options, &block)
+      # @return [Hash<Symbol, Object>]
+      csv_options = (options[:csv] || {}).merge({
+        headers: false,
+      })
+
+      @csv = ::CSV.new(output, **csv_options)
+
+      super(row_model, output, **options, &block)
+    end
+
+    # Writes a row to the output stream.
+    #
+    # @param [Array<String, nil>, nil] row
+    # @return [ActsAsTable::Writer]
+    def write_row(row)
+      @csv << row
+
+      self
+    end
+  end
+end

data/lib/acts_as_table_csv.rb

@@ -0,0 +1,17 @@
+require 'active_support/core_ext/module'
+
+begin
+  require 'rails/engine'
+  require 'acts_as_table_csv/engine'
+rescue ::LoadError
+  # void
+end
+
+require 'acts_as_table_csv/version'
+
+# ActsAsTable extension for parsing/serializing CSV data.
+module ActsAsTableCsv
+  extend ::ActiveSupport::Autoload
+
+  autoload :VERSION
+end

data/lib/acts_as_table_csv/engine.rb

@@ -0,0 +1,13 @@
+module ActsAsTableCsv
+  class Engine < ::Rails::Engine
+    isolate_namespace ActsAsTableCsv
+
+    initializer 'acts_as_table_csv.append_format' do |app|
+      ActsAsTable.configure do
+        require 'acts_as_table/csv'
+
+        config.formats << :CSV
+      end
+    end
+  end
+end

data/lib/acts_as_table_csv/version.rb

@@ -0,0 +1,4 @@
+module ActsAsTableCsv
+  # @return [String]
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_table_csv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Borkum
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts_as_table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActsAsTable extension for parsing/serializing CSV data.
+email:
+- mark.borkum@pnnl.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- Rakefile
+- lib/acts_as_table/csv.rb
+- lib/acts_as_table/csv/reader.rb
+- lib/acts_as_table/csv/writer.rb
+- lib/acts_as_table_csv.rb
+- lib/acts_as_table_csv/engine.rb
+- lib/acts_as_table_csv/version.rb
+homepage: https://github.com/pnnl/acts_as_table_csv
+licenses:
+- BSD-3-Clause
+metadata:
+  bug_tracker_uri: https://github.com/pnnl/acts_as_table_csv/issues
+  source_code_uri: https://github.com/pnnl/acts_as_table_csv
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: CSV support for ActsAsTable.
+test_files: []