carbonado 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 795cebdd782fccc4baacb9f6c5a38fe9fa8d3a99ff2766ca3dbf9886b676470f
+  data.tar.gz: 9ac37a84679b99246396b3190da3a1f64de46f939e03313d3d80c58b97db8115
+SHA512:
+  metadata.gz: 995630e05da5622d5d564daf8c90df351379052cb3611522ec3de1e18516a16ed3f5eab4406d48decd16ac08fb20a8e691a8f744350aeaf18e65e9775f631d33
+  data.tar.gz: 598faac8202293ac03a8cb5272b1663601407a51a6e993c38450c0b19e566701196777f0d32f9dee16fa121073e3903140c8241dae2c846f969bcf1e220d2e6b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at owen.m@bccriskadvisory.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in runtime_gem_activator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Owen Mooney
+
+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,73 @@
+# Carbonado
+
+Carbonado is a gem that allows you to require installed gems, even if they are not specified in your Gemfile. This means that you can optionally include other gems if they are already installed, even if your gem just provides an executable. 
+
+Carbonado is named after an impure form of diamond, as it is an impure way to load gems at runtime. [wiki](https://en.wikipedia.org/wiki/Carbonado)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carbonado'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install runtime_gem_activator
+
+## Usage
+
+You can either include the `Carbonado` module, or alternatively call the methods directly on the module. There are two methods you can use, `activate_gem` and `stub_gem_method`. The `activate_gem` method is used to activate a locally installed gem. You can also provide a version requirement. This will raise a `Carbonado::Error` if it fails to activate the gem. Once the gem is activated, you can `require` it as normal.
+
+    # Module method
+    Carbonado.activate_gem("nokogiri", "~> 1.6.0")
+
+    # Include the module
+    class MyClass
+      include Carbonado
+      def activate_optional_component
+        begin
+          activate_gem("activerecord", "> 1.0.0")
+          require("active_record")
+          puts "ActiveRecord module initialized successfully"
+        rescue Carbonado::Error, Gem::LoadError
+          puts "Can't activate ActiveRecord module"
+        end
+      end
+    end
+
+The `stub_gem_method` method overrides the `Kernel#gem` method to be a no-op. This is useful when a gem uses the `Kernel#gem` method to activate a gem at runtime. This works fine if the gem is installed using Bundler, but if you are activating it with Carbonado, then this will fail. The only common use case for this is if you are using ActiveRecord, and are manually activating one of the SQL gems at runtime using Carbonado. For example:
+
+    Carbonado.activate_gem("sqlite3", "~> 0.1.14")
+    # This will fail
+    ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "foo.sqlite")
+
+    # Use stub_gem_method to make Kernel#gem a no-op
+    Carbonado.stub_gem_method do
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "foo.sqlite")
+    end
+
+This does mean that you will need to take responsibility for ensuring version compatibility between the SQL gem and ActiveRecord.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/slicedpan/carbonado. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RuntimeGemActivator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/slicedpan/carbonado/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carbonado"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/carbonado.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "carbonado/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "carbonado"
+  spec.version       = Carbonado::VERSION
+  spec.authors       = ["Owen Mooney"]
+  spec.email         = ["omooney@tcd.ie"]
+
+  spec.summary       = %q{Activate installed gems at runtime}
+  spec.description   = "Activate installed gems at runtime. "\
+                       "This means that gems can optionally use other installed gems at runtime."
+  spec.homepage      = "https://github.com/slicedpan/carbonado.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/slicedpan/carbonado"
+    spec.metadata["changelog_uri"] = "https://github.com/slicedpan/carbonado/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+end

data/lib/carbonado.rb

@@ -0,0 +1,77 @@
+require "carbonado/version"
+
+module Carbonado
+  class Error < StandardError; end
+  
+  # Activate the named gem. Specify a version requirement as a string or a Gem::Requirement
+  # object. This will also recursively activate the dependencies of the gem. It can fail if a gem
+  # has a dependency that is already activated which doesn't satisfy the requirements of the given
+  # gem or one of its dependencies. Otherwise it can fail if the given gem or one of its 
+  # dependencies is not installed
+  def activate_gem(gem_name, version = nil, requirer = nil)
+    version_requirement = version.is_a?(Gem::Requirement) ? version : Gem::Requirement.default
+    loaded_gem = Gem::Specification.stubs.select{ |s| s.name == gem_name }.first
+    if !loaded_gem.nil?
+      return true if Gem::Requirement.new(version_requirement).satisfied_by?(loaded_gem.version)      
+
+      error_msg = "There is alread an activated version of #{gem_name}"
+      error_msg += ", required by #{requirer}" if requirer
+      error_msg += ", that does not meet the version requirement #{version_requirement}"
+      raise Error, error_msg
+    end
+    installed_versions = installed_stubs.select{ |s| s.name == gem_name }.sort_by(&:version)
+    raise Error, "Could not find #{gem_name} in list of installed gems" if installed_versions.empty?
+    allowed_versions = installed_versions.select do |s|
+      Gem::Requirement.new(version_requirement).satisfied_by?(s.version)
+    end
+
+    selected_spec = allowed_versions.last.to_spec
+    selected_spec.dependencies.select(&:runtime?).each{ |dep| activate_gem(dep.name) }    
+    selected_spec.activate
+  end
+
+  # This method stubs the Kernel#gem method to make it a noop for the code executed in the yielded 
+  # block. This method is useful if there is a gem that uses the Kernel#gem method to activate a
+  # gem from the bundle that you have already activated using the activate_gem method above. One
+  # example is the ActiveRecord::Base.establish_connection method. Depending on the adapter, this
+  # will try to activate the appropriate gem using the 'gem' method, which will fail because our
+  # approach doesn't alter the bundle. I guess this is a TODO, since it may be possible to update
+  # the bundle so that the gem method will succeed which would be a better solution.
+  def stub_gem_method
+    Kernel.define_method :fake_gem do |*args|
+    end
+
+    Kernel.alias_method :real_gem, :gem
+    Kernel.alias_method :gem, :fake_gem
+
+    yield
+
+    Kernel.alias_method :gem, :real_gem
+  end
+
+  private
+
+  # This is a copy of the implementation of Gem::Specification.installed_stubs, however that
+  # method is private, so it may change in subsequent versions of rubygems. Therefore we'll
+  # implement it here just in case.
+  def installed_stubs
+    map_stubs(Gem::Specification.dirs, "*.gemspec") do |path, base_dir, gems_dir|
+      Gem::StubSpecification.gemspec_stub(path, base_dir, gems_dir)
+    end
+  end
+
+  def gemspec_stubs_in(dir, pattern)
+    Gem::Util.glob_files_in_dir(pattern, dir).map { |path| yield path }.select(&:valid?)
+  end
+
+  def map_stubs(dirs, pattern) # :nodoc:
+    dirs.flat_map do |dir|
+      base_dir = File.dirname dir
+      gems_dir = File.join base_dir, "gems"
+      gemspec_stubs_in(dir, pattern) { |path| yield path, base_dir, gems_dir }
+    end
+  end
+
+  # Also add these as class methods
+  extend self
+end

data/lib/carbonado/version.rb

@@ -0,0 +1,3 @@
+module Carbonado
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: carbonado
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Mooney
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-17 00:00:00.000000000 Z
+dependencies: []
+description: Activate installed gems at runtime. This means that gems can optionally
+  use other installed gems at runtime.
+email:
+- omooney@tcd.ie
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- carbonado.gemspec
+- lib/carbonado.rb
+- lib/carbonado/version.rb
+homepage: https://github.com/slicedpan/carbonado.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/slicedpan/carbonado.git
+  source_code_uri: https://github.com/slicedpan/carbonado
+  changelog_uri: https://github.com/slicedpan/carbonado/CHANGELOG.md
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Activate installed gems at runtime
+test_files: []