usa 0.1.0

data/lib/generators/usa/install/install_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/active_record'
+
+module USA
+  module Generators
+    # Everything installing this gem writes into a host: the migrations that make its tables
+    # and fill them. Not an initializer, because there is nothing here to configure.
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      # Thor reads `USA` as `u_s_a` rather than underscoring it, so the name somebody types is
+      # said here. Without this line `bin/rails g usa:install` finds no generator at all.
+      namespace 'usa:install'
+
+      # @return [Array<String>] where a file being copied is looked for.
+      def self.source_paths = [ USA::Engine.root.join('db/migrate').to_s ]
+
+      # Copied rather than read off the gem, so the host owns the files and their timestamps.
+      # @return [void]
+      def copy_migrations
+        Dir.children(USA::Engine.root.join('db/migrate')).sort.each do |name|
+          migration_template name, "db/migrate/#{name.split('_', 2).last}"
+        end
+      end
+    end
+  end
+end

data/lib/tasks/usa.rake

@@ -0,0 +1,8 @@
+namespace :db do
+  namespace :usa do
+    desc 'Write every state, county, city and ZIP, including the ones a release has added'
+    task seed: :environment do
+      USA.seed
+    end
+  end
+end

data/lib/usa/engine.rb

@@ -0,0 +1,9 @@
+require 'action_dispatch'
+require 'rails/engine'
+
+module USA
+  # Teaches Rails where this gem's models live, and prefixes their tables with `usa_`.
+  class Engine < ::Rails::Engine
+    isolate_namespace USA
+  end
+end

data/lib/usa/version.rb

@@ -0,0 +1,4 @@
+module USA
+  # The version of this gem, as RubyGems knows it.
+  VERSION = '0.1.0'
+end

data/lib/usa.rb

@@ -0,0 +1,23 @@
+require 'active_support/inflector'
+require 'csv'
+
+# Before the engine, so Zeitwerk reads usa/zip.rb as USA::ZIP and a heading says ZIP, not Zip.
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym 'USA'
+  inflect.acronym 'ZIP'
+  inflect.acronym 'FIPS'
+end
+
+require 'usa/version'
+require 'usa/engine'
+
+# The geography of the United States: the states, counties, cities and ZIPs an address names.
+module USA
+  # Writes every row this release holds, keeping the id of every row the database already has.
+  # @return [void]
+  def self.seed
+    [ USA::State, USA::County, USA::City, USA::CityCounty, USA::ZIP ].each(&:seed)
+    USA::State.recount_counties
+    USA::County.recount_zips
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: usa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Claudio Baccigalupo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Every state, county, city and ZIP, as tables a Rails app joins to
+email:
+- claudiob@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/models/concerns/usa/seeded.rb
+- app/models/usa/city.rb
+- app/models/usa/city_county.rb
+- app/models/usa/county.rb
+- app/models/usa/record.rb
+- app/models/usa/state.rb
+- app/models/usa/zip.rb
+- db/migrate/20260914120000_create_usa_states.rb
+- db/migrate/20260914120001_create_usa_counties.rb
+- db/migrate/20260914120002_create_usa_zips.rb
+- db/migrate/20260914120003_create_usa_cities.rb
+- db/migrate/20260914120004_create_usa_city_counties.rb
+- db/migrate/20260914120005_seed_usa.rb
+- db/seeds/cities.csv
+- db/seeds/counties.csv
+- db/seeds/states.csv
+- db/seeds/zips.csv
+- lib/generators/usa/install/install_generator.rb
+- lib/tasks/usa.rake
+- lib/usa.rb
+- lib/usa/engine.rb
+- lib/usa/version.rb
+homepage: https://github.com/claudiob/usa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/claudiob/usa
+  source_code_uri: https://github.com/claudiob/usa/
+  changelog_uri: https://github.com/claudiob/usa/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/usa
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: The geography of the United States
+test_files: []