mooncell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7174d01ad8172d3b5d85027c3eec815c283d259c5074e0275866d771eb114b94
+  data.tar.gz: e27a4aec091dcc1f904eedd137c258043f1437bbcc4b255fcb7b48c8c9a8ecfa
+SHA512:
+  metadata.gz: 1b34eded1a484213af4a5165432ff6a6b951d6a7c0b389e3da3767626f8608a02b9f121efe5d5b820be361cb44d6c8bc2238c71463b8f5628df2fbdabccad7a2
+  data.tar.gz: 58be9c2e38e8aa483b8d5626426e3607beafd3ea9df0c73283cb8b9ed3a3515d8edd760d79e016f29a6d6c810696cf292fe570ebcdc02dbdc42e97e65e172ef9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ctags
+tags
+
+Gemfile.lock

data/.overcommit.yml

@@ -0,0 +1,32 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  AuthorName:
+    enabled: false
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+  BundleAudit:
+    enabled: true
+
+PostCheckout:
+  ALL: # Special hook name that customizes all hooks of this type
+    quiet: true # Change all post-checkout hooks to only display output on failure
+
+  IndexTags:
+    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at elct9620@frost.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mooncell.gemspec
+gemspec
+
+gem 'pry'

data/README.md

@@ -0,0 +1,138 @@
+Mooncell
+===
+
+The **Mooncell** is a Domain-Driven Design online game server framework inspired by [Hanami.rb](https://hanamirb.org/).
+
+An online game usually includes one or more servers but it is hard to share the codebase and support multiple protocols.
+
+Mooncell split game logic to `libs` and allow shared with other projects, and allow the developer to implement behaviors inside `apps` between servers.
+
+## Concept
+
+Currently, Mooncell still under design. Below is the core concept to implement servers with it.
+
+### Structure
+
+This is a Map server implements a move command.
+
+```
+├── Gemfile
+├── Gemfile.lock
+├── apps
+│   └── map
+│       ├── application.rb
+│       ├── commands
+│       │   └── move.rb
+│       ├── config
+│       │   └── routes.rb
+│       └── responds
+│           └── move.rb
+└── config
+    └── environment.rb
+```
+
+### Environment
+
+It defines the shared environment and servers to loaded.
+
+```ruby
+# frozen_string_literal: true
+
+require 'mooncell/protocol/websocket'
+
+require_relative '../apps/map/application'
+
+Mooncell.configure do
+  protocol :websocket
+
+  app Map::Application
+end
+```
+
+### Routes
+
+It defines the command available on the server.
+
+```ruby
+# frozen_string_literal: true
+
+command 'move', 'Map::Commands::Move'
+```
+
+### Command
+
+Process the command received from the client.
+
+```ruby
+# frozen_string_literal: true
+
+module Map
+  module Commands
+    class Move
+      include Mooncell::Command
+
+      # Fake Model
+      Player = Struct.new(:id, :x, :y)
+
+      # Expose to respond
+      expose :player
+
+      def call(params)
+        @player = Player.new(params['id'], params['x'], params['y'])
+      end
+    end
+  end
+end
+```
+
+### Respond
+
+Return the process result to client.
+
+```ruby
+# frozen_string_literal: true
+
+module Map
+  module Responds
+    class Move
+      include Mooncell::Respond
+
+      # Broadcast to all clients
+      broadcast true
+
+      def call(*)
+        { id: player.id, x: player.x, y: player.y }
+      end
+    end
+  end
+end
+```
+
+## Installation
+
+> TODO
+
+## Usage
+
+> TODO
+
+## Development
+
+> TODO
+
+## Roadmap
+
+The first target is to design the architecture to support TCP/WebSocket protocol and allow use JSON or customize serializer.
+
+* [ ] Naming
+* [ ] Project Generator
+
+> TBD
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/mooncell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Mooncell project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elct9620/mooncell/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/mooncell

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler'
+require 'mooncell/cli/commands'
+
+Mooncell::CLI.new.call

data/lib/mooncell.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'mooncell/version'
+
+# A online game server framework for Ruby
+#
+# @since 0.1.0
+module Mooncell
+  require 'mooncell/command'
+  require 'mooncell/respond'
+  require 'mooncell/entity'
+  require 'mooncell/protocol'
+
+  require 'mooncell/loader'
+  require 'mooncell/environment'
+  require 'mooncell/configuration'
+  require 'mooncell/connection'
+  require 'mooncell/connection_pool'
+
+  require 'mooncell/application'
+
+  # @since 0.1.0
+  # @api private
+  @_mutex = Mutex.new
+
+  # Return current environment
+  #
+  # @return [String] the current environment
+  #
+  # @since 0.3.1
+  #
+  # @see Mooncell::Environment#environment
+  #
+  # @example
+  #   Mooncell.env => "development"
+  def self.env
+    environment.environment
+  end
+
+  # Return application root
+  #
+  # @since 0.1.0
+  def self.root
+    environment.root
+  end
+
+  # Configure the Mooncell
+  #
+  # @param block [Proc] the configuration block
+  #
+  # @since 0.1.0
+  #
+  # @example
+  #   # config/environment.rb
+  #
+  #   # ...
+  #
+  #   Mooncell.configure do
+  #     protocol :websocket
+  #   end
+  def self.configure(&block)
+    @_mutex.synchronize do
+      @_configuration = Mooncell::Configuration.new(&block)
+    end
+  end
+
+  # Mooncell Configuration
+  #
+  # @return [Mooncell::Configuration] the configuration
+  #
+  # @see Mooncell.configure
+  #
+  # @since 0.1.0
+  # @api private
+  def self.configuration
+    @_mutex.synchronize do
+      raise 'Mooncell not configured' unless defined?(@_configuration)
+
+      @_configuration
+    end
+  end
+
+  # Current environment
+  #
+  # @return [Mooncell::Environment] environment
+  #
+  # @since 0.1.0
+  # @api private
+  def self.environment
+    @environment ||= Environment.new
+  end
+
+  # Check if enable code reloading
+  #
+  # @return [TrueClass,FalseClass] the result of check
+  #
+  # @since 0.1.0
+  # @api private
+  def self.code_reloading?
+    environment.code_reloading?
+  end
+end

data/lib/mooncell/application.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'mooncell/application_configuration'
+require 'mooncell/router'
+
+module Mooncell
+  # Mooncell Application
+  #
+  # @since 0.1.0
+  # @api private
+  class Application
+    # @since 0.1.0
+    # @api private
+    def self.inherited(base)
+      super
+      base.extend ClassMethods
+    end
+
+    # @since 0.1.0
+    # @api private
+    module ClassMethods
+      # @since 0.1.0
+      # @api private
+      def self.extended(base)
+        super
+        base.class_eval do
+          @_lock = Mutex.new
+
+          class << self
+            # @since 0.1.0
+            # @api private
+            attr_reader :configuration
+          end
+        end
+      end
+
+      # Application name
+      #
+      # @return [String] the application name
+      #
+      # @since 0.1.0
+      # @api private
+      def app_name
+        @app_name ||=
+          name.split('::').first.downcase
+      end
+
+      # Configure the application
+      #
+      # TODO: Support specify by environment
+      #
+      # @param block [Proc] the configuration block
+      #
+      # @since 0.1.0
+      # @api private
+      def configure(&block)
+        @_lock.synchronize do
+          @configuration = ApplicationConfiguration.new(&block)
+        end
+      end
+    end
+
+    # @since 0.1.0
+    # @api private
+    attr_reader :pool, :router
+
+    # Create application instance
+    #
+    # @since 0.1.0
+    # @api private
+    def initialize
+      @pool = ConnectionPool.new
+      @router = Router.new(self)
+
+      # TODO: Add support to reload router
+      setup_router
+    end
+
+    # Run application
+    #
+    # @since 0.1.0
+    # @api private
+    def call(*)
+      protocol = Protocol.get(configuration.protocol)
+      protocol.new(self).start
+    end
+
+    # Return the application configuration
+    #
+    # @return [Mooncell::ApplicationConfiguration] application configuration
+    #
+    # @see Application.configuration
+    #
+    # @since 0.1.0
+    # @api private
+    def configuration
+      self.class.configuration
+    end
+
+    private
+
+    # @since 0.1.0
+    # @api private
+    def setup_router
+      path =
+        Mooncell
+        .environment
+        .apps_path
+        .join(self.class.app_name, 'config', 'routes.rb')
+      code = File.open(path, 'rb:bom|utf-8', &:read)
+      @router.load(code)
+    end
+  end
+end