koine-csv 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ef578ceebc4473da0325750a733eb259d42a6bb
-  data.tar.gz: 9f5db34956ac39d00fd0ef395ac5725d6bba4020
+  metadata.gz: 61750f55f1fbec9a7047d25dbf2501dae41ae5c5
+  data.tar.gz: 00a991aa589665470d1bb0d19d1bf2494d53419c
 SHA512:
-  metadata.gz: b5e6690bc9d3ca97fa71029d602bdd5b79bbd11f198570dbf694beeb1adc15a00861eb5ef70e3df1ddc5557ce776e70f2d1fff026371442f83851efa8ac513f8
-  data.tar.gz: 9144d1e5a69a8ff8e64e2f345fdb3803889820e8ba7c152419777689bce7b607f4535ebc934f4a04826406e6cf1784ffa880dd0565b31abc91d967a6bbb15bf9
+  metadata.gz: 3b38bf2bb5a637b24ef2ebff7e8fc911291b26ea4ac3df76f2fe70a40fea2c12c72ff61a0c71dcff7ddb2defb45cf99994f3f9dd400fe8276a0b6793c6381f92
+  data.tar.gz: da11db9c6c6e33daf5ca58c80ac4705149520e5932ad0ea7e43ed976eade7b956b0563e4537363f9c11195449cc5919a5db0a6ed7ab6263e89db95c21b3adc3a

data/README.md

@@ -3,10 +3,10 @@
 Just another CSV parser
 
 [![Build Status](https://travis-ci.org/mjacobus/koine-csv.svg)](https://travis-ci.org/mjacobus/koine-csv)
-[![Code Coverage](https://scrutinizer-ci.com/g/mjacobus/koine-csv/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mjacobus/koine-csv/?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/mjacobus/koine-csv/badge.svg?branch=master)](https://coveralls.io/github/mjacobus/koine-csv?branch=master)
 [![Code Climate](https://codeclimate.com/github/mjacobus/koine-csv/badges/gpa.svg)](https://codeclimate.com/github/mjacobus/koine-csv)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mjacobus/koine-csv/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mjacobus/koine-csv/?branch=master)
-[![Dependency Status](https://gemnasium.com/mjacobus/koine-csv.svg)](https://gemnasium.com/mjacobus/koine-csv)
+[![Build Status](https://travis-ci.org/mjacobus/koine-csv.svg?branch=master)](https://travis-ci.org/mjacobus/koine-csv)
 [![Gem Version](https://badge.fury.io/rb/koine-csv.svg)](https://badge.fury.io/rb/koine-csv)
 
 ## Installation
@@ -30,14 +30,49 @@ Or install it yourself as:
 ```ruby
 parser = Koine::Csv::CsvParser.new(column_separator: ";")
 
-content = "a;b\nc;d\n"
+contents = "a;b\nc;d\n"
 
-result = parser.parse(content)
+result = parser.parse(contents)
+
+#  result = [
+#    ['a', 'b'],
+#    ['c', 'd'],
+#  ]
+```
+
+### Mapped Columns
+
+```ruby
+parser = MappedColumnsParser.new({
+  column_names: [:name, :last_name]
+})
+
+contents = "jon;doe\njohn;travolta\n"
+
+result = parser.parse(contents)
+
+#  result = [
+#    { name: 'jon', last_name: 'doe'},
+#    { name: 'john', last_name: 'travolta'},
+#  ]
+```
+
+### Named Columns
+
+When the CSV already comes with titles
+
+```ruby
+parser = NamedColumnsParser.new
+
+contents = "jon;doe\njohn;travolta\n"
+
+result = parser.parse(contents)
+
+#  result = [
+#    { 'name' => 'jon',  'last_name' => 'doe'},
+#    { 'name' => 'john', 'last_name' => 'travolta'},
+#  ]
 
-# result = [
-#   ['a', 'b'],
-#   ['c', 'd'],
-# ]
 ```
 
 ## Development

data/koine-csv.gemspec

@@ -34,4 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
 end

data/lib/koine/csv.rb

@@ -3,5 +3,7 @@ require "koine/csv/version"
 module Koine
   module Csv
     autoload :CsvParser, 'koine/csv/csv_parser'
+    autoload :MappedColumnsParser, 'koine/csv/mapped_columns_parser'
+    autoload :NamedColumnsParser, 'koine/csv/named_columns_parser'
   end
 end

data/lib/koine/csv/csv_parser.rb

@@ -3,15 +3,23 @@ require "csv"
 module Koine
   module Csv
     class CsvParser
-      def initialize(column_separator = ";")
-        @options = { col_sep: column_separator }
+      def initialize(options = {})
+        defaults = { column_separator: ";" }
+        options = defaults.merge(options)
+        @parser_options = { col_sep: options[:column_separator] }
       end
 
       def parse(contents, &block)
-        CSV.parse(contents, options, &block)
+        CSV.parse(contents, parser_options, &block)
       end
 
-      attr_reader :options
+      protected
+
+      def column_separator
+        parser_options[:col_sep]
+      end
+
+      attr_reader :parser_options
     end
   end
 end

data/lib/koine/csv/mapped_columns_parser.rb

@@ -0,0 +1,32 @@
+require "csv"
+
+module Koine
+  module Csv
+    class MappedColumnsParser < CsvParser
+      attr_reader :column_names
+
+      def initialize(options = {})
+        super(options)
+        @column_names = options.fetch(:column_names)
+      end
+
+      def parse(contents, &block)
+        mapped = []
+        CSV.parse(contents, parser_options) do |row|
+          new_row = {}
+          row.each_with_index do |value, index|
+            new_row[column_name(index)] = value
+          end
+          mapped << new_row
+        end
+        block_given? ? mapped.each(&block) : mapped
+      end
+
+      private
+
+      def column_name(index)
+        column_names.fetch(index)
+      end
+    end
+  end
+end

data/lib/koine/csv/named_columns_parser.rb

@@ -0,0 +1,21 @@
+require "csv"
+
+module Koine
+  module Csv
+    class NamedColumnsParser < CsvParser
+      def parse(contents, &block)
+        contents = contents.split("\n")
+        titles = contents.shift
+        column_names = CSV.parse(titles, col_sep: column_separator).first
+
+        options = {
+          column_names: column_names,
+          column_separator: column_separator
+        }
+
+        contents = contents.join("\n")
+        MappedColumnsParser.new(options).parse(contents, &block)
+      end
+    end
+  end
+end

data/lib/koine/csv/version.rb

@@ -1,5 +1,5 @@
 module Koine
   module Csv
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koine-csv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcelo Jacobus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-26 00:00:00.000000000 Z
+date: 2017-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Csv parsing classes
 email:
 - marcelo.jacobus@gmail.com
@@ -85,6 +113,8 @@ files:
 - koine-csv.gemspec
 - lib/koine/csv.rb
 - lib/koine/csv/csv_parser.rb
+- lib/koine/csv/mapped_columns_parser.rb
+- lib/koine/csv/named_columns_parser.rb
 - lib/koine/csv/version.rb
 homepage: https://github.com/mjacobus/koine-csv
 licenses:
@@ -107,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Csv parsing classes