ruby-on-rails - 如何使用条件依赖安装创建 Rails gem

标签 ruby-on-rails ruby rubygems

我正在尝试编写我的第一个 gem,并希望创建一个提供干涸序列化功能的 gem。我目前正在使用一个 gem,并且没有预见到它有任何问题,但我希望能够添加对多个序列化 gem 的支持。我看到的唯一缺点是它需要将它们添加到依赖项列表并将它们安装到使用我正在编写的 gem 的项目中。

有没有一种方法可以使用初始化程序来设置用户可能想要使用的首选 gem,并且只安装那个 gem,而不安装其他 gem?

我现在打算在没有这个功能的情况下编写它,但在未来,我希望通过对多个 gem 的支持使其更加健壮。


我更新了一个安装生成器,它创建了一个初始化程序,其中列出了默认的 gem,以及我认为可以动态添加依赖项的内容。我的测试通过了,我可以在本地捆绑安装,没有任何问题,我的 gem 似乎按预期工作,但是当我尝试推送到 gemfury 时,我现在收到错误消息:

remote: Initializing build: done.        
remote: ----→ Building package...        
remote:        RubyGem build detected        
remote:        Invalid gemspec in [/build/app/my_gem.gemspec]: cannot load such file -- blueprinter        
remote:        ERROR:  Error loading gemspec. Aborting.

在我的 gemspec 中

spec.add_dependency MyGem.configuration.serializer || 'blueprinter'

这是与当前配置尝试相关的代码:

# lib/my_gem

require "my_gem/version"
require 'my_gem/configuration'
require "my_gem/blueprinter"

module MyGem

  class << self
    attr_accessor :configuration
  end

  def self.configuration(&block)
    @configuration ||= Configuration.new
  end

  def self.configure
    yield(configuration)
  end
end

# lib/my_gem/configuration

module MyGem
  class Configuration
    attr_accessor :serializer

    def initialize
      @serializer = nil
    end
  end
end

最佳答案

我现在无法真正理解依赖注入(inject)。所以我尝试采用@engineersmky 的建议并为 gems 创建了一个安装。所以现在我把它作为我的安装生成器

require 'generators/base_generator'

module MyGem
  module Blueprinter
    class InstallGenerator < BaseGenerator
      source_root File.expand_path("../../../templates", __FILE__)

      # Add blueprinter gem to gemfile after my_gem declaration and bundles the newly declared gem
      def install_blueprinter
        remove_other_supported_gems('ActiveModelSerializers', 'FastJsonapi')
        puts 'Installing Blueprinter...'
        insert_into_file('Gemfile',
                         "\ngem 'blueprinter'",
                         after: "gem 'dry_serialization', source: 'https://gem.fury.io/my_private_gems/'")
        run 'bundle install'
      end


      def helper_include
        copy_api_controller
        gsub_file(API_CONTROLLER_PATH, /^\t*(include MyGem::.*)\n/, '')
        puts 'Adding include statement to ApiController'
        insert_into_file(API_CONTROLLER_PATH,
                         "\n\tinclude MyGem::Blueprinter",
                         after: 'class ApiController < ActionController::API'
        )
      end

    end
  end
end

使用 rails g my_gem::blueprinter::install 调用 这将创建一个从 ActionController::Base 继承的 ApiController,除非它已经存在,在 my_gem 声明之后将 gem 'blueprinter' 插入到 gemfile 中,删除对其他序列化器 gem 的引用,然后捆绑以安装 gem。

如果我决定使用整体式应用程序,我喜欢将我的 Controller 分成 api 和应用程序以分离关注点 :D

然后您可以使用我在每个文件中为每个相应的 gem 创建的枯燥方法 :D

关于ruby-on-rails - 如何使用条件依赖安装创建 Rails gem,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/60377785/

相关文章:

ruby-on-rails - 嵌入式表单更新上的ActiveSupport::HashWithIndifferentAccess

ruby - 在两个 ActiveRecord 类之间合并/复制属性的好方法?

ruby - 在任何来源中都找不到 public_suffix-2.0.4

ruby-on-rails - Ruby JSON.pretty_generate ... 很不漂亮

error-handling - 无法使用JRuby运行单元测试,没有要加载的此类文件-rubygems

ruby-on-rails - 从多个数组项返回字符串

ruby-on-rails - 如何为所有 Ember.js 路由指定 URL 'prefix'?

ruby-on-rails - 使用 ActiveRecord 与数据仓库风格的表对话?

ruby-on-rails - 未知验证器 : 'InValidator' on Ruby on Rails

ruby - 简单的单行将行与常见的第一个字段合并