configdsl 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in configdsl.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 MOZGIII
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,212 @@
+# ConfigDSL
+
+A tasty DSL for configuration files. Get rid of those ugly YAML and JSON configs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configdsl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configdsl
+
+## Usage
+
+### Standalone Usage
+
+#### To read a config file
+
+ - in your app:
+
+```ruby
+# Read external data
+ConfigDSL.read("test.cdsl.rb")
+```
+
+ - test.cdsl.rb
+
+```ruby
+hi "User"
+# p hi  # => "User"
+
+list do
+  one "123"
+  two "345"
+  three do
+    one "1"
+    three_two one + " 2"
+    three_three "three"
+  end
+  see "will_be_ovewritten"
+end
+
+list 5 do |index|
+  append "anything"
+  second index + 1
+  square index ** 2
+  
+  see "overwritten!"
+end
+
+starting_time Time.now
+```
+
+   will produce
+
+```ruby
+pp ConfigDSL.data
+
+{:hi=>"User",
+ :list=>
+  {:one=>"123",
+   :two=>"345",
+   :three=>{:one=>"1", :three_two=>"1 2", :three_three=>"three"},
+   :see=>"overwritten!",
+   :append=>"anything",
+   :second=>6,
+   :square=>25},
+ :starting_time=>2012-11-05 22:47:36 +0000}
+```
+
+#### You can also load inline configs form your code
+
+```ruby
+# Execute inline data
+ConfigDSL.execute do
+  inline_loading_example "here goes"
+  value "awesome"
+  code "great"
+  block_test "config option" do |preset|
+    block_val preset
+  end
+end
+
+# Another inline data
+ConfigDSL.execute do
+  value "awesome"
+end
+```
+    
+   gives
+
+```ruby
+{:inline_loading_example=>"here goes",
+ :value=>"awesome",
+ :code=>"great",
+ :block_test=>{:block_val=>"config option"}}
+```
+
+
+#### You can combine theese two
+
+```ruby
+# Read external data
+ConfigDSL.read("test.cdsl.rb")
+
+# Execute inline data
+ConfigDSL.execute do
+  inline_loading_example "here goes"
+  value "awesome"
+  code "great"
+  block_test "config option" do |preset|
+    block_val preset
+  end
+end
+
+# Another inline data
+ConfigDSL.execute do
+  value "awesome"
+end
+
+require "pp" # for pretty print    
+pp ConfigDSL.data
+```
+
+   is
+
+```ruby
+{:hi=>"User",
+ :list=>
+  {:one=>"123",
+   :two=>"345",
+   :three=>{:one=>"1", :three_two=>"1 2", :three_three=>"three"},
+   :see=>"overwritten!",
+   :append=>"anything",
+   :second=>6,
+   :square=>25},
+ :starting_time=>2012-11-05 22:48:40 +0000,
+ :inline_loading_example=>"here goes",
+ :value=>"awesome",
+ :code=>"great",
+ :block_test=>{:block_val=>"config option"}}
+```
+
+#### You can coviniently access all the config values in your app
+
+```ruby
+# Here is how you get all the config
+p ConfigDSL.data
+
+# To read data from your app you can do this:
+
+puts ; puts "Value of :value is: "
+p ConfigDSL.data[:value]
+
+# or this
+
+puts ; puts "Another way to get it is: "
+p ConfigDSL[:value]
+
+# Access block values
+
+puts "Block values: "
+
+puts ; puts "-- [:list][:one]"
+p ConfigDSL[:list][:one]
+
+puts ; puts "-- [:list][:two]"
+p ConfigDSL[:list][:two]
+
+puts ; puts "-- [:list][:three]"
+p ConfigDSL[:list][:three]
+
+puts ; puts "-- [:list][:three][:three_two]"
+p ConfigDSL[:list][:three][:three_two]
+
+# Get something complex
+puts ; puts "Program was stared at: "
+p ConfigDSL[:starting_time]
+```
+
+#### Check out the example!
+
+There is an `examples` dir. Check it out to see how it works for yourself!
+
+### Use Hashie::Mash
+
+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.
+
+
+### Ruby on Rails
+
+To be implemented. For now you can use it like standalone as initializer.
+
+### To-Do List
+
+ - Ruby on Rails integration
+ - Lazy config values
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/configdsl.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+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.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.add_runtime_dependency "activesupport"
+end

data/examples/example.rb

@@ -0,0 +1,56 @@
+$: << "../lib"
+require 'configdsl'
+
+# Read external data
+ConfigDSL.read("test.cdsl.rb")
+
+# Execute inline data
+ConfigDSL.execute do
+  inline_loading_example "here goes"
+  value "awesome"
+  code "great"
+  block_test "config option" do |preset|
+    block_val preset
+  end
+end
+
+# Another inline data
+ConfigDSL.execute do
+  value "awesome"
+end
+
+require "pp" # for pretty print
+
+# Here is how you get all the config
+pp ConfigDSL.data
+
+# To read data from your app you can do this:
+
+puts ; puts "Value of :value is: "
+p ConfigDSL.data[:value]
+
+# or this
+
+puts ; puts "Another way to get it is: "
+p ConfigDSL[:value]
+
+# Access block values
+
+puts "Block values: "
+
+puts ; puts "-- [:list][:one]"
+p ConfigDSL[:list][:one]
+
+puts ; puts "-- [:list][:two]"
+p ConfigDSL[:list][:two]
+
+puts ; puts "-- [:list][:three]"
+p ConfigDSL[:list][:three]
+
+puts ; puts "-- [:list][:three][:three_two]"
+p ConfigDSL[:list][:three][:three_two]
+
+# Get something complex
+puts ; puts "Program was stared at: "
+p ConfigDSL[:starting_time]
+

data/examples/test.cdsl.rb

@@ -0,0 +1,29 @@
+# Simple example
+hi "User"
+# p hi  # => "User"
+
+# Local variables still work!
+local_var = "it is me"
+another_var = "not included in config but can be used as usual"
+
+# Complex example
+list do
+  one "123"
+  two "345"
+  three do
+    one "1"
+    three_two one + " 2"
+    three_three "three"
+  end
+  see "will_be_ovewritten"
+end
+
+list 5 do |index|
+  append "anything"
+  second index + 1
+  square index ** 2
+  
+  see "overwritten!"
+end
+
+starting_time Time.now

data/lib/configdsl.rb

@@ -0,0 +1,165 @@
+require "configdsl/version"
+require "active_support/concern"
+require "forwardable"
+
+module ConfigDSL
+  module Memory
+    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
+      end
+    
+      # Main data container
+      def data
+        @data ||= layers_factory
+      end
+
+      # Stores a value in specified key for specified context
+      def store(key, value, context = [])
+        layer = expand_context(context)
+        layer[key] = value
+      end
+      
+      # Fetches a specified key for a specified context
+      # Allows to provide a default value
+      def fetch(key, defaul_value = nil, context = [])
+        fetch!(key, context)
+      rescue KeyError => e
+        defaul_value
+      end
+      
+      # Fetches a specified key for a specified context
+      # Raises exception if something goes wrong
+      def fetch!(key, context = [])
+        layer = expand_context(context)
+        raise KeyError, "In context #{context} key not found: #{key.inspect}" unless layer.has_key?(key)
+        layer[key]
+      end
+      
+      # Return a layer described by context or rises an exception
+      # if any of parent layers is undefined
+      def expand_context(context)
+        context.inject(data) do |hash, level|
+          hash[level]
+        end
+      end
+      
+      # Adds a new layer if it does not exist
+      def add_layer(new_layer, context)
+        current_layer = expand_context(context)
+        current_layer[new_layer] ||= layers_factory
+      end
+    end
+  end
+
+  module DSL    
+    extend ActiveSupport::Concern
+    
+    def self.debug?
+      false
+    end
+    
+    def context
+      @@context ||= []
+    end
+    
+    def debug(text)
+      puts text if DSL.debug?
+    end
+    
+    def varibales_hook(meth, *args, &block)
+      debug "Hooked #{meth}"
+      debug "Context is #{context}"
+      if block_given?
+        # Add list
+        debug "Adding list #{meth}"
+        evaluate_within_layer(meth, block, args)
+      else
+        if args.empty?
+          # Read variable
+          debug "Reading variable #{meth}"
+          Memory.fetch!(meth, context)
+        else
+          # Add variable
+          debug "Adding variable #{meth}"
+          value = args.size == 1 ? args.first : args.dup
+          Memory.store(meth, value, context)
+        end
+      end
+    end
+
+    def evaluate_within_layer(new_layer, block, args = [])
+      Memory.add_layer(new_layer, context)
+      begin
+        context.push new_layer
+        block.call(*args)
+      ensure
+        context.pop
+      end
+    end
+    
+    def method_missing(meth, *args, &block)
+      if respond_to?(meth)
+        super
+      else
+        varibales_hook(meth, *args, &block)
+      end
+    end
+
+  end
+  
+  module Processor
+    class Sandbox
+      include DSL
+    end
+
+    def self.process(filename)
+      sandbox = Sandbox.new
+      sandbox.instance_eval(File.read(filename), filename)
+      sandbox
+    end
+    
+    def self.execute(&block)
+      sandbox = Sandbox.new
+      sandbox.instance_eval(&block)
+      sandbox
+    end
+    
+    def self.add_module(module_const)
+      Sandbox.extend module_const
+    end
+  end
+  
+  class << self  
+    def read(filename)
+      Processor.process(filename)
+    end
+    
+    def execute(&block)
+      Processor.execute(&block)
+    end
+    
+    def data
+      Memory.data
+    end
+    
+    def method_missing(meth, *args, &block)
+      if data.respond_to?(meth)
+        data.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+    
+    def respond_to?(meth)
+      super_value = super
+      return super_value if super_value != false
+      data.respond_to?(meth)
+    end
+  end
+end

data/lib/configdsl/version.rb

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: configdsl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- MOZGIII
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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!
+email:
+- mike-n@narod.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- configdsl.gemspec
+- examples/example.rb
+- examples/test.cdsl.rb
+- lib/configdsl.rb
+- lib/configdsl/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A convinient DSL for your app configuration!
+test_files: []