rom-csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b4fa0eb73ae4be19bf5c40473f3015d008127f0
+  data.tar.gz: 7258ee79e604d5fd2698ca7987ff2e617ec87875
+SHA512:
+  metadata.gz: 55d0a0a264ff0f404e1fd55d122aba626b740dbe4e42b8638055123e7b0d3d4ed7fcf397e3717e93442a25f2715494c3b6d1776144b3a22dd4e9f29aa1d75031
+  data.tar.gz: 7a5c75411dc268e9d6eb7fc7578f292b1d1a0757525bc2d0d2923f284fa3b64a33207eb6e3e09bc95db42d4d89c519a975e12055194e26238b14ac96176e4a45

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 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,67 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# No need to handle LoadError in rake
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/*.rake
+
+# The enforced style doesn’t match Vim’s defaults
+Style/AlignParameters:
+  Enabled: false
+
+# UTF-8 is perfectly fine in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow using braces for value-returning blocks
+Style/Blocks:
+  Enabled: false
+
+# Documentation checked by Inch CI
+Style/Documentation:
+  Enabled: false
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# Need to be skipped for >-> usage
+Style/Lambda:
+  Enabled: false
+
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Even a single escaped slash can be confusing
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Need to be skipped for >-> usage
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Accept both single and double quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Allow def self.foo; @foo; end
+Style/TrivialAccessors:
+  Enabled: false
+
+# Allow rom-csv
+Style/FileName:
+  Enabled: false
+
+# Allow logical `or`/`and` in conditionals
+Style/AndOr:
+  EnforcedStyle: conditionals

data/.rubocop_todo.yml

@@ -0,0 +1,6 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-17 15:00:06 +0100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+bundler_args: --without tools
+script: "bundle exec rake ci"
+env:
+  - CODECLIMATE_REPO_TOKEN=a49f28520e49a35d73c9b6ed3d78ae110e4a5d05b9f154b999578a5175add09d
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1 2015-03-22
+
+First public release

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rom', git: 'https://github.com/rom-rb/rom.git', branch: 'master'
+  gem 'rspec', '~> 3.1'
+  gem 'codeclimate-test-reporter', require: false
+  gem 'inflecto'
+end
+
+group :tools do
+  gem 'rubocop'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Don Morrison
+
+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,42 @@
+[gem]: https://rubygems.org/gems/rom-csv
+[travis]: https://travis-ci.org/rom-rb/rom-csv
+[gemnasium]: https://gemnasium.com/rom-rb/rom-csv
+[codeclimate]: https://codeclimate.com/github/rom-rb/rom-csv
+[inchpages]: http://inch-ci.org/github/rom-rb/rom-csv
+
+# ROM::CSV
+
+[![Gem Version](https://badge.fury.io/rb/rom-csv.svg)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-csv.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-csv.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-csv/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-csv/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-csv.svg?branch=master)][inchpages]
+
+CSV support for [Ruby Object Mapper](https://github.com/rom-rb/rom)
+
+**Note: rom-csv is read only at the moment.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rom-csv"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-csv
+
+## Usage
+
+See `spec/integration/repository_spec.rb` or [examples/](https://github.com/rom-rb/rom-csv/tree/master/examples) folder for a sample usage.
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+desc "Run CI tasks"
+task ci: [:spec, :examples]

data/examples/README.md

@@ -0,0 +1,3 @@
+# Examples for ROM::CSV
+
+This folder contains sample usage of ROM::CSV.

data/examples/find_user.rb

@@ -0,0 +1,30 @@
+require 'bundler'
+Bundler.setup
+
+require 'rom/csv'
+require 'ostruct'
+
+csv_file = ARGV[0] || File.expand_path("./users.csv", File.dirname(__FILE__))
+
+setup = ROM.setup(:csv, csv_file)
+setup.relation(:users) do
+  def by_name(name)
+    restrict(name: name)
+  end
+end
+
+class User < OpenStruct
+end
+
+setup.mappers do
+  define(:users) do
+    register_as :entity
+    model User
+  end
+end
+
+rom = setup.finalize
+user = rom.relation(:users).as(:entity).by_name('Jane').one
+# => #<User id=2, name="Jane", email="jane@doe.org">
+
+user or abort "user not found"

data/examples/users.csv

@@ -0,0 +1,3 @@
+id,name,email
+1,Julie,julie.andrews@example.com
+2,Jane,jane@doe.org

data/lib/rom-csv.rb

@@ -0,0 +1 @@
+require 'rom/csv'

data/lib/rom/csv.rb

@@ -0,0 +1,8 @@
+require 'csv'
+
+require 'rom'
+require 'rom/csv/version'
+require 'rom/csv/repository'
+require 'rom/csv/relation'
+
+ROM.register_adapter(:csv, ROM::CSV)

data/lib/rom/csv/dataset.rb

@@ -0,0 +1,17 @@
+require 'rom/memory/dataset'
+
+module ROM
+  module CSV
+    # Dataset for CSV
+    #
+    # @api public
+    class Dataset < ROM::Memory::Dataset
+      # Convert each CSV::Row to a hash
+      #
+      # @api public
+      def self.row_proc
+        -> row { row.to_hash }
+      end
+    end
+  end
+end

data/lib/rom/csv/relation.rb

@@ -0,0 +1,16 @@
+require 'rom/relation'
+
+module ROM
+  module CSV
+    # Relation subclass of CSV adapter
+    #
+    # @example
+    #   class Users < ROM::Relation[:csv]
+    #   end
+    #
+    # @api public
+    class Relation < ROM::Relation
+      forward :join, :project, :restrict, :order
+    end
+  end
+end

data/lib/rom/csv/repository.rb

@@ -0,0 +1,97 @@
+require 'rom/repository'
+require 'rom/csv/dataset'
+
+# Ruby Object Mapper
+#
+# @see http://rom-rb.org/
+module ROM
+  # CSV support for ROM
+  #
+  # @example
+  #   require 'rom/csv'
+  #   require 'ostruct'
+  #
+  #   setup = ROM.setup(:csv, "./spec/fixtures/users.csv")
+  #   setup.relation(:users) do
+  #     def by_name(name)
+  #       dataset.find_all { |row| row[:name] == name }
+  #     end
+  #   end
+  #
+  #   class User < OpenStruct
+  #   end
+  #
+  #   setup.mappers do
+  #     define(:users) do
+  #       model User
+  #     end
+  #   end
+  #
+  #   rom = setup.finalize
+  #   p rom.read(:users).by_name('Jane').one
+  #   # => #<User id=2, name="Jane", email="jane@doe.org">
+  #
+  # **Note: rom-csv is read only at the moment.**
+  #
+  # @api public
+  module CSV
+    # CSV repository interface
+    #
+    # @api public
+    class Repository < ROM::Repository
+      # Expect a path to a single csv file which will be registered by rom to
+      # the given name or :default as the repository.
+      #
+      # Uses CSV.table which passes the following csv options:
+      # * headers: true
+      # * converters: numeric
+      # * header_converters: :symbol
+      #
+      # @param path [String] path to csv
+      #
+      # @api private
+      #
+      # @see CSV.table
+      def initialize(path)
+        @datasets = {}
+        @connection = ::CSV.table(path).by_row!
+      end
+
+      # Return dataset with the given name
+      #
+      # @param name [String] dataset name
+      # @return [Dataset]
+      #
+      # @api public
+      def [](name)
+        datasets[name]
+      end
+
+      # Register a dataset in the repository
+      #
+      # If dataset already exists it will be returned
+      #
+      # @param name [String] dataset name
+      # @return [Dataset]
+      #
+      # @api public
+      def dataset(name)
+        datasets[name] = Dataset.new(connection)
+      end
+
+      # Check if dataset exists
+      #
+      # @param name [String] dataset name
+      #
+      # @api public
+      def dataset?(name)
+        datasets.key?(name)
+      end
+
+      private
+
+      # @api private
+      attr_reader :datasets
+    end
+  end
+end

data/lib/rom/csv/version.rb

@@ -0,0 +1,5 @@
+module ROM
+  module CSV
+    VERSION = '0.0.1'.freeze
+  end
+end

data/rakelib/examples.rake

@@ -0,0 +1,6 @@
+desc "Run all samples from examples/ folder"
+task :examples do
+  FileList["examples/*.rb"].each do |example|
+    sh "ruby #{example}"
+  end
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+
+  namespace :rubocop do
+    desc 'Generate a configuration file acting as a TODO list.'
+    task :auto_gen_config do
+      exec "bundle exec rubocop --auto-gen-config"
+    end
+  end
+
+rescue LoadError
+end

data/rom-csv.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom/csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rom-csv'
+  spec.version       = ROM::CSV::VERSION.dup
+  spec.authors       = ['Don Morrison']
+  spec.email         = ['don@elskwid.net']
+  spec.summary       = 'CSV support for Ruby Object Mapper'
+  spec.description   = spec.summary
+  spec.homepage      = 'http://rom-rb.org'
+  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_runtime_dependency 'rom', '~> 0.6.0'
+
+  spec.add_development_dependency 'anima'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop', '~> 0.28.0'
+end

data/spec/fixtures/users.csv

@@ -0,0 +1,3 @@
+id,name,email
+1,Julie,julie.andrews@example.com
+2,Jane,jane@doe.org

data/spec/integration/repository_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'anima'
+
+describe 'CSV repository' do
+  subject(:rom) { setup.finalize }
+
+  let(:path) { File.expand_path('./spec/fixtures/users.csv') }
+
+  # If :csv is not passed in the repository is named `:default`
+  let(:setup) { ROM.setup(:csv, path) }
+
+  before do
+    setup.relation(:users) do
+      def by_name(name)
+        restrict(name: name)
+      end
+    end
+
+    class User
+      # Anima allows creation of an instance with an attribute hash
+      include Anima.new(:id, :name, :email)
+    end
+
+    setup.mappers do
+      define(:users) do
+        model User
+        register_as :entity
+      end
+    end
+  end
+
+  describe 'env#relation' do
+    it 'returns mapped object' do
+      jane = rom.relation(:users).as(:entity).by_name('Jane').to_a.first
+
+      expect(jane.id).to eql(2)
+      expect(jane.name).to eql('Jane')
+      expect(jane.email).to eql('jane@doe.org')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler.require
+
+if RUBY_ENGINE == 'rbx'
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'rom'
+require 'rom-csv'
+
+root = Pathname(__FILE__).dirname
+
+Dir[root.join('shared/*.rb').to_s].each { |f| require f }

data/spec/unit/dataset_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+require 'rom/lint/spec'
+
+describe ROM::CSV::Dataset do
+  let(:data) { [{ id: 1 }, { id: 2 }] }
+  let(:dataset) { ROM::CSV::Dataset.new(data) }
+
+  it_behaves_like "a rom enumerable dataset"
+end

data/spec/unit/repository_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+require 'rom/lint/spec'
+
+describe ROM::CSV::Repository do
+  let(:repository) { ROM::CSV::Repository }
+  let(:uri) { File.expand_path('./spec/fixtures/users.csv') }
+
+  it_behaves_like "a rom repository" do
+    let(:identifier) { :csv }
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: rom-csv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Don Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: anima
+  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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+description: CSV support for Ruby Object Mapper
+email:
+- don@elskwid.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/README.md
+- examples/find_user.rb
+- examples/users.csv
+- lib/rom-csv.rb
+- lib/rom/csv.rb
+- lib/rom/csv/dataset.rb
+- lib/rom/csv/relation.rb
+- lib/rom/csv/repository.rb
+- lib/rom/csv/version.rb
+- rakelib/examples.rake
+- rakelib/rubocop.rake
+- rom-csv.gemspec
+- spec/fixtures/users.csv
+- spec/integration/repository_spec.rb
+- spec/spec_helper.rb
+- spec/unit/dataset_spec.rb
+- spec/unit/repository_spec.rb
+homepage: http://rom-rb.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: CSV support for Ruby Object Mapper
+test_files:
+- spec/fixtures/users.csv
+- spec/integration/repository_spec.rb
+- spec/spec_helper.rb
+- spec/unit/dataset_spec.rb
+- spec/unit/repository_spec.rb