turf 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537d868afadd91478e29bfbc4b869983647ef663
-  data.tar.gz: 041f84e0ca6466e02ecda45e5d667b9209f9d9ef
+  metadata.gz: 041d3a291a6ed153c3b5f82fcd2c354c1a25113d
+  data.tar.gz: f4db87acd04ab1142806de020c1fbadf7a816883
 SHA512:
-  metadata.gz: 5db00b767ed41f28cffe57361c11e2c0de06dea1baa9246295230a4c52cc74839b545f1cfd8942d2413ca73bde7b4ede146740cfbcd54f71ee91e4ea2c20eb51
-  data.tar.gz: 9f5c21950b3047fb8c4dd57a912c4222dc5410c9bdf7592598d1f50a60a86b171f34d8bf8a8e32d590bfaac34d510fb15fc3eea12c7f9786d474870d0199b21f
+  metadata.gz: da5eefaa8107fcd0112d644351a97dc9424e46282569bc94356c03af080f92b24227f13ebe9b0a580852c913e024f65e442864c3d5b1a805230aafec455689a8
+  data.tar.gz: c86be7230bea291951c31a1640d0c554d2999e23b0bfcc017b69dfae52cc38e1964821cac07a8046f263e482ca79ddbf74c0ee9b6772e04bfc6b2734c7104a55

data/README.md

@@ -1,41 +1,93 @@
 # Turf
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/turf`. To experiment with that code, run `bin/console` for an interactive prompt.
+Turf lets you control the value of variables in different environments and makes it easy to override values locally.  It's easy to set `speak_in_chat` to `true` when `RAILS_ENV` equals "production" and `false` otherwise.  Turf is similar to the Rails `secrets.yml` file, but more powerful because it can execute Ruby code and return arrays, hashes, etc.
 
-TODO: Delete this and the text above, and describe your gem
 
-## Installation
+## How it works
 
-Add this line to your application's Gemfile:
+Turf looks for methods in the following order:
 
-```ruby
-gem 'turf'
-```
+1. The `Turf::Local` class.
+2. The `Turf::Test`, `Turf::Development`, or `Turf::Production` class.  Turf uses the development environment by default, but this can be overridden by setting `RAILS_ENV` to "production" or "test".
+3. The `Turf::Default` class.
 
-And then execute:
+I recommend defining the Turf classes in the `/config/turf` directory.
 
-    $ bundle
 
-Or install it yourself as:
+## Examples
 
-    $ gem install turf
+```ruby
+ENV["RAILS_ENV"] = "production"
+
+class Turf::Local
+  def something
+    "something in local"
+  end
+end
+
+class Turf::Development
+  def blah
+    "blah in development"
+  end
+end
+
+class Turf::Production
+  def something
+    "something in production"
+  end
+
+  def blah
+    "blah in production"
+  end
+end
+
+class Turf::Default
+  def four
+    2 + 2
+  end
+end
+
+# Turf::Local is the first place Turf looks for a
+# matching method
+Turf.find(:something) # => "something in local"
+
+# The RAILS_ENV is set to production, so Turf looks
+# in Turf::Production second if the method is not
+# found in Turf::Local
+# Turf::Development is ignored in production
+Turf.find(:blah) # => "blah in production"
+
+# Turf::Default is the last place to look
+Turf.find(:four) # => 4
+
+# Turf raises an exception when it can't find
+# a matching method
+Turf.find(:hi_there) # => raises an exception
+```
 
-## Usage
+## Setup
 
-TODO: Write usage instructions here
+Add this line to your application's Gemfile:
 
-## Development
+```ruby
+gem 'turf'
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Require turf:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+require 'turf'
+```
+
+Create the `Turf::Local`, `Turf::Test`, `Turf::Development`, `Turf::Production`, and `Turf::Default` classes (you don't have to create all of them, just the ones you want).
+
+Use `Turf.find()` in your project.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/turf.
+Bug reports and pull requests are welcome on GitHub at https://github.com/MrPowers/turf.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/turf.rb

@@ -1,5 +1,4 @@
 require "turf/version"
-require 'pry'
 
 require_relative "./turf/lookup.rb"
 

data/lib/turf/version.rb

@@ -1,3 +1,3 @@
 module Turf
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turf
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - MrPowers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler