dotopts 0.1.2 → 0.1.3

data/.index

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

data/Gemfile.lock

@@ -1,16 +1,13 @@
 PATH
   remote: .
   specs:
-    dotopts (0.1.0)
-
-PATH
-  remote: ../ae
-  specs:
-    ae (1.8.1)
+    dotopts (0.1.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    ae (1.8.1)
+      ansi
     ansi (1.4.3)
     brass (1.2.1)
     facets (2.9.3)
@@ -27,7 +24,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  ae!
+  ae
   dotopts!
   qed
   spectroscope

data/HISTORY.md

@@ -1,5 +1,23 @@
 # RELEASE HISTORY
 
+## 0.1.3 / 2013-01-30
+
+Environment settings were not being applied. This release improves the code
+that handles application of options and fixes the environment setting issue.
+This release also adds a debug log option, so one can see what DotOpts is doing
+by setting `dotopts_debug`.
+
+Changes:
+
+* Fix environment setting, ensuring their application.
+* Add debug log when `doptopts_debug` is set.
+
+
+## 0.1.2 / 2013-01-29
+
+Accidental release. Yanked.
+
+
 ## 0.1.1 / 2013-01-29
 
 This release simply fixes the missing optional argument on the

data/README.md

@@ -1,21 +1,17 @@
-[![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
 
 **Automated Commandline Options (for Ruby Executables)**
 
 [Website](http://rubyworks.github.com/dotopts) /
 [Report Issue](http://github.com/rubyworks/dotopts/issues) /
-[Source Code](http://github.com/rubyworks/dotopts)
-
+[Source Code](http://github.com/rubyworks/dotopts) /
+[![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)
 
 ## About
 
 DotOpts is an automatic commandline argument augmenter. It looks for a
-project's local `.opts` configuration file and applies the appropriate
+project's local `.option` configuration file and applies the appropriate
 arguments when a matching command is invoked.
 
 
@@ -53,7 +49,7 @@ This will allow dotopts to run whenever using `bundle exec`.
 
 ### Setting Arguments
 
-A simple example of a projects `.opts` file:
+A simple example of a projects `.option` file:
 
     yardoc
     yard doc
@@ -80,7 +76,7 @@ as a variable substitution.
 
 ### Conditional Profiles
 
-The `.opts` configuration file support profiles via the square brackets.
+The `.option` configuration file support profiles via the square brackets.
 Profiles are chosen via the `$profile` or `$p` environment variable.
 
 ```

data/demo/09_battery/commands_only.md

@@ -2,7 +2,7 @@
 
 ## Most basic example
 
-Given an .opts file:
+Given a `.option` file:
 
     yard
       --title "Big Title"
@@ -14,7 +14,7 @@ When we run `yard`, we should get the arguments:
 
 ## Example with later matching commande
 
-Given an .opts file with a number of profiles:
+Given a `.option` file with a number of profiles:
 
     something
       --title "Little Title"
@@ -29,7 +29,7 @@ When we run `yard` we should get the arguments:
 
 ## Example with multiple matching commands
 
-Given an .opts file with a number of commands:
+Given a `.option` file with a number of commands:
 
     yard
       --title "First Title"

data/demo/09_battery/profiles_basic.md

@@ -2,7 +2,7 @@
 
 ## Basic example with multiple profiles
 
-Given an .opts file:
+Given a `.option` file:
 
     yard
       --title "Cool Title"
@@ -18,7 +18,7 @@ When we run `yard`, we should get the arguments:
 
 ## Example with single profile
 
-Given an .opts file with a leading profile:
+Given a `.option` file with a leading profile:
 
     [example]
     yard
@@ -31,7 +31,7 @@ When we run `p=example yard`, we should get the arguments:
 
 ## Example with later matching profile
 
-Given an .opts file with a number of profiles:
+Given a `.option` file with a number of profiles:
 
     [something]
     yard
@@ -48,7 +48,7 @@ When we run `p=example yard` we should get the arguments:
 
 ## Example with multiple matching profiles
 
-Given an .opts file with a number of profiles:
+Given a `.option` file with a number of profiles:
 
     [example]
     yard

data/demo/09_battery/profiles_complex.md

@@ -2,7 +2,7 @@
 
 ## Basic environment profile
 
-Given an .opts file:
+Given a `.option` file:
 
     [a=1]
     yard
@@ -15,7 +15,7 @@ When we run `a=1 yard`, we should get the arguments:
 
 ## Multi-matching profile
 
-Given an .opts file:
+Given a `.option` file:
 
     [a=1 b=2]
     yard
@@ -28,7 +28,7 @@ When we run `a=1 b=2 yard`, we should get the arguments:
 
 ## Multiple multi-matching profiles
 
-Given an .opts file:
+Given a `.option` file:
 
     [a=1 b=1]
     yard
@@ -45,7 +45,7 @@ When we run `a=1 b=3 yard`, we should get the arguments:
 
 ## Multiple matching multi-matching profiles
 
-Given an .opts file:
+Given a `.option` file:
 
     [a=1 b=1]
     yard

data/demo/09_battery/profiles_regex.md

@@ -2,7 +2,7 @@
 
 ## Basic profile regex
 
-Given an .opts file:
+Given a `.option` file:
 
     [~"q(x)?"]
     yard
@@ -20,7 +20,7 @@ And when we run `p=qx yard`, we should get the arguments:
 
 ## Basic environment profile regex
 
-Given an .opts file:
+Given a `.option` file:
 
     [a=~"x|y"]
     yard
@@ -38,7 +38,7 @@ And when we run `a=y yard`, we should get the arguments:
 
 ## Complex profile
 
-Given an .opts file:
+Given a `.option` file:
 
     [~"q(x)?" a=~"x|y"]
     yard

data/demo/09_battery/substitution.md

@@ -2,7 +2,7 @@
 
 ## Most basic example
 
-Given an .opts file:
+Given a `.option` file:
 
     yard
       --title $title
@@ -14,7 +14,7 @@ When we run `title=Title yard`, we should get the arguments:
 
 ## Environment profile substitutions
 
-Given an .opts file:
+Given a `.option` file:
 
     [a=$b]
     yard

data/demo/applique/battery.rb

@@ -1,4 +1,4 @@
-When 'Given an .opts file' do |text|
+When "Given a `.option` file" do |text|
   ENV.replace({})
   ARGV.replace([])
 

data/lib/dotopts/api.rb

@@ -1,8 +1,8 @@
 module DotOpts
   require 'dotopts/parser'
 
-  #
-  OPTIONS_FILE = '.opts'
+  # Configuration file name.
+  OPTIONS_FILE = '.option'
 
   # Configure
   #
@@ -13,9 +13,14 @@ module DotOpts
   def self.configure!(file=nil)
     file = options_file unless file
     if file
-      text = File.read(file)
+      text   = File.read(file)
       parser = Parser.parse(text)
-      apply(parser.arguments, parser.environment)
+
+      argv = parser.arguments
+      env  = parser.environment
+
+      debug(file, argv, env)
+      apply(argv, env)
     end
   end
 
@@ -48,10 +53,29 @@ module DotOpts
   #
   # TODO: Support argument prepending in future version?
   #
+  # @return nothing
   def self.apply(argv, env={})
-    puts argv.join(' ') if ENV['dotopts_debug']
     env.each{ |k,v|  ENV[k.to_s] = v.to_s }
     ARGV.concat(argv)
   end
 
+  # Print message to stderr if dopts_debug flag it set.
+  #
+  # @return nothing
+  def self.debug(file, argv, env)
+    return unless ENV['dotopts_debug'] 
+
+    $stderr.puts "dotopts file: #{file}"
+
+    unless argv.empty?
+      msg = argv.join(' ')
+      $stderr.puts "dotopts argv: " + msg
+    end
+
+    unless env.empty?
+      msg = env.map{ |k,v| "#{k}=#{v.inspect}" }.join(' ')
+      $stderr.puts "dotopts env: " + msg
+    end
+  end
+
 end

data/lib/dotopts/parser.rb

@@ -3,39 +3,44 @@ module DotOpts
   class Parser
     require 'shellwords'
 
-    #
+    # Regular expression to match profile headers.
     RE_PROFILE_HEADER = /^\[/
 
-    #
+    # Regular expression to match command headers.
     RE_COMMAND_HEADER = /^\w/
 
-    #
+    # Regular expression to match blank strings.
     RE_BLANK_STRING = /^\s*$/
 
+    # Convenience constructor for `new(text).parse`.
     #
+    # @return [Parser]
     def self.parse(text)
       parser = new(text)
       parser.parse
       parser
     end
 
+    # Initialize new instance.
+    #
+    # @param [#to_s] text
     #
     def initialize(text)
-      @text = text
+      @text = text.to_s
       @arguments = []
       @environment = {}
     end
 
-    #
+    # The configuration document text.
     attr :text
 
-    #
+    # The applicable arguments parsed from the config text.
     attr :arguments
 
-    #
+    # The applicable environment parsed from the config text.
     attr :environment
 
-    #
+    # Parse the configuration text.
     def parse
       lines = @text.lines.to_a
 
@@ -54,7 +59,7 @@ module DotOpts
       parse_profiles(lines)
     end
 
-    #
+    # Parse profiles.
     def parse_profiles(lines)
       until lines.empty?
         line = lines.first.rstrip
@@ -87,7 +92,7 @@ module DotOpts
       end
     end
 
-    #
+    # Parse commands.
     def parse_commands(lines)
       while line = lines.first
         line = line.strip
@@ -106,7 +111,7 @@ module DotOpts
       end
     end
 
-    #
+    # Parse environment.
     def parse_environment(lines)
       while line = lines.first
         line = line.strip
@@ -121,7 +126,7 @@ module DotOpts
       end
     end
 
-    #
+    # Parse arguments.
     def parse_arguments(lines)
       while line = lines.first
         line = line.rstrip
@@ -134,9 +139,10 @@ module DotOpts
       end
     end
 
+    # The current command comes from the basename of `$0`.
+    # But it can be overriddne by setting the `cmd` environment variable.
     #
-    # @todo Note sure the cmd environment variable override is a good idea.
-    #
+    # @return [String]
     def current_command
       ENV['cmd'] || File.basename($0)
     end
@@ -148,12 +154,18 @@ module DotOpts
       value.gsub(/\$(\w+)/){ |m| ENV[$1] }
     end
 
+    # Split a string up into shellwords.
     #
+    # @return [Array]
     def shellwords(value)
       Shellwords.shellwords(value)
     end
 
+    # Remove intialize blank lines for an array of strings.
+    #
+    # @param [Array<String>] lines
     #
+    # @return [Array<String>]
     def remove_initial_blank_lines(lines)
       lines.shift while RE_BLANK_STRING =~ lines.first
     end

metadata

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