micromicro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae75d6afb6f7d98bc3a2fc12333ccbd31824e1cecd8336057e551fe6b392a643
+  data.tar.gz: 877da43669217907635d71015ec574ebc656e8755c8f6267229cebde36f281b0
+SHA512:
+  metadata.gz: a4b5a68c2d343fe0935d2103016aacf0b94d7a7c391d3ea360160a25fcb01bc16b7c70ae715e12b17142cedb928bea782b8057db5002df3e9ece2a99fdf1558c
+  data.tar.gz: 16a62f01b013d56547cebcac3001ecf59b77b3c14653f473a833d66589c6be31b5c53c2e6c547e0ce5c65f3dafb18feeb94be30ae0f57c65a96def024d6afccb

data/.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: https://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+indent_style = tab

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "microformats_test_suite"]
+	path = spec/support/fixtures/microformats_test_suite
+	url = https://github.com/jgarber623/microformats-test-suite

data/.reek.yml

@@ -0,0 +1,8 @@
+detectors:
+  DuplicateMethodCall:
+    max_calls: 3
+  IrresponsibleModule:
+    enabled: false
+
+exclude_paths:
+  - vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--order random
+--require spec_helper

data/.rubocop

@@ -0,0 +1,3 @@
+--display-style-guide
+--extra-details
+--parallel

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/.simplecov

@@ -0,0 +1,11 @@
+require 'simplecov-console'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+
+if RSpec.configuration.files_to_run.length > 1
+  formatters << SimpleCov::Formatter::Console
+end
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
+end

data/.travis.yml

@@ -0,0 +1,19 @@
+dist: bionic
+language: ruby
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+cache:
+  - bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  email: false
+  slack:
+    rooms:
+      secure: JmMccxJmz97LtzKLPd+Hp1MeRUKL8kscN2A2CPyEyRJC7u/U+41SHtXkojR4OpQDoCsP3MexhqoJ/Fu1eLDxZ3e1B7PFrwKCfSQc8YZhLYfE0B9Tfy4M+LBQkgoLwsUHP2Vxyho0iZ1knL+070EJQlEpTox+9N8eTfOX6SOpiNLDHTRd4217yI7faog790OYGKTbOCRj5fo+kPAeN8NrEZavjx6QeWBcJ/wRv6O2V6dhrnqOho2ktSj14/yeNsVoYc4Ondk5Hy/zSCPRjvqFO9wI2mC6l7u9W0ffy09trvkXTTmPQeCbzFKgybHSKpmxCE6frFOSkO+aBVGJ/p4hxej5001nzZrCfZF3MBEKQwAFHBLX6hIIbCOZmR915vl+8NGPkCy4o8W/BlRWKtVWIbDCk8sxf+WbIHLkSsfBBGHmABxQXvDS3ejKh+Rm35ejdrak2jWg/cxYHBbZDHBNPjLHbYzfziMSlNgbQ3V9fVfpNC1AI7jXNSgOsuX6Uv5dvTk40Wa4xEiNOkEtLMn55exnrxoJ+B68aZPvA/71/rvHKPyjgBNxu7Zb+5mrVHja+DNTdotomWdzfmILn2CV1xvfhQAFmph4lagiRHqpLXATJ6N0907tNILJUzbvMPONVbcyQlx1UHnbiezagjQ+dwoOyjof184M8jECba7zXzs=

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 / 2020-05-06
+
+- Initial release!

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to MicroMicro
+
+There are a couple ways you can help improve MicroMicro:
+
+1. Fix an existing [issue][issues] and submit a [pull request][pulls].
+1. Review open [pull requests][pulls].
+1. Report a new [issue][issues]. _Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue._
+
+## Getting Started
+
+MicroMicro is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/micromicro).
+
+Before making changes to MicroMicro, you'll want to install Ruby 2.5.8. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.5.8 using your method of choice, install the project's gems by running:
+
+```sh
+bundle install
+```
+
+## Making Changes
+
+1. Fork and clone the project's repo.
+1. Install development dependencies as outlined above.
+1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
+1. _Write some code!_
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
+1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
+1. Push the branch to your fork: `git push -u origin my-new-feature`.
+1. Create a new [pull request][pulls] and we'll review your changes.
+
+## Code Style
+
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended you install the EditorConfig plugin for your editor of choice.
+
+Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
+
+[issues]: https://github.com/jgarber623/micromicro/issues
+[pulls]: https://github.com/jgarber623/micromicro/pulls

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in micromicro.gemspec
+gemspec
+
+gem 'pry-byebug', '~> 3.9'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.82.0'
+gem 'rubocop-performance', '~> 1.5'
+gem 'rubocop-rspec', '~> 1.38'
+gem 'simplecov', '~> 0.18.5'
+gem 'simplecov-console', '~> 0.7.2'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019–present Jason Garber
+
+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,122 @@
+# MicroMicro
+
+**A Ruby gem for extracting [microformats2](http://microformats.org/wiki/microformats2)-encoded data from HTML documents.**
+
+[![Build](https://img.shields.io/travis/com/jgarber623/micromicro/master.svg?style=for-the-badge)](https://travis-ci.com/jgarber623/micromicro)
+[![Dependencies](https://img.shields.io/depfu/jgarber623/micromicro.svg?style=for-the-badge)](https://depfu.com/github/jgarber623/micromicro)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/micromicro.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/micromicro)
+[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/micromicro.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/micromicro/code)
+
+## Key Features
+
+- Parses microformats2-encoded HTML documents according to the [microformats2 parsing specification](http://microformats.org/wiki/microformats2-parsing)
+- Passes all microformats2 tests from [the official test suite](https://github.com/microformats/tests)¹
+- Supports Ruby 2.5 and newer
+
+**Note:** MicroMicro **does not** parse [Classic Microformats](http://microformats.org/wiki/Main_Page#Classic_Microformats) (referred to in [the parsing specification](http://microformats.org/wiki/microformats2-parsing#note_backward_compatibility_details) as "backcompat root classes" and "backcompat properties"). If parsing documents marked up in this fashion, consider using [the official microformats-ruby parser](https://github.com/microformats/microformats-ruby).
+
+<small>¹ …with some exceptions until [this pull request](https://github.com/microformats/tests/pull/112) is merged.</small>
+
+## Getting Started
+
+Before installing and using MicroMicro, you'll want to have [Ruby](https://www.ruby-lang.org) 2.5 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
+
+MicroMicro is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/micromicro).
+
+## Installation
+
+If you're using [Bundler](https://bundler.io), add MicroMicro to your project's `Gemfile`:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'micromicro'
+```
+
+…and hop over to your command prompt and run…
+
+```sh
+$ bundle install
+```
+
+## Usage
+
+### Basic Usage
+
+MicroMicro's `parse` method accepts two arguments: a `String` of markup and a `String` representing the URL associated with that markup.
+
+The markup (typically HTML) can be retrieved from the Web using a library of your choosing or provided inline as a simple `String` (e.g. `<div class="h-card">Jason Garber</div>`) The URL provided is used to resolve relative URLs in accordance with the document's language rules.
+
+An example using a simple `String` of HTML as input:
+
+```ruby
+require 'micromicro'
+
+doc = MicroMicro.parse('<div class="h-card">Jason Garber</div>', 'https://sixtwothree.org')
+#=> #<MicroMicro::Document items: #<MicroMicro::Collections::ItemsCollection count: 1, members: [#<MicroMicro::Item types: ["h-card"], properties: 1, children: 0>]>, relations: #<MicroMicro::Collections::RelationsCollection count: 0, members: []>>
+
+doc.to_h
+#=> { :items => [{ :type => ["h-card"], :properties => { :name => ["Jason Garber"] } }], :rels => {}, :"rel-urls" => {} }
+```
+
+The `Hash` produced by calling `doc.to_h` may be converted to JSON (e.g. `doc.to_h.to_json`) for storage, additional manipulation, or use with other tools.
+
+Another example pulling the source HTML from [Tantek](https://tantek.com)'s website:
+
+```ruby
+require "net/http"
+require "micromicro"
+
+url = "https://tantek.com"
+rsp = Net::HTTP.get(URI.parse(url))
+
+doc = MicroMicro.parse(rsp, url)
+#=> #<MicroMicro::Document items: #<MicroMicro::Collections::ItemsCollection count: 1, members: […]>, relations: #<MicroMicro::Collections::RelationsCollection count: 31, members: […]>>
+
+doc.to_h
+#=> { :items => [{ :type => ["h-card"], :properties => {…}, :children => […]}], :rels => {…}, :'rel-urls' => {…} }
+```
+
+### Advanced Usage
+
+Building on the example above, a MicroMicro-parsed document is navigable and manipulable using a familiar `Enumerable`-esque interface.
+
+```ruby
+doc.items.first
+#=> #<MicroMicro::Item types: ["h-card"], properties: 42, children: 6>
+
+doc.items.first.properties
+#=> #<MicroMicro::Collections::PropertiesCollection count: 42, members: […]>
+
+doc.items.first.properties[7]
+#=> #<MicroMicro::Property name: "category", prefix: "p", value: "teacher">
+
+doc.items.first.properties.take(5).map { |property| [property.name, property.value] }
+#=> [["photo", { :value => "https://tantek.com/photo.jpg", :alt => "" }], ["url", "https://tantek.com/"], ["uid", "https://tantek.com/"], ["name", "Tantek Çelik"], ["role", "Inventor, writer, teacher, runner, coder, more."]]
+
+doc.items.first.children
+#=> #<MicroMicro::Collections::ItemsCollection count: 6, members: […]>
+
+doc.relations.first
+#=> #<MicroMicro::Relation href: "https://tantek.com/", rels: ["canonical"]>
+
+doc.relations.map(&:rels).flatten.uniq.sort
+#=> ["alternate", "apple-touch-icon-precomposed", "author", "authorization_endpoint", "bookmark", "canonical", "hub", "icon", "me", "microsub", …]
+
+doc.relations.find { |relation| relation.rels.include?('webmention') }
+# => #<MicroMicro::Relation href: "https://webmention.io/tantek.com/webmention", rels: ["webmention"]>
+```
+
+## Contributing
+
+Interested in helping improve MicroMicro? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/micromicro/blob/master/CONTRIBUTING.md) for details.
+
+## Acknowledgments
+
+MicroMicro wouldn't exist without the hard work of everyone involved in the [microformats](http://microformats.org) community. Additionally, the comprehensive [microformats test suite](https://github.com/microformats/tests) was invaluable in the development of this Ruby gem.
+
+MicroMicro is written and maintained by [Jason Garber](https://sixtwothree.org).
+
+## License
+
+MicroMicro is freely available under the [MIT License](https://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+
+require 'reek/rake/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = false
+  task.source_files  = FileList['**/*.rb'].exclude('vendor/**/*.rb')
+end
+
+RSpec::Core::RakeTask.new
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
+
+task default: [:rubocop, :reek, :spec]

data/lib/micro_micro/collections/base_collection.rb

@@ -0,0 +1,37 @@
+module MicroMicro
+  module Collections
+    class BaseCollection
+      include Enumerable
+
+      delegate :[], :each, :last, :length, :split, to: :members
+
+      # @param members [Array<MicroMicro::Item, MicroMicro::Property, MicroMicro::Relation>]
+      def initialize(members = [])
+        @members = members
+
+        decorate_members if respond_to?(:decorate_members, true)
+      end
+
+      # @return [String]
+      def inspect
+        format(%(#<#{self.class.name}:%#0x count: #{count}, members: #{members.inspect}>), object_id)
+      end
+
+      # @param member [MicroMicro::Item, MicroMicro::Property, MicroMicro::Relation]
+      # @return [self]
+      def push(member)
+        members.push(member)
+
+        decorate_members if respond_to?(:decorate_members, true)
+
+        self
+      end
+
+      alias << push
+
+      private
+
+      attr_reader :members
+    end
+  end
+end

data/lib/micro_micro/collections/items_collection.rb

@@ -0,0 +1,10 @@
+module MicroMicro
+  module Collections
+    class ItemsCollection < BaseCollection
+      # @return [Array<Hash{Symbol => Array<String, Hash>}>]
+      def to_a
+        map(&:to_h)
+      end
+    end
+  end
+end

data/lib/micro_micro/collections/properties_collection.rb

@@ -0,0 +1,18 @@
+module MicroMicro
+  module Collections
+    class PropertiesCollection < BaseCollection
+      # @return [Hash{Symbol => Array<String, Hash>}]
+      def to_h
+        group_by(&:name).symbolize_keys.deep_transform_values do |property|
+          property.item_node? ? property.value.to_h : property.value
+        end
+      end
+
+      private
+
+      def decorate_members
+        each { |member| member.collection = self }
+      end
+    end
+  end
+end

data/lib/micro_micro/collections/relations_collection.rb

@@ -0,0 +1,23 @@
+module MicroMicro
+  module Collections
+    class RelationsCollection < BaseCollection
+      # @see microformats2 Parsing Specification section 1.4
+      # @see http://microformats.org/wiki/microformats2-parsing#parse_a_hyperlink_element_for_rel_microformats
+      #
+      # @return [Hash{Symbole => Hash{Symbol => Array, String}}]
+      def group_by_url
+        group_by(&:href).symbolize_keys.transform_values { |relations| relations.first.to_h.slice!(:href) }
+      end
+
+      # @see microformats2 Parsing Specification section 1.4
+      # @see http://microformats.org/wiki/microformats2-parsing#parse_a_hyperlink_element_for_rel_microformats
+      #
+      # @return [Hash{Symbol => Array<String>}]
+      def group_by_rel
+        each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |member, hash|
+          member.rels.each { |rel| hash[rel] << member.href }
+        end.symbolize_keys.transform_values(&:uniq)
+      end
+    end
+  end
+end