honey_format 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 976b0f358d1577605a7cf6774c0bfa0d8cc417dc
-  data.tar.gz: 692ee6e558f64ff7cded7e1e3d2b0b3fe33e3d73
+SHA256:
+  metadata.gz: d0c2df26f96e590dfd9c65b15c99b9cb17227c02b434e09acd5afc0477b4e5ba
+  data.tar.gz: 59acd72d13e5474e22b47f35beb6961de6a38c7104b1a6f73bfb85f99d301a75
 SHA512:
-  metadata.gz: e7da999d1c8b1b938111752b87c6174bc8d5119c0d8acd46100fd6d6add24ef48a03153a4df8f6d5153ade514bc40dfbcd6e121b9a9fb4da102b60d6eef9eb81
-  data.tar.gz: cdf05e13e33c42d7942becd58f4db7a9ffac59e7b05a86a793ae97861f18a9f72064605fc2de331aa46384b80f1c28878534452ca6d6cc7e5e89456cd979de42
+  metadata.gz: 549b7fd83a6d787d0d5aef97fbec94a33fb6fbca040e2523d7a30724c2e56b81669f71d8464eac6ab428ef4552e4ca4bb614b4d2046aa0bd6d2d527b3a1a17b1
+  data.tar.gz: 6889ec68257b31887b4e804766c281b0547f93d8feb8720214670d79cf2636f40920633181ce7597d66e7ae381bac34dc32e1f449bccac19be73eab24c29b539

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 benchmark.csv
+.byebug_history

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/README.md

@@ -1,6 +1,6 @@
 # HoneyFormat [![Build Status](https://travis-ci.org/buren/honey_format.svg)](https://travis-ci.org/buren/honey_format) [![Code Climate](https://codeclimate.com/github/buren/honey_format/badges/gpa.svg)](https://codeclimate.com/github/buren/honey_format) ![Docs badge](https://inch-ci.org/github/buren/honey_format.svg?branch=master)
 
-Convert CSV to object with one command.
+Convert CSV to an array of objects with with ease.
 
 Perfect for small files of test data or small import scripts.
 
@@ -13,6 +13,8 @@ user.id         # => "1"
 user.username   # => "buren"
 ```
 
+:information_source: Supports Ruby >= 2.3, has no dependencies other than Ruby stdlib.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/honey_format.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['burenstam@gmail.com']
 
   spec.summary       = 'Convert CSV to objects.'
-  spec.description   = 'Convert CSV to object with one command. Automagically makes your column order independent by defining real, named, methods for each column.'
+  spec.description   = 'Convert CSV to an array of objects with with ease. Create objects for each row with methods matching the column names. No dependencies other than Ruby stdlib.'
   spec.homepage      = 'https://github.com/buren/honey_format'
   spec.license       = 'MIT'
 

data/lib/honey_format/columns.rb

@@ -1,3 +1,5 @@
+require 'honey_format/convert_header_value'
+
 module HoneyFormat
   # Represents columns.
   class Columns
@@ -6,7 +8,8 @@ module HoneyFormat
     # @param [Array] valid array of symbols representing valid columns.
     # @raise [MissingCSVHeaderColumnError] raised when header is missing
     # @raise [UnknownCSVHeaderColumnError] raised when column is not in valid list.
-    def initialize(header, valid = :all)
+    def initialize(header, valid: :all, converter: ConvertHeaderValue)
+      @converter = converter
       @columns = build_columns(header, valid)
     end
 
@@ -20,23 +23,14 @@ module HoneyFormat
 
     def build_columns(header, valid)
       header.map do |column|
-        Sanitize.string!(column)
+        column = @converter.call(column.dup)
         validate_column_presence!(column)
 
-        column = symnolize_string!(column)
-
         validate_column_name!(column, valid)
         column
       end
     end
 
-    def symnolize_string!(column)
-      column.downcase!
-      column.gsub!(/ /, '')
-      column.gsub!(/-/, '_')
-      column.to_sym
-    end
-
     def validate_column_presence!(col)
       if col.nil? || col.empty?
         fail(MissingCSVHeaderColumnError, "CSV header column can't be empty.")

data/lib/honey_format/convert_header_value.rb

@@ -0,0 +1,31 @@
+module HoneyFormat
+  module ConvertHeaderValue
+    REPLACE_MAP = [
+      [/ \(/, '('],
+      [/ \[/, '['],
+      [/ \{/, '{'],
+      [/\) /, ')'],
+      [/\] /, ']'],
+      [/\} /, '}'],
+      [/ /, '_'],
+      [/-/, '_']
+    ].map { |array| array.freeze }.freeze
+
+    # Returns converted value and mutates the argument.
+    # @return [Symbol] the cleaned header column.
+    # @param [String] column the string to be cleaned.
+    # @example Convert simple header
+    #     ConvertHeaderValue.call("  User name ") #=> "user_name"
+    # @example Convert complex header
+    #     ConvertHeaderValue.call(" First name (user)") #=> :'first_name(user)'
+    def self.call(column)
+      column.strip!
+      column.downcase!
+      REPLACE_MAP.each do |data|
+        from, to = data
+        column.gsub!(from, to)
+      end
+      column.to_sym
+    end
+  end
+end

data/lib/honey_format/csv.rb

@@ -14,10 +14,10 @@ module HoneyFormat
     # @raise [MissingCSVHeaderError] raised when header is missing (empty or nil).
     # @raise [MissingCSVHeaderColumnError] raised when header column is missing.
     # @raise [UnknownCSVHeaderColumnError] raised when column is not in valid list.
-    def initialize(csv, delimiter: ',', header: nil, valid_columns: :all)
+    def initialize(csv, delimiter: ',', header: nil, valid_columns: :all, header_converter: ConvertHeaderValue)
       csv = ::CSV.parse(csv, col_sep: delimiter)
       @csv_body = csv
-      @header = Header.new(header || csv.shift, valid: valid_columns)
+      @header = Header.new(header || csv.shift, valid: valid_columns, converter: header_converter)
     end
 
     # @return [Array] of strings for sanitized header.

data/lib/honey_format/header.rb

@@ -9,9 +9,13 @@ module HoneyFormat
     # @param [Array] header array of strings.
     # @param [Array] valid array of symbols representing valid columns.
     # @raise [MissingCSVHeaderError] raised when header is missing (empty or nil).
-    def initialize(header, valid: :all)
-      @column_names = build_header(header)
-      @columns = Columns.new(@column_names, valid)
+    def initialize(header, valid: :all, converter: ConvertHeaderValue)
+      if header.nil? || header.empty?
+        fail(MissingCSVHeaderError, "CSV header can't be empty.")
+      end
+
+      @column_names = Sanitize.array(header)
+      @columns = Columns.new(@column_names, valid: valid, converter: converter)
     end
 
     # Returns columns as array.
@@ -19,14 +23,5 @@ module HoneyFormat
     def columns
       @columns.to_a
     end
-
-    private
-
-    def build_header(header)
-      if header.nil? || header.empty?
-        fail(MissingCSVHeaderError, "CSV header can't be empty.")
-      end
-      Sanitize.array!(header)
-    end
   end
 end

data/lib/honey_format/sanitize.rb

@@ -2,16 +2,36 @@ module HoneyFormat
   # Utility class for sanitizing various simple data types.
   class Sanitize
     # Returns array of cleaned strings.
-    # @return [Array] the cleaned array of strings.
-    # @param [Array] row the array of strings to be cleaned.
+    # @return [Array<String>] the cleaned array of strings.
+    # @param [Array<String>] row the array of strings to be cleaned.
+    # @example Sanitize array
+    #     Sanitize.array(["  a "]) #=> ["a"]
+    def self.array(row)
+      row.map { |column| string(column) }
+    end
+
+    # Returns array of cleaned elements.
+    # @return [String] the cleaned array.
+    # @param [String] column the string to be cleaned.
+    # @example Sanitize string
+    #     Sanitize.string("  a ") #=> "a"
+    # @example Sanitize nil
+    #     Sanitize.string(nil) #=> nil
+    def self.string(column)
+      return column if column.nil?
+      column.strip
+    end
+
+    # Returns mutated array of cleaned strings.
+    # @return [Array<String>] the cleaned array of strings.
+    # @param [Array<String>] row the array of strings to be cleaned.
     # @example Sanitize array
     #     Sanitize.array!(["  a "]) #=> ["a"]
     def self.array!(row)
       row.map! { |column| string!(column) }
-      row
     end
 
-    # Returns array of cleaned elements.
+    # Returns mutated and cleaned string.
     # @return [String] the cleaned array.
     # @param [String] column the string to be cleaned.
     # @example Sanitize string
@@ -19,8 +39,8 @@ module HoneyFormat
     # @example Sanitize nil
     #     Sanitize.string!(nil) #=> nil
     def self.string!(column)
-      column.strip! unless column.nil?
-      column
+      return if column.nil?
+      column.tap(&:strip!)
     end
   end
 end

data/lib/honey_format/version.rb

@@ -1,4 +1,4 @@
 module HoneyFormat
   # Gem version
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-04 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,8 +80,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Convert CSV to object with one command. Automagically makes your column
-  order independent by defining real, named, methods for each column.
+description: Convert CSV to an array of objects with with ease. Create objects for
+  each row with methods matching the column names. No dependencies other than Ruby
+  stdlib.
 email:
 - burenstam@gmail.com
 executables: []
@@ -103,6 +104,7 @@ files:
 - honey_format.gemspec
 - lib/honey_format.rb
 - lib/honey_format/columns.rb
+- lib/honey_format/convert_header_value.rb
 - lib/honey_format/csv.rb
 - lib/honey_format/exceptions.rb
 - lib/honey_format/header.rb
@@ -130,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Convert CSV to objects.