utilio 0.0.0 → 0.0.1

data/README.md

@@ -1,9 +1,60 @@
-= utilio
+# Utilio #
 
-Description goes here.
+A general collection of application utilities for dealing with paths and active_record.
+
+## Installation ##
+
+Use rubygems, like a good boy should.
+
+	install gem utilio
+	
+## Usage ##
+
+### Path Utilities ###
+
+Path utilities mainly for root and app. Also a simple helper for loading yaml files from the root of your app.
+
+	# file: /code/myapp/myapp.rb
+	require 'utilio'
+	
+Set root to an absolute or relative location. If you choose not to set the root path, Utilio assumes' it's the directory of the running ruby file (e.g. `File.dirname($0)`).
+
+	Utilio::Path.root = File.dirname(__FILE__)
+	Utilio::Path.root = '/some/random/dir'
+
+Read the root path:
+
+	Utilio::Path.root
+	
+Concatenating paths onto root path (ala File#join). Note that this doesn't modify subsequent calls to `Utilio::Path.root`.
+
+	Utilio::Path.root 'db', 'migrate' #=> /code/myapp/myapp/db/migrate
+	
+App folder shortcut (equivalent to doing `Utilio::Path.root 'app', ...`):
+
+	Utilio::Path.app 'models' #=> /code/myapp/myapp/app/models
+	
+Loading yaml file contents (see YAML#load_file):
+
+	Utilio::Path.yaml_file 'config', 'settings.yml'
+	
+### Database Utilities ###
+
+Database utilities for simple config loading. Note that this depends on Utilio::Path.root, so set that if you need to.
+
+	# file /code/myapp/myapp.rb
+	require 'utilio'
+	
+Load the configuration file from it's default location ({ROOT}/config/database.yml). Note this gives you the full file contents (all env's).
+
+	Utilio::Database.config
+	
+You can specify the specific env to use as well as the location of the file for all you misfits out there who just happen to call your config directory `conf`. Creepy.
+
+	Utilio::Database.config :environment => ENV['RACK_ENV'], :file => 'some_random_directory/database.yml'
+
+## Note on Patches/Pull Requests ##
 
-== Note on Patches/Pull Requests
- 
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -12,6 +63,6 @@ Description goes here.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright ##
 
 Copyright (c) 2010 BJ Neilsen. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/utilio.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{utilio}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["BJ Neilsen"]
+  s.date = %q{2010-08-06}
+  s.description = %q{}
+  s.email = %q{bj.neilsen@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".bundle/config",
+     ".bundle/environment.rb",
+     ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/utilio.rb",
+     "lib/utilio/database.rb",
+     "lib/utilio/path.rb",
+     "spec/data/database.yml",
+     "spec/data/path.yml",
+     "spec/spec_helper.rb",
+     "spec/utilio_database_spec.rb",
+     "spec/utilio_path_spec.rb",
+     "utilio.gemspec"
+  ]
+  s.homepage = %q{http://www.rand9.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A general collection of application utilities for dealing with paths and active_record}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/utilio_database_spec.rb",
+     "spec/utilio_path_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - BJ Neilsen
@@ -60,6 +60,7 @@ files:
 - spec/spec_helper.rb
 - spec/utilio_database_spec.rb
 - spec/utilio_path_spec.rb
+- utilio.gemspec
 has_rdoc: true
 homepage: http://www.rand9.com
 licenses: []