json_csv 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '0043834553b3243296e8b2b55c6806721b82673c'
-  data.tar.gz: 857ab74bc2b9f95ffb0f5d9d47ba520f8ba0a17f
+SHA256:
+  metadata.gz: 7dc36a6c25ffa37eae4a51c7d373763c3958eb10341f2659acbbf70c7f1f6cdf
+  data.tar.gz: de793cb71e127d0518cca18a1fc5c4f31d0d595df51f23abb0c79c02394b4435
 SHA512:
-  metadata.gz: 427f4714f7b6999c798bef38b8e80bef3f0fe5033b31909e4a3aa064aee79e407e5f5957a207dfaa55d9d389b7da763d813c053ce184f3dd8bc97c0b38ead32a
-  data.tar.gz: cdf0311ca31c8c830f22daf426f18e2a36f77cb5ebc47ebdc97ceaf8eeecea1bf1b88f2dec60dd2155e4f6d94c17ccfa5aded6cb64efe9b399d1aaf27beb5738
+  metadata.gz: abffea2f7c780e093a052e3d558526f5e1d93c4492a36de3e3d0a1d38eaa81be4f81ccd929352bd630b6a7db4e8b9141dc76d70a0f8a4986c5a6b1b9a1cf3316
+  data.tar.gz: d791b8465efb81add9160dc3f2d04a1772c3762c3cc88467d456820123153fb80df7c3f02dd2071ea8e4acd518e9fc87323b0d05cc77da927cd9bf871ddcdace

data/README.md

@@ -13,9 +13,26 @@ gem install json_csv
 ```ruby
 require 'json_csv'
 
-TODO: Provide usage examples
+path_to_output_csv_file = '/path/to/file.csv'
+
+# Write json-like hash objects to a csv file
+
+JsonCsv.create_csv_for_json_records(path_to_output_csv_file) do |csv_builder|
+  digital_objects_for_batch_export(batch_export) do |digital_object|
+    csv_builder.add({...json-like hash...})
+  end
+end
+
+# Read csv back into json-like hash objects
+
+JsonCsv.csv_file_to_hierarchical_json_hash(csv_file.path) do |json_hash_for_row, csv_row_number|
+  puts "Row: #{csv_row_number}" # prints out 2 the first time, then 3, etc.
+  puts "Object: #{json_hash_for_row}" # prints out a hierarchical json object, created from the csv row
+end
 ```
 
+See specs for advanced usage.
+
 ### Running Tests (for developers):
 
 Tests are great and we should run them.  Here's how:

data/lib/json_csv/csv_to_json.rb

@@ -21,7 +21,7 @@ module JsonCsv
       # because it only keeps one row in memory at a time.
       # Sample usage: csv_file_to_hierarchical_json_hash(path_to_csv, field_casting_rules = {}, strip_value_whitespace = true) do |row_json_hash, row_number|
       def csv_file_to_hierarchical_json_hash(path_to_csv, field_casting_rules = {}, strip_value_whitespace = true)
-        i = 1 # start with row 1 because this corresponds to the first row of 0-indexed CSV data
+        i = 2 # start with row 2 because this corresponds to the SECOND row of 1-indexed CSV data (where headers are row 1)
         CSV.foreach(path_to_csv, headers: true, header_converters: lambda { |header|
           header.strip # remove leading and trailing header whitespace
         }) do |row_data_hash|

data/lib/json_csv/version.rb

@@ -1,6 +1,6 @@
 module JsonCsv
 
-  VERSION = '0.0.7'.freeze
+  VERSION = '1.0.0'.freeze
 
   def self.version
     VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric O'Hanlon
@@ -114,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A library for converting json to csv...and back!