rom-http 0.5.0 → 0.6.0.rc1

data/lib/rom/http/error.rb

@@ -1,5 +1,6 @@
 module ROM
   module HTTP
     Error = Class.new(StandardError)
+    SchemaNotDefinedError = Class.new(Error)
   end
 end

data/lib/rom/http/gateway.rb

@@ -1,4 +1,4 @@
-require 'thread_safe'
+require 'concurrent'
 require 'rom/http/dataset'
 
 module ROM
@@ -29,7 +29,7 @@ module ROM
       #
       # @api public
       def initialize(config)
-        @datasets = ThreadSafe::Cache.new
+        @datasets = Concurrent::Map.new
         @config = config
       end
 

data/lib/rom/http/relation.rb

@@ -1,46 +1,123 @@
-require 'rom/plugins/relation/view'
+require 'dry/core/cache'
+require 'rom/initializer'
 require 'rom/plugins/relation/key_inference'
+require 'rom/http/transformer'
 
 module ROM
   module HTTP
     # HTTP-specific relation extensions
     #
     class Relation < ROM::Relation
+      extend Dry::Core::Cache
+      extend ::ROM::Initializer
       include Enumerable
 
       adapter :http
 
-      use :view
       use :key_inference
 
+      option :transformer, reader: true, default: proc { ::ROM::HTTP::Transformer }
+
       forward :with_request_method, :with_path, :append_path, :with_options,
-              :with_params, :clear_params, :project
+              :with_params, :clear_params
+
 
-      # @api private
       def initialize(*)
         super
-        if schema?
-          dataset.response_transformer(
-            Dataset::ResponseTransformers::Schemad.new(schema.to_h)
-          )
+
+        raise(
+          SchemaNotDefinedError,
+          "You must define a schema for #{self.class.register_as} relation"
+        ) unless schema?
+      end
+
+      def primary_key
+        attribute = schema.find(&:primary_key?)
+
+        if attribute
+          attribute.alias || attribute.name
+        else
+          :id
         end
       end
 
+      def project(*names)
+        with(schema: schema.project(*names.flatten))
+      end
+
+      def exclude(*names)
+        with(schema: schema.exclude(*names.flatten))
+      end
+
+      def rename(mapping)
+        with(schema: schema.rename(mapping))
+      end
+
+      def prefix(prefix)
+        with(schema: schema.prefix(prefix))
+      end
+
+      def wrap(prefix = dataset.name)
+        with(schema: schema.wrap(prefix))
+      end
+
+      def to_a
+        with_transformation { super }
+      end
+
       # @see Dataset#insert
       def insert(*args)
-        dataset.insert(*args)
+        with_transformation { dataset.insert(*args) }
       end
       alias_method :<<, :insert
 
       # @see Dataset#update
       def update(*args)
-        dataset.update(*args)
+        with_transformation { dataset.update(*args) }
       end
 
       # @see Dataset#delete
       def delete
         dataset.delete
       end
+
+      private
+
+      def with_transformation(&block)
+        tuples = block.call
+
+        transformed = with_schema_proc do |proc|
+          transformer_proc[Array([tuples]).flatten(1).map(&proc.method(:call))]
+        end
+
+        tuples.kind_of?(Array) ? transformed : transformed.first
+      end
+
+      def with_schema_proc(&block)
+        schema_proc = fetch_or_store(schema) do
+          Types::Coercible::Hash.schema(schema.to_h)
+        end
+
+        block.call(schema_proc)
+      end
+
+      def transformer_proc
+        if mapped?
+          transformer[:map_array, transformer[:rename_keys, mapping]]
+        else
+          transformer[:identity]
+        end
+      end
+
+      def mapped?
+        mapping.any?
+      end
+
+      def mapping
+        schema.each_with_object({}) do |attr, mapping|
+          mapping[attr.name] = attr.alias if attr.alias
+        end
+      end
     end
   end
 end

data/lib/rom/http/transformer.rb

@@ -0,0 +1,16 @@
+module ROM
+  module HTTP
+    # Transformer
+    #
+    # Used to perform data transformations on behalf of relations
+    #
+    # @api private
+    module Transformer
+      extend Transproc::Registry
+
+      import :identity, from: ::Transproc::Coercions
+      import :map_array, from: ::Transproc::ArrayTransformations
+      import :rename_keys, from: ::Transproc::HashTransformations
+    end
+  end
+end

data/lib/rom/http/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module HTTP
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0.rc1'.freeze
   end
 end

data/rom-http.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'thread_safe'
-  spec.add_runtime_dependency 'dry-types'
-  spec.add_runtime_dependency 'rom', '~> 2.0'
-  spec.add_runtime_dependency 'dry-equalizer'
+  spec.add_runtime_dependency 'concurrent-ruby'
+  spec.add_runtime_dependency 'rom', '~> 3.0.0.rc'
+  spec.add_runtime_dependency 'dry-core', '~> 0.2', '>= 0.2.3'
+  spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/spec/integration/abstract/commands/create_spec.rb

@@ -2,14 +2,22 @@ RSpec.describe ROM::HTTP::Commands::Create do
   include_context 'setup'
   let(:relation) do
     Class.new(ROM::HTTP::Relation) do
-      dataset :users
+      schema(:users) do
+        attribute :id, ROM::Types::Int
+        attribute :first_name, ROM::Types::String
+        attribute :last_name, ROM::Types::String
+      end
+
+      def by_id(id)
+        with_params(id: id)
+      end
     end
   end
 
   context 'with single tuple' do
     let(:response) { double }
-    let(:tuple) { double }
     let(:attributes) { { first_name: 'John', last_name: 'Jackson' } }
+    let(:tuple) { attributes.merge(id: 1) }
     let(:command) do
       Class.new(ROM::HTTP::Commands::Create) do
         register_as :create
@@ -51,10 +59,10 @@ RSpec.describe ROM::HTTP::Commands::Create do
   context 'with a collection' do
     let(:response_1) { double }
     let(:response_2) { double }
-    let(:tuple_1) { double }
-    let(:tuple_2) { double }
     let(:attributes_1) { { first_name: 'John', last_name: 'Jackson' } }
     let(:attributes_2) { { first_name: 'Jill', last_name: 'Smith' } }
+    let(:tuple_1) { attributes_1.merge(id: 1) }
+    let(:tuple_2) { attributes_2.merge(id: 2) }
     let(:attributes) { [attributes_1, attributes_2] }
     let(:command) do
       Class.new(ROM::HTTP::Commands::Create) do

data/spec/integration/abstract/commands/delete_spec.rb

@@ -2,7 +2,13 @@ RSpec.describe ROM::HTTP::Commands::Delete do
   include_context 'setup'
   let(:relation) do
     Class.new(ROM::HTTP::Relation) do
-      dataset :users
+      schema(:users) do
+        attribute :id, ROM::Types::Int
+      end
+
+      def by_id(id)
+        with_params(id: id)
+      end
     end
   end
   let(:response) { double }

data/spec/integration/abstract/commands/update_spec.rb

@@ -2,14 +2,22 @@ RSpec.describe ROM::HTTP::Commands::Update do
   include_context 'setup'
   let(:relation) do
     Class.new(ROM::HTTP::Relation) do
-      dataset :users
+      schema(:users) do
+        attribute :id, ROM::Types::Int
+        attribute :first_name, ROM::Types::String
+        attribute :last_name, ROM::Types::String
+      end
+
+      def by_id(id)
+        with_params(id: id)
+      end
     end
   end
 
   context 'with single tuple' do
     let(:response) { double }
-    let(:tuple) { double }
     let(:attributes) { { first_name: 'John', last_name: 'Jackson' } }
+    let(:tuple) { attributes.merge(id: 1) }
     let(:command) do
       Class.new(ROM::HTTP::Commands::Update) do
         register_as :update
@@ -51,10 +59,10 @@ RSpec.describe ROM::HTTP::Commands::Update do
   context 'with a collection' do
     let(:response_1) { double }
     let(:response_2) { double }
-    let(:tuple_1) { double }
-    let(:tuple_2) { double }
     let(:attributes_1) { { first_name: 'John', last_name: 'Jackson' } }
     let(:attributes_2) { { first_name: 'Jill', last_name: 'Smith' } }
+    let(:tuple_1) { attributes_1.merge(id: 1) }
+    let(:tuple_2) { attributes_2.merge(id: 2) }
     let(:attributes) { [attributes_1, attributes_2] }
     let(:command) do
       Class.new(ROM::HTTP::Commands::Update) do

data/spec/integration/abstract/relation_spec.rb

@@ -8,10 +8,9 @@ RSpec.describe ROM::HTTP::Relation do
 
   let(:relation) do
     Class.new(ROM::HTTP::Relation) do
-      dataset :users
-
-      view :base, [:id, :name] do
-        self
+      schema(:users) do
+        attribute :id, ROM::Types::Int
+        attribute :name, ROM::Types::String
       end
 
       def by_id(id)
@@ -38,8 +37,7 @@ RSpec.describe ROM::HTTP::Relation do
         response_handler: response_handler,
         name: :users
       },
-      request_method: :get,
-      path: "/#{id}",
+      path: "users/#{id}",
       params: params
     )
   end

data/spec/shared/users_and_tasks.rb

@@ -2,7 +2,9 @@ RSpec.shared_context 'users and tasks' do
   include_context 'setup'
   let(:users_relation) do
     Class.new(ROM::HTTP::Relation) do
-      dataset :users
+      schema(:users) do
+        attribute :id, ROM::Types::Int
+      end
 
       def by_id(id)
         with_params(id: id)
@@ -11,7 +13,9 @@ RSpec.shared_context 'users and tasks' do
   end
   let(:tasks_relation) do
     Class.new(ROM::HTTP::Relation) do
-      dataset :tasks
+      schema(:tasks) do
+        attribute :id, ROM::Types::Int
+      end
 
       def by_id(id)
         with_params(id: id)

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'bundler'
 Bundler.setup
 
 require 'rom-http'
+require 'rspec/its'
 
 begin
 require 'byebug'

data/spec/unit/rom/http/dataset_spec.rb

@@ -22,8 +22,8 @@ RSpec.describe ROM::HTTP::Dataset do
       it { is_expected.to eq(config) }
     end
 
-    describe '#options' do
-      subject { dataset.options }
+    describe 'options' do
+      subject { dataset }
 
       context 'with options passed' do
         let(:options) do
@@ -35,29 +35,19 @@ RSpec.describe ROM::HTTP::Dataset do
           }
         end
 
-        it do
-          is_expected.to eq(
-            request_method: :put,
-            path: '',
-            projections: [],
-            params: {},
-            headers: {
-              'Accept' => 'application/json'
-            }
-          )
-        end
+        its(:base_path) { is_expected.to eq('') }
+        its(:request_method) { is_expected.to eq(:put) }
+        its(:path) { is_expected.to eq('') }
+        its(:params) { is_expected.to eq({}) }
+        its(:headers) { is_expected.to eq('Accept' => 'application/json') }
       end
 
       context 'with no options passed' do
-        it do
-          is_expected.to eq(
-            request_method: :get,
-            path: '',
-            projections: [],
-            params: {},
-            headers: {}
-          )
-        end
+        its(:base_path) { is_expected.to eq('') }
+        its(:request_method) { is_expected.to eq(:get) }
+        its(:path) { is_expected.to eq('') }
+        its(:params) { is_expected.to eq({}) }
+        its(:headers) { is_expected.to eq({}) }
       end
     end
   end
@@ -110,40 +100,6 @@ RSpec.describe ROM::HTTP::Dataset do
     end
   end
 
-  describe '#response_transformer' do
-    context 'with argument' do
-      let(:transformer) { double('ResponseTransformer') }
-
-      subject! { dataset.response_transformer(transformer) }
-
-      it do
-        expect(dataset.instance_variable_get(:@response_transformer))
-          .to eq(transformer)
-      end
-      it { is_expected.to eq(transformer) }
-    end
-
-    context 'without argument' do
-      context 'when transformer not set' do
-        subject! { dataset.response_transformer }
-
-        it { is_expected.to be_a(ROM::HTTP::Dataset::ResponseTransformers::Schemaless) }
-      end
-
-      context 'when transformer set' do
-        let(:transformer) { double('ResponseTransformer') }
-
-        before do
-          dataset.response_transformer(transformer)
-        end
-
-        subject! { dataset.response_transformer }
-
-        it { is_expected.to eq(transformer) }
-      end
-    end
-  end
-
   describe '#uri' do
     context 'when no uri configured' do
       let(:config) { {} }
@@ -219,6 +175,51 @@ RSpec.describe ROM::HTTP::Dataset do
     end
   end
 
+  describe '#base_path' do
+    subject { dataset.base_path }
+
+    context 'with no base_path option' do
+      context 'when dataset name is set' do
+        let(:config) do
+          {
+            uri: uri,
+            request_handler: request_handler,
+            response_handler: response_handler,
+            name: :users
+          }
+        end
+
+        it 'returns the dataset name as a string' do
+          is_expected.to eq('users')
+        end
+      end
+
+      context 'when dataset name is not set' do
+        it 'returns an empty string' do
+          is_expected.to eq('')
+        end
+      end
+    end
+
+    context 'with base_path option' do
+      context 'when base_path is absolute' do
+        let(:base_path) { '/users' }
+        let(:options) { { base_path: base_path } }
+
+        it 'removes the leading /' do
+          is_expected.to eq('users')
+        end
+      end
+
+      context 'when base_path is not absolute' do
+        let(:base_path) { 'users' }
+        let(:options) { { base_path: base_path } }
+
+        it { is_expected.to eq(base_path) }
+      end
+    end
+  end
+
   describe '#path' do
     subject { dataset.path }
 
@@ -305,16 +306,13 @@ RSpec.describe ROM::HTTP::Dataset do
 
     subject! { new_dataset }
 
-    it { expect(new_dataset.config).to eq(config) }
-    it do
-      expect(new_dataset.options).to eq(
-        request_method: :get,
-        path: '',
-        projections: [],
-        params: {},
-        headers: headers
-      )
-    end
+    its(:config) { is_expected.to eq(config) }
+    its(:base_path) { is_expected.to eq('') }
+    its(:request_method) { is_expected.to eq(:get) }
+    its(:path) { is_expected.to eq('') }
+    its(:params) { is_expected.to eq({}) }
+    its(:headers) { is_expected.to eq(headers) }
+
     it { is_expected.to_not be(dataset) }
     it { is_expected.to be_a(ROM::HTTP::Dataset) }
   end
@@ -360,68 +358,29 @@ RSpec.describe ROM::HTTP::Dataset do
 
     subject! { new_dataset }
 
-    it { expect(new_dataset.config).to eq(config) }
-    it do
-      expect(new_dataset.options).to eq(
-        request_method: :get,
-        path: '',
-        projections: [],
-        params: {
-          name: name
-        },
-        headers: {}
-      )
-    end
+    its(:config) { is_expected.to eq(config) }
+    its(:base_path) { is_expected.to eq('') }
+    its(:request_method) { is_expected.to eq(:get) }
+    its(:path) { is_expected.to eq('') }
+    its(:params) { is_expected.to eq(name: name) }
+    its(:headers) { is_expected.to eq({}) }
+
     it { is_expected.to_not be(dataset) }
     it { is_expected.to be_a(ROM::HTTP::Dataset) }
   end
 
-  describe '#project' do
-    let(:data) do
-      [
-        { id: 1, name: 'John', email: 'john@hotmail.com' },
-        { id: 2, name: 'Jill', email: 'jill@hotmail.com' }
-      ]
-    end
+  describe '#with_base_path' do
+    let(:base_path) { '/users/tasks' }
+    let(:new_dataset) { double(ROM::HTTP::Dataset) }
 
     before do
-      allow(request_handler).to receive(:call)
-      allow(response_handler).to receive(:call).and_return(data)
-    end
-
-    subject! { dataset.project(*projections).to_a }
-
-    context 'with projections' do
-      context 'with a list of arguments' do
-        let(:projections) { [:id, :name] }
-
-        it 'applies the projections to the result set' do
-          is_expected.to match_array([
-            { id: 1, name: 'John' },
-            { id: 2, name: 'Jill' }
-          ])
-        end
-      end
-
-      context 'with a single array argument' do
-        let(:projections) { [[:id, :name]] }
-
-        it 'applies the projections to the result set' do
-          is_expected.to match_array([
-            { id: 1, name: 'John' },
-            { id: 2, name: 'Jill' }
-          ])
-        end
-      end
+      allow(dataset).to receive(:with_options).and_return(new_dataset)
     end
 
-    context 'without projections' do
-      let(:projections) { [] }
+    subject! { dataset.with_base_path(base_path) }
 
-      it 'returns the original data' do
-        is_expected.to match_array(data)
-      end
-    end
+    it { expect(dataset).to have_received(:with_options).with(base_path: base_path) }
+    it { is_expected.to eq(new_dataset) }
   end
 
   describe '#with_path' do
@@ -449,14 +408,14 @@ RSpec.describe ROM::HTTP::Dataset do
     subject! { dataset.append_path(path) }
 
     context 'without existing path' do
-      it { expect(dataset).to have_received(:with_options).with(path: '/tasks') }
+      it { expect(dataset).to have_received(:with_options).with(path: 'tasks') }
       it { is_expected.to eq(new_dataset) }
     end
 
     context 'with existing path' do
       let(:options) { { path: '/users' } }
 
-      it { expect(dataset).to have_received(:with_options).with(path: '/users/tasks') }
+      it { expect(dataset).to have_received(:with_options).with(path: 'users/tasks') }
       it { is_expected.to eq(new_dataset) }
     end
   end