coals 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 056a13dacd6d3601df9d4d5463c3b3d07c1c7546
+  data.tar.gz: 18c965470c21a46be94e2fb7bab2215714529712
+SHA512:
+  metadata.gz: 0ffb9dc7bf0d80bacb02c24bc5867ee7b7ac770c9a68d6f1d9de8152b57d6d610943c36a6278f13b1b0094f46ac31fc34374360e875bf1edc787d50fc6d2d1ad
+  data.tar.gz: 0ba41a7eaf905fbb03c257a1affa8e30878e1c5776a2367be4bd82d553b6eb331832d69309ba6db30d493a61c8e2f08527860701f7658de551f69e8b05c005b9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.0.pre.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tasandberg@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    coals (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.10.3)
+    minitest-reporters (1.1.18)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.5.0)
+    ruby-progressbar (1.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  coals!
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.1.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0.pre.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tim Sandberg
+
+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,54 @@
+# Coals
+
+Built to ease the pain of navigating a large collection of rake tasks.  Simply type `coals` from a project root and
+coals will walk you through the available groups, tasks, and any necessary arguments to run the command.
+
+Features:
+* See all rake tasks in your project in an organized format.
+* Easily find the task you're looking for.
+* No need to dig through the code to recall what arguments a task requires
+* Verification step so you can see the fully constructed command before execution.
+* TODO: Configurable execution prefix (`bundle exec`(default), `zeus rake`, etc..)
+* TODO: Aliases for common task arguments, e.g.
+  ```
+  $ coals --set-alias me timmehs@github.com
+  Coals alias "me" set to timmehs@github.com
+  ```
+* TODO: Colors and Formatting
+* TODO: Command help docs
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coals'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coals
+
+## Usage
+
+From within a ruby project with a Rakefile, run `coals` and follow the prompts. ...
+```
+$ coals
+Available Task Groups
+1.  build (1)                     2.  clean (1)                     3.  clobber (1)                   4.  install (2)
+5.  release (1)                   6.  test (1)
+Choose an option:
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Timmehs/coals. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/coals

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'coals'
+
+Coals::RakeRunner.new.run

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coals"
+
+# 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/coals.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coals/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coals"
+  spec.version       = Coals::VERSION
+  spec.authors       = ["Tim Sandberg"]
+  spec.email         = ["tasandberg@gmail.com"]
+
+  spec.summary       = %q{An interactive rake task runner}
+  spec.description   = %q{
+    When run in a ruby project, Coals provides an interactive interface for calling rake tasks with the appropriate
+    arguments. Some features include:
+    * Setting the execution prefix of your choice, i.e. 'rake', 'bundle exec rake', 'bin/remote-rake development', etc.
+    * Set aliases for common values: `coals --alias me jimbo@springfield-high.edu`
+    * Review and confirm command before running.
+  }
+  spec.homepage      = "http://github.com/Timmehs/coals"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ['coals']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1.0"
+end

data/lib/coals.rb

@@ -0,0 +1,6 @@
+require "coals/version"
+
+require 'coals/menu'
+require 'coals/runner'
+require 'coals/task'
+require 'coals/menu'

data/lib/coals/menu.rb

@@ -0,0 +1,8 @@
+
+module Coals
+  class Menu
+    def initialize(options)
+      @options = options
+    end
+  end
+end

data/lib/coals/runner.rb

@@ -0,0 +1,94 @@
+DESCRIPTION_REGEX = /\s+#\s(.+)/
+COMMAND_REGEX = /rake (\S+)/
+ARGS_REGEX = /\S+\[(\S+)\]/
+
+module Coals
+  class RakeRunner
+    def initialize
+      @tasks = build_tasks
+      @full_command = nil
+      @task = nil
+      @group_key = nil
+      @confirmed = false
+    end
+
+    def run
+      until @group_key
+        groups_menu
+        entry = Integer(gets.chomp)
+        @group_key = @tasks.keys[entry - 1] if (1..(@tasks.keys.length)).member?(entry)
+        puts ""
+      end
+
+      until @task
+        command_menu
+        entry = Integer(gets.chomp)
+        @task = @tasks[@group_key][entry - 1]
+        puts ""
+      end
+
+      until @task.runnable?
+        arguments_menu
+      end
+
+      until @confirmed
+        puts 'REVIEW COMMAND'
+        puts @task.build_command
+        puts 'Run? (yes/no)'
+        entry = gets.chomp
+        @confirmed = entry == 'yes'
+        puts ""
+      end
+
+      puts `#{@task.build_command}`
+    rescue ArgumentError => e
+      if e.message =~ /invalid value for Integer\(\)/
+        puts 'Please enter a number'
+        run
+      else
+        raise e
+      end
+    end
+
+    private
+
+    def build_tasks
+      result = `bundle exec rake --tasks`
+      rows = result.split("\n")
+      rows.each_with_object({}) do |r, object|
+        task = Task.new(r)
+        if task.group
+          object[task.group] ||= []
+          object[task.group] << task
+        else
+          object[task.command] = [task]
+        end
+      end
+    end
+
+    def print_menu(options, title, width = 4)
+      menu = title
+      options.each_with_index do |option, i|
+        menu += "\n" if (i % width).zero?
+        menu += "#{i + 1}.".ljust(4) + option.ljust(30)
+      end
+      puts menu
+      puts 'Choose an option:'
+    end
+
+    def groups_menu
+      options = @tasks.keys.map { |group| "#{group} (#{@tasks[group].size})" }
+      print_menu(options, 'Available Task Groups')
+    end
+
+    def command_menu
+      menu_items = @tasks[@group_key].map(&:full_command)
+      print_menu(menu_items, "Available `#{@group_key}` Commands", 1)
+    end
+
+    def arguments_menu
+      desc = `zeus rake --describe #{@task.command}`.split("\n")[1].chomp
+      @task.arguments_prompt
+    end
+  end
+end

data/lib/coals/task.rb

@@ -0,0 +1,43 @@
+module Coals
+  class Task
+    attr_reader :full_command, :group, :command, :arguments
+
+    def initialize(row)
+      @full_command = COMMAND_REGEX.match(row).captures[0]
+      @command = @full_command.split('[')[0]
+      @group = /(\S+):/.match(@full_command) && /(\S+):/.match(@full_command).captures[0]
+      @arguments = args
+      @prefix = 'bundle exec rake'
+    end
+
+    def runnable?
+      !@arguments || @arguments.values.none?(&:nil?)
+    end
+
+    def build_command
+      raise 'Task not buildable' unless runnable?
+      argument_str = @arguments ? "[#{@arguments.values.join(',')}]" : ''
+      "#{@prefix} #{@command}#{argument_str}"
+    end
+
+    def args
+      args = ARGS_REGEX.match(full_command)
+      args && args.captures[0].split(',').each_with_object({}) { |arg_name, obj| obj[arg_name] = nil }
+    end
+
+    def get_argument(key)
+      puts "Enter #{key}:"
+      entry = gets.chomp
+      puts "\"#{entry}\" entered for #{key}."
+      @arguments[key] = entry
+    end
+
+    def arguments_prompt
+      until runnable?
+        @arguments.each do |arg_name, value|
+          get_argument(arg_name) if value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/coals/version.rb

@@ -0,0 +1,3 @@
+module Coals
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: coals
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Sandberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: "\n    When run in a ruby project, Coals provides an interactive interface
+  for calling rake tasks with the appropriate\n    arguments. Some features include:\n
+  \   * Setting the execution prefix of your choice, i.e. 'rake', 'bundle exec rake',
+  'bin/remote-rake development', etc.\n    * Set aliases for common values: `coals
+  --alias me jimbo@springfield-high.edu`\n    * Review and confirm command before
+  running.\n  "
+email:
+- tasandberg@gmail.com
+executables:
+- coals
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/coals
+- bin/console
+- bin/setup
+- coals.gemspec
+- lib/coals.rb
+- lib/coals/menu.rb
+- lib/coals/runner.rb
+- lib/coals/task.rb
+- lib/coals/version.rb
+homepage: http://github.com/Timmehs/coals
+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.5.2
+signing_key: 
+specification_version: 4
+summary: An interactive rake task runner
+test_files: []