rats 0.2.3 → 0.3.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Mark
+Copyright (c) 2009-2010 Mark G
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -59,6 +59,14 @@ There can be up to a maximum of 36 Sections in a township.  The number starts wi
 North of number 6 and counts up West-to-East until the number 12.  It snakes back
 and forth until it finishes at number 36 in the North-East corner.
 
+=== Half
+a.k.a. Half Section
+
+from above example: [= N or = North]
+
+The Half Section represents a 1/2 x 1 mile area within the 1x1 mile Section.
+They are identified by "N", "E", "S" and "W".
+
 === Quarter
 a.k.a. Quarter Section
 
@@ -91,6 +99,16 @@ fields from multiple string representations of the location.
 For example, NE 1-2-3 W4 and 40300201NE are both recognized and parsed, representing
 the same location.
 
+=== Expansion/Division
+
+Townships, Sections and Half Sections can be divided into multiple Quarter Sections.
+1 Half Section = 2 Quarter Sections
+1 Section = 4 Quarter Sections
+1 Township = 144 Quarter Sections
+
+For example, the Half Section N 1-2-3 W4 has the Quarter Sections NE 1-2-3 W4 and
+NW 1-2-3 W4. 
+
 === Display
 
 Included is string creation that can create common representations of the
@@ -113,6 +131,13 @@ Read the attributes
   quarter_section.township
   quarter_section.range
   quarter_section.meridian
+  
+Divide into multiple Quarter Sections
+
+  half_section = Rats.new("N 1-2-3 W4")
+  half_section.is_divisible?
+  quarter_sections = half_section.divide
+  # quarter_sections == [Rats.new("NE 1-2-3 W4"), Rats.new("NW 1-2-3 W4")]
 
 = Information
 
@@ -143,7 +168,7 @@ cases this assumption breaks down.
 == Environment
 
 This gem was created using:
-- ruby 1.9.1-p378, 1.9.2-head
+- ruby 1.9.1-p378, 1.9.2-p0
 - rspec 1.3.0
 - rake 0.8.7
 

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.1

data/lib/rats/base.rb

@@ -70,7 +70,11 @@ module Rats
       if self.meridian && self.range && self.township
         if self.section
           if self.quarter
-            :quarter
+            if Rats::Quarter.half?(self.quarter)
+              :half
+            else
+              :quarter
+            end
           else
             :section
           end
@@ -143,7 +147,62 @@ module Rats
     def to_a
       [self.quarter, self.section, self.township, self.range, self.meridian].compact
     end
-       
+    
+    # can this location be broken down into quarter sections?
+    #
+    def is_divisible?
+      [:half, :section, :township].include?(self.scope)
+    end
+    
+    # returns individual quarter sections for a :half_section, :section or :township
+    #
+    def divide
+      return unless self.is_divisible?
+      case self.scope
+      when :half
+        self.divide_half
+      when :section
+        self.divide_section
+      when :township
+        self.divide_township
+      end
+    end
+    
+    def divide_half
+      quarters = []
+      case self.quarter.to_s.downcase
+      when 'n'
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'NE')
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'NW')
+      when 's'
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'SE')
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'SW')
+      when 'e'
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'NE')
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'SE')
+      when 'w'
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'NW')
+        quarters << Rats.new(self.meridian, self.range, self.township, self.section, 'SW')
+      end
+      quarters
+    end
+    
+    def divide_section(section=nil)
+      quarters = []
+      ['NE', 'NW', 'SE', 'SW'].each do |quarter|
+        quarters << Rats.new(self.meridian, self.range, self.township, section || self.section, quarter)
+      end
+      quarters
+    end
+    
+    def divide_township
+      quarters = []
+      (1..36).each do |section|
+        quarters += divide_section(section)
+      end
+      quarters
+    end
+
     private
 
     def parse_string(location)
@@ -162,8 +221,11 @@ module Rats
     end
 
     def parse_description(description)
-      quarter = description.to_s.scan(/^\D{2}/)
-      self.quarter = quarter[0].upcase if quarter && quarter.size > 0
+      # just skip the case of only a meridian ie: 'W4'
+      unless description.to_s.match(/^w\d{1,3}$/i)
+        quarter = description.to_s.scan(/^north|^south|^east|^west|^ne|^nw|^se|^sw|^n|^e|^s|^w/i)
+        self.quarter = Rats::Quarter.transform(quarter[0]) if quarter && quarter.size > 0
+      end
 
       numbers = description.to_s.scan(/\d{1,3}/)
       if numbers
@@ -176,14 +238,14 @@ module Rats
     end
 
     def parse_parcel_id(parcel_id)
-      result = parcel_id.to_s.scan(/^(\d{1})(\d{2})(\d{3})(\d{2})(\D{2})?/)      
+      result = parcel_id.to_s.scan(/^(\d{1})(\d{2})(\d{3})(\d{2})(\D{1,2})?/)      
       return unless result && result.size > 0
       numbers = result.pop.compact      
       self.meridian = numbers.shift.to_i if numbers.size > 0
       self.range = numbers.shift.to_i if numbers.size > 0
       self.township = numbers.shift.to_i if numbers.size > 0
       self.section = numbers.shift.to_i if numbers.size > 0
-      self.quarter = numbers.shift.to_s if numbers.size > 0
+      self.quarter = numbers.shift.to_s.strip if numbers.size > 0
       true
     end
 

data/lib/rats/data/quarter.rb

@@ -1,7 +1,7 @@
 module Rats
   class Quarter < Data
     
-    VALID_QUARTERS = [:ne, :nw, :se, :sw]
+    VALID_QUARTERS = [:ne, :nw, :se, :sw, :n, :e, :s, :w]
     
     def self.padding_width; 2; end
     def self.padding_value; " "; end
@@ -12,21 +12,48 @@ module Rats
     
     def fullname
       return "" unless self.value
-      template = "the %s Quarter"
+      template = "the %s %s"
       case self.value.to_s.downcase.to_sym
       when :ne
-        sprintf(template, 'Northeast')
+        sprintf(template, 'Northeast', 'Quarter')
       when :se
-        sprintf(template, 'Southeast')
+        sprintf(template, 'Southeast', 'Quarter')
       when :nw
-        sprintf(template, 'Northwest')
+        sprintf(template, 'Northwest', 'Quarter')
       when :sw
-        sprintf(template, 'Southwest')
+        sprintf(template, 'Southwest', 'Quarter')
+      when :n
+        sprintf(template, 'North', 'Half')
+      when :e
+        sprintf(template, 'East', 'Half')
+      when :s
+        sprintf(template, 'South', 'Half')
+      when :w
+        sprintf(template, 'West', 'Half')
       else
         ''
       end
     end
     
+    def self.half?(value)
+      %w(north n south s east e west w).include?(value.to_s.downcase)
+    end
+    
+    def self.transform(value)
+      v = value.to_s.upcase.strip
+      case v
+      when 'NORTH'
+        v = 'N'
+      when 'SOUTH'
+        v = 'S'
+      when 'EAST'
+        v = 'E'
+      when 'WEST'
+        v = 'W'
+      end
+      v
+    end
+    
     private
     
     def validate!

data/rats.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rats}
-  s.version = "0.2.3"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark G"]
-  s.date = %q{2010-05-08}
+  s.date = %q{2010-09-10}
   s.description = %q{A ruby class to help with using the Alberta Township System}
   s.email = %q{rats@attackcorp.com}
   s.extra_rdoc_files = [
@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/attack/rats}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A ruby class to help with using the Alberta Township System}
   s.test_files = [
     "spec/data/data_spec.rb",
@@ -64,7 +64,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/data/quarter_spec.rb

@@ -12,6 +12,18 @@ describe Rats::Quarter do
     data.fullname.should == "the Northeast Quarter"
   end
   
+  it "detects half" do
+    Rats::Quarter.half?('NE').should be_false
+    Rats::Quarter.half?('N').should be_true
+    Rats::Quarter.half?('North').should be_true
+  end
+  
+  it "transform input" do
+    Rats::Quarter.transform('ne').should == 'NE'
+    Rats::Quarter.transform('north').should == 'N'
+    Rats::Quarter.transform('n').should == 'N'
+  end
+  
   describe "boundaries" do
     
     it "knows valid data" do

data/spec/rats_spec.rb

@@ -96,6 +96,26 @@ describe "Rats" do
       land.scope.should == :quarter
     end
     
+    it "understands N 1-2-3 W4" do
+      land = Rats.new("N 1-2-3 W4")
+      land.quarter.should == "N"
+      land.section.should == 1
+      land.township.should == 2
+      land.range.should == 3
+      land.meridian.should == 4
+      land.scope.should == :half
+    end
+    
+    it "understands North 1-2-3 W4" do
+      land = Rats.new("North 1-2-3 W4")
+      land.quarter.should == "N"
+      land.section.should == 1
+      land.township.should == 2
+      land.range.should == 3
+      land.meridian.should == 4
+      land.scope.should == :half
+    end
+    
     it "understands 40300201NE" do
       land = Rats.new("40300201NE")
       land.quarter.should == "NE"
@@ -329,6 +349,11 @@ describe "Rats" do
         land.location(:long).should == "the Northeast Quarter of Section 1, Township 2, Range 3, West of the Fourth Meridian"
       end
       
+      it "returns the long version with Half" do
+        land = Rats.new("N 1-2-3 W4")
+        land.location(:long).should == "the North Half of Section 1, Township 2, Range 3, West of the Fourth Meridian"
+      end
+      
       it "returns the long version with Section" do
         land = Rats.new("1-2-3 W4")
         #puts land.inspect
@@ -352,6 +377,16 @@ describe "Rats" do
       land.scope.should == :quarter
     end
     
+    it "knows half" do
+      land = Rats.new("E 1-2-3 W4")
+      land.scope.should == :half
+    end
+    
+    it "knows half" do
+      land = Rats.new("East 1-2-3 W4")
+      land.scope.should == :half
+    end
+    
     it "knows section" do
       land = Rats.new("1-2-3 W4")
       land.scope.should == :section
@@ -398,6 +433,43 @@ describe "Rats" do
       land = Rats.new("1-2-3 W4")
       land.to_a.should == [1, 2, 3, 4]
     end
+    
+    describe "expansion" do
+      
+      it "is divisible" do
+        Rats.new("N 1-2-3 W4").is_divisible?.should be_true
+        Rats.new("1-2-3 W4").is_divisible?.should be_true
+        Rats.new("2-3 W4").is_divisible?.should be_true
+      end
+      
+      it "is not divisible" do
+        Rats.new("NE 1-2-3 W4").is_divisible?.should be_false
+        Rats.new("3 W4").is_divisible?.should be_false
+        Rats.new("W4").is_divisible?.should be_false
+      end
+      
+      describe "half -> 2 quarters" do
+        quarters = Rats.new("N 1-2-3 W4").divide
+        quarters.size.should == 2
+        quarters.first.quarter.should == 'NE'
+        quarters.last.quarter.should == 'NW'
+      end
+      
+      describe "section -> 4 quarters" do
+        quarters = Rats.new("1-2-3 W4").divide
+        quarters.size.should == 4
+        quarters[0].quarter.should == 'NE'
+        quarters[1].quarter.should == 'NW'
+        quarters[2].quarter.should == 'SE'
+        quarters[3].quarter.should == 'SW'
+      end
+      
+      describe "township -> 144 quarters" do
+        quarters = Rats.new("2-3 W4").divide
+        quarters.size.should == 144
+      end
+      
+    end
                     
   end
   

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Mark G
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-08 00:00:00 -06:00
+date: 2010-09-10 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -64,6 +64,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -71,6 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -80,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A ruby class to help with using the Alberta Township System