structured_csv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f0d139cdc9ff3d124d745b783e00c1e9128efaf723df4976c19605a823dec6f
-  data.tar.gz: 396d9c993b850a571746a68cd64ee1c7a295d41d612c534196cb48c87c0415d7
+  metadata.gz: b2be5d95ae78c40e2e0060fbb04fd7df15bcbd80cd94b72a51a7ede81783fabf
+  data.tar.gz: 258a09fb19ecb5f0a784c0b742806975c8d085ecb938cc49bb098eb6f5571b7d
 SHA512:
-  metadata.gz: 656fa1acf23c402402f8bc3ddc5b00c81fb805dbd3128be8c6ea301e7e3fdc4fa2105126ac2e452e5050178442bd0910f1ad141cc8820f39af68a09ce2c7f2de
-  data.tar.gz: d5371f377396641b87f878ada7e0e9c15cdff14afe46c2c3035e1da4d92bfc6b7a1323e2d9df0447574d35861d04abec394f1237d57e605479cc67dd00264c01
+  metadata.gz: 83e5fd945dab4fa147e147565980418198f3f298d23d266a4051d70229f0739a91f8c29b8ed634703944f991bc9e48eb7a9aecd0edb410e49905af3b25026eef
+  data.tar.gz: 479cedec9f895269e238df4685279e6300864056f516bdcd699854a0c3310c0d634888d70b43ff4bf3d5d31e326d3c19a8171cf90d94ecdf2172ecb02722538c

data/.editorconfig

@@ -0,0 +1,18 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+indent_size = 8
+
+# Tab indentation (no size specified)
+[*.sh]
+indent_style = tab

data/.gitattributes

@@ -0,0 +1 @@
+.gitignore	-text

data/.github/workflows/main.yml

@@ -4,15 +4,19 @@ on: [push,pull_request]
 
 jobs:
   build:
+    continue-on-error: true
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.6.7, 2.7.3, 3.0.1]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.6
+        ruby-version: ${{ matrix.ruby-version }}
     - name: Run the default task
       run: |
         gem install bundler -v 2.2.15
         bundle install
-        bundle exec rake
+        bundle exec rake spec

data/.gitignore

@@ -1,11 +1,261 @@
-/.bundle/
-/.yardoc
-/_yardoc/
+# rspec failure tracking
+.rspec_status
+
+.rubocop-http*
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos,windows,linux,vim,emacs,textmate,sublimetext,visualstudiocode,ruby,direnv
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,windows,linux,vim,emacs,textmate,sublimetext,visualstudiocode,ruby,direnv
+
+### direnv ###
+.direnv
+.envrc
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+ltximg/**
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data
+
+
+### Linux ###
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
 
-# rspec failure tracking
-.rspec_status
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### SublimeText ###
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+*.sublime-workspace
+
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
+# *.sublime-project
+
+# SFTP configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+### TextMate ###
+*.tmproj
+*.tmproject
+tmtags
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux,
+# vim,emacs,textmate,sublimetext,visualstudiocode,ruby,direnv

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  Enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,5 +1,42 @@
+# inherit_from:
+#   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# Override
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+# local repo-specific modifications
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Layout/EmptyLinesAroundBlockBody:
+#   Enabled: false
+
+# # https://github.com/rubocop-hq/rubocop/issues/6259#issuecomment-420734217
+# Layout/ExtraSpacing:
+#   ForceEqualSignAlignment: true
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 120
+
+Lint/PercentStringArray:
+  # AutoCorrect: false
+  Enabled: false
+
+Security/YAMLLoad:
+  AutoCorrect: false
+
+Style/ParenthesesAroundCondition:
+  AutoCorrect: false
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +46,5 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma

data/Gemfile

@@ -5,8 +5,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in structured_csv.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.7"
+group :test do
+  gem "rubocop", "~> 1.14", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rails", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end

data/README.adoc

@@ -1,8 +1,11 @@
 = Process Structured CSV files (`structured_csv`)
 
+image:https://badge.fury.io/rb/structured_csv.svg["Gem Version", link="https://badge.fury.io/rb/structured_csv"]
+image:https://github.com/riboseinc/structured_csv/actions/workflows/main.yml/badge.svg["Tests", link="https://github.com/riboseinc/structured_csv/actions/workflows/main.yml"]
+
 == Purpose
 
-The `structured_csv_to_yaml.rb` script converts a "`Structured CSV`" file into a YAML file.
+The `structured_csv_to_yaml` script converts a "`Structured CSV`" file into a YAML file.
 
 When you have data of a yet-undefined data structure, it is useful to manage
 them inside a CSV file which can be viewed and edited by a CSV editor,
@@ -19,11 +22,35 @@ This script supports UTF-8 CSV files.
 NOTE: This was originally developed to create over 50 normalized data models for ITU Operational Bulletin data. See https://github.com/ituob/ for more details.
 
 
+== Installation
+
+Add this line to your application's `Gemfile`:
+
+[source,ruby]
+----
+gem 'structured_csv'
+----
+
+and then run:
+
+[source,sh]
+----
+bundle install
+----
+
+Or install it without a `Gemfile`:
+
+[source,sh]
+----
+gem install structured_csv
+----
+
+
 == Usage
 
 [source,sh]
 ----
-$ exe/structured_csv_to_yaml.rb [input-file.csv]
+$ structured_csv_to_yaml [input-file.csv]
 ----
 
 Where,
@@ -202,4 +229,3 @@ data:
 == Examples
 
 The `samples/` folder contains a number of complex examples.
-