csquares 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-22
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/csquares.rb
+lib/csquares/csquares.rb
+lib/csquares/core_ext.rb
+script/console
+script/destroy
+script/generate
+test/test_csquares.rb

data/README.rdoc

@@ -0,0 +1,50 @@
+= csquares
+
+http://github.com/broughcut/csquares
+
+== DESCRIPTION:
+
+http://www.cmar.csiro.au/csquares/csq-faq.htm
+
+== FEATURES/PROBLEMS:
+
+
+== SYNOPSIS:
+
+csquare = CSquare.new(38.8894, -77.0356)
+csquare.code
+csquare.digits
+csquare.sq(0.01)
+
+== REQUIREMENTS:
+
+Ruby 1.8
+
+== INSTALL:
+
+sudo gem install csquares
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jamie Brough
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/csquares'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('csquares', CSquares::VERSION) do |p|
+  p.developer('Jamie Brough', 'broughcut@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/csquares.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'csquares/core_ext'
+require 'csquares/csquares'
+
+module CSquares
+  VERSION = '0.1.0'
+end

data/lib/csquares/core_ext.rb

@@ -0,0 +1,34 @@
+module Enumerable
+  
+  # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/6663
+  
+  def interleave(enum2)
+    e1, e2, res = to_a.reverse, enum2.to_a.reverse, []
+    res.push e1.pop, e2.pop until e1.empty? or e2.empty?
+    res + (e1 + e2) .reverse
+  end
+end
+
+class Array
+  
+  # http://blog.jayfields.com/2007/09/ruby-arraychunk.html
+
+  def chunk(number_of_chunks)
+    chunks = Array.new(number_of_chunks) { [] }
+    count = 0
+    self.each do |e|
+      chunks[count] << e 
+      count = (count < number_of_chunks-1) ? count + 1 : 0
+    end
+    chunks
+  end
+  
+  def chunk_into(max_size_of_array)
+    chunks = [[]]
+    self.each do |e|
+      chunks << [] unless chunks.last.length < max_size_of_array
+      chunks.last << e
+    end
+    chunks
+  end
+end

data/lib/csquares/csquares.rb

@@ -0,0 +1,70 @@
+class CSquare
+
+  attr_reader :lat, :lng, :code, :digits
+
+  KM = {10 => 0.1, 50 => 0.5, 100 => 1, 500 => 5, 1000 => 10}
+ 
+  def initialize(lat,lng)
+    @lat, @lng = lat.to_f,lng.to_f
+    digits = pad_and_interleave.insert(0,global_quadrant)
+    chunks = chunk_up(digits)
+    chunks[1..-1].each {|it| it.insert(0,intermediate_quadrant(it))}
+    @code = delimit(chunks)
+    @digits = chunks.join.split("").map {|it| it.to_i}
+  end
+
+  def sq(i=0.1,int=false)
+    n = 6 + (3 * Math.log10(i).abs).ceil
+    it = case i
+      when 10 then @digits[0..3]
+      when 5 then @digits[0..4]
+      when 1 then @digits[0..6]
+      else @digits[0..n]
+    end
+    result = delimit [it[0..3],*it[4..-1].chunk_into(3)]
+    int ? result.gsub(/:/){}.to_i : result
+  end
+
+  private
+
+  def global_quadrant
+    if lat >= 0
+      lng >= 0 ? 1 : 7
+    else
+		  lng >= 0 ? 3 : 5
+    end
+  end
+
+  def intermediate_quadrant(q)
+    a = (0..4).include?(q.first)
+    b = (0..4).include?(q.last)
+    if a && b then 1
+    elsif a && !b then 2
+    elsif !a && b then 3
+    else 4 end
+  end
+
+  def pad_and_interleave
+    a,b = [lat,lng].map {|it| it.to_f.abs.to_s.split(".")}
+    [a,b].each_with_index do |it,i| 
+      it.first.insert(0,"0") while it.first.size <= i+1
+      if i == 1
+        it[0] = it.first[0,2],it.first[2,2]
+      else
+        it[0] = it.first.split("")
+      end
+      it[1] = it.last.split("")
+      it.flatten!
+    end
+    a.interleave(b).join.split("").map {|it| it.to_i}
+  end
+
+  def chunk_up(digits)
+    chunks = digits.chunk_into(2)
+    chunks = [[chunks.first,chunks[1]].flatten,*chunks[2..-1]]
+  end
+
+  def delimit(chunks)
+    chunks.map {|it| it.join("")}.join(":").sub(/:$/){}
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/csquares.rb'}"
+puts "Loading csquares gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_csquares.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/csquares'
+
+class TestCSquares < Test::Unit::TestCase
+  def test_squares
+    assert_equal "7307:487:380:383:495:2",  CSquare.new(38.8894,-77.0356).sq(0.0005)
+    assert_equal "7307:487:380:383:495",    CSquare.new(38.8894,-77.0356).sq(0.001)
+    assert_equal "7307:487:380:383:4",      CSquare.new(38.8894,-77.0356).sq(0.005)
+    assert_equal "7307:487:380:383",        CSquare.new(38.8894,-77.0356).sq(0.01)
+    assert_equal "7307:487:380:3",          CSquare.new(38.8894,-77.0356).sq(0.05)
+    assert_equal "7307:487:380",            CSquare.new(38.8894,-77.0356).sq(0.1)
+    assert_equal "7307:487:3",              CSquare.new(38.8894,-77.0356).sq(0.5)
+    assert_equal "7307:487",                CSquare.new(38.8894,-77.0356).sq(1)
+    assert_equal "7307:4",                  CSquare.new(38.8894,-77.0356).sq(5)
+    assert_equal "7307",                    CSquare.new(38.8894,-77.0356).sq(10)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: csquares
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jamie Brough
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-22 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: http://www.cmar.csiro.au/csquares/csq-faq.htm
+email: 
+- broughcut@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/csquares.rb
+- lib/csquares/csquares.rb
+- lib/csquares/core_ext.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_csquares.rb
+has_rdoc: true
+homepage: http://github.com/broughcut/csquares
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: csquares
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: http://www.cmar.csiro.au/csquares/csq-faq.htm
+test_files: 
+- test/test_csquares.rb