coals 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 056a13dacd6d3601df9d4d5463c3b3d07c1c7546
4
- data.tar.gz: 18c965470c21a46be94e2fb7bab2215714529712
3
+ metadata.gz: 01f1688712a9394ae8b879d9cb1014e4a1421087
4
+ data.tar.gz: 4cdc0de54f1d3676f5ff78a4f92905144b37ebf5
5
5
  SHA512:
6
- metadata.gz: 0ffb9dc7bf0d80bacb02c24bc5867ee7b7ac770c9a68d6f1d9de8152b57d6d610943c36a6278f13b1b0094f46ac31fc34374360e875bf1edc787d50fc6d2d1ad
7
- data.tar.gz: 0ba41a7eaf905fbb03c257a1affa8e30878e1c5776a2367be4bd82d553b6eb331832d69309ba6db30d493a61c8e2f08527860701f7658de551f69e8b05c005b9
6
+ metadata.gz: 1ff68725edaa6faf6cf499f6e59011b456f68bfe966955f6053508a9ce79c027f5b803e83b806ced05fbe298f346d35603c1c4b71e246c8e17facb10949eb89e
7
+ data.tar.gz: 55fe269ebe3fdd3ca4dc953f94bdffe6ee09ea3ed4293480fcae682442bccd9cd384c39ee929fad0690428d9c1a564a842cbdf29de202c09dea71ef49aca5c24
@@ -1,6 +1,6 @@
1
- require "coals/version"
2
-
1
+ require 'coals/version'
2
+ require 'coals/highlight'
3
3
  require 'coals/menu'
4
+ require 'coals/prompt'
5
+ require 'coals/task_tree'
4
6
  require 'coals/runner'
5
- require 'coals/task'
6
- require 'coals/menu'
@@ -0,0 +1,37 @@
1
+ module Coals
2
+ COLORS = {
3
+ BLACK: 30,
4
+ RED: 31,
5
+ GREEN: 32,
6
+ BROWN: 33,
7
+ BLUE: 34,
8
+ MAGENTA: 35,
9
+ CYAN: 36,
10
+ GRAY: 37,
11
+ BG_BLACK: 40,
12
+ BG_RED: 41,
13
+ BG_GREEN: 42,
14
+ BG_BROWN: 43,
15
+ BG_BLUE: 44,
16
+ BG_MAGENTA: 45,
17
+ BG_CYAN: 46,
18
+ BG_GRAY: 47,
19
+ BOLD: 1,
20
+ ITALIC: 3,
21
+ UNDERLINE: 4
22
+ }.freeze
23
+
24
+ module Highlight
25
+ refine String do
26
+ def colorize(code)
27
+ "\033[#{code}m#{self}\033[0m"
28
+ end
29
+
30
+ COLORS.each do |color_name, code|
31
+ define_method color_name.downcase.to_sym do
32
+ colorize(code)
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -1,8 +1,56 @@
1
-
2
1
  module Coals
3
2
  class Menu
4
- def initialize(options)
3
+ using Coals::Highlight
4
+ attr_reader :selection
5
+
6
+ # Show a menu of options in a loop until the user makes a selection.
7
+ # Return the selection value
8
+ #
9
+ # @param menu {Array} - list of options to choose from
10
+ def initialize(options:, prompt: nil, title: '')
11
+ @select = nil
5
12
  @options = options
13
+ @title = title
14
+ @prompt = prompt
15
+ show_menu until @selection
16
+ end
17
+
18
+ private
19
+
20
+ def show_menu
21
+ menu = "\nCOALS -- #{@title}\n".brown
22
+ menu += format_menu_options
23
+ println menu
24
+ integer_input
25
+ end
26
+
27
+ def integer_input
28
+ print "\nChoose an option: ".bold
29
+ option_index = raw_input.to_i - 1
30
+ @selection = @options.values[option_index]
31
+ end
32
+
33
+ def raw_input
34
+ input = $stdin.gets.chomp
35
+ input =~ /quit|exit|q/ ? abort('Goodbye 👋') : input
36
+ end
37
+
38
+ def println(str)
39
+ $stdout.puts str
40
+ end
41
+
42
+ def print(str)
43
+ $stdout.print str
44
+ end
45
+
46
+ def min_column_width
47
+ @options.keys.max_by(&:length).length
48
+ end
49
+
50
+ def format_menu_options
51
+ @options.keys.each_with_index.inject('') do |result, (option, i)|
52
+ result + "\n#{i + 1}.".ljust(4) + option.ljust(30)
53
+ end
6
54
  end
7
55
  end
8
56
  end
@@ -0,0 +1,7 @@
1
+ module Coals
2
+ module Prompt
3
+ def capture_selection(title: '', options:, prompt: '')
4
+ Coals::Menu.new(title: title, options: options, prompt: prompt).selection
5
+ end
6
+ end
7
+ end
@@ -1,94 +1,89 @@
1
- DESCRIPTION_REGEX = /\s+#\s(.+)/
2
- COMMAND_REGEX = /rake (\S+)/
3
- ARGS_REGEX = /\S+\[(\S+)\]/
4
-
5
1
  module Coals
6
2
  class RakeRunner
3
+ include Coals::Prompt
4
+ include Coals::TaskTree
5
+
7
6
  def initialize
8
- @tasks = build_tasks
7
+ @tasks = task_tree
9
8
  @full_command = nil
10
9
  @task = nil
10
+ @task_arguments = {}
11
11
  @group_key = nil
12
12
  @confirmed = false
13
13
  end
14
14
 
15
+ # TODO: Some cascading condition set such that user can back up or go forward by 1 step
15
16
  def run
16
- until @group_key
17
- groups_menu
18
- entry = Integer(gets.chomp)
19
- @group_key = @tasks.keys[entry - 1] if (1..(@tasks.keys.length)).member?(entry)
20
- puts ""
21
- end
17
+ until @confirmed
18
+ @namespace = capture_selection(
19
+ title: 'Avalable Task Groups:',
20
+ options: build_namespace_options
21
+ )
22
22
 
23
- until @task
24
- command_menu
25
- entry = Integer(gets.chomp)
26
- @task = @tasks[@group_key][entry - 1]
27
- puts ""
28
- end
23
+ @task = capture_selection(
24
+ title: "Available '#{@namespace}' commands:",
25
+ options: build_task_options
26
+ )
29
27
 
30
- until @task.runnable?
31
- arguments_menu
32
- end
28
+ unless @task.arg_names.empty?
29
+ @task_arguments = @task.arg_names.each_with_object({}) { |arg, obj| obj[arg] = nil }
30
+ capture_task_arguments while @task_arguments.values.any?(&:nil?)
31
+ end
33
32
 
34
- until @confirmed
35
- puts 'REVIEW COMMAND'
36
- puts @task.build_command
37
- puts 'Run? (yes/no)'
38
- entry = gets.chomp
39
- @confirmed = entry == 'yes'
40
- puts ""
33
+ @confirmed = capture_confirmation
41
34
  end
42
35
 
43
- puts `#{@task.build_command}`
44
- rescue ArgumentError => e
45
- if e.message =~ /invalid value for Integer\(\)/
46
- puts 'Please enter a number'
47
- run
48
- else
49
- raise e
50
- end
36
+ # Invoke ensures that prerequirement tasks like rails :environment are run first.
37
+ @task.invoke(*@task_arguments.values)
51
38
  end
52
39
 
53
40
  private
54
41
 
55
- def build_tasks
56
- result = `bundle exec rake --tasks`
57
- rows = result.split("\n")
58
- rows.each_with_object({}) do |r, object|
59
- task = Task.new(r)
60
- if task.group
61
- object[task.group] ||= []
62
- object[task.group] << task
63
- else
64
- object[task.command] = [task]
65
- end
42
+ def groups_menu
43
+ options = @tasks.keys.map { |group| "#{group} (#{@tasks[group].size})" }
44
+ print_menu(options, 'Available Task Groups')
45
+ end
46
+
47
+ def build_namespace_options
48
+ @tasks.each_with_object({}) do |(group, tasks), options|
49
+ options["#{group} (#{tasks.length})".ljust(55)] = group
66
50
  end
67
51
  end
68
52
 
69
- def print_menu(options, title, width = 4)
70
- menu = title
71
- options.each_with_index do |option, i|
72
- menu += "\n" if (i % width).zero?
73
- menu += "#{i + 1}.".ljust(4) + option.ljust(30)
53
+ def capture_task_arguments
54
+ @task_arguments.select { |_, v| v.nil? }.each_key do |arg_name|
55
+ input = ''
56
+ while input.empty?
57
+ print "\nRake task '#{@task.name_with_args}'\nEnter #{arg_name}: "
58
+ input = gets.chomp
59
+ end
60
+ @task_arguments[arg_name] = input
74
61
  end
75
- puts menu
76
- puts 'Choose an option:'
77
62
  end
78
63
 
79
- def groups_menu
80
- options = @tasks.keys.map { |group| "#{group} (#{@tasks[group].size})" }
81
- print_menu(options, 'Available Task Groups')
64
+ def capture_confirmation
65
+ input = nil
66
+
67
+ until /y|yes|n|no/ =~ input
68
+ task_string = "rake #{@task.name}"
69
+ task_string += "[#{@task_arguments.values.join(',')}]" if @task_arguments.size.positive?
70
+ puts 'Execute rake task? (y/n)'
71
+ puts " #{task_string}"
72
+ input = gets.chomp.downcase
73
+ end
74
+
75
+ !!(/y|yes/ =~ input)
82
76
  end
83
77
 
84
- def command_menu
85
- menu_items = @tasks[@group_key].map(&:full_command)
86
- print_menu(menu_items, "Available `#{@group_key}` Commands", 1)
78
+ def subtasks
79
+ @tasks[@namespace]
87
80
  end
88
81
 
89
- def arguments_menu
90
- desc = `zeus rake --describe #{@task.command}`.split("\n")[1].chomp
91
- @task.arguments_prompt
82
+ def build_task_options
83
+ subtasks.each_with_object({}) do |task, options|
84
+ label = task.name_with_args.to_s.ljust(30) + '# ' + task.comment
85
+ options[label] = task
86
+ end
92
87
  end
93
88
  end
94
89
  end
@@ -0,0 +1,33 @@
1
+ require 'rake'
2
+
3
+ module Rake
4
+ class Task
5
+ def namespace
6
+ name.split(':')[0]
7
+ end
8
+ end
9
+ end
10
+
11
+
12
+ module Coals
13
+ module TaskTree
14
+ def task_tree
15
+ @_task_tree ||= build_tasks.each_with_object(Hash.new { |h, k| h[k] = [] }) do |task, tree|
16
+ tree[task.namespace] << task
17
+ end
18
+ end
19
+
20
+ # Coals assumes that any task lacking a description
21
+ # is not meant to be called directly, i.e. a 'subtask'
22
+ # This is in line with the list rendered by `rake -T`
23
+ def build_tasks
24
+ load_rakefile
25
+ Rake.application.tasks.reject { |t| t.comment.nil? }
26
+ end
27
+
28
+ def load_rakefile
29
+ Rake::TaskManager.record_task_metadata = true
30
+ load 'Rakefile'
31
+ end
32
+ end
33
+ end
@@ -1,3 +1,3 @@
1
1
  module Coals
2
- VERSION = "0.1.0"
2
+ VERSION = '0.1.1'.freeze
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: coals
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tim Sandberg
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-11-20 00:00:00.000000000 Z
11
+ date: 2018-02-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -16,14 +16,70 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 1.16.a
19
+ version: 1.16.1
20
20
  type: :development
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 1.16.a
26
+ version: 1.16.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: guard
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: guard-rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.11.3
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.11.3
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry-byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 3.5.1
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 3.5.1
27
83
  - !ruby/object:Gem::Dependency
28
84
  name: rake
29
85
  requirement: !ruby/object:Gem::Requirement
@@ -39,33 +95,47 @@ dependencies:
39
95
  - !ruby/object:Gem::Version
40
96
  version: '10.0'
41
97
  - !ruby/object:Gem::Dependency
42
- name: minitest
98
+ name: rspec
43
99
  requirement: !ruby/object:Gem::Requirement
44
100
  requirements:
45
101
  - - "~>"
46
102
  - !ruby/object:Gem::Version
47
- version: '5.0'
103
+ version: 3.7.0
48
104
  type: :development
49
105
  prerelease: false
50
106
  version_requirements: !ruby/object:Gem::Requirement
51
107
  requirements:
52
108
  - - "~>"
53
109
  - !ruby/object:Gem::Version
54
- version: '5.0'
110
+ version: 3.7.0
55
111
  - !ruby/object:Gem::Dependency
56
- name: minitest-reporters
112
+ name: rubocop
57
113
  requirement: !ruby/object:Gem::Requirement
58
114
  requirements:
59
- - - "~>"
115
+ - - ">="
60
116
  - !ruby/object:Gem::Version
61
- version: 1.1.0
117
+ version: '0'
62
118
  type: :development
63
119
  prerelease: false
64
120
  version_requirements: !ruby/object:Gem::Requirement
65
121
  requirements:
66
- - - "~>"
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rubocop-rspec
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
67
137
  - !ruby/object:Gem::Version
68
- version: 1.1.0
138
+ version: '0'
69
139
  description: "\n When run in a ruby project, Coals provides an interactive interface
70
140
  for calling rake tasks with the appropriate\n arguments. Some features include:\n
71
141
  \ * Setting the execution prefix of your choice, i.e. 'rake', 'bundle exec rake',
@@ -79,22 +149,13 @@ executables:
79
149
  extensions: []
80
150
  extra_rdoc_files: []
81
151
  files:
82
- - ".gitignore"
83
- - ".travis.yml"
84
- - CODE_OF_CONDUCT.md
85
- - Gemfile
86
- - Gemfile.lock
87
- - LICENSE.txt
88
- - README.md
89
- - Rakefile
90
152
  - bin/coals
91
- - bin/console
92
- - bin/setup
93
- - coals.gemspec
94
153
  - lib/coals.rb
154
+ - lib/coals/highlight.rb
95
155
  - lib/coals/menu.rb
156
+ - lib/coals/prompt.rb
96
157
  - lib/coals/runner.rb
97
- - lib/coals/task.rb
158
+ - lib/coals/task_tree.rb
98
159
  - lib/coals/version.rb
99
160
  homepage: http://github.com/Timmehs/coals
100
161
  licenses:
data/.gitignore DELETED
@@ -1,8 +0,0 @@
1
- /.bundle/
2
- /.yardoc
3
- /_yardoc/
4
- /coverage/
5
- /doc/
6
- /pkg/
7
- /spec/reports/
8
- /tmp/
@@ -1,5 +0,0 @@
1
- sudo: false
2
- language: ruby
3
- rvm:
4
- - 2.3.4
5
- before_install: gem install bundler -v 1.16.0.pre.3
@@ -1,74 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as
6
- contributors and maintainers pledge to making participation in our project and
7
- our community a harassment-free experience for everyone, regardless of age, body
8
- size, disability, ethnicity, gender identity and expression, level of experience,
9
- nationality, personal appearance, race, religion, or sexual identity and
10
- orientation.
11
-
12
- ## Our Standards
13
-
14
- Examples of behavior that contributes to creating a positive environment
15
- include:
16
-
17
- * Using welcoming and inclusive language
18
- * Being respectful of differing viewpoints and experiences
19
- * Gracefully accepting constructive criticism
20
- * Focusing on what is best for the community
21
- * Showing empathy towards other community members
22
-
23
- Examples of unacceptable behavior by participants include:
24
-
25
- * The use of sexualized language or imagery and unwelcome sexual attention or
26
- advances
27
- * Trolling, insulting/derogatory comments, and personal or political attacks
28
- * Public or private harassment
29
- * Publishing others' private information, such as a physical or electronic
30
- address, without explicit permission
31
- * Other conduct which could reasonably be considered inappropriate in a
32
- professional setting
33
-
34
- ## Our Responsibilities
35
-
36
- Project maintainers are responsible for clarifying the standards of acceptable
37
- behavior and are expected to take appropriate and fair corrective action in
38
- response to any instances of unacceptable behavior.
39
-
40
- Project maintainers have the right and responsibility to remove, edit, or
41
- reject comments, commits, code, wiki edits, issues, and other contributions
42
- that are not aligned to this Code of Conduct, or to ban temporarily or
43
- permanently any contributor for other behaviors that they deem inappropriate,
44
- threatening, offensive, or harmful.
45
-
46
- ## Scope
47
-
48
- This Code of Conduct applies both within project spaces and in public spaces
49
- when an individual is representing the project or its community. Examples of
50
- representing a project or community include using an official project e-mail
51
- address, posting via an official social media account, or acting as an appointed
52
- representative at an online or offline event. Representation of a project may be
53
- further defined and clarified by project maintainers.
54
-
55
- ## Enforcement
56
-
57
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
- reported by contacting the project team at tasandberg@gmail.com. All
59
- complaints will be reviewed and investigated and will result in a response that
60
- is deemed necessary and appropriate to the circumstances. The project team is
61
- obligated to maintain confidentiality with regard to the reporter of an incident.
62
- Further details of specific enforcement policies may be posted separately.
63
-
64
- Project maintainers who do not follow or enforce the Code of Conduct in good
65
- faith may face temporary or permanent repercussions as determined by other
66
- members of the project's leadership.
67
-
68
- ## Attribution
69
-
70
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
- available at [http://contributor-covenant.org/version/1/4][version]
72
-
73
- [homepage]: http://contributor-covenant.org
74
- [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile DELETED
@@ -1,6 +0,0 @@
1
- source "https://rubygems.org"
2
-
3
- git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
-
5
- # Specify your gem's dependencies in coals.gemspec
6
- gemspec
@@ -1,31 +0,0 @@
1
- PATH
2
- remote: .
3
- specs:
4
- coals (0.1.0)
5
-
6
- GEM
7
- remote: https://rubygems.org/
8
- specs:
9
- ansi (1.5.0)
10
- builder (3.2.3)
11
- minitest (5.10.3)
12
- minitest-reporters (1.1.18)
13
- ansi
14
- builder
15
- minitest (>= 5.0)
16
- ruby-progressbar
17
- rake (10.5.0)
18
- ruby-progressbar (1.9.0)
19
-
20
- PLATFORMS
21
- ruby
22
-
23
- DEPENDENCIES
24
- bundler (~> 1.16.a)
25
- coals!
26
- minitest (~> 5.0)
27
- minitest-reporters (~> 1.1.0)
28
- rake (~> 10.0)
29
-
30
- BUNDLED WITH
31
- 1.16.0.pre.3
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2017 Tim Sandberg
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
data/README.md DELETED
@@ -1,54 +0,0 @@
1
- # Coals
2
-
3
- Built to ease the pain of navigating a large collection of rake tasks. Simply type `coals` from a project root and
4
- coals will walk you through the available groups, tasks, and any necessary arguments to run the command.
5
-
6
- Features:
7
- * See all rake tasks in your project in an organized format.
8
- * Easily find the task you're looking for.
9
- * No need to dig through the code to recall what arguments a task requires
10
- * Verification step so you can see the fully constructed command before execution.
11
- * TODO: Configurable execution prefix (`bundle exec`(default), `zeus rake`, etc..)
12
- * TODO: Aliases for common task arguments, e.g.
13
- ```
14
- $ coals --set-alias me timmehs@github.com
15
- Coals alias "me" set to timmehs@github.com
16
- ```
17
- * TODO: Colors and Formatting
18
- * TODO: Command help docs
19
-
20
-
21
- ## Installation
22
-
23
- Add this line to your application's Gemfile:
24
-
25
- ```ruby
26
- gem 'coals'
27
- ```
28
-
29
- And then execute:
30
-
31
- $ bundle
32
-
33
- Or install it yourself as:
34
-
35
- $ gem install coals
36
-
37
- ## Usage
38
-
39
- From within a ruby project with a Rakefile, run `coals` and follow the prompts. ...
40
- ```
41
- $ coals
42
- Available Task Groups
43
- 1. build (1) 2. clean (1) 3. clobber (1) 4. install (2)
44
- 5. release (1) 6. test (1)
45
- Choose an option:
46
- ```
47
-
48
- ## Contributing
49
-
50
- 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.
51
-
52
- ## License
53
-
54
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile DELETED
@@ -1,10 +0,0 @@
1
- require "bundler/gem_tasks"
2
- require "rake/testtask"
3
-
4
- Rake::TestTask.new(:test) do |t|
5
- t.libs << "test"
6
- t.libs << "lib"
7
- t.test_files = FileList["test/**/*_test.rb"]
8
- end
9
-
10
- task :default => :test
@@ -1,14 +0,0 @@
1
- #!/usr/bin/env ruby
2
-
3
- require "bundler/setup"
4
- require "coals"
5
-
6
- # You can add fixtures and/or initialization code here to make experimenting
7
- # with your gem easier. You can also use a different console, if you like.
8
-
9
- # (If you use this, don't forget to add pry to your Gemfile!)
10
- # require "pry"
11
- # Pry.start
12
-
13
- require "irb"
14
- IRB.start(__FILE__)
data/bin/setup DELETED
@@ -1,8 +0,0 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here
@@ -1,34 +0,0 @@
1
-
2
- lib = File.expand_path("../lib", __FILE__)
3
- $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
- require "coals/version"
5
-
6
- Gem::Specification.new do |spec|
7
- spec.name = "coals"
8
- spec.version = Coals::VERSION
9
- spec.authors = ["Tim Sandberg"]
10
- spec.email = ["tasandberg@gmail.com"]
11
-
12
- spec.summary = %q{An interactive rake task runner}
13
- spec.description = %q{
14
- When run in a ruby project, Coals provides an interactive interface for calling rake tasks with the appropriate
15
- arguments. Some features include:
16
- * Setting the execution prefix of your choice, i.e. 'rake', 'bundle exec rake', 'bin/remote-rake development', etc.
17
- * Set aliases for common values: `coals --alias me jimbo@springfield-high.edu`
18
- * Review and confirm command before running.
19
- }
20
- spec.homepage = "http://github.com/Timmehs/coals"
21
- spec.license = "MIT"
22
-
23
- spec.files = `git ls-files -z`.split("\x0").reject do |f|
24
- f.match(%r{^(test|spec|features)/})
25
- end
26
- spec.bindir = "bin"
27
- spec.executables = ['coals']
28
- spec.require_paths = ["lib"]
29
-
30
- spec.add_development_dependency "bundler", "~> 1.16.a"
31
- spec.add_development_dependency "rake", "~> 10.0"
32
- spec.add_development_dependency "minitest", "~> 5.0"
33
- spec.add_development_dependency "minitest-reporters", "~> 1.1.0"
34
- end
@@ -1,43 +0,0 @@
1
- module Coals
2
- class Task
3
- attr_reader :full_command, :group, :command, :arguments
4
-
5
- def initialize(row)
6
- @full_command = COMMAND_REGEX.match(row).captures[0]
7
- @command = @full_command.split('[')[0]
8
- @group = /(\S+):/.match(@full_command) && /(\S+):/.match(@full_command).captures[0]
9
- @arguments = args
10
- @prefix = 'bundle exec rake'
11
- end
12
-
13
- def runnable?
14
- !@arguments || @arguments.values.none?(&:nil?)
15
- end
16
-
17
- def build_command
18
- raise 'Task not buildable' unless runnable?
19
- argument_str = @arguments ? "[#{@arguments.values.join(',')}]" : ''
20
- "#{@prefix} #{@command}#{argument_str}"
21
- end
22
-
23
- def args
24
- args = ARGS_REGEX.match(full_command)
25
- args && args.captures[0].split(',').each_with_object({}) { |arg_name, obj| obj[arg_name] = nil }
26
- end
27
-
28
- def get_argument(key)
29
- puts "Enter #{key}:"
30
- entry = gets.chomp
31
- puts "\"#{entry}\" entered for #{key}."
32
- @arguments[key] = entry
33
- end
34
-
35
- def arguments_prompt
36
- until runnable?
37
- @arguments.each do |arg_name, value|
38
- get_argument(arg_name) if value.nil?
39
- end
40
- end
41
- end
42
- end
43
- end