yard_ghurt 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eabd1d16b12b7055c9ab9a5c0bdc460281cc3cfe63b7b4e207e086ed30de30a6
-  data.tar.gz: 200b03f7a0a22016a8634dcb3b4d3e0854d97eb9714933ec6a339bb9651b281a
+  metadata.gz: 3d6655a3fefa8677dd2b00ea73dbd7b87cf1c6d13b888ed67c29feb899f2555e
+  data.tar.gz: 52ffccc6f6a7d98e7865396b1c8c3e2b8c9a58452d3e724b0d0eb0c75e3495ab
 SHA512:
-  metadata.gz: acd5ef0039f8a3fce2f5c3ecf89a25259d38d2988585ac33a6aa1ad5540bae27ec1eb2833325c793f36df403f0db936576fce26e964750aea97fb2e8d8e67b0b
-  data.tar.gz: b47d674b37f759696fa23bea3b5d145c7d2561679a104bf3335df1af06a2943174f4bcc9e998bb917c04e633b94c6d67d361d8b974e9b7200289e9cb26da675c
+  metadata.gz: bcab8039ee10ff48858cd161483bbbc32ebe23a038f32303defe23081932ab4bc97b7e0d64a4de15307c14993cdf4d311d7385ed00a920af324b641b3e11d110
+  data.tar.gz: 31b278e7cbc842b3431eda53f8737bf957ff7068c4796ca984c0362040777b31f8542270e0844942b7a47906b464a41be7cf155712f4a9f1a05b2a41c391ad93

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.1.0...master)
+## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.2.0...master)
+
+## [v1.2.0] - 2020-02-29
+### Added
+- bin/yard_ghurt
+    - For getting the GitHub/YARDoc anchor link ID from a string
+- App class
+- AnchorLinks.escape()
+
+### Changed
+- README to talk about bin/yard_ghurt
+
+### Fixed
+- In AnchorLinks, don't use obsolete method URI.escape()/encode()
+    - This outputted a lot of warnings
 
 ## [v1.1.0] - 2019-07-31
 ### Added

data/README.md

@@ -20,6 +20,7 @@
     - [GHPSyncTask](#ghpsynctask)
     - [Util / YardGhurt](#util--yardghurt)
     - [AnchorLinks](#anchorlinks)
+- [CLI App](#cli-app)
 - [Hacking](#hacking)
     - [Testing](#testing)
 - [Tests](#tests)
@@ -244,6 +245,33 @@ puts al.to_github_anchor_id(name) # this-is-another-test-1
 puts al.to_github_anchor_id(name) # this-is-another-test-1
 ```
 
+## [CLI App](#contents)
+A CLI app has been added for convenience for when writing your own README.
+
+On the command line:
+```
+$ yard_ghurt -g "What's this ID?"
+# => whats-this-id
+
+$ yard_ghurt -y "What's this ID?"
+# => What_s_this_ID_
+
+$ yard_ghurt -a "What's this ID?"
+# => GitHub: whats-this-id
+#    YARDoc: What_s_this_ID_
+```
+
+Help:
+```
+Usage: yard_ghurt [options]
+    -a, --anchor <string>            Print GitHub & YARDoc anchor link IDs of <string>
+    -g, --github <string>            Print GitHub anchor link ID of <string>
+    -y, --yard <string>              Print YARDoc anchor link ID of <string>
+    ---
+    -h, --help                       Print this help
+    -v, --version                    Print the version
+```
+
 ## [Hacking](#contents)
 
 ```
@@ -324,7 +352,7 @@ Newline
 [GNU LGPL v3+](LICENSE.txt)
 
 > YardGhurt (<https://github.com/esotericpig/yard_ghurt>)  
-> Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2019-2020 Jonathan Bradley Whited (@esotericpig)  
 > 
 > YardGhurt is free software: you can redistribute it and/or modify  
 > it under the terms of the GNU Lesser General Public License as published by  

data/bin/yard_ghurt

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of YardGhurt.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# YardGhurt is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# YardGhurt is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with YardGhurt.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'yard_ghurt'
+
+
+# @since 1.2.0
+yg = YardGhurt::App.new()
+yg.run()

data/lib/yard_ghurt.rb

@@ -4,7 +4,7 @@
 
 #--
 # This file is part of YardGhurt.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
+# Copyright (c) 2019-2020 Jonathan Bradley Whited (@esotericpig)
 # 
 # YardGhurt is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -21,12 +21,14 @@
 #++
 
 
+require 'optparse'
 require 'yard_ghurt/anchor_links'
 require 'yard_ghurt/gfm_fix_task'
 require 'yard_ghurt/ghp_sync_task'
 require 'yard_ghurt/util'
 require 'yard_ghurt/version'
 
+
 ###
 # YARDoc GitHub Rake Tasks
 # 
@@ -37,4 +39,62 @@ module YardGhurt
   # Internal code should use +Util.+!
   # See {Util} for details.
   include Util
+  
+  ###
+  # A simple CLI app used in file +bin/yard_ghurt+.
+  # 
+  # Mainly for getting GitHub/YARDoc anchor link IDs.
+  # 
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  1.2.0
+  ###
+  class App
+    attr_reader :args
+    
+    def initialize(args=ARGV)
+      super()
+      
+      @args = args
+    end
+    
+    def run()
+      parser = OptionParser.new() do |op|
+        op.program_name = 'yard_ghurt'
+        op.version = VERSION
+        
+        op.banner = "Usage: #{op.program_name} [options]"
+        
+        op.on('-a','--anchor <string>','Print GitHub & YARDoc anchor link IDs of <string>') do |str|
+          al = AnchorLinks.new()
+          puts "GitHub: #{al.to_github_anchor_id(str)}"
+          puts "YARDoc: #{al.to_yard_anchor_id(str)}"
+          exit
+        end
+        op.on('-g','--github <string>','Print GitHub anchor link ID of <string>') do |str|
+          al = AnchorLinks.new()
+          puts al.to_github_anchor_id(str)
+          exit
+        end
+        op.on('-y','--yard <string>','Print YARDoc anchor link ID of <string>') do |str|
+          al = AnchorLinks.new()
+          puts al.to_yard_anchor_id(str)
+          exit
+        end
+        
+        op.separator op.summary_indent + '---'
+        
+        op.on_tail('-h','--help','Print this help') do
+          puts op
+          exit
+        end
+        op.on_tail('-v','--version','Print the version') do
+          puts "#{op.program_name} v#{op.version}"
+          exit
+        end
+      end
+      
+      parser.parse!(@args)
+      puts parser # Print help if nothing was parsed
+    end
+  end
 end

data/lib/yard_ghurt/anchor_links.rb

@@ -4,7 +4,7 @@
 
 #--
 # This file is part of YardGhurt.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
+# Copyright (c) 2019-2020 Jonathan Bradley Whited (@esotericpig)
 # 
 # YardGhurt is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -119,6 +119,20 @@ module YardGhurt
       return self
     end
     
+    # Escape +str+ for the web (e.g., "%20" for a space).
+    # 
+    # Mainly used for non-English languages.
+    # 
+    # @param str [String] the string to escape
+    # 
+    # @return [String] the escaped string
+    # 
+    # @since  1.2.0
+    def self.escape(str)
+      # URI.escape()/encode() is obsolete
+      return URI.encode_www_form_component(str)
+    end
+    
     # Merge +anchor_ids+ with {anchor_ids} and {yard_anchor_ids}.
     # 
     # @param anchor_ids [Hash] the anchor IDs (of GFM anchor IDs to YARDoc anchor IDs) to merge
@@ -198,7 +212,7 @@ module YardGhurt
         id.downcase!()
       end
       
-      id = URI.escape(id) # For non-English languages
+      id = self.class.escape(id) # For non-English languages
       
       # Duplicates
       dup_num = 1
@@ -246,7 +260,7 @@ module YardGhurt
       id.strip!()
       id.gsub!(/&[^;]+;/,'_') # Replace entities: &...;
       id.gsub!(/[^a-z0-9-]/i,'_')
-      id = URI.escape(id) # For non-English languages
+      id = self.class.escape(id) # For non-English languages
       
       # Duplicates
       orig_id = id.dup()

data/lib/yard_ghurt/version.rb

@@ -22,5 +22,5 @@
 
 
 module YardGhurt
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/yard_ghurt.gemspec

@@ -3,7 +3,7 @@
 
 #--
 # This file is part of YardGhurt.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
+# Copyright (c) 2019-2020 Jonathan Bradley Whited (@esotericpig)
 # 
 # YardGhurt is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -44,8 +44,11 @@ Gem::Specification.new() do |spec|
   }
   
   spec.require_paths = ['lib']
+  spec.bindir        = 'bin'
+  spec.executables   = [spec.name]
   
   spec.files = Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{erb,rb}')) +
+               Dir.glob(File.join(spec.bindir,'**',"{#{spec.executables.join(',')}}")) +
                Dir.glob(File.join('{test,yard}','**','*.{erb,rb}')) +
                %W( Gemfile #{spec.name}.gemspec Rakefile ) +
                %w( CHANGELOG.md LICENSE.txt README.md )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard_ghurt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2020-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,7 +83,8 @@ dependencies:
 description: YARDoc GitHub Rake Tasks. Fix GitHub Flavored Markdown (GFM) files.
 email:
 - bradley@esotericpig.com
-executables: []
+executables:
+- yard_ghurt
 extensions: []
 extra_rdoc_files: []
 files:
@@ -92,6 +93,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/yard_ghurt
 - lib/yard_ghurt.rb
 - lib/yard_ghurt/anchor_links.rb
 - lib/yard_ghurt/gfm_fix_task.rb
@@ -124,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: YARDoc GitHub Rake Tasks