data_file 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c624f6ed68a60ae3afff5246813a4e9412459d5f
+  data.tar.gz: 7d3e88e31be86b9e1eb9ae434aacef2344446624
+SHA512:
+  metadata.gz: b7f28ddbe7f0bcd16de77705f279fdf15430eacee720c341283b7f643eda316c32b35e89c88c488db1ee2e51fafb1b2e3eab62a255875e31474c44d1ad0d5eea
+  data.tar.gz: 78e46a94cb24e54992b3f3ec638c424d7a55f222137096bbf6861f45ca3a32047e778a87bc4b6fa880a639f633596d793b1569819ef1949b59c7687b0e52a479

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bruno Azisaka Maciel
+
+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,3 @@
+# DataFile
+
+This gem is used to read CSV, TXT and XLS/XLSX files. 

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/data_file.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_file"
+  spec.version       = DataFile::VERSION
+  spec.authors       = ["Bruno Azisaka Maciel"]
+  spec.email         = ["bruno@azisaka.com.br"]
+  spec.summary       = %q{Open data files with .csv, .txt, .xls, .xlsx extensions.}
+  spec.description   = %q{With a parser and file detector, you just need to provide the file and it will do the rest.}
+  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{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "mime-types"
+  spec.add_dependency "spreadsheet"
+end

data/lib/data_file.rb

@@ -0,0 +1,10 @@
+require "data_file/version"
+require "data_file/reader"
+require "data_file/reader/base"
+require "data_file/reader/csv"
+require "data_file/reader/excel"
+require "data_file/importer"
+require "data_file/detector"
+
+module DataFile
+end

data/lib/data_file/detector.rb

@@ -0,0 +1,23 @@
+require "mime-types"
+
+module DataFile
+  class Detector
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def text?
+      mime_type =~ /text\/(plain|csv|comma-separated-values)/
+    end
+
+    def encoding
+      file.external_encoding.name
+    end
+
+    def mime_type
+      MIME::Types.type_for(file.path).first.content_type
+    end
+  end
+end

data/lib/data_file/importer.rb

@@ -0,0 +1,35 @@
+module DataFile
+  class Importer
+    attr_reader :reader
+
+    def initialize(reader)
+      @reader = reader
+    end
+
+    def each_row(row)
+      if csv?
+        row
+      else
+        row = rows[row]
+        defined?(POI) ? row.cells.map(&:value) : row.to_a
+      end
+    end
+
+    def rows
+      @rows ||= csv? ? reader.parser.rows : reader.parser.rows_range.to_a
+    end
+
+    def each(&block)
+      rows.each do |row|
+        row = each_row(row)
+        if !row.all?(&:blank?) && row != reader.parser.headers
+          block.call(row)
+        end
+      end
+    end
+
+    def csv?
+      reader.parser.is_a?(Reader::CSV)
+    end
+  end
+end

data/lib/data_file/reader.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module DataFile
+  class Reader
+    attr_reader :file, :file_path, :options
+
+    def initialize(file_path, options = {})
+      @options = { headers: true }.merge(options) 
+      @file_path = file_path
+    end
+
+    def file
+      @file ||= File.open(file_path, 'r:iso-8859-1:utf-8')
+    end
+
+    def parser
+      @parser ||= detector.text? ? CSV.new(self) : Excel.new(self)
+    end
+
+    def detector
+      @detector ||= Detector.new(file)
+    end
+  end
+end

data/lib/data_file/reader/base.rb

@@ -0,0 +1,11 @@
+module DataFile
+  class Reader
+    class Base
+      attr_reader :reader
+
+      def initialize(reader)
+        @reader = reader
+      end
+    end
+  end
+end

data/lib/data_file/reader/csv.rb

@@ -0,0 +1,22 @@
+require "csv"
+
+module DataFile
+  class Reader
+    class CSV < Base
+      def headers
+        @headers ||= (csv.headers rescue nil) || []
+      end
+
+      def rows
+        @rows ||= csv.each_with_object([]) do |row, array|
+          array << (row.is_a?(::CSV::Row) ? row.to_hash.values : row)
+        end
+      end
+
+      private
+      def csv
+        @csv ||= ::CSV.parse(reader.file.read, reader.options)
+      end
+    end
+  end
+end

data/lib/data_file/reader/excel.rb

@@ -0,0 +1,40 @@
+begin
+  require "poi"
+rescue LoadError
+  require "spreadsheet"
+end
+
+module DataFile
+  class Reader
+    class Excel < Base
+      def headers
+        defined?(POI) ? rows[0].cells.map(&:value) : rows[0].to_a
+      end
+
+      def rows
+        worksheet.rows
+      end
+
+      def rows_range
+        (rows_index..rows.size)
+      end
+
+      def rows_index
+        reader.options[:headers] ? 1 : 0
+      end
+
+      def operator
+        defined?(POI) ? POI::Workbook : Spreadsheet
+      end
+
+      private
+      def excel
+        operator.open(reader.file_path)
+      end
+
+      def worksheet
+        excel.worksheets.first
+      end
+    end
+  end
+end

data/lib/data_file/version.rb

@@ -0,0 +1,3 @@
+module DataFile
+  VERSION = "0.0.2"
+end

data/spec/data_file/detector_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+require "data_file/detector"
+
+module DataFile
+  describe Detector do
+    let(:object) { described_class.new(file_path) }
+    let(:path) { "../../support/fixtures/#{file}" }
+    let(:file_path) { File.open(File.expand_path(path, __FILE__)) }
+
+    describe "#text?" do
+      subject { object.text? }
+
+      context "when the file is a xls" do
+        let(:file) { "test.xls" }
+        it { should be_false }
+      end
+
+      context "when the file is a xlsx" do
+        let(:file) { "test.xlsx" }
+        it { should be_false }
+      end
+
+      context "when the file is a txt" do
+        let(:file) { "test.txt" }
+        it { should be_true }
+      end
+
+      context "when the file is a csv" do
+        let(:file) { "test.csv" }
+        it { should be_true }
+      end
+    end
+  end
+end

data/spec/data_file/importer_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+require "data_file/importer"
+
+module DataFile
+  describe Importer do
+    let(:object) { described_class.new reader }
+    let(:reader) { double "reader" }
+  end
+end

data/spec/data_file/reader/csv_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+module DataFile
+  describe Reader::CSV do
+    let(:csv_file) do
+      File.open(File.expand_path("../../../support/fixtures/test.csv", __FILE__))
+    end
+    let(:txt_file) do
+      File.open(File.expand_path("../../../support/fixtures/test.txt", __FILE__))
+    end
+
+    let(:file) { csv_file }
+    let(:object) { described_class.new reader }
+    let(:reader) { Reader.new file, options }
+    let(:options) { { } }
+
+    describe "#rows" do
+      subject { object.rows }
+
+      context "when the headers option is true" do
+        let(:options) { { headers: true } }
+
+        it { should == [ ["Does", "It", "Work", "?"] ] }
+      end
+
+      context "when the headers option is false" do
+        let(:options) { { headers: false } }
+
+        it { should == [ ["This", "Is", "A", "Test"],
+                         ["Does", "It", "Work", "?"] ] }
+      end
+
+      context "when the headers option is not defined" do
+        it { should == [ ["Does", "It", "Work", "?"] ] }
+      end
+    end
+
+    describe "#headers" do
+      subject { object.headers }
+      it { should == ["This", "Is", "A", "Test"] }
+    end
+  end
+end

data/spec/data_file/reader/excel_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+require "data_file/reader"
+
+module DataFile
+  describe Reader::Excel do
+    let(:xls_file) do
+      File.open(File.expand_path("../../../support/fixtures/test.xls", __FILE__))
+    end
+
+    let(:object) { described_class.new reader }
+    let(:reader) { Reader.new xls_file, options }
+    let(:options) { { } }
+
+    describe "#rows" do
+      subject { object.rows }
+
+      if defined?(POI)
+        it { should be_kind_of POI::Rows }
+      else
+        its(:first) { should be_kind_of Spreadsheet::Excel::Row }
+      end
+    end
+
+    describe "#rows_range" do
+      subject { object.rows_range }
+
+      context "when the headers option is true" do
+        let(:options) { { headers: true } }
+        it { should == (1..45) }
+      end
+
+      context "when the headers option is false" do
+        let(:options) { { headers: false } }
+        it { should == (0..45) }
+      end
+
+      context "when the headers option is not defined" do
+        let(:options) { { } }
+        it { should == (1..45) }
+      end
+    end
+
+    describe "#rows_index" do
+      subject { object.rows_index }
+
+      context "when the headers option is true" do
+        let(:options) { { headers: true } }
+        it { should == 1 }
+      end
+
+      context "when the headers option is false" do
+        let(:options) { { headers: false } }
+        it { should == 0 }
+      end
+
+      context "when the headers option is not defined" do
+        let(:options) { { } }
+        it { should == 1 }
+      end
+    end
+  end
+end

data/spec/data_file/reader_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+require "data_file/reader"
+
+module DataFile
+  describe Reader do
+    let(:object) { described_class.new "file_path" }
+
+    describe "#parser" do
+      subject { object.parser }
+
+      context "when the file is text" do
+        before { object.stub_chain(:detector, :text?).and_return(true) }
+        it { should be_kind_of Reader::CSV }
+      end
+
+      context "when the file is a spreadsheet" do
+        before { object.stub_chain(:detector, :text?).and_return(false) }
+        it { should be_kind_of Reader::Excel }
+      end
+    end
+
+    describe "#detector" do
+      let(:file) { double "file" }
+      before { object.stub(:file).and_return(file) }
+      subject { object.detector }
+
+      it { should be_kind_of(Detector) }
+      its(:file) { should == file }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require "data_file"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/spec/support/fixtures/test.csv

@@ -0,0 +1,2 @@
+This,Is,A,Test
+Does,It,Work,?

data/spec/support/fixtures/test.txt

@@ -0,0 +1,2 @@
+This,Is,A,Test
+Does,It,Work,?

data/spec/support/fixtures/test_with_more_items.csv

@@ -0,0 +1,5 @@
+This,Is,A,Test
+Does,It,Work,?
+?,Work,It,Does
+A,B,C,D
+D,C,B,A

data/spec/support/fixtures/test_with_two_fields.csv

@@ -0,0 +1,2 @@
+field1,field2,field3,field4,field5
+Hello,World,email@test.com,200,9.5

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: data_file
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bruno Azisaka Maciel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  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'
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  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: With a parser and file detector, you just need to provide the file and
+  it will do the rest.
+email:
+- bruno@azisaka.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data_file.gemspec
+- lib/data_file.rb
+- lib/data_file/detector.rb
+- lib/data_file/importer.rb
+- lib/data_file/reader.rb
+- lib/data_file/reader/base.rb
+- lib/data_file/reader/csv.rb
+- lib/data_file/reader/excel.rb
+- lib/data_file/version.rb
+- spec/data_file/detector_spec.rb
+- spec/data_file/importer_spec.rb
+- spec/data_file/reader/csv_spec.rb
+- spec/data_file/reader/excel_spec.rb
+- spec/data_file/reader_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/test.aaa
+- spec/support/fixtures/test.csv
+- spec/support/fixtures/test.txt
+- spec/support/fixtures/test.xls
+- spec/support/fixtures/test.xlsx
+- spec/support/fixtures/test_with_more_items.csv
+- spec/support/fixtures/test_with_more_items.xls
+- spec/support/fixtures/test_with_two_fields.csv
+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.0
+signing_key: 
+specification_version: 4
+summary: Open data files with .csv, .txt, .xls, .xlsx extensions.
+test_files:
+- spec/data_file/detector_spec.rb
+- spec/data_file/importer_spec.rb
+- spec/data_file/reader/csv_spec.rb
+- spec/data_file/reader/excel_spec.rb
+- spec/data_file/reader_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/test.aaa
+- spec/support/fixtures/test.csv
+- spec/support/fixtures/test.txt
+- spec/support/fixtures/test.xls
+- spec/support/fixtures/test.xlsx
+- spec/support/fixtures/test_with_more_items.csv
+- spec/support/fixtures/test_with_more_items.xls
+- spec/support/fixtures/test_with_two_fields.csv
+has_rdoc: