epok 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 387ff0cf39fe626399e0c9e3c3100403040a9b632c7d2a6f0b32a7831bd5fe35
-  data.tar.gz: 892468b7a7ac3cd9663e04f9aec7bdd241570db8b05c9b3f6c5baa3f0c1b0f0a
+  metadata.gz: 12d0e1ef79e2fd5ff522e79748f413cdb123a79c863bba24a85dce868a1c7127
+  data.tar.gz: 0c44daa4fe8d10908c75301d9a363bacf4d03ff0edf0eb13a2ff307cf96fe286
 SHA512:
-  metadata.gz: b300e878806a3cf7ebf3336eaae481e55576ac89e5677d1b177ef6c42e2e40a59368893aaeb34e5f78e168c437bb1f0507496900f133c8b9d6652995a0bcc52a
-  data.tar.gz: f79a5fab0614a5cbd6a146cff6693a5ffc195d9bff4d04d2551d06f76103d46ea5565e6f4a7a3efcf1b2e28cebe71071d7c228ab07905dab259b5146907a7e17
+  metadata.gz: 8358374a58c28bd2cb5f10ec9ce94248b0a9ba2a2bb2a733f4cfb003a62fecf90e8e6ec46ffd8648b8ab4172df745976586fcc09b264d10c26f34438138af961
+  data.tar.gz: bcc962b28eaf4a3d8bb62325a422709488a437338aad6c7eced0afe9bce2c27a5865f7d367674759888e7fe78c28f46d8fb4350b3424dab60fba894627050816

data/.claude/skills/swarf/SKILL.md

@@ -0,0 +1,77 @@
+---
+name: swarf
+description: Score Ruby methods by complexity against test coverage with swarf, and turn the worst rows into the next test to write. Use after writing or changing Ruby code and before calling a change done.
+---
+
+# swarf
+
+swarf scores every Ruby method with `CRAP = CC² · (1 − coverage)³ + CC` and lists them worst first. Complexity is parsed from source. Coverage is recorded by a probe loaded into the test run and stored in `.swarf/coverage.json`, so scoring works without setup but coverage needs a test run.
+
+## The loop
+
+1. Run the suite with the probe loaded (see Setup if unsure):
+
+   ```
+   bundle exec rspec          # or: bundle exec rake test
+   ```
+
+2. Score the files you touched, not the whole project:
+
+   ```
+   git diff --name-only --diff-filter=d main -- '*.rb' | xargs bundle exec swarf
+   ```
+
+   Named paths are always scored, even under `test/`, `db/` or a `.swarfignore` pattern.
+
+3. Take the top rows and act on the Evidence column (next section). Write or extend the test, re-run the suite, score again.
+
+4. Stop when the touched methods sit at `CRAP = CC` with `Cov% 100.0`. Nothing you test pulls a score under its CC. If a score is too high at full coverage, that is complexity, which is a refactor question, not a testing one. Do not split methods to chase the number.
+
+Before saying a change is done, run step 2 and report the top rows.
+
+## Reading a row
+
+```
+Method          CC    Cov%   CRAP      Evidence  Location
+Cart#checkout    6    0.0%  42.00  never called  lib/cart.rb:31
+Cart#discount    4   50.0%   6.00        3/6 br  lib/cart.rb:24
+```
+
+| Evidence       | Meaning                                      | Do                                                            |
+| -------------- | -------------------------------------------- | ------------------------------------------------------------- |
+| `never called` | A VM call count of zero. No test reaches it. | Write a test that calls it.                                   |
+| `3/6 br`       | 3 of 6 branch outcomes ran.                  | Extend a test to the untaken outcomes.                        |
+| `1/1 ln`       | No branches, so lines are the whole truth.   | Nothing, at 100%.                                             |
+| `no data`      | No run has been recorded for this file.      | The probe is not loaded, or the suite has not run. Fix Setup. |
+| `stale`        | The file changed after it was measured.      | Re-run the suite, then score again.                           |
+
+`no data` and `stale` both score at the `CC² + CC` floor rather than guess. They are also counted per file under the table, because the fix is per file.
+
+A `never called` on a method a test clearly exercises means the test ran without the probe, or the probe loaded after the file. Check Setup before writing a duplicate test.
+
+## Setup
+
+The probe must load before the code under test, because `Coverage` only sees files loaded after it starts. One line, placed first:
+
+- **RSpec**: first line of `.rspec`: `--require swarf/probe`
+- **Minitest**: first line of `test/test_helper.rb`: `require "swarf/probe"`
+- **Rails**: in `test/test_helper.rb`, after `require "bundler/setup"` and before `require_relative "../config/environment"`. Below the environment require, the whole app is invisible to it.
+- **Anything**: `RUBYOPT="-rswarf/probe" bundle exec rake test`
+
+Add `.swarf/` to `.gitignore`. Runs merge, so a single spec file adds to what earlier runs proved; nothing is erased until the file's bytes change.
+
+Do not run swarf's probe alongside SimpleCov. Ruby allows one `Coverage.start` per process; if SimpleCov started first, swarf warns and records nothing.
+
+## Commands
+
+```
+bundle exec swarf                       # whole project, worst 20
+bundle exec swarf lib/ app/             # directories
+bundle exec swarf app/models/cart.rb    # one file
+bundle exec swarf --limit 0             # every row
+bundle exec swarf --ignore "app/legacy/**"
+bundle exec swarf --all                 # ignore nothing, including db/ and .swarfignore
+SWARF_DIR=/tmp/swarf bundle exec swarf  # store elsewhere; set for the test run too
+```
+
+swarf's CC counts `if`, `unless`, `while`, `until`, `for`, `when`, `in`, `rescue`, `&&`, `||` and `&.`, not blocks, so it will not match RuboCop's. Methods made by `define_method` are not seen.

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /test/fixtures/
+.swarf/

data/CLAUDE.md

@@ -0,0 +1,31 @@
+# Epok
+
+Ruby gem wrapping the GCBA EPOk API (https://epok.buenosaires.gob.ar).
+No runtime dependencies beyond the standard library.
+
+## Development
+
+```
+bundle install
+bundle exec rake test     # records VCR cassettes into test/fixtures on first run
+bundle exec swarf lib/    # complexity vs. coverage report, worst first
+```
+
+Cassettes are gitignored, so the first test run hits the live API.
+The API rejects curl's default User-Agent, but Ruby's Net::HTTP works fine.
+
+## Releasing
+
+1. Make sure `main` is clean and pushed, and `bundle exec rake test` passes.
+2. Bump `Epok::VERSION` in `lib/epok/version.rb`. Follow semver:
+   patch for fixes, minor for new behaviour, major for breaking changes.
+3. Commit it as `Bump version to X.Y.Z`.
+4. Run `bundle exec rake release`. This builds the gem, creates and pushes
+   the `vX.Y.Z` tag, and pushes the gem to rubygems.org. It needs rubygems
+   credentials (`gem signin`) and may prompt for an OTP if the account has
+   MFA enabled. If it prompts, the user has to run it themselves.
+5. Create a GitHub release from the tag with a short summary of what changed:
+   `gh release create vX.Y.Z --generate-notes`.
+
+Version numbers on rubygems.org cannot be reused, so check the diff before
+running step 4.

data/Gemfile

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
+
+gem "swarf", group: :development

data/Gemfile.lock

@@ -1,47 +1,67 @@
 PATH
   remote: .
   specs:
-    epok (0.1.0)
+    epok (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ansi (1.5.0)
-    builder (3.2.3)
-    byebug (11.0.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    hashdiff (0.3.9)
-    minitest (5.11.3)
-    minitest-reporters (1.3.6)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ansi (1.6.0)
+    bigdecimal (4.1.3)
+    builder (3.3.0)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    hashdiff (1.2.1)
+    minitest (5.27.0)
+    minitest-reporters (1.8.0)
       ansi
       builder
-      minitest (>= 5.0)
+      minitest (>= 5.0, < 7)
       ruby-progressbar
-    public_suffix (3.0.3)
-    rake (10.5.0)
-    ruby-progressbar (1.10.0)
-    safe_yaml (1.0.5)
-    vcr (4.0.0)
-    webmock (3.5.1)
-      addressable (>= 2.3.6)
+    public_suffix (7.0.5)
+    rake (13.4.2)
+    rexml (3.4.4)
+    ruby-progressbar (1.13.0)
+    swarf (0.2.0)
+    vcr (6.4.0)
+    webmock (3.26.4)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  byebug
   epok!
   minitest (~> 5.0)
   minitest-reporters (~> 1.3, >= 1.3.6)
-  rake (~> 10.0)
-  vcr (~> 4.0)
+  rake (~> 13.0)
+  swarf
+  vcr (~> 6.0)
   webmock (~> 3.5, >= 3.5.1)
 
+CHECKSUMS
+  addressable (2.9.0) sha256=7fdf6ac3660f7f4e867a0838be3f6cf722ace541dd97767fa42bc6cfa980c7af
+  ansi (1.6.0) sha256=ac9ea0c0ea8d32fb4e271348e609963ac78882f34b73836c2a02b3622e666658
+  bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66
+  builder (3.3.0) sha256=497918d2f9dca528fdca4b88d84e4ef4387256d984b8154e9d5d3fe5a9c8835f
+  crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
+  epok (0.2.0)
+  hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1
+  minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
+  minitest-reporters (1.8.0) sha256=8ce5280fb73ad3178ae525454df169b6f28c1b38b1d088ea91815d3a370ba384
+  public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  swarf (0.2.0) sha256=b4306a244fe4b096cfe263e452e666156856eac2467ae5d770639ef11388b375
+  vcr (6.4.0) sha256=077ac92cc16efc5904eb90492a18153b5e6ca5398046d8a249a7c96a9ea24ae6
+  webmock (3.26.4) sha256=8d8da206d217ebe6968cfb09c77f4533c23074e1432bad865f3994eacbaad50d
+
 BUNDLED WITH
-   1.17.2
+  4.0.20

data/README.md

@@ -1,15 +1,13 @@
 # Epok
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/epok`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+GCBA EPOk wrapper to query indexed geographic objects.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'epok'
+gem "epok"
 ```
 
 And then execute:
@@ -22,7 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+>> obelisco = Epok::Location.new(x: -58.381570, y: -34.603738)
+=> #<struct Epok::Location x=-58.38157, y=-34.603738>
+
+>> pharmacies_around_obelisco = Epok.geocoder(obelisco, "farmacias")
+=> #<Epok::Geocoder:0x00007f8719ab4f08 @x=-58.38157, @y=-34.603738, @categories="farmacias">
+
+>> pharmacies_around_obelisco.first.content
+=> {"Nombre"=>"Farmacia en PELLEGRINI, CARLOS 765", "Teléfono"=>"43223198 43220298"}
+
+>> cgp = Epok.search("cgp")
+=> #<Epok::Search:0x00007f871a09ac60 @query="cgp">
+
+>> sede_4 = cgp.first
+=> #<Epok::Object:0x00007f8719b36788 @id="sedes_de_comunas|4">
+
+>> sede_4.name
+=> "Sede Comunal 4"
+
+>> sede_4.content
+=> {"Nombre"=>"Sede Comunal 4", "Dirección"=>"BARCO CENTENERA del 2906", "Teléfonos"=>"4918-2243/1815/8920-4949 9024 Int. 105", "Trámites y Servicios"=>"<a href=\"http://www.buenosaires.gob.ar/comuna-4/sede-comunal-4\" target=\"_blank\">link</a>"}
+```
 
 ## Development
 
@@ -40,4 +59,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Epok project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arzezak/epok/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Epok project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arzezak/epok/blob/main/CODE_OF_CONDUCT.md).

data/epok.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files`.split("\n")
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "webmock", "~> 3.5", ">= 3.5.1"
 end

data/lib/epok/api.rb

@@ -3,22 +3,25 @@ require "json"
 
 module Epok
   class API
-    BASE_URL = "epok.buenosaires.gob.ar"
+    BASE_URL = "https://epok.buenosaires.gob.ar".freeze
 
     def self.object(id)
-      response = Net::HTTP.get_response(BASE_URL, "/getObjectContent/?id=#{id}")
-      JSON.parse(response.body)
+      JSON.parse(get("/getObjectContent/?id=#{id}"))
     end
 
     def self.search(query)
-      response = Net::HTTP.get_response(BASE_URL, "/buscar/?texto=#{query}")
-      JSON.parse(response.body)["instancias"]
+      JSON.parse(get("/buscar/?texto=#{query}"))["instancias"]
     end
 
     def self.geocoder(x, y, categories)
-      response = Net::HTTP.get_response(BASE_URL,
-        "/reverseGeocoderLugares/?x=#{x}&y=#{y}&categorias=#{categories}&radio=500")
-      JSON.parse(response.body)["instancias"]
+      JSON.parse(get(
+        "/reverseGeocoderLugares/?x=#{x}&y=#{y}&categorias=#{categories}&radio=500"
+      ))["instancias"]
     end
+
+    def self.get(path)
+      Net::HTTP.get_response(URI("#{BASE_URL}#{path}")).body
+    end
+    private_class_method :get
   end
 end

data/lib/epok/object.rb

@@ -17,6 +17,7 @@ module Epok
     def content
       object["contenido"].each_with_object({}) do |entry, hash|
         name, value = entry.values_at("nombre", "valor")
+        value = value.strip
         hash[name] = value unless value.empty?
       end
     end
@@ -24,7 +25,7 @@ module Epok
     private
 
     def object
-      API.object(id)
+      @object ||= API.object(id)
     end
   end
 end

data/lib/epok/version.rb

@@ -1,3 +1,3 @@
 module Epok
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/epok/object_test.rb

@@ -11,22 +11,26 @@ module Epok
     end
 
     def test_that_an_object_has_a_name
-      assert_equal "Calesita del Parque Saavedra", object.name
+      assert_equal "BIBLIOTECA ANMAT", object.name
     end
 
     def test_that_an_object_has_a_normalized_address
-      assert_equal "GARCIA DEL RIO y CONDE", object.normalized_address
+      assert_equal "DE MAYO AV. 869", object.normalized_address
     end
 
     def test_that_an_object_has_content
       expected_content = {
-        "Nombre" => "Calesita del Parque Saavedra",
-        "Dirección" => "GARCIA DEL RIO y CONDE (CP 1430) - Saavedra - Comuna 12",
-        "Actividad Principal" => "Calesita",
-        "Días y Horarios" => "Todos los días de 10:00 a 12:00 y de 14:00 a 19:30.",
-        "Observaciones" => "Los días de lluvia la calesita se encuentra cerrada.",
-        "Sector" => "Privado",
-        "Público" => "Niños"
+        "Nombre" => "BIBLIOTECA ANMAT",
+        "Categoria" => "BIBLIOTECA",
+        "Subcategoria" => "ESPECIALIZADA GUBERNAMENTAL",
+        "Teléfonos" => "54.011 4340-0800 INT. 1047 FAX 54.011 4340-0800 INT. 1048",
+        "E-Mail" => "<a href=\"mailto:NDURAND@ANMAT.GOV.AR\">NDURAND@ANMAT.GOV.AR</a>",
+        "Página WEB" => "<a href=\"http://WWW.ANMAT.GOV.AR\" target=\"_blank\">WWW.ANMAT.GOV.AR</a>",
+        "Dependencia" => "ADMINISTRACION NACIONAL DE MEDICAMENTOS Y TECNOLOGIA MEDICA ANMAT",
+        "Sector" => "PUBLICO",
+        "Dirección" => "DE MAYO AV. 869",
+        "Barrio" => "MONSERRAT",
+        "Comuna" => "Comuna 1"
       }
 
       assert_equal expected_content, object.content

data/test/epok_test.rb

@@ -1,15 +1,20 @@
 require "test_helper"
 
 class EpokTest < Minitest::Test
-  def test_that_it_has_a_version_number
-    refute_nil Epok::VERSION
-  end
+  def test_that_search_builds_a_search
+    search = Epok.search("garicoits")
 
-  def test_responds_to_search
-    assert_respond_to Epok, :search
+    assert_instance_of Epok::Search, search
+    assert_equal "garicoits", search.query
   end
 
-  def test_responds_to_geocoder
-    assert_respond_to Epok, :geocoder
+  def test_that_geocoder_builds_a_geocoder
+    obelisco = Epok::Location.new(x: -58.381570, y: -34.603738)
+    geocoder = Epok.geocoder(obelisco, "farmacias")
+
+    assert_instance_of Epok::Geocoder, geocoder
+    assert_equal(-58.381570, geocoder.x)
+    assert_equal(-34.603738, geocoder.y)
+    assert_equal "farmacias", geocoder.categories
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+require "swarf/probe"
+
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
 require "epok"

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epok
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ariel Rzezak
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -64,28 +49,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +98,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/skills/swarf/SKILL.md"
 - ".gitignore"
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -140,7 +127,6 @@ homepage: https://github.com/arzezak/epok
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: GCBA EPOk wrapper.
 test_files: []