mini_readline 0.6.5 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de25a37c0b75ebcb2e6e8edbcc0e7bfb08aaa863
-  data.tar.gz: b842f03c9f0804b79ee9254bf7d623a06536e111
+  metadata.gz: ceacc828df705967b25a0f557c94851e37eb2453
+  data.tar.gz: 166a205727e1be37dbdcbc451e3541e44477e81c
 SHA512:
-  metadata.gz: 8c9a5d664a358812295f1358f21c6857abd02204f94d9b0c317636da9d11a506c868e1822887774cf6bb88e8524986898d01d5af9258ddc51530872aacb71692
-  data.tar.gz: 294db641b431ea5a069441332405185cc89ae771ca74115d4dad71e88213f31d6508c41c9a65bebdf261d8d503742e73184ac622601c7845c45ccccb26e235cc
+  metadata.gz: 8f4a068c51f1c7e9db78e75f9274537726d4fe37e003106a6651d4536de01ecbd117f10e7fa4c7ab0cfc6121738bc4067ab6aeedccf2f710bc57c91da0d00ea0
+  data.tar.gz: 5541574214dbfa7d6b68908287022e8fb6aeae0ed80d361b2de3ac588ae7b244dd50c01b2328f89eb1f4756f6297141c4e4b645abb272d768034294bebe1856e

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -41,7 +41,7 @@ The mini_readline gem supports a simple set of editing commands. These vary
 somewhat based on the system platform. The keyboard mappings (and alias
 mappings) are listed below:
 
-Editor Action    | Windows Key                      | Other Key
+Editor Action    | Windows Key                      | Mac/Linux Key
 -----------------|----------------------------------|------------
 Enter            | Enter                            | Enter
 Left             | Left Arrow, Pad Left             | Left Arrow, Ctrl-B
@@ -61,9 +61,8 @@ Auto-complete    | Tab, Ctrl-I                      | Tab, Ctrl-I
 End of Input     | Ctrl-Z                           | Alt-z
 
 ### Notes
-* The label "Other" is an umbrella that bundles together the Linux, Mac,
-and Cygwin platforms.
-* On "Other" systems lacking an Alt key, these sequences may be
+* The label "Mac/Linux" also includes the Cygwin platform.
+* On "Mac/Linux" systems lacking an Alt key, these sequences may be
 replaced by Escape followed by the appropriate letter.
 * References to Pad keys under Windows assume that Num Lock is not engaged.
 * Support for End of Input is controlled by the eoi_detect option. See options
@@ -103,7 +102,8 @@ also be accomplished with the command:
 ### Compatible Mode
 
 In compatible mode, mini_readline tries to be somewhat compatible with the
-classic system readline facility. Here is this compatible mode in action with
+classic system readline facility. This means that MiniReadline module methods
+are used to obtain user input. Here is this compatible mode in action with
 entry history enabled:
 
 ```ruby
@@ -111,8 +111,13 @@ MiniReadline.readline('>', true)
 ```
 and with entry history disabled:
 ```ruby
+MiniReadline.readline('>')
+```
+or
+```ruby
 MiniReadline.readline('>', false)
 ```
+
 Where the string argument is the prompt seen by the user and the flag controls
 the history buffer. Use true to enable history and false to disable it.
 
@@ -130,9 +135,9 @@ can be accomplished with these options settings.
 
 ##### Module Aliasing [Deprecated]
 
-For enhanced compatibility, the mini_readline gem has the ability to alias
-itself as the readline gem. When this feature is used, compatible code is even
-more compatible looking:
+In an attempt to enhance compatibility, the mini_readline gem has the ability
+to alias itself as the readline gem. When this feature is used, compatible code
+is even more compatible looking:
 ```ruby
 Readline.readline('>', true)
 ```
@@ -193,7 +198,7 @@ feature to go away by version 0.7.0 unless some feedback is received.**
 In native mode, instances of the Readline class are used to get user input.
 
 ```ruby
-edit = MiniReadline::Readline.new()
+edit = MiniReadline::Readline.new
 ```
 
 The constructor takes an optional argument. A hash of options that are used

data/lib/mini_readline.rb

@@ -32,6 +32,10 @@ module MiniReadline
 
 end
 
+if defined?($force_alias_read_line_module) && $force_alias_read_line_module
+  warn "mini_readline: $force_alias_read_line_module is deprecated."
+end
+
 #Optionally: Setup the module alias for Readline
 begin
   old_stderr = $stderr

data/lib/mini_readline/version.rb

@@ -1,4 +1,4 @@
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.6.5"
+  VERSION = "0.6.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.7
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2016-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -80,6 +80,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md