pry-janitor 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32ce27be1a29f991cf6bb348c2103211549396fe4617efbe452f784324ec88e5
+  data.tar.gz: 1227aa2510a61987878ca399be09ebe6a7f3ff2e41e1107a1cd7f392f445f2a5
+SHA512:
+  metadata.gz: 2f2c0aa2d7088a01af5ca24ab4727cd67f35bc92da04f4dc861d25e62cc3aa994ffa707aec6ee8e186d9c92c4a17c1451cf50b18e862faf7a5e5a601317e3ea9
+  data.tar.gz: c5983ff8c34ae7630b2d87daec756d31544e11e62bbf98b6cd1cafa8636d4e2f45f973229736132aad322ed27d147bd982666c427f155b677fbbb09bec07b31d

data/.gitignore

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

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 tony@angel.co. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pry-janitor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    pry-janitor (0.1.4)
+      pry (~> 0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry-janitor!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tony
+
+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,48 @@
+# pry-janitor
+
+:knife: Kill idle `pry` sessions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pry-janitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pry-janitor
+
+## Usage
+
+Production rails consoles will automatically exit after 2 hours of inactivity.
+
+To configure the gem for other consoles or to re-configure the gem for production rails consoles run:
+
+```ruby
+# kill pry session after one hour
+PryJanitor.auto_exit_after(60 * 60)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/venturehacks/pry-janitor. 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).
+
+## Code of Conduct
+
+Everyone interacting in the pry-janitor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pry-janitor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pry-janitor'
+
+# 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.
+
+require 'pry'
+Pry.start

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/lib/pry-janitor.rb

@@ -0,0 +1,102 @@
+require 'pry-janitor/version'
+require 'singleton'
+require 'pry'
+
+class PryJanitor
+  include Singleton
+
+  CHECK_ACTIVITY_SECONDS = 60
+  DEFAULT_TIMEOUT_SECONDS = 60 * 60 * 2
+  PRY_HOOK_NAME = :pry_janitor
+
+  ACTIVITY_SIGNAL = 'USR1'.freeze
+  PAUSE_SIGNAL = 'USR2'.freeze
+  KILL_SIGNAL = 'TERM'.freeze
+  EXIT_SIGNAL = 'EXIT'.freeze
+
+  def self.auto_exit_after(timeout = DEFAULT_TIMEOUT_SECONDS)
+    instance.auto_exit_after(timeout)
+  end
+
+  def self.register_pry_hooks
+    instance.register_pry_hooks
+  end
+
+  def auto_exit_after(timeout)
+    kill_child
+    with_install_handlers do
+      @parent_pid = Process.pid
+      @child_pid = Process.fork { child_process(timeout) }
+    end
+    kill_child_on_exit
+  end
+
+  def register_pry_hooks
+    # pause last activity for long running commands
+    Pry.hooks.add_hook(:before_eval, PRY_HOOK_NAME) do
+      signal_child(PAUSE_SIGNAL)
+    end
+
+    # record activity when a command finishes, line is read, or session starts
+    Pry.hooks.add_hook(:after_eval, PRY_HOOK_NAME) do
+      signal_child(ACTIVITY_SIGNAL)
+    end
+
+    Pry.hooks.add_hook(:after_read, PRY_HOOK_NAME) do
+      signal_child(ACTIVITY_SIGNAL)
+    end
+
+    Pry.hooks.add_hook(:before_session, PRY_HOOK_NAME) do
+      signal_child(ACTIVITY_SIGNAL)
+    end
+  end
+
+  private
+
+  # 1. install signal handlers in the parent so the child is immediately ready
+  # 2. re-install pre-existing signal handlers back into the parent
+  def with_install_handlers
+    prev_sig1 = Signal.trap(ACTIVITY_SIGNAL) { @last_activity = Time.now }
+    prev_sig2 = Signal.trap(PAUSE_SIGNAL) { @last_activity = nil }
+    yield
+    Signal.trap(ACTIVITY_SIGNAL, prev_sig1)
+    Signal.trap(PAUSE_SIGNAL, prev_sig2)
+  end
+
+  def child_process(timeout)
+    loop do
+      begin
+        # kill parent and exit loop if last activity is longer than timeout
+        if @last_activity && @last_activity < Time.now - timeout
+          Process.kill(KILL_SIGNAL, @parent_pid)
+        end
+        sleep CHECK_ACTIVITY_SECONDS
+      rescue Interrupt
+        # parent exited, exit loop
+        break
+      end
+    end
+  end
+
+  def signal_child(signal)
+    Process.kill(signal, @child_pid) if @child_pid
+  end
+
+  def kill_child
+    signal_child(KILL_SIGNAL)
+  end
+
+  def kill_child_on_exit
+    Signal.trap(EXIT_SIGNAL) { kill_child }
+  end
+end
+
+# need to register the hooks before pry starts
+PryJanitor.register_pry_hooks
+
+# auto exit if production rails console
+if defined?(Rails)
+  prod = Rails.env.production?
+  console = Rails.const_defined?('Console')
+  PryJanitor.auto_exit_after if prod && console
+end

data/lib/pry-janitor/version.rb

@@ -0,0 +1,3 @@
+class PryJanitor
+  VERSION = '0.1.4'.freeze
+end

data/pry-janitor.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pry-janitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pry-janitor'
+  spec.version       = PryJanitor::VERSION
+  spec.authors       = ['Tony']
+  spec.email         = ['tony@angel.co']
+
+  spec.summary       = '🔪 Kill idle pry sessions'
+  spec.description   = 'Production rails consoles will automatically exit after 2 hours of inactivity.'
+  spec.homepage      = 'https://github.com/venturehacks/pry-janitor'
+  spec.license       = 'MIT'
+
+  # 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 { |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_dependency 'pry', '~> 0.11'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: pry-janitor
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Tony
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Production rails consoles will automatically exit after 2 hours of inactivity.
+email:
+- tony@angel.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pry-janitor.rb
+- lib/pry-janitor/version.rb
+- pry-janitor.gemspec
+homepage: https://github.com/venturehacks/pry-janitor
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: "\U0001F52A Kill idle pry sessions"
+test_files: []