usamap 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDdhOGExNjgxMzhkZjQ1M2UwNmZjOGJkNzBjNDYyZGE1ZGMxYjYxNg==
+  data.tar.gz: !binary |-
+    MDk0NTMzNjVkYTQzYjU2NzU4NjJiMDI3M2U4ZGFmM2ExMDBkMTUzNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGY0M2FhMGE3N2Q4MjJjOTIyMzdhMjJkMDEwY2JlODc0MjMwODdjMWMzNDkz
+    ZTViN2JhZTZmMDVjMDU2MGU1YTMzZTM2NzljYzE4NzU1MGFlNjU2YWQ2NGYy
+    NzY2NWVlMGNjYzYzNzI0MzliYzAxMDIxM2YyYTk0OThiZDYwYTI=
+  data.tar.gz: !binary |-
+    NjNkOWM1MGQ5MWI1MmNjOGEwODk2NzQ1NWYzNmI1NTVhNzkzNmQwZTgzZTQ5
+    YWE5YWNhYTNhN2M4YmQ1ZDA0NTAxYzhjMWNiZDI0NmE0ODc1ZmIyODA3Nzk4
+    NjNlMGE5N2M1MGQ0ZGQ4YmI2YzcyMzBkY2RjOTIzZGExMjc0NmY=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) salemine.com
+
+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/README.md

@@ -0,0 +1,55 @@
+usamap
+======
+
+Create a colorized svg map of the USA using ruby. Plot ranges and colors using FIPS coordinates for US counties.
+
+## Installation
+
+~~~.ruby
+  gem install usamap
+~~~
+
+
+## Example Usage
+
+~~~.ruby
+require 'usamap'
+
+colors = {}
+colors[0..5] = '#CD5C5C'
+colors[6..100] = 'blue'
+
+stats = {}
+stats['35001'] = 3  # 35001 is FIPS for Bernalillo, NM
+stats['35049'] = 99 # 35049 is FIPS for Santa Fe, NM
+
+my_map = USAmap.new(stats, colors)
+puts my_map
+~~~
+
+
+## Example Output
+
+
+![alt text](https://raw.github.com/wiki/salemine/usamap/nm_counties.png "Sample Map")
+
+
+
+
+
+
+
+## Credits/Resources
+SVG Map:
+http://commons.wikimedia.org/wiki/File:Usa_counties_large.svg
+
+
+FIPS Codes:
+http://en.wikipedia.org/wiki/FIPS_county_code
+
+
+## Inspiration
+http://flowingdata.com/2009/11/12/how-to-make-a-us-county-thematic-map-using-free-tools/
+
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/usa_counties_svg.rb

@@ -1,5 +1,7 @@
-
-@@svg = <<END_OF_SVG
+module UsaCountiesSvg
+  # The blank SVG (Scalable Vector Graphics) map of the USA 
+  def self.svg
+    @svg = <<-END_OF_SVG
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 
@@ -35,7 +37,7 @@
     </rdf:RDF>
   </metadata>
   <defs id='defs1930'></defs>
-  
+
   <style type='text/css' id='style_css_sheet'>
   /*
    * Below are Cascading Style Sheet (CSS) definitions in use in this file,
@@ -46,7 +48,7 @@
    * 
    *
    */
-  
+
 .counties {fill:#d0d0d0;fill-rule:nonzero;stroke:#000000;stroke-width:0.178287;}
 .State_Lines {fill:none;stroke:#221e1f;stroke-width:0.89143497;}
 .separator {fill:none;stroke:#a9a9a9;stroke-width:2.3177309;}
@@ -12630,5 +12632,6 @@
      class="separator"
      id="#separator" />
 </svg>
-
-END_OF_SVG
+    END_OF_SVG
+  end
+end

data/lib/usamap.rb

@@ -1,19 +1,24 @@
-require 'usa_counties_svg'
+require File.join(File.dirname(__FILE__), 'usa_counties_svg')
 
+# @author salemine <info@salemine.com>
 class USAmap
-  attr_accessor :stats_h, :colors_h
-  
+  include UsaCountiesSvg
+  # @param [Hash] stats_h stats to plot by county FIPS value eg stats_h ['35001'] = 3
+  # @param [Hash] colors_h colors to plot for numeric ranges eg colors_h [0..5] = '#CD5C5C'
   def initialize(stats_h = {}, colors_h = {})
     @stats_h, @colors_h = stats_h, colors_h
   end
 
+  # == Returns:
+  # A colorized SVG (Scalable Vector Graphics) map of the USA 
   def to_s
     css = '' 
     @stats_h.each do |fips, val|
       colr = @colors_h.select { |range, hex| range.member?(val) }.values.first  
       css << ".c#{fips} {fill:#{colr}}\n"
     end
-    @@svg.gsub!(/\/\*CSS insertion point\*\//, css)
+    svg = UsaCountiesSvg.svg
+    css.empty? ? svg : svg.gsub!(/\/\*CSS insertion point\*\//, "/*CSS insertion point*/\n#{css}") 
   end
-  
+    
 end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/usamap/usamap_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'usamap'
+
+module Usamap
+  
+  describe USAmap do  
+    before(:each) do
+      @blank_svg = UsaCountiesSvg.svg
+    end
+    
+    describe "should be a blank map when instantiated without params"  do
+      its(:to_s) { should == @blank_svg }
+    end      
+     
+    context "with color and stats hashes passed when instantiated" do
+      it "should insert one css class definition" do
+        colors = {}; colors[6..100] = 'blue'
+        stats = {}; stats['35049'] = 99 
+        my_map = USAmap.new(stats, colors)      
+ 
+        my_map.to_s.should include (".c35049 {fill:blue}")
+      end
+ 
+      it "should be equal to the blank_svg with the css inserted" do
+        colors = {}; colors[6..100] = 'blue'
+        stats = {}; stats['35049'] = 99 
+        my_map = USAmap.new(stats, colors)      
+        blank_svg_tweaked =  @blank_svg.gsub(/\/\*CSS insertion point\*\//, "/*CSS insertion point*/\n.c35049 {fill:blue}\n")       
+   
+        blank_svg_tweaked.should == my_map.to_s  
+      end
+    end
+  
+  end
+
+end

metadata

@@ -1,17 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: usamap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - salemine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
-dependencies: []
-description: A gem to draw a svg map of the USA by county
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Create a colorized svg map of the USA by county using FIPS coordinates
 email: info@salemine.com
 executables: []
 extensions: []
@@ -19,29 +32,34 @@ extra_rdoc_files: []
 files:
 - lib/usamap.rb
 - lib/usa_counties_svg.rb
+- Rakefile
+- spec/spec_helper.rb
+- spec/usamap/usamap_spec.rb
+- README.md
+- LICENSE.txt
 homepage: https://github.com/salemine/usamap
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: A map of the USA
+specification_version: 4
+summary: Map of the USA in svg format. Plot colors via FIPS county coordinates.
 test_files: []
 has_rdoc: