aid 0.1.3 → 0.2.2

data/lib/aid/script.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Aid
   class Script
     include Aid::Colorize
     include Aid::Inheritable
 
     def self.name
-      klass_name = self.to_s.split('::').last
+      klass_name = to_s.split('::').last
 
       klass_name
         .scan(/[A-Z][a-z0-9]*/)
@@ -34,7 +36,7 @@ module Aid
     end
 
     def self.description
-      ""
+      ''
     end
 
     def help
@@ -64,7 +66,7 @@ module Aid
     end
 
     def system!(*args)
-      puts colorize(:command, args.join(" "))
+      puts colorize(:command, args.join(' '))
       system(*args) || abort(colorize(:error, "\n== Command #{args} failed =="))
     end
 
@@ -91,7 +93,7 @@ module Aid
     private
 
     def aid_directory
-      "./.aid"
+      './.aid'
     end
   end
 end

data/lib/aid/scripts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aid
   module Scripts
   end

data/lib/aid/scripts/doctor.rb

@@ -1,45 +1,14 @@
+# frozen_string_literal: true
+
 module Aid
   module Scripts
     class Doctor < Aid::Script
-      class Check
-        include Aid::Colorize
-
-        attr_reader :name, :command, :remedy, :problems
-
-        def initialize(name:, command:, remedy:)
-          @name = name
-          @command = command
-          @remedy = remedy
-          @problems = []
-        end
-
-        def run!
-          print "Checking: #{name}... "
-
-          success = if command.respond_to?(:call)
-            command.call
-          else
-            system "#{command} > /dev/null 2>&1"
-          end
-
-          if success
-            puts 'OK'
-          else
-            print colorize(:error, 'F')
-            fix = remedy.respond_to?(:join) ? remedy.join(" ") : remedy
-            puts "\n  To fix: #{colorize(:command, fix)}\n\n"
-
-            problems << name
-          end
-        end
-      end
-
       def self.description
-        "Checks the health of your development environment"
+        'Checks the health of your development environment'
       end
 
       def self.help
-        "doctor - helps you diagnose any setup issues with this application"
+        'doctor - helps you diagnose any setup issues with this application'
       end
 
       def initialize(*args)
@@ -56,8 +25,8 @@ module Aid
 
       def run
         puts <<~HELP
-        To implement this script for your repository, create the following
-        file in #{colorize(:green, "#{aid_directory}/doctor.rb")}:
+          To implement this script for your repository, create the following
+          file in #{colorize(:green, "#{aid_directory}/doctor.rb")}:
 
           class Doctor < Aid::Scripts::Doctor
             def run
@@ -73,7 +42,7 @@ module Aid
             end
           end
 
-        You can add as many checks to your script as you want.
+          You can add as many checks to your script as you want.
         HELP
 
         exit
@@ -87,8 +56,101 @@ module Aid
         problems.size
       end
 
-      def command(s)
-        "run #{colorize :command, s}"
+      def command(cmd)
+        CommandRemedy.new(cmd)
+      end
+
+      class Remedy
+        def initialize(message)
+          @message = message
+        end
+
+        def auto_fixable?
+          false
+        end
+
+        def auto_fix!
+          # By default, we don't know how to auto-fix
+        end
+
+        def to_s
+          message
+        end
+
+        private
+
+        attr_reader :message
+      end
+
+      class CommandRemedy < Remedy
+        include Aid::Colorize
+
+        alias shell_command message
+
+        def initialize(shell_command)
+          super
+        end
+
+        def auto_fixable?
+          true
+        end
+
+        def auto_fix!
+          puts "==> running #{colorize(:command, "$ #{shell_command}")}"
+          system(shell_command)
+        end
+
+        def to_s
+          "run #{colorize :command, shell_command}"
+        end
+      end
+
+      class Check
+        include Aid::Colorize
+
+        attr_reader :name, :command, :remedy, :problems
+
+        def initialize(name:, command:, remedy:)
+          @name = name
+          @command = command
+          @remedy = remedy.is_a?(Remedy) ? remedy : Remedy.new(remedy)
+          @problems = []
+          @checked_once = false
+        end
+
+        def run!
+          print "Checking: #{name}... "
+
+          success = run_command
+
+          if success
+            puts 'OK'
+          else
+            puts colorize(:error, 'F')
+
+            if @checked_once || !remedy.auto_fixable?
+              puts "\n  To fix: #{remedy}\n\n"
+              problems << name
+            elsif remedy.auto_fixable?
+              @checked_once = true
+
+              puts '==> attempting autofix'
+              remedy.auto_fix!
+              puts '==> retrying check'
+              run!
+            end
+          end
+        end
+
+        private
+
+        def run_command
+          if command.respond_to?(:call)
+            command.call
+          else
+            system "#{command} > /dev/null 2>&1"
+          end
+        end
       end
     end
   end

data/lib/aid/scripts/help.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aid
   module Scripts
     class Help < Aid::Script
@@ -11,11 +13,11 @@ module Aid
       end
 
       def self.description
-        "Displays help information"
+        'Displays help information'
       end
 
       def self.help
-        ""
+        ''
       end
 
       def run
@@ -34,10 +36,12 @@ module Aid
       def basic_usage
         puts "Usage: aid #{colorize(:light_blue, '[script name]')}"
         puts
-        puts "Specify a specific script to run, options are: "
+        puts 'Specify a specific script to run, options are: '
         puts
 
-        names_and_descriptions = Aid::Script.scripts.map do |name, script|
+        scripts = Hash[Aid::Script.scripts.sort]
+
+        names_and_descriptions = scripts.map do |name, script|
           [
             colorize(:light_green, name),
             colorize(:light_blue, script.description)
@@ -47,7 +51,7 @@ module Aid
         padding = names_and_descriptions.map { |name, _| name.length }.max
 
         names_and_descriptions.each do |name, description|
-          puts "  %-#{padding}s %s" % [name, description]
+          puts format("  %-#{padding}s %s", name, description)
         end
 
         puts

data/lib/aid/scripts/init.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module Aid
   module Scripts
     class Init < Aid::Script
       def self.description
-        "Sets up aid in your project"
+        'Sets up aid in your project'
       end
 
       def run
-        step "Creating .aid directory" do
+        step 'Creating .aid directory' do
           system! "mkdir -p #{aid_directory}"
         end
 
         puts
-        puts "All done! To create your first script, run "\
-          "#{colorize(:green, "aid new [script-name]")}"
+        puts 'All done! To create your first script, run '\
+          "#{colorize(:green, 'aid new [script-name]')}"
       end
     end
   end

data/lib/aid/scripts/new.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
+
 module Aid
   module Scripts
     class New < Aid::Script
       def self.description
-        "Generates a new script in the aid directory"
+        'Generates a new script in the aid directory'
       end
 
       def self.help
         <<~HELP
-        Usage: aid new [script name]
-
-        Generates a new script file in the aid script directory.
-
-        Example:
-          #{colorize(:green, "$ aid new my-script-name")}
-
-          will generate a new script called my_script_name.rb
+          Usage: aid new [script name]
+           Generates a new script file in the aid script directory.
+           Example:
+            #{colorize(:green, '$ aid new my-script-name')}
+             will generate a new script called my_script_name.rb
         HELP
       end
 
@@ -23,12 +22,12 @@ module Aid
         check_for_aid_directory!
 
         step "Creating #{output_path}" do
-          File.open(output_path, "wb") do |fp|
+          File.open(output_path, 'wb') do |fp|
             fp.write(template)
           end
 
           puts
-          print "Successfully created "
+          print 'Successfully created '
           puts colorize(:green, output_path)
         end
       end
@@ -40,38 +39,36 @@ module Aid
       end
 
       def output_filename
-        "#{script_name.gsub(/-/, "_")}.rb"
+        "#{script_name.tr('-', '_')}.rb"
       end
 
       def check_for_aid_directory!
-        unless Dir.exist?(aid_directory)
-          abort "The #{colorize(:green, aid_directory)} directory is "\
-            "missing. Please run #{colorize(:green, "aid init")} to create it."
-        end
+        return if Dir.exist?(aid_directory)
+
+        abort "The #{colorize(:green, aid_directory)} directory is "\
+          "missing. Please run #{colorize(:green, 'aid init')} to create it."
       end
 
       def template
         <<~RUBY
-        class #{class_name} < Aid::Script
-          def self.description
-            "FILL ME IN"
+          class #{class_name} < Aid::Script
+            def self.description
+              "FILL ME IN"
+            end
+             def self.help
+              <<~HELP
+              Fill me in.
+              HELP
+            end
+             def run
+            end
           end
-
-          def self.help
-            <<~HELP
-            Fill me in.
-            HELP
-          end
-
-          def run
-          end
-        end
         RUBY
       end
 
       def class_name
         script_name
-          .split("-")
+          .split('-')
           .map { |token| token[0].upcase + token[1..-1] }
           .join
       end

data/lib/aid/scripts/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+#
+require_relative '../version'
+
+module Aid
+  module Scripts
+    class Version < Aid::Script
+      def self.description
+        'Displays the current version'
+      end
+
+      def run
+        puts Aid::VERSION
+      end
+    end
+  end
+end
+
+

data/lib/aid/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aid
-  VERSION = "0.1.3"
+  VERSION = '0.2.2'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: aid
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - David Balatero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - dbalatero@gmail.com
@@ -62,6 +90,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".solargraph.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -89,12 +119,14 @@ files:
 - lib/aid.rb
 - lib/aid/colorize.rb
 - lib/aid/inheritable.rb
+- lib/aid/plugins.rb
 - lib/aid/script.rb
 - lib/aid/scripts.rb
 - lib/aid/scripts/doctor.rb
 - lib/aid/scripts/help.rb
 - lib/aid/scripts/init.rb
 - lib/aid/scripts/new.rb
+- lib/aid/scripts/version.rb
 - lib/aid/version.rb
 homepage: https://github.com/dbalatero/aid
 licenses:
@@ -115,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library to make repo scripts easy and discoverable.