every_day_irb 1.6.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d213edb00033e0945f696b6b22820889a55edb55
-  data.tar.gz: f3cc5ff284fee3d19a725a47c99cc9f72cbd423d
+SHA256:
+  metadata.gz: 63b54ae5658ab766b9b11309684504b8fa40ed1ba8514d20c7794c90cb73275f
+  data.tar.gz: 2f9f355a588e94980e8e7186e5f9ad789b1ddc3ca7ff1f8fba3ef9759c521e95
 SHA512:
-  metadata.gz: ddbc9d0eff3e565f736651a7389d8d082b6b19f58841a8a41d538eb7813320640324dcb4a8e79664f7a9e161503cd7d2ce09707c91afaa3dd7ea3f7806308c21
-  data.tar.gz: 7d2d5e644edfa86bef52abb304e3f07217afa5aecb9327cf069c28632bb5480feeadc2b2b0b69011608ec2ff37a8011d1039df29726a4a61eb846c25067996d6
+  metadata.gz: f379ad16388abc35a36015bc6ee219ce67b1d8725728378e992c4a519aae1a960bef10aa21b0f4fd07a0525111f989802b299c5a98d898968c7f795a24238558
+  data.tar.gz: e23d016a3c95d27830522ffdd6248fa05ac746fadbb0940231bc53f9c2e06257c93b185cf246fb3094bd4eccbade1a2ecac43cb16705a5d537ca580b2bae3391

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/pkg

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+
+rvm:
+- 2.6
+- 2.5
+- 2.4
+- 2.3
+- ruby-head
+- jruby-9.2.6.0
+- truffleruby
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: truffleruby
+    - rvm: 2.3
+#   fast_finish: true

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## CHANGELOG
+
+### 2.1.1
+
+- Loosen Ruby dependency to allow Ruby 3.0
+
+### 2.1.0
+
+- Separate every_day_irb into its own git repository
+  - No code changes
+
+### 2.0.0
+
+- Separate every_day_irb's release cycle from irbtool release cycle
+- Move cd enhancements into cd microgem on which every_day_irb depends
+- You must extend EveryDayIrb explicitly, does not happen on require, anymore
+- Add rr for require_relative

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 opensource@janlelis.com. 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,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rspec", "~> 3.2"
+gem "rake"

data/{LICENSE → MIT-LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2014 Jan Lelis
+Copyright (c) 2010-2020 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,38 @@
+# Every day… IRB [![[version]](https://badge.fury.io/rb/every_day_irb.svg)](https://badge.fury.io/rb/every_day_irb)  [![[travis]](https://travis-ci.org/janlelis/every_day_irb.svg)](https://travis-ci.org/janlelis/every_day_irb)
+
+Provides utility methods useful in IRB, like a `rq` method for requiring libraries, or `ls` for showing the list of files of the current directory. Part of [Irbtools](https://irb.tools).
+
+## Setup
+
+Add to your `Gemfile`:
+
+```ruby
+gem "every_day_irb"
+```
+
+## Usage
+
+Execute this:
+
+```ruby
+extend EveryDayIrb
+```
+
+to get the following methods:
+
+- ls(path = '.')
+- cd(path = nil)
+- cat(path)
+- rq(lib)
+- rr(lib)
+- ld(lib)
+- rerequire(lib)
+- clear
+- reset!
+- session_history(number_of_lines = nil)
+
+More info at the [Irbtools README](https://github.com/janlelis/irbtools#irbtools-methods) and in the [specs](https://github.com/janlelis/every_day_irb/blob/master/spec/every_day_irb_spec.rb).
+
+## MIT License
+
+Copyright (C) 2010-2020 Jan Lelis <https://janlelis.com>. Released under the MIT license.

data/Rakefile

@@ -0,0 +1,41 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir["*.gemspec"].first
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+
+# # #
+# Start an IRB session with the gem loaded
+
+desc "#{gemspec.name} | IRB"
+task :irb do
+  sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
+end
+
+# # #
+# Run specs
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--backtrace --color'
+end
+
+task default: :spec
+
+

data/every_day_irb.gemspec

@@ -1,18 +1,22 @@
 # -*- encoding: utf-8 -*-
-require File.dirname(__FILE__) + '/lib/irbtools/configure'
 
-Gem::Specification.new do |s|
-  s.name = 'every_day_irb'
-  s.version = Irbtools::VERSION
+require File.dirname(__FILE__) + "/lib/every_day_irb/version"
 
-  s.authors               = ["Jan Lelis"]
-  s.summary               = 'every_day_irb defines helper methods that simplify life in irb.'
-  s.description           = 'every_day_irb defines helper methods that simplify life in irb.: ls, cat, rq, rrq, ld, session_history, reset!, clear, ...'
-  s.email                 = 'mail@janlelis.de'
-  s.extra_rdoc_files      = %w[LICENSE]
-  s.files                 = Dir.glob(%w[lib/every_day_irb.rb every_day_irb.gemspec])
-  s.homepage              = 'http://github.com/janlelis/irbtools'
-  s.required_ruby_version = '>= 1.8.7'
-  s.license               = 'MIT'
-  s.add_development_dependency %q<rspec>
+Gem::Specification.new do |gem|
+  gem.name          = "every_day_irb"
+  gem.version       = EveryDayIrb::VERSION
+  gem.summary       = "EveryDayIrb simplifies daily life in IRB."
+  gem.description   = "EveryDayIrb simplifies daily life in IRB with commands like: ls, cat, rq, rrq, ld, reset!, ..."
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["hi@ruby.consulting"]
+  gem.homepage      = "https://irb.tools"
+  gem.license       = "MIT"
+
+  gem.files         = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^pkg/ }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.0", "< 4.0"
+  gem.add_dependency 'cd', '~> 1.0'
 end

data/lib/every_day_irb.rb

@@ -1,16 +1,20 @@
-# every_day_irb defines some helper methods that might be useful in every-day irb usage
+require_relative 'every_day_irb/version'
 
-module EveryDayIrb
-  VERSION = "1.6.1"
+require 'cd'
 
+module EveryDayIrb
   extend self
   private
 
   # shows the contents of your current directory (more such commands available by FileUtils)
-  def ls(path='.')
-    Dir[ File.join( path, '*' )].map{|filename| File.basename filename }
+  def ls(path = '.')
+    Cd.cd.ls(path)
+  end
+
+  # patch cd so that it also shows the current directory and got some extras
+  def cd(path = nil)
+    Cd.cd(path)
   end
-  alias dir ls
 
   # read file contents (also see ray for ruby source files ;) )
   def cat(path)
@@ -22,6 +26,11 @@ module EveryDayIrb
     require lib.to_s
   end
 
+  # same for require relative
+  def rr(lib)
+    require_relative lib.to_s
+  end
+
   # load shortcut, not suited for non-rb
   def ld(lib)
     load lib.to_s + '.rb'
@@ -40,11 +49,16 @@ module EveryDayIrb
   end
   alias rrq rerequire
 
+  # just clear the screen
+  def clear
+    system 'clear'
+  end
+
   # restart irb
   def reset!
     # remember history...
-    reset_irb = proc{ exec$0 }
-    if defined?(Ripl) && Ripl.respond_to?(:started?) && Ripl.started?
+    reset_irb = proc{ exec $0 }
+    if defined?(Ripl) && Ripl.started?
       Ripl.shell.write_history if Ripl.shell.respond_to? :write_history
       reset_irb.call
     else
@@ -53,15 +67,10 @@ module EveryDayIrb
     end
   end
 
-  # just clear the screen
-  def clear
-    system 'clear'
-  end
-
-  # returns the last lines, needed for some copy_ methods
+  # returns the last lines
   def session_history(number_of_lines = nil)
     if !number_of_lines
-      if defined?(Ripl) && Ripl.respond_to?(:started?) && Ripl.started?
+      if defined?(Ripl) && Ripl.started?
         number_of_lines = Ripl.shell.line
       else
         number_of_lines = context.instance_variable_get(:@line_no)
@@ -70,7 +79,3 @@ module EveryDayIrb
     Readline::HISTORY.entries[-number_of_lines...-1]*"\n"
   end
 end
-
-include EveryDayIrb
-
-# J-_-L

data/lib/every_day_irb/version.rb

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

data/spec/every_day_irb_spec.rb

@@ -0,0 +1,126 @@
+require_relative '../lib/every_day_irb'
+
+require 'fileutils'
+
+describe EveryDayIrb do
+  include EveryDayIrb
+
+  let(:filename){ __FILE__ }
+  let(:filename_without_rb){ filename.sub(/\.rb$/, '') }
+  let(:path){ File.dirname(filename) + '/..' }
+
+  describe '#ls' do
+    it 'returns an array' do
+      expect( ls ).to be_a Array
+    end
+
+    context '[no args]' do
+      it 'calls Dir["./*"] to get the list of all files in the current dir' do
+        res = Dir['./*']
+        expect( Dir ).to receive(:[]).with('./*').and_return(res)
+
+        ls
+      end
+    end
+
+    context 'one arg' do
+      it 'calls Dir["#{path}/*"] to get the list of all files of the given path' do
+        res = Dir["#{path}/*"]
+        expect( Dir ).to receive(:[]).with("#{path}/*").and_return(res)
+
+        ls(path)
+      end
+    end
+  end
+
+  describe "#cd" do
+    it 'returns an array' do
+      expect( ls ).to be_a Array
+    end
+
+    it 'requests FileUtils to change the directory' do
+      expect( FileUtils::Verbose ).to receive(:cd).with("/")
+
+      cd "/"
+    end
+  end
+
+  describe '#cat' do
+    it 'returns a String' do
+      expect( cat(filename) ).to be_a String
+    end
+
+    it 'calls File.read(path)' do
+      expect( File ).to receive(:read).with(filename)
+
+      cat(filename)
+    end
+  end
+
+  describe '#rq' do
+    it 'calls require with the arg' do
+      expect( self ).to receive(:require).with('rbconfig')
+
+      rq 'rbconfig'
+    end
+
+    it 'calls to_s on the arg' do
+      expect( self ).to receive(:require).with('rbconfig')
+
+      rq:rbconfig
+    end
+  end
+
+  describe '#rr' do
+    it 'calls require_re with the arg' do
+      expect( self ).to receive(:require_relative).with('something').and_return(nil)
+
+      rr 'something'
+    end
+
+    it 'calls to_s on the arg' do
+      expect( self ).to receive(:require_relative).with('something').and_return(nil)
+
+      rr:something
+    end
+  end
+
+  describe '#ld' do
+    it 'calls load with the arg, but appends ".rb"' do
+      expect( self ).to receive(:load).with(filename)
+
+      ld filename_without_rb
+    end
+
+    it 'calls to_s on the arg' do
+      expect( self ).to receive(:load).with(filename)
+
+      ld filename_without_rb.to_sym
+    end
+  end
+
+  describe '#rerequire' do
+    it 'requires a library a second time' do
+      first_time = require 'abbrev'
+      second_time = rerequire 'abbrev'
+
+      expect( second_time ).to be true
+    end
+  end
+
+  describe '#clear' do
+    it "calls the system's clear command" do
+      expect( self ).to receive(:system).with('clear')
+
+      clear
+    end
+  end
+
+  describe '#reset!' do
+    pending
+  end
+
+  describe '#session_history' do
+    pending
+  end
+end

metadata

@@ -1,41 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: every_day_irb
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2020-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: cd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 'every_day_irb defines helper methods that simplify life in irb.: ls,
-  cat, rq, rrq, ld, session_history, reset!, clear, ...'
-email: mail@janlelis.de
+        version: '1.0'
+description: 'EveryDayIrb simplifies daily life in IRB with commands like: ls, cat,
+  rq, rrq, ld, reset!, ...'
+email:
+- hi@ruby.consulting
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
+extra_rdoc_files: []
 files:
-- LICENSE
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
 - every_day_irb.gemspec
 - lib/every_day_irb.rb
-homepage: http://github.com/janlelis/irbtools
+- lib/every_day_irb/version.rb
+- spec/every_day_irb_spec.rb
+homepage: https://irb.tools
 licenses:
 - MIT
 metadata: {}
@@ -47,16 +57,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '2.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: every_day_irb defines helper methods that simplify life in irb.
-test_files: []
+summary: EveryDayIrb simplifies daily life in IRB.
+test_files:
+- spec/every_day_irb_spec.rb