abtion-aid 0.2.0

data/examples/rubocop.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Rubocop < Aid::Script
+  def self.description
+    'Runs rubocop against the codebase'
+  end
+
+  def self.help
+    <<~HELP
+      Usage:
+         #{colorize(:green, '$ aid rubocop')} - runs all the cops
+        #{colorize(:green, '$ aid rubocop fix')} - auto-fixes any issues
+    HELP
+  end
+
+  def run
+    step 'Running Rubocop' do
+      cmd = 'bundle exec rubocop'
+      cmd << ' -a' if auto_fix?
+
+      system! cmd
+    end
+  end
+
+  private
+
+  def auto_fix?
+    argv.first == 'fix'
+  end
+end

data/examples/slim_lint.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class SlimLint < Aid::Script
+  def self.description
+    'Runs slim-lint against our templates'
+  end
+
+  def self.help
+    <<~HELP
+      Usage: $ aid slim-lint
+       This will run slim-lint against our templates under app/.
+    HELP
+  end
+
+  def run
+    step 'Linting slim templates...' do
+      system! 'slim-lint app/**/*.slim'
+    end
+
+    puts
+    puts colorize(:green, 'Passed!')
+  end
+end

data/examples/test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Test < Aid::Script
+  def self.description
+    'Runs full test suite'
+  end
+
+  def self.help
+    <<~HELP
+      Usage: aid test
+       Runs all the tests that are needed for acceptance.
+    HELP
+  end
+
+  def run
+    Rubocop.run
+    Eslint.run
+    Mocha.run
+    SlimLint.run
+    Rspec.run
+  end
+end

data/examples/update.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class Update < Aid::Script
+  def self.description
+    'Updates your dev environment automatically'
+  end
+
+  def self.help
+    <<~HELP
+      aid update
+       This script is a way to update your development environment automatically.
+      It will:
+       - rebase origin/master onto this branch
+      - install any new dependencies
+      - run any migrations
+      - prune your logs
+      - restart your servers
+    HELP
+  end
+
+  def run
+    pull_git
+    install_dependencies
+    update_db
+    remove_old_logs
+    restart_servers
+  end
+
+  private
+
+  def pull_git
+    step 'Rebasing from origin/master' do
+      system! 'git fetch origin && git rebase origin/master'
+    end
+  end
+
+  def install_dependencies
+    step 'Installing dependencies' do
+      system! 'command -v bundler > /dev/null || '\
+        'gem install bundler --conservative'
+
+      system! 'bundle install'
+      system! 'yarn'
+    end
+  end
+
+  def update_db
+    step 'Updating database' do
+      system! 'rake db:migrate db:test:prepare'
+    end
+  end
+
+  def remove_old_logs
+    step 'Removing old logs and tempfiles' do
+      system! 'rake log:clear tmp:clear'
+    end
+  end
+
+  def restart_servers
+    restart_rails
+  end
+
+  def restart_rails
+    step 'Attempting to restart Rails' do
+      output = `bin/rails restart`
+
+      if $CHILD_STATUS.exitstatus.positive?
+        puts colorize(
+          :light_red,
+          'skipping restart, not supported in this version of '\
+            'Rails (needs >= 5)'
+        )
+      else
+        puts output
+      end
+    end
+  end
+end

data/exe/aid

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/aid'
+
+Aid.load_scripts!
+
+plugins = Aid::PluginManager.new
+plugins.activate_plugins
+
+Aid.load_configs!
+
+script = Aid::Script.scripts[Aid.script_name]
+
+if ARGV.empty?
+  Aid::Scripts::Help.run
+  exit 0
+end
+
+if script
+  script.run(*Aid.script_args)
+else
+  puts "Script '#{script}' not recognized"
+  puts
+
+  Aid::Scripts::Help.run
+
+  exit 1
+end

data/lib/aid.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'aid/version'
+
+module Aid
+  def self.load_paths
+    @load_paths ||= [
+      File.expand_path(File.dirname(__FILE__) + '/aid/scripts'),
+      '.aid',
+      "#{Aid.project_root}/.aid",
+      ENV['AID_PATH']
+    ].compact
+  end
+
+  def self.load_scripts!
+    load_paths.each do |path|
+      Dir.glob("#{path}/*.rb").each do |file|
+        require File.expand_path(file) unless %r{/config\.rb$}.match?(file)
+      end
+    end
+  end
+
+  def self.load_configs!
+    load_paths.each do |path|
+      config = File.expand_path("#{path}/config.rb")
+      require config if File.exist?(config)
+    end
+  end
+
+  def self.script_name
+    ARGV.first
+  end
+
+  def self.script_args
+    ARGV[1..-1]
+  end
+
+  def self.project_root
+    @project_root ||= begin
+      current_search_dir = Dir.pwd
+
+      loop do
+        git_dir = "#{current_search_dir}/.git"
+
+        return current_search_dir if Dir.exist?(git_dir)
+        break if current_search_dir == '/'
+
+        current_search_dir = File.expand_path("#{current_search_dir}/..")
+      end
+
+      nil
+    end
+  end
+end
+
+require_relative 'aid/colorize'
+require_relative 'aid/inheritable'
+require_relative 'aid/plugins'
+require_relative 'aid/script'
+require_relative 'aid/scripts'

data/lib/aid/colorize.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Aid
+  module Colorize
+    module_function
+
+    def self.included(base)
+      colorize = self
+
+      base.class_eval do
+        extend colorize
+      end
+    end
+
+    COLOR_CODES = {
+      black: 30,
+      blue: 34,
+      brown: 33,
+      cyan: 36,
+      dark_gray: 90,
+      green: 32,
+      light_blue: 94,
+      light_cyan: 96,
+      light_gray: 37,
+      light_green: 92,
+      light_purple: 95,
+      light_red: 91,
+      light_yellow: 93,
+      purple: 35,
+      red: 31,
+      white: 97,
+      yellow: 33,
+
+      command: 96,
+      error: 91,
+      info: 93
+    }.freeze
+
+    def colorize(color, string)
+      "\e[#{COLOR_CODES[color]}m#{string}\e[0m"
+    end
+  end
+end

data/lib/aid/inheritable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Aid
+  module Inheritable
+    def self.included(klass)
+      klass.instance_eval do
+        extend ClassMethods
+
+        def self.inherited(subklass)
+          Aid::Script.script_classes << subklass
+        end
+      end
+    end
+
+    module ClassMethods
+      def script_classes
+        @script_classes ||= []
+      end
+
+      def reset_script_classes!
+        @scripts = nil
+        @script_classes = []
+      end
+
+      def scripts
+        @scripts ||= load_scripts_deferred
+      end
+
+      def load_scripts_deferred
+        script_classes.each_with_object({}) do |klass, result|
+          result[klass.name] = klass
+        end
+      end
+    end
+  end
+end

data/lib/aid/plugins.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Aid
+  class PluginManager
+    def plugins
+      @plugins ||= load_plugins
+    end
+
+    def activate_plugins
+      plugins.each do |_, plugin|
+        plugin.activate!
+      end
+    end
+
+    private
+
+    def load_plugins
+      plugins = {}
+
+      locate_plugins.each do |plugin|
+        plugins[plugin.name] ||= plugin
+      end
+
+      plugins
+    end
+
+    AID_PLUGIN_PREFIX = 'aid-'
+
+    def locate_plugins
+      plugins = []
+
+      gem_list.each do |gem_object|
+        next unless gem_object.name.start_with?(AID_PLUGIN_PREFIX)
+
+        plugins << Plugin.new(gem_object)
+      end
+
+      plugins
+    end
+
+    def gem_list
+      Gem.refresh
+      return Gem::Specification if Gem::Specification.respond_to?(:each)
+
+      Gem.source_index.find_name('')
+    end
+
+    class Plugin
+      attr_reader :name
+
+      def initialize(gem_object)
+        @name = gem_object.name.split('-', 2).last
+        @gem = gem_object
+      end
+
+      def activate!
+        require @gem.name
+      rescue LoadError => e
+        warn "Found plugin #{@gem.name}, but could not require '#{@gem.name}'"
+        warn e
+      end
+    end
+  end
+end

data/lib/aid/script.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Aid
+  class Script
+    include Aid::Colorize
+    include Aid::Inheritable
+
+    def self.name
+      klass_name = to_s.split('::').last
+
+      klass_name
+        .scan(/[A-Z][a-z0-9]*/)
+        .map(&:downcase)
+        .join('-')
+    end
+
+    def exit_with_help!
+      puts self.class.help
+      exit
+    end
+
+    def self.help
+      <<~HELP
+        Help has not been implemented for "#{name}". Please implement a
+        help method like so:
+
+        class #{self} < Aid::Script
+          def self.help
+            <<-EOF
+            My awesome help message here.
+            This will be so useful for people.
+            EOF
+          end
+        end
+      HELP
+    end
+
+    def self.description
+      ''
+    end
+
+    def help
+      self.class.help
+    end
+
+    def description
+      self.class.description
+    end
+
+    attr_reader :argv
+
+    def initialize(*argv)
+      @argv = *argv
+    end
+
+    def self.run(*argv)
+      new(*argv).run
+    end
+
+    def run
+      raise NotImplementedError
+    end
+
+    def exit_code
+      0
+    end
+
+    def system!(*args)
+      puts colorize(:command, args.join(' '))
+      system(*args) || abort(colorize(:error, "\n== Command #{args} failed =="))
+    end
+
+    def step(name)
+      puts colorize(:info, "\n== #{name} ==")
+      yield if block_given?
+    end
+
+    def project_root
+      Aid.project_root
+    end
+
+    private
+
+    def aid_directory
+      './.aid'
+    end
+  end
+end