ddenv 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec082036626c59440016bd290efe318994ed5d11affb29c29c74a40fb7bf6f57
-  data.tar.gz: 4af215b869b270245f24b97ac688301e6f8b53fac521c4c1c11c15c750279e99
+  metadata.gz: be59b284b001642fbf169fb71a0c6887b2a54c4747ef52c0cc695b6b6621f7eb
+  data.tar.gz: b140aa2607964e48d50555420db3d038cc1e9306ce46147e5657e97c4f2c06bd
 SHA512:
-  metadata.gz: 9eb69dfcc93bc53d2757483eff2f14469666b220487e4356353c37687d1b22c7ff7d58a3c5a308d4565e891d08721fafca7eabc45e9a70958a7af4aecc26792c
-  data.tar.gz: '08f42ffb6c4ab4acf25ef12253dbbe5e8c2c8d2b9031562e55f7993e94023143055dddb319e45b2880c646f5c53815352b1cdbb3a98aac455397bc8f049f5ac7'
+  metadata.gz: e59e6c7ef5f3e64ccd0962475e0137912009188b2cff521d39dc4bfacfb8645542ae432299aeefda5af817dfdb4b8999cc75186af8ef66ea79b8c15d947ac4f6
+  data.tar.gz: cdcffc2846efe163d628f6ac677533e12cd8501783d72fb8ee6f5f09cb2bd37d166ca7b37628a4b2d6321762b5f902533668ca137134458506135305710d2f36

data/.rubocop.yml

@@ -15,5 +15,8 @@ Style/Documentation:
 Metrics:
   Enabled: false
 
+Layout/LineLength:
+  Enabled: false
+
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [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.

data/README.md

@@ -24,20 +24,29 @@ Next, create a `ddenv.yaml` file which contains the list of dependencies to mana
 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 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)
 %
 ```
 
@@ -46,4 +55,8 @@ 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: <var>VERSION</var></code> installs the given version of Ruby.
+- <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

@@ -1,3 +1,6 @@
 up:
   - homebrew: overmind
-  - ruby: 3.3.0
+  - 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

@@ -11,7 +11,7 @@ module Ddenv
         max_message_size = all_goals.map { _1.message.size }.max
 
         all_goals.each do |goal|
-          spinner = TTY::Spinner.new("[:spinner] :message... :title")
+          spinner = TTY::Spinner.new("[:spinner] :message   :title")
           spinner.update(message: format("%-#{max_message_size}s", goal.message))
           spinner.update(title: "checking")
           spinner.auto_spin

data/lib/ddenv/config.rb

@@ -19,15 +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(value)
+          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/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/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_installed.rb

@@ -3,24 +3,19 @@
 module Ddenv
   module Goals
     class RubyInstalled < Goal
-      def initialize(ruby_version)
-        super()
-        @ruby_version = ruby_version
-      end
-
       def message
-        "Installing Ruby v#{@ruby_version}"
+        "Installing Ruby v#{ruby_version}"
       end
 
       def achieved?
-        pathname = Pathname.new(Dir.home) / ".rubies" / "ruby-#{@ruby_version}"
+        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)
+        cmd.run("ruby-install", "--cleanup", ruby_version)
       end
 
       def pre_goals
@@ -31,18 +26,18 @@ module Ddenv
 
       def post_goals
         [
-          RubyShadowenvCreated.new(ruby_pathname.to_s, @ruby_version)
+          RubyShadowenvCreated.new(ruby_version, ruby_pathname.to_s)
         ]
       end
 
-      def props
-        [@ruby_version]
-      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}"
+        @_ruby_pathname ||= Pathname.new(Dir.home) / ".rubies" / "ruby-#{ruby_version}"
       end
     end
   end

data/lib/ddenv/goals/ruby_shadowenv_created.rb

@@ -7,6 +7,7 @@ module Ddenv
 
       def initialize(ruby_version, ruby_path)
         super()
+
         @ruby_version = ruby_version
         @ruby_path = ruby_path
       end
@@ -33,6 +34,10 @@ module Ddenv
         ]
       end
 
+      def props
+        [@ruby_version, @ruby_path]
+      end
+
       private
 
       def shadowenv_contents

data/lib/ddenv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ddenv
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/ddenv.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require "json"
+require "pathname"
 require "yaml"
 
+require "cri"
 require "tty-command"
 require "tty-spinner"
 
@@ -14,13 +16,18 @@ require_relative "ddenv/homebrew"
 require_relative "ddenv/subclass_responsibility_error"
 require_relative "ddenv/version"
 
-require_relative "ddenv/commands/help"
 require_relative "ddenv/commands/up"
 
 require_relative "ddenv/goals/homebrew_package_installed"
 require_relative "ddenv/goals/ruby_install_installed"
 require_relative "ddenv/goals/ruby_installed"
 require_relative "ddenv/goals/ruby_shadowenv_created"
+require_relative "ddenv/goals/bundle_installed"
+require_relative "ddenv/goals/gem_installed"
+require_relative "ddenv/goals/node_build_installed"
+require_relative "ddenv/goals/node_installed"
+require_relative "ddenv/goals/npm_packages_installed"
+require_relative "ddenv/goals/node_shadowenv_created"
 require_relative "ddenv/goals/shadowenv_initialized"
 require_relative "ddenv/goals/shadowenv_dir_created"
 require_relative "ddenv/goals/shadowenv_dir_git_ignored"