csv_files 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21d49d53fcf95ff07842f2d2149fb1591e6ab89f
+  data.tar.gz: f091feec0c93607120f6c69526a20b5b70cd3615
+SHA512:
+  metadata.gz: 54e5895a4dbba909d36b2c6079ab83242e3deeb9f8850318c64e90bcb435cb824100c5fe098bebbe24b93a8243aee61dc081614b3c3a34ae9974ad5ff9f8e179
+  data.tar.gz: ebdcf6c5b30460ab5d739269c3ab0f7e901a60cafdb25d547c1f6571ec00c79c068352171104ef6c27bb811d891d53213d6fc761fc168d8436a4c46a98622cb0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csv_files.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Damien Brzoska
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# CsvFiles
+
+CSV files generator for large datasets. This gem let you save large datasets as soon as the row limit (default to 10_000) is reach.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csv_files'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_files
+
+## Usage
+
+```ruby
+csv = CsvFiles::Generator.new("path-to-export-file", ['header', 'values', 'goes', 'here'], 10_000)
+```
+
+You need to define you storing method as follow:
+
+```ruby
+csv.store_fn = lambda do |filename, text|
+  puts filename
+  puts text
+  # You can store this to S3 or your file system in this block
+end
+```
+
+To insert data you can use the following:
+
+```ruby
+csv << ['my', 'values', 'go', 'here']
+```
+
+A file will automatically be created as soon as the limit is reach. If the limit isn't reach, call the following method:
+
+```ruby
+csv.store
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/csv_files/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/csv_files.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv_files/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv_files"
+  spec.version       = CsvFiles::VERSION
+  spec.authors       = ["Damien Brzoska"]
+  spec.email         = ["damien.brz@gmail.com"]
+  spec.description   = %q{CSV files generator for large datasets}
+  spec.summary       = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/csv_files.rb

@@ -0,0 +1,54 @@
+require 'csv'
+require "csv_files/version"
+
+module CsvFiles
+  class Generator
+    attr_accessor :filename, :headers, :limit, :items, :count, :store_fn
+
+    def initialize(filename, headers, limit = 10_000)
+      raise "Filename must be present" if filename.nil? || filename.to_s == ""
+      raise "Headers must be present" if headers.nil?
+      raise "Headers must be an array" if !headers.is_a?(Array) || headers.size.zero?
+      raise "Limit must be a number" if !limit.is_a?(Numeric)
+
+      self.filename = formatted_filename(filename.to_s)
+      self.limit = limit.round
+      self.headers = headers
+      self.items = Array.new()
+      self.count = 0
+    end
+
+    def <<(row)
+      @items << row
+      store if limit_reached?
+      row
+    end
+
+    def store
+      csv = CSV.generate do |r|
+        r << @headers
+        @items.each { |i| r << i }
+      end
+      store_fn.call(generated_filename, csv)
+      @items.clear
+      @count += 1
+    end
+
+    private
+    def limit_reached?
+      @items.size >= @limit
+    end
+
+    def generated_filename
+      "#{@filename}-#{@count}.csv"
+    end
+
+    def formatted_filename(name)
+      if (match = name.match(/(.*)(\.csv)$/))
+        match[1]
+      else
+        name
+      end
+    end
+  end
+end

data/lib/csv_files/version.rb

@@ -0,0 +1,3 @@
+module CsvFiles
+  VERSION = "0.0.1"
+end

data/spec/csv_files_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe CsvFiles::Generator do
+  it "should be initialize with at least a filename" do
+    subject = CsvFiles::Generator.new("my-file-name", ['email'], 1_000)
+    expect(subject.filename).to eq("my-file-name")
+    expect(subject.limit).to eq(1_000)
+  end
+
+  it "should raise an exception when filename is missing or headers are missing or limit is not a number" do
+    expect { CsvFiles::Generator.new() }.to raise_error
+    expect { CsvFiles::Generator.new('filename') }.to raise_error
+    expect { CsvFiles::Generator.new('filename', ['email'], 'abc') }.to raise_error
+  end
+
+  describe "#<<" do
+    subject { CsvFiles::Generator.new("export", ['value'], 1) }
+
+    it "should raise an error if #store_fn has not be set" do
+      expect {
+        subject << [1]
+      }.to raise_error
+    end
+
+    it "shouldn't raise an error if #store_fn has been defined" do
+      subject.store_fn = lambda { |name, text| puts "#{name} - #{text}" }
+
+      expect {
+        subject << [1]
+      }.to output("export-0.csv - value\n1\n").to_stdout
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'csv_files'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: csv_files
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Damien Brzoska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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 files generator for large datasets
+email:
+- damien.brz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- csv_files.gemspec
+- lib/csv_files.rb
+- lib/csv_files/version.rb
+- spec/csv_files_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/csv_files_spec.rb
+- spec/spec_helper.rb