hoe-markdown 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cb9e4c8f53ee98f050766c035755003dbe76403b1625b0e90dfb00eccc7930a
+  data.tar.gz: 97069f8181dff7b9b32bf710a55f959788b7169830e5bf6918a721c2326b1c7e
+SHA512:
+  metadata.gz: 33ef8ee4cb89cdafc82cfea1f9dbb0ea94380ca6fe6350abca751b9a55ec7a0d257943b1dd6340d86d3d87089361a66f420cf1f612ac77e0e123fc67c5f32086
+  data.tar.gz: 5dcfe24d87131804e1b49f0cd1c91cdf3e804682feb31f8ddfa2a4c538542afe304dffb2ec9dabbec9d423a4abcf5782e3f6f617a76c9a1599ec421435266b3c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Hoe::Markdown CHANGELOG
+
+## v1.0.0 / 2020-06-07
+
+Released!

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mike.dalessio@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hoe-markdown.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Dalessio
+
+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,103 @@
+# Hoe::Markdown
+
+Hoe::Markdown is a [Hoe](https://www.zenspider.com/projects/hoe.html) plugin to help manage your project's markdown files. It's intended for gem maintainers, but the underlying library of markdown manipulation methods might be generally useful.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hoe-markdown'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hoe-markdown
+
+
+## Usage
+
+In your Rakefile:
+
+``` ruby
+Hoe::plugin :markdown
+```
+
+Rake tasks are exposed under the `markdown` namespace.
+
+
+### Choosing your markdown files correctly
+
+Hoe makes some outdated assumptions about the location of your README and your changelog files, which you (as a maintainer) need to opt out of. Specifically, you probably have something like this in your Rakefile
+
+```
+Hoe.spec "projectname" do
+  ...
+  self.history_file = "CHANGELOG.md"
+  self.readme_file = "README.md"
+  ...
+end
+```
+
+If you've got files named "CHANGELOG.md" and/or "README.md" then this plugin will do the right thing, and you won't need to specify this in your Rakefile.
+
+
+### Controlling what files are modified
+
+By default, any `.md` file that Hoe knows about (through `Manifest.txt` or other attributes) will be included.
+
+This can be overridden by setting the attribute named `markdown_linkify_files` which should be an array of file paths.
+
+
+### Rake Tasks
+
+An idempotent rake task `markdown:linkify` is created which will iterate through each of the markdown files in your project, and create hyperlinks for:
+
+* any github username [formatted like `@username`]
+* github issue mention [formatted like `#1234`]
+* github issue URI [which must match either the Hoe metadata URI for the bug tracker, or that same URI's equivalent pull request URI]
+
+So, for example, this text:
+
+```markdown
+# Changelog
+
+## v1.0.0
+
+Bugfix: Frobnicate the transmogrifier. #123
+Thanks, @hobbes!
+
+Feature: Finagle the sprocket. See https://github.com/cogswellcogs/sprocketkiller/issues/456
+```
+
+would be turned into:
+
+```markdown
+# Changelog
+
+## v1.0.0
+
+Bugfix: Frobnicate the transmogrifier. [#123](https://github.com/cogswellcogs/sprocketkiller/issues/123)
+Thanks, [@hobbes](https://github.com/hobbes)!
+
+Feature: Finagle the sprocket. See [#456](https://github.com/cogswellcogs/sprocketkiller/issues/456)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flavorjones/hoe-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/flavorjones/hoe-markdown/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). See [LICENSE.txt](https://github.com/flavorjones/hoe-markdown/blob/master/LICENSE.txt).
+
+
+## Code of Conduct
+
+Everyone interacting in the Hoe::Markdown project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/flavorjones/hoe-markdown/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hoe-markdown.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/hoe/markdown/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "hoe-markdown"
+  spec.version = Hoe::Markdown::VERSION
+  spec.authors = ["Mike Dalessio"]
+  spec.email = ["mike.dalessio@gmail.com"]
+
+  spec.summary = %q{Hoe plugin with helpers for markdown documentation files.}
+  spec.description = %q{Hoe plugin with markdown helpers, for example to hyperlink github issues and github usernames in markdown files.}
+  spec.homepage = "https://github.com/flavorjones/hoe-markdown"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # 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("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/lib/hoe/markdown.rb

@@ -0,0 +1,61 @@
+class Hoe
+  module Markdown
+    #
+    #  Optional: used to specify which markdown files to linkify. [default: any markdown files found in `files`].
+    #
+    attr_accessor :markdown_linkify_files
+
+    def default_markdown_linkify_files
+      spec.files.grep(/\.md$/)
+    end
+
+    def initialize_markdown
+      @markdown_linkify_files = nil
+
+      if File.exist?("CHANGELOG.md")
+        self.history_file = "CHANGELOG.md"
+      end
+
+      if File.exist?("README.md")
+        self.readme_file = "README.md"
+      end
+    end
+
+    def define_markdown_tasks
+      @markdown_linkify_files ||= default_markdown_linkify_files
+      return if markdown_linkify_files.empty?
+
+      namespace_name = "markdown:linkify"
+      linkify_tasks = []
+
+      namespace namespace_name do
+        markdown_linkify_files.each do |mdfile_path|
+          mdfile_name = File.basename(mdfile_path)
+          task_name = mdfile_name.downcase.split(".")[0..-2].join(".")
+
+          desc "hyperlink github issues and usernames in #{mdfile_name}"
+          task task_name do
+            puts "linkifying #{mdfile_path} ..."
+            markdown = File.read(mdfile_path)
+
+            markdown = Hoe::Markdown::Util.linkify_github_usernames(markdown)
+            if spec.metadata["bug_tracker_uri"]
+              markdown = Hoe::Markdown::Util.linkify_github_issues(markdown, spec.metadata["bug_tracker_uri"])
+            else
+              warn "Spec metadata URI for 'bugs' is missing, skipping linkification of issues and pull requests"
+            end
+
+            File.open(mdfile_path, "w") { |f| f.write markdown }
+          end
+          linkify_tasks << "#{namespace_name}:#{task_name}"
+        end
+      end
+
+      desc "hyperlink github issues and usernames in markdown files"
+      task namespace_name => linkify_tasks
+    end
+  end
+end
+
+require "hoe/markdown/version"
+require "hoe/markdown/util"

data/lib/hoe/markdown/util.rb

@@ -0,0 +1,64 @@
+class Hoe
+  module Markdown
+    module Util
+      GITHUB_ISSUE_MENTION_REGEX = %r{
+        # issue number, like '#1234'
+        \#([[:digit:]]+)
+
+        # not already in a markdown hyperlink
+        (?!\][\(\[])
+
+        # don't truncate the issue number to meet the previous negative lookahead
+        (?![[[:digit:]]])
+      }x
+
+      # see https://github.com/shinnn/github-username-regex
+      GITHUB_USER_REGEX = %r{
+        # username, like "@flavorjones"
+        @([[:alnum:]](?:[[:alnum:]]|-(?=[[:alnum:]])){0,38})
+
+        # not already in a markdown hyperlink
+        (?!\][\(\[])
+
+        # don't truncate the username to meet the previous negative lookahead
+        (?![[[:alnum:]]])
+      }x
+
+      def self.linkify_github_issues(markdown, issues_uri)
+        if issues_uri.nil? || issues_uri.empty?
+          raise "#{__FILE__}:#{__method__}: URI for bugs cannot be empty\n"
+        end
+
+        issue_uri_regex = %r{
+          # not already in a markdown hyperlink
+          (?<!\]\()
+
+          #{issues_uri}/([[:digit:]]+)
+
+          # don't truncate the issue number to meet the previous negative lookahead
+          (?![[[:digit:]]])
+        }x
+
+        pull_uri = issues_uri.gsub("issues", "pull")
+        pull_uri_regex = %r{
+          # not already in a markdown hyperlink
+          (?<!\]\()
+
+          #{pull_uri}/([[:digit:]]+)
+
+          # don't truncate the issue number to meet the previous negative lookahead
+          (?![[[:digit:]]])
+        }x
+
+        markdown
+          .gsub(GITHUB_ISSUE_MENTION_REGEX, "[#\\1](#{issues_uri}/\\1)")
+          .gsub(issue_uri_regex, "[#\\1](#{issues_uri}/\\1)")
+          .gsub(pull_uri_regex, "[#\\1](#{pull_uri}/\\1)")
+      end
+
+      def self.linkify_github_usernames(markdown)
+        markdown.gsub(GITHUB_USER_REGEX, "[@\\1](https://github.com/\\1)")
+      end
+    end
+  end
+end

data/lib/hoe/markdown/version.rb

@@ -0,0 +1,5 @@
+class Hoe
+  module Markdown
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: hoe-markdown
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Dalessio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-07 00:00:00.000000000 Z
+dependencies: []
+description: Hoe plugin with markdown helpers, for example to hyperlink github issues
+  and github usernames in markdown files.
+email:
+- mike.dalessio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hoe-markdown.gemspec
+- lib/hoe/markdown.rb
+- lib/hoe/markdown/util.rb
+- lib/hoe/markdown/version.rb
+homepage: https://github.com/flavorjones/hoe-markdown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/flavorjones/hoe-markdown
+  source_code_uri: https://github.com/flavorjones/hoe-markdown
+  changelog_uri: https://github.com/flavorjones/hoe-markdown/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Hoe plugin with helpers for markdown documentation files.
+test_files: []