stibium-bundled 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 872a10da7e3924dd1b8dca69f57bcbd7f31ab6b82097b3cd45ddfaf4ff8e0aa9
+  data.tar.gz: 97e4ccd6cd8211e1e4ad9d8ab63feec5294168b8971187ad44d6d80ee78c957b
+SHA512:
+  metadata.gz: 1c253d6972da289b0ef2c78826e3d4b88d17fd19370afe47938c1cc44d6c79fd47a22f05312ade86318059e6d97c8a85937c9ed2b7817d4156ca63a4ff757479
+  data.tar.gz: 38c53b363286e39f45360d12717e9c5dd262906b770b04759e8ab7231b283175484fe674ae8d89db3a31b4cb83fe41c07bb179a5d507871312e2ebed4e5e5e8d

data/.yardopts

@@ -0,0 +1,16 @@
+# vim: ft=sh
+
+lib/**/*.rb                                   \
+    --no-progress                             \
+    --markup-provider 'redcarpet'             \
+    --markup 'markdown'                       \
+    --charset 'utf-8'                         \
+    --protected --private --embed-mixins      \
+    --tag type:'type' --hide-tag 'type'       \
+    --readme README.md                        \
+    --exclude '_flymake\\.rb$'                \
+    --exclude '/\\.#'
+
+# Local Variables:
+# mode: sh
+# End:

data/lib/stibium-bundled.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+$LOAD_PATH.unshift(__dir__)

data/lib/stibium/bundled.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+unless Object.const_defined?(:Stibium)
+  # Namespace
+  module Stibium
+  end
+end
+
+# Sample of use:
+#
+# ```ruby
+# # file: lib/awesome_gem.rb
+# module AwesomeGem
+#   Stibium::Bundled.call(self, basedir: "#{__dir__}/..")
+#
+#   bundled&.tap do |bundle|
+#     unless bundle.standalone!
+#         require 'bundler/setup' if bundle.locked?
+#     end
+#   end
+# end
+# ```
+#
+# or:
+#
+# ```ruby
+# # file: lib/awesome_gem.rb
+# module AwesomeGem
+#   class << self
+#     include(Stibium::Bundled)
+#   end
+#
+#   self.bundled_from("#{__dir__}/..") do |bundle|
+#     unless bundle.standalone!
+#       require 'bundler/setup' if bundle.locked?
+#     end
+#   end
+# end
+module Stibium::Bundled
+  {
+    Bundle: 'bundle',
+    VERSION: 'version',
+  }.each { |k, v| autoload(k, "#{__dir__}/bundled/#{v}") }
+
+  # @!method bundled?
+  #   Denote bundle is locked or standalone.
+  #   @return [Boolean]
+
+  # @!method bundled
+  #   @return [Bundle, nil]
+
+  # @param [String, Pathname] basedir
+  #
+  # @return [Bundle. nil]
+  def bundled_from(basedir)
+    Stibium::Bundled
+      .call(self, basedir: basedir)
+      .bundled
+      .tap { |bundle| yield(bundle) if block_given? and bundle }
+  end
+
+  class << self
+    # @param target [Class, Module]
+    # @param basedir [String, Pathname]
+    #
+    # @return [Class, Module]
+    def call(target, basedir:)
+      target.tap do |t|
+        t.singleton_class.tap do |sc|
+          sc.singleton_class.__send__(:include, self)
+          sc.define_method(:bundled?) { !bundled?.nil? }
+          sc.define_method(:bundled) do
+            # @type [Bundle] bundle
+            # rubocop:disable Style/TernaryParentheses
+            Bundle.new(basedir).yield_self { |bundle| (bundle.locked? or bundle.standalone?) ? bundle : nil }
+            # rubocop:enable Style/TernaryParentheses
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stibium/bundled/bundle.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../bundled'
+
+# Describe a bundle.
+class Stibium::Bundled::Bundle
+  autoload(:Pathname, 'pathname')
+
+  # @return [Pathname]
+  attr_reader :path
+
+  # @param path [String, Pathname]
+  #
+  # @raise [Errno::ENOENT]
+  # @raise [ArgumentError] when given ``path`` is not a directory.
+  def initialize(path)
+    self.tap do
+      @path = Pathname.new(path).realpath.freeze
+
+      raise ArgumentError, 'path is not a directory' unless self.path.directory?
+    end.freeze
+  end
+
+  # @return [String]
+  def to_path
+    path.to_path
+  end
+
+  # Denote lockfile (``gems.locked`` or ``Gemfile.lock``) is present.
+  #
+  # @see #gemfiles
+  #
+  # @return [Boolean]
+  def locked?
+    !!gemfiles[1]
+  end
+
+  # Get path to gemfile.
+  #
+  # @see #gemfiles
+  #
+  # @return [Pathname, nil]
+  def gemfile
+    gemfiles[0]
+  end
+
+  # Get gemfile files (gemfile + lockfile) or nothing.
+  #
+  # @note Files are returned in pairs, gemfile and its lockfile. As a result a missing file provides empty result.
+  #
+  # @return [Array<Pathname>, nil]
+  def gemfiles
+    [%w[gems.rb gems.locked], %w[Gemfile Gemfile.lock]].map do |m|
+      m.map { |fname| path.join(fname) }.keep_if(&:file?)
+    end.reject(&:empty?).reject { |r| r.size < 2 }.first
+  end
+
+  # Denote bundle seems to be installed as a standalone.
+  #
+  # @see https://bundler.io/man/bundle-install.1.html
+  #
+  # @return [Boolean]
+  def standalone?
+    standalone_setupfile.file?
+  end
+
+  # Load standalone setup if present
+  #
+  # @return [Boolean]
+  def standalone!
+    # noinspection RubyResolve
+    standalone?.tap { |b| require standalone_setupfile if b }
+  end
+
+  protected
+
+  # @see #standalone?
+  #
+  # @return [Pathname]
+  def standalone_setupfile
+    path.join('bundle', 'bundler', 'setup.rb')
+  end
+end

data/lib/stibium/bundled/version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../bundled'
+require 'kamaze/version'
+
+module Stibium::Bundled
+  # Version
+  #
+  # @type [Kamaze::Version]
+  VERSION = Kamaze::Version.new.freeze
+end

data/lib/stibium/bundled/version.yml

@@ -0,0 +1,17 @@
+---
+major: 0
+minor: 0
+patch: 1
+authors: ['Dimitri Arrigoni']
+email: 'dimitri@arrigoni.me'
+date: '2021-01-11'
+summary: 'Denote bundle state'
+description: 'Denote bundle state, based on conventions.'
+homepage: 'https://github.com/SwagDevOps/stibium-bundled'
+licenses: ['GPL-3.0']
+license_header: |
+  Copyright (C) 2020-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+  License GPLv3+: GNU GPL version 3 or later
+  <http://www.gnu.org/licenses/gpl.html>.
+  This is free software: you are free to change and redistribute it.
+  There is NO WARRANTY, to the extent permitted by law.

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: stibium-bundled
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dimitri Arrigoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kamaze-version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Denote bundle state, based on conventions.
+email: dimitri@arrigoni.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- lib/stibium-bundled.rb
+- lib/stibium/bundled.rb
+- lib/stibium/bundled/bundle.rb
+- lib/stibium/bundled/version.rb
+- lib/stibium/bundled/version.yml
+homepage: https://github.com/SwagDevOps/stibium-bundled
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Denote bundle state
+test_files: []