config_fun 0.4.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--debug

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+  gem 'ruby-debug'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.43)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Grant Ammons
+
+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,121 @@
+## ConfigFun:  Beautiful configurations for your projects and gems
+
+http://github.com/gammons/config_fun
+
+## DESCRIPTION:
+
+Does your gem or project need the user to create or add configuration to it?  Use ConfigFun to allow them to easily configure your gem, in a quick, terse and painless way!
+
+## SYNOPSIS:
+
+Adding ConfigFun to your project is super easy.  Include the config_fun gem as part of your gem's dependencies.  
+
+Say you need to write a configuration that allows the user to add their account information, name, password, and some IMAP information.
+With ConfigFun, the configuration could look like this:
+
+```ruby
+account "personal" do
+  name "grant"
+  password "bungalow"
+
+  imap do
+    server "imap.gmail.com"
+    ssl true
+  end
+end
+```
+
+To parse this configuration, you'd simply Say the following:
+
+```ruby
+config = ConfigFun.parse!(File.read(account_information_file))
+```
+
+..and the config variable would include a sweet hash of all the info the user provided!
+
+```ruby
+config == {:account=> {:password => "bungalow", :imap => {:ssl => true, :server => "imap.gmail.com"}, :name => "grant"}}
+```
+
+## DETAILS:
+
+
+### Arrays
+
+if ConfigFun encounters a block twice within the same context, it will create an array.
+
+```ruby
+user do
+  room "123"
+end
+
+user do
+  room "456"
+end
+```
+
+The resulting hash will have a `:user` key with an array of `:room`s as the value.
+
+```ruby
+{:user=>[{:room=>"123"}, {:room=>"456"}]}
+```
+
+### An important caveat
+
+Blocks do not take any paramters.  You may be tempted to do something like the following:
+
+```ruby
+user "Bob" do
+  room "123"
+end
+```
+
+ConfigFun <strong>will not</strong> be able to parse this, because there is no equivalent hash it can boil down to.
+
+The correct way to write the above code for ConfigFun is as follows:
+
+```ruby
+user do
+  name "bob"
+  room "123"
+end
+```
+
+## REQUIREMENTS:
+
+* None!
+* Tested against ruby 1.8.7 and 1.9.2.
+
+## INSTALL:
+
+`gem install config_fun`
+
+## AUTHORS:
+
+* Grant Ammons
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Grant Ammons (grant@pipelinedealsco.com)
+
+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/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "config_fun"
+  gem.homepage = "http://github.com/gammons/config_fun"
+  gem.license = "MIT"
+  gem.summary = %Q{A beautiful configuration maker for your gem or project}
+  gem.description = %Q{does your gem or project require configuration?  This will make creating and parsing configuration a snap!}
+  gem.email = "grant@pipelinedealsco.com"
+  gem.authors = ["Grant Ammons"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "config_fun #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/config_fun.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{config_fun}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Grant Ammons"]
+  s.date = %q{2011-10-30}
+  s.description = %q{does your gem or project require configuration?  This will make creating and parsing configuration a snap!}
+  s.email = %q{grant@pipelinedealsco.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "config_fun.gemspec",
+    "lib/config_fun.rb",
+    "spec/config_fun_spec.rb",
+    "spec/examples/config.rb",
+    "spec/examples/test.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gammons/config_fun}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{A beautiful configuration maker for your gem or project}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+  end
+end
+

data/lib/config_fun.rb

@@ -0,0 +1,75 @@
+class ConfigFun
+  def self.parse!(str = nil, &block)
+    self.new(str, &block).__config
+  end
+
+  def initialize(str = nil, &block)
+    @__config = {}
+    @__cur = @__config
+    @__parents = []
+    instance_eval(&block) if block_given?
+    instance_eval(str) if str
+  end
+
+    def method_missing(m, *args, &block)
+      m = (m.to_s[1..(m.to_s.size - 1)]).to_sym if m.to_s.index("_") == 0
+      @__cur = @__parents.reduce(@__config) do |hash, cur|
+        hash[cur].class == Array ? hash[cur].last : hash[cur]
+      end
+
+      if m == :partial
+        read_partial(args)
+      elsif block_given?
+        $stderr << "Warning, ignoring args passed to a block.  args = '#{args}'\n" if args.count >= 1
+        if (@__cur[m].nil? or @__cur[m].class == Hash) and (@__cur[m] == {} or not @__cur.keys.include?(m))
+          @__parents << m
+          @__cur[m] = {}
+          @__cur = @__cur[m]
+          instance_eval(&block)
+          @__parents.pop
+        elsif @__cur[m].class == Hash    # we've seen this element before, so convert to array.
+          @__parents << m
+          if @__parents.count > 1
+            grandparent = @__parents[0..(@__parents.count - 2)]
+            parent = @__parents[@__parents.count - 1]
+
+            val = @__parents[0..(@__parents.count - 2)].reduce(@__config) do |hash, cur|
+              hash[cur].class == Array ? hash[cur].last : hash[cur]
+            end[parent]
+
+            @__parents[0..(@__parents.count - 2)].reduce(@__config) do |hash, cur|
+              hash[cur].class == Array ? hash[cur].last : hash[cur]
+            end[parent] = [val]
+
+            @__cur = @__parents[0..(@__parents.count - 2)].reduce(@__config)  do |hash, cur|
+              hash[cur].class == Array ? hash[cur].last : hash[cur]
+            end[parent]
+          else
+            # case where we are the first item
+            @__config[m] = [@__config[m]]
+            @__cur = @__config[m]
+          end
+
+          @__cur << {}
+          instance_eval(&block)
+          @__parents.pop
+        elsif @__cur[m].class == Array   # already an array so just append our new element
+          @__parents << m
+          @__cur[m] << {}
+          @__cur = @__cur[m].last
+          instance_eval(&block)
+          @__parents.pop
+        end
+      else
+        if @__cur.class == Array
+          @__cur.last[m] = args.first
+        else
+          @__cur[m] = args.first
+        end
+      end
+    end
+
+    def __config
+      @__config
+    end
+end

data/spec/config_fun_spec.rb

@@ -0,0 +1,149 @@
+require 'config_fun'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "config_fun" do
+  context "dsl" do
+    it "should be able to use reserved words with an underscore" do
+      struct = ConfigFun.parse! do
+        _id 1
+        _def 'dingle'
+        _class 'bargle'
+      end
+      struct.should == {:class=>"bargle", :def=>"dingle", :id=>1}
+    end
+
+    it "should be able to nest hashes within hashes" do
+      struct = ConfigFun.parse! do
+        @person = "bob"
+        entries do
+          person do
+            name @person
+            height "5 feet"
+          end
+          shirt "green"
+        end
+      end
+      struct.should == {:entries=>{:person=>{:height=>"5 feet", :name=>"bob"}, :shirt=>"green"}}
+    end
+
+    it "should convert multiple entries of the same hash key to an array" do
+      struct = ConfigFun.parse! do
+        entries do
+          dingle do
+            harble "barble"
+          end
+          people do
+            person do
+              name "john"
+              height "5 feet"
+            end
+            person do
+              name "bob"
+              height "6 feet"
+            end
+          end
+          shirt "green"
+        end
+      end
+      struct.should == {:entries => {:dingle => {:harble => "barble"}, :people => {:person => [{:height=>"5 feet", :name=>"john" },{:height=>"6 feet", :name=>"bob"}]}, :shirt => 'green'}}
+    end
+
+    it "should be able to handle 3 or more array entries" do
+      struct = ConfigFun.parse! do
+        @people = ["sue","bob","sally","jim"]
+        @people.each do |name|
+          person do
+            name name
+          end
+        end
+      end
+      struct.should == {:person => [{:name => "sue"}, {:name=>"bob"}, {:name=>"sally"}, {:name=>"jim"}]}
+    end
+
+    it "should see variables defined within its scope inside blocks" do
+      struct = ConfigFun.parse! do
+        @person = "bob"
+        entries do
+          person do
+            brain do
+              iq 100
+            end
+            name @person
+            height "5 feet"
+          end
+          shirt "green"
+        end
+      end
+      struct.should == {:entries=>{:person=>{:height=>"5 feet", :name=>"bob", :brain=>{:iq=>100}}, :shirt=>"green"}}
+    end
+
+    it "should be able to handle arrays both outer and inner" do
+      struct = ConfigFun.parse! do
+        entries do
+          person do
+            name "bob"
+            colors do
+              red "red"
+              green "green"
+            end
+            colors do
+              brown "brown"
+              orange "orange"
+            end
+          end
+
+          person do
+            name "jim"
+            colors do
+              blue "blue"
+              pink "pink"
+            end
+            colors do
+              purple "purple"
+              dark_brown "dark brown"
+            end
+          end
+        end
+      end
+      struct.should == {:entries=>{:person=>[{:colors=>[{:red=>"red", :green=>"green"}, {:orange=>"orange", :brown=>"brown"}], :name=>"bob"}, {:colors=>[{:blue=>"blue", :pink=>"pink"}, {:purple=>"purple", :dark_brown=>"dark brown"}], :name=>"jim"}]}}
+    end
+
+    it "the base entry should be able to carry an array" do
+      struct = ConfigFun.parse! do
+        entry do
+          item "item1"
+        end
+
+        entry do
+          item "item2"
+        end
+
+        entry do
+          item "item3"
+        end
+      end
+      struct.should == {:entry=>[{:item=>"item1"}, {:item=>"item2"}, {:item=>"item3"}]}
+    end
+  end
+
+  context "real-world example use" do
+    let(:config) do
+      config = ConfigFun.parse!(File.read(File.expand_path(File.dirname(__FILE__) + '/examples/test.rb')))
+    end
+
+    it "should parse a config correctly" do
+      expected = {:config=>{:user=>[{:name=>"bob"}, {:name=>"jim"}]}}
+      config.should == expected
+    end
+  end
+
+  it "should warn the user if they pass arguments to a block" do
+    $stderr.should_receive("<<").with(/Warning, ignoring args passed to a block/)
+    struct = ConfigFun.parse! do
+      user "bob" do
+        room '123'
+      end
+    end
+
+  end
+end

data/spec/examples/config.rb

@@ -0,0 +1,9 @@
+account "personal" do
+  name "grant"
+  password "bungalow"
+
+  imap do
+    server "imap.gmail.com"
+    ssl true
+  end
+end

data/spec/examples/test.rb

@@ -0,0 +1,9 @@
+config do
+  user do
+    name "bob"
+  end
+
+  user do
+    name "jim"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: config_fun
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Grant Ammons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: ruby-debug
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+description: does your gem or project require configuration?  This will make creating and parsing configuration a snap!
+email: grant@pipelinedealsco.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- config_fun.gemspec
+- lib/config_fun.rb
+- spec/config_fun_spec.rb
+- spec/examples/config.rb
+- spec/examples/test.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/gammons/config_fun
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A beautiful configuration maker for your gem or project
+test_files: []
+