flat_file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2ed36f67ce4b2e4dd652083303c3334c25fb75b38bac58556db7dcc35bae5ce
+  data.tar.gz: decdc753ea4c124ea579e712ade96264fe5cfe11d4d13d1e1b262bac60d794a1
+SHA512:
+  metadata.gz: 4d0945ef8d97a589b7b8dbb246f9d5e216f3ae430e9789818f7bcd7dd3e11768b59a43658b208f05adcef7066bcb22613b867bda9b3ee4eb35c7c68bc0804347
+  data.tar.gz: 3ce275f2214d7395cfe716793be28870a2aa081bc92f6002cc615079e520ddd81e992984a0c3d2fda900835468744572c3d14035d6024202bcfbf7a508bd759a

data/.editorconfig

@@ -0,0 +1,22 @@
+#   ╔═╗╔╦╗╦╔╦╗╔═╗╦═╗┌─┐┌─┐┌┐┌┌─┐┬┌─┐
+#   ║╣  ║║║ ║ ║ ║╠╦╝│  │ ││││├┤ ││ ┬
+#  o╚═╝═╩╝╩ ╩ ╚═╝╩╚═└─┘└─┘┘└┘└  ┴└─┘
+#
+#  http://editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 255
+trim_trailing_whitespace = true
+
+[*.{md,csv,tsv}]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[*.tsv]
+indent_style = tab

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,217 @@
+AllCops:
+  TargetRubyVersion: 2.5.0
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Don't leave calls to pry lying around.
+Lint/Debugger:
+  Enabled: true
+
+# ==============================================================================
+# Documentation
+# ==============================================================================
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/DocumentationMethod:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+# ==============================================================================
+# Naming
+# ==============================================================================
+
+Naming/MethodName:
+  Enabled: true
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+
+# ==============================================================================
+# Layout
+# ==============================================================================
+
+Metrics/LineLength:
+  Max: 150
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# https://unix.stackexchange.com/a/18789
+Layout/TrailingEmptyLines:
+  EnforcedStyle: final_newline
+
+# ==============================================================================
+# Strings
+# ==============================================================================
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Style/FormatStringToken:
+  # EnforcedStyle: template
+  Enabled: false
+
+# ==============================================================================
+# Numbers
+# ==============================================================================
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+# preferably `EnforcedStyle: snake_case`, but it varies.
+Naming/VariableNumber:
+  Enabled: false
+
+# ==============================================================================
+# Braces, Brackets, and Parentheses
+# ==============================================================================
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# ==============================================================================
+# Trailing Commas
+# ==============================================================================
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# ==============================================================================
+# Fewer lines doesn't mean better code
+# ==============================================================================
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+# TODO: Look into adding an `EnforcedStyle` to not use guard clauses.
+Style/GuardClause:
+  Enabled: false
+
+# TODO: Look into adding an `EnforcedStyle` to not use if/unless modifiers.
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+# ==============================================================================
+# Explicit, not redundant
+# ==============================================================================
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+# ==============================================================================
+# Exceptions
+# ==============================================================================
+
+Lint/SuppressedException:
+  AllowComments: true
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+
+# ==============================================================================
+# Unsorted
+# ==============================================================================
+
+# Default value (special_inside_parentheses) is ridiculous.
+# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstHashElement
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Default value (special_inside_parentheses) is ridiculous.
+# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstArrayElement
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: false
+
+# `x&.y&.[](:argument)` isn't what I'd call "readable".
+# https://stackoverflow.com/questions/34794697/using-with-the-safe-navigation-operator-in-ruby
+Style/SafeNavigation:
+  Enabled: false
+
+Style/NegatedIf:
+  EnforcedStyle: postfix
+
+# TODO: File issue to ignore enums when using `EnforcedStyle: assign_inside_condition`.
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: False
+
+Style/AsciiComments:
+  Enabled: false
+
+Lint/EmptyWhen:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in flat_file.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    flat_file (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    coderay (1.1.3)
+    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)
+    docile (1.3.2)
+    json (2.3.1)
+    method_source (0.9.2)
+    minitest (5.14.2)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8.23)
+  flat_file!
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.4)
+  pry (~> 0.12.2)
+  rake (~> 13.0)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Clay Dunston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# FlatFile
+
+Convenience methods for reading CSV, TSV, & JSON files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flat_file'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install flat_file
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task(default: :test)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flat_file"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flat_file.gemspec

@@ -0,0 +1,37 @@
+require_relative "lib/flat_file/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "flat_file"
+  spec.version       = FlatFile::VERSION
+  spec.authors       = ["Clay Dunston"]
+  spec.email         = ["dunstontc@gmail.com"]
+  spec.summary       = "Convenience methods for reading CSV, TSV, & JSON files"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/tcd/flat_file"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata = {
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => spec.homepage,
+    "changelog_uri"     => "#{spec.homepage}/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}",
+    "yard.run"          => "yri", # use "yard" to build full HTML docs.
+  }
+
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.23"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.4"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

data/lib/flat_file.rb

@@ -0,0 +1,8 @@
+require "flat_file/version"
+require "flat_file/csv"
+require "flat_file/tsv"
+require "flat_file/qsv"
+require "flat_file/json"
+
+# Convenience methods for reading CSV, TSV, & JSON files
+module FlatFile; end

data/lib/flat_file/csv.rb

@@ -0,0 +1,52 @@
+require "csv"
+
+module FlatFile
+  module CSV
+
+    # Read a CSV file and return its contents as an array of hashes.
+    #
+    # @param filepath [String] Path to the CSV file.
+    # @return [Array<Hash>]
+    def self.from_file(filepath)
+      rows = []
+      begin
+        ::CSV.foreach(filepath, headers: true) do |row|
+          rows.append(row)
+        end
+        return rows
+      rescue StandardError => e
+        # if defined?(Rails)
+        #   Rails.logger.error({
+        #     message: "Error reading CSV file",
+        #     filepath: filepath,
+        #     error: e,
+        #   })
+        # end
+        return rows
+      end
+    end
+
+    # Read a CSV stream and return its contents as an array of hashes.
+    #
+    # @param data [String, IO] Stream of CSV data.
+    # @return [Array<Hash>]
+    def self.from_stream(data)
+      rows = []
+      begin
+        ::CSV.new(data, headers: true).each do |row|
+          rows.append(row)
+        end
+        return rows
+      rescue StandardError => e
+        # if defined?(Rails)
+        #   Rails.logger.error({
+        #     message: "Error reading CSV data",
+        #     error: e,
+        #   })
+        # end
+        return rows
+      end
+    end
+
+  end
+end

data/lib/flat_file/json.rb

@@ -0,0 +1,19 @@
+require "json"
+
+module FlatFile
+  module JSON
+
+    # Return a hash parsed from a given JSON file.
+    #
+    # @param file [String]
+    # @return [Hash,ActiveSupport::HashWithIndifferentAccess]
+    def self.from_file(file)
+      data = ::JSON.parse(File.read(file))
+      if defined?(ActiveSupport::HashWithIndifferentAccess)
+        return data&.with_indifferent_access || data
+      end
+      return data
+    end
+
+  end
+end

data/lib/flat_file/qsv.rb

@@ -0,0 +1,61 @@
+require "csv"
+
+module FlatFile
+  # Read data exports from Postico
+  module QSV
+
+    # https://ruby-doc.org/stdlib-2.6.1/libdoc/csv/rdoc/CSV.html#method-c-new
+    # @return [Hash]
+    OPTIONS = {
+      col_sep:    ";",
+      headers:    true,
+      quote_char: "'",
+      converters: ::CSV::Converters.keys + [:json],
+    }.freeze()
+
+    # @param filepath [String] Path to the file.
+    # @return [Array<Hash{String => String}>]
+    def self.from_file(filepath)
+      # ::CSV::Converters[:json] = ->(s) { self.parse_postico_json(s) }
+      return ::CSV.read(filepath, self.options).map(&:to_hash)
+    end
+
+    # @return [Hash]
+    def self.options()
+      custom_converter = ->(value, field_info) { self.parse_postico_json(value, field_info) }
+      return {
+        col_sep: ";",
+        headers: true,
+        quote_char: '"',
+        converters: [custom_converter],
+      }
+    end
+
+    # @param value [Object]
+    # @param _field_info [Hash]
+    # @return [Object]
+    def self.parse_postico_json(value, _field_info)
+      return value if value.blank?()
+      return value if value.length == 0
+      return value unless value[0] == "{"
+      return ::JSON.parse(value)
+    rescue ::JSON::ParserError => e
+      # if defined?(Rails)
+      #   Rails.logger.error({
+      #     message: "Rescued from 'JSON::ParserError' in parse_postico_json",
+      #     error: e,
+      #   })
+      # end
+      return value
+    rescue StandardError => e
+      # if defined?(Rails)
+      #   Rails.logger.error({
+      #     message: "Rescued from 'StandardError' in parse_postico_json",
+      #     error: e,
+      #   })
+      # end
+      return value
+    end
+
+  end
+end

data/lib/flat_file/tsv.rb

@@ -0,0 +1,21 @@
+require "csv"
+
+module FlatFile
+  module TSV
+
+    # Read a TSV file and return its contents as an array of hashes.
+    #
+    # @param filepath [String] Path to the TSV file.
+    # @param delim [String]
+    # @return [Array<Hash{String => String}>]
+    def self.from_file(filepath, delim: "\t")
+      return ::CSV.read(
+        filepath,
+        col_sep: delim,
+        headers: true,
+        quote_char: "\x00",
+      ).map(&:to_hash)
+    end
+
+  end
+end

data/lib/flat_file/version.rb

@@ -0,0 +1,3 @@
+module FlatFile
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: flat_file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clay Dunston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Convenience methods for reading CSV, TSV, & JSON files
+email:
+- dunstontc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flat_file.gemspec
+- lib/flat_file.rb
+- lib/flat_file/csv.rb
+- lib/flat_file/json.rb
+- lib/flat_file/qsv.rb
+- lib/flat_file/tsv.rb
+- lib/flat_file/version.rb
+homepage: https://github.com/tcd/flat_file
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tcd/flat_file
+  source_code_uri: https://github.com/tcd/flat_file
+  changelog_uri: https://github.com/tcd/flat_file/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/flat_file/0.1.0
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Convenience methods for reading CSV, TSV, & JSON files
+test_files: []