cli_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81073fed9f35e6bf2534855ae8553cd1ee279b63
+  data.tar.gz: bb92bb66ccea64ad1c811f87ea43c91201481f65
+SHA512:
+  metadata.gz: 10a4399ac9253c393ee1a982ccd4d59d49fa20ce9dc509968b0406135fa24d19184f9115b1e6ac4e016f7c3db1f1fe7c365b2a6cbc6b2d03ab60316d05439902
+  data.tar.gz: 9bc5406afa807a95dbee5ecdfdb3bfcd70105e1703ab44dd64fc05c7526a3043d6e04678ee3789be54acd8afd6aa03370f716e88412af6b772287ad4e9d2bb65

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,68 @@
+# CLIConfig
+
+## A tiny gem for handling configs for command line apps
+
+CLIConfig provides a dsl heavily based on solnic/virtus for specifying options
+that will be filled from yam or command line options via OptionParser.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cli_config
+
+## Usage
+
+```ruby
+class RPGConfig
+  include CLIConfig
+
+  option :name, String, desc: 'your name'
+  option :race, Symbol, desc: 'your race (%{default})', default: :human
+  option :strength, Integer, desc: 'your strength (%{default})', default: 33
+  option :stamina, Integer, desc: 'your stamina (%{default})', default: 33, key: :x
+  option :intelligence, Integer, desc: 'your intelligence (%{default})', default: 34
+end
+
+config = RPGConfig.new(name: 'test')
+
+# Or read from a yaml file
+# config = RPGConfig.load('/some/config.yml')
+
+parser = OptionParser.new
+parser.banner = "Usage: #{$0} [options]"
+config.override_from_option_parser(parser)
+
+puts parser
+```
+
+Output:
+
+```
+Usage: rpg [options]
+    -n, --name VALUE                 your name
+    -r, --race VALUE                 your race (human)
+    -s, --strength VALUE             your strength (33)
+    -x, --stamina VALUE              your stamina (33)
+    -i, --intelligence VALUE         your intelligence (34)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jreinert/cli_config.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cli_config"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cli_config.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cli_config'
+  spec.version       = CLIConfig::VERSION
+  spec.authors       = ['Joakim Reinert']
+  spec.email         = ['mail+gems@jreinert.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'A tiny gem for handling configs for command line apps'
+  spec.description   = 'Provides dsl heavily based on solnic/virtus for' \
+                       'specifying options that will be filled from yaml' \
+                       'or command line options via OptionParser'
+  spec.homepage      = 'https://github.com/jreinert/cli_config'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+end

data/lib/cli_config.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+require 'active_support/concern'
+require 'virtus'
+require 'cli_config/version'
+require 'cli_config/option'
+
+module CLIConfig
+  extend ActiveSupport::Concern
+
+  included do
+    include Virtus.model
+    extend ClassMethods
+    include InstanceMethods
+  end
+
+  module ClassMethods
+    def load(file)
+      new(YAML.load_file(file))
+    end
+
+    def option(name, type, options = {})
+      attribute(name, Option[type], { strict: true }.merge(options))
+    end
+  end
+
+  module InstanceMethods
+    def override_from_option_parser(option_parser)
+      attribute_set.each do |attribute|
+        attribute.from_option_parser(option_parser) do |value|
+          send(:"#{attribute.name}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/cli_config/option.rb

@@ -0,0 +1,51 @@
+require 'active_support/core_ext/object/try'
+
+module CLIConfig
+  class Option < Virtus::Attribute
+    def self.[](type)
+      Class.new(self).tap do |klass|
+        klass.define_singleton_method(:type) { type }
+      end
+    end
+
+    def coerce(value)
+      Virtus::Attribute.build(
+        self.class.type,
+        strict: options[:strict]
+      ).coerce(value)
+    end
+
+    def from_option_parser(parser, &block)
+      if boolean?
+        parser.on("-#{key}", "--[no-]#{long_key}", description, &block)
+      else
+        parser.on("-#{key}", "--#{long_key} #{value_name}", description, &block)
+      end
+    end
+
+    private
+
+    def description
+      default = default_value.value
+      description = options[:description] || options[:desc]
+      return unless description
+      description % { default: default }
+    end
+
+    def key
+      options.fetch(:key, name.to_s[0])
+    end
+
+    def long_key
+      name.to_s.tr('_', '-')
+    end
+
+    def value_name
+      options[:value_name].try(:upcase) || 'VALUE'
+    end
+
+    def boolean?
+      self.class.type == Boolean
+    end
+  end
+end

data/lib/cli_config/version.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: cli_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joakim Reinert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Provides dsl heavily based on solnic/virtus forspecifying options that
+  will be filled from yamlor command line options via OptionParser
+email:
+- mail+gems@jreinert.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cli_config.gemspec
+- lib/cli_config.rb
+- lib/cli_config/option.rb
+- lib/cli_config/version.rb
+homepage: https://github.com/jreinert/cli_config
+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.1
+signing_key: 
+specification_version: 4
+summary: A tiny gem for handling configs for command line apps
+test_files: []
+has_rdoc: