ausburbs 0.2.0

data/lib/ausburbs.rb

@@ -0,0 +1,38 @@
+module Ausburbs
+  autoload :State, 'ausburbs/state'
+  autoload :Suburb, 'ausburbs/suburb'
+
+  @data_path = File.join(File.dirname(__FILE__), '..', 'data')
+
+  class << self
+    def state_names
+      @@states.keys.sort
+    end
+
+    def state(state_name)
+      load_data
+      @@states[state_name.to_s.upcase]
+    end
+
+    def states
+      load_data
+      @@states.values.sort{ |s1, s2| s1.name <=> s2.name }
+    end
+
+    def suburbs(state_name)
+      load_data
+      Ausburbs.states[state.to_s.upcase].suburbs
+    end
+
+    private
+    def load_data
+      @@states ||= {}
+      if @@states.empty?
+        data = YAML.load_file( File.join(@data_path, 'suburbs.yml') )
+        data.each do |state_name, suburbs|
+          @@states[state_name] = State.new(state_name, suburbs)
+        end
+      end
+    end
+  end
+end

data/lib/ausburbs/state.rb

@@ -0,0 +1,19 @@
+module Ausburbs
+  class State
+    attr_accessor :name, :suburbs
+
+    def initialize(*args)
+      self.name = args[0]
+      load_suburb_data!(args[1])
+    end
+
+    private
+    def load_suburb_data!(data)
+      self.suburbs = []
+      data.each do |suburb_data|
+        self.suburbs << Suburb.new(suburb_data)
+      end
+      self.suburbs.sort{ |s1, s2| s1.postcode <=> s2.postcode }
+    end
+  end
+end

data/lib/ausburbs/suburb.rb

@@ -0,0 +1,17 @@
+module Ausburbs
+  class Suburb
+    attr_accessor :name, :postcode, :state, :latitude, :longitude
+    def initialize(data = nil)
+      parse!(data) if data
+    end
+
+    private
+    def parse!(data)
+      self.name = data[:name].to_s
+      self.postcode = data[:postcode].to_s.rjust(4, '0')
+      self.state = data[:state].to_s
+      self.latitude = data[:latitude].to_f
+      self.longitude = data[:longitude].to_f
+    end
+  end
+end

data/lib/ausburbs/version.rb

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

data/spec/ausburbs_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Ausburbs do
+  before :each do
+
+  end
+
+  it "should return a list of states, in alphabetical order" do
+    Ausburbs.states.should be_a(Array)
+    last_state = nil
+    Ausburbs.states.each do |state|
+      state.should be_a(Ausburbs::State)
+      (state.name > last_state.name).should be_true if last_state
+      last_state = state
+    end
+  end
+
+  it "should return an list of suburbs for a given state, in postcode order" do
+    Ausburbs.states.each do |state|
+      state.suburbs.should be_a(Array)
+      last_suburb = nil
+      state.suburbs.each do |suburb|
+        suburb.should be_a(Ausburbs::Suburb)
+        (suburb.postcode >= last_suburb.postcode).should be_true if last_suburb
+        last_suburb = suburb
+      end
+    end
+  end
+
+  it "should return the list of state names, in alphabetical order" do
+    Ausburbs.state_names.should be_a(Array)
+    last_state_name = nil
+    Ausburbs.state_names.each do |state_name|
+      (state_name.should >= last_state_name).should be_true if last_state_name
+      last_state_name = state_name
+    end
+  end
+
+  it "should return a state for a given state name" do
+    Ausburbs.state_names.each do |state_name|
+      Ausburbs.state(state_name).should be_a(Ausburbs::State)
+      Ausburbs.state(state_name).name.should == state_name
+    end
+  end
+end
+
+describe Ausburbs::State do
+  before :each do
+    @state = Ausburbs.states.first
+  end
+
+  it "should have a name" do
+    @state.respond_to?(:name).should be_true
+    @state.name.should be_a(String)
+  end
+
+  it "should return a list of suburbs" do
+    @state.suburbs.should be_an(Array)
+  end
+end
+
+describe Ausburbs::Suburb do
+  before :each do
+    @suburb = Ausburbs.states.first.suburbs.first
+  end
+
+  it "should have a name" do
+    @suburb.respond_to?(:name).should be_true
+    @suburb.name.should be_a(String)
+  end
+
+  it "should have a postcode" do
+    @suburb.respond_to?(:postcode).should be_true
+    @suburb.postcode.should be_a(String)
+  end
+
+  it "should have a latitude"do
+    @suburb.respond_to?(:latitude).should be_true
+    @suburb.latitude.should be_a(Float)
+  end
+
+  it "should have a longitude" do
+    @suburb.respond_to?(:longitude).should be_true
+    @suburb.longitude.should be_a(Float)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'ausburbs'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: ausburbs
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Nicholas Bruning
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: A simple gem for accesssing basic data about suburbs across Australia, including latitudes and longitudes
+email: 
+- nicholas@bruning.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- ausburbs.gemspec
+- data/.DS_Store
+- data/suburbs.yml
+- lib/.DS_Store
+- lib/ausburbs.rb
+- lib/ausburbs/state.rb
+- lib/ausburbs/suburb.rb
+- lib/ausburbs/version.rb
+- spec/ausburbs_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/thetron/ausburbs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ausburbs
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides Australian suburbs data including latitudes and longitudes.
+test_files: 
+- spec/ausburbs_spec.rb
+- spec/spec_helper.rb