abtion-aid 0.2.0

data/lib/aid/scripts.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Aid
+  module Scripts
+  end
+end

data/lib/aid/scripts/doctor.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Aid
+  module Scripts
+    class Doctor < Aid::Script
+      def self.description
+        'Checks the health of your development environment'
+      end
+
+      def self.help
+        'doctor - helps you diagnose any setup issues with this application'
+      end
+
+      def initialize(*args)
+        super
+        @checks = []
+      end
+
+      def check(**options)
+        check = Check.new(options)
+        @checks << check
+
+        check.run!
+      end
+
+      def run
+        puts <<~HELP
+          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
+              check_phantomjs_installed
+            end
+
+            private
+
+            def check_phantomjs_installed
+              check name: "PhantomJS installed",
+                command: "which phantomjs",
+                remedy: command("brew install phantomjs")
+            end
+          end
+
+          You can add as many checks to your script as you want.
+        HELP
+
+        exit
+      end
+
+      def problems
+        @checks.map(&:problems).flatten
+      end
+
+      def exit_code
+        problems.size
+      end
+
+      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
+end

data/lib/aid/scripts/help.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Aid
+  module Scripts
+    class Help < Aid::Script
+      attr_reader :script
+
+      def initialize(*argv)
+        super
+
+        script_name = argv.first
+        @script = Aid::Script.scripts[script_name]
+      end
+
+      def self.description
+        'Displays help information'
+      end
+
+      def self.help
+        ''
+      end
+
+      def run
+        if script
+          puts "Help for #{colorize(:light_blue, script.name)}:"
+
+          puts script.help
+          puts
+        else
+          basic_usage
+        end
+      end
+
+      private
+
+      def basic_usage
+        puts "Usage: aid #{colorize(:light_blue, '[script name]')}"
+        puts
+        puts 'Specify a specific script to run, options are: '
+        puts
+
+        scripts = Hash[Aid::Script.scripts.sort]
+
+        names_and_descriptions = scripts.map do |name, script|
+          [
+            colorize(:light_green, name),
+            colorize(:light_blue, script.description)
+          ]
+        end
+
+        padding = names_and_descriptions.map { |name, _| name.length }.max
+
+        names_and_descriptions.each do |name, description|
+          puts format("  %-#{padding}s %s", name, description)
+        end
+
+        puts
+      end
+    end
+  end
+end

data/lib/aid/scripts/init.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Aid
+  module Scripts
+    class Init < Aid::Script
+      def self.description
+        'Sets up aid in your project'
+      end
+
+      def run
+        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]')}"
+      end
+    end
+  end
+end

data/lib/aid/scripts/new.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Aid
+  module Scripts
+    class New < Aid::Script
+      def self.description
+        '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
+        HELP
+      end
+
+      def run
+        exit_with_help! unless script_name
+        check_for_aid_directory!
+
+        step "Creating #{output_path}" do
+          File.open(output_path, 'wb') do |fp|
+            fp.write(template)
+          end
+
+          puts
+          print 'Successfully created '
+          puts colorize(:green, output_path)
+        end
+      end
+
+      private
+
+      def output_path
+        "#{aid_directory}/#{output_filename}"
+      end
+
+      def output_filename
+        "#{script_name.tr('-', '_')}.rb"
+      end
+
+      def check_for_aid_directory!
+        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"
+            end
+             def self.help
+              <<~HELP
+              Fill me in.
+              HELP
+            end
+             def run
+            end
+          end
+        RUBY
+      end
+
+      def class_name
+        script_name
+          .split('-')
+          .map { |token| token[0].upcase + token[1..-1] }
+          .join
+      end
+
+      def script_name
+        argv.first
+      end
+    end
+  end
+end

data/lib/aid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Aid
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: abtion-aid
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Abtion
+- David Balatero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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:
+- mail@abtion.com
+executables:
+- aid
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".solargraph.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aid.gemspec
+- bin/console
+- bin/setup
+- examples/begin.rb
+- examples/ci.rb
+- examples/data_dump.rb
+- examples/doctor.rb
+- examples/eslint.rb
+- examples/finish.rb
+- examples/mocha.rb
+- examples/pr.rb
+- examples/pushit.rb
+- examples/rspec.rb
+- examples/rubocop.rb
+- examples/slim_lint.rb
+- examples/test.rb
+- examples/update.rb
+- exe/aid
+- 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/version.rb
+homepage: https://github.com/abtion/aid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A library to make repo scripts easy and discoverable.
+test_files: []