GB2260 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1f1e39c794df897086e9b57ee7bf6af4a33187a
-  data.tar.gz: 03af9401b3966081100d909294ed954db97458ca
+  metadata.gz: febcce9dda36cd75c751136957fb3f7fee0d5ef6
+  data.tar.gz: fb00da230871eccb96690841e2c6a5050fd7c70b
 SHA512:
-  metadata.gz: 88ab9591bd0e2bde1ec8a1a3e7fe5a65a5294be51489941bfd6ea6a63849ee8f29009603965ddea119636fd547ed92ab712b1956e90032812739455ff1da0376
-  data.tar.gz: 045dce066250477d0dd069107cf8a5b657865510c045c8acd7825b34f2a8f04c92c233fe43cc05889ee7e929bfa4e60d9d9be492118c49a1352668bfdf5de569
+  metadata.gz: ff25d3eefd41715e4c071b7d14f138f6e133b42bbfa51681902d543357af23dbbc2463edc7a865d6c53df83891a2314785341fef4ea3ad4eca56c6c8edcdc145
+  data.tar.gz: 0a1b3337e5af8c1c85f17c0cd8539ed0181c986dcd09af7e494453fea5e5b4c48774bf32ab34a4120e0a0e303df403e75d778a75a1704ec166927b2046c92625

data/.travis.yml

@@ -1,4 +1,9 @@
 language: ruby
 rvm:
   - 2.2.0
-before_install: gem install bundler -v 1.10.5
+git:
+  submodules: false
+before_install:
+  - sed -i 's/git@github.com:/https:\/\/github.com\//' .gitmodules
+  - git submodule update --init --recursive
+  - gem install bundler -v 1.10.5

data/CHANGELOG.md

@@ -8,6 +8,11 @@ GB2260.rb is in a pre-1.0 state. This means that its APIs and behavior are subje
 
 * Your contribution here!
 
+## 0.2.0 (2015-11-11)
+
+* Implement spec 0.2
+* Deprecate `#year` of `Division` 
+
 ## 0.1.1 (2015-09-12)
 
 * Fix description on rubygems
@@ -17,4 +22,4 @@ GB2260.rb is in a pre-1.0 state. This means that its APIs and behavior are subje
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/wolflee/GB2260.rb/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/cn/GB2260.rb/compare/v0.2.0...HEAD

data/GB2260.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
 end

data/README.md

@@ -1,5 +1,11 @@
 # GB2260
 
+[![GB/T 2260](http://img.shields.io/badge/GB%2FT-2260-blue.svg?style=flat)](https://github.com/cn/GB2260)
+[![Gem Version](https://badge.fury.io/rb/GB2260.svg)](http://badge.fury.io/rb/GB2260)
+[![Build Status](https://travis-ci.org/cn/GB2260.rb.svg?branch=master)](https://travis-ci.org/cn/GB2260.rb)
+[![Code Climate](https://codeclimate.com/github/cn/GB2260.rb/badges/gpa.svg)](https://codeclimate.com/github/cn/GB2260.rb)
+[![Coverage Status](https://coveralls.io/repos/wolflee/GB2260.rb/badge.svg?branch=master&service=github)](https://coveralls.io/github/wolflee/GB2260.rb?branch=master)
+
 The Ruby implementation for looking up the Chinese administrative divisions.
 
 ## Installation

data/lib/GB2260/array.rb

@@ -0,0 +1,11 @@
+module ArrayExtensions
+  refine Array do
+    [:select, :reject].each do |action|
+      [:start, :end].each do |position|
+        define_method "#{action}_#{position}_with".to_sym do |predicate|
+          self.send(action) { |c| c.send("#{position}_with?".to_sym, predicate) }
+        end
+      end
+    end
+  end
+end

data/lib/GB2260/constants.rb

@@ -1,5 +1,5 @@
 class GB2260
-  LATEST_YEAR = '2014'.freeze
+  LATEST_REVISION = '2014'.freeze
   PROVINCE_SUFFIX = '0000'.freeze
   PREFECTURE_SUFFIX = '00'.freeze
 end

data/lib/GB2260/data.rb

@@ -1,24 +1,41 @@
 class GB2260
   class Data
+    GEM_DIR = File.join(File.dirname(__FILE__), '../../').freeze
+
     class << self
       def data
-        gem_dir = File.join(File.dirname(__FILE__), '../../')
-        Dir.chdir(gem_dir) do
-          @data ||= Hash[Dir.glob("data/*.txt").map do |fn|
-            [
-              fn.gsub(/data\/GB2260-/, '').gsub(/\.txt$/, ''),
-              Hash[
-                File.readlines(File.expand_path(File.join(gem_dir, fn))).map do |l|
-                  l.strip.split("\t")
-                end]
-            ]
-          end]
+        Dir.chdir(GEM_DIR) do
+          @data ||= fetch_data(GEM_DIR)
         end
       end
 
-      def search(code, year=nil)
-        year ||= LATEST_YEAR
-        data[year.to_s][code.to_s]
+      def search(code, revision=nil)
+        revision ||= LATEST_REVISION
+        data[revision.to_s][code.to_s]
+      end
+
+      private
+
+      def fetch_data(dir)
+        Hash[array_data(dir)]
+      end
+
+      def array_data(dir)
+        Dir["data/*.txt"].map do |fn|
+          [strip_revision(fn), Hash[per_revision_data(real_path(dir, fn))]]
+        end
+      end
+
+      def per_revision_data(filepath)
+        File.readlines(filepath).map {|l| l.chomp.split("\t") }
+      end
+
+      def real_path(dir, filename)
+        File.expand_path(File.join(dir, filename))
+      end
+
+      def strip_revision(filename)
+        filename.sub(/data\/GB2260-/, '').sub(/\.txt$/, '')
       end
     end
   end

data/lib/GB2260/deprecation.rb

@@ -0,0 +1,10 @@
+module DeprecationWarner
+  refine Module do
+    def deprecate(old_method, new_method)
+      define_method(old_method) do |*args, &block|
+        warn "[DEPRECATION] `#{old_method}` is deprecated.  Please use `#{new_method}` instead."
+        send(new_method, *args, &block)
+      end
+    end
+  end
+end

data/lib/GB2260/division.rb

@@ -1,27 +1,42 @@
 class GB2260
   class Division
-    attr_reader :code, :name, :year
+    using DeprecationWarner
 
-    def self.get(code, year=nil)
-      new(code, Data.search(code, year))
+    attr_reader :code, :name, :revision
+    deprecate :year, :revision
+
+    def self.get(code, revision=nil)
+      new(code, Data.search(code, revision), revision)
+    end
+
+    def self.batch(codes, revision=nil)
+      codes.map { |code| get(code, revision) }
     end
 
-    def initialize(code, name, year=nil)
+    def initialize(code, name, revision=nil)
       @code = code.to_s
       @name = name.to_s
-      @year = year
+      @revision = (revision || LATEST_REVISION).to_s
     end
 
     def ==(other)
-      code == other.code && year == other.year
+      eql? other
+    end
+
+    def eql?(other)
+      code == other.code && revision == other.revision
     end
 
     def to_s
-      "<GB2260-#{@year||LATEST_YEAR} #{[province, prefecture, county].compact.map(&:name).join('/')}>"
+      "<GB2260-#{@revision} #{@code} #{[province, prefecture, county].compact.map(&:name).join('/')}>"
+    end
+
+    def hash
+      [@code, @revision].hash
     end
 
     def province
-      Division.get(@code[0,2] + PROVINCE_SUFFIX, @year)
+      Division.get(@code[0,2] + PROVINCE_SUFFIX, @revision)
     end
 
     def is_province?
@@ -29,7 +44,7 @@ class GB2260
     end
 
     def prefecture
-      Division.get(@code[0,4] + PREFECTURE_SUFFIX, @year) unless is_province?
+      Division.get(@code[0,4] + PREFECTURE_SUFFIX, @revision) unless is_province?
     end
 
     def is_prefecture?

data/lib/GB2260/version.rb

@@ -1,3 +1,3 @@
 class GB2260
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/GB2260.rb

@@ -1,35 +1,45 @@
 require "GB2260/version"
 require "GB2260/constants"
+require "GB2260/deprecation"
 require "GB2260/data"
 require "GB2260/division"
+require "GB2260/array"
 
 class GB2260
-  def initialize(year=nil)
-    @year = year || LATEST_YEAR
+  using ArrayExtensions
+
+  def self.revisions
+    Data.data.keys.reverse
+  end
+
+  def initialize(revision=nil)
+    @revision = (revision || LATEST_REVISION).to_s
   end
 
   def get(code)
-    Division.get(code, @year)
+    Division.get(code, @revision)
+  end
+
+  def all_code
+    Data.data[@revision].keys
   end
 
   def provinces
-    Data.data[@year].keys
-      .select { |c| c.end_with? PROVINCE_SUFFIX  }
-      .map { |c| Division.get(c, @year) }
+    Division.batch all_code.select_end_with(PROVINCE_SUFFIX), @revision
   end
 
   def prefectures(province_code)
-    Data.data[@year].keys
-      .select { |c| c.start_with? province_code.to_s[0,2] }
-      .select { |c| c.end_with? PREFECTURE_SUFFIX  }
-      .reject { |c| c.end_with? PROVINCE_SUFFIX }
-      .map { |c| Division.get(c, @year) }
+    Division.batch(all_code
+      .select_start_with(province_code.to_s[0,2])
+      .select_end_with(PREFECTURE_SUFFIX)
+      .reject_end_with(PROVINCE_SUFFIX),
+    @revision)
   end
 
   def counties(prefecture_code)
-    Data.data[@year].keys
-      .select { |c| c.start_with? prefecture_code.to_s[0,4] }
-      .reject { |c| c.end_with? PREFECTURE_SUFFIX }
-      .map { |c| Division.get(c, @year) }
+    Division.batch(all_code
+      .select_start_with(prefecture_code.to_s[0,4])
+      .reject_end_with(PREFECTURE_SUFFIX),
+    @revision)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: GB2260
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - WolfLee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-12 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - liyuan0228@gmail.com
@@ -90,8 +104,10 @@ files:
 - data/GB2260-2013.txt
 - data/GB2260-2014.txt
 - lib/GB2260.rb
+- lib/GB2260/array.rb
 - lib/GB2260/constants.rb
 - lib/GB2260/data.rb
+- lib/GB2260/deprecation.rb
 - lib/GB2260/division.rb
 - lib/GB2260/version.rb
 homepage: https://github.com/wolflee/GB2260.rb