gamefic 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b365a88c85293650a4450cb905443a222aa1fa23
-  data.tar.gz: 2e299521b31b1c357651c52b7d2978c69988f306
+  metadata.gz: 6840c99f360ddbe9171237724e2462369b6e9436
+  data.tar.gz: dae8127b46901506eaf847fbb1c56db6591d69af
 SHA512:
-  metadata.gz: 5839d40d6211f3327e7f0d79667e591456e44a72da1f622f87af99127dcc97a207b6cefe06f6beb5edb75e135d85b1517a8731504b032fa706062f86d4c69e0b
-  data.tar.gz: 6ad1537348f09477915daab0a77b1709cea1380145323ab4d803565898f9ab693bd0fd065dd33eef57d94d09d104355d64e7119978e2f57fba359c58a599fde5
+  metadata.gz: 7276ad50d8871721e1999184e3e37ae6fafd8523a816d35708a2c0ac3766c1453cbe3449a73c2205481266cf2200c14309f53accc8ad15573ae1db4cdfc85f33
+  data.tar.gz: d5ce49c27cff38d30024bd418b2b979e20b3acd78f2c14e2b16ff82662086084965fa767a4d8bbe6e6b6bc4ff88cb48952cdb7f5bf349d64577a922005d9bd3e

data/bin/gamefic

@@ -3,8 +3,7 @@
 require 'gamefic'
 require 'gamefic/shell'
 
-shell = Gamefic::Shell.new
+# Make play the default command if the first argument is an existing file
+args = %w(play help).include?(ARGV[0]) || ARGV.count.zero? || !File.exist?(ARGV[0]) ? ARGV : ARGV.dup.unshift('play')
 
-shell.register "play", Gamefic::Shell::Command::Play
-
-shell.execute
+Gamefic::Shell.start(args)

data/lib/gamefic/shell.rb

@@ -1,25 +1,75 @@
+require 'thor'
+require 'gamefic/engine/tty'
+require 'zip'
+require 'tmpdir'
+require 'yaml'
+
 module Gamefic
+  class Shell < Thor
+    map %w[--version -v] => :version
 
-  class Shell
-    autoload :Command, 'gamefic/shell/command'
+    desc "--version, -v", "Print the version"
+    def version
+      puts "gamefic #{Gamefic::VERSION}"
+    end
     
-    def initialize
-      @commands = {}
+    desc 'play FILE_NAME', 'Execute a compiled (.gfic) game'
+    option :verbose, type: :boolean, aliases: :v, desc: "Don't suppress Ruby exceptions"
+    def play(file)
+      Dir.mktmpdir 'gamefic_' do |dir|
+        puts 'Loading...'
+        decompress file, dir
+        run_game(dir)
+      end
+    rescue StandardError => e
+      puts "'#{file}' does not appear to be a valid Gamefic file."
+      show_exception(e) if options[:verbose]
+    end
+
+    desc 'info FILE_NAME', 'Print information about a (.gfic) game'
+    option :verbose, type: :boolean, aliases: :v, desc: "Don't suppress Ruby exceptions"
+    def info(file)
+      Dir.mktmpdir 'gamefic_' do |dir|
+        decompress file, dir
+        metadata = YAML.load_file File.join(dir, 'metadata.yaml')
+        metadata.each { |k, v|
+          puts "#{k}: #{v}"
+        }
+      end
+    rescue StandardError, Zip::Error => e
+      puts "'#{file}' does not appear to be a valid Gamefic file."
+      show_exception(e) if options[:verbose]
     end
     
-    def register cmd, cls
-      @commands[cmd] = cls
+    # Custom error message for invalid command or filename
+    def method_missing(symbol, *args)
+      raise UndefinedCommandError, "Could not find command or file named \"#{symbol}\"."
     end
     
-    def execute
-      command = ARGV[0]
-      cls = @commands[command]
-      if cls.nil?
-        Gamefic::Shell::Command::Play.new.run(['play'] + ARGV)
-      else
-        cls.new.run ARGV
+    private
+
+    def show_exception(exception)
+      puts exception.inspect
+      puts exception.backtrace.join("\n")
+    end
+
+    def decompress(zipfile, destination)
+      Zip::File.open(zipfile) do |z|
+        z.each do |entry|
+          FileUtils.mkdir_p File.join(destination, File.dirname(entry.name))
+          full_path = File.join(destination, entry.name)
+          entry.extract full_path unless File.exist?(full_path)
+        end
       end
     end
+
+    def run_game(directory)
+      story = Plot.new(Source::File.new(File.join(directory, 'scripts')))
+      story.script 'main'
+      story.metadata = YAML.load_file File.join(directory, 'metadata.yaml')
+      engine = Tty::Engine.new story
+      puts "\n"
+      engine.run
+    end
   end
-  
 end

data/lib/gamefic/version.rb

@@ -1,3 +1,3 @@
 module Gamefic
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/gamefic.rb

@@ -15,4 +15,5 @@ require "gamefic/director"
 require "gamefic/plot"
 require "gamefic/engine"
 require "gamefic/direction"
-require "gamefic/version"
+
+require 'gamefic/version'

metadata

@@ -1,57 +1,129 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-27 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.3.0
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 description: An adventure game and interactive fiction framework
 email: fsnyder@gamefic.com
 executables:
@@ -129,10 +201,6 @@ files:
 - lib/gamefic/script/text.rb
 - lib/gamefic/serialized.rb
 - lib/gamefic/shell.rb
-- lib/gamefic/shell/command.rb
-- lib/gamefic/shell/command/base.rb
-- lib/gamefic/shell/command/play.rb
-- lib/gamefic/shell/registry.rb
 - lib/gamefic/source.rb
 - lib/gamefic/source/base.rb
 - lib/gamefic/source/file.rb
@@ -152,19 +220,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gamefic
 test_files: []
-has_rdoc: 

data/lib/gamefic/shell/command/base.rb

@@ -1,38 +0,0 @@
-require 'gamefic/shell'
-require 'slop'
-
-class Gamefic::Shell::Command::Base
-  # Execute the command
-  #
-  def run input
-    raise "Unimplemented command"
-  end
-  
-  # Get the options for the command
-  #
-  # @return [Slop::Options]
-  def options
-    @options ||= Slop::Options.new
-  end
-  
-  # Get the help documentation for this command.
-  #
-  # @return [String]
-  def help
-    optons.to_s
-  end
-  
-  protected
-  
-  # @return [Slope::Result]
-  def parse input
-    parser.parse input
-  end
-  
-  private
-
-  # @return [Slop::Parser]  
-  def parser
-    @parser ||= Slop::Parser.new(options)
-  end
-end

data/lib/gamefic/shell/command/play.rb

@@ -1,51 +0,0 @@
-require 'zip'
-require 'tmpdir'
-require 'gamefic/engine/tty'
-require 'gamefic/shell'
-require 'yaml'
-
-class Gamefic::Shell::Command::Play < Gamefic::Shell::Command::Base
-  include Gamefic
-  
-  def run input
-    result = parse input
-    file = result.arguments[1]
-    raise "File not specified." if file.nil?
-    raise "'#{file}' does not exist." if !File.exist?(file)
-    raise "'#{file}' is a directory." if File.directory?(file)
-    play file
-  end
-
-  private
-  
-  def decompress(zipfile, destination)
-    Zip::File.open(zipfile) do |z|
-      z.each do |entry|
-        FileUtils.mkdir_p File.join(destination, File.dirname(entry.name))
-        full_path = File.join(destination, entry.name)
-        if !File.exist?(full_path)
-          entry.extract full_path
-        end
-      end
-    end
-  end
-
-  def play file
-    Dir.mktmpdir 'gamefic_' do |dir|
-      puts "Loading..."
-      story = Plot.new(Source::File.new(File.join(dir, 'scripts')))
-      begin
-        decompress file, dir
-      rescue Exception => e
-        puts "'#{file}' does not appear to be a valid Gamefic file."
-        #puts "Error: #{e.message}"
-        #exit 1
-      end
-      story.script 'main'
-      story.metadata = YAML.load_file File.join(dir, 'metadata.yaml')
-      engine = Tty::Engine.new story
-      puts "\n"
-      engine.run
-    end    
-  end
-end

data/lib/gamefic/shell/command.rb

@@ -1,4 +0,0 @@
-module Gamefic::Shell::Command
-  autoload :Base, 'gamefic/shell/command/base'
-  autoload :Play, 'gamefic/shell/command/play'
-end

data/lib/gamefic/shell/registry.rb

@@ -1,13 +0,0 @@
-module Gamefic
-  class Shell
-    module Registry
-      @commands = {}
-      def self.register cmd, cls
-        @commands[cmd] = cls
-      end
-      def self.get_command_class cmd
-        @commands[cmd]
-      end
-    end
-  end
-end