hanami-db 2.2.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b8f0855774dd7a9d0edc7609c7a07b95080edb38a6d30cab7454c5eb61a3e67
+  data.tar.gz: 1398ac362dcab2ac3f74cc59e328b5264c7326ddd6bec6502e3cd747bdceeedc
+SHA512:
+  metadata.gz: bf77b5817253e28718b84495d45cc6fe1665718c1c008f70577615e1f4c259e39adbfac342112761b30cd699e1b249b88f05b0d839d8955a2201fa645cd84ac0
+  data.tar.gz: b212e3a4b636b0d7bda6a31fad889105a47b9c26a4c094d0a16e1369c41ff01c0fa79a2eefebfa64bce84e3abf5cf6d926d29ec323d5955cc4d0702fcf7a3c5c

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright © 2024 Tim Riley
+
+MIT License
+
+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,52 @@
+# Hanami::DB
+
+The database layer for [full-stack Hanami 2.2 applications](hanami/hanami).
+It's a thin layer on top of [ROM](https://rom-rb.org/) 5.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/hanami-db.svg)](https://badge.fury.io/rb/db)
+[![CI](https://github.com/hanami/db/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/hanami/db/actions?query=workflow%3Aci+branch%3Amain)
+[![Depfu](https://badges.depfu.com/badges/7cd17419fba78b726be1353118fb01de/overview.svg)](https://depfu.com/github/hanami/controller?project=Bundler)
+
+## Contact
+
+* Home page: http://hanamirb.org
+* Community: http://hanamirb.org/community
+* Guides: https://guides.hanamirb.org
+* Mailing List: http://hanamirb.org/mailing-list
+* API Doc: http://rubydoc.info/gems/hanami-db
+* Chat: http://chat.hanamirb.org
+
+
+## Installation
+
+__Hanami::DB__ supports Ruby (MRI) 3.1+
+
+Add this line to your Hanami application's Gemfile:
+
+```ruby
+gem "hanami-db"
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+## Versioning
+
+__Hanami::DB__ uses [Semantic Versioning 2.0.0](http://semver.org)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright © 2024 Hanami Team – Released under MIT License

data/hanami-db.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/hanami/db/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "hanami-db"
+  spec.version = Hanami::DB::VERSION
+  spec.authors = ["Hanami team"]
+  spec.email = ["admin@hanamirb.org"]
+  spec.summary = "The database layer for Hanami apps"
+  spec.homepage = "https://hanamirb.org"
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/hanami/db/issues",
+    "changelog_uri" => "https://github.com/hanami/db/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://guides.hanamirb.org",
+    "funding_uri" => "https://github.com/sponsors/hanami",
+    "source_code_uri" => "https://github.com/hanami/db",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.required_ruby_version = ">= 3.1"
+  spec.add_dependency "rom", "~> 5.3"
+  spec.add_dependency "rom-sql", "~> 3.6", ">= 3.6.4"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data/lib/hanami/db/gem_inflector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Hanami
+  module DB
+    # @api private
+    class GemInflector < Zeitwerk::GemInflector
+      def camelize(basename, _abspath)
+        return "DB" if basename == "db"
+
+        super
+      end
+    end
+  end
+end

data/lib/hanami/db/relation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Hanami
+  module DB
+    # @api public
+    # @since 2.2.0
+    class Relation < ROM::Relation[:sql]
+    end
+  end
+end

data/lib/hanami/db/repo.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Hanami
+  module DB
+    # @api public
+    # @since 2.2.0
+    class Repo < ROM::Repository
+      # @api public
+      # @since 2.2.0
+      def self.[](root)
+        fetch_or_store(root) do
+          # Override ROM::Repository.[] logic to ensure repos with explicit roots inherit from
+          # Hanami::DB::Repo itself, instead of the plain old ROM::Repository::Root.
+          Class.new(self).tap { |klass|
+            klass.root(root)
+          }
+        end
+      end
+
+      # @api public
+      # @since 2.2.0
+      defines :root
+
+      # @api public
+      # @since 2.2.0
+      attr_reader :root
+
+      # @api private
+      def self.inherited(klass)
+        super
+        klass.root(root)
+      end
+
+      # @api public
+      # @since 2.2.0
+      def initialize(*, **)
+        super
+
+        # Repos in Hanami apps infer a root from their class name (e.g. :posts for PostRepo). This
+        # means _every_ repo ends up with an inferred root, many of which will not exist as
+        # relations. To avoid errors from fetching these non-existent relations, check first before
+        # setting the root.
+        @root = set_relation(self.class.root) if set_relation?(self.class.root)
+      end
+
+      private
+
+      def set_relation?(name) # rubocop:disable Naming/AccessorMethodName
+        name && container.relations.key?(name)
+      end
+    end
+  end
+end

data/lib/hanami/db/struct.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Hanami
+  module DB
+    # @api public
+    # @since 2.2.0
+    class Struct < ROM::Struct
+    end
+  end
+end

data/lib/hanami/db/testing.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "uri"
+
+module Hanami
+  module DB
+    module Testing
+      # Replaces development suffix in test mode
+      #
+      # @api private
+      # @since 2.2.0
+      DATABASE_NAME_SUFFIX = "_test"
+
+      # @api private
+      # @since 2.2.0
+      DATABASE_NAME_MATCHER = /_dev(elopment)?$/
+      private_constant :DATABASE_NAME_MATCHER
+
+      class << self
+        # @api private
+        # @since 2.2.0
+        def database_url(url)
+          url = parse_url(url)
+
+          case deconstruct_url(url)
+          in { scheme: "sqlite", opaque: nil, path: } unless path.nil?
+            url.path = database_filename(path)
+          in { path: String => path } if path =~ DATABASE_NAME_MATCHER
+            url.path = path.sub(DATABASE_NAME_MATCHER, DATABASE_NAME_SUFFIX)
+          in { path: String => path } unless path.end_with?(DATABASE_NAME_SUFFIX)
+            url.path << DATABASE_NAME_SUFFIX
+          else
+            # do nothing
+          end
+
+          stringify_url(url)
+        end
+
+        private
+
+        # @api private
+        # @since 2.2.0
+        def parse_url(url)
+          if url.is_a?(URI::Generic)
+            # URI#dup does not duplicate internal instance
+            # variables, making mutation dangerous.
+            URI(stringify_url(url))
+          else
+            URI(url.to_s)
+          end
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+
+        # Work around a bug in Ruby 3.0.x that erroneously omits
+        # the '//' prefix from hierarchical URLs.
+        #
+        # @api private
+        # @since 2.2.0
+        def stringify_url(url)
+          if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1.0")
+            return url.to_s
+          end
+
+          require "stringio"
+
+          buf = StringIO.new
+          buf << url.scheme
+          buf << ":"
+          buf << (url.opaque || "//")
+
+          if url.user || url.password
+            buf << "#{url.user}:#{url.password}@"
+          end
+
+          if url.host
+            buf << url.host
+          end
+
+          if url.port
+            buf << ":"
+            buf << url.port
+          end
+
+          if url.path
+            buf << url.path
+          end
+
+          if url.query
+            buf << "?"
+            buf << url.query
+          end
+
+          if url.fragment
+            buf << "#"
+            buf << url.fragment
+          end
+
+          buf.string
+        end
+
+        # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
+
+        # Deconstructs a URI::Generic for pattern-matching.
+        #
+        # @param url [URI] Database URL parsed as URI::Generic
+        #
+        # @return [Hash]
+        #
+        # @api private
+        # @since 2.2.0
+        def deconstruct_url(url)
+          %i[opaque path scheme].each_with_object({}) do |part, hash|
+            hash[part] = url.public_send(part)
+          end
+        end
+
+        # Transform filename as with URI paths, but account for extname
+        #
+        # @param path [String] path component from URI
+        #
+        # @return [String]
+        #
+        # @api private
+        # @since 2.2.0
+        def database_filename(path)
+          path = Pathname(path)
+          ext = path.extname
+          database = path.basename(ext).to_s
+
+          if database =~ /^dev(elopment)?$/
+            database = "test"
+          elsif database =~ DATABASE_NAME_MATCHER
+            database.sub!(DATABASE_NAME_MATCHER, DATABASE_NAME_SUFFIX)
+          elsif !database.end_with?(DATABASE_NAME_SUFFIX)
+            database << DATABASE_NAME_SUFFIX
+          end
+
+          path.dirname.join(database + ext).to_s
+        end
+      end
+    end
+  end
+end

data/lib/hanami/db/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hanami
+  module DB
+    VERSION = "2.2.0.beta1"
+  end
+end

data/lib/hanami/db.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rom"
+require "rom-sql"
+require "zeitwerk"
+
+module Hanami
+  module DB
+    require_relative "db/gem_inflector"
+
+    # @api private
+    # @since 2.2.0
+    def self.loader
+      @loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+
+        loader.inflector = GemInflector.new("#{root}/hanami/db.rb")
+        loader.tag = "hanami-db"
+        loader.push_dir root
+        loader.ignore(
+          "#{root}/hanami-db.rb",
+          "#{root}/hanami/db/gem_inflector.rb"
+        )
+      end
+    end
+    loader.setup
+  end
+end

data/lib/hanami-db.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "hanami/db"

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: hanami-db
+version: !ruby/object:Gem::Version
+  version: 2.2.0.beta1
+platform: ruby
+authors:
+- Hanami team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: rom-sql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.4
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
+email:
+- admin@hanamirb.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- hanami-db.gemspec
+- lib/hanami-db.rb
+- lib/hanami/db.rb
+- lib/hanami/db/gem_inflector.rb
+- lib/hanami/db/relation.rb
+- lib/hanami/db/repo.rb
+- lib/hanami/db/struct.rb
+- lib/hanami/db/testing.rb
+- lib/hanami/db/version.rb
+homepage: https://hanamirb.org
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/hanami/db/issues
+  changelog_uri: https://github.com/hanami/db/blob/main/CHANGELOG.md
+  documentation_uri: https://guides.hanamirb.org
+  funding_uri: https://github.com/sponsors/hanami
+  source_code_uri: https://github.com/hanami/db
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: The database layer for Hanami apps
+test_files: []