dotopts 0.1.0 → 0.1.1

data/.index

@@ -49,7 +49,7 @@ paths:
 created: '2013-01-23'
 summary: Automatic Arguments for Ruby
 title: DotOpts
-version: 0.1.0
+version: 0.1.1
 name: dotopts
 description: DotOpts is an automatic commandline argument augmenter for Ruby tools.
-date: '2013-01-25'
+date: '2013-01-29'

data/HISTORY.md

@@ -1,5 +1,15 @@
 # RELEASE HISTORY
 
+## 0.1.1 / 2013-01-29
+
+This release simply fixes the missing optional argument on the
+`DotOpts#configure!` method's interface.
+
+Changes:
+
+* Fix `DotOpts#configure!` method. [bug]
+
+
 ## 0.1.0 / 2013-01-28
 
 First release of DotOpts.

data/README.md

@@ -1,11 +1,11 @@
-[![Build Status](https://secure.travis-ci.org/rubyworks/dotopts.png)](http://travis-ci.org/rubyworks/dotopts)
 [![Gem Version](https://badge.fury.io/rb/dotopts.png)](http://badge.fury.io/rb/dotopts)
+[![Build Status](https://secure.travis-ci.org/rubyworks/dotopts.png)](http://travis-ci.org/rubyworks/dotopts)
 
 <br/>
 
 # DotOpts
 
-**Universal Command Options Configuration (for Ruby Executables)**
+**Automated Commandline Options (for Ruby Executables)**
 
 [Website](http://rubyworks.github.com/dotopts) /
 [Report Issue](http://github.com/rubyworks/dotopts/issues) /
@@ -14,9 +14,9 @@
 
 ## About
 
-DotOpts is an automatic command line argument augmenter. I looks for a local
-local `.opts` configuration file and applies the appropriate arguments
-when a matching command is invoked.
+DotOpts is an automatic commandline argument augmenter. It looks for a
+project's local `.opts` configuration file and applies the appropriate
+arguments when a matching command is invoked.
 
 
 ## Features
@@ -35,7 +35,7 @@ DotOpts can be install via Rubygems:
     gem install dotopts
 
 If you would like to use DotOpts with all Ruby tools, regardless of
-wether they have built-in support for DotOpts, then add `-rdotopts`
+whether they have built-in support for DotOpts, then add `-rdotopts`
 to you `RUBYOPT` environment variable.
 
     export RUBYOPT="-rdotopts"
@@ -119,8 +119,8 @@ using regular expressions.
 ## Third Party Support
 
 Ruby tool developers can support dotopts out-of-the-box simple by running
-`require 'dotopt'` in their program before parsing the commandline. DotOpts
-simply inject arguments into `ARGV` so it can work with any commandline
+`require 'dotopts'` in their program before parsing the commandline. DotOpts
+simply injects arguments into `ARGV` so it can work with any commandline
 option parser.
 
 
@@ -129,7 +129,7 @@ option parser.
 ### Universal Solution?
 
 It would be awesome if it were possible to have DotOpts apply to *all* executables,
-not just Ruby-based executables. But I do not know of such a solution for Bash, Zsh
+not just Ruby-based executables. But I do not know how this can be done for Bash, Zsh
 or any other shell. Of course, each scripting language could potentially have
 its own implementation of DotOpts, which would cover many more executables, but it
 would still not cover all of them.

data/lib/dotopts/api.rb

@@ -2,23 +2,29 @@ module DotOpts
   require 'dotopts/parser'
 
   #
-  CONFIG_FILE = '.options'
+  OPTIONS_FILE = '.opts'
 
   # Configure
-  def self.configure!(config_file)
-    if config_file = config_file || config_file()
-      text = File.read(config_file)
+  #
+  # @param [String] file
+  #   The configuration file to load. (optional)
+  #
+  # @return nothing
+  def self.configure!(file=nil)
+    file = options_file unless file
+    if file
+      text = File.read(file)
       parser = Parser.parse(text)
       ARGV.concat parser.arguments
-    end   
+    end
   end
 
-  # Returns the `.ruby` file of the current project.
+  # Returns the options file of the current project.
   #
-  # @return {String] The .ruby file of the project.
-  def self.config_file
+  # @return {String] The options file of the project.
+  def self.options_file
     if project_root
-      file = File.join(project_root, CONFIG_FILE)
+      file = File.join(project_root, OPTIONS_FILE)
       return file if File.exist?(file)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotopts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qed