rom-files 0.2.0

data/spec/lib/rom/files/relation/select_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rom/files/relation'
+require 'shared/rom/files/media_relation'
+
+RSpec.describe ROM::Files::Relation, '#select' do
+  include_context 'media relation'
+
+  subject(:names) { relation.pluck(:basename) }
+  let(:relation) { container.relations[:media] }
+
+  context '(simple_pattern)' do
+    let(:relation) { super().select('*.txt') }
+
+    it { is_expected.to eql [P('some_file.txt')] }
+  end
+
+  context '(multiple, patterns)' do
+    let(:relation) { super().select('*.txt', '*.md') }
+
+    it { is_expected.to eql [P('some_file.txt'), P('some_markdown.md')] }
+  end
+
+  context '(glob_pattern)' do
+    let(:relation) { super().select('*.{txt,md}') }
+
+    it { is_expected.to eql [P('some_file.txt'), P('some_markdown.md')] }
+  end
+
+  context '(ordered_glob_pattern)' do
+    let(:relation) { super().select('*.{md,txt}') }
+
+    it { is_expected.to eql [P('some_markdown.md'), P('some_file.txt')] }
+  end
+end

data/spec/lib/rom/files/relation/sort_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/media_relation'
+
+RSpec.describe ROM::Files::Relation, '#sort' do
+  include_context 'media relation'
+
+  subject(:names) { relation.pluck(:basename) }
+
+  context 'default (by path)' do
+    let(:relation) { super().sort }
+
+    it { is_expected.to eql([P('some_file.txt'), P('some_image.png'), P('some_markdown.md')]) }
+  end
+
+  context 'by extname' do
+    let(:relation) { super().sort(:extname) }
+
+    it { is_expected.to eql([P('some_markdown.md'), P('some_image.png'), P('some_file.txt')]) }
+  end
+end

data/spec/lib/rom/files/relation/to_a_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/media_relation'
+
+RSpec.describe ROM::Files::Relation, '#to_a' do
+  include_context 'media relation'
+
+  let(:names) { relation.pluck(:basename) }
+  let(:paths) { relation.to_a.map { |file| file[:__FILE__] } }
+
+  its(:to_a) { is_expected.to eq data }
+  its(:schema) { is_expected.to be_a ROM::Files::Schema }
+
+  it 'lists file paths' do
+    expect(paths).to eql([
+                           P('media/some_image.png'),
+                           P('media/some_file.txt'),
+                           P('media/some_markdown.md')
+                         ])
+  end
+
+  context 'names' do
+    subject { names }
+
+    it { is_expected.to eql([P('some_image.png'), P('some_file.txt'), P('some_markdown.md')]) }
+
+    context 'with custom view using select' do
+      let(:relation) { super().text_files }
+
+      it { is_expected.to eql [P('some_file.txt'), P('some_markdown.md')] }
+    end
+
+    context 'with custom view using reject' do
+      let(:relation) { super().binary_files }
+
+      it { is_expected.to eql [P('some_image.png')] }
+    end
+  end
+end

data/spec/lib/rom/files/relation_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rom/files/relation'
+require 'shared/rom/files/media_relation'
+
+RSpec.describe ROM::Files::Relation do
+  include_context 'media relation'
+
+  its(:count) { is_expected.to eq 3 }
+end

data/spec/lib/rom/files/schema/attributes_inferrer_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rom/files/schema/attributes_inferrer'
+require 'shared/rom/files/media_relation'
+
+RSpec.describe ROM::Files::Schema::AttributesInferrer do
+  include_context 'media files'
+
+  subject(:inferrer) { described_class.new(attr_class: attr_class) }
+  let(:attr_class) { ROM::Files::Attribute }
+
+  its(:attr_class) { is_expected.to eq attr_class }
+
+  describe '#call' do
+    subject(:result) { inferrer.(schema, gateway) }
+    let(:relation_name) { ROM::Relation::Name.new(:media) }
+    let(:schema) { ROM::Files::Schema.new(relation_name) }
+
+    it { is_expected.to be_a Array }
+    its(:size) { is_expected.to eq 2 }
+
+    describe 'inferred' do
+      subject(:inferred) { result.first }
+
+      it { is_expected.to be_a Array }
+      its(:size) { is_expected.to eq 1 }
+
+      describe '__FILE__' do
+        subject(:attribute) { inferred.first }
+
+        it { is_expected.to be_a attr_class }
+        its(:name) { is_expected.to eq ROM::Files::ID }
+        its(:primitive) { is_expected.to eq Pathname }
+        its(:primary_key?) { is_expected.to be true }
+      end
+    end
+
+    describe 'missing' do
+      subject(:missing) { result.last }
+
+      it { is_expected.to be_a Array }
+      its(:size) { is_expected.to eq 0 }
+    end
+  end
+end

data/spec/lib/rom/files/schema/inferrer_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rom/files/schema/inferrer'
+require 'shared/rom/files/media_files'
+
+RSpec.describe ROM::Files::Schema::Inferrer do
+  include_context 'media files'
+
+  subject(:inferrer) { described_class.new }
+  let(:relation_name) { ROM::Relation::Name.new(:media) }
+  let(:schema) { ROM::Files::Schema.new(relation_name) }
+
+  its(:attr_class) { is_expected.to eq ROM::Files::Attribute }
+
+  describe '#call' do
+    subject(:result) { inferrer.(schema, gateway) }
+
+    it { is_expected.to be_a Hash }
+    its([:attributes]) { is_expected.to be_a Array }
+
+    describe '[:attributes]' do
+      subject(:attributes) { result[:attributes] }
+
+      it { is_expected.to be_a Array }
+      its(:size) { is_expected.to eq 1 }
+      its(:first) { is_expected.to be_a ROM::Files::Attribute }
+    end
+  end
+end

data/spec/lib/rom/files/schema_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'rom/files/schema'
+require 'shared/rom/files/media_relation'
+
+RSpec.describe ROM::Files::Schema do
+  subject(:schema) { schema_proc.() }
+  let(:identify) { schema.method(:identify) }
+  let(:contents_for) { schema.method(:contents_for) }
+
+  before { schema.finalize_attributes!.finalize! }
+
+  context 'with simple primary key' do
+    let(:schema_proc) do
+      Class.new(ROM::Relation[:files]).schema do
+        attribute :path, ROM::Files::Types::Path
+      end
+    end
+
+    its(:primary_key) { is_expected.to eql [schema[:path]] }
+
+    describe '#identify' do
+      subject { identify }
+
+      its([path: Pathname('a')]) { is_expected.to eq Pathname('a') }
+      its([path: Pathname('a'), other: 'b']) { is_expected.to eq Pathname('a') }
+      its([other: 'b']) { is_expected.to eq nil }
+    end
+  end
+
+  context 'with complex primary key' do
+    let(:schema_proc) do
+      Class.new(ROM::Relation[:files]).schema do
+        attribute :dir, ROM::Files::Types::Path
+        attribute :path, ROM::Files::Types::Path
+      end
+    end
+
+    its(:primary_key) { is_expected.to eql [schema[:dir], schema[:path]] }
+
+    describe '#identify' do
+      subject { identify }
+
+      its([dir: Pathname('lib/'), path: Pathname('file.rb')]) { is_expected.to eq Pathname('lib/file.rb') }
+      its([dir: Pathname('lib/')]) { is_expected.to eq Pathname('lib/') }
+      its([path: Pathname('file.rb')]) { is_expected.to eq Pathname('file.rb') }
+      its([other: 'b']) { is_expected.to eq nil }
+    end
+  end
+
+  context 'without primary key defined' do
+    let(:schema_proc) do
+      Class.new(ROM::Relation[:files]).schema do
+        attribute :__FILE__, ROM::Files::Types::Pathname
+      end
+    end
+
+    its(:primary_key) { is_expected.to eql [] }
+
+    describe '#identify' do
+      subject { identify }
+
+      its([__FILE__: Pathname('a')]) { is_expected.to eq Pathname('a') }
+      its([__FILE__: Pathname('a'), other: 'b']) { is_expected.to eq Pathname('a') }
+      its([other: 'b']) { is_expected.to eq nil }
+    end
+  end
+
+  context 'with simple contents attribute' do
+    let(:schema_proc) do
+      Class.new(ROM::Relation[:files]).schema do
+        attribute :path, ROM::Files::Types::Path
+        attribute :contents, ROM::Files::Types::String.meta(DATA: true)
+      end
+    end
+
+    its(:primary_key) { is_expected.to eql [schema[:path]] }
+
+    describe '#contents_for' do
+      subject { contents_for }
+
+      its([contents: 'Contents']) { is_expected.to eq 'Contents' }
+      its([contents: '']) { is_expected.to eq '' }
+      its([contents: nil]) { is_expected.to eq nil }
+      its([other: 'b']) { is_expected.to eq nil }
+    end
+  end
+
+  context 'with complex simple contents attribute' do
+    let(:schema_proc) do
+      Class.new(ROM::Relation[:files]).schema do
+        attribute :path, ROM::Files::Types::Path
+        attribute :header, ROM::Files::Types::String.meta(DATA: true)
+        attribute :footer, ROM::Files::Types::String.meta(DATA: true)
+      end
+    end
+
+    its(:primary_key) { is_expected.to eql [schema[:path]] }
+
+    describe '#contents_for' do
+      subject { contents_for }
+
+      its([header: "Header\n", footer: "Footer\n"]) { is_expected.to eq "Header\nFooter\n" }
+      its([header: "Header\n"]) { is_expected.to eq "Header\n" }
+      its([footer: "Footer\n"]) { is_expected.to eq "Footer\n" }
+      its([contents: '']) { is_expected.to eq nil }
+    end
+  end
+end

data/spec/lib/rom/files/types/mime_type_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rom/files/types'
+
+RSpec.describe ROM::Files::Types::MimeType do
+  subject(:type) { described_class }
+
+  its(['text/plain']) { is_expected.to be_a MIME::Type }
+end

data/spec/lib/rom/files/types/path_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rom/files/types'
+
+RSpec.describe ROM::Files::Types::Path do
+  subject(:type) { described_class }
+
+  its([Pathname.pwd]) { is_expected.to be_a Pathname }
+  its(:meta) { is_expected.to eq(primary_key: true) }
+end

data/spec/lib/rom/files/types_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'rom/files/types'
+
+RSpec.describe ROM::Files::Types do
+end

data/spec/shared/rom/files/files_setup.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/gateway_setup'
+
+RSpec.shared_context 'files setup' do
+  include_context 'gateway setup'
+
+  let(:path) { uri.join(dir) }
+  let(:data) do
+    tree.map do |file, _contents|
+      { __FILE__: path.join(file).relative_path_from(uri) }
+    end
+  end
+
+  before :each do
+    path.mkpath
+    tree.each { |file, contents| path.join(file).write(contents) }
+  end
+end

data/spec/shared/rom/files/filesystem_setup.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'filesystem setup' do
+  let(:uri) { SPEC_ROOT.join('../tmp/test') }
+
+  before do
+    uri.rmtree if uri.directory?
+    uri.mkpath
+  end
+end

data/spec/shared/rom/files/gateway_setup.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/filesystem_setup'
+
+RSpec.shared_context 'gateway setup' do
+  include_context 'filesystem setup'
+
+  let(:configuration) { ROM::Configuration.new(:files, uri, extensions: %i[text markdown]) }
+  let(:container) { ROM.container(configuration) }
+  let(:gateway) { container.gateways[:default] }
+
+  # @param [Pathname, #to_s] path
+  # @return [Pathname]
+  def P(path) # rubocop:disable Naming/MethodName
+    Pathname(path)
+  end
+end

data/spec/shared/rom/files/media_dataset.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/media_files'
+
+RSpec.shared_context 'media dataset' do
+  include_context 'media files'
+
+  subject(:dataset) { ROM::Files::Dataset.new(connection: connection) }
+  let(:connection) { ROM::Files::Connection.new(path) }
+end

data/spec/shared/rom/files/media_files.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/files_setup'
+
+RSpec.shared_context 'media files' do
+  include_context 'files setup'
+
+  let(:dir) { 'media' }
+  let(:path) { uri.join(dir) }
+  let(:tree) do
+    {
+      'some_image.png' => '',
+      'some_file.txt' => 'some content',
+      'some_markdown.md' => 'some **markdown** file'
+    }
+  end
+end

data/spec/shared/rom/files/media_relation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'shared/rom/files/media_files'
+
+RSpec.shared_context 'media relation' do
+  include_context 'media files'
+
+  subject(:relation) { container.relations.media }
+
+  before :each do
+    configuration.relation :media do
+      schema :media, infer: true
+
+      # @return [ROM::Files::Relation]
+      def text_files
+        select('*.{txt,md}')
+      end
+
+      # @return [ROM::Files::Relation]
+      def binary_files
+        reject('*.txt', '*.md')
+      end
+    end
+
+    configuration.relation :text do
+      schema 'text/plain', infer: true do
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup
+require 'rspec/its'
+require 'simplecov'
+
+require 'rom-files'
+
+SPEC_ROOT = Pathname(__dir__)