aid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d410aaa006c361b0a2def56ab77ed4e4cbb7e7f
+  data.tar.gz: cbe5fbe9a404339b9da151f7c09e30e654993308
+SHA512:
+  metadata.gz: dd862dbea28b6ec45c838178cbe17d34b2c8d7034cb9b0ec6c8fd507646a2ebcfeafbd788172bf3669b0c69e32ae7cadb0dd70fb02ccd280554cc83e974d17fc
+  data.tar.gz: bfd5c74b562d001a650a39dbbc4c79004ef153a58fa157b4362835f5a64578b84738d9c97f60a7311ca7f333caebd858f2110a6f8c0912833f96f3f6528193a6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.aide
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) do |repo_name|
+  "https://github.com/#{repo_name}"
+end
+
+# Specify your gem's dependencies in aide.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Balatero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Aide
+
+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/aide`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aide'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aide
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dbalatero/aide.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aid.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "aid"
+  spec.version       = Aid::VERSION
+  spec.authors       = ["David Balatero"]
+  spec.email         = ["dbalatero@gmail.com"]
+
+  spec.summary       = %q{A library to make repo scripts easy and discoverable.}
+  spec.homepage      = "https://github.com/dbalatero/aid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aide"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/aid

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/aid"
+
+Aid.load_scripts!
+
+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,32 @@
+require_relative "aid/version"
+
+module Aid
+  def self.load_paths
+    @load_paths ||= [
+      File.expand_path(File.dirname(__FILE__) + "/aid/scripts"),
+      ".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)
+      end
+    end
+  end
+
+  def self.script_name
+    ARGV.first
+  end
+
+  def self.script_args
+    ARGV[1..-1]
+  end
+end
+
+require_relative "aid/colorize"
+require_relative "aid/inheritable"
+require_relative "aid/script"
+require_relative "aid/scripts"

data/lib/aid/colorize.rb

@@ -0,0 +1,39 @@
+module Aid::Colorize
+  extend self
+
+  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,
+  }
+
+  def colorize(color, string)
+    "\e[#{COLOR_CODES[color]}m#{string}\e[0m"
+  end
+end

data/lib/aid/inheritable.rb

@@ -0,0 +1,35 @@
+module Aid
+  module Inheritable
+    def self.included(klass)
+      klass.instance_eval do
+        extend ClassMethods
+
+        def self.inherited(subklass)
+          self.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.reduce(Hash.new) do |result, klass|
+          result[klass.name] = klass
+          result
+        end
+      end
+    end
+  end
+end

data/lib/aid/script.rb

@@ -0,0 +1,70 @@
+module Aid
+  class Script
+    include Aid::Colorize
+    include Aid::Inheritable
+
+    def self.name
+      klass_name = self.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
+
+    attr_reader :argv
+
+    def initialize(*argv)
+      @argv = *argv
+    end
+
+    def self.run(*argv)
+      new(*argv).run
+    end
+
+    def run
+      raise NotImplementedError
+    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
+
+    private
+
+    def aid_directory
+      "./.aid"
+    end
+  end
+end

data/lib/aid/scripts.rb

@@ -0,0 +1,4 @@
+module Aid
+  module Scripts
+  end
+end

data/lib/aid/scripts/help.rb

@@ -0,0 +1,57 @@
+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
+
+        names_and_descriptions = Aid::Script.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 "  %-#{padding}s %s" % [name, description]
+        end
+
+        puts
+      end
+    end
+  end
+end

data/lib/aid/scripts/init.rb

@@ -0,0 +1,19 @@
+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,84 @@
+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.gsub(/-/, "_")}.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
+      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,3 @@
+module Aid
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: aid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Balatero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-01 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- dbalatero@gmail.com
+executables:
+- aid
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aid.gemspec
+- bin/console
+- bin/setup
+- exe/aid
+- lib/aid.rb
+- lib/aid/colorize.rb
+- lib/aid/inheritable.rb
+- lib/aid/script.rb
+- lib/aid/scripts.rb
+- lib/aid/scripts/help.rb
+- lib/aid/scripts/init.rb
+- lib/aid/scripts/new.rb
+- lib/aid/version.rb
+homepage: https://github.com/dbalatero/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.6.11
+signing_key: 
+specification_version: 4
+summary: A library to make repo scripts easy and discoverable.
+test_files: []