yoptparse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9da740c1ef27e2b9fa90c8ad2e64fab52f602bb2
+  data.tar.gz: a0dcc13accf4cf3c963900e47eb7ac83b1fb89e7
+SHA512:
+  metadata.gz: e06ff2b1d27dd969c1a52f69502e7daf669410adec76ccdfc3d52824ff1361b520aa0167c5d876235ee0ab6ff08da80dc00432344a4127508ef6ccb06d7c0c6e
+  data.tar.gz: e5f0469c2a8784973a458ffe073f1ca53df657560317d78df2d5138954ca613fb94f8b9c75b98259fb605f28d8c87875ebb48ca13b048faafa70c193a2aac0be

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+- 1st Release :tada:

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryo Nakamura
+
+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,64 @@
+# Yoptparse
+
+[![Gem Version](https://badge.fury.io/rb/yoptparse.svg)](https://badge.fury.io/rb/yoptparse)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/r7kamura/yoptparse)
+[![CircleCI](https://circleci.com/gh/r7kamura/yoptparse.svg?style=svg)](https://circleci.com/gh/r7kamura/yoptparse)
+
+Command line option parsing with [YARD](http://yardoc.org/) and optparse.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "yoptparse"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install yoptparse
+```
+
+## Usage
+
+Inherit `Yoptparse::Command` and define `#initialize` method with YARD style documentation.
+
+```ruby
+class ExampleCommand < Yoptparse::Command
+  # Usage: somemoji extract [options]
+  # @param destination [String] Directory path to put extracted emoji images
+  # @param format [String] png or svg (default: png)
+  # @param provider [String] Emoji provider name (apple, emoji_one, noto or twemoji)
+  # @param quiet [Boolean] Disable log output
+  # @param size [Integer] Image size
+  def initialize(destination:, format: "png", provider:, quiet: false, size: 64)
+    @destination = destination
+    @format = format
+    @provider = provider
+    @quiet = quiet
+    @size = size
+  end
+end
+
+puts ExampleCommand.to_option_parser
+```
+
+```
+Usage: somemoji extract [options]
+        --destination=               Directory path to put extracted emoji images (required)
+        --provider=                  Emoji provider name (apple, emoji_one, noto or twemoji) (required)
+        --format=                    png or svg (default: png)
+        --quiet                      Disable log output
+        --size=                      Image size
+```
+
+### Documentation
+
+See API documentation at http://www.rubydoc.info/github/r7kamura/yoptparse.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/yoptparse.rb

@@ -0,0 +1,6 @@
+require "optparse"
+require "yard"
+
+require "yoptparse/command"
+require "yoptparse/option"
+require "yoptparse/version"

data/lib/yoptparse/command.rb

@@ -0,0 +1,58 @@
+module Yoptparse
+  class Command
+    class << self
+      # @return [String]
+      def banner
+        ::YARD::Registry.at("#{self}#initialize").docstring
+      end
+
+      # @param argv [Array<String>]
+      # @return [Hash{Symbol => Object}]
+      def parse(argv)
+        option_parser, result_store = generate_option_parser_and_result_store
+        option_parser.parse(argv)
+        result_store
+      end
+
+      # @return [OptionParser]
+      def to_option_parser
+        generate_option_parser_and_result_store.first
+      end
+
+      private
+
+      # @return [String]
+      def constructor_path
+        instance_method(:initialize).source_location.first
+      end
+
+      # @return [Array]
+      def generate_option_parser_and_result_store
+        load_constructor_documentation
+        result_store = {}
+        option_parser = ::OptionParser.new
+        option_parser.banner = banner
+        instance_method(:initialize).parameters.map do |argument_type, argument_name|
+          option = ::Yoptparse::Option.new(
+            argument_name: argument_name,
+            argument_type: argument_type,
+            command_class: self,
+          )
+          option_parser.on(
+            option.long_option,
+            option.type_class,
+            option.description,
+          ) do |value|
+            result_store[argument_name] = value
+          end
+        end
+        [option_parser, result_store]
+      end
+
+      # @return [void]
+      def load_constructor_documentation
+        ::YARD.parse(constructor_path)
+      end
+    end
+  end
+end

data/lib/yoptparse/option.rb

@@ -0,0 +1,91 @@
+module Yoptparse
+  class Option
+    # @param argument_name [Symbol]
+    # @param argument_type [Symbol]
+    # @param command_class [Class]
+    def initialize(argument_name:, argument_type:, command_class:)
+      @argument_name = argument_name
+      @argument_type = argument_type
+      @command_class = command_class
+    end
+
+    # @return [String]
+    def description
+      [description_main, description_suffix].compact.join(" ")
+    end
+
+    # @return [String]
+    def long_option
+      "--#{chain_cased_argument_name}#{long_option_suffix}"
+    end
+
+    # @return [Class]
+    def type_class
+      case tag.type
+      when "Array"
+        ::Array
+      when "Float"
+        ::Float
+      when "Integer"
+        ::Integer
+      when "Numeric"
+        ::Numeric
+      when "OptionParser::DecimalInteger"
+        ::OptionParser::DecimalInteger
+      when "OptionParser::DecimalNumeric"
+        ::OptionParser::DecimalNumeric
+      when "OptionParser::OctalInteger"
+        ::OptionParser::OctalInteger
+      when "String"
+        ::String
+      else
+        ::Object
+      end
+    end
+
+    private
+
+    # @return [Boolean]
+    def boolean?
+      tag.type == "Boolean"
+    end
+
+    # @return [String]
+    def chain_cased_argument_name
+      @argument_name.to_s.gsub("_", "-")
+    end
+
+    # @return [String, nil]
+    def description_main
+      if tag
+        tag.text
+      end
+    end
+
+    # @return [String, nil]
+    def description_suffix
+      if required?
+        "(required)"
+      end
+    end
+
+    # @return [String, nil]
+    def long_option_suffix
+      unless boolean?
+        "="
+      end
+    end
+
+    # @return [Boolean]
+    def required?
+      @argument_type == :keyreq
+    end
+
+    # @return [YARD::Tag, nil]
+    def tag
+      ::YARD::Registry.at("#{@command_class}#initialize").tags.find do |tag|
+        tag.tag_name == "param" && tag.name == @argument_name.to_s
+      end
+    end
+  end
+end

data/lib/yoptparse/version.rb

@@ -0,0 +1,3 @@
+module Yoptparse
+  VERSION = "0.1.0"
+end

data/yoptparse.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yoptparse/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yoptparse"
+  spec.version       = Yoptparse::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Command line option parsing with YARD and optparse."
+  spec.homepage      = "https://github.com/r7kamura/yoptparse"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yard"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: yoptparse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-15 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: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yoptparse.rb
+- lib/yoptparse/command.rb
+- lib/yoptparse/option.rb
+- lib/yoptparse/version.rb
+- yoptparse.gemspec
+homepage: https://github.com/r7kamura/yoptparse
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Command line option parsing with YARD and optparse.
+test_files: []