rom-filesystem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07e33aa71201427c543df2bb38df3fa50d685592
+  data.tar.gz: b6fbf5bf3f40f2118bddff64e5479425011f91f1
+SHA512:
+  metadata.gz: e8988020d9c982751865363369b52bc324d7a5be2e97aec4c70f04e8cfe730c9114cb66dcc6b6209358e36394b9e7e2d4597edbb496a59974a2949bff4eeb342
+  data.tar.gz: 5df3ecc124baf1cb699aa1817d0d16bc783f3e4b006199b4ac79dac02152af71246961d8acea348dbad41f4e8c71f5801994c1ec8b2517b9175f92b2619783a5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,74 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+# Exclude temporary files
+AllCops:
+  Exclude:
+    - tmp/**/*
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# No need to handle LoadError in Rakefile
+Lint/HandleExceptions:
+  Exclude:
+    - Rakefile
+
+# gemspec is a special snowflake
+Metrics/LineLength:
+  Exclude:
+    - rom.gemspec
+
+# The enforced style doesn’t match Vim’s defaults
+Style/AlignParameters:
+  Enabled: false
+
+# 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
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# Need to be skipped for >-> usage
+Style/Lambda:
+  Enabled: false
+
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Result::Success and Result::Failure use > for callbacks
+Style/OpMethod:
+  Exclude:
+    - lib/rom/command_registry.rb
+
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Need to be skipped for >-> usage
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Accept both single and double quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Allow def self.foo; @foo; end
+Style/TrivialAccessors:
+  Enabled: false
+
+# Allow rom-sql
+Style/FileName:
+    Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-26 17:45:40 +0200 using RuboCop version 0.34.2.
+# 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.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 23
+
+# Offense count: 17
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 118
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 17

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without yard guard benchmarks tools
+script: "bundle exec rake ci"
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - rbx-2
+  - jruby-9000
+  - jruby-head
+  - ruby-head
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=4bc2ab1a7aa4cefb2d9794f3f13941a479c42884d0afea032a841ed0fbebfb44
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: jruby-9000
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 2016-02-06
+
+First release. Allows to retrieve file data from relations (directories).

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec', '~> 3.1'
+  gem 'codeclimate-test-reporter', require: false
+  gem 'inflecto'
+end
+
+group :tools do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rubocop', '~> 0.28'
+end

data/Guardfile

@@ -0,0 +1,24 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "rspec", all_on_start: true do
+    # run all specs if Gemfile.lock is modified
+    watch('Gemfile.lock') { 'spec' }
+
+    # run all specs if any library code is modified
+    watch(%r{\Alib/.+\.rb\z}) { 'spec' }
+
+    # run all specs if supporting files are modified
+    watch('spec/spec_helper.rb') { 'spec' }
+    watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+    # run a spec if it is modified
+    watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+
+    notification :tmux, display_message: true if ENV.key?('TMUX')
+  end
+
+  guard :rubocop do
+    # run rubocop on modified file
+    watch(%r{\Alib/.+\.rb\z})
+    watch(%r{\Aspec/.+\.rb\z})
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,36 @@
+[gem]: https://rubygems.org/gems/rom-filesystem
+[travis]: https://travis-ci.org/hecrj/rom-filesystem
+[gemnasium]: https://gemnasium.com/hecrj/rom-filesystem
+[codeclimate]: https://codeclimate.com/github/hecrj/rom-filesystem
+[inchpages]: http://inch-ci.org/github/hecrj/rom-filesystem
+
+# ROM::Filesystem
+
+[![Gem Version](https://badge.fury.io/rb/rom-filesystem.svg)][gem]
+[![Build Status](https://travis-ci.org/hecrj/rom-filesystem.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/hecrj/rom-filesystem.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/hecrj/rom-filesystem/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/hecrj/rom-filesystem/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/hecrj/rom-filesystem.svg?branch=master)][inchpages]
+
+Filesystem adapater for [Ruby Object Mapper](https://github.com/rom-rb/rom).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom-filesystem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-filesystem
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:ci]
+
+desc 'Run CI tasks'
+task ci: [:spec]
+
+begin
+  require 'rubocop/rake_task'
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << '--display-cop-names'
+  end
+rescue LoadError
+end

data/lib/rom-filesystem.rb

@@ -0,0 +1 @@
+require 'rom/filesystem'

data/lib/rom/filesystem.rb

@@ -0,0 +1,7 @@
+require 'rom'
+
+require 'rom/filesystem/version'
+require 'rom/filesystem/gateway'
+require 'rom/filesystem/relation'
+
+ROM.register_adapter(:filesystem, ROM::Filesystem)

data/lib/rom/filesystem/dataset.rb

@@ -0,0 +1,41 @@
+module ROM
+  module Filesystem
+    class Dataset
+      def initialize(dir, options = {})
+        @dir = dir
+        @options = options
+
+        @options[:select] ||= ['*']
+      end
+
+      def select(*args)
+        self.class.new(@dir, @options.merge(select: args))
+      end
+
+      def sort
+        self.class.new(@dir, @options.merge(sort: true))
+      end
+
+      def each(&block)
+        to_a.each(&block)
+      end
+
+      def to_a
+        root = Pathname.new(@dir.path)
+        paths = @options[:select].map { |filter| "#{root}/#{filter}" }
+
+        matches = Dir[*paths].reject { |f| f == '.' || f == '..' }
+        matches = matches.sort if @options[:sort]
+
+        matches.map do |filename|
+          path = root.join(filename)
+
+          {
+            name: path.basename.to_s,
+            path: path
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rom/filesystem/gateway.rb

@@ -0,0 +1,19 @@
+require 'rom/filesystem/dataset'
+
+module ROM
+  module Filesystem
+    class Gateway < ROM::Gateway
+      def initialize(root)
+        @root = File.absolute_path(root)
+      end
+
+      def dataset(name)
+        Dataset.new(Dir.new("#{@root}/#{name}"))
+      end
+
+      def dataset?(name)
+        Dir.exist?("#{@root}/#{name}")
+      end
+    end
+  end
+end

data/lib/rom/filesystem/relation.rb

@@ -0,0 +1,9 @@
+module ROM
+  module Filesystem
+    class Relation < ROM::Relation
+      adapter :filesystem
+
+      forward :select, :sort
+    end
+  end
+end

data/lib/rom/filesystem/version.rb

@@ -0,0 +1,5 @@
+module Rom
+  module Filesystem
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rom-filesystem.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom/filesystem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rom-filesystem'
+  spec.version       = Rom::Filesystem::VERSION
+  spec.authors       = ['Héctor Ramón']
+  spec.email         = ['hector0193@gmail.com']
+
+  spec.summary       = 'Filesystem adapter for ROM'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/hecrj/rom-filesystem'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rom', '~> 1.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/integration/read_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Reading relations' do
+  include_context 'media files'
+
+  before :each do
+    configuration.relation(:media) do
+      register_as :media
+    end
+  end
+
+  it 'lists file paths' do
+    paths = container.relation(:media).sort.to_a.map { |file| file[:path] }
+
+    expect(paths).to eql([
+                           Pathname.new(TMP_TEST_DIR).join('media/some_file.txt'),
+                           Pathname.new(TMP_TEST_DIR).join('media/some_image.png'),
+                           Pathname.new(TMP_TEST_DIR).join('media/some_markdown.md')
+                         ])
+  end
+
+  it 'lists file names' do
+    names = container.relation(:media).sort.to_a.map { |file| file[:name] }
+
+    expect(names).to eql(%w(some_file.txt some_image.png some_markdown.md))
+  end
+
+  it 'selects files' do
+    files = container.relation(:media).select('*.txt', '*.png').sort.to_a.map { |file| file[:name] }
+
+    expect(files).to eql(%w(some_file.txt some_image.png))
+  end
+end

data/spec/shared/database_setup.rb

@@ -0,0 +1,4 @@
+shared_context 'database setup' do
+  let(:configuration) { ROM::Configuration.new(:filesystem, TMP_TEST_DIR).use(:macros) }
+  let(:container) { ROM.container(configuration) }
+end

data/spec/shared/media_files.rb

@@ -0,0 +1,19 @@
+shared_context 'media files' do
+  include_context 'database setup'
+
+  before :each do
+    media_dir = TMP_TEST_DIR.join('media')
+
+    FileUtils.mkdir_p(media_dir)
+
+    File.open(media_dir.join('some_file.txt'), 'w') do |f|
+      f.write('some content')
+    end
+
+    File.open(media_dir.join('some_markdown.md'), 'w') do |f|
+      f.write('some markdown file')
+    end
+
+    File.open(media_dir.join('some_image.png'), 'w') {}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler.setup
+
+if RUBY_ENGINE == 'rbx'
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'rom-filesystem'
+
+root = Pathname(__FILE__).dirname
+TMP_PATH = root.join('../tmp')
+TMP_TEST_DIR = TMP_PATH.join('test')
+
+Dir[root.join('shared/*.rb').to_s].each { |f| require f }
+
+RSpec.configure do |config|
+  config.before do
+    FileUtils.rm_r(TMP_TEST_DIR) if File.exist?(TMP_TEST_DIR)
+    FileUtils.mkdir_p(TMP_TEST_DIR)
+
+    @constants = Object.constants
+  end
+
+  config.after do
+    added_constants = Object.constants - @constants
+    added_constants.each { |name| Object.send(:remove_const, name) }
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rom-filesystem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Héctor Ramón
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Filesystem adapter for ROM
+email:
+- hector0193@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rom-filesystem.rb
+- lib/rom/filesystem.rb
+- lib/rom/filesystem/dataset.rb
+- lib/rom/filesystem/gateway.rb
+- lib/rom/filesystem/relation.rb
+- lib/rom/filesystem/version.rb
+- rom-filesystem.gemspec
+- spec/integration/read_spec.rb
+- spec/shared/database_setup.rb
+- spec/shared/media_files.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hecrj/rom-filesystem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Filesystem adapter for ROM
+test_files:
+- spec/integration/read_spec.rb
+- spec/shared/database_setup.rb
+- spec/shared/media_files.rb
+- spec/spec_helper.rb