rom-files 0.2.0

data/lib/rom/files/extensions/text/attributes_inferrer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../markup/attributes_inferrer'
+
+module ROM
+  module Files
+    module Extensions
+      module Text
+        class AttributesInferrer < Markup::AttributesInferrer
+          # @return [Dry::Types::Definition]
+          def markup_type
+            Types::String
+          end
+        end
+      end
+    end
+
+    Schema::AttributesInferrer.register 'text/plain', Extensions::Text::AttributesInferrer.new.freeze
+  end
+end

data/lib/rom/files/gateway.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'connection'
+require_relative 'extensions'
+
+module ROM
+  module Files
+    # Files gateway interface
+    #
+    # @example
+    #   gateway = ROM::Files::Gateway.new('.')
+    #   gateway.dataset(:lib)
+    #   gateway[:lib].insert(name: 'rom.rb')
+    #
+    # @api public
+    class Gateway < ROM::Gateway
+      extend Forwardable
+
+      adapter :files
+
+      # @!attribute [r] connection
+      #   @return [Connection]
+
+      # @param root [Pathname, #to_s]
+      # @param extensions [Array<Symbol>, Symbol]
+      def initialize(root = Pathname.pwd, extensions: [])
+        @connection = Connection.new(root)
+        Files.load_extensions(*Array(extensions))
+      end
+
+      # @return [Object] default logger
+      #
+      # @api public
+      attr_reader :logger
+
+      # Set default logger for the gateway
+      #
+      # @param logger [Logger] object
+      #
+      # @api public
+      def use_logger(logger)
+        @logger = logger
+      end
+
+      # @param name [Pathname, #to_s]
+      # @return [Dataset]
+      def dataset(name)
+        self[name] || connection.create_dataset(name)
+      end
+
+      # @!method []
+      #   @param (see Connection#[])
+      #   @return (see Connection#[])
+      def_instance_delegators :connection, :[]
+
+      # @!method dataset?
+      #   @param (see Connection#key?)
+      #   @return (see Connection#key?)
+      def_instance_delegator :connection, :key?, :dataset?
+    end
+  end
+end

data/lib/rom/files/plugins/configuration/gem.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rom/files/extensions'
+
+module ROM
+  module Files
+    module Plugins
+      module Configuration
+        module Gem
+          # Provide methods for registering files relations with common gem setup
+          #
+          # @param configuration [ROM::Configuration]
+          # @param relations [Boolean]
+          # @return [ROM::Configuration]
+          def self.apply(configuration, relations: true, **options)
+            configuration.extend Methods
+            configuration.register_gem_relations(**options) if relations
+          end
+
+          module Methods
+            def register_gem_relations(**options)
+              Files.load_extensions(:gem)
+              Files::Extensions::Gem.register_extension(self, **options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/files/plugins/relation/instrumentation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rom/plugins/relation/instrumentation'
+
+module ROM
+  module Files
+    module Plugins
+      module Relation
+        # @api private
+        module Instrumentation
+          def self.included(klass)
+            super
+
+            klass.class_eval do
+              include ROM::Plugins::Relation::Instrumentation
+
+              # @api private
+              # @param [ROM::Files::Relation] relation
+              def notification_payload(relation)
+                super.merge(**relation.dataset.options)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/files/plugins/schema/contents.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rom/files/constants'
+require 'rom/files/types'
+
+module ROM
+  module Files
+    module Plugins
+      module Schema
+        # A plugin for automatically adding contents of file
+        # to the schema definition
+        #
+        # @example Generic `DATA` field with String type
+        #   schema do
+        #     use :contents
+        #   end
+        #
+        # @example Specify another type
+        #   schema do
+        #     use :contents, type: Types::YAML
+        #   end
+        #
+        # @example Specify another name
+        #   # using other types
+        #   schema do
+        #     use :contents, name: :contents
+        #   end
+        #
+        # @api public
+        module Contents
+          NAME = Files::DATA
+          TYPE = Types::String
+
+          # @api private
+          def self.apply(schema, name: NAME, type: TYPE)
+            contents = type.meta(name: name, source: schema.name, DATA: true)
+
+            schema.attributes.concat(
+              schema.class.attributes([contents], schema.attr_class)
+            )
+          end
+
+          # @api private
+          module DSL
+            # Sets non-default contents attribute
+            #
+            # @example Set custom attribute name
+            #   schema do
+            #     use :contents
+            #     contents :contents
+            #   end
+            #
+            # @example Set custom type
+            #   schema do
+            #     use :contents
+            #     contents type: Types::JSON
+            #   end
+            #
+            # @api public
+            def contents(name = NAME, inline_type = TYPE, type: inline_type)
+              options = plugin_options(:contents)
+              options[:name] = name
+              options[:type] = type
+
+              self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/files/plugins/schema/mime.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rom/files/constants'
+require 'rom/files/types'
+require 'mime/types/full'
+
+module ROM
+  module Files
+    module Plugins
+      module Schema
+        # A plugin for obtaining MIME-type of file using its name
+        #
+        # @example Generic `mime_type` field
+        #   schema do
+        #     use :mime_type
+        #   end
+        #
+        # @api public
+        module Mime
+          PROC = ->(path) { MIME::Types.type_for(path.basename.to_s).first }
+          TYPE = Types::MimeType.optional
+
+          # @api private
+          def self.apply(schema, name: :mime_type, type: TYPE)
+            mime_type = type.meta(
+              name: name,
+              __proc__: PROC,
+              source: schema.name
+            )
+
+            schema.attributes.concat(
+              schema.class.attributes([mime_type], schema.attr_class)
+            )
+          end
+
+          # @api private
+          module DSL
+            # Sets non-default contents attribute
+            #
+            # @example Set custom attribute name `#type` for MIME-type
+            #   schema do
+            #     use :mime
+            #     mime :type
+            #   end
+            #
+            # @api public
+            def mime(name = :mime_type, inline_type = TYPE, type: inline_type)
+              options = plugin_options(:mime)
+              options[:name] = name
+              options[:type] = type
+
+              self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/files/plugins/schema/shebang.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'rom/files/constants'
+require 'rom/files/types'
+
+module ROM
+  module Files
+    module Plugins
+      module Schema
+        # A plugin for automatically adding shebang of file
+        # to the schema definition
+        #
+        # @example Generic `DATA` field with String type
+        #   schema do
+        #     use :shebang
+        #   end
+        #
+        # @example Specify another type
+        #   schema do
+        #     use :shebang, type: Types::YAML
+        #   end
+        #
+        # @example Specify another name
+        #   # using other types
+        #   schema do
+        #     use :shebang, name: :shebang
+        #   end
+        #
+        # @api public
+        module Shebang
+          TYPE = Types::String
+          NAME = :run_with
+
+          # @param path [Pathname]
+          # @return [String, nil]
+          def self.read_shebang(path)
+            shebang = path.readlines.first || ''
+            shebang[2..-1].chomp if shebang.match?(/\A#!/)
+          end
+
+          # @api private
+          def self.apply(schema, name: NAME, type: TYPE)
+            shebang = type.meta(name: name, source: schema.name, __proc__: method(:read_shebang))
+
+            schema.attributes.concat(
+              schema.class.attributes([shebang], schema.attr_class)
+            )
+          end
+
+          # @api private
+          module DSL
+            # Sets non-default shebang attribute
+            #
+            # @example Set custom attribute name
+            #   schema do
+            #     use :shebang
+            #     shebang :shebang
+            #   end
+            #
+            # @example Set custom type
+            #   schema do
+            #     use :shebang
+            #     shebang type: Types::JSON
+            #   end
+            #
+            # @api public
+            def shebang(name = NAME, inline = TYPE, type: inline)
+              options = plugin_options(:shebang)
+              options[:name] = name
+              options[:type] = type
+
+              self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/files/plugins/schema/stat.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'rom/files/types'
+
+module ROM
+  module Files
+    module Plugins
+      module Schema
+        # A plugin for automatically adding stat properties of file
+        # to the schema definition
+        #
+        # @example Generic `__stat__` field with String type
+        #   schema do
+        #     use :stat
+        #   end
+        #
+        # @example Specify another set of properties
+        #   schema do
+        #     use :stat, properties: %i[]
+        #   end
+        #
+        # @api public
+        module Stat
+          NAME = :stat
+
+          TYPES = {
+            atime: Types::Time,
+            basename: Types::String,
+            birthtime: Types::Time,
+            blksize: Types::Int.optional,
+            blocks: Types::Int.optional,
+            ctime: Types::Time,
+            dev: Types::Int,
+            dev_major: Types::Int,
+            dev_minor: Types::Int,
+            ftype: Types::FileType,
+            gid: Types::Int,
+            ino: Types::Int,
+            mode: Types::Int,
+            mtime: Types::Time,
+            nlink: Types::Int,
+            rdev: Types::Int,
+            rdev_major: Types::Int,
+            rdev_minor: Types::Int,
+            size: Types::Int,
+            uid: Types::Int
+          }.freeze
+
+          ALIASES = {
+            accessed_at: :atime,
+            changed_at: :ctime,
+            updated_at: :mtime,
+            created_at: :birthtime,
+            type: :ftype
+          }.freeze
+
+          class << self
+            # @api private
+            def apply(schema, name: NAME, stats: EMPTY_ARRAY, aliases: EMPTY_HASH)
+              attributes = []
+              attributes = [build_property(schema, name, type: Types::FileStat)] if name
+              attributes += stats.map { |stat| build_property(schema, stat) }
+              attributes += aliases.map do |as, stat|
+                build_property(schema, as, stat: stat)
+              end
+
+              schema.attributes.concat(
+                schema.class.attributes(attributes, schema.attr_class)
+              )
+            end
+
+            private
+
+            def build_property(schema, name, stat: ALIASES[name] || name, type: TYPES[stat])
+              raise ArgumentError, "Unknown property #{(stat || name).inspect}" unless type
+              type.meta(name: name, source: schema.name, __stat__: (stat == NAME) || stat)
+            end
+          end
+
+          # @api private
+          module DSL
+            # @example Sets non-default list of stat properties
+            #   schema do
+            #     use :stat
+            #     stat :basename
+            #   end
+            #
+            # @example Sets list of aliased properties
+            #   schema do
+            #     use :stat
+            #     stat aliased: { created_at: :ctime }
+            #   end
+            #
+            # @api public
+            def stat(name = NAME, stats: EMPTY_ARRAY, aliases: EMPTY_HASH)
+              options = plugin_options(:stat)
+              options[:name] = name
+              options[:stats] = stats
+              options[:aliases] = aliases
+
+              self
+            end
+          end
+        end
+      end
+    end
+  end
+end