attractor-swift 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783075f65d0b5fc72db27fbe146c75e4f08197743f0ac13d96f2c6cc11a53c44
+  data.tar.gz: d79761047aab01a58eff2bb89aab868b589affeb8abe9ad0dfbf01e0ca943b71
+SHA512:
+  metadata.gz: f95d230978f00d012ff0d71545c3cfddfc1934a79ebe4bc334a56cb5a89840823ea815741b2134c029c6ace693d419a2d632776831455e7eec34a9fb0bd9af3f
+  data.tar.gz: 98064df8b81e17c7ffd1778cc781d83ea1257d7cabfa58945e247d3eb6416c0fed556d25ca4c7dcf187d0d86d08862951bc5e63fe5c3041a0fc62025b2b33ef0

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+.rspec_status
+Gemfile.lock
+*~

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## RELEASE 0.1.0
+
+* Initial release: Swift calculator on `Attractor::LizardCalculator` (attractor >= 2.8), detector for `Package.swift`, Xcode projects and bare `.swift` trees.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+# Develop against an unreleased attractor: ATTRACTOR_PATH=../attractor bundle install
+gem "attractor", path: ENV["ATTRACTOR_PATH"] if ENV["ATTRACTOR_PATH"]

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Julian Rubisch
+
+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,84 @@
+# attractor-swift
+
+Swift plugin for [attractor](https://github.com/julianrubisch/attractor), the churn vs. complexity
+tool. Complexity is the per-function cyclomatic complexity reported by
+[lizard](https://github.com/terryyin/lizard); churn comes from attractor's git history.
+
+## Installation
+
+```bash
+gem install attractor attractor-swift
+```
+
+lizard is a Python tool. attractor runs it through [uv](https://docs.astral.sh/uv/) when
+`lizard` itself is not on your PATH:
+
+```bash
+# one of
+brew install uv          # then `uvx lizard` fetches lizard on first use
+pip install lizard
+```
+
+attractor finds the plugin by its gem name; nothing to configure.
+
+## Usage
+
+```bash
+cd my-swift-project
+attractor calc -c 0 --format table              # every file, table
+attractor calc --format json                    # per-function details with line ranges
+attractor diff --base main --head HEAD -c 0     # complexity delta of a branch
+attractor report                                # the interactive chart
+```
+
+Method-level `details` carry lizard's CCN and location:
+
+```json
+"details": {
+  "total": {"score": 3, "line": 6, "end_line": 15},
+  "pay":   {"score": 3, "line": 24, "end_line": 30}
+}
+```
+
+Two things to know about the numbers:
+
+- CCN is McCabe cyclomatic complexity, a different scale from flog's Ruby score. attractor
+  reports per language, so they are never compared.
+- lizard names functions without their type (`total`, not `Cart.total`). Two functions with
+  the same name in one file are kept apart by their start line (`card@32`, `card@50`).
+
+Force a specific runner with `ATTRACTOR_LIZARD="python -m lizard"`.
+
+## Using this repository as a template for another language
+
+Everything language-specific is two strings and a detector. To make `attractor-kotlin`:
+
+1. Copy this repository. Rename `swift` → `kotlin` in file names, module names, the gemspec and
+   the workflow.
+2. `lib/attractor/calculators/kotlin_calculator.rb`: `language: "kotlin"` (a name from
+   `lizard --help`, under `-l`), `file_extension: "kt"` (a regex-ish string is fine:
+   `"(kt|kts)"`), `@type = "Kotlin"`.
+3. `lib/attractor/detectors/kotlin_detector.rb`: what marks a project (`build.gradle.kts`,
+   any `*.kt`).
+4. Replace the fixture in `spec/fixtures/` and the expected numbers in the calculator spec;
+   run `uvx lizard -l kotlin --csv spec/fixtures/...` once to get them.
+5. Push, tag, `rake release`.
+
+Languages lizard scores today include C/C++, C#, Go, Java, JavaScript, Kotlin, Lua, Objective-C,
+PHP, Python, Rust, Scala, Swift, TypeScript and more. For languages with a better native
+metric tool (Ruby has flog, JavaScript has escomplex with class and import context), write
+the calculator against that tool instead, as attractor-ruby and attractor-javascript do.
+
+## Development
+
+```bash
+bin/setup
+bundle exec rspec        # the lizard integration example skips without lizard or uv
+bundle exec standardrb
+```
+
+Against an unreleased attractor: `ATTRACTOR_PATH=../attractor bundle install`.
+
+## License
+
+MIT.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/attractor-swift.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "attractor/swift/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "attractor-swift"
+  spec.version = Attractor::Swift::VERSION
+  spec.authors = ["Julian Rubisch"]
+  spec.email = ["julian@julianrubisch.at"]
+
+  spec.summary = "Attractor plugin for Swift: churn vs. cyclomatic complexity via lizard"
+  spec.description = <<-DESCRIPTION
+    Attractor plugin for the Swift programming language. Scores files with lizard's
+    per-function cyclomatic complexity and attractor's git churn.
+  DESCRIPTION
+  spec.homepage = "https://github.com/julianrubisch/attractor-swift"
+  spec.licenses = ["MIT"]
+  spec.required_ruby_version = ">= 3.3"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(spec|\.github)/}) || %w[.rspec .rspec_status .standard.yml .tool-versions].include?(f)
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "attractor", ">= 2.8"
+
+  spec.add_development_dependency "bundler", ">= 2.7"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attractor/swift"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bundle install
+command -v uvx >/dev/null || echo "uv is not installed; lizard will not run. See https://docs.astral.sh/uv/"

data/lib/attractor/calculators/swift_calculator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Attractor
+  # Everything language-specific is these two strings; the scoring lives in
+  # Attractor::LizardCalculator (attractor >= 2.8).
+  class SwiftCalculator < LizardCalculator
+    def initialize(**options)
+      super(language: "swift", file_extension: "swift", **options)
+      @type = "Swift"
+    end
+  end
+end

data/lib/attractor/detectors/swift_detector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Attractor
+  class SwiftDetector < BaseDetector
+    # A package manifest or an Xcode project is the cheap signal; a bare directory of .swift
+    # files (a script, a playground export) still counts, hence the glob fallback.
+    def detect
+      root = Dir.pwd
+      File.exist?(File.join(root, "Package.swift")) ||
+        Dir.glob(File.join(root, "*.{xcodeproj,xcworkspace}")).any? ||
+        Dir.glob(File.join(root, "**", "*.swift")).any?
+    end
+  end
+end

data/lib/attractor/swift/version.rb

@@ -0,0 +1,5 @@
+module Attractor
+  module Swift
+    VERSION = "0.1.0"
+  end
+end

data/lib/attractor/swift.rb

@@ -0,0 +1,16 @@
+require "attractor/swift/version"
+
+require "attractor"
+require "attractor/registry_entry"
+require "attractor/calculators/lizard_calculator"
+require "attractor/calculators/swift_calculator"
+require "attractor/detectors/base_detector"
+require "attractor/detectors/swift_detector"
+
+module Attractor
+  module Swift
+    class Error < StandardError; end
+
+    Attractor.register(Attractor::RegistryEntry.new(type: "swift", detector_class: SwiftDetector, calculator_class: SwiftCalculator))
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: attractor-swift
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Rubisch
+bindir: bin
+cert_chain: []
+date: 2026-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: attractor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Attractor plugin for the Swift programming language. Scores files with lizard's
+      per-function cyclomatic complexity and attractor's git churn.
+email:
+- julian@julianrubisch.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- attractor-swift.gemspec
+- bin/console
+- bin/setup
+- lib/attractor/calculators/swift_calculator.rb
+- lib/attractor/detectors/swift_detector.rb
+- lib/attractor/swift.rb
+- lib/attractor/swift/version.rb
+homepage: https://github.com/julianrubisch/attractor-swift
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/julianrubisch/attractor-swift
+  source_code_uri: https://github.com/julianrubisch/attractor-swift
+  bug_tracker_uri: https://github.com/julianrubisch/attractor-swift/issues
+  changelog_uri: https://github.com/julianrubisch/attractor-swift/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: 'Attractor plugin for Swift: churn vs. cyclomatic complexity via lizard'
+test_files: []