Eiji

Eiji

How about add optional dependencies?

defmodule MyApp.MixFile do
  use Mix.Project

  def project do
    [
      app: :my_app,
      version: "0.1.0",
      elixir: "~> 1.4",
      elixirc_paths: elixirc_paths(Mix.env),
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
      aliases: aliases(),
      deps: deps(),
      optional_deps: optional_deps(),
    ]
  end

  # ...
end

and example code:

defmodule MyApp.Things.Special do
  @behavior MyApp.Thing
  # don't compile this module if we don't have an optional library
  @module_depends_on: :optional_library

  def example(), do: OptionalLibrary.example()

  # or:

  # don't compile this method if we don't have an another optional library
  @depends_on: :another_optional_library
  def something(), do: AnotherOptionalLibrary.something()
end

mix deps.get should ask if we want an optional dependency in our setup.

Here I think like Gentoo user. In this source based distribution we can choose USE flags so we can compile package for example: with sound support and without bluetooth support. Of course it’s only simple example that probably should be more explained and discussed.

What do you think about my idea? Maybe instead of choosing packages we should choose something like USE flags, so we could provide easy pre-setup for deployment administrators?

Showing Posts 1 to 2

josevalim

josevalim

Creator of Elixir

We already support optional dependencies by specifying optional: true in your dependencies and then you can use something like if Code.ensure_loaded?(ModuleInADep) to check if a dependency is available or not.

Eiji

Eiji OP

@josevalim: Thanks for response. I see that I was not clear …

I found Mix.Tasks.Deps docs for it:

:optional - marks the dependency as optional. In such cases, the current project will always include the optional dependency but any other project that depends on the current project won’t be forced to use the optional dependency. However, if the other project includes the optional dependency on its own, the requirements and options specified here will also be applied.
It’s good for libraries, so primary project decides if dependency is required or not - that’s ok, but it’s not what I was looking for.

First of all my example is primary project - not 3rd party library - it’s ready (only example case) app to deploy.
Now we have based linux admin that got task to install our project and configure it. He needs to know what exactly packages provide features that he needs- I think it’s not clear for non-elixir administrators. We already know for what are floki, flow and other projects, but not everyone needs to know them.

Let me give another more complex example:

defmodule Example.Mixfile do
  use Mix.Project

  def application(), do: [extra_applications: [:logger]]

  def project do
    [
      app: :example,
      build_embedded: Mix.env == :prod,
      deploy_deps: deploy_deps(),
      deps: [],
      elixir: "~> 1.4.0",
      start_permanent: Mix.env == :prod,
      version: "0.1.0",
    ]
  end

  defp deploy_deps do
    [
      {
        # Simple groups descritpion like:
        :audio, [
          # optional package list for support audio
        ]
      }
    }
  end
end

and fetching dependencies:

mix deps.get
Running dependency resolution...

Getting required dependencies:
* Getting first_required_dependency (Hex package)
  Checking package (https://repo.hex.pm/tarballs/flow-0.11.0.tar)
  Fetched package

Would you like to add: "audio" support? [Y/n] Y
* Getting first_optional_audio_dependency (Hex package)
  Checking package (https://repo.hex.pm/tarballs/flow-0.11.0.tar)
  Fetched package
* Getting first_optional_audio_dependency (Hex package)
  Checking package (https://repo.hex.pm/tarballs/flow-0.11.0.tar)
  Fetched package

Would you like to add: "..." support? [Y/n] n
* Package first_optional_..._dependency (Hex package) is skipped.

Secondly, see comparison of if and module attribute:

if Code.ensure_loaded?(ModuleInADep) do
  defmodule ModuleName do
    # ...
  end
end

defmodule ModuleName do
  if Code.ensure_loaded?(ModuleInADep) do
    def method_a_name(), do: ModuleInADep.method_name()
  end
  
  if Code.ensure_loaded?(ModuleInBDep) do
    def method_b_name(), do: ModuleInBDep.method_name()
  end
end

# compare to:

defmodule ModuleName do
  # for example: where Experimental.Flow is declared?
  # I think that package name is much more cleaner here.
  @module_depends_on :package_name
  # ...
end

defmodule ModuleName do
  @depends_on: :optional_library_a
  def method_a_name(), do: ModuleInADep.method_name()
  
  @depends_on: :optional_library_b
  def method_b_name(), do: ModuleInBDep.method_name()
end

What do you think about it?

— All posts loaded —

Where Next? Top

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 91898 914
New
AstonJ
The obligatory hello world thread! Who are you and where are you from? :stuck_out_tongue:
4616 55835 594
New
byu
@chrismccord : I just saw the Extract AGENTS.md from Phoenix.new into phx.new generator commit to the phoenix project. My initial shotgu...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
alexslade
Fly’s CEO posted this recently - Turn And Face The Strange · The Fly Blog It says that Fly is going all-in on sprites, which is a worry ...
New
Herve37
We’re evaluating API mocking tools for OpenAPI-based projects and would love to hear what other teams are using. We’re particularly inte...
New
matt-savvy
Is there a word for the ~> symbol used in Version strings? Do you also just call it a Squiggle Arrow™ ?!
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews