confy 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle/**
+vendor/**

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    confy (0.1.0)
+      crack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  confy!
+  rspec

data/README.md

@@ -0,0 +1,24 @@
+# Confy
+
+Reads configuration-like files and makes them Object-like.
+
+### Backends
+- xml
+- json
+- yaml
+- 'simple' (e.g. x=1)
+
+### Examples
+
+
+    # Given an generic conf file:
+    # name=james\nage=42
+    Confy.parse("/path/to/person.xyz", :as => "SimpleAssignment").name
+    # => "james"
+
+    # Given an XML file:
+    # <person><address><city>Birmingham</city></address></perso>
+    Confy.parse("/path/to/person.xml").person.address.city
+    # => "Birmingham"
+
+

data/confy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'confy/version'
+
+Gem::Specification.new do |s|
+  s.name        = "confy"
+  s.version     = Confy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["James Cook"]
+  s.email       = ["james@isotope11.com"]
+  s.summary     = %q{Configuration parser}
+  #s.description = %q{}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "confy"
+
+  s.add_dependency "crack"
+  s.add_development_dependency "rspec"
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths      = ["lib"]
+end

data/lib/confy.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require "ostruct"
+
+lib = File.expand_path('../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require  "hash_to_ostruct.rb"
+
+module Confy
+  autoload :Core,    "confy/core"
+  autoload :Backend, "confy/backend"
+
+  def parse *args
+    core = Core.new *args
+    core.parse
+  end
+
+  def [] *args
+    parse *args
+  end
+
+  module_function :parse, :[]
+end

data/lib/confy/backend.rb

@@ -0,0 +1,18 @@
+lib = File.expand_path('../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+module Confy
+  module Backend
+    require  "backend/base"
+    autoload "Yaml",            "backend/yaml"
+    autoload "Json",            "backend/json"
+    autoload "Xml",             "backend/xml"
+    autoload "SimpleAssignment","backend/simple_assignment"
+
+    # Link up the backends to matching file extensions
+    register :json
+    register :xml
+    register :simple_assignment
+    register :yaml, :yml, :as => "Yaml"
+  end
+end

data/lib/confy/backend/base.rb

@@ -0,0 +1,28 @@
+module Confy
+  module Backend
+    class Base
+      def self.which(path)
+        extension = extensions.dup.detect{|e,klass| e.to_s == File.extname(path)[1..-1] }
+        if extension
+          Backend.const_get(extension.pop)
+        else
+          raise Confy::UnsupportedFileExtensionError, "No backend available for #{path}."
+        end
+      end
+
+      def self.extensions
+        @extensions ||= Set.new
+      end
+    end
+
+    # backend should call this method automatically once defined to register themselves as a backend
+    def register *args
+      options      = args.last.is_a?(Hash) ? args.pop : {}
+      extension    = args.first
+      options[:as] = "#{extension.to_s[0].upcase}#{extension.to_s[1..-1]}" if options[:as].nil?
+      args.flatten.map{|ext| Base.extensions.<<([ext.to_s, options[:as].to_s]) }
+    end
+
+    module_function :register
+  end
+end

data/lib/confy/backend/json.rb

@@ -0,0 +1,15 @@
+module Confy
+  module Backend
+    class Json < Hash
+      def initialize path
+        require "json"
+        @config = ::JSON.parse(::File.read(path)).to_ostruct
+      end
+
+      def method_missing *args
+        @config.send args.shift
+      end
+    end
+  end
+end
+

data/lib/confy/backend/simple_assignment.rb

@@ -0,0 +1,52 @@
+# Example:
+# #my.conf
+# x=1
+# y=2
+# z:3
+# Confy.parse("my.conf", :as => :simple_assignment)
+module Confy
+  module Backend
+
+    class SimpleAssignment < Hash
+      def initialize path
+        @config = __parse path
+      end
+
+      def self.splitter pattern=nil
+        if pattern
+          @splitter = pattern
+        end
+
+        @splitter ||= /=|:/
+      end
+
+      def self.comment_pattern pattern=nil
+        if pattern
+          @comment_pattern = pattern
+        end
+
+        @comment_pattern ||= /\A#/
+      end
+
+      def method_missing *args
+        @config.send args.shift
+      end
+
+      private
+      def __parse path
+        @config = {}
+        ::File.readlines(path).each do |line|
+          key,val = line.split(SimpleAssignment.splitter)
+          if key && val
+            key.strip!; val.strip!
+            next if key =~ SimpleAssignment.comment_pattern
+            @config[key] = val.chomp
+          end
+        end
+        @config.to_ostruct
+      end
+    end
+    register :simple_assignment
+  end
+end
+

data/lib/confy/backend/xml.rb

@@ -0,0 +1,17 @@
+module Confy
+  module Backend
+
+    class Xml < Hash
+      def initialize path
+        require "crack/xml"
+        @config = ::Crack::XML.parse(::File.read(path)).to_ostruct
+      end
+
+      def method_missing *args
+        @config.send args.shift
+      end
+    end
+    register :xml
+  end
+end
+

data/lib/confy/backend/yaml.rb

@@ -0,0 +1,16 @@
+module Confy
+  module Backend
+    class Yaml < Hash
+      def initialize path
+        require "yaml"
+        @config = ::YAML.load_file(path).to_ostruct
+      end
+
+      def method_missing *args
+        @config.send args.shift
+      end
+    end
+    register :yaml, :yml, :as => "Yaml"
+  end
+end
+

data/lib/confy/core.rb

@@ -0,0 +1,32 @@
+module Confy
+  class Core
+    attr_reader :backend, :path
+    def initialize *args
+      @path, *rest = args
+      tail = rest.pop
+      if tail.is_a?(Hash)
+        set_options tail
+      end
+      raise FileNotFoundError unless @path && File.exist?(@path)
+    end
+
+    def inspect
+      backend ? backend.inspect : "<Confy::Core>"
+    end
+
+    def parse
+      @backend ||= Backend::Base.which(@path)
+      @backend.new @path
+    end
+
+    private
+    def set_options options
+      if options[:as]
+        @backend = Backend.const_get options[:as].to_s
+      end
+    end
+  end
+
+  class FileNotFoundError             < StandardError; end
+  class UnsupportedFileExtensionError < StandardError; end
+end

data/lib/confy/version.rb

@@ -0,0 +1,3 @@
+module Confy
+  VERSION = "0.2.0"
+end

data/lib/hash_to_ostruct.rb

@@ -0,0 +1,15 @@
+# Allow for recursive ostruct goodness
+# TODO Less monkey patching
+Hash.class_eval do
+  def to_ostruct
+    open_struct = OpenStruct.new
+    each { | key, value | open_struct.send("#{key}=", (value.respond_to?(:to_ostruct) ? value.to_ostruct : value) )}
+    open_struct
+  end
+end
+
+Array.class_eval do
+  def to_ostruct
+    map { | element | element.to_ostruct }
+  end
+end

data/spec/backend/json_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Confy do
+  context ".parse" do
+    context "given a json file" do
+      it "should parse the file" do
+        path = File.join(fixture_path, "sample.json")
+        config = Confy.parse( path ) 
+        config.should be_an_instance_of(Confy::Backend::Json)
+        config.name.should == "bob"
+        config.age.should == "42"
+      end
+    end
+  end
+end
+

data/spec/backend/simple_assignment_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Confy do
+  context ".parse" do
+    context "with :as => 'SimpleAssignment'" do
+      it "should parse the file" do
+        path = File.join(fixture_path, "sample.conf")
+        config = Confy.parse( path, :as => "SimpleAssignment") 
+        config.should be_an_instance_of(Confy::Backend::SimpleAssignment)
+        config.name.should == "james"
+        config.age.should == "27"
+        config.location.should == "Birmingham"
+      end
+    end
+  end
+end

data/spec/confy_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Confy do
+  context ".parse" do
+    context "given a valid path" do
+      context "given a supported extension" do
+        it "should parse the file" do
+          path = File.join(fixture_path, "sample.yml")
+          config = Confy.parse( path ) 
+          config.should be_an_instance_of(Confy::Backend::Yaml)
+          config.one.should == "one"
+          config.two.should == "two"
+          config.three.name.should == "bob"
+        end
+      end
+
+      context "given a unsupported extension" do
+        it "should raise UnsupportedFileExtension" do
+          path = File.join(fixture_path, "invalid.wtf")
+          lambda{ Confy.parse( path )}.should raise_error(Confy::UnsupportedFileExtensionError)
+        end
+      end
+    end
+
+    context "given a invalid path" do
+      it "should raise FileNotFound" do
+        path = "/tmp/asdf/"
+        lambda{ Confy.parse( path )}.should raise_error(Confy::FileNotFoundError)
+      end
+    end
+  end
+end

data/spec/fixtures/invalid.wtf

@@ -0,0 +1 @@
+E>( o )<3

data/spec/fixtures/sample.conf

@@ -0,0 +1,6 @@
+# comment
+name=james
+age=27
+location = Birmingham
+
+# another comment

data/spec/fixtures/sample.json

@@ -0,0 +1 @@
+{"name": "bob", "age": "42"}

data/spec/fixtures/sample.xml

@@ -0,0 +1,8 @@
+<person>
+  <name>Bob</name>
+  <age>200</age>
+  <address>
+    <state>AL</state>
+    <city>Birmingham</city>
+  </address>
+</person>

data/spec/fixtures/sample.yml

@@ -0,0 +1,4 @@
+one: "one"
+two: "two"
+three:
+  name: "bob"

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+lib = File.expand_path('../../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "confy"
+
+RSpec.configure do
+  def fixture_path
+    File.join( File.dirname(__FILE__), "fixtures" )
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: confy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- James Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- james@isotope11.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- confy.gemspec
+- lib/confy.rb
+- lib/confy/backend.rb
+- lib/confy/backend/base.rb
+- lib/confy/backend/json.rb
+- lib/confy/backend/simple_assignment.rb
+- lib/confy/backend/xml.rb
+- lib/confy/backend/yaml.rb
+- lib/confy/core.rb
+- lib/confy/version.rb
+- lib/hash_to_ostruct.rb
+- spec/backend/json_spec.rb
+- spec/backend/simple_assignment_spec.rb
+- spec/confy_spec.rb
+- spec/fixtures/invalid.wtf
+- spec/fixtures/sample.conf
+- spec/fixtures/sample.json
+- spec/fixtures/sample.xml
+- spec/fixtures/sample.yml
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: confy
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Configuration parser
+test_files: 
+- spec/backend/json_spec.rb
+- spec/backend/simple_assignment_spec.rb
+- spec/confy_spec.rb
+- spec/fixtures/invalid.wtf
+- spec/fixtures/sample.conf
+- spec/fixtures/sample.json
+- spec/fixtures/sample.xml
+- spec/fixtures/sample.yml
+- spec/spec_helper.rb