spoom 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e66609da288328708122f32555a990ea5f4f72d311f9c40038df3a9b22759de
-  data.tar.gz: 782237d97b66b1a60d0fd83f931aecbba40d23869d178d0d9196ed4ab4f0a0c1
+  metadata.gz: 120fef71dbc1eb301d6425be852e9bd96554114865f5350c0bb5553fe16fbdaf
+  data.tar.gz: a50b10a8f28d7a96c9167ccf457116b61ef300f06d9dcce44801528355fc22cf
 SHA512:
-  metadata.gz: bda11074ba04efcede0f9cef4bfbb1d441dac8ac56ca2fcf5190dd174c59903b0ac53b8f9ab1166b14d9a3016128a1025fb68b6a449c5d763ecc7bc2778059c0
-  data.tar.gz: '0987432e65a6114e8b802892bd7602bc0bcf43dc2f1f9d3f920d79c003c2968d4f429f9e564d05721e5836505c3350d86205d04ad6b84d01c1882aa541736ff6'
+  metadata.gz: 4c306c8d3bbe04aa4874fc95d826989d226a5b20d3548048c0e485ae27678e32f79e63c0a7e98e3b743e116622a2161e75f04c0ca75214c1c78ece75977f6ce4
+  data.tar.gz: d5745d54bfc4caf3daf584231647dc299ce572888555304c8f4334aac495fec0d61457e60281a2c0e4992c4ef19d1b923e17151f006a4f436c7cddbf366b733c

data/README.md

@@ -1,8 +1,6 @@
 # Spoom
 
-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/spoom`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Useful tools for Sorbet enthusiasts.
 
 ## Installation
 
@@ -22,17 +20,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Parsing Sorbet config
+
+Parses a Sorbet config file:
+
+```ruby
+config = Spoom::Sorbet::Config.parse_file("sorbet/config")
+puts config.paths   # "."
+```
+
+Parses a Sorbet config string:
+
+```ruby
+config = Spoom::Sorbet::Config.parse_string(<<~CONFIG)
+  a
+  --file=b
+  --ignore=c
+CONFIG
+puts config.paths   # "a", "b"
+puts config.ignore  # "c"
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Don't forget to run `bin/sanity` before pushing your changes.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/spoom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/spoom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +57,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Spoom project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/spoom/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Spoom project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/spoom/blob/master/CODE_OF_CONDUCT.md).

data/lib/spoom.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "spoom/version"
+require "sorbet-runtime"
 
-module Spoom
-  class Error < StandardError; end
-end
+require "spoom/version"
+require "spoom/sorbet/config"

data/lib/spoom/sorbet/config.rb

@@ -0,0 +1,99 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module Sorbet
+    # Parse Sorbet config files
+    #
+    # Parses a Sorbet config file:
+    #
+    # ```ruby
+    # config = Spoom::Sorbet::Config.parse_file("sorbet/config")
+    # puts config.paths   # "."
+    # ```
+    #
+    # Parses a Sorbet config string:
+    #
+    # ```ruby
+    # config = Spoom::Sorbet::Config.parse_string(<<~CONFIG)
+    #   a
+    #   --file=b
+    #   --ignore=c
+    # CONFIG
+    # puts config.paths   # "a", "b"
+    # puts config.ignore  # "c"
+    # ```
+    class Config
+      extend T::Sig
+
+      sig { returns(T::Array[String]) }
+      attr_reader :paths, :ignore
+
+      sig { void }
+      def initialize
+        @paths = T.let([], T::Array[String])
+        @ignore = T.let([], T::Array[String])
+      end
+
+      class << self
+        extend T::Sig
+
+        sig { params(sorbet_config_path: String).returns(Spoom::Sorbet::Config) }
+        def parse_file(sorbet_config_path)
+          parse_string(File.read(sorbet_config_path))
+        end
+
+        sig { params(sorbet_config: String).returns(Spoom::Sorbet::Config) }
+        def parse_string(sorbet_config)
+          config = Config.new
+          ignore = T.let(false, T::Boolean)
+          skip = T.let(false, T::Boolean)
+          sorbet_config.each_line do |line|
+            line = line.strip
+            case line
+            when /^--ignore$/
+              ignore = true
+              next
+            when /^--ignore=/
+              config.ignore << parse_option(line)
+              next
+            when /^--file$/
+              next
+            when /^--file=/
+              config.paths << parse_option(line)
+              next
+            when /^--dir$/
+              next
+            when /^--dir=/
+              config.paths << parse_option(line)
+              next
+            when /^--.*=/
+              next
+            when /^--/
+              skip = true
+            when /^-.*=?/
+              next
+            else
+              if ignore
+                config.ignore << line
+                ignore = false
+              elsif skip
+                skip = false
+              else
+                config.paths << line
+              end
+            end
+          end
+          config
+        end
+
+        private
+
+        sig { params(line: String).returns(String) }
+        def parse_option(line)
+          T.must(line.split("=").last).strip
+        end
+      end
+    end
+  end
+end

data/lib/spoom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spoom
-  VERSION = "0.0.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexandre Terrasa
@@ -107,6 +107,7 @@ files:
 - Rakefile
 - exe/spoom
 - lib/spoom.rb
+- lib/spoom/sorbet/config.rb
 - lib/spoom/version.rb
 homepage: https://github.com/Shopify/spoom
 licenses: