rib 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2cc6e3966230aac382f90352549a7545c8e27ff
-  data.tar.gz: 6bb97f019cc41dffbc900fa2d5aa1f44024d65a8
+  metadata.gz: 2179819cb0fd07bfd02d5fff9313d0b72a6d3bfe
+  data.tar.gz: cb65c6407da421a2a6013bce9d3de585a73175f4
 SHA512:
-  metadata.gz: 0a0519f630b28351cf2d6f636c976eea2d904b1703fbf63c9ad1824944cb204dd5490f39d7d3ebffa1ffe81e994324135e8c5176eb3f905172d259bb3902a76b
-  data.tar.gz: 87d41ae852dfb60039bd785fcc9b141fd01cc1bfc304f5b2047891d29ab04ccc05d989075cbec8068b6b35c1a2e7c6bf2a0013c489290b4322d9c132ce639e20
+  metadata.gz: 2d3e07839f36a11e48295a8b6b4fc605941acf1ad2dd0cfdc37b33d873393e287a3e62bcc69eae106ea8e5623c1a2250d01d8d367658adc629cb8947865a260b
+  data.tar.gz: b183b7adae908696abf296133f2cce5cecd21fa8a6cd7dffe0cc62fffb239e887ad8ba2edd8082b3aeccebe0cf7fa76352aaba4e25e5bbea579802cbf86c0d0d

data/.travis.yml

@@ -12,3 +12,7 @@ before_install:
   - rvm use --install $TRAVIS_RUBY_VERSION --binary --latest
 install: 'gem install bundler; bundle install --retry=3'
 script: 'ruby -r bundler/setup -S rake test'
+
+matrix:
+  allow_failures:
+  - rvm: rbx

data/CHANGES.md

@@ -1,5 +1,14 @@
 # CHANGES
 
+## Rib 1.4.0 -- 2016-11-11
+
+* Search Rib home by directories rather than config/history file.
+* Respect prefix option for detecting Rib home.
+* Update help message for `-n`, which won't load any config.
+* Change `Rib.config[:config]` to `Rib.config_path`.
+* [app/rails] Fix loading boot file when using prefix option.
+* [app/auto] Fix two variable shadowing warnings.
+
 ## Rib 1.3.1 -- 2016-11-03
 
 * [core/strip_backtrace], [more/color] No longer show `./` for current path.

data/README.md

@@ -7,6 +7,7 @@ by Lin Jen-Shin ([godfat](http://godfat.org))
 * [github](https://github.com/godfat/rib)
 * [rubygems](https://rubygems.org/gems/rib)
 * [rdoc](http://rdoc.info/github/godfat/rib)
+* [issues](https://github.com/godfat/rib/issues) (feel free to ask for support)
 
 ## DESCRIPTION:
 
@@ -87,12 +88,15 @@ As a fully featured app console (yes, some commands could be used together)
 
     rib all auto # or `rib auto all`, the order doesn't really matter
 
+#### Customization
+
 You can customize Rib's behaviour by setting a config file located at
-`~/.rib/config.rb` or `~/.config/rib/config.rb`, or `$RIB_HOME/config.rb` by
-setting `$RIB_HOME` environment variable. Since it's merely a Ruby script
-which would be loaded into memory before launching Rib shell session, You can
-put any customization or monkey patch there. Personally, I use all plugins
-provided by Rib.
+`$RIB_HOME/config.rb`, or `./.rib/config.rb`, or `~/.rib/config.rb`, or
+`~/.config/rib/config.rb`, searched by respected order. The default
+would be `~/.rib/config.rb`. Since it's merely a Ruby script which would
+be loaded into memory before launching Rib shell session, You can put any
+customization or monkey patch there. Personally, I use all plugins provided
+by Rib.
 
 My Personal [~/.config/rib/config](https://github.com/godfat/dev-tool/blob/master/.config/rib/config.rb)
 
@@ -132,12 +136,77 @@ file. To see a list of overridable API, please read [api.rb][]
 
 [api.rb]: https://github.com/godfat/rib/blob/master/lib/rib/api.rb
 
+#### Rib home and history file
+
+Rib home is used to store a config file and a history file, which is
+searched in this order:
+
+* $RIB_HOME
+* ./.rib
+* ~/.rib
+* ~/.config/rib
+
+Rib would stop searching whenever the directory is found. If none could be
+found, the default would be:
+
+* ~/.rib
+
+So the default history file would be located at `~/.rib/history.rb`.
+
+#### Project config and history
+
+Since `./.rib` would be searched before `~/.rib`, you could create project
+level config at the project directory, and the history would also be
+separated from each other, located at the respected `./.rib/history.rb`.
+
+To do this, you don't really have to create a project config. Creating an
+empty directory for Rib home at the project directory would also work.
+
+#### Project directory and command line options
+
+You could set the project directory by using `-p, --prefix` command line
+option. So consider this:
+
+    cd ~/project
+    rib auto
+
+Would work the same as:
+
+    cd /tmp
+    rib -p ~/project auto
+
+And the project config and history would be located at `~/project/.rib`.
+
+To check for more command line options, run `rib -h`:
+
+```
+Usage: rib [ruby OPTIONS] [rib OPTIONS] [rib COMMANDS]
+ruby options:
+  -e, --eval LINE        Evaluate a LINE of code
+  -d, --debug            Set debugging flags (set $DEBUG to true)
+  -w, --warn             Turn warnings on (set $-w and $VERBOSE to true)
+  -I, --include PATH     Specify $LOAD_PATH (may be used more than once)
+  -r, --require LIBRARY  Require the library, before executing your script
+rib options:
+  -c, --config FILE      Load config from FILE
+  -p, --prefix PATH      Prefix to locate the app. Default to .
+  -n, --no-config        Suppress loading ~/.config/rib/config.rb
+  -h, --help             Print this message
+  -v, --version          Print the version
+rib commands:
+  min                    Run the minimum essence
+  auto                   Run as Rails or Ramaze console (auto-detect)
+  all                    Load all recommended plugins
+  rails                  Run as Rails console
+  rack                   Run as Rack console
+  ramaze                 Run as Ramaze console
+```
+
 #### Basic configuration
 
 Rib.config                 | Functionality
 -------------------------- | -------------------------------------------------
 ENV['RIB_HOME']            | Specify where Rib should store config and history
-Rib.config[:config]        | The path where config should be located
 Rib.config[:name]          | The name of this shell
 Rib.config[:result_prompt] | Default is "=>"
 Rib.config[:prompt]        | Default is ">>"
@@ -149,7 +218,7 @@ Rib.config[:exit]          | Commands to exit, default [nil] # control+d
 Rib.config                     | Functionality
 ------------------------------ | ---------------------------------------------
 Rib.config[:completion]        | Completion: Bond config
-Rib.config[:history_file]      | Default is "~/.rib/config/history.rb"
+Rib.config[:history_file]      | Default is "~/.rib/history.rb"
 Rib.config[:history_size]      | Default is 500
 Rib.config[:color]             | A hash of Class => :color mapping
 Rib.config[:autoindent_spaces] | How to indent? Default is two spaces: '  '

data/lib/rib/app/auto.rb

@@ -3,12 +3,10 @@ module Rib; end
 module Rib::Auto
   module_function
   def load
-    app, name = %w[ramaze rails rack].find{ |name|
-      require "rib/app/#{name}"
-      app = Rib.const_get(name.capitalize)
-      if app.send("#{name}?")
-        break app, name
-      end
+    app, name = %w[ramaze rails rack].find{ |n|
+      require "rib/app/#{n}"
+      a = Rib.const_get(n.capitalize)
+      break a, n if a.public_send("#{n}?")
     }
 
     if app

data/lib/rib/app/rails.rb

@@ -111,6 +111,6 @@ module Rib::Rails
   end
 
   def path_for file
-    "#{Rib.config[:prefix]}/config/#{file}"
+    File.expand_path("#{Rib.config[:prefix]}/config/#{file}")
   end
 end

data/lib/rib/runner.rb

@@ -5,28 +5,28 @@ module Rib::Runner
   module_function
   def options
     @options ||=
-    [['ruby options:'    , ''                                        ],
-     ['-e, --eval LINE'                                               ,
-      'Evaluate a LINE of code'                                      ],
+    [['ruby options:'    , ''                                      ],
+     ['-e, --eval LINE'                                             ,
+      'Evaluate a LINE of code'                                    ],
 
-     ['-d, --debug'                                                   ,
-      'Set debugging flags (set $DEBUG to true)'                     ],
+     ['-d, --debug'                                                 ,
+      'Set debugging flags (set $DEBUG to true)'                   ],
 
-     ['-w, --warn'                                                    ,
-       'Turn warnings on (set $-w and $VERBOSE to true)'             ],
+     ['-w, --warn'                                                  ,
+       'Turn warnings on (set $-w and $VERBOSE to true)'           ],
 
-     ['-I, --include PATH'                                            ,
-       'Specify $LOAD_PATH (may be used more than once)'             ],
+     ['-I, --include PATH'                                          ,
+       'Specify $LOAD_PATH (may be used more than once)'           ],
 
-     ['-r, --require LIBRARY'                                         ,
-       'Require the library, before executing your script'           ],
+     ['-r, --require LIBRARY'                                       ,
+       'Require the library, before executing your script'         ],
 
-     ['rib options:'     , ''                                        ],
-     ['-c, --config FILE', 'Load config from FILE'                   ],
-     ['-p, --prefix PATH', 'Prefix to locate the app. Default to .'  ],
-     ['-n, --no-config'  , 'Suppress loading ~/.config/rib/config.rb'],
-     ['-h, --help'       , 'Print this message'                      ],
-     ['-v, --version'    , 'Print the version'                       ]] +
+     ['rib options:'     , ''                                      ],
+     ['-c, --config FILE', 'Load config from FILE'                 ],
+     ['-p, --prefix PATH', 'Prefix to locate the app. Default to .'],
+     ['-n, --no-config'  , 'Suppress loading any config'           ],
+     ['-h, --help'       , 'Print this message'                    ],
+     ['-v, --version'    , 'Print the version'                     ]] +
 
     [['rib commands:'    , '']] + commands
   end
@@ -120,13 +120,13 @@ module Rib::Runner
         require($1 || argv.shift)
 
       when /^-c=?(.+)?/, /^--config=?(.+)?/
-        Rib.config[:config] = $1 || argv.shift
+        Rib.config_path = $1 || argv.shift
 
       when /^-p=?(.+)?/, /^--prefix=?(.+)?/
         Rib.config[:prefix] = $1 || argv.shift
 
       when /^-n/, '--no-config'
-        Rib.config.delete(:config)
+        Rib.config_path = Rib::Skip
         parse_next(argv, arg)
 
       when /^-h/, '--help'

data/lib/rib/version.rb

@@ -1,4 +1,4 @@
 
 module Rib
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/lib/rib.rb

@@ -11,9 +11,7 @@ module Rib
   #
   # @api public
   def config
-    @config ||= {:name => 'rib',
-                 :config => File.join(home, 'config.rb'),
-                 :prefix => '.'}
+    @config ||= {:name => 'rib', :prefix => '.'}
   end
 
   # All shells in the memory
@@ -33,13 +31,11 @@ module Rib
   #
   # @api public
   def home
-    ENV['RIB_HOME'] ||= begin
-      ['./.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'))
+    ENV['RIB_HOME'] ||= File.expand_path(
+      ["#{config[:prefix]}/.rib", '~/.rib', '~/.config/rib'].find{ |path|
+        File.exist?(File.expand_path(path))
       } || '~/.rib'
-    end
+    )
   end
 
   # Convenient shell accessor, which would just give you current last shell
@@ -49,7 +45,7 @@ module Rib
   # @api public
   def shell
     shells.last || begin
-      require_config if config_path
+      require_config if config_path && config_path != Skip
       (shells << Shell.new(config)).last
     end
   end
@@ -59,7 +55,7 @@ module Rib
   #
   # @api public
   def plugins
-    Shell.ancestors[1..-1].select{ |a| a.singleton_class < Plugin }
+    Shell.ancestors.drop(1).select{ |a| a.singleton_class < Plugin }
   end
 
   # Convenient way to disable all plugins in the memory.
@@ -85,29 +81,25 @@ module Rib
   #
   # @api public
   def require_config
-    return unless config_path
-    result = require(config_path)
+    result = require(config_path) if File.exist?(config_path)
     Rib.say("Config loaded from: #{config_path}") if $VERBOSE && result
     result
   rescue StandardError, LoadError, SyntaxError => e
-    Rib.warn("Error loading #{config[:config]}\n" \
+    Rib.warn("Error loading #{config_path}\n" \
              "  #{Rib::API.format_error(e)}")
   end
 
-  # 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.
+  # The config path where Rib tries to load upon Rib.shell.
+  # It is depending on where Rib.home was discovered if
+  # no specific config path was specified via -c or --config command
   #
   # @api public
   def config_path
-    return nil unless config[:config]
-    path = File.expand_path(config[:config])
-    if File.exist?(path)
-      path
-    else
-      nil
-    end
+    @config_path ||= File.join(home, 'config.rb')
+  end
+
+  def config_path= new_path
+    @config_path = new_path
   end
 
   # Say (print to $stdout, with colors in the future, maybe)

data/rib.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rib 1.3.1 ruby lib
+# stub: rib 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rib".freeze
-  s.version = "1.3.1"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Lin Jen-Shin (godfat)".freeze]
-  s.date = "2016-11-03"
+  s.date = "2016-11-11"
   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".freeze
   s.email = ["godfat (XD) godfat.org".freeze]
   s.executables = [
@@ -89,7 +89,7 @@ Gem::Specification.new do |s|
   "test/test_shell.rb".freeze]
   s.homepage = "https://github.com/godfat/rib".freeze
   s.licenses = ["Apache License 2.0".freeze]
-  s.rubygems_version = "2.6.7".freeze
+  s.rubygems_version = "2.6.8".freeze
   s.summary = "Ruby-Interactive-ruBy -- Yet another interactive Ruby shell".freeze
   s.test_files = [
   "test/core/test_completion.rb".freeze,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rib
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby-Interactive-ruBy -- Yet another interactive Ruby shell