area_cn 0.0.3 → 0.0.5

data/README.md

@@ -18,15 +18,30 @@ Or install it yourself as:
 
 ## Usage
 
+  # Find by name or code
+
   zhejiang = AreaCN.areas.find_by_name("浙江省")
   zhejiang.code # => "330000"
-  zhejiang.children == zhejiang.cities # => ["杭州市", "...", "..."]
+  zhejiang.children == zhejiang.cities # => [{:name => "杭州市", :code => "330100"}, {}, {}, ...]
 
   
-  hangzhou = AreaCN.areas.find_by_name("杭州市")
+  hangzhou = AreaCN.areas.find_by_code("330100")
   hangzhou.code # => "330100"
-  hangzhou.children == hangzhou.districts # => ["滨江区", "...", "..."]
+  hangzhou.name # => "杭州市"
+  hangzhou.children == hangzhou.districts # => [{:name => "滨江区", :code => "330108"}, {}, {}, ...]
+
+  # Return all provinces
+
+  AreaCN.provinces
+  AreaCN.areas.provinces
+
+  # Code methods
+
+  zhejiang.code.prefix # => return '33'
+  hangzhou.code.parent # => return '330000'
 
+  zhejiang.ancestor?(hangzhou) # => return true
+  hangzhou.child?(zhejiang)    # => return true
 
 
 ## Contributing

data/lib/area_cn/area.rb

@@ -4,7 +4,7 @@ module AreaCN
   class Area
     include Comparable
 
-    attr_reader :name, :children
+    attr_reader :name, :code, :children
     attr_accessor :parent
 
     # area is a json area from areas.json file
@@ -14,12 +14,8 @@ module AreaCN
       @children = []
     end
 
-    def code
-      @code.value
-    end
-
     def parent_code
-      @code.parent.code
+      @code.parent
     end
 
     def children_names
@@ -27,7 +23,7 @@ module AreaCN
     end
 
     def children_codes
-      @children_codes ||= children.map { |child| child.code }
+      @children_codes ||= children.map(&:code)
     end
 
     def province?
@@ -54,6 +50,9 @@ module AreaCN
       to_hash.to_json(*args)
     end
 
+    def inspect
+      to_hash
+    end
   end
 
   class Province < Area

data/lib/area_cn/areas.rb

@@ -29,9 +29,9 @@ module AreaCN
 
     def find_by_code(code, area_level = nil)
       scope = area_level ? instance_variable_get("@#{area_level.to_s.pluralize}") : all
-      code_value = code.is_a?(Code) ? code.value : code
-      scope.detect { |area| area.code == code_value }
+      scope.detect { |area| area.code == code }
     end
+    alias_method :get, :find_by_code
 
     def match(name, area_level = nil)
       scope = area_level ? instance_variable_get("@#{area_level.to_s.pluralize}") : all

data/lib/area_cn/code.rb

@@ -1,13 +1,12 @@
 module AreaCN
-  class Code
-    include Comparable
-
+  class Code < String
     ROOT = "000000"
 
-    attr_accessor :code
+    attr_reader :code
 
     def initialize(code)
       @code = code
+      super(code)
     end
 
     def value
@@ -17,10 +16,10 @@ module AreaCN
     def prefix
       return if code == ROOT
       return @prefix if @prefix
-      code_prefix = code.sub(/0{2,4}$/, '') 
-      code_prefix << '0' if code_prefix.length.odd?
+      @prefix = code.sub(/0{2,4}$/, '') 
+      @prefix << '0' if @prefix.length.odd?
        
-      code_prefix 
+      @prefix 
     end
 
     def parent
@@ -31,10 +30,10 @@ module AreaCN
     def ancestors
       return @ancestors if @ancestors
       child = self
-      ancestors = [self] 
-      ancestors << child while child = child.parent 
+      @ancestors = [self] 
+      @ancestors << child while child = child.parent 
             
-      ancestors
+      @ancestors
     end
 
     def ancestor?(other)
@@ -43,20 +42,7 @@ module AreaCN
     end
 
     def child?(other)
-      other = Code.new(other) unless other.is_a?(Code)
-      other.ancestor?(self)
-    end
-
-    def <=>(other)
-      self.code <=> other.code
-    end
-
-    def inspect
-      @code
-    end
-
-    def to_s
-      @code
+      self.ancestors.include?(other)
     end
   end
 end

data/lib/area_cn/version.rb

@@ -1,3 +1,3 @@
 module AreaCN
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/area_cn.rb

@@ -23,5 +23,21 @@ module AreaCN
     def match(name, area_level = nil)
       areas.match(name, area_level)
     end
+
+    def provinces
+      areas.provinces
+    end
+
+    def cities
+      areas.cities
+    end
+
+    def districts
+      areas.districts
+    end
+
+    def all
+      areas.all
+    end
   end
 end

data/spec/area_cn_spec.rb

@@ -49,7 +49,21 @@ describe AreaCN, "中国地区数据" do
   end
 
   describe AreaCN::Code do
-    it "code.prefix should return code's prefix" do
+    let(:code) { code = AreaCN::Code.new('110100') }
+      
+    it "code should behave like string" do
+      code.should == '110100'
+
+      code.should > '110000'
+
+      "code: #{code}".should == "code: 110100"
+    end
+
+    it "#value should return raw code string" do
+      code.value.should == '110100'
+    end
+
+    it "#prefix should return code's prefix" do
       code = AreaCN::Code.new("110000")
       code.prefix.should == '11'
 
@@ -63,26 +77,57 @@ describe AreaCN, "中国地区数据" do
       code.prefix.should == '1101'
     end
 
-    it "code parent" do
+    it "#parent should return parent code instance" do
       code = AreaCN::Code.new("110000")
+      code.parent.should == "000000"
       code.parent.should == AreaCN::Code.new("000000")
 
       AreaCN::Code.new("000000").parent.should == nil
     end
 
-    it "code ancestor" do
+    it "#ancestors" do
+      code.ancestors.should include("110100")
+      code.ancestors.should == ['110100', '110000', '000000']
+    end
+
+    it "code ancestor?" do
+      raw_code1 = '330101'
+      raw_code2 = '330100'
+      raw_code3 = '330000'
+
       code1 = AreaCN::Code.new("330101")
       code2 = AreaCN::Code.new("330100")
       code3 = AreaCN::Code.new("330000")
 
       code2.ancestor?(code1).should be_true
+      code2.ancestor?(raw_code1).should be_true
+
       code3.ancestor?(code2).should be_true
+      code3.ancestor?(raw_code2).should be_true
+
       code3.ancestor?(code1).should be_true
+      code3.ancestor?(raw_code1).should be_true
 
       code1.child?(code2).should be_true
       code1.child?(code3).should be_true
     end
 
+    it "#child" do
+      raw_code1 = '330101'
+      raw_code2 = '330100'
+      raw_code3 = '330000'
+
+      code1 = AreaCN::Code.new("330101")
+      code2 = AreaCN::Code.new("330100")
+      code3 = AreaCN::Code.new("330000")
+
+      code1.child?(code2).should be_true
+      code1.child?(raw_code2).should be_true
+
+      code1.child?(code3).should be_true
+      code1.child?(raw_code3).should be_true
+    end
+
     it "code should can be compare" do
       AreaCN::Code.new("330101").should == AreaCN::Code.new("330101")
     end

metadata

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