json_csv 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '083c453d42f086f73ff27fe17b02502ec0ab0265'
-  data.tar.gz: 7261db772a8643e85dcc5f0f9eba9cf4c40c2631
+  metadata.gz: f70535d234603ac01375388383a3823da0f73673
+  data.tar.gz: cdae7c0ddfa419662a18a097a7373e8d196a1f48
 SHA512:
-  metadata.gz: c5d184e9c10afdb02cdcf7f376a3b47c5f228b6de1c0e38ba4ab784614e188dcd4b2b0a18bf43a7eaeb2e4ecbeea02cc7a20a7db48af99ec32c90092ba560804
-  data.tar.gz: c1c3fc8c7a8e4f9b5abf1c88f67500b4f14ce7a32efbbd1e4a3140e88eacdf08ed303e197bd7b78eb429286a8d84fe17c23499a7ab666e737710a5416b753940
+  metadata.gz: 8793368170c8003b8bea3af8b6e84e410973589458c8ac0d244702bed2d779ee914c24c028929053ef10e4cc4ce3d8cc054324700a453d3858a95401df4d402c
+  data.tar.gz: 871e4bfcfb63b869b60f9bc413c32823f118f2bfaec4296032ea7b7bffa07876ff0db5e66cf782b2c9d76800a0fd81e8b38fd046120ee782f18390657c20fd69

data/lib/json_csv/csv_to_json.rb

@@ -0,0 +1,111 @@
+require 'csv'
+
+module JsonCsv
+  module CsvToJson
+
+    TYPE_STRING = 'string'.freeze
+    TYPE_INTEGER = 'integer'.freeze
+    TYPE_FLOAT = 'float'.freeze
+    TYPE_BOOLEAN = 'boolean'.freeze
+    FIELD_CASTING_TYPES = [TYPE_STRING, TYPE_INTEGER, TYPE_FLOAT, TYPE_BOOLEAN].freeze
+
+    # Takes flat csv data and yields to a block for each row,
+    # presenting that row as un-flattened json.
+    # This method works for large CSVs and uses very little memory
+    # because it only keeps one row in memory at a time.
+    def csv_file_to_hierarchical_json_hash(path_to_csv, field_casting_rules = {})
+      i = 0
+      CSV.foreach(path_to_csv, headers: true) do |row_data_hash|
+        hierarchical_hash = {}
+        row_data_hash.each do |key, value|
+          next if value.nil? || value == '' # ignore nil or empty string values
+          put_value_at_json_path(hierarchical_hash, key, value, field_casting_rules)
+        end
+        yield hierarchical_hash, i
+        i += 1
+      end
+    end
+
+    # For the given obj, puts the given value at the given json_path,
+    # creating nested elements as needed. This method calls itself
+    # recursively when placing a value at a nested path, and during
+    # this sequence of calls the obj param may either be a hash or an array.
+    def put_value_at_json_path(obj, json_path, value, field_casting_rules = {}, full_json_path_from_top = json_path)
+      json_path_pieces = json_path_to_pieces(json_path)
+
+      if json_path_pieces.length == 1
+        # If the full_json_path_from_top matches one of the field_casting_rules,
+        # then case this field to the specified cast type
+        full_json_path_from_top_as_field_casting_rule_pattern = real_json_path_to_field_casting_rule_pattern(full_json_path_from_top)
+        obj[json_path_pieces[0]] = field_casting_rules.key?(full_json_path_from_top_as_field_casting_rule_pattern) ? apply_field_casting_type(value, field_casting_rules[full_json_path_from_top_as_field_casting_rule_pattern]) : value
+      else
+        obj[json_path_pieces[0]] ||= (json_path_pieces[1].is_a?(Integer) ? [] : {})
+        put_value_at_json_path(obj[json_path_pieces[0]], pieces_to_json_path(json_path_pieces[1..-1]), value, field_casting_rules, full_json_path_from_top)
+      end
+    end
+
+    # Takes a real json_path like "related_books[1].notes_from_reviewers[0]" and
+    # converts it to a field_casting_rule_pattern like: "related_books[x].notes_from_reviewers[x]"
+    def real_json_path_to_field_casting_rule_pattern(full_json_path_from_top)
+      full_json_path_from_top.gsub(/\d+/, 'x')
+    end
+
+    def apply_field_casting_type(value, field_casting_type)
+      raise ArgumentError, "Invalid cast type #{field_casting_type}" unless FIELD_CASTING_TYPES.include?(field_casting_type)
+
+      case field_casting_type
+      when TYPE_INTEGER
+        raise ArgumentError, "\"#{value}\" is not an integer" unless value =~ /^[0-9]+$/
+        value.to_i
+      when TYPE_FLOAT
+        raise ArgumentError, "\"#{value}\" is not a float" unless value =~ /^[0-9]+(\.[0-9]+)*$/ || value =~ /^\.[0-9]+$/
+        value.to_f
+      when TYPE_BOOLEAN
+        if value.downcase == 'true'
+          true
+        elsif value.downcase == 'false'
+          false
+        else
+          raise ArgumentError, "\"#{value}\" is not a boolean"
+        end
+      else
+        value # fall back to string, which is the original form
+      end
+    end
+
+    # Takes the given json_path and splits it into individual json path pieces.
+    # e.g. Takes "related_books[1].notes_from_reviewers[0]" and converts it to:
+    # ["related_books", 1, "notes_from_reviewers", 0]
+    def json_path_to_pieces(json_path)
+      # split on...
+      # '].' (when preceded by a number)
+      # OR
+      # '[' (when followed by a number)
+      # OR
+      # ']' (when preceded by a number)
+      # OR
+      # '.' (always)
+      # ...and remove empty elements (which only come up when you're working with
+      # a json_path like '[0]', which splits between the first bracket and the number)
+      pieces = json_path.split(/(?<=\d)\]\.|\[(?=\d)|(?<=\d)\]|\./).reject { |piece| piece == '' }
+      pieces.map { |piece| piece.to_i.to_s == piece ? piece.to_i : piece } # numeric pieces should be actual numbers
+    end
+
+    # Generates a string json path from the given pieces
+    # e.g. Takes ["related_books", 1, "notes_from_reviewers", 0] and converts it to:
+    # "related_books[1].notes_from_reviewers[0]"
+    def pieces_to_json_path(pieces)
+      json_path = ''
+      pieces.each do |piece|
+        if piece.is_a?(Integer)
+          json_path += "[#{piece}]"
+        else
+          json_path += '.' unless json_path.empty?
+          json_path += piece
+        end
+      end
+      json_path
+    end
+
+  end
+end

data/lib/json_csv/json_to_csv.rb

@@ -0,0 +1,46 @@
+require 'json'
+
+module JsonCsv
+  module JsonToCsv
+
+    # Converts the given json_hash into a flat csv hash, converting all values to
+    # strings (because CSVs are dumb and don't store info about data types)
+    # Set first_index to 1 if you want the first element in an array to
+    #
+    def json_hash_to_flat_csv_row_hash(json_hash)
+      flat = flatten_hash(json_hash)
+      # Convert values to strings because in the CSV file, all values are strings
+      flat.each { |key, val| flat[key] = val.nil? ? '' : val.to_s }
+      flat
+    end
+
+    # This method calls itself recursively while flattening a hash, and during
+    # this sequence of calls the obj param may either be a hash or an array.
+    def flatten_hash(obj, parent_path = '', flat_hash_to_build = {})
+      if obj.is_a?(Hash)
+        obj.each do |key, val|
+          if key_contains_unallowed_characters?(key)
+            raise ArgumentError, 'Cannot deal with hash keys that contain "[" or "]" because these are used for internal processing.'
+          end
+          path = parent_path + (parent_path.empty? ? '' : '.') + key
+          flatten_hash(val, path, flat_hash_to_build)
+        end
+      elsif obj.is_a?(Array)
+        obj.each_with_index do |el, index|
+          path = parent_path + "[#{index}]"
+          flatten_hash(el, path, flat_hash_to_build)
+        end
+      else
+        flat_hash_to_build[parent_path] = obj unless obj.nil? || obj == '' # ignore nil or empty string values
+      end
+
+      flat_hash_to_build
+    end
+
+    def key_contains_unallowed_characters?(key)
+      return true if key.index('[') || key.index(']') || key.index('.')
+      false
+    end
+
+  end
+end

data/lib/json_csv/version.rb

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

data/lib/json_csv.rb

@@ -1,5 +1,8 @@
-module JsonCsv
+require "json_csv/version"
+require "json_csv/json_to_csv"
+require "json_csv/csv_to_json"
 
+module JsonCsv
+  extend JsonCsv::JsonToCsv
+  extend JsonCsv::CsvToJson
 end
-
-require "json_csv/version"

data/lib/tasks/json_csv/ci.rake

@@ -13,13 +13,25 @@ namespace :json_csv do
       spec.rspec_opts = ['--backtrace'] if ENV['CI']
     end
 
+    require 'rubocop/rake_task'
+
+    desc 'Run style checker'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.requires << 'rubocop-rspec'
+      task.fail_on_error = true
+    end
   rescue LoadError => e
     puts "[Warning] Exception creating rspec rake tasks.  This message can be ignored in environments that intentionally do not pull in the RSpec gem (i.e. production)."
     puts e
   end
 
   desc "CI build"
-  task :ci do
+  task ci: ['json_csv:rubocop'] do
+    Rake::Task["json_csv:rspec"].invoke
+  end
+
+  desc "CI build"
+  task :ci_nocop do
     Rake::Task["json_csv:rspec"].invoke
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Eric O'Hanlon
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
 description: A library for converting json to csv...and back!
 email: elo2112@columbia.edu
 executables: []
@@ -46,6 +88,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/json_csv.rb
+- lib/json_csv/csv_to_json.rb
+- lib/json_csv/json_to_csv.rb
 - lib/json_csv/version.rb
 - lib/tasks/json_csv.rake
 - lib/tasks/json_csv/ci.rake