luzvimin 0.1.0 → 1.0.0

data/README.md

@@ -1,6 +1,6 @@
 # Luzvimin
 
-TODO: Write a gem description
+Luzvimin is a gem that lists all regions and provinces in the Philippines
 
 ## Installation
 
@@ -18,7 +18,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To list all regions:
+  
+    Luzvimin.regions
+
+To create a select tag for all regions:
+  
+    Luzvimin.select_regions
+
+To get details about a region:
+
+    region = Luzvimin.region('NCR')
+    region.code is 'NCR'.
+    region.name is 'National Capital Region'.
+
+To get a region's provinces:
+
+    region.provinces
+
+To create a select tag for all region's provinces:
+
+    region.select_provinces
 
 ## Contributing
 

data/lib/luzvimin.rb

@@ -25,7 +25,7 @@ module Luzvimin
       provinces.map { |k, v| [k, v] }.sort_by{ |k, v| v['position'] }  
     end 
 
-    def select_provinces
+    def provinces_options_for_select
       provinces.map {|s| [s[1]['name'],s[0]]}
     end 
   end
@@ -39,7 +39,7 @@ module Luzvimin
       REGIONS      
     end
 
-    def select_regions
+    def regions_options_for_select
       REGIONS.map {|s| [s[1]['name'],s[0]]}
     end
   end

data/lib/luzvimin/version.rb

@@ -1,3 +1,3 @@
 module Luzvimin
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/spec/luzvimin_region_spec.rb

@@ -30,15 +30,15 @@ describe Luzvimin::Region do
     end
   end
 
-  describe 'select_provinces' do
+  describe 'provinces_options_for_select' do
     context 'all' do
-      subject { region.select_provinces }
+      subject { region.provinces_options_for_select }
       it { should be_an(Array) }
       it { should have(1).items }
     end
 
     context 'first province' do
-      subject { region.select_provinces.first }
+      subject { region.provinces_options_for_select.first }
       it { should be_an(Array) }
       it { should_not be_empty }
       it { should have(2).items }

data/spec/luzvimin_spec.rb

@@ -25,15 +25,15 @@ describe Luzvimin do
     it { Luzvimin.regions.first.should be_an(Array) }
   end
 
-  describe 'select_regions' do
+  describe 'regions_options_for_select' do
     context 'all' do
-      subject { Luzvimin.select_regions }
+      subject { Luzvimin.regions_options_for_select }
       it { should be_an(Array) }
       it { should have(17).items }
     end
 
     context 'first region' do
-      subject { Luzvimin.select_regions.first }
+      subject { Luzvimin.regions_options_for_select.first }
       it { should be_an(Array) }
       it { should_not be_empty }
       it { should have(2).items }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luzvimin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec