decoupage_administratif 0.1.0

data/lib/decoupage_administratif/territory_strategies.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module DecoupageAdministratif
+  module TerritoryStrategies
+    class Base
+      def initialize(territory)
+        @territory = territory
+      end
+
+      def intersects_with_insee_codes?(commune_insee_codes)
+        return false if commune_insee_codes.empty?
+
+        perform_intersection(commune_insee_codes)
+      end
+
+      def insee_codes
+        @insee_codes ||= calculate_insee_codes
+      end
+
+      private
+
+      attr_reader :territory
+
+      def perform_intersection(commune_insee_codes)
+        raise NotImplementedError, "Must be implemented by subclass"
+      end
+
+      def calculate_insee_codes
+        raise NotImplementedError, "Must be implemented by subclass"
+      end
+    end
+
+    class CommuneStrategy < Base
+      private
+
+      def perform_intersection(commune_insee_codes)
+        commune_insee_codes.include?(territory.code)
+      end
+
+      def calculate_insee_codes
+        [territory.code]
+      end
+    end
+
+    class DepartementStrategy < Base
+      private
+
+      def perform_intersection(commune_insee_codes)
+        departement_prefix = territory.code.length == 2 ? territory.code : territory.code[0..1]
+        commune_insee_codes.any? { |commune_code| commune_code.start_with?(departement_prefix) }
+      end
+
+      def calculate_insee_codes
+        territory.communes.map(&:code)
+      end
+    end
+
+    class RegionStrategy < Base
+      private
+
+      def perform_intersection(commune_insee_codes)
+        departement_codes = territory.departements.map(&:code)
+        commune_insee_codes.any? do |commune_code|
+          dept_code = commune_code.length >= 3 && commune_code[0..1].to_i >= 96 ? commune_code[0..2] : commune_code[0..1]
+          departement_codes.include?(dept_code)
+        end
+      end
+
+      def calculate_insee_codes
+        territory.communes.map(&:code)
+      end
+    end
+
+    class EpciStrategy < Base
+      private
+
+      def perform_intersection(commune_insee_codes)
+        epci_commune_codes = territory.membres.map { |membre| membre[:code] || membre["code"] }
+        (epci_commune_codes & commune_insee_codes).any?
+      end
+
+      def calculate_insee_codes
+        territory.membres.map { |membre| membre[:code] || membre["code"] }
+      end
+    end
+  end
+end

data/lib/decoupage_administratif/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DecoupageAdministratif
+  VERSION = "0.1.0"
+  DATA_VERSION = "5.2.0"
+  DATA_SOURCE = "@etalab/decoupage-administratif"
+end

data/lib/decoupage_administratif.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "decoupage_administratif/version"
+require_relative "decoupage_administratif/config"
+require_relative "decoupage_administratif/base_model"
+require_relative "decoupage_administratif/territory_strategies"
+require_relative "decoupage_administratif/territory_extensions"
+require_relative "decoupage_administratif/parser"
+require_relative "decoupage_administratif/commune"
+require_relative "decoupage_administratif/departement"
+require_relative "decoupage_administratif/region"
+require_relative "decoupage_administratif/epci"
+require_relative "decoupage_administratif/search"
+
+require 'decoupage_administratif/railtie' if defined?(Rails)
+
+module DecoupageAdministratif
+  class Error < StandardError; end
+  class NotFoundError < Error; end
+
+  # Returns information about the embedded data version
+  # @return [String] formatted string with data version information
+  def self.data_info
+    "Data version: #{DATA_VERSION} (from #{DATA_SOURCE})"
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+require_relative '../decoupage_administratif/config'
+
+def download_file(url, destination)
+  puts "Downloading from #{url}..."
+
+  uri = URI(url)
+  response = Net::HTTP.get_response(uri)
+
+  raise "Download failed with status: #{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+  File.binwrite(destination, response.body)
+  puts "Successfully downloaded"
+
+  # Validate JSON
+  begin
+    JSON.parse(File.read(destination))
+    puts "JSON validation successful"
+  rescue JSON::ParserError => e
+    puts "Error: Invalid JSON file downloaded"
+    puts e.message
+    FileUtils.rm(destination)
+    raise "Download failed: Invalid JSON"
+  end
+end
+
+namespace :decoupage_administratif do
+  desc 'Update files'
+  task :update do
+    collection = %w[communes departements regions epci]
+    data_dir = DecoupageAdministratif::Config.data_directory
+    FileUtils.mkdir_p(data_dir)
+
+    collection.each do |item|
+      file = File.join(data_dir, "#{item}.json")
+      url = "https://unpkg.com/@etalab/decoupage-administratif@4.0.0/data/#{item}.json"
+
+      download_file(url, file)
+
+      puts "Update completed successfully!"
+    rescue StandardError => e
+      puts "Error during update:"
+      puts e.message
+      puts e.backtrace
+      exit 1
+    end
+  end
+
+  desc 'Download files'
+  task :install do
+    data_dir = DecoupageAdministratif::Config.data_directory
+    FileUtils.rm_rf(data_dir) if File.directory?(data_dir)
+    Rake::Task['decoupage_administratif:update'].invoke
+  end
+end

data/sig/decoupage_administratif/base_model.rbs

@@ -0,0 +1,7 @@
+module DecoupageAdministratif
+  module BaseModel
+    def find: (String) -> untyped
+    def find_by: (Hash[Symbol, untyped]) -> untyped
+    def where: (Hash[Symbol, untyped]) -> Array[untyped]
+  end
+end

data/sig/decoupage_administratif/commune.rbs

@@ -0,0 +1,32 @@
+module DecoupageAdministratif
+  extend BaseModel
+  class Commune
+    extend BaseModel
+    include TerritoryExtensions
+    attr_reader code: String
+    attr_reader nom: String
+    attr_reader zone: String
+    attr_reader region_code: String
+    attr_reader departement_code: String
+    attr_reader commune_type: String
+
+    def initialize: (
+        code: String,
+        nom: String,
+        zone: String,
+        region_code: String,
+        departement_code: String,
+        commune_type: Symbol
+      ) -> void
+
+    def self.all: () -> Array[Commune]
+
+    def self.communes_actuelles: () -> Array[Commune]
+
+    def region: () -> Region
+
+    def departement: () -> Departement
+
+    def epci: () -> Epci?
+  end
+end

data/sig/decoupage_administratif/departement.rbs

@@ -0,0 +1,24 @@
+module DecoupageAdministratif
+  class Departement
+    extend BaseModel
+    include TerritoryExtensions
+    attr_reader code: String
+    attr_reader nom: String
+    attr_reader zone: String
+    attr_reader code_region: String
+
+    def initialize: (
+        code: String,
+        nom: String,
+        zone: String,
+        code_region: String
+      ) -> void
+
+
+    def self.all: () -> Array[Departement]
+
+    def communes: () -> Array[Commune]
+
+    def region: () -> Region
+  end
+end

data/sig/decoupage_administratif/epci.rbs

@@ -0,0 +1,23 @@
+module DecoupageAdministratif
+  class Epci
+    extend BaseModel
+    include TerritoryExtensions
+    attr_reader code: String
+    attr_reader nom: String
+    attr_reader membres: Array[{ code: String, nom: String }]
+
+    def initialize: (
+        code: String,
+        nom: String,
+        membres: Array[{ code: String, nom: String }]
+      ) -> void
+
+    def self.all: () -> Array[Epci]
+
+    def self.search_by_communes_codes: (Array[String]) -> Array[Epci]
+
+    def communes: () -> Array[Commune]
+
+    def regions: () -> Array[Region]
+  end
+end

data/sig/decoupage_administratif/parser.rbs

@@ -0,0 +1,11 @@
+module DecoupageAdministratif
+  class Parser
+    attr_reader data: Array[Hash[String, untyped]]
+
+    def initialize: (String) -> void
+
+    private
+
+    def load_data: () -> void
+  end
+end

data/sig/decoupage_administratif/region.rbs

@@ -0,0 +1,21 @@
+module DecoupageAdministratif
+  class Region
+    extend BaseModel
+    include TerritoryExtensions
+    attr_reader code: String
+    attr_reader nom: String
+    attr_reader zone: String
+
+    def initialize: (
+        code: String,
+        nom: String,
+        zone: String,
+      ) -> void
+
+    def self.all: () -> Array[Region]
+
+    def communes: () -> Array[Commune]
+
+    def departements: () -> Array[Departement]
+  end
+end

data/sig/decoupage_administratif/search.rbs

@@ -0,0 +1,20 @@
+module DecoupageAdministratif
+  class Search
+    attr_reader codes: Array[String] | nil
+    attr_reader regions: Array[Region] | nil
+    attr_reader departements: Array[Departement] | nil
+    attr_reader epcis: Array[Epci] | nil
+    attr_reader communes: Array[Commune] | nil
+
+    def by_insee_codes: () -> Hash[Symbol, Array[Region] | Array[Departement] | Array[Epci] | Array[Commune]]
+
+    private
+
+    def find_communes_by_codes: () -> Hash[Departement, Array[Commune]]
+
+    def search_for_communes: () -> void
+    def search_for_departements: () -> void
+    def search_for_epcis: () -> void
+    def search_for_region: () -> void
+  end
+end

data/sig/decoupage_administratif/territory_extensions.rbs

@@ -0,0 +1,11 @@
+module DecoupageAdministratif
+  module TerritoryExtensions
+    def territory_intersects_with_insee_codes?: (Array[String] commune_insee_codes) -> bool
+
+    def territory_insee_codes: () -> Array[String]
+
+    private
+
+    def territory_strategy: () -> TerritoryStrategies::Base
+  end
+end

data/sig/decoupage_administratif/territory_strategies.rbs

@@ -0,0 +1,51 @@
+module DecoupageAdministratif
+  module TerritoryStrategies
+    class Base
+      def initialize: (untyped territory) -> void
+
+      def intersects_with_insee_codes?: (Array[String] commune_insee_codes) -> bool
+
+      def insee_codes: () -> Array[String]
+
+      private
+
+      attr_reader territory: untyped
+
+      def perform_intersection: (Array[String] commune_insee_codes) -> bool
+
+      def calculate_insee_codes: () -> Array[String]
+    end
+
+    class CommuneStrategy < Base
+      private
+
+      def perform_intersection: (Array[String] commune_insee_codes) -> bool
+
+      def calculate_insee_codes: () -> Array[String]
+    end
+
+    class DepartementStrategy < Base
+      private
+
+      def perform_intersection: (Array[String] commune_insee_codes) -> bool
+
+      def calculate_insee_codes: () -> Array[String]
+    end
+
+    class RegionStrategy < Base
+      private
+
+      def perform_intersection: (Array[String] commune_insee_codes) -> bool
+
+      def calculate_insee_codes: () -> Array[String]
+    end
+
+    class EpciStrategy < Base
+      private
+
+      def perform_intersection: (Array[String] commune_insee_codes) -> bool
+
+      def calculate_insee_codes: () -> Array[String]
+    end
+  end
+end

data/sig/decoupage_administratif.rbs

@@ -0,0 +1,4 @@
+module DecoupageAdministratif
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: decoupage_administratif
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucien Mollard
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Ruby gem for French administrative divisions (découpage administratif
+  français). Access data about all French communes (municipalities), départements,
+  régions, and EPCIs (intercommunalités). Official data from @etalab/decoupage-administratif.
+email:
+- lucien.mollard@beta.gouv.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/communes.json
+- data/departements.json
+- data/epci.json
+- data/regions.json
+- lib/decoupage_administratif.rb
+- lib/decoupage_administratif/base_model.rb
+- lib/decoupage_administratif/commune.rb
+- lib/decoupage_administratif/config.rb
+- lib/decoupage_administratif/departement.rb
+- lib/decoupage_administratif/epci.rb
+- lib/decoupage_administratif/parser.rb
+- lib/decoupage_administratif/railtie.rb
+- lib/decoupage_administratif/region.rb
+- lib/decoupage_administratif/search.rb
+- lib/decoupage_administratif/territory_extensions.rb
+- lib/decoupage_administratif/territory_strategies.rb
+- lib/decoupage_administratif/version.rb
+- lib/tasks/install.rake
+- sig/decoupage_administratif.rbs
+- sig/decoupage_administratif/base_model.rbs
+- sig/decoupage_administratif/commune.rbs
+- sig/decoupage_administratif/departement.rbs
+- sig/decoupage_administratif/epci.rbs
+- sig/decoupage_administratif/parser.rbs
+- sig/decoupage_administratif/region.rbs
+- sig/decoupage_administratif/search.rbs
+- sig/decoupage_administratif/territory_extensions.rbs
+- sig/decoupage_administratif/territory_strategies.rbs
+homepage: https://github.com/betagouv/decoupage-administratif-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/betagouv/decoupage-administratif-gem
+  changelog_uri: https://github.com/betagouv/decoupage-administratif-gem/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: French administrative divisions - Découpage administratif français
+test_files: []