archer-rails 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83355041e7d4db676c39d7578272e2ad5b1f485a1d3ce93f19c0ecf997afc270
-  data.tar.gz: 6dbafdf30bdd43a6866b25f137f3e9c23218d6f756b7f1e31a37f07cf321f5b2
+  metadata.gz: 19712b8bc5685ad3770bb596c00281b60ea6c394ec3a748c2874121660d1d90f
+  data.tar.gz: 2470e42aa3128bac2e2c59994a0aab8a8bfb04e9887bac37d951dd294e4a1004
 SHA512:
-  metadata.gz: 2b4638dcf53e8b2fc7883a992ae5a2234406298ebd7cb2a8d3a4eaf78e06fb81eb80cc7c892b7f8996c4785e7b60a55b702d85655587f4ee4989c7bff4f72f25
-  data.tar.gz: 4e2da0efaa2218f940ec22d62ef20d5f0747a1b5e63fe15189860306013cbb736440b96bec783d4774bdf5e5886218d908faaaeb60bf2ac5ae1be500a994456d
+  metadata.gz: 14bb6c24f59394f76688c4eb75698d6d340a600e04c44f96f5214406cc7489fba74d68c3c4d5e953774915875f535eb2cbce3453f2a664d954308c4625c1395e
+  data.tar.gz: 9809857aa33df6b242f104845e1eaa43185e79c28c4177ed7cc6de08750ca0e097cd44c853124b873ea7d1d65aea6b6a343c11d21dc132a8609831a53a6f0f95

data/CHANGELOG.md

@@ -1,7 +1,25 @@
-## 0.1.1
+## 0.2.3 (2021-08-03)
+
+- Added `save_session` option
+
+## 0.2.2 (2021-01-07)
+
+- Fixed issue with Reline detection
+
+## 0.2.1 (2020-11-23)
+
+- Fixed issue with not loading history
+- Use `datetime` type in migration
+
+## 0.2.0 (2020-04-09)
+
+- Added support for Reline
+- Dropped support for Rails 4.2
+
+## 0.1.1 (2018-10-23)
 
 - Fixed issue with not loading history on Heroku
 
-## 0.1.0
+## 0.1.0 (2018-10-23)
 
 - First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Andrew Kane
+Copyright (c) 2018-2020 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

data/README.md

@@ -53,6 +53,14 @@ Archer.user
 
 ## Clearing History
 
+Disable saving history for the current session with:
+
+```ruby
+Archer.save_session = false
+```
+
+You should do this when running sensitive commands.
+
 Clear history for current user with:
 
 ```ruby
@@ -105,3 +113,11 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/archer/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/archer.git
+cd archer
+bundle install
+```

data/lib/archer.rb

@@ -3,6 +3,7 @@ require "active_support/core_ext/module/attribute_accessors"
 
 # modules
 require "archer/engine" if defined?(Rails)
+require "archer/irb"
 require "archer/version"
 
 module Archer
@@ -14,13 +15,18 @@ module Archer
   mattr_accessor :user
   self.user = ENV["USER"]
 
+  mattr_accessor :save_session
+  self.save_session = true
+
+  # TODO remove in 0.3.0
   mattr_accessor :history_file
 
   def self.clear
     quietly do
       Archer::History.where(user: user).delete_all
     end
-    Readline::HISTORY.clear
+    Readline::HISTORY.clear if defined?(Readline)
+    Reline::HISTORY.clear if defined?(Reline)
     true
   end
 
@@ -35,20 +41,34 @@ module Archer
     end
 
     if history
-      Readline::HISTORY.push(*history.commands.split("\n"))
+      commands = history.commands.split("\n")
+      history_object.push(*commands)
     end
   end
 
   def self.save
     quietly do
       history = Archer::History.where(user: user).first_or_initialize
-      history.commands = Readline::HISTORY.to_a.last(limit).join("\n")
-      history.save
+      history.commands = history_object.to_a.last(limit).join("\n")
+      history.save!
     end
   rescue ActiveRecord::StatementInvalid
     warn "[archer] Unable to save history"
   end
 
+  # private
+  # TODO use IRB.CurrentContext.io.class::HISTORY
+  def self.history_object
+    reline? ? Reline::HISTORY : Readline::HISTORY
+  end
+
+  # private
+  def self.reline?
+    IRB.CurrentContext.io.is_a?(IRB::ReidlineInputMethod)
+  rescue
+    false
+  end
+
   # private
   def self.quietly
     ActiveRecord::Base.logger.silence do

data/lib/archer/engine.rb

@@ -1,11 +1,14 @@
 module Archer
   class Engine < Rails::Engine
     console do
+      # TODO remove in 0.3.0
       Archer.history_file ||= Rails.root.join("tmp", ".irb-history")
-      Archer.start
+
+      # need IRB context to be ready before Archer.start
+      ::IRB::Irb.prepend(Archer::Irb)
 
       at_exit do
-        Archer.save
+        Archer.save if Archer.save_session
       end
     end
   end

data/lib/archer/irb.rb

@@ -0,0 +1,9 @@
+module Archer
+  module Irb
+    # needs to run after conf[:MAIN_CONTEXT] is set
+    def eval_input(*)
+      Archer.start
+      super
+    end
+  end
+end

data/lib/archer/version.rb

@@ -1,3 +1,3 @@
 module Archer
-  VERSION = "0.1.1"
+  VERSION = "0.2.3"
 end

data/lib/generators/archer/install_generator.rb

@@ -1,37 +1,17 @@
-# 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
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       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
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

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

@@ -3,7 +3,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     create_table :archer_history do |t|
       t.string :user
       t.text :commands
-      t.timestamp :updated_at
+      t.datetime :updated_at
     end
 
     add_index :archer_history, :user, unique: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archer-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,57 +16,29 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord
   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
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '5'
+description:
 email: andrew@chartkick.com
 executables: []
 extensions: []
@@ -79,6 +51,7 @@ files:
 - lib/archer.rb
 - lib/archer/engine.rb
 - lib/archer/history.rb
+- lib/archer/irb.rb
 - lib/archer/version.rb
 - lib/generators/archer/install_generator.rb
 - lib/generators/archer/templates/migration.rb.tt
@@ -86,7 +59,7 @@ homepage: https://github.com/ankane/archer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,16 +67,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Rails console history for Heroku, Docker, and more
 test_files: []