rguidepost 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cd9964b0c1115b0b9f8fa37103d864b2b12000df4506f7b738f64b35b130cc1
+  data.tar.gz: 492b028b8cc1f8b2adf692736901d722a2dda8361208db40512f4a78d517dbf6
+SHA512:
+  metadata.gz: 42fc33f6299df1b027cbbeefbc848487156f464e4d20035a5264703d758a010587a53468af273389f134c9c1e50a1fc6bbdc8e65379ded78d1c7c08ba4cd6abe
+  data.tar.gz: 3f051eb1a355c01cd325752c35bccf2bb3b19a215055dac5defd441d89fd3a78556339f699fdbc5908e37b74eafc9425fb1a1afefc948b71739e19fa8618a099

data/.envrc.template

@@ -0,0 +1 @@
+export PATH=$PWD/bin:$PATH

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+.envrc
+/vendor/bundle/*
+/rguidepost.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 TODO: Write your email address. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.7
+
+RUN mkdir /app
+WORKDIR /app
+
+RUN bundle config --local path vendor/bundle

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rguidepost.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'tty-prompt'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    rguidepost (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    equatable (0.6.1)
+    necromancer (0.5.1)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    tty-color (0.5.1)
+    tty-cursor (0.7.1)
+    tty-prompt (0.21.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rguidepost!
+  rspec (~> 3.0)
+  tty-prompt
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,44 @@
+# Rguidepost
+
+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/rguidepost`. 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 'rguidepost'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rguidepost
+
+## 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/[USERNAME]/rguidepost. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rguidepost/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rguidepost project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rguidepost/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker-compose run --rm ruby "$@"

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/docker-compose.yml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+  ruby:
+    image: rguidpost
+    build: .
+    command: /bin/bash
+    volumes:
+      - .:/app
+      - ~/.ssh:/root/ssh
+    environment:
+      BUNDLE_APP_CONFIG: /app/.bundle

data/docker/bashrc

@@ -0,0 +1 @@
+alias be=bundle exec

data/exe/rguidepost

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rguidepost'
+
+Rguidepost.execute_repository_command

data/lib/rguidepost.rb

@@ -0,0 +1,40 @@
+require "rguidepost/version"
+require "tty-prompt"
+require 'yaml'
+require "open3"
+require_relative "./rguidepost/command"
+
+module Rguidepost
+  extend self
+
+  def read_commands
+    yaml = YAML.load_file('rguidepost.yml')
+    raise "rguidepost.yml is not hash." unless yaml.is_a? Hash
+    commands = yaml["commands"]
+    raise %q{rguidepost.yml doesn't have 'commands' key. } if commands.nil?
+
+    commands
+  end
+  
+  
+  def execute_repository_command
+    commands = read_commands
+
+    command = TTY::Prompt.new.select("repository commands:") do |menu|
+      commands.keys.each do |key|
+        menu.choice key, Command.new(commands, key)
+      end
+    end
+
+    success = command.execute
+    exit 1 unless success
+  rescue TTY::Reader::InputInterrupt => e
+    puts ""
+    puts "aborted."
+    exit 1
+  rescue => e
+    puts e.message
+    puts "aborted."
+    exit 1
+  end
+end

data/lib/rguidepost/command.rb

@@ -0,0 +1,44 @@
+module Rguidepost
+  class Command
+    def initialize(entire_data, command_key)
+      @entire_data = entire_data
+      command_data = @entire_data[command_key]
+      @command_string = command_data if command_data.is_a? String
+
+      if command_data.is_a? Hash
+        @command_string = command_data["command"]
+        @pre_command = Command.new(@entire_data, command_data["pre_command"]) unless command_data["pre_command"].nil?
+        @ignore_pre = command_data["ignore_pre"] || false
+        @post_command = Command.new(@entire_data, command_data["post_command"]) unless command_data["post_command"].nil?
+        @ensure_post = command_data["ensure_post"] || false
+      end
+
+      raise "#{command_key}: undefined command." if @command_string.nil? || @command_string == ""
+    end
+
+    def execute
+      unless @pre_command.nil?
+        success = @pre_command.execute
+        return false if !success && !@ignore_pre
+      end
+
+      status = execute_command(@command_string)
+
+      return status.success? if @post_command.nil?
+      return false if !status.success? && !@ensure_post
+
+      success = @post_command.execute
+      success
+    end
+
+    private
+
+    def execute_command command
+      Open3.popen3(%Q{bash -lc "#{command}"}) do |stdin, stdout, stderr, wait_thread|
+        stdout.each { |line| puts line }
+        stderr.each { |line| puts line }
+        wait_thread.value
+      end
+    end
+  end
+end

data/lib/rguidepost/version.rb

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

data/rguidepost.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/rguidepost/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rguidepost"
+  spec.version       = Rguidepost::VERSION
+  spec.authors       = ["ryokkkke"]
+  spec.email         = ["rrrtechrrr@gmail.com"]
+
+  spec.summary       = %q{Guidepost that indicates useful commands to developers of a repository.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/ryokkkke/rguidepost"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ryokkkke/rguidepost"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/templates/rguidepost.yml

@@ -0,0 +1,9 @@
+commands:
+  "ruby version": ruby -v
+  "echo done message": echo "done!"
+  "bundle install":
+    pre_command: ruby version
+    ignore_pre: true
+    command: bundle install
+    post_command: echo done message
+    ensure_post: true

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rguidepost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryokkkke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- rrrtechrrr@gmail.com
+executables:
+- rguidepost
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc.template"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/druby
+- bin/setup
+- docker-compose.yml
+- docker/bashrc
+- exe/rguidepost
+- lib/rguidepost.rb
+- lib/rguidepost/command.rb
+- lib/rguidepost/version.rb
+- rguidepost.gemspec
+- templates/rguidepost.yml
+homepage: https://github.com/ryokkkke/rguidepost
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ryokkkke/rguidepost
+  source_code_uri: https://github.com/ryokkkke/rguidepost
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Guidepost that indicates useful commands to developers of a repository.
+test_files: []