keepgoing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14820183bb25ef55e7878bbe1ce3fdf6c87bafc64a71102d8462a67f4eae927e
+  data.tar.gz: 0fbbf1c8ed8c9383a5089e56309f458d2d56dc28af7969a500108c53650110d6
+SHA512:
+  metadata.gz: a163e5125850e0665485309151b5d642fb164fe75928307d5c1b59ab390b4bee2a1ee4dc4f3ba5bbee1eea46e3101fc786a304bffa0e270c77a8ba70610b31e0
+  data.tar.gz: ffbd4e5f2876f85a2aa22111afa91c00b9048111cd7d372a747be65bbb3552c2a569d3070011daa754bcacec398371489073d730f1375fa142f5c501260f6a9d

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-05-11
+
+- Initial release of keepgoing, my first gem ever 🎉

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at me@wolfgangrittner.dev. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in keepgoing.gemspec
+gemspec
+
+# A make-like build utility for Ruby
+gem "rake", "~> 13.0"
+
+# Ruby Style Guide, with linter & automatic code fixer
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    keepgoing (0.1.0)
+      guard (~> 2.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    standard (1.11.0)
+      rubocop (= 1.28.2)
+      rubocop-performance (= 1.13.3)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  keepgoing!
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Wolfgang Rittner
+
+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,49 @@
+# Keepgoing
+
+keepgoing uses [guard](https://github.com/guard/guard) to tighten the feedback loop on your single-file Ruby script that uses [bundler/inline](https://bundler.io/guides/bundler_in_a_single_file_ruby_script.html).  
+When added as a gem to your script, it will run your script once when started like you are used to, but it won't exit and rather keep it going and re-run it every time you modify your script. You keep tinkering and once you save your script runs again and you 💥 immediately see the result 🤯.
+
+## bundler/inline
+When trying out things with Ruby, and maybe a new Ruby gem or [even full blown Rails](https://christoph.luppri.ch/single-file-rails-applications-for-fun-and-bug-reporting), an awesome way to do this is using "bundler/inline".  
+It allows you to put a whole application including a "gemfile" into a single-file Ruby script, which gives you a quick feedback loop and allows you to share the whole thing as one self-contained file.
+
+## automate > manual
+It would be great if we could tighten things up even more and supercharge the feedback loop by combining bundler/inline with guard auto-run.  
+I was wondering if guard could be inlined into that single-file Ruby script as well, and set up to execute that single file whenever it changed. This would allow us to start things up once, then keep editing and see results immediately.  
+Turns out you can, meet keepgoing!
+
+
+## Usage
+
+Example Ruby single-file script:
+```ruby:test.rb
+require "bundler/inline"
+
+gemfile do
+  source "https://rubygems.org"
+  gem "keepgoing"
+end
+
+puts "Woohoo"
+```
+
+When you run this script in a terminal with `ruby test.rb`, it will execute like it would without keepgoing, printing out "Woohoo".  
+But you'll notice it won't exit back to your terminal prompt. If you go back to your editor and change something, say add another `puts` and save, you'll notice it gets executed again and you see the results of your edit right away.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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 the created tag, 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/wolfgangrittner/keepgoing. 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/wolfgangrittner/keepgoing/blob/main/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 Keepgoing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wolfgangrittner/keepgoing/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+
+task default: :standard

data/keepgoing.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/keepgoing/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "keepgoing"
+  spec.version = Keepgoing::VERSION
+  spec.authors = ["Wolfgang Rittner"]
+  spec.email = ["me@wolfgangrittner.dev"]
+
+  spec.summary = "Supercharge your ruby script with auto-run on save."
+  spec.description = <<~DESC
+    This gem is intended for use in a single file Ruby script that uses bundler/inline.
+    You start your script once with `ruby your-script.rb` and keepgoing will take control,
+    and re-run you script every time you save your script.
+    You can concentrate on tinkering, while keepgoing will, well keep going,
+    providing you with a fast and effortless feedback loop for your ruby experiments.
+  DESC
+  spec.homepage = "https://github.com/wolfgangrittner/keepgoing"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wolfgangrittner/keepgoing"
+  spec.metadata["changelog_uri"] = "https://github.com/wolfgangrittner/keepgoing/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "guard", "~> 2.18"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/guard/keepgoing.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ::Guard
+  # Guard plugin for keepgoing, which will `load` the file it is given as an option,
+  # on start and on modification.
+  class Keepgoing < Plugin
+    attr_reader :runs
+
+    def initialize(options = {})
+      puts options
+      opts = options.dup
+      @runs = 0
+      super(opts) # important to call + avoid passing options Guard doesn't understand
+    end
+
+    def start
+      @runs = 1
+      puts "Hi! I'll keepgoing until you press Ctrl+C. Just edit and save away, you can do this 🎉\n\n"
+      run_all
+    end
+
+    def run_all
+      do_run
+    end
+
+    def run_on_modifications(_paths)
+      puts "Press Ctrl+C to quit keepgoing. Just edit and save away, you can do this 🎉\n\n"
+      do_run
+    end
+
+    private
+
+    def do_run
+      @runs += 1
+      load options[:file]
+    rescue ScriptError, StandardError => e
+      # prevent any script errors from stopping guard/keepgoing, but print error
+      puts e.inspect
+    end
+  end
+end

data/lib/keepgoing/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Keepgoing
+  VERSION = "0.1.0"
+end

data/lib/keepgoing.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "keepgoing/version"
+
+require "guard"
+require "guard/commander" # needed because of https://github.com/guard/guard/issues/793
+require_relative "guard/keepgoing"
+
+# keepgoing's core, that keeps things going
+module Keepgoing
+  # The .start method will start up Guard using .guardfile as configuration.
+  # This mehtod is idempotent, it will start guard only once on the first call.
+  # If guard is already active, it will do nothing.
+  def self.start
+    return if Guard.state
+
+    Guard::UI.level = :warn
+    Guard.start(guardfile_contents: guardfile)
+
+    exit
+  end
+
+  # @private
+  def self.script_file
+    $PROGRAM_NAME
+  end
+
+  # @private
+  def self.guardfile
+    <<~GUARDFILE
+      clearing :on
+      interactor :off
+      guard "keepgoing", file: "#{script_file}" do
+        watch("#{script_file}")
+      end
+    GUARDFILE
+  end
+end
+
+# Automatically start keepgoing
+Keepgoing.start

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: keepgoing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wolfgang Rittner
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+description: |
+  This gem is intended for use in a single file Ruby script that uses bundler/inline.
+  You start your script once with `ruby your-script.rb` and keepgoing will take control,
+  and re-run you script every time you save your script.
+  You can concentrate on tinkering, while keepgoing will, well keep going,
+  providing you with a fast and effortless feedback loop for your ruby experiments.
+email:
+- me@wolfgangrittner.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- keepgoing.gemspec
+- lib/guard/keepgoing.rb
+- lib/keepgoing.rb
+- lib/keepgoing/version.rb
+homepage: https://github.com/wolfgangrittner/keepgoing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wolfgangrittner/keepgoing
+  source_code_uri: https://github.com/wolfgangrittner/keepgoing
+  changelog_uri: https://github.com/wolfgangrittner/keepgoing/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Supercharge your ruby script with auto-run on save.
+test_files: []