metado 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7635052f7b0458d60892bf8857e87cf5ec2e610f89ab8e4fda525a7dd01642ff
+  data.tar.gz: 3d3352f0b937ce94ed6456eb108e337993e6f94c5116e815cdb5e8c6e190db99
+SHA512:
+  metadata.gz: b9573425f80f240937eae337707cf21cb0e688eccdb3ee14b23268a73cd689454448e2e87738d8fdeab563f4ad12dec4619d5389c841fc630f788320211cb6aa
+  data.tar.gz: ab019ca4c62dc76b5071b6fef9abce45743d025175d9416bbc2906fa846b195aa1ba6543a62d15643946fae7ab86231577821456a8bdb45669e05bf875a91083

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.10
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    metado (0.1.0)
+      tomlrb
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.0.2)
+      rubocop (= 1.11.0)
+      rubocop-performance (= 1.10.1)
+    tomlrb (2.0.1)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  metado!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.0.2)
+
+BUNDLED WITH
+   2.2.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Paul Samuels
+
+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,155 @@
+`Metado` is a tool for adding metadata to your TODOs.
+
+## Idea
+
+Add structure to TODOs to make it so that you can query them across a codebase.
+
+This tool proposes a simple markup and provides a command line tool to parse it into JSON.
+This leaves the user free to do whatever filtering they desire in their favourite language.
+
+## Syntax rules
+
+A metado is formed from consecutive single line comments and looks like this in a C based language:
+
+```
+// METADO: Remove this toggle before release
+//   | This feature toggle should be removed with the release of Feature X
+//   > fixVersion = "FeatureX"
+```
+
+- The first line denotes a metado with the token `METADO:` and the rest of the line acts as the metado's title.
+- Any subsequent lines starting with a pipe ("|") create a longer form description for the metado.
+- Any subsequent lines starting with a greater than operator (">") form the data portion of the metado and are parsed using TOML.
+
+Running the tool on this readme would result in this output:
+
+```
+➜ metado path/to/readme/dir | jq .
+[
+  {
+    "file": "path/to/readme/dir/README.md",
+    "line_number": 0,
+    "title": "Remove this toggle before release",
+    "body": "This feature toggle should be removed with the release of Feature X",
+    "data": {
+      "fixVersion": "FeatureX"
+    }
+  }
+]
+```
+
+## Example usage
+
+Given the following metados in our source code:
+
+```
+// METADO: Remove this toggle before release
+//   | This feature toggle should be removed with the release of Feature X
+//   > fixVersion = "FeatureX"
+
+// METADO: Spike implementation
+//   | This is really inefficient and could be simplified.
+//   > tags = ["performance", "spike"]
+
+// METADO: This could do with a cache
+//   > tags = ["performance"]
+//   > fixVersion = "FeatureX"
+```
+
+If we wanted to check we have no work left to do before releasing "FeatureX" we could run the following query:
+
+```
+➜ metado Sources | jq 'map(select(.data.fixVersion == "FeatureX"))'
+{
+  "file": "Example.swift",
+  "line_number": 27,
+  "title": "Remove this toggle before release",
+  "body": "This feature toggle should be removed with the release of Feature X",
+  "data": {
+    "fixVersion": "FeatureX"
+  }
+}
+{
+  "file": "Example.swift",
+  "line_number": 16,
+  "title": "This could do with a cache",
+  "body": "",
+  "data": {
+    "tags": [
+      "performance"
+    ],
+    "fixVersion": "FeatureX"
+  }
+}
+```
+
+If we wanted to find any metados that have been tagged as "performance" we could run the following query:
+
+```
+➜ metado Sources | jq 'map(select(.data.tags | index("performance")))'
+[
+  {
+    "file": "Example.swift",
+    "line_number": 12,
+    "title": "Spike implementation",
+    "body": "This is really inefficient and could be simplified.",
+    "data": {
+      "tags": [
+        "performance",
+        "spike"
+      ]
+    }
+  },
+  {
+    "file": "Example.swift",
+    "line_number": 16,
+    "title": "This could do with a cache",
+    "body": "",
+    "data": {
+      "tags": [
+        "performance"
+      ],
+      "fixVersion": "FeatureX"
+    }
+  }
+]
+```
+
+The key thing is that the metado tool outputs JSON so the filtering can be written in any language - the examples above use the `jq` command line tool.
+Once the data is filtered the results could be used to notify people, fail CI builds or whatever could be useful for your project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metado'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install metado
+
+## Usage
+
+```
+Usage: metado SOURCE_DIR
+```
+
+## 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.
+
+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 the created tag, 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/paulsamuels/metado.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "metado"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/metado

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "metado/cli"
+
+Metado::CLI.start

data/lib/metado.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "metado/version"
+
+module Metado
+  class Error < StandardError; end
+end

data/lib/metado/cli.rb

@@ -0,0 +1,23 @@
+require_relative "parser/file"
+require_relative "parser/metado"
+
+require "json"
+
+module Metado
+  class CLI
+    def self.start
+      unless (dir = ARGV.first)
+        puts "Usage: metado SOURCE_DIR"
+        exit 1
+      end
+
+      result = Dir["#{dir}/**/*"].flat_map do |file|
+        next unless File.file?(file)
+
+        Parser::File.comments(file).map(&Parser::Metado.method(:parse)).flatten.map(&:to_h)
+      end.compact
+
+      puts JSON.generate result
+    end
+  end
+end

data/lib/metado/parser/file.rb

@@ -0,0 +1,38 @@
+require_relative "../type/comment"
+
+module Metado
+  module Parser
+    module File
+      class << self
+        def comments file
+          regex = single_line_comment_regex(file)
+
+          ::File.readlines(file).each_with_index.reduce([[], nil]) { |(comments, current_comment), (line, index)|
+            if (line = line[regex, 1])
+              (current_comment ||= Type::Comment.new(file, index + 1, []).tap(&comments.method(:push))).body << line
+            else
+              current_comment = nil
+            end
+
+            [comments, current_comment]
+          }.first
+        end
+
+        private
+
+        def single_line_comment_regex file
+          sentinel = case ::File.extname file
+          when ".py", ".rb", ".sh"
+            "#"
+          when ".hs"
+            "--"
+          else
+            "//"
+          end
+
+          %r{^\s*#{sentinel}(.*)}
+        end
+      end
+    end
+  end
+end

data/lib/metado/parser/metado.rb

@@ -0,0 +1,30 @@
+require "tomlrb"
+require_relative "../type/node"
+
+module Metado
+  module Parser
+    module Metado
+      def self.parse comment
+        comment.body.each_with_index.reduce([[], nil]) { |(metados, current_metado), (line, index)|
+          if (title = line[/^\s*METADO:\s*(.*)/, 1])
+            current_metado = Type::Node.new(comment.file, comment.line_number + index, title, [], []).tap(&metados.method(:push))
+          elsif current_metado
+            if (body = line[/^\s*\|\s*(.*)/, 1])
+              current_metado.body << body
+            elsif (data = line[/^\s*>\s*(.*)/, 1])
+              current_metado.data << data
+            else
+              current_metado = nil
+            end
+          else
+            current_metado = nil
+          end
+
+          [metados, current_metado]
+        }.first.map { |item|
+          Type::Node.new(item.file, item.line_number, item.title, item.body.join("\n"), Tomlrb.parse(item.data.join("\n")))
+        }
+      end
+    end
+  end
+end

data/lib/metado/type/comment.rb

@@ -0,0 +1,5 @@
+module Metado
+  module Type
+    Comment = Struct.new(:file, :line_number, :body)
+  end
+end

data/lib/metado/type/node.rb

@@ -0,0 +1,5 @@
+module Metado
+  module Type
+    Node = Struct.new(:file, :line_number, :title, :body, :data)
+  end
+end

data/lib/metado/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Metado
+  VERSION = "0.1.0"
+end

data/metado.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/metado/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "metado"
+  spec.version = Metado::VERSION
+  spec.authors = ["Paul Samuels"]
+  spec.email = ["paulio1987@gmail.com"]
+
+  spec.summary = "Supercharge your todos with metadata"
+  spec.homepage = "https://github.com/paulsamuels/metado"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/paulsamuels/metado"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tomlrb"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "standard", "~> 1.0.2"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: metado
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Samuels
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomlrb
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description:
+email:
+- paulio1987@gmail.com
+executables:
+- metado
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/metado
+- lib/metado.rb
+- lib/metado/cli.rb
+- lib/metado/parser/file.rb
+- lib/metado/parser/metado.rb
+- lib/metado/type/comment.rb
+- lib/metado/type/node.rb
+- lib/metado/version.rb
+- metado.gemspec
+homepage: https://github.com/paulsamuels/metado
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/paulsamuels/metado
+  source_code_uri: https://github.com/paulsamuels/metado
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Supercharge your todos with metadata
+test_files: []