cri-scaffold 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3baefc027bda1f63e2b709b08ea178b72c7b24cb
+  data.tar.gz: 4076f8984e61971c3214eeebf5d8df217c90ac16
+SHA512:
+  metadata.gz: 8852294a8c5f8d8e9748bbceeb95fb664e3ce0e0612c0520de6efca95da2d5cb0fde78d8b0a39043d3f8fce341b3c200cc0962dce7364ddf2d10b3c7e0fb9049
+  data.tar.gz: '0870b5e94a636a1599525f31b2bedc5855ba8884ac5830ebe51e9eb066f08aaa4944eaea1c4d533114a8ddbe42307496bc0cae524c7432989a312514a3b2c2f7'

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ed@edropple.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cri-scaffold.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ed Ropple
+
+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,66 @@
+# Cri::Scaffold
+
+[Cri](https://github.com/ddfreyne/cri) is a pretty great tool. But using it can
+be a bit of a pain sometimes, especially if you have deeply structured commands.
+Cri::Scaffold exists to provide a convention-over-configuration method of
+defining commands. It intentionally limits the options available--every project
+using Cri::Scaffold works exactly the same, every time. In a nutshell:
+
+- The root command is always `cli.rb`.
+- Subcommands are in the `cli/` directory and end in `.cli.rb`,
+  i.e. `cli/foo.cli.rb`, which will be defined as the `foo` subcommand.
+- Sub-subcommands (and so on and so forth) are defined in directories descending
+  from the name of the command, i.e. `foo bar` would be in `cli/foo/bar.rb`.
+- Any command with an underscore in the name is converted to a hyphen to remove
+  the "is it an underscore or is it a hyphen?" question. Hyphens are cool. We
+  use hyphens.
+
+Hat-tip to my friend [Sean Edwards](https://github.com/seanedwards) for the
+idea.
+
+## Usage
+Cri::Scaffold expects to be pointed at a directory containing a file called
+`cli.rb`. It returns acompletely configured `Cri::Command` that can be evaluated
+with `ARGV`:
+
+```rb
+#! /usr/bin/env ruby
+require 'cri/scaffold'
+
+Cri::scaffold(File.expand_path("#{__dir__}/../lib/somegem")).run(ARGV)
+```
+
+The contents of `cli.rb`, and any sub-commands, will be evaluated as a DSL,
+as if they were included inside of a `Cri::Command` block. There are two
+important differences when writing the root command:
+
+- The command is created with `Cri::Command.new_basic_root`, not instantiated
+  directly via `Cri::Command.new`.
+- The variable `program_name` is in scope, containing
+  `File.basename($PROGRAM_NAME)`, to ensure a predictable help file text.
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. 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/eropple/cri-scaffold. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+Everyone interacting in the Cri::Scaffold project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/eropple/cri-scaffold/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cri/scaffold"
+
+# 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(__FILE__)

data/bin/setup

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

data/cri-scaffold.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cri/scaffold/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cri-scaffold"
+  spec.version       = Cri::Scaffold::VERSION
+  spec.authors       = ["Ed Ropple"]
+  spec.email         = ["ed@edropple.com"]
+
+  spec.summary       = "Quickly lays out a scaffold for command-line apps using Cri."
+  spec.homepage      = "https://github.com/eropple/cri-scaffold"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "cri", "~> 2.10"
+end

data/lib/cri-scaffold.rb

@@ -0,0 +1 @@
+require "cri/scaffold"

data/lib/cri/scaffold.rb

@@ -0,0 +1,47 @@
+require "cri/scaffold/version"
+
+require "cri"
+
+module Cri
+  def self.scaffold(path)
+    Scaffold.build_command(root: File.expand_path(path))
+  end
+
+  module Scaffold
+    def self.build_command(root:, name: nil, parent: nil)
+      raise "#{root} does not exist." unless Dir.exist?(root)
+      raise "name must be a String or nil, or parent must be nil." \
+        if !parent.nil? && !name.is_a?(String)
+
+      file = File.join(root, [name, "cli.rb"].compact.join("."))
+
+      cmd =
+        if parent.nil?
+          raise "#{file} must exist." unless File.exist?(file)
+
+          Cri::Command.new_basic_root.modify do
+            program_name = File.basename($PROGRAM_NAME)
+            name program_name
+
+            instance_eval File.read(file), file
+          end
+        else
+          parent.define_command(name.gsub("_", "-")) do |dsl|
+            dsl.instance_eval File.read(file), file
+          end
+        end
+
+      subdir = "#{root}/#{name || "cli"}"
+      if Dir.exist?(subdir)
+        Dir["#{subdir}/*.cli.rb"].each do |path|
+          new_root = File.dirname(path)
+          new_name = File.basename(path, ".cli.rb")
+
+          Scaffold.build_command(root: new_root, name: new_name, parent: cmd)
+        end
+      end
+
+      cmd
+    end
+  end
+end

data/lib/cri/scaffold/version.rb

@@ -0,0 +1,5 @@
+module Cri
+  module Scaffold
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cri-scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ed Ropple
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: cri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: 
+email:
+- ed@edropple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cri-scaffold.gemspec
+- lib/cri-scaffold.rb
+- lib/cri/scaffold.rb
+- lib/cri/scaffold/version.rb
+homepage: https://github.com/eropple/cri-scaffold
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Quickly lays out a scaffold for command-line apps using Cri.
+test_files: []