configdsl 1.0.0 → 1.1.0

data/README.md

@@ -1,6 +1,6 @@
 # ConfigDSL
 
-A tasty DSL for configuration files. Get rid of those ugly YAML and JSON configs.
+A tasty Ruby-based DSL for configuration files. Get rid of those silly YAML and JSON configs.
 
 ## Installation
 
@@ -43,7 +43,7 @@ list do
     three_two one + " 2"
     three_three "three"
   end
-  see "will_be_ovewritten"
+  see "will_be_overwritten"
 end
 
 list 5 do |index|
@@ -184,15 +184,51 @@ puts ; puts "Program was stared at: "
 p ConfigDSL[:starting_time]
 ```
 
+#### Keys as methods
+
+You can access all config values using method chaining syntax instead of using the square brackets.
+
+```ruby
+ConfigDSL[:list][:three][:three_two]
+```
+
+is equal to
+
+```ruby
+ConfigDSL.list.three.three_two
+```
+
+However, there is a little problem with this approach.
+Data container objects do have their own methods besides the methods that they provide to get data values.
+
+Notice that `ConfigDSL.data` is also a reserved method (it returns internal first-level data container).
+
 #### Check out the example!
 
 There is an `examples` dir. Check it out to see how it works for yourself!
 
-### Use Hashie::Mash
+### Lazy Values
+
+You can have lazy values in your configuration code! By default, those values are evaluated when you call them for the first time.
+This can be very useful when you want to load config before everything else. Storing some config data in the database? This is for you.
+
+```ruby
+ConfigDSL.execute do
+  lazy_varaible lazy!{ Time.now }
+  standart_variable Time.now
+end
+
+sleep 2
+
+ConfigDSL.standart_variable  # => 2012-11-11 21:37:09 +0400
+ConfigDSL.lazy_varaible      # => 2012-11-11 21:37:11 +0400
+```
+
+Can be tricky! Make sure you understand what Lazy Values do and what they don't do!
 
-If you're using Hashie::Mash from https://github.com/intridea/hashie, it will be used to store the config.
-Just make sure to require it before you read the first value.
+### Use Hashie::Mash - Deprecated!
 
+Hashie::Mash can not be used as a layer-level storage anymore (because of lazy values implementation).
 
 ### Ruby on Rails
 
@@ -201,7 +237,6 @@ To be implemented. For now you can use it like standalone as initializer.
 ### To-Do List
 
  - Ruby on Rails integration
- - Lazy config values
 
 ## Contributing
 

data/configdsl.gemspec

@@ -4,16 +4,16 @@ require File.expand_path('../lib/configdsl/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["MOZGIII"]
   gem.email         = ["mike-n@narod.ru"]
-  gem.description   = %q{A convinient DSL for your app configuration!}
-  gem.summary       = %q{A convinient DSL for your app configuration!}
-  gem.homepage      = ""
+  gem.description   = %q{A convinient Ruby-based DSL for your app configuration!}
+  gem.summary       = %q{A convinient Ruby-based DSL for your app configuration!}
+  gem.homepage      = "http://github.com/MOZGIII/ConfigDSL"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "configdsl"
   gem.require_paths = ["lib"]
-  gem.version       = Configdsl::VERSION
+  gem.version       = ConfigDSL::VERSION
   
   gem.add_runtime_dependency "activesupport"
 end

data/examples/example.rb

@@ -36,7 +36,7 @@ p ConfigDSL[:value]
 
 # Access block values
 
-puts "Block values: "
+puts ; puts "Block values: "
 
 puts ; puts "-- [:list][:one]"
 p ConfigDSL[:list][:one]

data/examples/example_lazy.rb

@@ -0,0 +1,37 @@
+$: << "../lib"
+require 'configdsl'
+
+ConfigDSL.execute do
+  lazy_varaible lazy!{ Time.now }
+  standart_variable Time.now
+  
+  lower_level_also_works do
+    lazy_time lazy!{ Time.now }
+  end
+  
+  delta lazy!(Time.now){ |config_reading_time| Time.now.to_i - config_reading_time.to_i }
+end
+
+# We sleep for time to change
+sleep 2
+
+print "Standart: "
+p ConfigDSL.standart_variable
+
+print "Lazy: "
+p ConfigDSL.lazy_varaible
+
+print "Lazy (another way to get): "
+p ConfigDSL[:lazy_varaible]
+
+print "Lazy (force LazyValue object instead of its content): "
+p ConfigDSL.original_reader(:lazy_varaible)
+
+print "Non-toplevel lazy variables (only evaluated on request): "
+p ConfigDSL.lower_level_also_works
+
+print "And this value processed: "
+p ConfigDSL.lower_level_also_works.lazy_time
+
+print "Delta between lazy and standart Time.now (should -> 2): "
+p ConfigDSL.delta

data/examples/test.cdsl.rb

@@ -15,7 +15,7 @@ list do
     three_two one + " 2"
     three_three "three"
   end
-  see "will_be_ovewritten"
+  see "will_be_overwritten"
 end
 
 list 5 do |index|

data/lib/configdsl/version.rb

@@ -1,3 +1,3 @@
-module Configdsl
-  VERSION = "1.0.0"
+module ConfigDSL
+  VERSION = "1.1.0"
 end

data/lib/configdsl.rb

@@ -4,14 +4,51 @@ require "forwardable"
 
 module ConfigDSL
   module Memory
+    class MemoryLayer < Hash
+      def self.make_alias_method(meth)
+        "original_#{meth}".to_sym
+      end
+    
+      ALIASED_METHODS = [
+        :[], :fetch
+      ]
+      
+      ALIASED_METHODS.each do |meth|
+        original_method = make_alias_method(meth)
+        
+        begin
+          alias_method original_method, meth
+          
+          define_method meth do |*args, &block|
+            lazy_value = __send__(original_method, *args, &block)
+            lazy_value = lazy_value.value if lazy_value.kind_of?(LazyValue)
+            lazy_value
+          end
+        rescue NameError
+        end
+      end
+      
+      # Give a more handy name
+      alias_method :original_reader, make_alias_method(:[])
+      
+      # Allow methods invocation to read values
+      def method_missing(meth, *args, &block)
+        return self[meth] if has_key?(meth)
+        super
+      end
+      
+      # Allow methods invocation to read values, second part
+      def respond_to?(meth)
+        return true if has_key?(meth)
+        super
+      end
+    end
+  
     class << self
       # Creates a new layer-level storage element
       def layers_factory
-        # Try to use Hashie::Mash if defined (see hashie gem)
-        return Hashie::Mash.new if defined?(Hashie::Mash)
-        
-        # Fallback to standart ruby Hash
-        Hash.new
+        @factory_base_class ||= MemoryLayer
+        @factory_base_class.new
       end
     
       # Main data container
@@ -61,7 +98,11 @@ module ConfigDSL
     extend ActiveSupport::Concern
     
     def self.debug?
-      false
+      @debug ||= false
+    end
+    
+    def self.debug!(value = true)
+      @debug = value
     end
     
     def context
@@ -72,6 +113,10 @@ module ConfigDSL
       puts text if DSL.debug?
     end
     
+    def lazy!(*args, &block)
+      LazyValue.new(block, args)
+    end
+    
     def varibales_hook(meth, *args, &block)
       debug "Hooked #{meth}"
       debug "Context is #{context}"
@@ -162,4 +207,44 @@ module ConfigDSL
       data.respond_to?(meth)
     end
   end
+  
+  class LazyValue
+    def self.default_options
+      {
+        caching: true        
+      }
+    end
+    
+    attr_reader :block, :args, :options
+  
+    def initialize(block, args = [], options = {})
+      @block = block
+      @args = args
+      @options = self.class.default_options.merge(options)
+      @cached = false
+    end
+    
+    def value(new_args = nil)
+      return @cache if caching? && cached?
+      value = block.call(*(new_args ? new_args : args))
+      if caching?
+        @cache = value
+        @cached = true
+      end
+      value
+    end
+    
+    def caching?
+      !!options[:caching]
+    end
+    
+    def flush_cache!
+      @cache = nil # clean pointer so that GC can do it's work immediately
+      @cached = true
+    end
+    
+    def cached?
+      @cached
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configdsl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &28949232 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,13 +21,8 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A convinient DSL for your app configuration!
+  version_requirements: *28949232
+description: A convinient Ruby-based DSL for your app configuration!
 email:
 - mike-n@narod.ru
 executables: []
@@ -41,10 +36,11 @@ files:
 - Rakefile
 - configdsl.gemspec
 - examples/example.rb
+- examples/example_lazy.rb
 - examples/test.cdsl.rb
 - lib/configdsl.rb
 - lib/configdsl/version.rb
-homepage: ''
+homepage: http://github.com/MOZGIII/ConfigDSL
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -64,8 +60,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A convinient DSL for your app configuration!
+summary: A convinient Ruby-based DSL for your app configuration!
 test_files: []
+has_rdoc: