ddenv 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d454d9e8eba496ccf1c073109663cd75eb360317650505ba195f46e35df21330
-  data.tar.gz: ed0c07ba499cdb8ebbfdb0c24d4d57c64902eb4e5ec50599bed07c97961b1dff
+  metadata.gz: be59b284b001642fbf169fb71a0c6887b2a54c4747ef52c0cc695b6b6621f7eb
+  data.tar.gz: b140aa2607964e48d50555420db3d038cc1e9306ce46147e5657e97c4f2c06bd
 SHA512:
-  metadata.gz: bd6afc63047346551aee1dbea9d9b29895e3f355dbbdfb3638fea312aa05daa658af804b282b6f9ac36d7d0b6b95849162bbbbec881dcd07e863c141aba33d91
-  data.tar.gz: 3302364fce3c5cfee447a1cffecbf2ed5f691f1821e2b9db8a0a38ae362800cec2b8e0df7dc9f4bae28234ec2ee39c1eaa29f842cc2a7fd473ab09ee60f93584
+  metadata.gz: e59e6c7ef5f3e64ccd0962475e0137912009188b2cff521d39dc4bfacfb8645542ae432299aeefda5af817dfdb4b8999cc75186af8ef66ea79b8c15d947ac4f6
+  data.tar.gz: cdcffc2846efe163d628f6ac677533e12cd8501783d72fb8ee6f5f09cb2bd37d166ca7b37628a4b2d6321762b5f902533668ca137134458506135305710d2f36

data/.rubocop.yml

@@ -14,3 +14,9 @@ Style/Documentation:
 
 Metrics:
   Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-04-29
+
+- Fix unknown `Pathname` constant
+- Add `bundle`, `node` and `npm` goals
+
+## [0.1.1] - 2024-04-29
+
+- Add functioning `ddenv.yaml` with support for `homebrew` and `ruby` goals.
+
 ## [0.1.0] - 2024-04-28
 
 - Initial release

data/README.md

@@ -1,39 +1,62 @@
-# Ddenv
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ddenv`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/[USERNAME]/ddenv. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ddenv/blob/main/CODE_OF_CONDUCT.md).
-
-## 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 Ddenv project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ddenv/blob/main/CODE_OF_CONDUCT.md).
+# ddenv
+
+**ddenv** (*Denis’ Developer Environment*) is a tool for maintaining a local
+environment for development.
+
+> [!CAUTION]
+> This software is a pre-alpha work in progress. Do not use just yet.
+
+## Requirements
+
+- Homebrew
+- fish shell
+
+> [!NOTE]
+> In the future, this will work for bash and zsh as well.
+
+## Quick start
+
+Install it: `brew install denisdefreyne/ddenv/ddenv`.
+
+Next, create a `ddenv.yaml` file which contains the list of dependencies to manage:
+
+```yaml
+up:
+  - homebrew: overmind
+  - ruby: 3.3.0
+  - bundle
+  - node: 20.12.2
+  - npm
+```
+
+Lastly, run `ddenv up`.
+
+```
+% ddenv up
+[✔] Installing Homebrew package overmind       done (previously achieved)
+[✔] Installing Homebrew package ruby-install   done (previously achieved)
+[✔] Installing Ruby v3.3.0                     done (previously achieved)
+[✔] Initializing Shadowenv                     done (previously achieved)
+[✔] Creating .shadowenv.d                      done (previously achieved)
+[✔] Adding .shadowenv.d to .gitignore          done (previously achieved)
+[✔] Trusting .shadowenv.d                      done (previously achieved)
+[✔] Adding Ruby to shadowenv                   done (previously achieved)
+[✔] Installing Ruby gem bundler                done (previously achieved)
+[✔] Installing bundle                          done (previously achieved)
+[✔] Installing Homebrew package node-build     done (previously achieved)
+[✔] Installing Node v20.12.2                   done (previously achieved)
+[✔] Adding Node to shadowenv                   done (previously achieved)
+[✔] Installing npm packages                    done (previously achieved)
+%
+```
+
+Now your local developer environment is ready to be used.
+
+## Goals
+
+- <code>homebrew: <var>PACKAGENAME</var></code> installs the Homebrew package with the given name.
+- <code>ruby</code> installs Ruby (with the version specified in the `.ruby-version`
+  file).
+- <code>bundle</code> runs `bundle install`.
+- <code>node: <var>VERSION</var></code> installs the give Node.js version.
+- <code>npm</code> installs packages from package.json using npm.

data/TODO.md

@@ -0,0 +1,6 @@
+# To do
+
+- Add support for bash/zsh
+- Add support for installing PostgreSQL (and set env variables)
+- Add support for installing Redis (and set env variables)
+- Add support for installing Python (and maintain venv)

data/ddenv.yaml

@@ -0,0 +1,6 @@
+up:
+  - homebrew: overmind
+  - ruby
+  - bundle
+  - node: 20.12.2
+  - npm

data/lib/ddenv/cli.rb

@@ -2,26 +2,30 @@
 
 module Ddenv
   class CLI
-    def initialize(args)
-      @args = args
+    ROOT_CMD = Cri::Command.new_basic_root.modify do
+      name        "ddenv"
+      usage       "ddenv [options] [command] [options]"
+      summary     "manage developer environment"
+      description "Manages your local developer environment."
     end
 
-    def call
-      if @args.size != 1
-        warn "usage: ddenv [command]"
-        exit 64 # EX_USAGE
-      end
+    ROOT_CMD.define_command("up") do
+      name        "up"
+      usage       "up [options]"
+      summary     "bring up developer environment"
+      description "Brings up the local developer environment to be in line what is described in the ddenv.yaml configuration file."
 
-      command_name = @args.first
-      case command_name
-      when "help"
-        Ddenv::Commands::Help.new.call
-      when "up"
+      run do |_opts, _args, _cmd|
         Ddenv::Commands::Up.new.call
-      else
-        warn "ddenv: unknown command: #{command_name}"
-        exit 64 # EX_USAGE
       end
     end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def call
+      ROOT_CMD.run(@args)
+    end
   end
 end

data/lib/ddenv/commands/up.rb

@@ -4,19 +4,26 @@ module Ddenv
   module Commands
     class Up < Ddenv::Command
       def call
-        config = Ddenv::Config.read_from_file("dev.yml")
+        config = Ddenv::Config.read_from_file("ddenv.yaml")
+
+        all_goals = config.goals.flat_map(&:with_pre_and_post_goals).uniq
+
+        max_message_size = all_goals.map { _1.message.size }.max
+
+        all_goals.each do |goal|
+          spinner = TTY::Spinner.new("[:spinner] :message   :title")
+          spinner.update(message: format("%-#{max_message_size}s", goal.message))
+          spinner.update(title: "checking")
+          spinner.auto_spin
 
-        config.goals.each do |goal|
-          puts goal.message
-          puts "  Checking..."
           if goal.achieved?
-            puts "  Already achieved."
+            spinner.update(title: "done (previously achieved)")
           else
-            puts "  Achieving..."
+            spinner.update(title: "working...")
             goal.achieve
-            puts "  Newly achieved."
+            spinner.update(title: "done (newly achieved)")
           end
-          puts
+          spinner.success
         end
       end
     end

data/lib/ddenv/config.rb

@@ -19,13 +19,22 @@ module Ddenv
           when Hash
             [element.keys.first, element.values.first]
           when String
-            # TODO: for later
-            # (when a goal has no extra details)
+            [element, nil]
           end
 
         case key
         when "homebrew"
           Goals::HomebrewPackageInstalled.new(value)
+        when "ruby"
+          Goals::RubyInstalled.new
+        when "node"
+          Goals::NodeInstalled.new(value)
+        when "bundle"
+          Goals::BundleInstalled.new
+        when "npm"
+          Goals::NpmPackesInstalled.new
+        else
+          raise "unknown key: #{key}"
         end
       end
     end

data/lib/ddenv/goal.rb

@@ -15,5 +15,37 @@ module Ddenv
     def achieve
       raise SubclassResponsibilityError.new(self.class, __method__)
     end
+
+    def pre_goals
+      []
+    end
+
+    def post_goals
+      []
+    end
+
+    def with_pre_and_post_goals
+      [
+        *pre_goals.flat_map(&:with_pre_and_post_goals),
+        self,
+        *post_goals.flat_map(&:with_pre_and_post_goals)
+      ]
+    end
+
+    def props
+      []
+    end
+
+    def ==(other)
+      self.class == other.class && props == other.props
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      [self.class, props].hash
+    end
   end
 end

data/lib/ddenv/goals/bundle_installed.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class BundleInstalled < Goal
+      def message
+        "Installing bundle"
+      end
+
+      def achieved?
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "exec", "--", "bundle", "check")
+        true
+      rescue StandardError
+        false
+      end
+
+      def achieve
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "exec", "--", "bundle", "install")
+      end
+
+      def pre_goals
+        [
+          GemInstalled.new("bundler")
+        ]
+      end
+    end
+  end
+end

data/lib/ddenv/goals/gem_installed.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class GemInstalled < Goal
+      def initialize(gem_name)
+        super()
+        @gem_name = gem_name
+      end
+
+      def message
+        "Installing Ruby gem #{@gem_name}"
+      end
+
+      def achieved?
+        cmd = TTY::Command.new(printer: :null)
+        stdout, _stderr = cmd.run("shadowenv", "exec", "--", "gem", "list", "-i", "^#{@gem_name}$")
+        stdout.chomp == "true"
+      end
+
+      def achieve
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "exec", "--", "gem", "install", @gem_name)
+      end
+
+      def props
+        [@gem_name]
+      end
+    end
+  end
+end

data/lib/ddenv/goals/homebrew_package_installed.rb

@@ -3,6 +3,8 @@
 module Ddenv
   module Goals
     class HomebrewPackageInstalled < Goal
+      attr_reader :package_name
+
       def initialize(package_name)
         super()
         @package_name = package_name
@@ -21,6 +23,10 @@ module Ddenv
         cmd = TTY::Command.new(printer: :null)
         cmd.run("brew", "install", @package_name)
       end
+
+      def props
+        [@package_name]
+      end
     end
   end
 end

data/lib/ddenv/goals/node_build_installed.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    module NodeBuildInstalled
+      def self.new
+        Ddenv::Goals::HomebrewPackageInstalled.new("node-build")
+      end
+    end
+  end
+end

data/lib/ddenv/goals/node_installed.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class NodeInstalled < Goal
+      attr_reader :node_version
+
+      def initialize(node_version)
+        super()
+
+        @node_version = node_version.to_s
+      end
+
+      def message
+        "Installing Node v#{node_version}"
+      end
+
+      def achieved?
+        node_pathname.directory?
+      end
+
+      def achieve
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("node-build", node_version, node_pathname.to_s)
+      end
+
+      def pre_goals
+        [
+          NodeBuildInstalled.new
+        ]
+      end
+
+      def post_goals
+        [
+          NodeShadowenvCreated.new(node_version, node_pathname.to_s)
+        ]
+      end
+
+      private
+
+      def node_pathname
+        @_node_pathname ||= Pathname.new(Dir.home) / ".node-versions" / node_version
+      end
+    end
+  end
+end

data/lib/ddenv/goals/node_shadowenv_created.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class NodeShadowenvCreated < Goal
+      PATH = ".shadowenv.d/20_node.lisp"
+
+      def initialize(node_version, node_path)
+        super()
+
+        @node_version = node_version
+        @node_path = node_path
+      end
+
+      def message
+        "Adding Node to shadowenv"
+      end
+
+      def achieved?
+        File.file?(PATH) && File.read(PATH) == shadowenv_contents
+      end
+
+      def achieve
+        File.write(PATH, shadowenv_contents)
+
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "trust")
+      end
+
+      def pre_goals
+        [
+          Ddenv::Goals::ShadowenvDirCreated.new
+        ]
+      end
+
+      def props
+        [@node_version, @node_path]
+      end
+
+      private
+
+      def shadowenv_contents
+        <<~CONTENTS
+          (provide "node" "#{@node_version}")
+
+          (env/prepend-to-pathlist "PATH" "#{@node_path}/bin")
+        CONTENTS
+      end
+    end
+  end
+end

data/lib/ddenv/goals/npm_packages_installed.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class NpmPackesInstalled < Goal
+      def message
+        "Installing npm packages"
+      end
+
+      def achieved?
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "exec", "--", "npx", "check-dependencies")
+        true
+      rescue StandardError
+        false
+      end
+
+      def achieve
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "exec", "--", "npm", "install")
+      end
+    end
+  end
+end

data/lib/ddenv/goals/ruby_install_installed.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    module RubyInstallInstalled
+      def self.new
+        Ddenv::Goals::HomebrewPackageInstalled.new("ruby-install")
+      end
+    end
+  end
+end

data/lib/ddenv/goals/ruby_installed.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class RubyInstalled < Goal
+      def message
+        "Installing Ruby v#{ruby_version}"
+      end
+
+      def achieved?
+        pathname = Pathname.new(Dir.home) / ".rubies" / "ruby-#{ruby_version}"
+        pathname.directory?
+      end
+
+      def achieve
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("ruby-install", "--cleanup", ruby_version)
+      end
+
+      def pre_goals
+        [
+          RubyInstallInstalled.new
+        ]
+      end
+
+      def post_goals
+        [
+          RubyShadowenvCreated.new(ruby_version, ruby_pathname.to_s)
+        ]
+      end
+
+      private
+
+      def ruby_version
+        @_ruby_version ||= File.read(".ruby-version").chomp
+      end
+
+      def ruby_pathname
+        @_ruby_pathname ||= Pathname.new(Dir.home) / ".rubies" / "ruby-#{ruby_version}"
+      end
+    end
+  end
+end

data/lib/ddenv/goals/ruby_shadowenv_created.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class RubyShadowenvCreated < Goal
+      PATH = ".shadowenv.d/10_ruby.lisp"
+
+      def initialize(ruby_version, ruby_path)
+        super()
+
+        @ruby_version = ruby_version
+        @ruby_path = ruby_path
+      end
+
+      def message
+        "Adding Ruby to shadowenv"
+      end
+
+      def achieved?
+        File.file?(PATH) && File.read(PATH) == shadowenv_contents
+      end
+
+      def achieve
+        File.write(PATH, shadowenv_contents)
+
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "trust")
+      end
+
+      def pre_goals
+        [
+          Ddenv::Goals::ShadowenvDirCreated.new
+        ]
+      end
+
+      def props
+        [@ruby_version, @ruby_path]
+      end
+
+      private
+
+      def shadowenv_contents
+        <<~CONTENTS
+          (provide "ruby" "#{@ruby_version}")
+
+          (when-let ((ruby-root (env/get "RUBY_ROOT")))
+          (env/remove-from-pathlist "PATH" (path-concat ruby-root "bin"))
+          (when-let ((gem-root (env/get "GEM_ROOT")))
+            (env/remove-from-pathlist "PATH" (path-concat gem-root "bin")))
+          (when-let ((gem-home (env/get "GEM_HOME")))
+            (env/remove-from-pathlist "PATH" (path-concat gem-home "bin"))))
+
+          (env/set "GEM_PATH" ())
+          (env/set "GEM_HOME" ())
+          (env/set "RUBYOPT" ())
+
+          (env/set "RUBY_ROOT" "#{@ruby_path}")
+          (env/prepend-to-pathlist "PATH" "#{@ruby_path}/bin")
+          (env/set "RUBY_ENGINE" "ruby")
+          (env/set "RUBY_VERSION" "#{@ruby_version}")
+          (env/set "GEM_ROOT" "#{@ruby_path}/lib/ruby/gems/#{@ruby_version}")
+
+          (when-let ((gem-root (env/get "GEM_ROOT")))
+            (env/prepend-to-pathlist "GEM_PATH" gem-root)
+            (env/prepend-to-pathlist "PATH" (path-concat gem-root "bin")))
+
+          (let ((gem-home
+                (path-concat (env/get "HOME") ".gem" (env/get "RUBY_ENGINE") (env/get "RUBY_VERSION"))))
+            (do
+              (env/set "GEM_HOME" gem-home)
+              (env/prepend-to-pathlist "GEM_PATH" gem-home)
+              (env/prepend-to-pathlist "PATH" (path-concat gem-home "bin"))))
+        CONTENTS
+      end
+    end
+  end
+end