recite_csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8492257e8882c0950b3bd4fe923537cbb0b94822
+  data.tar.gz: d5d2eca503ee999109e44dedb9e0296fcaa9c91d
+SHA512:
+  metadata.gz: 17a59c273f7487aac65ad7a0e121e50fb9b830fe7653b434d54bf84e4422411b900dc5a3dfc2b90b8dacdd20667a35ee299e0cc2ca80b359b785797548681f3f
+  data.tar.gz: 3e3dd79a098ece2b2fe80fdd96d399b41551b226923aae8edba873db7c76d91c4b2d08f46b4e17d4c0cb030d3d9bc56c66b375789b0793243d535c04c02d4177

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+  - 2.4.2
+before_install: gem install bundler -v 1.14.6
+script:
+  - bundle install
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+- Initial Release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in recite_csv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuji Hanamura
+
+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,126 @@
+# ReciteCSV
+
+ReciteCSV helps to build a class for CSV reader.
+
+[![Build Status](https://travis-ci.org/yujideveloper/recite_csv.svg?branch=master)](https://travis-ci.org/yujideveloper/recite_csv)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recite_csv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recite_csv
+
+## Usage
+
+The following is a example csv file.
+
+``` csv
+COL1,COL2
+VALUE1,VALUE2
+VALUE3,VALUE4
+```
+
+Specify header definition using hash object.
+
+``` ruby
+class Foo
+  include ReciteCSV::Reader::Builder.new(col1: "COL1", col2: "COL2")
+end
+
+Foo.new("./example.csv").each do |row|
+  row.class # => Foo::Row
+  row.col1
+  row.col2
+end
+```
+
+Specify header definition using array object.
+
+``` ruby
+class Bar
+  include ReciteCSV::Reader::Builder.new(%w[col1 col2])
+end
+
+Bar.new("./example.csv").each do |row|
+  row.class # => Bar::Row
+  row.col1
+  row.col2
+end
+```
+
+Define custom methods of row object.
+
+``` ruby
+class Baz
+  include(
+    ReciteCSV::Reader::Builder.new(col1: "COL1", col2: "COL2") do
+      # define methods of Row class
+      def col1
+        "override #{super}"
+      end
+
+      def custom_method
+        # do somethings..
+      end
+    end
+  )
+end
+
+Baz.new("./example.csv").each do |row|
+  row.class # => Baz::Row
+  row.col1
+  row.col2
+  row.custom_method
+end
+```
+
+Define custom methods of row object using `row_methods`.
+
+``` ruby
+class Quz
+  include ReciteCSV::Reader::Builder.new(col1: "COL1", col2: "COL2")
+
+  row_methods do
+    def col1
+      "override #{super}"
+    end
+
+    def custom_method
+      # do somethings..
+    end
+  end
+end
+
+Quz.new("./example.csv").each do |row|
+  row.class # => Quz::Row
+  row.col1
+  row.col2
+  row.custom_method
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yujideveloper/recite_csv.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "recite_csv"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/recite_csv/header/definition.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  module Header
+    module Definition
+      class Base
+        attr_reader :raw_definition
+
+        def initialize(raw_definition)
+          @raw_definition = raw_definition
+        end
+
+        def build_column_methods_module
+          self.class::ColumnMethodsBuilder.new(self.raw_definition)
+        end
+
+        def default_csv_options
+          {}.freeze
+        end
+
+        def self.new(*)
+          if self == Base
+            raise ::NotImplementedError, "#{self} is an abstract class and cannot be instantiated."
+          end
+          super
+        end
+      end
+
+      class Hash < Base
+        DEFAULT_CSV_OPIONS = { headers: :first_row }.freeze
+
+        class ColumnMethodsBuilder < ::Module
+          def initialize(raw_definition)
+            raw_definition.each do |method_name, header_name|
+              define_method method_name do
+                self[header_name]
+              end
+            end
+          end
+        end
+
+        def default_csv_options
+          DEFAULT_CSV_OPIONS
+        end
+      end
+
+      class Array < Base
+        class ColumnMethodsBuilder < ::Module
+          def initialize(raw_definition)
+            raw_definition.each.with_index do |name, idx|
+              next if name.nil? || name.empty?
+              define_method name do
+                self[idx]
+              end
+            end
+          end
+        end
+      end
+
+      DEFINITIONS = {
+        ::Hash => Hash,
+        ::Array => Array
+      }.freeze
+
+      module_function
+
+      def dispatch(header_definition)
+        _, definition_class = DEFINITIONS.find { |klass, _| header_definition.is_a? klass }
+        raise ::ArgumentError, "Unexpected header definition type" unless definition_class
+        definition_class.new(header_definition)
+      end
+    end
+  end
+end

data/lib/recite_csv/header.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  module Header
+  end
+end
+
+require "recite_csv/header/definition"

data/lib/recite_csv/module.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+end

data/lib/recite_csv/reader/builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "recite_csv/header"
+require "recite_csv/row"
+require "recite_csv/reader/core"
+require "recite_csv/reader/dsl"
+
+module ReciteCSV
+  module Reader
+    class Builder < ::Module
+      def initialize(header_definition, &block)
+        definition = Header::Definition.dispatch(header_definition)
+        @definition = definition
+        @row_class = ::Class.new(Row::Base) do |klass|
+          klass.include definition.build_column_methods_module
+          klass.class_exec(&block) if block_given?
+        end
+      end
+
+      def included(class_or_module)
+        class_or_module.include Core
+        class_or_module.const_set(:Row, @row_class)
+        class_or_module.const_set(:DEFAULT_CSV_OPIONS, @definition.default_csv_options)
+        class_or_module.extend DSL
+      end
+    end
+  end
+end

data/lib/recite_csv/reader/core.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module ReciteCSV
+  module Reader
+    module Core
+      include Enumerable
+
+      attr_reader :file, :csv_options
+
+      def initialize(file, csv_options = {})
+        @file = file
+        @csv_options = (csv_options || {}).merge(self.class::DEFAULT_CSV_OPIONS)
+      end
+
+      def each
+        if block_given?
+          ::CSV.foreach(self.file, self.csv_options) do |raw_row|
+            yield self.class::Row.new(raw_row)
+          end
+        else
+          self.to_enum
+        end
+      end
+    end
+  end
+end

data/lib/recite_csv/reader/dsl.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  module Reader
+    module DSL
+      def row_methods(&block)
+        self::Row.class_exec(&block)
+      end
+    end
+  end
+end

data/lib/recite_csv/reader.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  module Reader
+  end
+end
+
+require "recite_csv/reader/builder"

data/lib/recite_csv/row/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  module Row
+    class Base
+      attr_reader :raw_data
+
+      def initialize(raw_data)
+        @raw_data = raw_data
+      end
+
+      def [](key)
+        self.raw_data[key]
+      end
+    end
+  end
+end

data/lib/recite_csv/row.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  module Row
+  end
+end
+
+require "recite_csv/row/base"

data/lib/recite_csv/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ReciteCSV
+  VERSION = "0.1.0"
+end

data/lib/recite_csv.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "recite_csv/module"
+require "recite_csv/version"
+require "recite_csv/reader"

data/recite_csv.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "recite_csv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "recite_csv"
+  spec.version       = ReciteCSV::VERSION
+  spec.authors       = ["Yuji Hanamura"]
+  spec.email         = ["yuji.developer@gmail.com"]
+
+  spec.summary       = "ReciteCSV helps to build a class for CSV reader."
+  spec.description   = "ReciteCSV helps to build a class for CSV reader."
+  spec.homepage      = "https://github.com/yujideveloper/recite_csv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: recite_csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Hanamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: ReciteCSV helps to build a class for CSV reader.
+email:
+- yuji.developer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/recite_csv.rb
+- lib/recite_csv/header.rb
+- lib/recite_csv/header/definition.rb
+- lib/recite_csv/module.rb
+- lib/recite_csv/reader.rb
+- lib/recite_csv/reader/builder.rb
+- lib/recite_csv/reader/core.rb
+- lib/recite_csv/reader/dsl.rb
+- lib/recite_csv/row.rb
+- lib/recite_csv/row/base.rb
+- lib/recite_csv/version.rb
+- recite_csv.gemspec
+homepage: https://github.com/yujideveloper/recite_csv
+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.6.13
+signing_key: 
+specification_version: 4
+summary: ReciteCSV helps to build a class for CSV reader.
+test_files: []