gemthief 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8cdbee97d70a5f6d65d76822d021c6ec4e2aeb9
+  data.tar.gz: a8feebdf6f915d86830c23dcb80f29266688b9ce
+SHA512:
+  metadata.gz: 36666867ffcafdd569962e63367070f8345e2ec727ef9f39daf8a5f28f5d8dd21394388894b3e23b70331f3a5dd3444d1329ad8344f962abfc180d169b23f73f
+  data.tar.gz: 5e60a907ede5e49cc46020fdcbea4b2d0f425f378bdbece2adeff77a5597e90241e1fe2c16d88f8d62030b7e10387a90b45799ec13e6c53623d6471c38f4f4f5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matt Hink
+
+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,74 @@
+# Gemthief
+## A Ruby Roguelike Framework
+
+Gemthief is a framework for building roguelike games using the Ruby programming language.  Its architecture takes many cues from the Ruby on Rails web framework, in the sense that it establishes a strong set of conventions so that users can focus more on building their game. To that end, it makes heavy use of ActiveSupport, and takes many cues from Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gemthief'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gemthief
+
+## Usage
+There are three main 'components' of a Gemthief roguelike: Scenes, Views, and the Executive.
+
+### The Executive
+The Executive is the "central hub" of your game- when you start your game, it initializes Curses, instantiates the `initial_scene` and its view, and then enters the main game loop.
+
+During the main game loop, it gets input from the user and hands it off to the `active_scene` for processing.  After that input is processed, it tells the scene to refresh its view, and then refreshes Curses.
+
+```ruby
+# /game/executive.rb
+#  An example Executive
+class Executive < Gemthief::Executive
+  initial_scene(:dungeon) do |scene|
+    scene.generate_layout!
+    scene.add_monsters!
+  end
+end
+```
+
+TODO: The Executive will also responsible for scene transitions.  The planned structure for this is to have the /game/executive.rb file define a scene transition graph, which describes how the game transitions between different types of Scene. Then, after a Scene handles input, it can provide a signal (the name of an edge) to the Executive to request transitioning to another Scene.
+
+(Roughly equivalent to `Rails::Application`)
+
+### Scenes
+Scenes are your game's bread and butter.  Scenes have two major responsibilities: handling input, and tracking their state.
+
+Don't let the terminology fool you- while these are called Scenes, they don't just represent the 'gamelike' parts of your game- they can also represent menus (perhaps a class selection or an inventory screen). If you need a certain part of your game to handle input in a unique way AND/OR track its state independently, use a Scene.
+
+Scenes consist of two lifecycle events:
+- `handle_input(input)`
+- `render!`
+
+In the `handle_input` step, you should determine what the user wants to do and update your Scene's state accordingly.  Then, in the `render!` step, you should manipulate your View to reflect that state.  For example, if I received an 'h' input, the `handle_input` might update my hero's position, moving them one step to the left.  Then, in `render!`, I would tell my view to update the screen with the hero's new coordinates.
+
+Multiple instances of a particular Scene class are allowed- this is how we might, for instance, keep track of several 'floors' of a dungeon.  Each floor would be an instance of some type of "FloorScene". However, only one scene *instance* is the "active scene" at any given time.  Also note that Scene instances are persistent- you don't lose one Scene's state when you transition to another one.
+
+TODO: Scenes might be responisble for too much.  In the interest of not introducing too much abstraction, I'm making them responsible for both input interpretation and state tracking.  While they're intentionally similar to Rails controllers, the range of allowable inputs is considerably larger and less standardized than Rails' RESTful actions. I'm not sure if I want to introduce a recommendation for state management (i.e. models) just yet. While this framework *is* sorta MVC, I haven't given the Model part much thought yet.
+TODO: Read up on desktop MVC/MVVM-type architectures
+TODO: Can scenes be responsible for both state management *and* input interpretation? Or should they dispatch off to persistent Models?
+
+(Roughly equivalent to Rails controllers.)
+
+### Views
+Views are responsible for updating the user interface so that it reflects the state of their associated Scene.  View instances are always associated with a specific Scene instance.
+
+An important note: Views should be *stateless*.  During the transition into a Scene instance, the Executive creates a brand-new View instance for it.  If you transition out of a Scene, the Executive will finalize it and detach it from the scene instance, creating a new View if/when the game transitions back.
+
+(Roughly equivalent to Rails views)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/gemthief.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gemthief/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gemthief"
+  spec.version       = Gemthief::VERSION
+
+  spec.author        = "Matt Hink"
+  spec.email         = "mhink1103@gmail.com"
+
+  spec.summary       = %q{A Ruby Roguelike Framework}
+  spec.homepage      = "https://github.com/mhink/gemthief"
+  spec.license       = "MIT"
+
+  if spec.respond_to? :metadata
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'activesupport', '~> 4.2.5'
+  spec.add_dependency 'mono_logger', '~> 1.1.0'
+  spec.add_dependency 'curses', '~> 1.0.1'
+end

data/lib/gemthief.rb

@@ -0,0 +1,24 @@
+require 'active_support'
+
+module Gemthief
+  extend ActiveSupport::Autoload
+
+  autoload :Executive
+  autoload :Scene
+  autoload :View
+
+  class << self
+    @game = @game_class = nil
+
+    attr_writer :game
+    attr_accessor :game_class
+
+    def game
+      @game ||= (game_class.new if game_class)
+    end
+
+    def config
+      game.config
+    end
+  end
+end

data/lib/gemthief/config.rb

@@ -0,0 +1,6 @@
+module Gemthief
+  module Configuration
+    def initialize(root)
+    end
+  end
+end

data/lib/gemthief/executive.rb

@@ -0,0 +1,101 @@
+require 'gemthief'
+require 'gemthief/executive/callbacks'
+require 'gemthief/executive/window_management'
+
+module Gemthief
+  class Executive
+    include Callbacks
+    include WindowManagement
+
+    attr_accessor :active_scene
+
+    def config
+      @config ||= Gemthief::Config.new(self.class.root_path(self.class.called_from))
+    end
+
+    def start!
+      run_callbacks :start do
+        init_curses!
+        self.active_scene = initial_scene
+      end
+
+      catch(:game_end) do
+        loop do
+          active_scene.render!
+          refresh_curses!
+          active_scene.handle_input stdscr.getch
+        end
+      end
+    rescue SystemExit
+      # no-op
+    rescue => ex
+      # TODO: Move logging into the framework
+      # log! ex 
+    ensure
+      run_callbacks :finish
+    end
+
+    class << self
+      attr_accessor :called_from
+
+      attr_accessor :initial_scene_name
+      attr_accessor :initial_scene_setup
+
+      def inherited(base)
+        super
+        Gemthief.game_class = base
+
+        base.called_from = begin
+          call_stack = if Kernel.respond_to?(:caller_locations)
+            caller_locations.map { |l| l.absolute_path || l.path }
+          else
+            caller.map { |p| p.sub(/:\d+.*/, '') }
+          end
+
+          File.dirname(callstack.detect { |p| p !~ %r[lib/gemthief] })
+        end
+      end
+
+      def find_root(from)
+        find_root_with_flag "lib", from
+      end
+
+      def find_root_with_flag(flag, root_path, default=nil)
+        while root_path && File.directory?(root_path) && !File.exist?("#{root_path}/#{flag}")
+          parent = File.dirname(root_path)
+          root_path = parent != root_path && parent
+        end
+
+        root = File.exist?("#{root_path}/#{flag}") ? root_path : default
+        raise "Could not find root path for #{self}" unless root
+
+        Pathname.new File.realpath root
+      end
+
+      def initial_scene(scene, &block)
+        @initial_scene_name = case scene
+        when Class  then scene.name.underscore
+        when String then scene
+        when Symbol then scene
+        end
+        @initial_scene_setup = block
+      end
+    end
+
+    def initial_scene
+      @scene_instance ||= begin
+        scene_name = if self.class.initial_scene_name.nil?
+          "Initial"
+        else
+          self.class.initial_scene_name
+        end
+        scene_class = scene_name.to_s.camelize + "Scene"
+        scene_instance = scene_class.constantize.new
+        if self.class.initial_scene_setup.respond_to? :call
+          self.class.initial_scene_setup.call(scene_instance)
+        end
+        scene_instance
+      end
+    end
+  end
+end

data/lib/gemthief/executive/callbacks.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+require 'active_support/callbacks'
+
+module Gemthief
+  class Executive
+    module Callbacks
+      extend ActiveSupport::Concern
+      include ActiveSupport::Callbacks
+
+      CALLBACKS = [:start, :finish]
+
+      included do
+        define_callbacks *CALLBACKS
+      end
+
+      module ClassMethods
+        [:before, :around, :after].product(CALLBACKS).each do |type, callback|
+          define_method("#{type}_#{callback}") do |&block|
+            set_callback callback, type, &block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gemthief/executive/window_management.rb

@@ -0,0 +1,85 @@
+require 'active_support/concern'
+
+module Gemthief
+  class Executive
+    module WindowManagement
+      extend ActiveSupport::Concern
+
+      included do
+        include Curses
+      end
+
+      def init_curses!
+        init_screen
+        cbreak
+        noecho
+        srand
+        curs_set 0
+        trap("INT") { exit 0; }
+      end
+
+      def refresh_curses!
+        stdscr.noutrefresh
+        active_scene.view.refresh!
+        doupdate
+      end
+
+      def root_window
+        stdscr
+      end
+
+      class Panel
+        def initialize(screen_x, screen_y, screen_width, screen_height, content_width, content_height, content_x=0, content_y=0)
+          @screen_x       = screen_x
+          @screen_y       = screen_y
+          @screen_width   = screen_width
+          @screen_height  = screen_height
+          @content_width  = content_width
+          @content_height = content_height
+          @content_x      = content_x
+          @content_y      = content_y
+
+          @outer = Curses::Pad.new(@content_height, @content_width)
+          @inner = @outer.subpad(@content_height, @content_width,1,1)
+        end
+
+        # TODO: Use Forwardable for these and other methods
+        def clear
+          @inner.clear
+        end
+        def setpos(at_line, at_col)
+          @inner.setpos(at_line, at_col)
+        end
+        def addstr(char)
+          @inner.addstr("@")
+        end
+
+        def noutrefresh
+          @outer.noutrefresh(
+            @content_y, @content_x, 
+            @screen_y, @screen_x, 
+            screen_maxrow, screen_maxcol
+          )
+          @outer.box(?|, ?-)
+          @inner.noutrefresh(
+            @content_y, @content_x,
+            @screen_y+1, @screen_x+1,
+            screen_maxrow-2, screen_maxcol-2
+          )
+        end
+
+        def dimensions
+          { x: @width, y: @height }
+        end
+
+        def screen_maxrow
+          @screen_y + @screen_height
+        end
+
+        def screen_maxcol
+          @screen_x + @screen_width
+        end
+      end
+    end
+  end
+end

data/lib/gemthief/scene.rb

@@ -0,0 +1,33 @@
+module Gemthief
+  class Scene
+    class << self
+      attr_reader :view_name
+      def default_view(view=nil)
+        return @view_name if view.nil?
+
+        @view_name = case view
+        when Class  then view.name.underscore
+        when String then view
+        when Symbol then view
+        end
+      end
+    end
+
+    def view
+      @view ||= begin
+        view_name = if self.class.view_name.nil?
+          self.class.name.gsub(/Scene$/, "")
+        else
+          self.class.view_name
+        end
+        view_class = view_name.to_s.camelize + "View"
+        view_class.constantize.new(Gemthief.game.root_window)
+      end
+    end
+
+    def initialize
+      super
+      view
+    end
+  end
+end

data/lib/gemthief/version.rb

@@ -0,0 +1,3 @@
+module Gemthief
+  VERSION = "0.1.1"
+end

data/lib/gemthief/view.rb

@@ -0,0 +1,7 @@
+module Gemthief
+  class View
+    def initialize(root_window)
+      @root_window = root_window
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: gemthief
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matt Hink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: mono_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: 
+email: mhink1103@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemthief.gemspec
+- lib/gemthief.rb
+- lib/gemthief/config.rb
+- lib/gemthief/executive.rb
+- lib/gemthief/executive/callbacks.rb
+- lib/gemthief/executive/window_management.rb
+- lib/gemthief/scene.rb
+- lib/gemthief/version.rb
+- lib/gemthief/view.rb
+homepage: https://github.com/mhink/gemthief
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby Roguelike Framework
+test_files: []