devinator 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 046f88a18615ff14000b6152870bc84c8e8f7eedfd827a9c8a24d1c001f5fb9a
-  data.tar.gz: d22ff6f57a13d3c6166cc61665f26bd40f3da09c4af11e1aa8bb37ce043c262b
+  metadata.gz: 849893f1832cf84799047935f72eeaedc26a389668d5ef5f9e4727aed2493896
+  data.tar.gz: b758be13ae17fb04700bcdd2bafd5828d3864f1e006b023b18408bfd753169f1
 SHA512:
-  metadata.gz: 8df565e8abfe627a0092227af9d393242c5e906bc85279ea5ff09147e5a64a3e98c81d5d7b7b17776058df9b486fbdd8a08bf9e7e7ea6d19f6696fc98538e55d
-  data.tar.gz: 14f6a8f20a1109135bf49acea9f5139a51524efc3828e9124445af3067bc78fbdeb216a94cc93a25ef9d71cd09af3ee70c6b80a3ee639275f686079489746a2f
+  metadata.gz: b29bb12d118f1cbd152cb54fc125d02f446a8b621681639de34a125d21da0edee73181ab3faf7d7c867c70a0f78c378a13079ff36f6c7933dd47207715952b04
+  data.tar.gz: 710b0d2463d0075bf2e0d1353726782be8e1d4e3cccbbf63e2b859b4a34c248c2b9dab250a6c19675ac7829e712fe35b8cc11cb03000b4f440bf0f5fc70e4b6a

data/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org" do
-  gem "tty-command"
+  gemspec
 
   group :development do
     gem "standardrb"

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    devinator (0.0.3)
+      tty-command
+
 GEM
   specs:
 
@@ -6,7 +12,7 @@ GEM
   specs:
     ast (2.4.3)
     diff-lcs (1.6.2)
-    json (2.15.1)
+    json (2.15.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     parallel (1.27.0)
@@ -77,9 +83,9 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  devinator!
   rspec!
   standardrb!
-  tty-command!
 
 BUNDLED WITH
    2.7.2

data/Makefile

@@ -1,7 +1,13 @@
-.PHONY: setup_hooks pretty build
+.PHONY: setup_hooks pretty build clean deploy
+clean:
+	rm *.gem
+
 build:
 	gem build
 
+deploy: clean build
+	gem push devinator-*.gem
+
 setup_hooks:
 	git config core.hooksPath ./.git-hooks
 

data/README.md

@@ -8,9 +8,60 @@ opinionated but can be twisted to your will.
 Simply `cd` to your project and run `devinator`. It will do several things for
 you in this order:
 
+1. `bin/setup`
+2. launch your editor
+3. start `tmux`
+4. run the commands in `Procfile.dev` or `bin/dev`
+
+### With a dx setup
+
+If you have some extra files they will be used to run your project in the dx
+environment. So running it would look more like:
+
 1. `dx/build`
 2. `dx/start`
-3. `bin/setup` or `bin/setup`
-4. start your multiplexer
+3. `dx/exec bin/setup`
 5. launch your editor
-6. run the commands in `Procfile.dev` or `bin/dev`
+4. start `tmux`
+6. run the commands in `Procfile.dev` prefixed with `dx/exec` or `dx/exec bin/dev`
+
+## Installation for Linux/OSX
+
+1. run `ruby --version` to confirm it's installed
+1. run `tmux -V` to confirm it's installed
+2. `gem install devinator`
+3. `which devinator` to confirm it installed and is in your `$PATH`
+
+## Configuration
+
+Open `~/.config/devinator.rb` with your editor of choice and add the following
+content:
+
+```ruby
+Devinator::Config.configure do |config|
+  # Use this to run any personal commands before the usual culprits, this is
+  # useful for loading secrets and the like.
+  config.setup_commands = []
+
+  # If your editor is run in as :first_command or :last_command then this is the
+  # title that tmux will get for that window.
+  config.editor.title = "editor"
+
+  # This is your editor command, if you're running it with a timing of
+  # :end_of_setup then you will want to make sure this isn't foregrounded. I
+  # belive `code` by default will go into the background, so that's a good setup
+  # if you use VSCode.
+  config.editor.command = ENV["EDITOR"]
+
+  # This is when you want your editor command to run, the valid options are:
+  #   - :end_of_setup
+  #   - :first_command
+  #   - :last_command
+  #
+  # :end_of_setup will call it as the last setup command before tmux is
+  # launched.
+  # :first_command will call it in the first window of tmux
+  # :last_command will call it in the last window of tmux
+  config.editor.timing = :first_command
+end
+```

data/bin/dev

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bin/test

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+echo "=== Ruby ==="
+ruby --version
+
+echo "=== Bundle ==="
+bundle check || bundle install

data/devinator.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.executables = [
     "devinator"
   ]
+
+  gem.add_dependency "tty-command"
 end

data/lib/devinator/config.rb

@@ -19,10 +19,10 @@ class Devinator
 
       @setup_commands += user_configuration.setup_commands
 
-      @setup_commands << "dx/build" if File.exist? "dx/build"
-      @setup_commands << "dx/start" if File.exist? "dx/start"
+      @setup_commands << "dx/build" if File.file? "dx/build"
+      @setup_commands << "dx/start" if File.file? "dx/start"
 
-      @setup_commands << dx_exec("bin/setup") if File.exist? "bin/setup"
+      @setup_commands << dx_exec("bin/setup") if File.file? "bin/setup"
 
       @setup_commands << user_configuration.editor.command if user_configuration.editor.timing == :end_of_setup
 
@@ -39,13 +39,13 @@ class Devinator
         }
       end
 
-      if File.exist? "Procfile.dev"
+      if File.file? "Procfile.dev"
         File.read("Procfile.dev").lines.each { |line|
           name, command = line.split(":", 2)
           @commands << {title: name, command: dx_exec(command.strip)}
         }
 
-      elsif File.exist? "bin/dev"
+      elsif File.file? "bin/dev"
         @commands << {title: "dev", command: dx_exec("bin/dev")}
       end
 
@@ -61,7 +61,7 @@ class Devinator
 
     private_class_method def self.dx_exec(command)
       result = ""
-      result << "dx/exec " if File.exist? "dx/exec"
+      result << "dx/exec " if File.file? "dx/exec"
       result << command
     end
   end

data/lib/devinator/version.rb

@@ -1,3 +1,3 @@
 class Devinator
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/devinator.rb

@@ -8,7 +8,7 @@ class Devinator
     tty = TTY::Command.new(uuid: false)
 
     user_config_path = File.expand_path("~/.config/devinator.rb")
-    Kernel.require(user_config_path) if File.exist?(user_config_path)
+    Kernel.require(user_config_path) if File.file?(user_config_path)
 
     Devinator::Config.setup_commands.each { tty.run it, only_output_on_error: true }
 

data/spec/devinator_spec.rb

@@ -15,7 +15,7 @@ describe Devinator do
 
     it "runs the setup commands before run commands" do
       expect(File).to receive(:expand_path).with("~/.config/devinator.rb").and_return("user config")
-      expect(File).to receive(:exist?).with("user config").and_return(false)
+      expect(File).to receive(:file?).with("user config").and_return(false)
       expect(TTY::Command).to receive(:new).with(uuid: false)
 
       expect(Dir).to receive(:pwd).and_return("/path/to/project")
@@ -44,7 +44,7 @@ describe Devinator do
 
     it "loads the user config" do
       expect(File).to receive(:expand_path).with("~/.config/devinator.rb").and_return("user config")
-      expect(File).to receive(:exist?).with("user config").and_return(true)
+      expect(File).to receive(:file?).with("user config").and_return(true)
 
       expect(Kernel).to receive(:require).with("user config")
 

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: devinator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Sean Earle
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       A little tool to help you get your development
       environment up and running with a single command.
@@ -26,8 +40,10 @@ files:
 - Gemfile.lock
 - Makefile
 - README.md
+- bin/dev
 - bin/devinator
 - bin/pretty
+- bin/setup
 - bin/test
 - devinator.gemspec
 - lib/devinator.rb
@@ -60,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Start your development environment with one command!
 test_files: []