rom-files 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eba4415db48d67a665075918810e5b264f7b384a0e4ea012f60ef2df6fa949e8
+  data.tar.gz: 66a5bb3e56021072805392375f994da8099f4de7a93b3c7172d629aa4a44920c
+SHA512:
+  metadata.gz: cb33c5db321b7a14680c7b38fc683045184202986c11d988ea2a3c08984d6022330db71d7cb3fa7f02978615c462c7a245a1c89ad06d6217262da99be2d1a22f
+  data.tar.gz: 5f0bda1bf6ea5aa843a09e73a448a7625bf0a196068cc6162e0973a8f72d4c3d8bd5518c8b3424e037dae6ab5d4d6f8bd428a9fb830cf31776c1fc537b1398a1

data/.editorconfig

@@ -0,0 +1,9 @@
+[*]
+charset=utf-8
+end_of_line=lf
+insert_final_newline=true
+indent_style=space
+indent_size=2
+
+[*.taskpaper]
+indent_style=tab

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,112 @@
+# Exclude temporary files
+AllCops:
+  TargetRubyVersion: 2.4
+  DefaultFormatter: fuubar
+  DisplayCopNames: true
+  ExtraDetails: true
+  Exclude:
+  - tmp/**/*
+  - bin/*
+
+# The enforced style doesn’t match Vim’s defaults
+Layout/AlignParameters:
+  Enabled: false
+
+# Need to be skipped for >-> usage
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/Debugger:
+  Exclude:
+  - examples/*
+
+# No need to handle LoadError in Rakefile
+Lint/HandleExceptions:
+  Exclude:
+  - Rakefile
+
+Metrics/AbcSize:
+  Exclude:
+  - lib/pathname/extensions/pathmap.rb
+  - lib/rom/files/attribute.rb
+
+Metrics/BlockLength:
+  Exclude:
+  - Guardfile
+  - lib/pathname/extensions/pathmap.rb
+  - rom-files.gemspec
+  - spec/**/*_spec.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+  - lib/pathname/extensions/pathmap.rb
+
+Metrics/LineLength:
+  Max: 256
+
+Metrics/MethodLength:
+  Exclude:
+  - lib/pathname/extensions/pathmap.rb
+  - lib/rom/files/connection.rb
+
+Naming/FileName:
+  Exclude:
+  - '**/rom-files*'
+
+Naming/MethodName:
+  Exclude:
+  - lib/**/types.rb
+  - lib/dry/types/pathname.rb
+
+# UTF-8 is perfectly fine in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow using braces for value-returning blocks
+Style/BlockDelimiters:
+  Enabled: false
+
+# Documentation checked by Inch CI
+Style/Documentation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Exclude:
+  - lib/pathname/extensions/pathmap.rb
+  - lib/rom/files/extensions/gem/relations/*.rb
+  - spec/lib/pathname/extensions/pathmap_spec.rb
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# Need to be skipped for >-> usage
+Style/Lambda:
+  Enabled: false
+
+# Use compact calls with braces
+Style/LambdaCall:
+  EnforcedStyle: braces
+
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Accept both single and double quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Allow def self.foo; @foo; end
+Style/TrivialAccessors:
+  Enabled: false
+
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-11-28 03:15:26 +0300 using RuboCop version 0.51.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/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.start do
+  add_filter '/bin/'
+  add_filter '/spec/'
+  add_group('Missing') { |src| src.covered_percent < 100 }
+  add_group('Covered') { |src| src.covered_percent == 100 }
+end

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without yard guard benchmarks tools
+script: "bin/rake ci"
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - rbx-2
+  - jruby-9000
+  - jruby-head
+  - ruby-head
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=d284024edac5ef6b2f4b7d4a85505d192433ea269824c54592876999f0efce47
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: jruby-9000
+    - rvm: ruby-head
+    - rvm: jruby-head

data/.yardopts

@@ -0,0 +1,6 @@
+--plugin junk
+--title 'rom-files'
+--markup markdown
+--readme README.md
+--files *.md
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# The Changelog
+
+## v0.2.0 - _Unreleased_
+
+* Updated to ROM 4.0
+* Renamed to `rom-files`
+
+## v0.1.0 - _2016-02-06_
+
+First release. Allows to retrieve file data from relations (directories).

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source :github do |repo|
+  "https://github.com/#{repo}"
+end
+
+gemspec
+
+gem 'rom', '~> 4.1', github: 'rom-rb/rom', branch: :master
+gem 'rom-sql', '~> 2.2', github: 'rom-rb/rom-sql', branch: :master
+
+group :development do
+  gem 'tty-file'
+  gem 'tty-tree'
+end
+
+group :ide do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'guard-shell'
+  gem 'terminal-notifier-guard'
+end

data/Guardfile

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+notification :terminal_notifier if `uname`.match?(/Darwin/)
+notification :tmux, display_message: true if ENV.key?('TMUX')
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bin/rspec', all_on_start: true, all_after_pass: true do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    rspec = dsl.rspec
+    watch('.rspec') { rspec.spec_dir }
+    watch('Gemfile.lock') { rspec.spec_dir }
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(%r{\A#{rspec.spec_dir}/(?:shared)/.+\.rb\Z}) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cli: '--auto-correct' do
+    watch(%r{\Alib/.+\.rb\Z})
+    watch(%r{\Aspec/.+\.rb\Z})
+    watch(/\.rubocop.*\.yml/) { '.' }
+  end
+
+  guard :shell do
+    command = 'bin/yard doc --use-cache'
+    watch(%r{\Alib/.+\.rb\Z}) { |m| `#{command} #{m}` }
+    watch(/\A.+\.md\Z/) { |m| `#{command} #{m}` }
+    watch('.yardopts') { `#{command}` }
+  end
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+© 2017 Alex Semyonov, Héctor Ramón
+
+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,44 @@
+[gem]: https://rubygems.org/gems/rom-files
+[travis]: https://travis-ci.org/alsemyonov/rom-files
+[gemnasium]: https://gemnasium.com/alsemyonov/rom-files
+[codeclimate]: https://codeclimate.com/github/alsemyonov/rom-files
+[inchpages]: http://inch-ci.org/github/alsemyonov/rom-files
+
+# ROM::Files
+
+[![Gem Version](https://badge.fury.io/rb/rom-files.svg)][gem]
+[![Build Status](https://travis-ci.org/alsemyonov/rom-files.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/alsemyonov/rom-files.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/alsemyonov/rom-files/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/alsemyonov/rom-files/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/alsemyonov/rom-files.svg?branch=master)][inchpages]
+
+Files adapter for [Ruby Object Mapper](https://github.com/rom-rb/rom).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom-files'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install rom-files
+```
+
+## Changelog
+
+See {file:CHANGELOG.md}.
+
+## License
+
+See {file:LICENSE.md}.

data/Rakefile

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new :style do |task|
+  task.options << '--display-cop-names'
+end
+
+namespace :doc do
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new :default
+
+  require 'yard-junk'
+  desc 'Check the junk in your YARD Documentation'
+  task :junk do
+    exit_code = YardJunk::Janitor.new.run.report(:text)
+    exit exit_code unless exit_code.zero?
+  end
+
+  desc 'Check documentation with `yardcheck`'
+  task :check do
+    sh 'yardcheck --require rom-files --include lib --namespace ROM::Files --rspec spec'
+  end
+end
+
+task doc: %i[doc:default]
+
+desc 'Run CI tasks'
+task ci: %i[spec style doc doc:junk doc:check]
+
+task default: :ci

data/Roadmap.taskpaper

@@ -0,0 +1,44 @@
+rom-files:
+	ROM adapter for `file://` scheme
+	Goal: Universal ROM adapter for hierarchical tree-like (POSIX-compatible) filesystems
+	Connection:
+		- support file:// @done(2017-11-28)
+		- support dropbox://
+		- support webdav://
+	Dataset:
+		- provide interface comparable with Rake::FileList:
+			- remove Dataset#path @done(2017-11-28)
+			- add Dataset#data including selected tuples
+			- add Dataset#pending meaning #data should be rebuilt
+			- make #data-based datasets @done(2017-11-28)
+			- make datasets with MIME-type filtering @done(2017-11-28)
+			- make datasets with glob patterns filtering @done(2017-11-28)
+		- Implement Dataset#at(path)
+		- Implement Dataset#patterns @done(2017-11-28)
+		- Implement Dataset#paths @done(2017-11-28)
+		- Implement Dataset#to_tree
+			See `tty-tree` gem
+	Schema:
+		- Provide dynamic attributes based on pathname @done(2017-11-24)
+		- Provide Foreign Keys shortcuts @done(2017-11-24)
+		- Provide dynamic attributes based on contents
+		- Provide `#has_one` association support (`library_files` has one `spec_file` in gem setup)
+		- Provide `#has_many` association support (`year` has many `months` in middleman-like setup)
+		- Provide `:frontmatter` schema plugin
+		- Provide `:markdown` extension with `text/markdown` mime-type support @done(2017-11-23)
+		- Provide `:ruby` extension with `application/x-ruby` mime-type support @done(2017-11-24)
+		- Provide `:yaml` extension with `text/x-yaml` MIME-type support
+		- Provide `:csv` extension with `text/csv` MIME-type support
+	Configuration:
+		- Provide `:gem` extension with gem relations
+		- Provide `:xdg` extension for user directories layout support
+		- Provide `:ruby_generator` extension support
+			- Provide command for generating ruby class with RSpec test
+		- Provide `:dry_web` extension command for generating dry-web
+	Backlog:
+		- Provide `:website` extension for setting up middleman-like website
+		- Provide `:blog` extension for setting up blog
+		- Provide `:src` extension for unbroken pipeline
+Archive:
+	- Provide the way to use file stat properties in schema @done(2017-11-20) @project(rom-files)
+	- Add dynamic attributes, based on file path or other properties @done(2017-11-20) @project(rom-files)

data/bin/_guard-core

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")