rats 0.4.1 → 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmRmYmQ4MGUzMzQ1ZDFkNWUzMzlkZTJmZmViM2IzMDU0NjU2OGZkYQ==
+  data.tar.gz: !binary |-
+    YTc3NjhiY2QxMTRkMDk0NmM2Y2E3NGQxZGMzYzdkMzY4OWFkY2VkOQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjEzZTJjNDM0YWRhNjY0MmNiZWE1NTBlYTY1ODZlMGM1ZjUxZmUzZjIxYjkz
+    NWZiYTdmMmZmYzJjNzAzZjQyNzI1MWRhNWE5ZTMxOTQwZTM0NTI3ZjJkOWVl
+    NDllMWMzNjBiMjA4ZDRjNmNlODNhNmE4ZmY0ODRlMTZjNmExYWU=
+  data.tar.gz: !binary |-
+    YWFjMWZkNTM4MGVhMDdlMzM2ODBiNmUwNmI1ZWI3ZDdjNjE1MzgzYzNmMWJi
+    YWNiOTI1OTJlZGI3Zjc0MzQyNjQ1YzY0Y2I2N2IwMjJjZTBhYTM1NmY1OWYy
+    YWY0N2RlODVmNGUxODU0YmEzNmUzZTRhNjQzZmUwYmE0Y2QxZTI=

data/.gitignore

@@ -1,22 +1,6 @@
-## MAC OS
 .DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
 coverage
 rdoc
-pkg
-
-## PROJECT::SPECIFIC
 docs
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+script: 'bundle exec rake'
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec', '>= 2.11'
+  gem 'mocha'
+end

data/LICENSE

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

data/{README.rdoc → README.md}

@@ -1,13 +1,16 @@
-= rats
+# rats
+[![Build Status](https://travis-ci.org/attack/rats.png)](https://travis-ci.org/attack/rats)
 
 a.k.a. Ruby Alberta Township System
 
 A ruby class to help with using the Alberta Township System.  This class will allow
 you to create and represent townships, sections and quarter sections.
 
-You may find it amusing that Alberta is Rat-free ... until now.
+#### Status
 
-== ATS
+This gem is not under active development, but is still maintained.
+
+## ATS
 
 Alberta Township system is a land survey grid used in Alberta, Canada that
 divides the whole province into addressable locations.
@@ -16,7 +19,7 @@ A typical location looks like: NE 1-2-3 W4
 
 Which can be broken down as follows ...
 
-=== Meridian
+### Meridian
 
 from above example: [= W4] or West of the 4th Meridian
 
@@ -25,7 +28,7 @@ and increments approx. every 4th line of longitude, from East to West.
 
 Alberta contains 3 of these Meridians, W4 through W6.
 
-=== Range
+### Range
 a.k.a Range Lines
 
 from above example: [= 3]
@@ -36,7 +39,7 @@ resets at the next Meridian.  Each increase is approx. every 6 miles.
 NOTE: The longitude lines are closer together the further North you get, so as
 you go North, there is less Ranges from East to West.
 
-=== Township
+### Township
 a.k.a. Township Lines
 
 from above example: [= 2]
@@ -49,7 +52,7 @@ NOTE: The 6x6 mile "square" indicated by the Township (line) + Range (line) +
 Meridian is confusingly called a Township.  So you have the Township line and
 the 6x6 mile Township "square".
 
-=== Section
+### Section
 
 from above example: [= 1]
 
@@ -59,7 +62,7 @@ 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.
 
-=== Multi
+### Multi
 a.k.a. Multi Quarters
 
 from above example: [= N or = North]
@@ -74,7 +77,7 @@ The Multi Quarter Section represents a 1/2 x 1 mile + 1/2 x 1/2 mile area within
 They are identified by "NSE", "NSW", "ENW", "ESW", "SNE", "SNW", "WNE" and "WSE",
 "NWS", "NES", "SEN", "SWN", "NWE", "NEW", "SEW", "SWE".
 
-=== Quarter
+### Quarter
 a.k.a. Quarter Section
 
 from above example: [= NE]
@@ -83,12 +86,12 @@ The Quarter represents a 1/2 x 1/2 mile square within the 1x1 mile Section.
 There can be 4 Quarters in a Section.  They are identified by "NE", "NW", "SE"
 and "SW".
 
-== Purpose
+## Purpose
 
 The purpose of Rats is to make it easier to deal with location described using
 the Alberta Township System, at the Quarter, Section or Township level.
 
-=== Validation
+### Validation
 
 Included is validations, only allowing you to describe locations that actually
 exist.
@@ -98,7 +101,7 @@ For example, Range-line 30 is valid for Township-lines 1-18, but not 18-126.
 NOTE: At the moment, invalid quarters within valid sections are not currently
 identified.
 
-=== Parsing
+### Parsing
 
 Included is string parsing, allowing you to extract and separate the different
 fields from multiple string representations of the location.
@@ -106,7 +109,7 @@ 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
+### Expansion/Division
 
 Townships, Sections and Half Sections can be divided into multiple Quarter Sections.
 1 Half Section = 2 Quarter Sections
@@ -117,87 +120,79 @@ Townships, Sections and Half Sections can be divided into multiple Quarter Secti
 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
+### Display
 
 Included is string creation that can create common representations of the
 location.
 
-= Usage
+# Usage
 
 Parse a location
 
-  quarter_section = Rats.new("NE 1-2-3 W4")
+```ruby
+quarter_section = Rats.new("NE 1-2-3 W4")
+```
 
 Print the location
 
-  quarter_section.location
-  quarter_section.location(:padded)
-  quarter_section.location(:short)
-  quarter_section.location(:long)
+```ruby
+quarter_section.location
+quarter_section.location(:padded)
+quarter_section.location(:short)
+quarter_section.location(:long)
+```
 
 Read the attributes
 
-  quarter_section.quarter
-  quarter_section.section
-  quarter_section.township
-  quarter_section.range
-  quarter_section.meridian
-  
+```ruby
+quarter_section.quarter
+quarter_section.section
+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")]
+```ruby
+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")]
 
-  multi_section = Rats.new("NSE 1-2-3 W4")
-  multi_section.is_divisible?
-  quarter_sections = multi_section.divide
-  # quarter_sections == [Rats.new("NE 1-2-3 W4"), Rats.new("NW 1-2-3 W4"), Rats.new("SE 1-2-3 W4")]
+multi_section = Rats.new("NSE 1-2-3 W4")
+multi_section.is_divisible?
+quarter_sections = multi_section.divide
+# quarter_sections == [Rats.new("NE 1-2-3 W4"), Rats.new("NW 1-2-3 W4"), Rats.new("SE 1-2-3 W4")]
+```
 
-= Information
+# Information
 
-== links
+## links
 
 http://en.wikipedia.org/wiki/Alberta_Township_System
 
-== Road Map
+## Road Map
 
 Future:
-- either correct the assumption that all quarters are valid in a valid
+* either correct the assumption that all quarters are valid in a valid
   section, or remove validation completely (re: all or none)
-- add support for Saskatchewan (no timeline, need to find data)
-- address bugs, if any
-
-Except for the above, once this gem is finalized, I do not see future
-development happening unless I want to add ATS to other-system conversions
-(ie: latitude/longitude).  Nothing else is planned.
+* add support for Saskatchewan (no timeline, need to find data)
 
-Currently this point has not been reached and this gem is still in development.
-
-== Assumptions
+## Assumptions
 
 As currently written, I assume that within every valid section, all four quarters
 are valid. I know this to be incorrect, but I can not correct this until I know which
 cases this assumption breaks down.
 
-== Environment
-
-This gem was created using:
-- ruby 1.9.1-p378, 1.9.2-p0
-- rspec 1.3.0
-- rake 0.8.7
+## Contributing
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
-== Copyright
+## Copyright
 
-Copyright (c) 2010 Mark sG. See LICENSE for details.
+Copyright (c) 2009-2014 Mark Gangl. See LICENSE for details.

data/Rakefile

@@ -1,46 +1,12 @@
 require 'rubygems'
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rats"
-    gem.summary = "A ruby class to help with using the Alberta Township System"
-    gem.description = "A ruby class to help with using the Alberta Township System"
-    gem.email = "rats@attackcorp.com"
-    gem.homepage = "http://github.com/attack/rats"
-    gem.authors = ["Mark G"]
-    #gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-  spec.spec_opts = ["-c"]
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+  spec.rspec_opts = ["--color"]
 end
 
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rats #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: :spec

data/lib/rats.rb

@@ -1,21 +1,16 @@
-$:.unshift(File.dirname(__FILE__))
-
+require 'rats/version'
 require 'rats/base'
 require 'rats/data'
 require 'rats/boundaries'
 
 module Rats
-  
   def self.new(*args)
     Rats::Base.new(args)
   end
-  
-  # custom errors
-  #
+
   class OutOfBounds < StandardError; end
   #class OutOfSection < OutOfBounds; end
   #class OutOfTownship < OutOfBounds; end
   #class OutOfMeridian < OutOfBounds; end
   #class OutOfAlberta < OutOfBounds; end
-    
-end
+end

data/lib/rats/base.rb

@@ -1,8 +1,7 @@
 module Rats
   class Base
-    
     attr_accessor :errors
-    
+
     def initialize(*args)
       return unless args.flatten!
       @quarter = Rats::Quarter.new
@@ -17,13 +16,13 @@ module Rats
         set_values(args)
       end
     end
-    
+
     def q; @quarter; end
     def s; @section; end
     def t; @township; end
     def r; @range; end
     def m; @meridian; end
-    
+
     def q=(v); @quarter = v; end
     def s=(v); @section = v; end
     def t=(v); @township = v; end
@@ -59,11 +58,11 @@ module Rats
       return unless value
       if value.is_a?(Array)
         set_values(value)
-      else  
+      else
         parse_string(value)
       end
     end
-    
+
     def to_s
       default_location
     end
@@ -88,20 +87,20 @@ module Rats
       end
     end
 
-    def valid?      
+    def valid?
       # check each data field individually
       [:meridian, :range, :township, :section, :quarter].each do |data|
         valid = self.send(data.to_s.chars.first).valid?
         add_error(data, self.send(data.to_s.chars.first).error) unless valid
       end
-      
+
       # check each field as it relates to others
       self.exists? unless self.errors.size > 0
-      
+
       # are we valid?
       self.errors.size == 0
     end
-    
+
     # test that a location actually exists
     #
     def exists?
@@ -110,26 +109,26 @@ module Rats
         add_error(:land, 'does not exist')
         return false
       end
-      
+
       # make sure range exists
       unless TOWNSHIPS_BY_RANGE_AND_MERIDIAN[self.meridian][self.range]
         add_error(:land, 'does not exist')
         return false
       end
-      
+
       # make sure township exists
       unless TOWNSHIPS_BY_RANGE_AND_MERIDIAN[self.meridian][self.range][:townships].include?(self.township)
         add_error(:land, 'does not exist')
         return false
       end
-      
+
       # make sure section exists
-      
+
       # it is possible all sections exists for all townships
       if TOWNSHIPS_BY_RANGE_AND_MERIDIAN[self.meridian][self.range].has_key?(:sections)
         # NO, now see if this township has valid sections
         if TOWNSHIPS_BY_RANGE_AND_MERIDIAN[self.meridian][self.range][:sections].has_key?(self.township)
-          # YES, check further to see that this section is listed          
+          # YES, check further to see that this section is listed
           unless TOWNSHIPS_BY_RANGE_AND_MERIDIAN[self.meridian][self.range][:sections][self.township].include?(self.section)
             add_error(:land, 'does not exist')
             return false
@@ -145,17 +144,17 @@ module Rats
         return true
       end
     end
-    
+
     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
@@ -169,7 +168,7 @@ module Rats
         self.divide_township
       end
     end
-    
+
     def divide_half
       quarters = []
       locations = case self.quarter.to_s.downcase
@@ -216,15 +215,15 @@ module Rats
       when 'swe'
         ['NE','SE','SW']
       end
-      
+
       # create the required locations
       locations.each do |quarter|
         quarters << Rats.new(self.meridian, self.range, self.township, section || self.section, quarter)
       end
-      
+
       quarters
     end
-    
+
     def divide_section(section=nil)
       quarters = []
       ['NE', 'NW', 'SE', 'SW'].each do |quarter|
@@ -232,7 +231,7 @@ module Rats
       end
       quarters
     end
-    
+
     def divide_township
       quarters = []
       (1..36).each do |section|
@@ -276,9 +275,9 @@ module Rats
     end
 
     def parse_parcel_id(parcel_id)
-      result = parcel_id.to_s.scan(/^(\d{1})(\d{2})(\d{3})(\d{2})(\D{1,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      
+      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
@@ -294,7 +293,7 @@ module Rats
       self.section = values.shift.to_i if values.size > 0
       self.quarter = values.shift.to_s if values.size > 0
     end
-    
+
 
     def default_location
       if self.quarter
@@ -307,7 +306,7 @@ module Rats
     def short_location
       [@meridian.to_p,@range.to_p,@township.to_p,@section.to_p,@quarter.to_p].compact.join('').strip
     end
-    
+
     def padded_location
       if self.quarter
         "#{@quarter.to_p} #{[@section.to_p,@township.to_p,@range.to_p].compact.join('-')} #{@meridian.to_s}".strip
@@ -327,11 +326,11 @@ module Rats
       parts << self.m.fullname
       parts.compact.join(', ')
     end
-    
+
     def add_error(index, the_error)
       @errors[index] = [] unless @errors.has_key?(index)
-      @errors[index] << the_error 
+      @errors[index] << the_error
     end
-    
+
   end
 end