elf_ham 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72ffdb4148875be506a707206c8e98663e7f62262534be35c5a051183b9a770b
-  data.tar.gz: '0843d1fa5afdb32025c8e719bc5c840614575fd1dd3d0f33a90b112610c6de9d'
+  metadata.gz: 31c43f2fb19baa2d2eb0e9458ea9ccadfd6f211a4372db4543b4cd5ef3b8a5cf
+  data.tar.gz: cf656cb6fbf83e9b8edafaecc189692ad0dbb79cd7b9db332eff91738b073674
 SHA512:
-  metadata.gz: 648bef55f51fb9795a0503488150372e48c7729bcd8a6d48fec414469d3a365d2698bcf91ced47859402de8da288ee1bb368ff39fb351ad53810e078da48de27
-  data.tar.gz: ce4d86ec8642704885411f0c94ebdb7543db05a52e37827525bb0bdf26b70fdca74993035e1fdfb520e66ed8410beab2f21c6b523f64eb86960affa1195b972e
+  metadata.gz: 4f39189b74b044d6089b9698ec62c10dd0bef0fe8cb950044dae1d80a059b622584c572629e43cdafa5555d3ab2851dfbcb8612a87a08ced141831f235e6f0f0
+  data.tar.gz: 43f5332a7924698e03f2159ecb3f30599cae63d1618203b46afca79e753d5e965b4decbb6d2da84de6faa78bcee53a3bd2f24174285c1035529ba52ae6bd865f

data/README.md

@@ -2,12 +2,66 @@
 
 ElfHam is an extremely simple utility gem that's useful for transform CSVs.
 
-## Usage
+## tldr;
 
-```sh
-gem install elf_ham
+```ruby
+require "elf_ham"
+
+# Load your CSV:
+elf_ham = ElfHam.new(ARGF.read)
+
+# Filter rows:
+elf_ham.select { |row| row["header2"] != "b" }
+
+# Transform rows:
+elf_ham.transform do |row|
+  row["header3"] = "elfham"
+end
+
+# Print the result
+puts elf_ham.output
 ```
 
+## Instructions
+
+1. Install the gem:
+
+   ```sh
+   gem install elf_ham
+   ```
+
+2. Create a transformation script:
+
+   ```sh
+   echo '#!/usr/bin/env ruby
+
+   require "elf_ham"
+
+   puts ElfHam.new(ARGF.read).select do |row|
+     row["header2"] != "b"
+   end.transform do |row|
+     row["header3"] = "elfham"
+   end.output' > transform.rb
+   ```
+
+3. Make the script executable:
+
+   ```sh
+   chmod u+x transform.rb
+   ```
+
+4. Edit the script to your liking.
+
+5. Run it:
+
+   ```sh
+   transform.rb path/to/your.csv > transformed.csv
+
+   # or
+
+   cat path/to/your.csv | transform.rb > transformed.csv
+   ```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/elf_ham/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ElfHam
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elf_ham
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jared Norman