hoe-markdown 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf9a6074da2a981e30084b7dd2f80f2d0e7d809351511e5f84459c9efdce7278
-  data.tar.gz: 35aa2d0edbcb62fd2d080eed18fbe108512027cbe16c7bfa2eb3da2ba1cb32a8
+  metadata.gz: abfcef683457297af7eaad6d438adcf6c2035d7a44a42f04218551344705b6a7
+  data.tar.gz: ce73aa0a2e6354778d23169ae711498bcf37816b8dea3c3406590243f39c59f7
 SHA512:
-  metadata.gz: cede2c0ad7e980d5f9d5ebb4b2daf577c191aab523dae0a6af1c28be3aa0b7549357530e0eb78d81f463d17fd51f999c5380f4ccacd57835c91f7817a6003fd6
-  data.tar.gz: eb4d6e81582ad7dca15338f1c90a4323a9a8405a923f960207f99a6a1ee43ee9fee823deaa7fd1261b318b6ff106ecff72beeab8752e5a8d5a0d1c9394de5cb0
+  metadata.gz: 9f45e91e75a7687ab261fa7ec651fb27bff58e5a3df6d1235cc256b6b1b31d79071c6178294244f753eb0d1c82abfd3be956164efc59cb577f04d55f48266b6c
+  data.tar.gz: 50fdb38dba957a40d68e3b1b2eb6b78ca3d8bc338cb258c10ec7fcd096cab15a94b54093f6974b00f82d4a928be65bc3c2adb4f7ecc72fe982ba072e4e08bd01

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Hoe::Markdown CHANGELOG
 
+## v1.3.0 / 2020-08-28
+
+Feature:
+
+- Hoe::Markdown::Standalone allows use of these rake tasks outside of Hoe
+
+
 ## v1.2.0 / 2020-06-16
 
 Fix:

data/Gemfile

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

data/README.md

@@ -2,6 +2,8 @@
 
 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.
 
+Hoe::Markdown::Standalone can be used without Hoe.
+
 
 ## Installation
 
@@ -20,7 +22,7 @@ Or install it yourself as:
     $ gem install hoe-markdown
 
 
-## Usage
+## Usage with Hoe
 
 In your Rakefile:
 
@@ -30,7 +32,6 @@ 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
@@ -88,6 +89,18 @@ Thanks, [@hobbes](https://github.com/hobbes)!
 Feature: Finagle the sprocket. See [#456](https://github.com/cogswellcogs/sprocketkiller/issues/456)
 ```
 
+## Usage without Hoe
+
+In your Rakefile:
+
+``` ruby
+require "hoe/markdown"
+Hoe::Markdown::Standalone.new("gemname").define_markdown_tasks
+```
+
+This will attempt to read your gemspec from `#{gemname}.gemspec`, and then the same rake tasks described above are created and behave the same way.
+
+
 ## 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).

data/hoe-markdown.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("rake", ">0")
 end

data/lib/hoe/markdown.rb

@@ -1,5 +1,9 @@
+require "rake"
+
 class Hoe
   module Markdown
+    include ::Rake::DSL
+
     #
     #  Optional: used to specify which markdown files to linkify. [default: any markdown files found in `files`].
     #
@@ -35,8 +39,7 @@ class Hoe
 
           desc "hyperlink github issues and usernames in #{mdfile_name}"
           task task_name do
-            puts "linkifying #{mdfile_path} ..."
-            markdown = File.read(mdfile_path)
+            original_markdown = markdown = File.read(mdfile_path)
 
             markdown = Hoe::Markdown::Util.linkify_github_usernames(markdown)
             if spec.metadata["bug_tracker_uri"]
@@ -45,7 +48,12 @@ class Hoe
               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 }
+            if markdown == original_markdown
+              puts "markdown:linkify: no changes to #{mdfile_path}"
+            else
+              puts "markdown:linkify: updating #{mdfile_path}"
+              File.open(mdfile_path, "w") { |f| f.write markdown }
+            end
           end
           linkify_tasks << "#{namespace_name}:#{task_name}"
         end
@@ -59,3 +67,4 @@ end
 
 require "hoe/markdown/version"
 require "hoe/markdown/util"
+require "hoe/markdown/standalone"

data/lib/hoe/markdown/standalone.rb

@@ -0,0 +1,13 @@
+class Hoe
+  module Markdown
+    class Standalone
+      include Hoe::Markdown
+
+      attr_reader :spec
+
+      def initialize gem_name
+        @spec = eval(File.read("./#{gem_name}.gemspec"))
+      end
+    end
+  end
+end

data/lib/hoe/markdown/version.rb

@@ -1,5 +1,5 @@
 class Hoe
   module Markdown
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hoe-markdown
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 description: Hoe plugin with markdown helpers, for example to hyperlink github issues
   and github usernames in markdown files.
 email:
@@ -29,6 +43,7 @@ files:
 - Rakefile
 - hoe-markdown.gemspec
 - lib/hoe/markdown.rb
+- lib/hoe/markdown/standalone.rb
 - lib/hoe/markdown/util.rb
 - lib/hoe/markdown/version.rb
 homepage: https://github.com/flavorjones/hoe-markdown