breadboard 1.0.0.alpha.1 → 1.0.0.alpha.2

data/.gitignore

@@ -1,3 +1,4 @@
 *.sw?
 pkg/*
 *.gemspec
+*.gem

data/CHANGELOG

@@ -1,3 +1,9 @@
+v1.0.0.alpha.2
+  Bug fix: site in breadboard wasn't getting parsed
+
+v1.0.0.alpha.1
+  Complete rewrite. You now configure Breadboard through a Ruby DSL.
+
 v0.2.0
   Rails 3 compatible! thx Dorren Chen!
 

data/VERSION

@@ -1 +1 @@
-1.0.0.alpha.1
+1.0.0.alpha.2

data/features/active_resource.feature

@@ -59,4 +59,4 @@ Feature: ActiveResource::Base looks up site config in breadboard
     And an empty Breadboard configuration
     And my Rails environment is "production"
     When I call the model's site method
-    Then I should recieve an empty string
+    Then I should recieve nil

data/features/step_definitions/active_resource_steps.rb

@@ -137,15 +137,15 @@ Given /^my Rails environment is "([^"]*)"$/ do |environment|
 end
 
 Then /^I should recieve the value configured in the Breadboard "([^"]*)" environment settings for that model$/ do |environment|
-  NoSiteAttribute.site.to_s.should == Breadboard.config.NoSiteAttribute.send(environment.to_sym)
+  NoSiteAttribute.site.should == Breadboard.config.NoSiteAttribute.send(environment.to_sym)
 end
 
 Then /^I should recieve the value configured in the Breadboard "([^"]*)" environment settings for the ancestor of that model$/ do |environment|
-  NoSiteAttribute.site.to_s.should == Breadboard.config.Parent.send(environment.to_sym)
+  NoSiteAttribute.site.should == Breadboard.config.Parent.send(environment.to_sym)
 end
 
 Then /^I should recieve the value configured in the Breadboard "([^"]*)" environment settings in the breadboard defaults section$/ do |environment|
-  NoSiteAttribute.site.to_s.should == Breadboard.config.default.send(environment.to_sym)
+  NoSiteAttribute.site.should == Breadboard.config.default.send(environment.to_sym)
 end
 
 Then /^ActiveResource should ignore more generic configurations in Breadboard$/ do
@@ -154,6 +154,6 @@ end
 Given /^an empty Breadboard configuration$/ do
 end
 
-Then /^I should recieve an empty string$/ do
-  NoSiteAttribute.site.to_s.should be_empty 
+Then /^I should recieve nil$/ do
+  NoSiteAttribute.site.should be_nil
 end

data/features/step_definitions/configure_steps.rb

@@ -17,8 +17,8 @@ Then /^I should be able to configure breadboard via Ruby blocks$/ do
     end
   end
 
-  Breadboard.config.default.all.should == "http://localhost:3000"
-  Breadboard.config.default.production.should == "http://test.com"
+  Breadboard.config.default.all.to_s.should == "http://localhost:3000"
+  Breadboard.config.default.production.to_s.should == "http://test.com"
 end
 
 Then /^I should be able to create a default configuration via the "default" Config method$/ do
@@ -31,8 +31,8 @@ Then /^I should be able to create a default configuration via the "default" Conf
     end
   end
 
-  Breadboard.config.default.all.should == "http://localhost:3000"
-  Breadboard.config.default.production.should == "http://test.com"
+  Breadboard.config.default.all.to_s.should == "http://localhost:3000"
+  Breadboard.config.default.production.to_s.should == "http://test.com"
 end
 
 Then /^I should be able to configure models via their lowercased, underscored method equivalents$/ do
@@ -40,11 +40,11 @@ Then /^I should be able to configure models via their lowercased, underscored me
   
   Breadboard.configure do
     article do
-      production "haha"
+      production "http://haha"
     end
   end
   
-  Breadboard.config.Article.production.should == "haha"
+  Breadboard.config.Article.production.to_s.should == "http://haha"
 end
 
 Then /^I should be able to configure a model by passing the constant for the model to the "model" method$/ do
@@ -52,11 +52,11 @@ Then /^I should be able to configure a model by passing the constant for the mod
   
   Breadboard.configure do
     model Smarticle do
-      production "haha"
+      production "http://haha"
     end
   end
   
-  Breadboard.config.Smarticle.production.should == "haha"
+  Breadboard.config.Smarticle.production.to_s.should == "http://haha"
 end
 
 Then /^I should be able to configure multiple models simultaneously by passing their constants to the "models" method$/ do
@@ -65,12 +65,12 @@ Then /^I should be able to configure multiple models simultaneously by passing t
   
   Breadboard.configure do
     models Particle, Yarticle do
-      production "haha"
+      production "http://haha"
     end
   end
   
-  Breadboard.config.Particle.production.should == "haha"
-  Breadboard.config.Yarticle.production.should == "haha"
+  Breadboard.config.Particle.production.to_s.should == "http://haha"
+  Breadboard.config.Yarticle.production.to_s.should == "http://haha"
 end
 
 Then /^I should be able to override the default Rails\.env environment retrieval in case I'm not in a rails app$/ do

data/features/step_definitions/reset_steps.rb

@@ -7,7 +7,7 @@ Given /^I have configured breadboard$/ do
 end
 
 When /^I call the method Breadboard\.reset$/ do
-  Breadboard.config.default.all.should == "http://test.com"
+  Breadboard.config.default.all.to_s.should == "http://test.com"
   Breadboard.reset
 end
 

data/lib/breadboard/environment.rb

@@ -7,12 +7,12 @@ module Breadboard
 
       def test(url=nil)
         return @environments[:test] if url.nil?
-        @environments[:test] = url
+        @environments[:test] = URI.parse url
       end
 
       def method_missing(method_name, *args, &block)
         return @environments[method_name] if args.length == 0
-        @environments[method_name] = args.first 
+        @environments[method_name] = URI.parse args.first 
       end
     end
   end

data/readme.md

@@ -1,53 +1,131 @@
 #Introduction
 
-breadboard.yml is to ActiveResource as database.yml is to ActiveRecord, taking the data source configuration out of the models and putting it where it belongs, in a configuration file. If the services you connect your ActiveResource models to depends on your RAILS_ENV, then breadboard is for you.
+Change your ActiveResource service providers based on your environment.
 
 ##Install
 
 Breadboard is available as a gem: 
 
-  # gem install breadboard
-
-If you'd like to use this in your rails project, add the following to your config/environment.rb:
-
-  config.gem 'breadboard'
+    # gem install breadboard
 
 ##Usage
 
-All you have to do is create a breadboard.yml file in your RAILS_ROOT/config directory. 
+If you're using this in a Rails app, you'll want to configure `Breadboard` in an initializer.
 
-In the simplest scenario, all of your ActiveResource models connect to the same service provider in all environments. In this case, you really don't need this gem, but if you're determined to use it just because you know it's the coolest thing ever, then we've got you covered:
+In the simplest scenario, all of your `ActiveResource` models connect to the same service provider in all environments. 
+In this case, you really don't need this gem, but if you're determined to use it just because you know it's the coolest thing ever, then we've got you covered:
 
-  default:
-    all: http://my.universal.service.provider.com
+    Breadboard.configure do
+      default do
+        all "http://my.universal.service.provider.com"
+      end
+    end
 
-This means: for all ActiveResource models, in all environments, connect them to http://my.universal.service.provider.com
+This means: for all ActiveResource models, in all environments, connect them to `http://my.universal.service.provider.com`
 
-However, it's more likely that you're using this gem because you are in a situation where you need to connect your models to different services based on a rails environment. This is also trivial with breadboard:
+However, it's more likely that you're using this gem because you are in a situation where you need to connect your models to different 
+services based on a rails environment. This is also trivial with breadboard:
 
-  default:
-    production: http://my.production.service.provider.com
-    development: http://my.development.service.provider
-  
+    Breadboard.configure do
+      default do
+        all "http://my.universal.service.provider.com"
+        production "http://my.production.service.provider.com"
+      end
+    end
+ 
 Now suppose you have an 'Author' model that needs to connect to a completely different service from everything else, in all environments:
-  
-  default:
-    production: http://my.production.service.provider.com
-    development: http://my.development.service.provider
 
-  author:
-    all: http://my.author.service.prodiver
+    Breadboard.configure do
+      default do
+        all "http://my.universal.service.provider.com"
+        production "http://my.production.service.provider.com"
+      end
+      
+      author do 
+        all "http://my.author.service.provider"
+      end
+    end
+
+You can use this alternate syntax, if you prefer:
+
+    Breadboard.configure do
+      default do
+        all "http://my.universal.service.provider.com"
+        production "http://my.production.service.provider.com"
+      end
+      
+      model Author do 
+        all "http://my.author.service.provider"
+      end
+    end
 
 Now suppose you have a 'Book' model that needs to connect to a different service provider than the default when in 'production' mode:
 
-  default:
-    production: http://my.production.service.provider.com
-    development: http://my.development.service.provider
+    Breadboard.configure do
+      default do
+        all "http://my.universal.service.provider.com"
+        production "http://my.production.service.provider.com"
+      end
+      
+      model Author do 
+        all "http://my.author.service.provider"
+      end
+
+      model Book do
+        production "http://my.book.production.service.provider"
+      end
+    end
+
+## Configuring the environment
+
+By default, Breadboard will check `Rails.env` to see what environment your app is in. 
+
+If your using Breadboard in something other than a rails app, you can configure how Breadboard determines your app's environment:
+
+    Breadboard.configure do
+      env do
+        # your app environment lookup logic here
+      end
+    end
+
+## Mutiple models with the same configuration
+
+Imagine you have several models that all share the same app configuration. There's two ways to about this configuration:
+
+- Let all of your models inherit from the same parent class and configure the parent class in breadboard
+- use the `models` method
+
+### Inheritance
+
+Let's imagine you have three models that should all share the same configuration: `Article`, `Author`, `Comment`. If they all inherited from the same parent, 
+`Publishing`, then you could simply configure the parent class in breadboard:
+
+    Breadboard.configure do
+      model Publishing do 
+        all "http://my.publishing.service.provider"
+      end
+    end
+
+If any of the children needed some configuration override, that will take precedence
+
+    Breadboard.configure do
+      model Publishing do 
+        all "http://my.publishing.service.provider"
+      end
+
+      model Article do
+        production "http://my.article.production.service.provider"
+      end
+    end
+
+### `models` Method
 
-  author:
-    all: http://my.author.service.prodiver
-  
-  book:
-    production: http://my.book.production.service.provider
+If your `Article`, `Author`, and `Comment` models couldn't all inherit from the same parent, you can still easily provide the same configuration for them 
+via the `models` method:
 
-I think you can see where this is going...
+    Breadboard.configure do
+      models Article, Author, Comment do 
+        all "http://my.publishing.service.provider"
+        production "http://my.production.publishing.service.provider"
+      end
+    end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: breadboard
 version: !ruby/object:Gem::Version 
-  hash: -3702664322
+  hash: -3702664328
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - alpha
-  - 1
-  version: 1.0.0.alpha.1
+  - 2
+  version: 1.0.0.alpha.2
 platform: ruby
 authors: 
 - Matt Parker