escape-room 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9689c8757fb50ad38757025143e777f8363eaa237f318ce48ab61d5eccc7cfe0
+  data.tar.gz: c7ab9a9f6239e0edd1d1163336229cf89f8219ff46ddc246683f675334a4cb6a
+SHA512:
+  metadata.gz: c1fa93a2e0b3e2970266c17a7b68cc4b63f3b828164160e45eeb829fe1a004ec65d66dc8e35f68f95d5c0d9b92f57e5eb4027aa310cb11481138b483eafa4e37
+  data.tar.gz: 12e49a1e3b118b31857aa99447cbf5dbf835e0a536df48b89170c868b13d40c73636af98df94f1aed8cffe5d7f63a40be5596f47f265c6e7a29cc37e3b280150

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    escape-room (0.0.2)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  escape-room!
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Jamie Wright
+
+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,96 @@
+escape
+======
+
+The escape room CLI
+
+## DESCRIPTION
+
+Escape is a command line interface for asking questions to get out of an escape room. Complete with tests.
+
+The CLI loops through a list of questions (that you can define) and for each correct answer, you will receive a piece of the code. The
+actors can use this code for a combination lock or whatever clue you want to provide them.
+
+If the actor gets an answer wrong, the CLI will give them an answer but it is not part of the code. They can go through all of the questions and
+one or more may be wrong but they will not know the wrong answer.
+
+### Usage
+
+You can modify the [configuration.yml](./configuration.yml) file with your own questions, answers, and the code.
+
+To start, the actors are greated with a welcome message and they hit return to start:
+
+```
+> WELCOME TO THE ESCAPE ROOM!
+>
+> You were chosen to take part in this clue. Be careful, any answer will give you a part
+> of the clue but if the answer is wrong, the clue is wrong. Any wrong part and you will
+> have to start all over.
+>
+> Hit RETURN to start!
+>
+```
+
+It then loops through the questions:
+
+```
+> WHAT IS THE VALUE OF PI? (Answer the question and hit RETURN)
+>
+```
+
+The CLI will then provide them with an answer, right or wrong:
+
+```
+> YOUR NEXT CLUE IS: '4'
+>
+```
+
+Once the CLI loops through all of the questions, you will get a message with a chance to start over:
+
+```
+> YOU HAVE COMPLETED THE CHALLENGE.
+>
+> Hit RETURN to restart.
+```
+
+### Installation
+
+1. Pull down this repository
+
+```
+git clone https://github.com/jwright/escape
+```
+
+2. `cd` into this directory
+
+```
+cd escape
+```
+
+3. Configure your welcome message, questions, answers, and code at [./configuration.yml](./configuration.yml)
+
+4. Run the application at the command line
+
+```
+escape
+```
+
+## RELEASING A NEW GEM
+
+1. Bump the VERSION in `lib/escape/version.rb`
+1. Commit changes and push to GitHub
+1. run `bundle exec rake release`
+
+## CONTRIBUTING
+
+1. Clone the repository `git clone git@github.com:jwright/escape`
+1. Create a feature branch `git checkout -b my-awesome-feature`
+1. Codez!
+1. Commit your changes (small commits please)
+1. Push your new branch `git push origin my-awesome-feature`
+1. Create a pull request `hub pull-request -b jwright:master -h jwright:my-awesome-feature`
+
+## LICENSE
+
+Copyright (c) 2019, Jamie Wright.
+
+This project is licensed under the [MIT License](LICENSE.md).

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/escape

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "escape"
+
+Escape::CLI.start

data/configuration.yml

@@ -0,0 +1,22 @@
+welcome_message: |
+  Welcome to the Escape Room!
+  +------------------------------------------------+
+
+  We are here to solve a puzzle together.
+  You will asked a series of questions.
+  Each question will provide you an answer.
+  The trick is that some of those questions may be wrong if your answer is wrong.
+  You will not know until you try the code that is provided to you after each answer.
+  Good luck.
+
+  Hit RETURN to start.
+
+questions:
+  - text: What is the meaning of life?
+    answer: 42
+  - text: What is the value of PI?
+    answer: 3
+
+clues:
+  - 4
+  - H

data/escape.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "escape/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "escape-room"
+  spec.version       = Escape::VERSION
+  spec.authors       = ["Jamie Wright"]
+  spec.email         = ["jamie@brilliantfantastic.com"]
+
+  spec.summary       = %q{A command line interface for asking questions to get out of an escape room}
+  spec.description   = %q{Create your own quiz to reveal clues in an escape room.}
+  spec.homepage      = "https://github.com/jwright/escape"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = "~> 2.5.0"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.executable    = "escape"
+
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/escape.rb

@@ -0,0 +1,6 @@
+require_relative "escape/cli"
+require_relative "escape/clue"
+require_relative "escape/commands"
+require_relative "escape/configuration"
+require_relative "escape/question"
+require_relative "escape/question_list"

data/lib/escape/cli.rb

@@ -0,0 +1,40 @@
+require "thor"
+
+module Escape
+  class CLI < Thor
+    default_task :start
+
+    desc "start", "Starts a new game"
+    def start
+      raise RuntimeError, "Number of questions does not match the number of clues" unless valid_configuration?
+
+      Escape::Commands::Welcome.new(self).show(configuration.welcome_message)
+      Escape::Commands::Questions.new(self).start(configuration.questions, configuration.clues)
+      Escape::Commands::Restart.new(self).restart_or_quit
+    end
+
+    desc "restart", "Restarts a new game"
+    def restart
+      Escape::Commands::Questions.new(self).start(configuration.questions, configuration.clues)
+      Escape::Commands::Restart.new(self).restart_or_quit
+    end
+
+    no_commands do
+      def execute(command)
+        self.class.new.invoke command
+      end
+    end
+
+    private
+
+    no_commands do
+      def configuration
+        @configuration ||= Escape::Configuration.load(File.join(File.dirname(__FILE__), "..", "..", "configuration.yml"))
+      end
+
+      def valid_configuration?
+        configuration.questions.count == configuration.clues.count
+      end
+    end
+  end
+end

data/lib/escape/clue.rb

@@ -0,0 +1,20 @@
+module Escape
+  class Clue
+    attr_reader :clues
+
+    def initialize(clues)
+      @clues = clues
+    end
+
+    def correct(index)
+      clues[index]
+    end
+
+    def incorrect(index)
+      correct = self.correct(index)
+
+      return ([*0..99] - [correct]).sample if correct.is_a?(Integer)
+      return ([*"A".."Z"] - [correct]).sample if correct.is_a?(String)
+    end
+  end
+end

data/lib/escape/commands.rb

@@ -0,0 +1,4 @@
+require_relative "commands/base"
+require_relative "commands/questions"
+require_relative "commands/restart"
+require_relative "commands/welcome"

data/lib/escape/commands/base.rb

@@ -0,0 +1,11 @@
+module Escape
+  module Commands
+    class Base
+      attr_reader :runner
+
+      def initialize(runner)
+        @runner = runner
+      end
+    end
+  end
+end

data/lib/escape/commands/questions.rb

@@ -0,0 +1,13 @@
+module Escape
+  module Commands
+    class Questions < Base
+      def start(questions, clues)
+        questions.each_with_index do |question, index|
+          answer = runner.ask(question.text)
+          runner.say(question.correct?(answer) ? Clue.new(clues).correct(index) : Clue.new(clues).incorrect(index))
+          runner.say
+        end
+      end
+    end
+  end
+end

data/lib/escape/commands/restart.rb

@@ -0,0 +1,13 @@
+module Escape
+  module Commands
+    class Restart < Base
+      def restart_or_quit
+        response = runner.ask "Hit RETURN to restart or Q to quit"
+        unless (response.to_s.strip.upcase == "Q")
+          runner.say
+          runner.execute :restart
+        end
+      end
+    end
+  end
+end

data/lib/escape/commands/welcome.rb

@@ -0,0 +1,10 @@
+module Escape
+  module Commands
+    class Welcome < Base
+      def show(message)
+        runner.say message
+        runner.ask "\n"
+      end
+    end
+  end
+end

data/lib/escape/configuration.rb

@@ -0,0 +1,31 @@
+require "yaml"
+
+module Escape
+  class Configuration
+    def clues
+      config["clues"]
+    end
+
+    def questions
+      QuestionList.load(config["questions"])
+    end
+
+    def welcome_message
+      config["welcome_message"]
+    end
+
+    class << self
+      def load(path)
+        new(YAML.load_file(path))
+      end
+    end
+
+    protected
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+  end
+end

data/lib/escape/question.rb

@@ -0,0 +1,20 @@
+module Escape
+  class Question
+    attr_reader :answer, :text
+
+    def initialize(text, answer: nil)
+      @text = text
+      @answer = answer
+    end
+
+    def correct?(answer)
+      self.answer.to_s == answer
+    end
+
+    class << self
+      def load(question)
+        new(question["text"], answer: question["answer"])
+      end
+    end
+  end
+end

data/lib/escape/question_list.rb

@@ -0,0 +1,23 @@
+module Escape
+  class QuestionList
+    include Enumerable
+
+    def initialize(*questions)
+      @questions = questions || []
+    end
+
+    def each(&block)
+      questions.each(&block)
+    end
+
+    class << self
+      def load(list)
+        new(*list.map { |item| Question.load(item) })
+      end
+    end
+
+    private
+
+    attr_reader :questions
+  end
+end

data/lib/escape/version.rb

@@ -0,0 +1,3 @@
+module Escape
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: escape-room
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jamie Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: Create your own quiz to reveal clues in an escape room.
+email:
+- jamie@brilliantfantastic.com
+executables:
+- escape
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/escape
+- configuration.yml
+- escape.gemspec
+- lib/escape.rb
+- lib/escape/cli.rb
+- lib/escape/clue.rb
+- lib/escape/commands.rb
+- lib/escape/commands/base.rb
+- lib/escape/commands/questions.rb
+- lib/escape/commands/restart.rb
+- lib/escape/commands/welcome.rb
+- lib/escape/configuration.rb
+- lib/escape/question.rb
+- lib/escape/question_list.rb
+- lib/escape/version.rb
+homepage: https://github.com/jwright/escape
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A command line interface for asking questions to get out of an escape room
+test_files: []