loquacious 1.5.2 → 1.6.0

data/History.txt

@@ -1,3 +1,8 @@
+== 1.6.0 / 2010-04-18
+
+* 1 minor enhancement
+  * Added a default "undefined" value
+
 == 1.5.2 / 2010-04-06
 
 * 1 bug fix

data/README.rdoc

@@ -58,31 +58,31 @@ they can appear above the attribute and value on their own line.
   # A simple example that configures three options (a b c) along with
   # descriptions for each option. The descriptions along with the
   # values for the configuration options are printed to the terminal.
-  
+
   require 'loquacious'
   include Loquacious
-  
+
   Configuration.for(:simple) {
     desc 'Your first configuration option'
     a "value for 'a'"
-  
+
     desc 'To be or not to be'
     b "William Shakespeare"
-  
+
     desc 'The underpinings of Ruby'
     c 42
   }
-  
+
   help = Configuration.help_for :simple
   help.show :values => true
 
   ====== output ======
    Your first configuration option
     - a => "value for 'a'"
-  
+
    To be or not to be
     - b => "William Shakespeare"
-  
+
    The underpinings of Ruby
     - c => 42
 
@@ -138,25 +138,25 @@ they can appear above the attribute and value on their own line.
   ====== output ======
    Configuration options for ActiveRecord::Base.
     - active_record
-   
+
    Determines whether to use ANSI codes to colorize the logging statements committed
    by the connection adapter. These colors make it much easier to overview things
    during debugging (when used through a reader like +tail+ and on a black background),
    but may complicate matters if you use software like syslog. This is true, by default.
     - active_record.colorize_logging => true
-   
+
    Determines whether to use Time.local (using :local) or Time.utc (using :utc)
    when pulling dates and times from the database. This is set to :local by default.
     - active_record.default_timezone => :local
-   
+
    The log level to use for the default Rails logger. In production mode,
    this defaults to :info. In development mode, it defaults to :debug.
     - log_level                      => :info
-   
+
    The path to the log file to use. Defaults to log/#{environment}.log
    (e.g. log/development.log or log/production.log).
     - log_path                       => "log/development.log"
-   
+
    The application's base directory.
     - root_path                      => "."
 
@@ -195,17 +195,17 @@ they can appear above the attribute and value on their own line.
   ====== output ======
    The log level to use for the default Rails logger. In production mode,
    this defaults to :info. In development mode, it defaults to :debug.
-   
+
      config.log_level = 'debug'
      config.log_level = :warn
-   
+
     - log_level => :warn
-   
+
    The path to the log file to use. Defaults to log/#{environment}.log
    (e.g. log/development.log or log/production.log).
-   
+
      config.log_path = File.join(ROOT, "log", "#{environment}.log
-   
+
     - log_path  => "log/development.log"
 
 == LICENSE:

data/lib/loquacious.rb

@@ -96,6 +96,7 @@ end  # module Loquacious
 
 Loquacious.libpath {
   require 'loquacious/core_ext/string'
+  require 'loquacious/undefined'
   require 'loquacious/configuration'
   require 'loquacious/configuration/iterator'
   require 'loquacious/configuration/help'

data/lib/loquacious/configuration.rb

@@ -110,7 +110,9 @@ module Loquacious
       CODE
 
       __desc[m]
-      self.__send("#{m}=", nil)
+
+      default = (args.empty? and !block) ? Loquacious::Undefined.new(m.to_s) : nil
+      self.__send("#{m}=", default)
       self.__send("#{m}", *args, &block)
     end
 
@@ -180,6 +182,7 @@ module Loquacious
       self.__send(key, value)
     end
 
+
     # Implementation of a doman specific language for creating configuration
     # objects. Blocks of code are evaluted by the DSL which returns a new
     # configuration object.
@@ -258,4 +261,3 @@ module Loquacious
   end  # class Configuration
 end  # module Loquacious
 
-# EOF

data/lib/loquacious/configuration/iterator.rb

@@ -144,9 +144,13 @@ class Loquacious::Configuration
     # single configuration attribute.
     #
     Node = Struct.new( :config, :name, :desc, :key ) {
-      def obj() config.__send__(key); end
       def config?() obj.kind_of? ::Loquacious::Configuration; end
+      def obj()
+        o = config.__send__(key)
+        o.kind_of?(::Loquacious::Undefined) ? nil : o
+      end
     }
 
   end  # class Iterator
 end  # class Loquacious::Configuration
+

data/lib/loquacious/undefined.rb

@@ -0,0 +1,86 @@
+
+module Loquacious
+
+  # Represents an undefined configuration value. An undefined value is
+  # assigned to each configuration propery by default. Any method can be
+  # invoked on an undefined value, and a warning message will be printed to
+  # the IO stream (defaulting to $stderr).
+  #
+  # The purpose of this class is to provide the user with a helpful message
+  # that the configuration values they are trying to use have not been setup
+  # correctly.
+  #
+  class Undefined
+
+    Keepers = %r/^__|^object_id$|^initialize$|^kind_of\?$|^respond_to\?$|^call$/
+    instance_methods(true).each do |m|
+      next if m[Keepers]
+      undef_method m
+    end
+    private_instance_methods(true).each do |m|
+      next if m[Keepers]
+      undef_method m
+    end
+    Kernel.methods.each do |m|
+      next if m[Keepers]
+      module_eval <<-CODE
+        def #{m}( *args, &block )
+          self.method_missing('#{m}', *args, &block)
+        end
+      CODE
+    end
+
+    @io = $stderr
+    @first_time = true
+
+    class << self
+      attr_accessor :io
+
+      # Write a warning message to the Undefined class IO stream. By default,
+      # this IO stream is set to the Ruby $stderr output.
+      #
+      def warn( key )
+        if @first_time
+          @io.puts <<-__
+---------------------------------------------------------------------------
+The Loquacious configuration system has detected that one or moe
+settings have an undefined value. An attempt is being made to reference
+sub-properties of these undefined settings. Messages will follow containing
+information about the undefined properties.
+---------------------------------------------------------------------------
+          __
+          @first_time = false
+        end
+
+        @io.puts "Access to undefined value #{key.first.inspect}: #{key.join('.')}"
+      end
+    end
+
+    # Creates a new undefined value returned from the lookup _key_ in some
+    # configuration object. The _key_ is used to alert the user where the
+    # undefined value came from.
+    #
+    def initialize( key )
+      @key = Kernel.Array(key)
+    end
+
+    # An undefined value acts like a +nil+ in that it has no value of its own.
+    # This method always returns +true+.
+    #
+    def nil?() true; end
+
+    # For every method invoked on an undefined object, generate a warning
+    # message describing the undefined value and the method that was called.
+    #
+    # Returns a new undefined object with the most recent method included in
+    # the key name.
+    #
+    def method_missing( method, *args, &block )
+      key = @key.dup << method.to_s
+      Undefined.warn key
+      return Undefined.new key
+    end
+
+  end  # class Undefined
+end  # module Loquacious
+

data/spec/spec_helper.rb

@@ -12,7 +12,11 @@ Spec::Runner.configure do |config|
   # config.mock_with :flexmock
   # config.mock_with :rr
 
+  Loquacious::Undefined.io = StringIO.new
+
   config.before :each do
+    Loquacious::Undefined.io.clear
+
     table = Loquacious::Configuration.instance_variable_get(:@table)
     table.clear
 

data/version.txt

@@ -1 +1 @@
-1.5.2
+1.6.0

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 5
-  - 2
-  version: 1.5.2
+  - 6
+  - 0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 -06:00
+date: 2010-05-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,7 @@ files:
 - lib/loquacious/configuration/help.rb
 - lib/loquacious/configuration/iterator.rb
 - lib/loquacious/core_ext/string.rb
+- lib/loquacious/undefined.rb
 - spec/configuration_spec.rb
 - spec/help_spec.rb
 - spec/iterator_spec.rb