archer-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc91028877ce1f88f0b7a00d7ae59f560f54b810920b4b63182da896c9e3f763
+  data.tar.gz: adc85d772d7c4b8b8e603eb38d4980f7c1949cec7bbd610f21ade433f7f0a3cf
+SHA512:
+  metadata.gz: 865302453215cfbb7401227d7d00ef7ecd0afaee60b2d113e5bb0e2c713a5158938edbf91fd1569d40e943a75dbe9a91eb3f709cba8d57820dcc2dff0c72dcd3
+  data.tar.gz: 8029f6e80439966df685d4402f72d40366e1f97bdfe2ae4ea1580cbce6c69625bd47df7b90248c6db9d336772b58514fd6083285d27663577de3cb45235943f9

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Kane
+
+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,107 @@
+# Archer
+
+Rails console history for Heroku, Docker, and more
+
+![Screenshot](https://ankane.org/images/archer-readme.png)
+
+Designed for platforms with ephemeral filesystems
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'archer-rails'
+```
+
+And run:
+
+```sh
+rails generate archer:install
+rails db:migrate
+```
+
+Lastly, update your Gemfile to only include it in environments where you need it:
+
+```ruby
+gem 'archer-rails', group: [:production]
+```
+
+## How It Works
+
+Ruby stores console history in a file specified by:
+
+```ruby
+IRB.conf[:HISTORY_FILE]
+```
+
+This file gets lost on ephemeral filesystems. Instead, we store its contents in the database.
+
+## Users
+
+Each user can keep their own history. The user determined by `ENV["USER"]` by default. You can specify a user when starting the console with:
+
+```sh
+USER=andrew rails console
+```
+
+Confirm it worked with:
+
+```rb
+Archer.user
+```
+
+## Clearing History
+
+Clear history for current user with:
+
+```ruby
+Archer.clear
+```
+
+## Configuration
+
+Change the number of commands to remember
+
+```ruby
+Archer.limit = 200 # default
+```
+
+Change how the user is determined
+
+```ruby
+Archer.user = ENV["USER"] # default
+```
+
+## Platform Notes
+
+### Heroku
+
+For user-specific history, the command should follow this format:
+
+```sh
+heroku run USER=andrew rails console
+```
+
+Set up an [alias](https://shapeshed.com/unix-alias/) to save yourself some typing
+
+```sh
+alias hc="heroku run USER=andrew rails console"
+```
+
+### Dokku
+
+There’s no way to specify a user at the moment.
+
+## History
+
+View the [changelog](https://github.com/ankane/archer/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/archer/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/archer/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/lib/archer-rails.rb

@@ -0,0 +1 @@
+require "archer"

data/lib/archer.rb

@@ -0,0 +1,62 @@
+# dependencies
+require "active_support/core_ext/module/attribute_accessors"
+
+# modules
+require "archer/engine" if defined?(Rails)
+require "archer/version"
+
+module Archer
+  autoload :History, "archer/history"
+
+  mattr_accessor :limit
+  self.limit = 200
+
+  mattr_accessor :user
+  self.user = ENV["USER"]
+
+  mattr_accessor :history_file
+
+  def self.clear
+    quietly do
+      Archer::History.where(user: user).delete_all
+    end
+    Readline::HISTORY.clear rescue nil
+    true
+  end
+
+  def self.start
+    history = nil
+    begin
+      quietly do
+        history = Archer::History.where(user: user).first_or_initialize
+      end
+    rescue
+      warn "[archer] Create table to enable history"
+    end
+
+    if history && history.persisted?
+      File.write(history_file, history.commands)
+    end
+
+    require "irb/ext/save-history"
+    IRB.conf[:SAVE_HISTORY] = limit
+    IRB.conf[:HISTORY_FILE] = history_file
+  end
+
+  def self.save
+    quietly do
+      history = Archer::History.where(user: user).first_or_initialize
+      history.commands = File.read(history_file)
+      history.save
+    end
+  rescue
+    # do nothing
+  end
+
+  # private
+  def self.quietly
+    ActiveRecord::Base.logger.silence do
+      yield
+    end
+  end
+end

data/lib/archer/engine.rb

@@ -0,0 +1,12 @@
+module Archer
+  class Engine < Rails::Engine
+    console do
+      Archer.history_file ||= Rails.root.join("tmp", ".irb-history")
+      Archer.start
+
+      at_exit do
+        Archer.save
+      end
+    end
+  end
+end

data/lib/archer/history.rb

@@ -0,0 +1,5 @@
+module Archer
+  class History < ActiveRecord::Base
+    self.table_name = "archer_history"
+  end
+end

data/lib/archer/version.rb

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

data/lib/generators/archer/install_generator.rb

@@ -0,0 +1,38 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Archer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/create_archer_history.rb", migration_version: migration_version
+      end
+
+      def migration_version
+        if rails5?
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+
+      def rails5?
+        Rails::VERSION::MAJOR >= 5
+      end
+    end
+  end
+end

data/lib/generators/archer/templates/migration.rb.tt

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :archer_history do |t|
+      t.string :user
+      t.text :commands
+      t.timestamp :updated_at
+    end
+
+    add_index :archer_history, :user, unique: true
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: archer-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/archer-rails.rb
+- lib/archer.rb
+- lib/archer/engine.rb
+- lib/archer/history.rb
+- lib/archer/version.rb
+- lib/generators/archer/install_generator.rb
+- lib/generators/archer/templates/migration.rb.tt
+homepage: https://github.com/ankane/archer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Rails console history for Heroku, Docker, and more
+test_files: []