ddenv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d454d9e8eba496ccf1c073109663cd75eb360317650505ba195f46e35df21330
-  data.tar.gz: ed0c07ba499cdb8ebbfdb0c24d4d57c64902eb4e5ec50599bed07c97961b1dff
+  metadata.gz: ec082036626c59440016bd290efe318994ed5d11affb29c29c74a40fb7bf6f57
+  data.tar.gz: 4af215b869b270245f24b97ac688301e6f8b53fac521c4c1c11c15c750279e99
 SHA512:
-  metadata.gz: bd6afc63047346551aee1dbea9d9b29895e3f355dbbdfb3638fea312aa05daa658af804b282b6f9ac36d7d0b6b95849162bbbbec881dcd07e863c141aba33d91
-  data.tar.gz: 3302364fce3c5cfee447a1cffecbf2ed5f691f1821e2b9db8a0a38ae362800cec2b8e0df7dc9f4bae28234ec2ee39c1eaa29f842cc2a7fd473ab09ee60f93584
+  metadata.gz: 9eb69dfcc93bc53d2757483eff2f14469666b220487e4356353c37687d1b22c7ff7d58a3c5a308d4565e891d08721fafca7eabc45e9a70958a7af4aecc26792c
+  data.tar.gz: '08f42ffb6c4ab4acf25ef12253dbbe5e8c2c8d2b9031562e55f7993e94023143055dddb319e45b2880c646f5c53815352b1cdbb3a98aac455397bc8f049f5ac7'

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [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,49 @@
-# Ddenv
+# ddenv
 
-TODO: Delete this and the text below, and describe your gem
+**ddenv** (*Denis’ Developer Environment*) is a tool for maintaining a local
+environment for development.
 
-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.
+> [!CAUTION]
+> This software is a pre-alpha work in progress. Do not use just yet.
 
-## Installation
+## Requirements
 
-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.
+- Homebrew
+- fish shell
 
-Install the gem and add to the application's Gemfile by executing:
+> [!NOTE]
+> In the future, this will work for bash and zsh as well.
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Quick start
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Install it: `brew install denisdefreyne/ddenv/ddenv`.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Next, create a `ddenv.yaml` file which contains the list of dependencies to manage:
 
-## Usage
+```yaml
+up:
+  - homebrew: overmind
+  - ruby: 3.3.0
+```
 
-TODO: Write usage instructions here
+Lastly, run `ddenv up`.
 
-## Development
+```
+% 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)
+%
+```
 
-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.
+Now your local developer environment is ready to be used.
 
-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).
+## Goals
 
-## 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).
+- <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.

data/ddenv.yaml

@@ -0,0 +1,3 @@
+up:
+  - homebrew: overmind
+  - ruby: 3.3.0

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

@@ -26,6 +26,8 @@ module Ddenv
         case key
         when "homebrew"
           Goals::HomebrewPackageInstalled.new(value)
+        when "ruby"
+          Goals::RubyInstalled.new(value)
         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/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/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,49 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class RubyInstalled < Goal
+      def initialize(ruby_version)
+        super()
+        @ruby_version = ruby_version
+      end
+
+      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_pathname.to_s, @ruby_version)
+        ]
+      end
+
+      def props
+        [@ruby_version]
+      end
+
+      private
+
+      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,73 @@
+# 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
+
+      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

data/lib/ddenv/goals/shadowenv_dir_created.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class ShadowenvDirCreated < Goal
+      PATH = ".shadowenv.d"
+
+      def message
+        "Creating .shadowenv.d"
+      end
+
+      def achieved?
+        Pathname.new(PATH).directory?
+      end
+
+      def achieve
+        FileUtils.mkdir_p(PATH)
+      end
+
+      def pre_goals
+        [
+          Ddenv::Goals::ShadowenvInitialized.new
+        ]
+      end
+
+      def post_goals
+        [
+          Ddenv::Goals::ShadowenvDirGitIgnored.new,
+          Ddenv::Goals::ShadowenvTrusted.new
+        ]
+      end
+    end
+  end
+end

data/lib/ddenv/goals/shadowenv_dir_git_ignored.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class ShadowenvDirGitIgnored < Goal
+      PATH = ".shadowenv.d/.gitignore"
+      CONTENTS = "*\n"
+
+      def message
+        "Adding .shadowenv.d to .gitignore"
+      end
+
+      def achieved?
+        File.file?(PATH) && File.read(PATH) == CONTENTS
+      end
+
+      def achieve
+        File.write(PATH, CONTENTS)
+      end
+    end
+  end
+end

data/lib/ddenv/goals/shadowenv_initialized.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class ShadowenvInitialized < Goal
+      FISH_LINE = "shadowenv init fish | source"
+
+      def message
+        "Initializing Shadowenv"
+      end
+
+      # TODO: support bash and zsh
+
+      def achieved?
+        fish_config = File.read(fish_config_path)
+        fish_config.lines.any? { _1.chomp == FISH_LINE }
+      end
+
+      def achieve
+        File.write(fish_config_path, "\n\n#{FISH_LINE}", mode: "a+")
+      end
+
+      private
+
+      def fish_config_path
+        @_fish_config_path ||= File.expand_path("~/.config/fish/config.fish")
+      end
+    end
+  end
+end

data/lib/ddenv/goals/shadowenv_trusted.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Ddenv
+  module Goals
+    class ShadowenvTrusted < Goal
+      def message
+        "Trusting .shadowenv.d"
+      end
+
+      def achieved?
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        begin
+          cmd.run("shadowenv", "exec", "--", "ls")
+        rescue StandardError
+          return false
+        end
+        true
+      end
+
+      def achieve
+        # TODO: use :pretty when passing --verbose
+        cmd = TTY::Command.new(printer: :null)
+        cmd.run("shadowenv", "trust")
+      end
+    end
+  end
+end

data/lib/ddenv/version.rb

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

data/lib/ddenv.rb

@@ -4,6 +4,7 @@ require "json"
 require "yaml"
 
 require "tty-command"
+require "tty-spinner"
 
 require_relative "ddenv/cli"
 require_relative "ddenv/command"
@@ -17,3 +18,10 @@ 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/shadowenv_initialized"
+require_relative "ddenv/goals/shadowenv_dir_created"
+require_relative "ddenv/goals/shadowenv_dir_git_ignored"
+require_relative "ddenv/goals/shadowenv_trusted"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddenv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Denis Defreyne
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Creates and maintains an environment for local development, including
   Ruby and Node versions.
 email:
@@ -40,7 +54,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- dev.yml
+- ddenv.yaml
 - exe/ddenv
 - lib/ddenv.rb
 - lib/ddenv/cli.rb
@@ -50,6 +64,13 @@ files:
 - lib/ddenv/config.rb
 - lib/ddenv/goal.rb
 - lib/ddenv/goals/homebrew_package_installed.rb
+- lib/ddenv/goals/ruby_install_installed.rb
+- lib/ddenv/goals/ruby_installed.rb
+- lib/ddenv/goals/ruby_shadowenv_created.rb
+- lib/ddenv/goals/shadowenv_dir_created.rb
+- lib/ddenv/goals/shadowenv_dir_git_ignored.rb
+- lib/ddenv/goals/shadowenv_initialized.rb
+- lib/ddenv/goals/shadowenv_trusted.rb
 - lib/ddenv/homebrew.rb
 - lib/ddenv/subclass_responsibility_error.rb
 - lib/ddenv/version.rb

data/dev.yml

@@ -1,4 +0,0 @@
-up:
-  - homebrew: vim
-  - homebrew: font-roboto
-  - homebrew: font-roboto-mono