multi_toml 1.0.0

data/LICENSE

@@ -0,0 +1,10 @@
+## Copyright and license
+
+Copyright 2013 James A. Rosen
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/README.md

@@ -0,0 +1,23 @@
+# multi_toml
+
+multi_toml is an interface gem for https://github.com/mojombo/toml.
+
+There are many great TOML libraries out there. If you're writing an application,
+you should be able to use any one you want. If you're writing a library that
+other libraries or applications will use, you should use multi_toml so that you
+don't impose a particular implementation on the consuming application.
+
+## Implementations
+
+ * https://rubygems.org/gems/toml
+ * https://rubygems.org/gems/toml-ruby
+ * https://rubygems.org/gems/toml_parser-ruby
+ * https://rubygems.org/gems/toml2
+
+## Seriously?
+
+Not entirely seriously, no.
+
+## But Why?
+
+Because application developers shouldn't have to install 3 TOML libraries.

data/lib/multi_toml.rb

@@ -0,0 +1,52 @@
+module MultiToml
+
+  PARSER_MAP = {
+    :toml      => lambda { |toml| TOML::Parser.new(toml).parsed },
+    :toml_ruby => lambda { |toml| Toml.load(toml) },
+    :toml2     => lambda { |toml| TOML.load(toml) }
+  }
+
+  class NoParserError < RuntimeError
+    def initialize(adapter)
+      super(adapter.nil? ? 'Could not detect a TOML parser' : "No TOML parser for #{adapter}")
+    end
+  end
+
+  def load(input)
+    parser.call(input)
+  end
+
+  def adapter
+    return @adapter if defined?(@adapter)
+    @adapter = detect_adapter
+  end
+
+  def adapter=(adapter)
+    @adapter = adapter
+  end
+
+  def detect_adapter
+    begin
+      require 'toml'
+      TOML.respond_to?(:load) ? :toml2 : :toml
+    rescue LoadError
+      begin
+        require 'toml-ruby'
+        :toml_ruby
+      rescue LoadError
+        nil
+      end
+    end
+  end
+
+  def parser
+    PARSER_MAP[adapter] or raise NoParserError.new(adapter)
+  end
+
+  extend self
+
+  class << self
+    private :detect_adapter, :parser
+  end
+
+end

data/spec/adapter_spec.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+describe 'MultiToml' do
+
+  let(:tomler) do
+    Object.new.tap do |o|
+      o.extend MultiToml
+    end
+  end
+
+  subject { tomler.load('anything') }
+
+  describe 'toml adapter' do
+    before do
+      parser = Class.new
+      parser.class_eval do
+        def initialize(input)
+        end
+
+        def parsed
+          'result'
+        end
+      end
+      toml = Module.new
+      toml.const_set :Parser, parser
+      Object.const_set(:TOML, toml)
+      tomler.adapter = :toml
+    end
+    after do
+      Object.send :remove_const, :TOML
+    end
+    it { should == 'result' }
+  end
+
+  describe 'toml_ruby adapter' do
+    before do
+      Object.const_set(:Toml, double(:load => 'result'))
+      tomler.adapter = :toml_ruby
+    end
+    after do
+      Object.send :remove_const, :Toml
+    end
+    it { should == 'result' }
+  end
+
+  describe 'toml2 adapter' do
+    before do
+      Object.const_set(:TOML, double(:load => 'result'))
+      tomler.adapter = :toml2
+    end
+    after do
+      Object.send :remove_const, :TOML
+    end
+    it { should == 'result' }
+  end
+
+end

data/spec/detect_adapter_spec.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+describe 'MultiToml.detect_adapter' do
+
+  let(:tomler) do
+    Object.new.tap do |o|
+      o.extend MultiToml
+    end
+  end
+
+  subject { tomler.adapter }
+
+  describe 'when no adapter is available' do
+    before { tomler.stub(:require).and_raise(LoadError) }
+    it { should == nil }
+  end
+
+  # TODO: I would like to change these tests to actually load the libraries
+  #       and then unload them after each run. I tried this four different
+  #       ways and then gave up. Right now, they're pretty brittle tests.
+
+  describe 'when toml is available' do
+    before do
+      tomler.stub(:require).with('toml')
+      tomler.stub(:require).with('toml-ruby').and_raise(LoadError)
+      Object.const_set(:TOML, Object.new)
+    end
+    after do
+      Object.send :remove_const, :TOML
+    end
+    it { should == :toml }
+  end
+
+  describe 'when toml-ruby is available' do
+    before do
+      tomler.stub(:require).with('toml').and_raise(LoadError)
+      tomler.stub(:require).with('toml-ruby')
+    end
+    it { should == :toml_ruby }
+  end
+
+  describe 'when toml-ruby is available' do
+    before do
+      tomler.stub(:require).with('toml')
+      tomler.stub(:require).with('toml-ruby').and_raise(LoadError)
+      Object.const_set(:TOML, double(:load => ''))
+    end
+    after do
+      Object.send :remove_const, :TOML
+    end
+    it { should == :toml2 }
+  end
+
+end

data/spec/no_adapter_spec.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+describe 'MultiToml, when no adapter is loaded' do
+
+  describe '' do
+    let(:tomler) do
+      Object.new.tap do |o|
+        o.extend MultiToml
+        o.stub(:detect_adapter).and_return(nil)
+      end
+    end
+
+    subject { tomler.load('foo = bar') }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error(MultiToml::NoParserError)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: multi_toml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- James A. Rosen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70095622560160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095622560160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70095622559680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: *70095622559680
+description: A gem to provide easy switching between different TOML backends, including
+  toml, toml-ruby, and toml2.
+email: james.a.rosen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/multi_toml/implementation.rb
+- lib/multi_toml.rb
+- README.md
+- LICENSE
+- spec/adapter_spec.rb
+- spec/detect_adapter_spec.rb
+- spec/no_adapter_spec.rb
+homepage: http://github.com/jamesarosen/multi_toml
+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.10
+signing_key: 
+specification_version: 2
+summary: A gem to provide swappable TOML backends.
+test_files:
+- spec/adapter_spec.rb
+- spec/detect_adapter_spec.rb
+- spec/no_adapter_spec.rb
+has_rdoc: 'false'