rcsv_loader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f581428c6e050728dbc4aa92a115ecd9c1441621
+  data.tar.gz: cd70140fdf7f62279bb6b28e01dd36ab0c9411f3
+SHA512:
+  metadata.gz: 8e0da230d509d4dca60d489d23551c8fda507d672ef33f372cfba747fe2b2ea904f1e1c531d67e1db72461bbc89452293cb0346a033f6a4da8702b5de25fdcba
+  data.tar.gz: 904038d9043c618727974778f5b93ea265abb6d8ac9f042ccec4a8867e60dabe5b0531a3403aa47ff8e1997292dfb2d8445e2cf5f768eb575aacca762c980de6

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Osadake212
+
+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,76 @@
+# RCsvLoader
+
+Mange a csv file more easily.
+
+[![Build Status](https://travis-ci.org/osadake212/rcsv_loader.svg?branch=master)](https://travis-ci.org/osadake212/rcsv_loader)
+
+## Usage
+
+Only 3 steps to start.
+
+### 0. Prepare a csv file.
+
+```
+
+"id","file name"
+"1","file_01.zip"
+
+```
+
+### 1. Define a class that represent csv schema.
+
+```ruby
+
+require 'rcsv_loader'
+
+class SampleCsv < RCsvLoader::Base
+  column 'id'
+  column 'file name', :file_name
+end
+
+```
+
+### 2. Load csv file with options.
+
+```ruby
+
+sample = SampleCsv.load_file csv_file_path, encoding: 'utf-8', headers: true
+
+```
+
+### 3. Get values with the accessor that is previously defined.
+
+```ruby
+
+rows = sample.where({ :id => "1" })
+p rows.first.file_name # => "file_01.zip"
+
+```
+
+### More
+
+[More information](https://github.com/osadake212/rcsv_loader/wiki).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rcsv_loader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rcsv_loader
+
+## Contributing
+
+1. Fork it ( https://github.com/osadake212/rcsv_loader/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 @@
+require "bundler/gem_tasks"

data/lib/rcsv_loader/version.rb

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

data/lib/rcsv_loader.rb

@@ -0,0 +1,140 @@
+require "rcsv_loader/version"
+require 'csv'
+
+module RCsvLoader
+
+  attr_reader :headers
+
+  #
+  # Define accessor names for csv column.
+  #
+  def column column_name, alias_name = nil
+    alias_name = column_name.to_sym unless alias_name
+    @headers = all_headers
+    @headers.merge!(alias_name => column_name)
+    define_row(@headers)
+  end
+
+  #
+  # Define headers for no headers csv.
+  #
+  def insert_headers headers = []
+    @headers = Hash[headers.map.with_index { |e, i| [e, i] }]
+    define_row(@headers)
+  end
+
+  class Base
+    extend RCsvLoader
+    extend Forwardable
+
+    #
+    # Laod a csv file
+    #
+    #   options: The options for 'csv' which is Ruby's built-in library.
+    #
+    def self.load_csv file, options = {}
+
+      rows = CSV.readlines file, options
+
+      rows = yield rows if block_given?
+
+      self.new rows.map { |row| self::Row.new row }
+    end
+
+    def_delegators :@rows, :+, :<<
+
+    def initialize rows = []
+      @rows = rows
+    end
+
+    def all
+      @rows
+    end
+
+    #
+    # params = {
+    #   :#{accessor_name} => expected_value,
+    #   ...
+    # }
+    #
+    # compare with '=='
+    #
+    # return empty array if the condition is invalid or couldn't find any rows.
+    #
+    def where params = {}
+      return @rows if params.empty?
+
+      # filter the conditions.
+      params.select! do |k, v|
+        self.class.headers.keys.any? { |key| key.to_s == k.to_s }
+      end
+
+      return [] if params.empty?
+
+      @rows.select do |row|
+        params.all? { |attr, con| (row.send attr) == con }
+      end
+
+    end
+
+    #
+    # Convert to csv string
+    #
+    # options: {
+    #   headers: boolean
+    # }
+    #
+    def to_csv options = {}
+      csv = ""
+      csv += CSV.generate_line(self.class.headers.map { |k, v| v } ) if options[:headers]
+      csv += @rows.map(&:to_csv).join
+    end
+  end
+
+  private
+  #
+  # Get headers that include super class's one.
+  #
+  def all_headers current_class = nil
+    current_class ||= self
+    return {} if current_class == Base
+    current_header = current_class.headers || {}
+    return current_header.merge all_headers(current_class.superclass)
+  end
+
+  #
+  # Define a class which represent a row of csv.
+  #
+  def define_row headers
+    headers ||= {}
+
+    # get the superclass for Row
+    baseclass = if superclass.const_defined? :Row
+                  superclass::Row
+                else
+                  Object
+                end
+
+    # remove class definition
+    if const_defined? :Row and baseclass != self::Row
+      self.send :remove_const, :Row
+    end
+
+    # define Row class
+    const_set :Row, (Class.new(baseclass) do
+
+      attr_accessor *headers.keys
+
+      define_method :initialize do |line = {}|
+        headers.each do |k, v|
+          instance_variable_set "@#{k.to_s}", line[v]
+        end
+      end
+
+      define_method :to_csv do
+        CSV.generate_line headers.map { |k, v| self.send k }
+      end
+
+    end)
+  end
+end

data/rcsv_loader.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rcsv_loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rcsv_loader"
+  spec.version       = RCsvLoader::VERSION
+  spec.authors       = ["osadake212"]
+  spec.email         = ["osadake.212@gmail.com"]
+  spec.summary       = %q{A simple csv loader.}
+  spec.description   = %q{A simple csv loader.}
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/spec/fixtures/no_headers_sample.csv

@@ -0,0 +1,2 @@
+"1","file_01.zip","zip","https://example.com/file_01.zip"
+"2","file_02.zip","zip","https://example.com/file_02.zip"

data/spec/fixtures/sample.csv

@@ -0,0 +1,3 @@
+"id","file name","extension","url"
+"1","file_01.zip","zip","https://example.com/file_01.zip"
+"2","file_02.zip","zip","https://example.com/file_02.zip"

data/spec/models/sample_csv.rb

@@ -0,0 +1,8 @@
+require 'rcsv_loader'
+
+class SampleCsv < RCsvLoader::Base
+  column 'id'
+  column 'file name', :file_name
+  column 'extension'
+  column 'url'
+end

data/spec/models/sample_csv_no_headers.rb

@@ -0,0 +1,5 @@
+require 'rcsv_loader'
+
+class SampleCsvNoHeaders < RCsvLoader::Base
+  insert_headers ['id', 'file_name', 'extension', 'url']
+end

data/spec/rcsv_loader_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+require 'pathname'
+
+require 'models/sample_csv'
+require 'models/sample_csv_no_headers'
+
+describe RCsvLoader do
+  it 'has a version number' do
+    expect(RCsvLoader::VERSION).not_to be nil
+  end
+
+  context "sample" do
+
+    shared_examples 'Row attributes' do |expected|
+      expected.each do |attr_name|
+        it { is_expected.to respond_to attr_name }
+      end
+    end
+
+    shared_examples "where" do |expected|
+      describe "data count" do
+        subject { results.count }
+        it { is_expected.to eq expected[:data_count] }
+      end
+
+      context "first row" do
+        subject(:row) { results.first }
+        describe "file name" do
+          subject { row.file_name }
+          it { is_expected.to eq expected[:first_row][:file_name] }
+        end
+        describe "extension" do
+          subject { row.extension }
+          it { is_expected.to eq expected[:first_row][:extension] }
+        end
+        describe "url" do
+          subject { row.url }
+          it { is_expected.to eq expected[:first_row][:url] }
+        end
+      end
+    end
+
+
+    context "with headers" do
+      let(:sample) do
+        path = File.join(Pathname(__FILE__).dirname, "fixtures/sample.csv")
+        SampleCsv.load_csv(path, :headers => true)
+      end
+
+      describe "data count" do
+        subject { sample.all.count }
+        it { is_expected.to eq 2 }
+      end
+
+      context "first row" do
+        subject { sample.all.first }
+        expected = [:id, :file_name, :extension, :url]
+        it_behaves_like 'Row attributes', expected
+      end
+
+      describe "where" do
+        context ':id => "2"' do
+          let(:results) { sample.where({ :id => "2" }) }
+          expected = {
+            :data_count => 1,
+            :first_row  => {
+              :file_name => "file_02.zip",
+              :extension => "zip",
+              :url       => "https://example.com/file_02.zip"
+            }
+          }
+          it_behaves_like "where", expected
+        end
+
+        context ':id => "1", :extension => "zip"' do
+          let(:results) { sample.where({ :id => "1", :extension => "zip" }) }
+          expected = {
+            :data_count => 1,
+            :first_row  => {
+              :file_name => "file_01.zip",
+              :extension => "zip",
+              :url       => "https://example.com/file_01.zip"
+            }
+          }
+          it_behaves_like "where", expected
+        end
+      end
+    end
+
+    context "with no_headers" do
+      let(:sample) do
+        path = File.join(Pathname(__FILE__).dirname, "fixtures/no_headers_sample.csv")
+        SampleCsvNoHeaders.load_csv path
+      end
+
+      describe "data count" do
+        subject { sample.all.count }
+        it { is_expected.to eq 2 }
+      end
+
+      context "first row" do
+        subject { sample.all.first }
+        expected = [:id, :file_name, :extension, :url]
+        it_behaves_like 'Row attributes', expected
+      end
+
+      describe "where" do
+        context ':extension => "zip"' do
+          let(:results) { sample.where({ :extension => "zip" }) }
+          expected = {
+            :data_count => 2,
+            :first_row  => {
+              :file_name => "file_01.zip",
+              :extension => "zip",
+              :url       => "https://example.com/file_01.zip"
+            }
+          }
+          it_behaves_like "where", expected
+        end
+
+        context ':id => "1", :extension => "zip"' do
+          let(:results) { sample.where({ :id => "1", :extension => "zip" }) }
+          expected = {
+            :data_count => 1,
+            :first_row  => {
+              :file_name => "file_01.zip",
+              :extension => "zip",
+              :url       => "https://example.com/file_01.zip"
+            }
+          }
+          it_behaves_like "where", expected
+        end
+      end
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rcsv_loader'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rcsv_loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- osadake212
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A simple csv loader.
+email:
+- osadake.212@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rcsv_loader.rb
+- lib/rcsv_loader/version.rb
+- rcsv_loader.gemspec
+- spec/fixtures/no_headers_sample.csv
+- spec/fixtures/sample.csv
+- spec/models/sample_csv.rb
+- spec/models/sample_csv_no_headers.rb
+- spec/rcsv_loader_spec.rb
+- spec/spec_helper.rb
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A simple csv loader.
+test_files:
+- spec/fixtures/no_headers_sample.csv
+- spec/fixtures/sample.csv
+- spec/models/sample_csv.rb
+- spec/models/sample_csv_no_headers.rb
+- spec/rcsv_loader_spec.rb
+- spec/spec_helper.rb