knossoscli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbf3eed14b624ac22809e9fbbdc58831bc94a718a80ead7a72c4bbf0fb03bd7b
+  data.tar.gz: 466d558726753210c52fd0b01390c7109303ec7e6b5f54073d88c77953211daa
+SHA512:
+  metadata.gz: 85eccd063ec54ae6896acdc8b2eb800772ee0ed48d0d338e7981920fd0b4797bfe42a3deee6c3f32478b71a57cfdde7f38183fb8e637f44cbfed47e25ff4cfbd
+  data.tar.gz: 57b576cc61412590e51f4ebbd4893d27e65662b1845e94ab3df234cf2e060344eb7d5a89a6badf0390a22b104e29553e19689a28dd398f52d845c84bb6c9681b

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+This project uses [Semantic Versioning][semv].
+
+## [Unreleased][new]
+- Create the project as a Ruby gem.
+- Remove '-' from the project name and shorten the name of the executable.
+- Add the Thor toolkit to build the command line interface.
+- Add the `carve` sub-command
+- Specify grid dimensions as arguments to the `carve` command
+- Accept the maze-carving algorithm as an argument
+- Add the Sidewinder algorithm
+- Drop implicit, deprecated `Grid.to_s` and use `Renderer::Text.render` instead
+- Automagically infer the list of available algorithms. At least until the
+library provides a cleaner way.
+- Provide an option to save a PNG image of the generated maze.
+
+## [0.0.0][0.0.0] — yyyy-mm-dd
+### Added
+
+---
+_This file is composed with [GitHub Flavored Markdown][gfm]._
+
+[gfm]: https://github.github.com/gfm/
+[semv]: https://semver.org
+
+[new]: https://github.com/petejh/knossoscli/compare/HEAD..v0.0.0
+[0.0.0]: https://github.com/petejh/knossoscli/releases/tag/v0.0.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Peter J. Hinckley
+
+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,72 @@
+# Knossos CLI
+A command line companion to the [`knossos`][gem] Ruby gem for generating mazes.
+
+## Installation
+Install globally with:
+```bash
+~$ gem install knossoscli
+```
+
+## Usage
+The Knossos CLI actually comprises a suite of commands similar to familiar tools
+like `git` and `bundler`. You can see a summary of the available sub-commands by
+invoking:
+```bash
+~$ knossos help
+```
+More detailed documentation for each sub-command is available with, for example:
+```bash
+~$ knossos help carve
+```
+
+Generate a maze in your terminal:
+```bash
+~$ knossos carve --rows=5 --columns=7 --algorithm=RecursiveBacktracker
+```
+
+## Contributing
+Bug reports and pull requests are welcome on [GitHub][orig]. Knossos provides
+a safe, welcoming space for collaboration. Everyone contributing to our
+project—including the codebase, issue trackers, chat, email, social media and
+the like—is expected to uphold our [Code of Conduct][coc].
+
+### Setting Up
+[Fork the project][fork] on GitHub and make a local clone. Install dependencies,
+and run the tests:
+```bash
+~/knossoscli$ bin/setup
+~/knossoscli$ bundle exec rake rspec
+```
+
+### Running the Code
+Run the command itself with:
+```bash
+~/knossoscli$ bundle exec exe/knossos
+```
+Or, you can experiment directly with the code interactively using:
+```bash
+~/knossoscli$ bin/console
+```
+
+### Publishing
+To release a new version of the library, first increment the version number in
+`lib/knossoscli/version.rb` following [Semantic Versioning][semv] policy, and
+update `CHANGELOG.md`. Commit your work, and finally, run:
+```bash
+# Create a git tag, push commits and tags, and publish to rubygems.org
+~/knossoscli$ bundle exec rake release
+```
+
+## License
+This gem is available as open source under the terms of the [MIT License][mit].
+
+---
+_This file is composed with [GitHub Flavored Markdown][gfm]._
+
+[coc]:  https://github.com/petejh/knossoscli/blob/master/CODE_OF_CONDUCT.md
+[fork]: https://help.github.co://help.github.com/en/github/getting-started-with-github/fork-a-repo
+[gem]:  https://github.com/petejh/knossos
+[gfm]:  https://github.github.com/gfm/
+[orig]: https://github.com/petejh/knossoscli
+[mit]:  https://github.com/petejh/knossoscli/blob/master/LICENSE.txt
+[semv]: https://semver.org

data/exe/knossos

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'knossoscli'
+
+KnossosCLI::CLI.start(ARGV)

data/lib/knossoscli.rb

@@ -0,0 +1,7 @@
+require_relative 'knossoscli/version'
+
+require_relative 'knossoscli/cli'
+require_relative 'knossoscli/error'
+
+module KnossosCLI
+end

data/lib/knossoscli/cli.rb

@@ -0,0 +1,39 @@
+require 'knossos'
+require 'thor'
+
+class KnossosCLI::CLI < Thor
+  desc 'carve', 'Carve a maze'
+  method_option :rows,
+    :type => :numeric,
+    :aliases => '-r'
+  method_option :columns,
+    :type => :numeric,
+    :aliases => '-c'
+  method_option :algorithm,
+    :type => :string,
+    :aliases => '-a',
+    :enum => Algorithm.constants.map(&:to_s).sort,
+    :default => 'BinaryTree'
+  method_option :image,
+    :type => :string,
+    :default => 'maze.png'
+  def carve
+    params = {}
+    params[:rows] = options[:rows].to_i if options[:rows]
+    params[:columns] = options[:columns].to_i if options[:columns]
+
+    grid = Knossos::Grid.new(params)
+
+    carver = Algorithm.const_get(options[:algorithm])
+    carver.carve(grid: grid)
+
+    text_renderer = Renderer::Text.new
+    puts text_renderer.render(grid: grid)
+
+    if options[:image]
+      image_renderer = Renderer::Image.new(grid)
+      image = image_renderer.render
+      image.save(options[:image])
+    end
+  end
+end

data/lib/knossoscli/error.rb

@@ -0,0 +1,2 @@
+class KnossosCLI::Error < StandardError
+end

data/lib/knossoscli/version.rb

@@ -0,0 +1,3 @@
+module KnossosCLI
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: knossoscli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter J. Hinckley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: knossos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A command line companion to the `knossos` Ruby gem.
+email:
+- petejh.code@q.com
+executables:
+- knossos
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/knossos
+- lib/knossoscli.rb
+- lib/knossoscli/cli.rb
+- lib/knossoscli/error.rb
+- lib/knossoscli/version.rb
+homepage: https://github.com/petejh/knossoscli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/petejh/knossoscli
+  source_code_uri: https://github.com/petejh/knossoscli
+  changelog_uri: https://github.com/petejh/knossoscli/CHANGELOG.md
+  bug_tracker_uri: https://github.com/petejh/knossoscli/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate mazes from the command line.
+test_files: []