csvn 0.1.4 → 0.1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d248aa4b3b16845aecb364fc15dcf0d9c46b319f1827bbe771a45fa552070abe
-  data.tar.gz: e95933d958a36e230c56c3dc86e1620d6fbb869a8b7cbb7f32aef501655d1ff6
+  metadata.gz: 602040055b5de864f762415fc8a75f65d7877c0e2e27aff3b92a3fd8fe372f21
+  data.tar.gz: 11157a6ee8412fc2d9ba7ade470293ce07633d116a1be782327a354055dcf39a
 SHA512:
-  metadata.gz: 37196e30b6f774ee3471f699f61c24ad0cba7d4d9bc3d404c18b081d4ff7bf0e1409502e982411671bdbe903a4efab1c57da947409de50dcb85c10ff2bdfc5da
-  data.tar.gz: 77bf83290039664a15f55c6fd585509b2ed7699a28e59cb87139e4cce5f1dc53813051aac3b5caa97b6b81dcb0f173a40e8322de033ac595fcdfc6168d178268
+  metadata.gz: 96f66737334d7ac18dd5eb38788a4e3708d4e88b9a48fe859ff3106d7c20ea6c1c96c79f48b233d64b9dd59eb284994f1628cbe84369c1ea33c4187d9c706ef7
+  data.tar.gz: 1de87400bfe09ca01462cef1ae908d06d7f894c950927bf109974f71ca755fe59d0c29a032dd0ece8d23640f3367f26c1228cb9d08b78be832519280a479e73a

data/Gemfile

@@ -4,5 +4,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "colorize", "~> 0.8.1"
+gem "rspec", "~> 3.0"

data/README.md

@@ -1,8 +1,6 @@
 # Csvn
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/csvn`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is my first gem for simple and more convinient work with csv files (especially for csv exports from DB). 
 
 ## Installation
 
@@ -22,7 +20,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### Base description of instance variables
+
+`file_name` - source file name for reading (absolute or relative path should be provided)
+
+`file_extension` - file extension
+
+`data` - file data rows (as array when readed and array of hashes after .smart_convert! method)
+
+`smart_convert` - convert readed data in array of hashes with file headers keys - false by default
+
+`file_headers` - file headers array
+
+`read_flag` - service flag to see if data already readed
+
+`output` - output file name with extension to use .write method
+
+
+### read data
+
+Can read data with all standart separators (iterating over DefaultConstants::COL_SEPS - `["\t", ",", ";", " ", "|", ":"]`)
+
+```
+csv_instance = CSVFile.new(file_name: "export_for_saller.csv") # create new instance
+csv_instance.info # show stat about file
+csv_instance.read # read file data - return array of arrays - allow to read file 
+csv_instance.smart_convert! - convert readed data into array of hashes with file headers keys
+```
+
+### write data
+
+```
+csv_instance.write(data_to_write: data, headers: headers) # write data in file with name provided with @destination instance variables
+```
+
+`data` - may be array of arrays or array of hashes -> will be automaticly converted while writing. If data is array of hashes - headers will be extracted from first data hash. Else - headers must be provided mannually.
 
 ## Development
 
@@ -32,8 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at hhttps://github.com/shamritskiy3468/csvn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/shamritskiy3468/csvn/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/shamritskiy3468/csvn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/shamritskiy3468/csvn/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -41,4 +73,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Csvn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/csvn/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Csvn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shamritskiy3468/csvn/blob/master/CODE_OF_CONDUCT.md).

data/csvn.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["shamritskiy3468"]
   spec.email         = ["sshamritskiy3468@gmail.com"]
 
-  spec.summary       = %q{Simple attemp to simplify routine work with CSV file.}
-  spec.description   = %q{Too lazy to write something, so use summary please :) }
+  spec.summary       = %q{Attemp to simplify routine work with CSV files (such as DB request result)}
+  spec.description   = %q{My simple gem for work with .csv data files. Can read data from files with any separator and allow work with them more comfortable.}
   spec.homepage      = "https://github.com/shamritskiy3468/csvn"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_dependency "colorize", "= 0.8.1"
 end

data/lib/csvn/version.rb

@@ -1,3 +1,3 @@
 module Csvn
-  VERSION = "0.1.4"
+  VERSION = "0.1.5.1"
 end

data/lib/csvn.rb

@@ -57,7 +57,7 @@ class CSVFile
   end
 
   # Only for string row values
-  # will be improved to be able to handle more complex selecting like SQL does
+  # will be improved to be able to handle more complex selecting like SQL does ----> multiple select
   def select(opts = {})
     return @data.select { |row| row[opts[:where]] =~ /#{opts[:like]}/ } if opts[:like]
     return @data.select { |row| row[opts[:where]] !~ /#{opts[:not_like]}/ } if opts[:not_like]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csvn
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5.1
 platform: ruby
 authors:
 - shamritskiy3468
@@ -9,8 +9,23 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2021-08-29 00:00:00.000000000 Z
-dependencies: []
-description: 'Too lazy to write something, so use summary please :) '
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: My simple gem for work with .csv data files. Can read data from files
+  with any separator and allow work with them more comfortable.
 email:
 - sshamritskiy3468@gmail.com
 executables: []
@@ -53,5 +68,5 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
-summary: Simple attemp to simplify routine work with CSV file.
+summary: Attemp to simplify routine work with CSV files (such as DB request result)
 test_files: []