csv_manager 1.0.1.pre.rc.1 → 1.0.2.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ced119dddc799c9c44f05de132e04f2bee096843
-  data.tar.gz: a8bb365c2826af9f3bb13ac11f3213fd8d56206a
+  metadata.gz: c13cb6a7dee6b5d523e69bde463aed98eeb43c18
+  data.tar.gz: d7bb6b7a0b965317b3736045601bb68aa4085af5
 SHA512:
-  metadata.gz: '00826715c6ed5a3d2cdd943c6a9454507fe9540e133e88f8298e3e4ac688982ba6ebf520e48a784791acd19f0fab7fdfb1e9519978165db8285f1e1ca3ee2892'
-  data.tar.gz: d8c0a2fa7f8089a92cf88eb3394b008d2f1f1e67f26214468595b8a2fa8a9dab34c77469bda6e9b04fdaf07d441226d36dc906f716ecbd7a8aa71f26a9221daf
+  metadata.gz: 985cd035536b6c666718c5df1c8b59238f1cac93e3787e26afdf14f0bbc2c1a6cbf99f87b6780e6230af7d36cde08f3e528f5d6a4784fc039577938dd6ea15ac
+  data.tar.gz: 6302d1b9739f57aea3f50b655d47a427b644cd570dcf388d15828ba010c22df46374db3a2ebc1e40096d35c37d6bc1b562e97c03cb60ea50358e7224ee057c2f

data/README.md

@@ -1,5 +1,8 @@
 # CSVManager
 
+[![Build Status](https://travis-ci.org/ghbooth12/csv_manager.svg?branch=master)](https://travis-ci.org/ghbooth12/csv_manager)
+[![Gem Version](https://badge.fury.io/rb/csv_manager.svg)](https://badge.fury.io/rb/csv_manager)
+
 This gem helps import/export a CSV file in a very easy and simple way.
 
 ```ruby
@@ -80,6 +83,7 @@ In the view, make sure to send `format: "csv"` to the path.
 
 * [Example 5) Download database in a CSV file](doc/export_download.md)
 
+-----
 
 ## Demo App
 To see the `CSVManager` in action you can take a look at this app - [Inventory](https://inventory-ghbooth12.herokuapp.com).

data/csv_manager.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.10.4"
-  # spec.add_development_dependency "logging"
+
+  spec.add_runtime_dependency "logging"
 end

data/lib/csv_manager.rb

@@ -1,8 +1,10 @@
-require "csv_manager/version"
 require "csv"
 require "pry"
+require 'logging'
+require "csv_manager/version"
 require "csv_manager/import"
 require "csv_manager/export"
+require 'csv_manager/utils'
 
 module CSVManager
 end

data/lib/csv_manager/export.rb

@@ -1,18 +1,25 @@
-# require 'logging'
-
 module CSVManager
   class Export
-    # def initialize
-    #   @logger = Logging.logger['csv_manager_export_log.txt']
-    #   @logger.level = :debug
-    # end
+    def initialize
+      @logger = Logging.logger(STDOUT)
+      @logger.level = :debug
+    end
 
+    # Calls `send_data` with text from `to_csv(obj)` and option hash.
+    # Then returns a CSV formatted string in an array.
+    # [params]
+    # - controller: controller that takes care of "download CSV" request. eg) products_controller
+    # - objs: model instances. eg) Product.all, Product.where(category: "office")
+    # - filename: a filename string. eg) "inventory_2016.csv"
     def download(controller, objs, filename=nil)
-      # @logger.debug "DOWNLOAD METHOD CALLED"
       return if controller.nil? || objs.nil?
+      @logger.info "#{LINER}CSVManager::Export#download {controller: #{controller}, objs: #{objs}, filename: #{filename}}#{LINER}"
       controller.send_data to_csv(objs), filename: filename
     end
 
+    # Generates a CSV formatted string with headers and given objects(objs).
+    # [params]
+    # - objs: model instances. eg) [product1, product2], Product.all
     def to_csv(objs)
       return unless validate(objs)
 
@@ -34,7 +41,9 @@ module CSVManager
       return csv_file
     end
 
-    # This method checks to see if an instance of ActiveRecord::Relation or an array of instance of ActiveRecord::Base is passed in.
+    # Checks to see if an instance of ActiveRecord::Relation or an array of instance of ActiveRecord::Base is passed in.
+    # [params]
+    # - objs: model instances
     def validate(objs)
       valid = false
 

data/lib/csv_manager/import.rb

@@ -2,13 +2,26 @@ module CSVManager
   class Import
     attr_reader :cols, :rows, :entire, :error
 
+    # [Instance variables]
+    # - @cols: an array of CSV headers. eg) ["category", "name", "price"]
+    # - @rows: an array of arrays which consist of values in each row of CSV file. eg) [["fruit", "apple", 1], ["fruit", "banana", 0.5]]
+    # - @entire: an array of hashes which consist of keys and values of CSV file. Keys are headers and values are data under the header columns. eg) [{"category"=>"fruit", "name"=>"apple", "price"=>1}, {"category"=>"fruit", "name"=>"banana", "price"=>0.5}]
+    # - @error: an error message string
     def initialize
+      @logger = Logging.logger(STDOUT)
+      @logger.level = :debug
+
       @cols = []
       @rows = []
       @entire = []
       @error = nil
     end
 
+    # Reads the given CSV file, parses and sets @cols, @rows and @entire.
+    # If CSV file is not readable, the error message assigns to @error without throwing an exception.
+    # [params]
+    # - file: CSV file path string
+    # - headers: true(CSV file includes headers.) OR string type("category,name,price") OR array type(["category","name","price"])
     def parse(file, headers=true)
       return if file.nil?
       file = file.path if file.respond_to?(:path)
@@ -17,6 +30,7 @@ module CSVManager
         raw_rows = CSV.read(file, headers: headers, converters: :numeric).to_a
       rescue
         @error = "ERROR! #{$!.message}"
+        @logger.warn "#{LINER}CSVManager::Import#parse {file: #{file}, headers: #{headers}}\n#{@error}#{LINER}"
         return
       end
 
@@ -29,20 +43,47 @@ module CSVManager
       end
     end
 
+    # Counts the number of rows in CSV file which was parsed in `parse` method.
+    # Note: Before calling this method, `parse` has to be called first.
     def count
       @rows.count
     end
 
+    # Returns an array of values related to `col`
+    # [params]
+    # - col: a header string. eg) "category", "name"...
     def get_contents(col)
       @entire.map {|hash| hash[col]}
     end
 
-    # Before calling this method, `parse` has to be called first.
+    # Populates `model` with `hash_arr` array
+    # Note: Before calling this method, `parse` has to be called first.
+    # [params]
+    # - model: model object eg) Call create(Product), NOT create("Product")
+    # - hash_arr: an array of hashes. eg) [{"name"=>"doll", "category"=>"Toys", "quantity"=>8}, {"name"=>"ribbon", "category"=>"craft", "quantity"=>10}]
     def create(model, hash_arr=@entire)
-      return if model.nil?
+      return if model.nil? || hash_arr.nil? || !validate(model, hash_arr)
+
       for hash in hash_arr
         model.create(hash)
       end
     end
+
+    # Checks if `hash_arr` is an array and
+    # attributes of `model` match with keys of the hash from `hash_arr`.
+    # [params]
+    # - model: model object eg) Call create(Product), NOT create("Product")
+    # - hash_arr: an array of hashes. eg) [{"name"=>"doll", "category"=>"Toys", "quantity"=>8}, {"name"=>"ribbon", "category"=>"craft", "quantity"=>10}]
+    def validate(model, hash_arr)
+      return false unless hash_arr.is_a?(Array)
+      keys = hash_arr.first.keys
+      cols = model.column_names[1..-3]
+
+      if keys != cols
+        @logger.warn "#{LINER}CSVManager::Import#validate | MatchError: #{keys} != #{cols} #{LINER}"
+        return false
+      end
+      true
+    end
   end
 end

data/lib/csv_manager/utils.rb

@@ -0,0 +1,3 @@
+module CSVManager
+  LINER = "\n#{"=" * 20}\n"
+end

data/lib/csv_manager/version.rb

@@ -1,3 +1,3 @@
 module CSVManager
-  VERSION = "1.0.1-rc.1"
+  VERSION = "1.0.2-rc.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_manager
 version: !ruby/object:Gem::Version
-  version: 1.0.1.pre.rc.1
+  version: 1.0.2.pre.rc.1
 platform: ruby
 authors:
 - Gahee Heo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -120,6 +120,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Import and export a CSV file in a very easy and simple way
 email:
 - ghbooth12@gmail.com
@@ -146,6 +160,7 @@ files:
 - lib/csv_manager.rb
 - lib/csv_manager/export.rb
 - lib/csv_manager/import.rb
+- lib/csv_manager/utils.rb
 - lib/csv_manager/version.rb
 homepage: https://github.com/ghbooth12/csv_manager
 licenses: