yard-clean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6119c23749a074e6e55dc0363f70c3f890ddcade
+  data.tar.gz: e50ab51467b260034b76ecd644e065193c6be25e
+SHA512:
+  metadata.gz: 721a9289529ffb09bdbfb3e3016aed3761e9cd2da7e748de1d6cab435aa05a6b020f7bf26b86228cf21e0baddf9b06635220a0474076c92e07087a02856a422f
+  data.tar.gz: 93f243868390878590de0ec7de594a11c614306b863112ce9943619621429ccdda033835f939b912fb372394a6fedcf26b0174f32868125c9efbf3009525bac4

data/.gitignore

@@ -0,0 +1,104 @@
+##############################################################################
+# BEGIN Global/macOS.gitingore
+#
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+#
+# END Global/macOS.gitingore
+##############################################################################
+
+##############################################################################
+# BEGIN Ruby.gitingore
+#
+# General Git ignore file for Ruby, including support for:
+# 
+# -   Bundler
+# -   RDoc and Yard
+# -   RBEnv and RVM
+# -   DotEnv (optional)
+# 
+# Additional support is available in separate ignore files:
+# 
+# -   Gem.gitignore (for gem source directories)
+# -   Rails.gitignore
+# -   RubyMotion.gitignore
+# 
+
+/*.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/ # We Use `//doc` for additional hand-written documentation
+/rdoc/
+
+## Environment normalization:
+.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, add `Gem.gitignore`
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+#
+# END Ruby.gitingore
+##############################################################################
+
+##############################################################################
+# BEGIN Gem.gitingore
+#
+/Gemfile.lock
+/.ruby-version
+/.ruby-gemset
+#
+# END Gem.gitingore
+##############################################################################
+
+
+# Project Rules
+# ============================================================================
+
+# Generated doc site (YARD)
+/site/
+
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yard-clean.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 nrser
+
+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,58 @@
+Yard::Clean by NRSER
+==============================================================================
+
+Yeah this just adds a `yard clean` command to remove the db files.
+
+Sometimes `yard server --reload` just doesn't cut it... generated HTML doesn't
+update, or ends up in a mixed state of old and new. This seems especially
+prevalent when using plugins.
+
+In these cases, my easy answer is to whack the database directory (defaults to
+`.yardoc/`), causing the YARD server to rebuild the database on the next page
+load.
+
+Yeah, this is basically `rm -rf ./.yardoc`, but I get sick of typing it, and
+scared that I'll fat-finger it and lose some uncommitted code.
+
+So, this could just be a one-liner shell script, except when someone changes
+the database directory with `--db FILE`, and then I still need to distribute it
+somehow, so this gem seems almost reasonable.
+
+Enjoy!
+
+
+Installation
+------------------------------------------------------------------------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-clean'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-clean
+
+If you're running on a recent YARD, you also need to enable the plugin.
+
+Add this to your `.yardopts`:
+
+    --plugin yard-clean
+
+
+Usage
+------------------------------------------------------------------------------
+
+    $ yard clean
+
+
+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 @@
+require "bundler/gem_tasks"

data/lib/yard-clean.rb

@@ -0,0 +1,5 @@
+require 'yard'
+require_relative "./yard/clean/version"
+require_relative "./yard/cli/clean"
+
+YARD::CLI::CommandParser.commands[:clean] = YARD::CLI::Clean

data/lib/yard/clean/version.rb

@@ -0,0 +1,5 @@
+module YARD
+  module Clean
+    VERSION = "0.1.0"
+  end
+end

data/lib/yard/cli/clean.rb

@@ -0,0 +1,144 @@
+# Requirements
+# ============================================================================
+
+require 'yard'
+require_relative "../clean/version"
+
+
+# Namespace
+# ============================================================================
+
+module YARD
+module CLI
+
+class Clean < YardoptsCommand
+  
+  # String to explain `yard clean` in `yard help` output. Also used in the 
+  # command help messages for the command itself.
+  # 
+  # @return [String]
+  # 
+  def description
+    'Remove the database files.'
+  end
+  
+  
+  # Runs the command, removing the DB directory (if it exists and *is* a 
+  # directory).
+  #
+  # @param [Array<String>] args
+  #   Shell-split arguments from the CLI.
+  # 
+  # @return [nil]
+  # 
+  # @note
+  #   Exits the program on failure.
+  # 
+  def run *args_and_opts
+    args = parse_arguments *args_and_opts
+    
+    unless args.empty?
+      log.warn  "`yard clean` does not accept arguments (only options), " +
+                "found #{ args.inspect }. See `yard clean --help` for usage."
+    end
+    
+    # This gets set to the correct DB file location by {#optparse}, which is
+    # run *first* for any yardopts file, then for any CLI options. If the DB
+    # option is found in neither, it will remain at it's default `.yardoc`
+    db = YARD::Registry.yardoc_file
+    
+    if File.exists? db
+      if File.directory? db
+        log.info "Found DB directory at #{ db.inspect }, removing..."
+        FileUtils.rm_rf db
+      
+      else
+        log.error "DB path #{ db.inspect } exists, but is NOT a directory!"
+        log.error "Exiting..."
+        exit false
+      end
+    else
+      log.info "DB path #{ db.inspect } does no exist, nothing to do."
+    end
+    
+    log.info "Done."
+    
+    nil
+  end # #run
+  
+  
+  # Parse argument strings. Called by {YARD::CLI::YardoptsCommand} for *both*
+  # the yardopts file (if any) and the CLI arguments.
+  # 
+  # We kick this off with our call to
+  # {YARD::CLI::YardoptsCommand#parse_arguments} up in {#run}.
+  # 
+  # @param [Array<String>] args
+  #   Shell-split argument strings (including options/switches).
+  # 
+  # @return [Array<String>]
+  #   The non-option arguments remaining after option parsing.
+  # 
+  def optparse *args
+    opts = OptionParser.new
+    opts.banner = "Usage: yard clean [options]"
+    opts.separator "" 
+    opts.separator description
+    opts.separator ""
+    opts.separator "Options:"
+    
+    opts.on('-b', '--db FILE', 'Use a specified .yardoc db to load from or save to',
+                  '  (defaults to .yardoc)') do |yardoc_file|
+      YARD::Registry.yardoc_file = yardoc_file
+    end
+    
+    opts.on_tail('-q', '--quiet', 'Show no warnings.') {
+      log.level = Logger::ERROR
+    }
+    
+    opts.on_tail('--verbose', 'Show more information.') {
+      log.level = Logger::INFO
+    }
+    
+    opts.on_tail('--debug', 'Show debugging information.') {
+      log.level = Logger::DEBUG
+    }
+    
+    opts.on_tail('-v', '--version', 'Show version information.') {
+      log.puts "yard clean #{YARD::Clean::VERSION}"
+      exit
+    }
+    
+    opts.on_tail('--bare-version', 'Show JUST version.') {
+      log.print "#{YARD::Clean::VERSION}"
+      exit
+    }
+    
+    opts.on_tail('-h', '--help', 'Show this help.')  {
+      log.puts opts
+      exit
+    }
+    
+    parse_options opts, args
+    
+    args
+  end # #optparse
+  
+  
+  # Callback when an unrecognized option is parsed. We ignore 'em... there are
+  # *many* options that can be defined in the *yardopts* that we don't handle
+  # and don't care about.
+  #
+  # @param [OptionParser::ParseError] err the exception raised by the
+  #   option parser
+  def unrecognized_option err
+    # pass
+  end
+      
+end # class Clean
+
+# /Namespace
+# ============================================================================
+
+end # module CLI
+end # module YARD

data/yard-clean.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yard/clean/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yard-clean"
+  spec.version       = YARD::Clean::VERSION
+  spec.authors       = ["nrser"]
+  spec.email         = ["neil@neilsouza.com"]
+
+  spec.summary       = %q{Yeah this just adds a `yard clean` command to remove files.}
+  # spec.description   = %q{}
+
+  spec.homepage      = "https://github.com/nrser/yard-clean"
+  spec.license       = "MIT"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  # TODO  No idea what version of YARD this will work back to...
+  spec.add_runtime_dependency "yard"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  # spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: yard-clean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nrser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- neil@neilsouza.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yard-clean.rb
+- lib/yard/clean/version.rb
+- lib/yard/cli/clean.rb
+- yard-clean.gemspec
+homepage: https://github.com/nrser/yard-clean
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Yeah this just adds a `yard clean` command to remove files.
+test_files: []