rib 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a52587cf79d9a191c020346fa3ba53bd5fc12b2
-  data.tar.gz: 522742f98cf7356531ae48892815444978971b31
+  metadata.gz: 71f4bd09ed661c3e6344b4370d4611ed34e230ce
+  data.tar.gz: 036e0c2191ac6edac8ef36465474d22347519e90
 SHA512:
-  metadata.gz: be4aed6f46a7a7c73f6713885903d0ed8309a6265bcece16c7dafa1539660c0571735f9b5464dc3435df5692c0a8b4c7603bace1eb7727b132d589f7443fb5f4
-  data.tar.gz: dcbbaadd88bed8fae8508e13840d908a82851a630d05d35e93d7d065bf698d4b5a995cec68ee940489f3e8b1e102142c61e1643cea1958441adcb35c5c4ae06b
+  metadata.gz: c40b597bbe06db537996568524f21f17789db421e6a15dbc9f269057003f7f037d4d2f3ad38f92ed1d7678cd373f5c5aabbedf8a0a749e94cab8190af23363e3
+  data.tar.gz: 74934c6bf5916c62ad455cde90a4abe3bc6aa72cd57c9a5792b749a0fb0cb65d516b9bc757db14af656116b4f099033b84489b91c87a69edba1c9fcea48105fa

data/CHANGES.md

@@ -1,5 +1,16 @@
 # CHANGES
 
+## Rib 1.2.2 -- 2014-01-23
+
+* From now on, we support project specific config file located on
+  "./.rib/config.rb". Note that if there's a project specific config file,
+  your home config would not be loaded at all. The history file would also
+  be put into "./.rib/history.rb". You might want to ignore it from your
+  repository to avoid leaking confidential information.
+
+* [extra/paging] Now we strip ANSI sequences before calculating if we need
+  a pager. This should make it much more accurate.
+
 ## Rib 1.2.1 -- 2014-01-18
 
 * Fixed a bug where it cannot properly elegantly handle errors when loading

data/lib/rib.rb

@@ -8,6 +8,8 @@ module Rib
   module_function
   # All default Rib configs, would be passed to Shell.new in Rib.shell,
   # but calling Shell.new directly won't bring this in.
+  #
+  # @api public
   def config
     @config ||= {:config => File.join(home, 'config.rb'), :name => 'rib'}
   end
@@ -22,10 +24,15 @@ module Rib
     @vars   ||= {}
   end
 
-  # Rib.home is where Rib storing things
+  # Rib.home is where Rib storing things. By default, it goes to '~/.rib',
+  # or somewhere containing a 'config.rb' or 'history.rb' in the order of
+  # './.rib' (project specific config), or '~/.rib' (home config), or
+  # '~/.config/rib' (home config, residing in ~/.config)
+  #
+  # @api public
   def home
     ENV['RIB_HOME'] ||= begin
-      ['~/.rib', '~/.config/rib'].find{ |path|
+      ['./.rib', '~/.rib', '~/.config/rib'].find{ |path|
         p = File.expand_path(path)
         File.exist?(File.join(p, 'config.rb')) ||
         File.exist?(File.join(p, 'history.rb'))
@@ -34,8 +41,10 @@ module Rib
   end
 
   # Convenient shell accessor, which would just give you current last shell
-  # or create one and load ~/.config/rib/config.rb if non has existed. If you
-  # need a clean shell which does not load rc file, use Shell.new instead.
+  # or create one and load the config file. If you need a clean shell which
+  # does not load config file, use Shell.new instead.
+  #
+  # @api public
   def shell
     shells.last || begin
       require_config if config_path
@@ -45,24 +54,34 @@ module Rib
 
   # All plugins which have been loaded into the memory regardless
   # it's enabled or not.
+  #
+  # @api public
   def plugins
     Shell.ancestors[1..-1].select{ |a| a.singleton_class < Plugin }
   end
 
   # Convenient way to disable all plugins in the memory.
   # This could also take a list of plugins and disable them.
+  #
+  # @api public
+  # @param plugs [Array] (Rib.plugins) Plugins which would be disabled.
   def disable_plugins plugs=plugins
     plugs.each(&:disable)
   end
 
   # Convenient way to enable all plugins in the memory.
   # This could also take a list of plugins and enable them.
+  #
+  # @api public
+  # @param plugs [Array] (Rib.plugins) Plugins which would be enabled.
   def enable_plugins plugs=plugins
     plugs.each(&:enable)
   end
 
-  # Load (actually require) ~/.config/rib/config.rb if exists.
+  # Load (actually require) the config file if it exists.
   # This might emit warnings if there's some error while loading it.
+  #
+  # @api public
   def require_config
     return unless config_path
     result = require(config_path)
@@ -73,7 +92,12 @@ module Rib
              "  #{Rib::API.format_error(e)}")
   end
 
-  # The config path where Rib tries to load upon Rib.shell
+  # The config path where Rib tries to load upon Rib.shell or
+  # Rib.require_config. It is depending on where Rib.home was discovered
+  # if no specific config path was specified via -c or --config command
+  # line option. See also Rib.config.
+  #
+  # @api public
   def config_path
     return nil unless config[:config]
     path = File.expand_path(config[:config])
@@ -85,19 +109,28 @@ module Rib
   end
 
   # Say (print to $stdout, with colors in the future, maybe)
-  # something by the name of Rib
+  # something by the name of Rib.
+  #
+  # @api public
+  # @param words [Array[String]] Words you want to say.
   def say *words
     $stdout.puts(Rib.prepare(words))
   end
 
   # Warn (print to $stderr, with colors in the future, maybe)
-  # something by the name of Rib
+  # something by the name of Rib.
+  #
+  # @api public
+  # @param words [Array[String]] Words you want to warn.
   def warn *words
     $stderr.puts(Rib.prepare(words))
   end
 
   # Warn (print to $stderr, with colors in the future, maybe)
-  # something by the name of Rib and then exit(1)
+  # something by the name of Rib and then exit(1).
+  #
+  # @api public
+  # @param words [Array[String]] Words you want to warn before aborting.
   def abort *words
     warn(words)
     exit(1)

data/lib/rib/extra/paging.rb

@@ -24,7 +24,8 @@ module Rib::Paging
   # `less -X` would mess up the buffers, so it's not desired, either.
   def one_screen? output
     cols, lines = `tput cols`.to_i, `tput lines`.to_i
-    output.count("\n") <= lines && output.size <= cols * lines
+    output.count("\n") <= lines &&
+      output.gsub(/\e\[[^m]*m/, '').size <= cols * lines
   end
 
   def page_result output

data/lib/rib/runner.rb

@@ -13,7 +13,7 @@ module Rib::Runner
       'Set debugging flags (set $DEBUG to true)'                     ],
 
      ['-w, --warn'                                                    ,
-       'Turn warnings on for your script (set $-w to true)'          ],
+       'Turn warnings on (set $-w and $VERBOSE to true)'             ],
 
      ['-I, --include PATH'                                            ,
        'Specify $LOAD_PATH (may be used more than once)'             ],

data/lib/rib/version.rb

@@ -1,4 +1,4 @@
 
 module Rib
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/rib.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rib 1.2.1 ruby lib
+# stub: rib 1.2.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rib"
-  s.version = "1.2.1"
+  s.version = "1.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-01-18"
+  s.date = "2014-01-23"
   s.description = "Ruby-Interactive-ruBy -- Yet another interactive Ruby shell\n\nRib is based on the design of [ripl][] and the work of [ripl-rc][], some of\nthe features are also inspired by [pry][]. The aim of Rib is to be fully\nfeatured and yet very easy to opt-out or opt-in other features. It shall\nbe simple, lightweight and modular so that everyone could customize Rib.\n\n[ripl]: https://github.com/cldwalker/ripl\n[ripl-rc]: https://github.com/godfat/ripl-rc\n[pry]: https://github.com/pry/pry"
   s.email = ["godfat (XD) godfat.org"]
   s.executables = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rib
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Ruby-Interactive-ruBy -- Yet another interactive Ruby shell