rom-files 0.2.0

data/spec/integration/rom/files/gem_spec.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rom-files'
+require 'rspec'
+
+RSpec.example_group ROM::Files, 'usage with gem' do
+  # @param [ROM::ConfigurationDSL] config
+  def def_tools(config)
+    config.relation :tools do
+      dataset do
+        select('*') # .stat(executable: true)
+      end
+
+      schema 'bin' do
+        # use :shebang
+      end
+    end
+  end
+
+  # @param [ROM::ConfigurationDSL] config
+  def def_examples(config)
+    config.relation :examples do
+      dataset { select '**/*.rb' }
+
+      schema 'examples' do
+        # use :ruby
+      end
+    end
+  end
+
+  def def_docs(config)
+    config.relation :docs do
+      dataset { select '**/*.md' }
+
+      schema 'text/markdown' do
+        # use :contents, type: Types::Markdown
+      end
+    end
+  end
+
+  def def_library(config)
+    config.relation :implementations do
+      dataset { inside('lib').recursive }
+
+      schema 'lib' do
+        # associations do
+        #   has_one :specification
+        # end
+      end
+    end
+  end
+
+  def def_specification(config)
+    config.relation :specifications do
+      dataset { select '**/*_spec.rb' }
+
+      schema 'spec' do
+        # associations do
+        #   belongs_to :implementation
+        # end
+      end
+    end
+  end
+
+  # @return [ROM::Container]
+  subject(:container) do
+    ROM.container(:files, uri) do |config|
+      def_docs(config)
+      def_tools(config)
+      def_examples(config)
+      def_library(config)
+      def_specification(config)
+      config.relation :gem do
+        schema :gem do
+          # associations do
+          #   has_many :implementations
+          #   has_many :specifications
+          #   has_many :rake_files
+          # end
+        end
+      end
+    end
+  end
+  let(:uri) { SPEC_ROOT.dirname }
+  let(:library_files) { container.relations[:implementations] }
+
+  xexample 'Container usage' do
+    require 'pry'
+    binding.pry # rubocop:disable Lint/Debugger
+  end
+
+  example 'List library files' do
+    expect(library_files.to_a).to be_a Array
+  end
+end
+
+require 'rspec/autorun' if $PROGRAM_NAME == __FILE__

data/spec/integration/rom/files/relations_spec.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rom-files'
+require 'rspec'
+
+RSpec.example_group ROM::Files::Relation do
+  Files = ROM::Files
+  Types = Files::Types
+
+  class Implementations < ROM::Files::Relation
+    dataset { select('*.rb').recursive }
+    schema :lib, as: :implementations do
+      attribute Files::ID, Types::Coercible::Pathname
+
+      primary_key Files::ID
+    end
+  end
+
+  class Specifications < ROM::Files::Relation
+    dataset { select('*_spec.rb').recursive }
+    schema :spec, as: :specifications do
+      attribute Files::ID, Types::Path
+    end
+  end
+
+  class TempFiles < ROM::Files::Relation
+    dataset { recursive }
+    schema :tmp, as: :temporary_files do
+      attribute Files::ID, Types::Pathname.meta(primary_key: true)
+    end
+  end
+
+  let(:configuration) do
+    ROM::Configuration.new(:files, Pathname(__dir__).dirname) do |config|
+      config.register_relation(Implementations)
+      config.register_relation(Specifications)
+      config.register_relation(TempFiles)
+    end
+  end
+  let(:container) { ROM.container(configuration) }
+
+  example 'Retrieving relations' do
+    p container
+
+    lib = container.relations[:implementations]
+    spec = container.relations[:specifications]
+    tmp = container.relations[:temporary_files]
+
+    expect(lib).to be_a Implementations
+    expect(spec).to be_a Specifications
+    expect(tmp).to be_a TempFiles
+
+    puts "lib #=> #{lib.inspect}"
+    puts 'pluck(:to_s) #=>', lib.pluck(:to_s)
+    # p :to_a, lib.to_a
+    puts 'spec #=>', spec.pluck(:basename)
+
+    puts "tmp #=> #{tmp.to_a}"
+  end
+end
+
+require 'rspec/autorun' if $PROGRAM_NAME == __FILE__

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rom/files/schema/inferrer'
+require 'shared/rom/files/media_files'
+
+RSpec.describe 'Schema inference for common file types' do
+  include_context 'media files'
+
+  let(:relation) { container.relations[relation_name] }
+  let(:schema) { relation.schema }
+  let(:source) { schema.name }
+  let(:relation_name) { dataset }
+
+  describe 'inferring attributes' do
+    before do
+      name = dataset
+      configuration.relation(relation_name) { schema(name, infer: true) }
+    end
+
+    context 'for any file set' do
+      let(:dataset) { :media }
+
+      describe '__FILE__' do
+        subject(:attribute) { schema[:__FILE__] }
+
+        its(:source) { is_expected.to eql source }
+        its('type.primitive') { is_expected.to be Pathname }
+      end
+    end
+
+    context 'for `text/plain` file set' do
+      let(:relation_name) { :texts }
+      let(:dataset) { 'text/plain' }
+
+      describe '__FILE__' do
+        subject(:attribute) { schema[:__FILE__] }
+
+        its(:source) { is_expected.to eql source }
+        its('type.primitive') { is_expected.to be Pathname }
+      end
+
+      describe 'DATA' do
+        subject(:attribute) { schema[:DATA] }
+
+        its(:source) { is_expected.to eql source }
+        its('type.primitive') { is_expected.to be String }
+
+        it 'autoloads contents' do
+          expect(attribute.meta[:DATA]).to be(true)
+        end
+      end
+    end
+
+    context 'for `text/markdown` file set' do
+      let(:relation_name) { :texts }
+      let(:dataset) { 'text/markdown' }
+
+      describe '__FILE__' do
+        subject(:attribute) { schema[:__FILE__] }
+
+        its(:source) { is_expected.to eql source }
+        its('type.primitive') { is_expected.to be Pathname }
+      end
+
+      describe 'DATA' do
+        subject(:attribute) { schema[:DATA] }
+
+        its(:source) { is_expected.to eql source }
+        its('type.primitive') { is_expected.to be Kramdown::Document }
+
+        it 'autoloads contents' do
+          expect(attribute.meta[:DATA]).to be(true)
+        end
+      end
+    end
+  end
+end

data/spec/lib/dry/types/pathname_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'dry/types/pathname'
+
+RSpec.describe Dry::Types do
+  subject(:types) { described_class }
+  specify { expect(types['optional.pathname']).to be_a Dry::Types::Sum }
+
+  describe 'pathname' do
+    subject(:type) { types['pathname'] }
+
+    it { is_expected.to be_a Dry::Types::Definition }
+
+    specify { expect(type[nil]).to eq nil }
+    specify { expect(type['sample.rb']).to eq 'sample.rb' }
+    specify { expect(type[Pathname('sample.rb')]).to eq Pathname('sample.rb') }
+  end
+
+  describe 'optional.pathname' do
+    subject(:type) { types['optional.pathname'] }
+
+    it { is_expected.to be_a Dry::Types::Sum }
+
+    specify { expect(type[nil]).to eq nil }
+    specify { expect(type['sample.rb']).to eq 'sample.rb' }
+    specify { expect(type[Pathname('sample.rb')]).to eq Pathname('sample.rb') }
+  end
+
+  describe 'coercible.pathname' do
+    subject(:type) { types['coercible.pathname'] }
+
+    it { is_expected.to be_a Dry::Types::Definition }
+
+    specify { expect(type[nil]).to eq Pathname('') }
+    specify { expect(type[:media]).to eq Pathname('media') }
+    specify { expect(type['sample.rb']).to eq Pathname('sample.rb') }
+    specify { expect(type[Pathname('sample.rb')]).to eq Pathname('sample.rb') }
+  end
+
+  describe 'strict.pathname' do
+    subject(:type) { types['strict.pathname'] }
+
+    it { is_expected.to be_a Dry::Types::Constrained }
+
+    specify { expect { type[nil] }.to raise_error Dry::Types::ConstraintError }
+    specify { expect { type['sample.rb'] }.to raise_error Dry::Types::ConstraintError }
+    specify { expect { type[Pathname('sample.rb')] }.not_to raise_error }
+    specify { expect(type[Pathname('sample.rb')]).to eq Pathname('sample.rb') }
+  end
+end

data/spec/lib/pathname/extensions/explode_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'pathname/extensions'
+
+RSpec.describe Pathname do
+  before { described_class.load_extensions :explode }
+
+  describe '#explode' do
+    specify { expect(Pathname('a').explode).to eq [Pathname('a')] }
+    specify { expect(Pathname('a/b').explode).to eq [Pathname('a'), Pathname('b')] }
+    specify { expect(Pathname('a/b/c').explode).to eq [Pathname('a'), Pathname('b'), Pathname('c')] }
+    specify { expect(Pathname('/a').explode).to eq [Pathname('/'), Pathname('a')] }
+    specify { expect(Pathname('/a/b').explode).to eq [Pathname('/'), Pathname('a'), Pathname('b')] }
+    specify { expect(Pathname('/a/b/c').explode).to eq [Pathname('/'), Pathname('a'), Pathname('b'), Pathname('c')] }
+
+    if File::ALT_SEPARATOR
+      specify { expect(Pathname('c:a').explode).to eq [Pathname('c:.'), Pathname('a')] }
+      specify { expect(Pathname('c:a/b').explode).to eq [Pathname('c:.'), Pathname('a'), Pathname('b')] }
+      specify { expect(Pathname('c:a/b/c').explode).to eq [Pathname('c:.'), Pathname('a'), Pathname('b'), Pathname('c')] }
+      specify { expect(Pathname('c:/a').explode).to eq [Pathname('c:/'), Pathname('a')] }
+      specify { expect(Pathname('c:/a/b').explode).to eq [Pathname('c:/'), Pathname('a'), Pathname('b')] }
+      specify { expect(Pathname('c:/a/b/c').explode).to eq [Pathname('c:/'), Pathname('a'), Pathname('b'), Pathname('c')] }
+    end
+  end
+end

data/spec/lib/pathname/extensions/ext_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'pathname/extensions'
+
+RSpec.describe Pathname do
+  before { described_class.load_extensions :ext }
+
+  describe '#ext' do
+    specify { expect(Pathname('one.two').ext('net')).to eq Pathname('one.net') }
+    specify { expect(Pathname('one.two').ext('.net')).to eq Pathname('one.net') }
+    specify { expect(Pathname('one').ext('net')).to eq Pathname('one.net') }
+    specify { expect(Pathname('one').ext('.net')).to eq Pathname('one.net') }
+    specify { expect(Pathname('one.two.c').ext('.net')).to eq Pathname('one.two.net') }
+    specify { expect(Pathname('one/two.c').ext('.net')).to eq Pathname('one/two.net') }
+    specify { expect(Pathname('one.x/two.c').ext('.net')).to eq Pathname('one.x/two.net') }
+    specify { expect(Pathname('one.x/two').ext('.net')).to eq Pathname('one.x/two.net') }
+    specify { expect(Pathname('.onerc.dot').ext('net')).to eq Pathname('.onerc.net') }
+    specify { expect(Pathname('.onerc').ext('net')).to eq Pathname('.onerc.net') }
+    specify { expect(Pathname('.a/.onerc').ext('net')).to eq Pathname('.a/.onerc.net') }
+    specify { expect(Pathname('one.two').ext('')).to eq Pathname('one') }
+    specify { expect(Pathname('one.two').ext).to eq Pathname('one') }
+    specify { expect(Pathname('.one.two').ext).to eq Pathname('.one') }
+    specify { expect(Pathname('.one').ext).to eq Pathname('.one') }
+    specify { expect(Pathname('.').ext('c')).to eq Pathname('.') }
+    specify { expect(Pathname('..').ext('c')).to eq Pathname('..') }
+
+    # These only need to work in windows
+    if RbConfig::CONFIG['host_os'].match?(/(msdos|mswin|djgpp|mingw|[Ww]indows)/)
+      specify { expect(Pathname('one.x\\two.c').ext('.net')).to eq Pathname('one.x\\two.net') }
+      specify { expect(Pathname('one.x\\two').ext('.net')).to eq Pathname('one.x\\two.net') }
+    end
+  end
+end

data/spec/lib/pathname/extensions/partial_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pathname/extensions'
+
+RSpec.describe Pathname do
+  before { described_class.load_extensions :partial }
+
+  describe '#partial' do
+    specify { expect(Pathname('1/2/file').partial(1)).to eq Pathname('1') }
+    specify { expect(Pathname('1/2/file').partial(2)).to eq Pathname('1/2') }
+    specify { expect(Pathname('1/2/file').partial(3)).to eq Pathname('1/2') }
+    specify { expect(Pathname('1/2/file').partial(0)).to eq Pathname('.') }
+    specify { expect(Pathname('1/2/file').partial(-1)).to eq Pathname('2') }
+    specify { expect(Pathname('1/2/file').partial(-2)).to eq Pathname('1/2') }
+    specify { expect(Pathname('1/2/file').partial(-3)).to eq Pathname('1/2') }
+  end
+end

data/spec/lib/pathname/extensions/pathmap_spec.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'pathname/extensions'
+
+RSpec.describe Pathname do
+  before { described_class.load_extensions :pathmap }
+
+  it 'returns_self_with_no_args', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap).to eq Pathname('abc.rb')
+  end
+
+  it 's_returns_file_separator', :aggregate_failures do
+    sep = File::ALT_SEPARATOR || File::SEPARATOR
+    expect(Pathname('abc.rb').pathmap('%s')).to eq Pathname(sep)
+    expect(Pathname('').pathmap('%s')).to eq Pathname(sep)
+    expect(Pathname('a/b').pathmap('%d%s%f')).to eq Pathname("a#{sep}b")
+  end
+
+  it 'f_returns_basename', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap('%f')).to eq Pathname('abc.rb')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%f')).to eq Pathname('abc.rb')
+    expect(Pathname('/this/is/a/dir/abc.rb').pathmap('%f')).to eq Pathname('abc.rb')
+  end
+
+  it 'n_returns_basename_without_extension', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap('%n')).to eq Pathname('abc')
+    expect(Pathname('abc').pathmap('%n')).to eq Pathname('abc')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%n')).to eq Pathname('abc')
+    expect(Pathname('/this/is/a/dir/abc.rb').pathmap('%n')).to eq Pathname('abc')
+    expect(Pathname('/this/is/a/dir/abc').pathmap('%n')).to eq Pathname('abc')
+  end
+
+  it 'd_returns_dirname', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap('%d')).to eq Pathname('.')
+    expect(Pathname('/abc').pathmap('%d')).to eq Pathname('/')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%d')).to eq Pathname('this/is/a/dir')
+    expect(Pathname('/this/is/a/dir/abc.rb').pathmap('%d')).to eq Pathname('/this/is/a/dir')
+  end
+
+  it '9d_returns_partial_dirname', :aggregate_failures do
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%2d')).to eq Pathname('this/is')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%1d')).to eq Pathname('this')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%0d')).to eq Pathname('.')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%-1d')).to eq Pathname('dir')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%-2d')).to eq Pathname('a/dir')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%100d')).to eq Pathname('this/is/a/dir')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%-100d')).to eq Pathname('this/is/a/dir')
+  end
+
+  it 'x_returns_extension', :aggregate_failures do
+    expect(Pathname('abc').pathmap('%x')).to eq Pathname('')
+    expect(Pathname('abc.rb').pathmap('%x')).to eq Pathname('.rb')
+    expect(Pathname('abc.xyz.rb').pathmap('%x')).to eq Pathname('.rb')
+    expect(Pathname('.depends').pathmap('%x')).to eq Pathname('')
+    expect(Pathname('dir/.depends').pathmap('%x')).to eq Pathname('')
+  end
+
+  it 'x_returns_everything_but_extension', :aggregate_failures do
+    expect(Pathname('abc').pathmap('%X')).to eq Pathname('abc')
+    expect(Pathname('abc.rb').pathmap('%X')).to eq Pathname('abc')
+    expect(Pathname('abc.xyz.rb').pathmap('%X')).to eq Pathname('abc.xyz')
+    expect(Pathname('ab.xyz.rb').pathmap('%X')).to eq Pathname('ab.xyz')
+    expect(Pathname('a.xyz.rb').pathmap('%X')).to eq Pathname('a.xyz')
+    expect(Pathname('abc.rb').pathmap('%X')).to eq Pathname('abc')
+    expect(Pathname('ab.rb').pathmap('%X')).to eq Pathname('ab')
+    expect(Pathname('a.rb').pathmap('%X')).to eq Pathname('a')
+    expect(Pathname('.depends').pathmap('%X')).to eq Pathname('.depends')
+    expect(Pathname('a/dir/.depends').pathmap('%X')).to eq Pathname('a/dir/.depends')
+    expect(Pathname('/.depends').pathmap('%X')).to eq Pathname('/.depends')
+  end
+
+  it 'p_returns_entire_pathname', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap('%p')).to eq Pathname('abc.rb')
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%p')).to eq Pathname('this/is/a/dir/abc.rb')
+    expect(Pathname('/this/is/a/dir/abc.rb').pathmap('%p')).to eq Pathname('/this/is/a/dir/abc.rb')
+  end
+
+  it 'dash_returns_empty_string', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap('%-')).to eq Pathname('')
+    expect(Pathname('abc.rb').pathmap('%X%-%x')).to eq Pathname('abc.rb')
+  end
+
+  it 'percent_percent_returns_percent', :aggregate_failures do
+    expect(Pathname('').pathmap('a%%b')).to eq Pathname('a%b')
+  end
+
+  it 'undefined_percent_causes_error', :aggregate_failures do
+    expect { Pathname('dir/abc.rb').pathmap('%z') }.to raise_error ArgumentError
+  end
+
+  it 'pattern_returns_substitutions', :aggregate_failures do
+    expect(Pathname('src/org/osb/Xyz.java').pathmap('%{src,bin}d')).to eq Pathname('bin/org/osb')
+  end
+
+  it 'pattern_can_use_backreferences', :aggregate_failures do
+    expect(Pathname('dir/this/is').pathmap('%{t(hi)s,\\1}p')).to eq Pathname('dir/hi/is')
+  end
+
+  it 'pattern_with_star_replacement_string_uses_block', :aggregate_failures do
+    expect(Pathname('src/org/osb/Xyz.java').pathmap('%{/org,*}d', &:upcase)).to eq Pathname('src/ORG/osb')
+    expect(Pathname('src/org/osb/Xyz.java').pathmap('%{.*,*}f', &:capitalize)).to eq Pathname('Xyz.java')
+  end
+
+  it 'pattern_with_no_replacement_nor_block_substitutes_empty_string', :aggregate_failures do
+    expect(Pathname('abc.rb').pathmap('%{a}f')).to eq Pathname('bc.rb')
+  end
+
+  it 'pattern_works_with_certain_valid_operators', :aggregate_failures do
+    expect(Pathname('dir/abc.rb').pathmap('%{a,x}p')).to eq Pathname('dir/xbc.rb')
+    expect(Pathname('dir/abc.rb').pathmap('%{i,1}d')).to eq Pathname('d1r')
+    expect(Pathname('dir/abc.rb').pathmap('%{a,x}f')).to eq Pathname('xbc.rb')
+    expect(Pathname('dir/abc.rb').pathmap('%{r,R}x')).to eq Pathname('.Rb')
+    expect(Pathname('dir/abc.rb').pathmap('%{a,x}n')).to eq Pathname('xbc')
+  end
+
+  it 'multiple_patterns', :aggregate_failures do
+    expect(Pathname('this/is/a/dir/abc.rb').pathmap('%{a,b;dir,\\0ectory}p')).to eq Pathname('this/is/b/directory/abc.rb')
+  end
+
+  it 'partial_directory_selection_works_with_patterns', :aggregate_failures do
+    expect(Pathname('this/is/a/really/long/path/ok.rb').pathmap('%{/really/,/}5d')).to eq Pathname('this/is/a/long')
+  end
+
+  it 'pattern_with_invalid_operator', :aggregate_failures do
+    expect do
+      Pathname('abc.xyz').pathmap('%{src,bin}z')
+    end.to raise_error ArgumentError, /unknown.*pathmap.*spec.*z/i
+  end
+
+  it 'works_with_windows_separators', :aggregate_failures do
+    if File::ALT_SEPARATOR
+      expect(Pathname('dir\abc.rb').pathmap('%n')).to eq Pathname('abc')
+      expect(Pathname('this\is\a\dir\abc.rb').pathmap('%d')).to eq Pathname('this\is\a\dir')
+    end
+  end
+
+  it 'complex_patterns', :aggregate_failures do
+    sep = Pathname('').pathmap('%s')
+    expect(Pathname('dir/abc.rb').pathmap('%d/%n%x')).to eq Pathname('dir/abc.rb')
+    expect(Pathname('abc.rb').pathmap('%d/%n%x')).to eq Pathname('./abc.rb')
+    expect(Pathname('dir/abc.rb').pathmap("Your file extension is '%x'")).to eq Pathname("Your file extension is '.rb'")
+    expect(Pathname('src/org/onestepback/proj/A.java').pathmap('%{src,bin}d/%n.class')).to eq Pathname('bin/org/onestepback/proj/A.class')
+    expect(Pathname('src_work/src/org/onestepback/proj/A.java').pathmap('%{\bsrc\b,bin}X.class')).to eq Pathname('src_work/bin/org/onestepback/proj/A.class')
+    expect(Pathname('.depends').pathmap('%X.bak')).to eq Pathname('.depends.bak')
+    expect(Pathname('a/b/c/d/file.txt').pathmap('%-1d%s%3d%s%f')).to eq Pathname("d#{sep}a/b/c#{sep}file.txt")
+  end
+end