carbonmu 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53974bdbf1c1b7b9098bd891531def0b0a163fe1
+  data.tar.gz: 0ba17a6b68dc0090370ee7be96d6125ea4ceac12
+SHA512:
+  metadata.gz: 7e8de6c21cf3e0e225bcfbd2f004b3ada12b6caa7ee598e62860d4b659e7f09bebd7777cc3fc0cda2748e7cc6cc791b3b2db1edfa8aa7b2e87f61c1b1754030d
+  data.tar.gz: 28f1428f645166759d57d55a9efee5777c6526e5fd25fd41372114d28418c603aeada747e6c8d00b79d0e6439382cdb7cd757d3f5e6a42902018414c0c47c88d

data/.gitignore

@@ -0,0 +1,3 @@
+.yardoc
+.*.swp
+coverage

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+carbonmu

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1
+  - rbx-2
+  - jruby-19mode
+services:
+  - mongodb
+addons:
+  code_climate:
+    repo_token: e3e4fc5da17ef3e332a5f62ce5a12d727ad472f367e41278df9d951b912cc748
+before_install:
+ - sudo apt-get install -qq libzmq3-dev

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,161 @@
+PATH
+  remote: .
+  specs:
+    carbonmu (0.0.1)
+      celluloid-io (~> 0.16.1)
+      celluloid-zmq (~> 0.16.0)
+      colorize (~> 0.7.3)
+      i18n (~> 0.7.0)
+      mongoid (~> 4.0.2)
+      multi_json (~> 1.9.2)
+      require_all (~> 1.3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    awesome_print (1.6.1)
+    bson (2.3.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    celluloid-io (0.16.2)
+      celluloid (>= 0.16.0)
+      nio4r (>= 1.1.0)
+    celluloid-zmq (0.16.0)
+      celluloid (>= 0.15.0)
+      ffi
+      ffi-rzmq
+    coderay (1.1.0)
+    colorize (0.7.5)
+    connection_pool (2.1.1)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    easy_translate (0.5.0)
+      json
+      thread
+      thread_safe
+    erubis (2.7.0)
+    fakefs (0.6.7)
+    ffi (1.9.6)
+    ffi-rzmq (2.0.4)
+      ffi-rzmq-core (>= 1.0.1)
+    ffi-rzmq-core (1.0.3)
+      ffi (~> 1.9)
+    formatador (0.2.5)
+    guard (2.12.4)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    highline (1.7.1)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    i18n-tasks (0.7.12)
+      activesupport
+      easy_translate (>= 0.5.0)
+      erubis
+      highline
+      i18n
+      slop (~> 3.5)
+      term-ansicolor
+      terminal-table
+    json (1.8.2)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.5.1)
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-rspec (2.1.0)
+      mongoid (~> 4.0.0)
+      rake
+      rspec (~> 3.1)
+    moped (2.0.4)
+      bson (~> 2.2)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    multi_json (1.9.3)
+    nenv (0.2.0)
+    nio4r (1.1.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    optionable (0.2.0)
+    origin (2.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    require_all (1.3.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    shellany (0.0.1)
+    slop (3.6.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    terminal-table (1.4.5)
+    thor (0.19.1)
+    thread (0.1.5)
+    thread_safe (0.3.4)
+    timecop (0.7.3)
+    timers (4.0.1)
+      hitimes
+    tins (1.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  carbonmu!
+  database_cleaner (~> 1.3.0)
+  fakefs
+  guard (~> 2.12.4)
+  guard-rspec (~> 4.5.0)
+  i18n-tasks (~> 0.7.12)
+  mongoid-rspec
+  pry
+  rake
+  rspec (~> 3.2.0)
+  timecop

data/Guardfile

@@ -0,0 +1,50 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Krajcar <allegro@conmolto.org>
+
+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 @@
+[![Join the chat at https://gitter.im/tkrajcar/carbonmu](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tkrajcar/carbonmu?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Stories in Ready](https://badge.waffle.io/tkrajcar/carbonmu.png?label=ready&title=Ready)](https://waffle.io/tkrajcar/carbonmu)
+[![Build Status](https://travis-ci.org/tkrajcar/carbonmu.png?branch=master)](https://travis-ci.org/tkrajcar/carbonmu)
+[![Code Climate](https://codeclimate.com/github/tkrajcar/carbonmu.png)](https://codeclimate.com/github/tkrajcar/carbonmu)
+
+# CarbonMU
+CarbonMU is a general-purpose, extendable MUD/MUSH server framework written in Ruby. It's designed to scale to thousands of players, handle a wide variety of game types, from classic hack-n-slash MUDs to innovative text-based social communities. **CarbonMU is not ready for public use by non-developers, but we welcome user contributions to help move the project along**.
+
+The remainder of this documentation is currently intended more as design documentation than how-tos.
+
+## Where to talk about CarbonMU
+
+* In the near future there will be an official CarbonMU support site running... CarbonMU. In the meantime, you can find me on M\*U\*S\*H (mush.pennmush.org 4201) as Rince.
+* Use [Gitter](https://gitter.im/tkrajcar/carbonmu), a nifty chat system that integrates with Github.
+
+## The road to 1.0
+
+See [this wiki page](https://github.com/tkrajcar/carbonmu/wiki/The-road-to-1.0) for the latest updates on what's on the todo list. You are more than welcome to get involved! Feel free to open issues with questions, join discussions, or ask if you need help finding a task suitable for your interest and skill level.
+
+## Architecture
+
+CarbonMU is powered by [Celluloid](https://celluloid.io/), an actor-based concurrency/multithreading framework, plus [ZeroMQ](http://zeromq.org/) for inter-process communication, and uses MongoDB (via [Mongoid](http://mongoid.org/)) to store all of its data. The framework is designed to support a variety of connections, including basic TCP telnet, SSL telnet, and JSON over HTTP, API-style.
+
+It's also intended to use a highly plugin-based model. A typical CarbonMU game will probably consist of the carbonmu core gem (what you see here), some number of community-supported third-party gems to provide things like a bboard system and other common utilities, and some game-specific custom code. It will not include a scripting engine or "softcode"-type functionality.
+
+Internally, CarbonMU looks like this:
+
+![architecture diagram](https://raw.githubusercontent.com/tkrajcar/carbonmu/master/doc/architecture.png)
+
+The `EdgeRouter` and `Server` are separate actors. The `Server` can be therefore be restarted to load new game code without dropping TCP connections.
+
+## Game objects
+
+There are four built-in descendants of `GameObject` in core (modules may choose to add their own).
+They are:
+
+* `Room`, which mixes in `Container` so it can have contents
+* `Thing`, something tangible that is in one and only one room (mixes in `Movable`), and also can have contents (is a `Container`)
+* `Player`, similar to `Thing` except can be logged into, and will support more interactions (i.e. you can send in-game mail to a `Player`, but not a `Thing`). Includes `Movable` and `Container`.
+* `Exit`, a connection between two `Room`s.
+
+All of these are stored in MongoDB in the `game_objects` collection.
+
+## Other data
+
+Of course, MU*s need a lot more data than just things that can be interacted with. There'll be things like bboard messages, mail, and thousands of other things games will want to add for their custom needs. Plugins are welcome to declare their own classes that inherit `Mongoid::Document`, and can even reference the `GameObject` descendants. There's no need to create 'data objects' and store them there.
+
+## Commands
+
+Defining a new command is done by subclassing Command, adding one or more `syntax` calls using regular expressions with named captures for parameters, and providing an `execute` model that receives a `@params` hash with its named captures and a [CommandContext](https://github.com/tkrajcar/carbonmu/blob/master/lib/core/command_context.rb) instance in `@context`. See [lib/commands](https://github.com/tkrajcar/carbonmu/tree/master/lib/commands) for examples. This will continue to be fleshed out.
+
+## Events
+
+We will use a pubsub model (not yet implemented) to allow for both core functionality and people's gems to provide behavior when game events occur, as well as register their own events too.
+
+## Building external plugins/modules/gems
+
+This needs to be documented in detail once an example is done.
+
+## Internationalization
+
+CarbonMU will have full i18n support on a per-player basis, allowing each player to see game messages in their own locales (of course, chat messages and so on will not be auto-translated).
+
+## Supported Rubies
+
+CarbonMU is supported on Ruby 2.0.x or newer, JRuby (latest release), and Rubinius (latest release). Using JRuby or Rubinius will allow your game to be multi-threaded.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Run I18n specs (check for missing & unused keys)."
+RSpec::Core::RakeTask.new('spec:i18n') do |task|
+  task.rspec_opts = "--tag i18n"
+end

data/carbonmu.gemspec

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "version"
+
+Gem::Specification.new do |s|
+  s.name     = "carbonmu"
+  s.version  = CarbonMU::VERSION.dup
+  s.required_ruby_version = ">= 2.0.0"
+  s.date     = Time.now.strftime('%Y-%m-%d')
+  s.summary  = "CarbonMU is a general-purpose, extendable MUD/MUSH server written in Ruby."
+  s.email    = "allegro@conmolto.org"
+  s.homepage = "http://github.com/tkrajcar/carbonmu"
+  s.authors  = ['Tim Krajcar']
+  s.licenses = ['MIT']
+
+  s.description = <<-EOF
+CarbonMU is a general-purpose, extendable MUD/MUSH server written in Ruby. CarbonMU is still
+under active development and not yet ready for general use.
+EOF
+
+  s.add_dependency "celluloid-io", "~> 0.16.1"
+  s.add_dependency "require_all", "~> 1.3.2"
+  s.add_dependency "multi_json", "~> 1.9.2"
+  s.add_dependency "celluloid-zmq", "~> 0.16.0"
+  s.add_dependency "colorize", "~> 0.7.3"
+  s.add_dependency "mongoid", "~> 4.0.2"
+  s.add_dependency "i18n", "~> 0.7.0"
+
+  s.add_development_dependency "awesome_print"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "guard", "~> 2.12.4"
+  s.add_development_dependency "guard-rspec", "~> 4.5.0"
+  s.add_development_dependency "mongoid-rspec"
+  s.add_development_dependency "rspec", "~> 3.2.0"
+  s.add_development_dependency "timecop"
+  s.add_development_dependency "database_cleaner", "~> 1.3.0"
+  s.add_development_dependency "i18n-tasks", "~> 0.7.12"
+  s.add_development_dependency "fakefs"
+
+  dependencies = [
+    # Examples:
+    # [:runtime,     "rack",  "~> 1.1"],
+    # [:development, "rspec", "~> 2.1"],
+  ]
+
+  s.files         = `git ls-files`.split
+  s.test_files    = Dir['spec/**/*']
+  #s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  ## Make sure you can build the s.add_dependency on older versions of RubyGems too:
+  s.rubygems_version = "2.2.2"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

data/config/i18n-tasks.yml

@@ -0,0 +1,89 @@
+# i18n-tasks finds and manages missing and unused translations https://github.com/glebm/i18n-tasks
+
+base_locale: en
+## i18n-tasks detects locales automatically from the existing locale files
+## uncomment to set locales explicitly
+# locales: [en, es, fr]
+
+## i18n-tasks report locale, default: en, available: en, ru
+# internal_locale: ru
+
+# Read and write locale data
+data:
+  ## by default, translation data are read from the file system, or you can provide a custom data adapter
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files to read from
+  read:
+    - config/locales/%{locale}.yml
+    # - config/locales/*.%{locale}.yml
+    # - config/locales/**/*.%{locale}.yml
+
+  # key => file routes, matched top to bottom
+  write:
+    ## E.g., write devise and simple form keys to their respective files
+    # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    # Catch-all
+    - config/locales/%{locale}.yml
+    # `i18n-tasks normalize -p` will force move the keys according to these rules
+
+  # YAML / JSON serializer options, passed to load / dump / parse / serialize
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+  json:
+    write:
+      # pretty print JSON
+      indent: '  '
+      space: ' '
+      object_nl: "\n"
+      array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Default scanner finds t() and I18n.t() calls
+  # scanner: I18n::Tasks::Scanners::PatternWithScopeScanner
+
+  ## Paths to search in, passed to File.find
+  paths:
+    - app/
+
+  ## Root for resolving relative keys (default)
+  # relative_roots:
+  #   - app/views
+
+  ## File.fnmatch patterns to exclude from search (default)
+  # exclude: ["*.jpg", "*.png", "*.gif", "*.svg", "*.ico", "*.eot", "*.ttf", "*.woff", "*.pdf"]
+
+  ## Or, File.fnmatch patterns to include
+  # include: ["*.rb", "*.html.slim"]
+
+## Google Translate
+# translation:
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   api_key: "AbC-dEf5"
+
+## Consider these keys not missing
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used
+# ignore_unused:
+# - 'activerecord.attributes.*'
+# - '{devise,kaminari,will_paginate}.*'
+# - 'simple_form.{yes,no}'
+# - 'simple_form.{placeholders,hints,labels}.*'
+# - 'simple_form.{error_notification,required}.:'
+
+## Exclude these keys from `i18n-tasks eq-base' report
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Exclude these keys from all of the reports
+# ignore:
+#  - kaminari.*