rom-csv 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48a7a492d5142f1d19b80c34a209bebbab1c349b
-  data.tar.gz: ae1893bd435ef69c849cf4dc15ad5df9028855b9
+  metadata.gz: 50f29f9955ae5aa228873154052cb12ea961f582
+  data.tar.gz: 3979e8a009b8725a7a5280703e29bc89259ac512
 SHA512:
-  metadata.gz: fac7adf3da1e06b6b8908149bc338d1bcdbeb800ea67e606ba76318fd0ae2d5a012300ecc9c0e28bb2468b29516ce9a1526838b87144b212c8e644d3b9415279
-  data.tar.gz: a912c91ebeebfb506233fc7dba5caa1467554b91352e65d3f346c9a9eef25453e802f315b99a0d92924e84b642bf4c3f67c8194c3034b2dd491457476f3fcd3f
+  metadata.gz: 03fb8e82792ea55ed6b72ff437d4c8c1381a24e980f82b0fe32c7df16b9a0473ea8e87cdb907498abe3d703cf1289f746b09493e059e22427d413e73173fff35
+  data.tar.gz: 9d6f4ab54cef76ed4f27b8c28a142dd6999f905ac1cb2d4daceab3c9d7bb32ae502b435048d790072878f57f32f11b66402dc5e0dcaa10be91c2bfff5178e462

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+spec/fixtures/testing.csv

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.2.0 2015-08-19
+
+### Added
+
+* Support for Create, Update and Delete commands (wafcio)
+* Support for in-memory joins (wafcio)
+
+[Compare v0.1.0...v0.2.0](https://github.com/rom-rb/rom-csv/compare/v0.1.0...v0.2.0)
+
 ## v0.1.0 2015-04-16
 
 ### Added
@@ -8,7 +17,7 @@
 
 * Improve test coverage (wafcio)
 
-[Compare v0.0.1...v0.1.0](https://github.com/rom-rb/rom/compare/v0.0.1...v0.1.0)
+[Compare v0.0.1...v0.1.0](https://github.com/rom-rb/rom-csv/compare/v0.0.1...v0.1.0)
 
 ## v0.0.1 2015-03-22
 

data/examples/find_user.rb

@@ -6,7 +6,10 @@ require 'ostruct'
 
 csv_file = ARGV[0] || File.expand_path("./users.csv", File.dirname(__FILE__))
 
+ROM.use :auto_registration
+
 setup = ROM.setup(:csv, csv_file)
+
 setup.relation(:users) do
   def by_name(name)
     restrict(name: name)

data/lib/rom/csv.rb

@@ -2,7 +2,7 @@ require 'csv'
 
 require 'rom'
 require 'rom/csv/version'
-require 'rom/csv/repository'
+require 'rom/csv/gateway'
 require 'rom/csv/relation'
 
 ROM.register_adapter(:csv, ROM::CSV)

data/lib/rom/csv/commands.rb

@@ -0,0 +1,3 @@
+require 'rom/csv/commands/create'
+require 'rom/csv/commands/delete'
+require 'rom/csv/commands/update'

data/lib/rom/csv/commands/create.rb

@@ -0,0 +1,40 @@
+require 'rom/commands'
+require 'rom/commands/create'
+
+module ROM
+  module CSV
+    module Commands
+      class Create < ROM::Commands::Create
+        adapter :csv
+
+        def execute(tuples)
+          insert_tuples =  [tuples].flatten.map do |tuple|
+            attributes = input[tuple]
+            validator.call(attributes)
+            attributes.to_h
+          end
+
+          insert(insert_tuples)
+          insert_tuples
+        end
+
+        def insert(tuples)
+          tuples.each { |tuple| dataset << new_row(tuple) }
+          dataset.sync!
+        end
+
+        def new_row(tuple)
+          ::CSV::Row.new(dataset.data.headers, ordered_data(tuple))
+        end
+
+        def ordered_data(tuple)
+          dataset.data.headers.map { |header| tuple[header] }
+        end
+
+        def dataset
+          relation.dataset
+        end
+      end
+    end
+  end
+end

data/lib/rom/csv/commands/delete.rb

@@ -0,0 +1,32 @@
+require 'rom/commands'
+require 'rom/commands/delete'
+
+module ROM
+  module CSV
+    module Commands
+      class Delete < ROM::Commands::Delete
+        adapter :csv
+
+        def execute
+          original_data = original_dataset.to_a
+
+          dataset.each do |dataset_tuple|
+            index = original_data.index(dataset_tuple)
+            original_dataset.data.delete(index)
+          end
+
+          original_dataset.sync!
+          dataset.data
+        end
+
+        def dataset
+          relation.dataset
+        end
+
+        def original_dataset
+          source.dataset
+        end
+      end
+    end
+  end
+end

data/lib/rom/csv/commands/update.rb

@@ -0,0 +1,48 @@
+require 'rom/commands'
+require 'rom/commands/update'
+
+module ROM
+  module CSV
+    module Commands
+      class Update < ROM::Commands::Update
+        adapter :csv
+
+        def execute(tuple)
+          attributes = input[tuple]
+          validator.call(attributes)
+          tuple = attributes.to_h
+
+          update(tuple)
+        end
+
+        def update(tuple)
+          original_data = original_dataset.to_a
+          output = []
+
+          dataset.each do |dataset_tuple|
+            index = original_data.index(dataset_tuple)
+            update_dataset(index, tuple)
+            output << original_dataset.data[index].to_hash
+          end
+
+          original_dataset.sync!
+          output
+        end
+
+        def update_dataset(index, tuple)
+          tuple.each do |key, value|
+            original_dataset.data[index][key] = value
+          end
+        end
+
+        def dataset
+          relation.dataset
+        end
+
+        def original_dataset
+          source.dataset
+        end
+      end
+    end
+  end
+end

data/lib/rom/csv/dataset.rb

@@ -6,12 +6,39 @@ module ROM
     #
     # @api public
     class Dataset < ROM::Memory::Dataset
+      option :path, reader: true
+      option :file_options, reader: true
+
       # Convert each CSV::Row to a hash
       #
       # @api public
       def self.row_proc
         -> row { row.to_hash }
       end
+
+      def reload!
+        @data = load_data
+      end
+
+      def sync!
+        write_data && reload!
+      end
+
+      def write_data
+        ::CSV.open(path, 'wb', file_options) do |csv|
+          data.to_a.each do |tuple|
+            csv << tuple
+          end
+        end
+      end
+
+      def load_data
+        ::CSV.table(path, file_options).by_row!
+      end
+
+      def count
+        data.count
+      end
     end
   end
 end

data/lib/rom/csv/{repository.rb → gateway.rb}

@@ -1,5 +1,6 @@
-require 'rom/repository'
+require 'rom/gateway'
 require 'rom/csv/dataset'
+require 'rom/csv/commands'
 
 # Ruby Object Mapper
 #
@@ -35,12 +36,12 @@ module ROM
   #
   # @api public
   module CSV
-    # CSV repository interface
+    # CSV gateway interface
     #
     # @api public
-    class Repository < ROM::Repository
+    class Gateway < ROM::Gateway
       # Expect a path to a single csv file which will be registered by rom to
-      # the given name or :default as the repository.
+      # the given name or :default as the gateway.
       #
       # Uses CSV.table which passes the following csv options:
       # * headers: true
@@ -55,6 +56,8 @@ module ROM
       # @see CSV.table
       def initialize(path, options = {})
         @datasets = {}
+        @path = path
+        @options = options
         @connection = ::CSV.table(path, options).by_row!
       end
 
@@ -68,7 +71,7 @@ module ROM
         datasets[name]
       end
 
-      # Register a dataset in the repository
+      # Register a dataset in the gateway
       #
       # If dataset already exists it will be returned
       #
@@ -77,7 +80,7 @@ module ROM
       #
       # @api public
       def dataset(name)
-        datasets[name] = Dataset.new(connection)
+        datasets[name] = Dataset.new(connection, dataset_options)
       end
 
       # Check if dataset exists
@@ -91,8 +94,12 @@ module ROM
 
       private
 
+      def dataset_options
+        { path: path, file_options: options }
+      end
+
       # @api private
-      attr_reader :datasets
+      attr_reader :datasets, :path, :options
     end
   end
 end

data/lib/rom/csv/relation.rb

@@ -10,7 +10,13 @@ module ROM
     #
     # @api public
     class Relation < ROM::Relation
+      adapter :csv
+
       forward :join, :project, :restrict, :order
+
+      def count
+        dataset.count
+      end
     end
   end
 end

data/lib/rom/csv/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module CSV
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/rom-csv.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rom', '~> 0.6.0'
+  spec.add_runtime_dependency 'rom', '~> 0.9', '>= 0.9.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/spec/fixtures/addresses.csv

@@ -0,0 +1,5 @@
+address_id,user_id,street
+1,1,Cleveland Street
+2,2,East Avenue
+3,2,Lantern Lane
+4,3,Lantern Street

data/spec/fixtures/users.csv

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

data/spec/integration/commands/create_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'virtus'
+
+describe 'Commands / Create' do
+  subject(:rom) { setup.finalize }
+
+  let(:original_path) { File.expand_path('./spec/fixtures/users.csv') }
+  let(:path) { File.expand_path('./spec/fixtures/testing.csv') }
+
+  # If :csv is not passed in the gateway is named `:default`
+  let(:setup) { ROM.setup(:csv, path) }
+
+  subject(:users) { rom.commands.users }
+
+  before do
+    FileUtils.copy(original_path, path)
+
+    setup.relation(:users)
+
+    class User
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :name, String
+      attribute :email, String
+    end
+
+    setup.mappers do
+      define(:users) do
+        model User
+        register_as :entity
+      end
+    end
+
+    setup.commands(:users) do
+      define(:create) do
+        result :one
+      end
+
+      define(:create_many, type: :create) do
+        result :many
+      end
+    end
+  end
+
+  it 'returns a single tuple when result is set to :one' do
+    result = users.try do
+      users.create.call(user_id: 4, name: 'John', email: 'john@doe.org')
+    end
+    expect(result.value).to eql(user_id: 4, name: 'John', email: 'john@doe.org')
+
+    result = rom.relation(:users).as(:entity).to_a
+    expect(result.count).to eql(4)
+  end
+
+  it 'returns tuples when result is set to :many' do
+    result = users.try do
+      users.create_many.call([
+        { user_id: 4, name: 'Jane', email: 'jane@doe.org' },
+        { user_id: 5, name: 'Jack', email: 'jack@doe.org' }
+      ])
+    end
+
+    expect(result.value.to_a).to match_array([
+      { user_id: 4, name: 'Jane', email: 'jane@doe.org' },
+      { user_id: 5, name: 'Jack', email: 'jack@doe.org' }
+    ])
+
+    result = rom.relation(:users).as(:entity).to_a
+    expect(result.count).to eql(5)
+  end
+end

data/spec/integration/commands/delete_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'Commands / Delete' do
+  subject(:rom) { setup.finalize }
+
+  let(:original_path) { File.expand_path('./spec/fixtures/users.csv') }
+  let(:path) { File.expand_path('./spec/fixtures/testing.csv') }
+
+  # If :csv is not passed in the gateway is named `:default`
+  let(:setup) { ROM.setup(:csv, path) }
+
+  subject(:users) { rom.commands.users }
+
+  before do
+    FileUtils.copy(original_path, path)
+
+    setup.relation(:users) do
+      def by_id(id)
+        restrict(user_id: id)
+      end
+    end
+
+    setup.commands(:users) do
+      define(:delete) do
+        result :one
+      end
+    end
+  end
+
+  it 'raises error when tuple count does not match expectation' do
+    result = users.try { users.delete.call }
+
+    expect(result.value).to be(nil)
+    expect(result.error).to be_instance_of(ROM::TupleCountMismatchError)
+  end
+
+  it 'deletes all tuples in a restricted relation' do
+    result = users.try { users.delete.by_id(1).call }
+
+    expect(result.value)
+      .to eql(user_id: 1, name: "Julie", email: "julie.andrews@example.com")
+
+    rom.relation(:users).dataset.reload!
+
+    result = rom.relation(:users).to_a
+    expect(result.count).to eql(2)
+  end
+end

data/spec/integration/commands/update_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'virtus'
+
+describe 'Commands / Updates' do
+  subject(:rom) { setup.finalize }
+
+  let(:original_path) { File.expand_path('./spec/fixtures/users.csv') }
+  let(:path) { File.expand_path('./spec/fixtures/testing.csv') }
+
+  # If :csv is not passed in the gateway is named `:default`
+  let(:setup) { ROM.setup(:csv, path) }
+
+  subject(:users) { rom.commands.users }
+
+  let(:relation) { rom.relations.users }
+  let(:first_data) { relation.by_id(1).to_a.first }
+  let(:new_data) { { name: 'Peter' } }
+  let(:output_data) do
+    [{ user_id: 1, name: 'Julie', email: 'tester@example.com' }]
+  end
+
+  before do
+    FileUtils.copy(original_path, path)
+
+    setup.relation(:users) do
+      def by_id(id)
+        restrict(user_id: id)
+      end
+    end
+
+    class User
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :name, String
+      attribute :email, String
+    end
+
+    setup.mappers do
+      define(:users) do
+        model User
+        register_as :entity
+      end
+    end
+
+    setup.commands(:users) do
+      define(:update)
+    end
+  end
+
+  it 'updates everything when there is no original tuple' do
+    result = users.try do
+      users.update.by_id(1).call(email: 'tester@example.com')
+    end
+
+    expect(result.value.to_a).to match_array(output_data)
+
+    # FIXME: reload! should not be necessary
+    rom.relation(:users).dataset.reload!
+
+    result = rom.relation(:users).as(:entity).by_id(1).to_a.first
+    expect(result.email).to eql('tester@example.com')
+  end
+end

data/spec/integration/relation_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'virtus'
+
+describe 'CSV gateway' do
+  context 'without extra options' do
+    # If :csv is not passed in the gateway is named `:default`
+    let(:users_path) { File.expand_path('./spec/fixtures/users.csv') }
+    let(:setup) do
+      ROM.setup(
+        users: [:csv, users_path]
+      )
+    end
+
+    before do
+      module TestPlugin; end
+
+      ROM.plugins do
+        adapter :csv do
+          register :test_plugin, TestPlugin, type: :relation
+        end
+      end
+    end
+
+    describe 'specify relation with plugin' do
+      it "shouldn't raise error" do
+        expect {
+          setup.relation(:users) do
+            gateway :users
+            use :test_plugin
+          end
+        }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/integration/repository_spec.rb

@@ -1,15 +1,23 @@
 require 'spec_helper'
 require 'virtus'
 
-describe 'CSV repository' do
+describe 'CSV gateway' do
   context 'without extra options' do
-    # If :csv is not passed in the repository is named `:default`
-    let(:path) { File.expand_path('./spec/fixtures/users.csv') }
-    let(:setup) { ROM.setup(:csv, path) }
+    # If :csv is not passed in the gateway is named `:default`
+    let(:users_path) { File.expand_path('./spec/fixtures/users.csv') }
+    let(:addresses_path) { File.expand_path('./spec/fixtures/addresses.csv') }
+    let(:setup) do
+      ROM.setup(
+        users: [:csv, users_path],
+        addresses: [:csv, addresses_path]
+      )
+    end
     subject(:rom) { setup.finalize }
 
     before do
       setup.relation(:users) do
+        gateway :users
+
         def by_name(name)
           restrict(name: name)
         end
@@ -21,14 +29,38 @@ describe 'CSV repository' do
         def ordered
           order(:name, :email)
         end
+
+        def with_addresses
+          join(addresses)
+        end
+      end
+
+      setup.relation(:addresses) do
+        gateway :addresses
       end
 
       class User
         include Virtus.model
 
-        attribute :id, Integer
+        attribute :user_id, Integer
+        attribute :name, String
+        attribute :email, String
+      end
+
+      class UserWithAddress
+        include Virtus.model
+
+        attribute :user_id, Integer
         attribute :name, String
         attribute :email, String
+        attribute :addresses
+      end
+
+      class Address
+        include Virtus.model
+
+        attribute :address_id, Integer
+        attribute :street, String
       end
 
       setup.mappers do
@@ -36,6 +68,18 @@ describe 'CSV repository' do
           model User
           register_as :entity
         end
+
+        define(:users_with_address, parent: :users) do
+          model UserWithAddress
+          register_as :entity_with_address
+
+          group :addresses do
+            model Address
+
+            attribute :address_id
+            attribute :street
+          end
+        end
       end
     end
 
@@ -43,7 +87,6 @@ describe 'CSV repository' do
       it 'returns restricted and mapped object' do
         jane = rom.relation(:users).as(:entity).by_name('Jane').to_a.first
 
-        expect(jane.id).to eql(3)
         expect(jane.name).to eql('Jane')
         expect(jane.email).to eql('jane@doe.org')
       end
@@ -51,7 +94,7 @@ describe 'CSV repository' do
       it 'returns specified attributes in mapped object' do
         jane = rom.relation(:users).as(:entity).only_name.to_a.first
 
-        expect(jane.id).to be_nil
+        expect(jane.user_id).to be_nil
         expect(jane.name).not_to be_nil
         expect(jane.email).to be_nil
       end
@@ -68,6 +111,17 @@ describe 'CSV repository' do
         expect(results[2].name).to eql('Julie')
         expect(results[2].email).to eq('julie@doe.org')
       end
+
+      it 'returns joined data' do
+        results = rom.relation(:users).as(:entity_with_address)
+                  .with_addresses.first
+
+        expect(results.attributes.keys.sort)
+          .to eq([:user_id, :name, :email, :addresses].sort)
+
+        expect(results.addresses.first.attributes.keys.sort)
+          .to eq([:address_id, :street].sort)
+      end
     end
 
     context 'with custom options' do

data/spec/spec_helper.rb

@@ -14,3 +14,5 @@ require 'rom-csv'
 root = Pathname(__FILE__).dirname
 
 Dir[root.join('shared/*.rb').to_s].each { |f| require f }
+
+ROM.use :auto_registration

data/spec/unit/repository_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-csv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Don Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,15 +94,24 @@ files:
 - examples/users.csv
 - lib/rom-csv.rb
 - lib/rom/csv.rb
+- lib/rom/csv/commands.rb
+- lib/rom/csv/commands/create.rb
+- lib/rom/csv/commands/delete.rb
+- lib/rom/csv/commands/update.rb
 - lib/rom/csv/dataset.rb
+- lib/rom/csv/gateway.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/addresses.csv
 - spec/fixtures/users.csv
 - spec/fixtures/users.utf-8.csv
+- spec/integration/commands/create_spec.rb
+- spec/integration/commands/delete_spec.rb
+- spec/integration/commands/update_spec.rb
+- spec/integration/relation_spec.rb
 - spec/integration/repository_spec.rb
 - spec/spec_helper.rb
 - spec/unit/dataset_spec.rb
@@ -121,13 +136,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: CSV support for Ruby Object Mapper
 test_files:
+- spec/fixtures/addresses.csv
 - spec/fixtures/users.csv
 - spec/fixtures/users.utf-8.csv
+- spec/integration/commands/create_spec.rb
+- spec/integration/commands/delete_spec.rb
+- spec/integration/commands/update_spec.rb
+- spec/integration/relation_spec.rb
 - spec/integration/repository_spec.rb
 - spec/spec_helper.rb
 - spec/unit/dataset_spec.rb