census_shapes 0.2.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in census_geographies.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    census_shapes (0.2.0)
+      generator_spec
+      pg
+      postgis_adapter
+      progress_bar
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    fattr (2.2.1)
+    generator_spec (0.8.5)
+      rails (>= 3.0, < 4.0)
+      rspec-rails
+    highline (1.6.15)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    nofxx-georuby (1.9.2)
+    options (2.3.0)
+      fattr
+    pg (0.14.1)
+    polyglot (0.3.3)
+    postgis_adapter (0.8.1)
+      nofxx-georuby
+    progress_bar (0.4.0)
+      highline (~> 1.6.1)
+      options (~> 2.3.0)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  census_shapes!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+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,123 @@
+census_shapes
+==================
+
+A Ruby Gem that facilitates the importing US Census Shapefiles into a PostGIS database.
+
+### Prerequisites
+
+This gem requires Postgres / PostGIS and is intended to be used with a Rails 3 application.
+
+### Installation
+
+To install the 'census_shapes' ruby gem:
+
+`gem install census_shapes`
+
+To use the gem in your Rails 3 Application, include the gem in your Gemfile:
+
+`gem "census_shapes"`
+
+### SETUP
+
+## 1) $ rails generate census_shapes:setup
+
+To setup your rails application to use census_shapes, run the following generator:
+
+`rails g census_shapes:setup MODEL_NAME`
+
+This will create all the necessary files, including:
+
+    config/database_example.yml
+    db/###_create_geographies.rb
+    lib/tasks/postgis_template.rake
+    lib/tasks/census_shapes.rake
+    
+    app/models/geography.rb
+    app/controllers/geographies_controller.rb
+    app/views/layouts/geographies.html.erb
+    app/assets/stylesheets/geographies.css.scss
+    app/views/geographies/partials/_map.erb
+
+## 2) Setup your Database
+
+The generator will create an example database configuration file at: config/database_example.yml.
+
+Edit the database, template, username and password values for your environment. Change the postgis_path for the appropriate environment(s). If you installed PostGIS through homebrew on OS X, the development path should be:  /usr/local/share/postgis/
+
+Rename the file database.yml.
+
+## 3) Create a PostGIS Template
+
+In your application directory, run the following rake task from the command console:
+
+`rake postgis_template:create`
+
+The generator uses the values set in database.yml, including the postgis_path to find the necessary PostGIS SQL files, and will generate a template database if one does not already exist.
+
+## 3) Migrate Database
+
+If Postgres / PostGIS is setup properly and the database.yml and template database are configured, you should now be able to migrate the database:
+
+`rake db:migrate`
+
+## 4) Import Census Geographies
+
+With the database migrated, we may import the census geographies:
+
+`rake census_shapes:import SHAPE=DESIRED_SHAPES`
+
+Replace DESIRED_SHAPES with the slugs of the Census Shapes you wish to import. For example, to import States and Counties, you would run the following command:
+
+`rake census_shapes:import SHAPE=STATE,COUNTY`
+
+The import process will download the zips of the required Census Shapes to 'tmp/shapefiles', unless a path is specified with the PATH argument:
+
+`rake census_shapes:import SHAPE=STATE,COUNTY PATH=/usr/local/shapefiles`
+
+Lastly, the Zip files will be deleted after import unless the ARCHIVE argument is specified:
+
+`rake census_shapes:import SHAPE=STATE,COUNTY ARCHIVE=true`
+
+For a full list of the 22 supported Census Geographic Summary Levels, see 'Summary Levels' of the 'Usage' section.
+
+Note: Depending upon your internet speed and the amount of Census Shapes you require, this may take several hours or days to complete.
+
+## 5) Validate Geometry (Optional)
+
+Depending upon the Census Shapes you install, validation may be required. For example:
+
+rake census_shapes:validate_geometry SHAPE=STATE,COUNTY
+
+The validate_geometry rake task will test and repair the geometries of all imported shapes.
+
+### USAGE
+
+## Summary Levels
+
+Census-Geographies will import the following 22 Geographic Summary Levels:
+
+**Sumlevel - Slug:  Name**
+
+ * 040 - STATE:  State
+ * 050 - COUNTY:  County
+ * 060 - COUSUB:  County Subdivision
+ * 067 - SUBMCD:  Subminor Civil Subdivision
+ * 101 - BLOCK:  Block
+ * 140 - TRACT: Tract
+ * 150 - BG:  Blockgroup
+ * 160 - PLACE:  Place
+ * 230 - ANRC: Alaska Native Regional Corporation
+ * 280 - AIANNH: American Indian Area/Alaska Native Area/Hawaiian Home Land
+ * 281 - AITS: American Indian Tribal Subdivision
+ * 320 - CBSA:  Metropolitan Statistical Area/Micropolitan Statistical Area
+ * 323 - METDIV: Metropolitan Division
+ * 340 - CSA: Combined Statistical Area
+ * 500 - CD: Congressional District (111th)
+ * 610 - SLDU: State Legislative District (Upper Chamber)
+ * 620 - SLDL:  State Legislative District (Lower Chamber)
+ * 700 - VTD: Voting District
+ * 871 - ZCTA5: ZIP Code Tabulation Area (5-Digit)
+ * 950 - ELSD: School District (Elementary)
+ * 960 - SCSD: School District (Secondary)
+ * 970 - UNSD: School District (Unified)
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/census_shapes.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "census_shapes/version"
+require "census_shapes"
+
+Gem::Specification.new do |s|
+  s.name        = "census_shapes"
+  s.version     = CensusShapes::VERSION
+  s.authors     = ["Ty Rauber"]
+  s.email       = ["tyrauber@mac.com"]
+  s.homepage    = "https://github.com/tyrauber/census_shapes"
+  s.summary     = "A Ruby Gem for importing US Census Shapes into PostGIS"
+  s.description = "Imports all the US Census Geographies into a PostGIS database."
+
+  s.rubyforge_project = "census_shapes"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "rspec"
+  s.add_dependency "pg"
+  s.add_dependency "postgis_adapter"
+  s.add_dependency "progress_bar"
+  s.add_dependency "generator_spec"
+end

data/lib/census_shapes.rb

@@ -0,0 +1,2 @@
+require "rubygems"
+require "census_shapes/version"

data/lib/census_shapes/version.rb

@@ -0,0 +1,3 @@
+module CensusShapes
+  VERSION = "0.2.0"
+end

data/lib/generators/census_shapes/setup/setup_generator.rb

@@ -0,0 +1,104 @@
+require 'rails/generators/migration'
+
+module CensusShapes
+  module Generators
+    class SetupGenerator < ::Rails::Generators::Base
+
+      include Rails::Generators::Migration       
+      source_root File.expand_path('../templates', __FILE__)
+      
+      argument :name, :type => :string, :default => "geography"
+    
+      class_option :route, :type => :boolean, :default => true, :description => "Generate Route" 
+      class_option :model, :type => :boolean, :default => true, :description => "Generate Model"
+      class_option :controller, :type => :boolean, :default => true, :description => "Generate Controller"  
+      class_option :view, :type => :boolean, :default => true, :description => "Generate View"  
+    
+      desc "add gem dependencies"
+      def add_gems
+        gem("pg")
+        gem("postgis_adapter")
+      end
+
+      desc "add the geographies migration"
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_files
+        migration_template "db/migrate/create_shapes.rb", "db/migrate/create_#{controller_name}.rb", {:controller_name => controller_name }
+        copy_file "config/database_example.yml", "config/database_example.yml"
+        copy_file "lib/tasks/postgis_template.rake", "lib/tasks/postgis_template.rake"
+        copy_file "lib/tasks/census_shapes.rake", "lib/tasks/census_shapes.rake"
+        gsub_file "lib/tasks/census_shapes.rake", "CONTROLLER_NAME", controller_name
+        copy_file "lib/yaml/us_shapes.yml", "lib/yaml/us_shapes.yml"
+        copy_file "lib/yaml/us_states.yml", "lib/yaml/us_states.yml"
+        copy_file "config/initializers/shapes_globals.rb", "config/initializers/#{controller_name}_globals.rb"
+        gsub_file "config/initializers/#{controller_name}_globals.rb", "MODEL_NAME", model_name
+      end
+    
+      def add_geographies_route
+        if options.route
+          route("resources :#{model_name}")
+          route("match ':type/:z/:x/:y.:format'=> '#{controller_name}#index', :requirements => {:z => /-?\d+(\.\d+)/, :x => /-?\d+(\.\d+)/, :y => /-?\d+(\.\d+)/ }")
+          route("root :to => '#{controller_name}#index'")
+        end
+      end
+    
+      def add_model
+        if options.model
+          copy_file "models/shape.rb", "app/models/#{model_name}.rb"
+          gsub_file "app/models/#{model_name}.rb", "MODEL_NAME", model_name
+        end
+      end
+
+      def add_controller
+        if options.controller
+          copy_file "controllers/shapes_controller.rb", "app/controllers/#{controller_name}_controller.rb"
+          gsub_file "app/controllers/#{controller_name.underscore}_controller.rb", "CONTROLLER_NAME", controller_name.camelcase
+          gsub_file "app/controllers/#{controller_name.underscore}_controller.rb", "MODEL_NAME", model_name
+        end
+      end
+    
+      def add_views
+        if options.view
+          copy_file "views/layouts/shapes.html.erb", "app/views/layouts/#{controller_name.underscore}.html.erb"
+          directory "views/shapes", "app/views/#{controller_name.underscore}"
+          gsub_file "app/views/#{controller_name.underscore}/index.html.erb", "MODEL_NAME", model_name
+          gsub_file "app/views/#{controller_name.underscore}/index.html.erb", "MODEL_DOWNCASE", model_name.downcase
+          gsub_file "app/views/#{controller_name.underscore}/index.html.erb", "CONTROLLER_NAME", controller_name
+        end
+      end
+
+      def remove_public_index
+        `rm public/index.html`
+      end
+
+      private
+    
+      def model_name  
+        name.classify
+      end
+      
+      def controller_name
+        name.tableize
+      end
+    end
+    
+    class String
+      
+      def underscore
+        self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+    end
+  end
+end

data/lib/generators/census_shapes/setup/templates/config/database_example.yml

@@ -0,0 +1,29 @@
+development:
+  adapter: postgresql
+  host: localhost
+  encoding: utf8
+  database: census_development
+  template: template_postgis
+  username: USERNAME
+  password: PASSWORD
+  postgis_path: /usr/local/share/postgis/
+  
+production:
+  adapter: postgresql
+  host: localhost
+  encoding: utf8
+  database: census_production
+  template: template_postgis
+  username: USERNAME
+  password: PASSWORD
+  postgis_path: /usr/local/share/postgis/
+
+test:
+  adapter: postgresql
+  host: localhost
+  encoding: utf8
+  database: census_test
+  template: template_postgis
+  username: USERNAME
+  password: PASSWORD
+  postgis_path: /usr/local/share/postgis/