rpg_level 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d6393c8eb999df0a66181c29c1f452a5e7f2ca4
+  data.tar.gz: e295f159f00c5aa3511cc883df91693604eacee7
+SHA512:
+  metadata.gz: a5be1a3636a6ab3f719337873b4a6c96fe90af51aaa86cf98392f617702a9959615f4115fd04bb7f5e5973006c57f8b0906cd5e971000eb016fb3cd9d96088f9
+  data.tar.gz: 00dbb2cdb25ce691d49a82578a613004a505ebc2d4e39bb2fc36591aff51a3ec4190d4a981366629199f28f09869444f4e38ed3e7b6cc9de83d60dc901b6747f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kjirou.web@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kjirou
+
+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,63 @@
+# RpgLevel
+
+[![Build Status](https://travis-ci.org/kjirou/ruby-rpg_level.svg?branch=master)](https://travis-ci.org/kjirou/ruby-rpg_level)
+
+Manage the [Level/EXP](http://gaming.wikia.com/wiki/Level_(RPG))
+  that is known as the most commonly growth system of role-playing games.
+
+
+## Feature
+
+The feature of this module has been aggregated into the following formula:
+
+```ruby
+level = formula_of_exp_table(exp)
+```
+
+This design has been often used in the classic RPGs, such as "Wizardry", "D&D", "Rouge-like", ..etc.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rpg_level'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rpg_level
+
+
+## Example
+
+```ruby
+require 'rpg_level'
+
+rpg_level = RpgLevel.new
+
+# Define EXP Table by formula
+#
+#   Lv1 = 0
+#   Lv2 = 4
+#   Lv3 = 6  (Total = 10)
+#   Lv4 = 8  (Total = 18)
+#   Lv5 = 10 (Total = 28)
+#
+rpg_level.define_exp_table(5) {|data| data[:level] * 2}
+
+# Obtain 12 experience points
+# It also means that leveling up at the same time
+rpg_level.obtain_exp(12)
+
+# Get current level
+p(rpg_level.level)  # => 3
+
+# Get more information
+p(rpg_level.level_status)  # => {:level=>3, :next_necessary_exp=>8, :lacking_exp_for_next=>6, :obtained_exp_for_next=>2}
+```

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

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rpg_level"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rpg_level.rb

@@ -0,0 +1,239 @@
+require 'rpg_level/version'
+
+class RpgLevel
+  CLEARED_CACHED_CURRENT_LEVEL_STATUS = nil
+
+  attr_reader(:exp, :min_level, :necessary_exps)
+
+  def initialize(min_level: 1)
+    @exp = 0
+    @min_level = min_level
+    # Necessary exps from the @min_level
+    @necessary_exps = []
+    # A cache of the #generate_status_of_current_level calculation
+    # It is too heavy for access to #level_status like a static value
+    @cached_current_level_status = CLEARED_CACHED_CURRENT_LEVEL_STATUS
+  end
+
+  def define_exp_table_from_array(necessary_exps)
+    necessary_exps.each do |v|
+      raise ArgumentError.new('some of necessary_exps are not a integer') unless v.is_a?(Integer)
+      raise ArgumentError.new('some of necessary_exps are less than 0') if v < 0
+    end
+
+    @necessary_exps = necessary_exps
+    @necessary_exps.freeze
+  end
+
+  def define_exp_table(max_level)
+    raise ArgumentError.new('max_level is less than min_level') if max_level < @min_level
+    raise ArgumentError unless block_given?
+    # TODO: How to convert the block to a proc?
+    necessary_exps = generate_necessary_exps(max_level) {|info| yield(info)}
+    define_exp_table_from_array(necessary_exps)
+  end
+
+  def max_level
+    @min_level + @necessary_exps.length
+  end
+
+  def is_allowed_level?(level)
+    level.between?(@min_level, max_level)
+  end
+
+  def find_necessary_exp_by_level(level)
+    return nil unless is_allowed_level?(level)
+    return 0 if level == @min_level
+    @necessary_exps[level - @min_level - 1]
+  end
+
+  def calculate_total_necessary_exp(from_level, to_level)
+    raise ArgumentError.new('from_level is greater than to_level') if from_level > to_level
+    raise ArgumentError.new('from_level is out of range') unless is_allowed_level?(from_level)
+    raise ArgumentError.new('to_level is out of range') unless is_allowed_level?(to_level)
+
+    (from_level..to_level).inject(0) do |result, level|
+      result + find_necessary_exp_by_level(level)
+    end
+  end
+
+  def max_exp
+    calculate_total_necessary_exp(@min_level, max_level)
+  end
+
+  def level_status
+    @cached_current_level_status = generate_status_of_current_level() unless @cached_current_level_status
+    @cached_current_level_status.dup
+  end
+
+  def level
+    level_status[:level]
+  end
+
+  def is_reached_max_level?
+    level == max_level
+  end
+
+  def alter_exp(exp_delta)
+    raise ArgumentError.new('exp_delta is not a integer') unless exp_delta.is_a?(Integer)
+    before_exp = @exp
+    change_exp_result = change_exp(@exp + exp_delta)
+    self.class.generate_exp_change_result(
+      before_exp, @exp, change_exp_result[:before_level], change_exp_result[:after_level])
+  end
+
+  def obtain_exp(increase_of_exp)
+    raise ArgumentError.new('increase_of_exp is less than 0') if increase_of_exp < 0
+    alter_exp(increase_of_exp)
+  end
+
+  def drain_exp(decrease_of_exp)
+    raise ArgumentError.new('decrease_of_exp is less than 0') if decrease_of_exp < 0
+    alter_exp(-decrease_of_exp)
+  end
+
+  def clear_exp
+    change_exp(0)
+    nil
+  end
+
+  # fraction_mode
+  #   :omitted
+  #     ex ) Lv3(15/20) + Lv1 => Lv4( 0/25) - As a Rogue-like games
+  #   :inherited
+  #     ex1) Lv3(15/20) + Lv1 => Lv4(15/25)
+  #     ex2) Lv3(15/20) + Lv1 => Lv4(14/15)
+  def obtain_exp_by_level(increase_of_level, fraction_mode)
+    raise ArgumentError.new('increase_of_level is not a integer') unless increase_of_level.is_a?(Integer)
+    raise ArgumentError.new('increase_of_level is less than 0') if increase_of_level < 0
+    raise ArgumentError.new('fraction_mode is invalid') unless [:omitted, :inherited].include?(fraction_mode)
+
+    from_level = level
+    to_level = cut_level_into_valid_range(from_level + increase_of_level)
+
+    exp_delta = case fraction_mode
+    when :omitted then
+      calculate_total_necessary_exp(min_level, to_level) - @exp
+    when :inherited then
+      next_necessary_exp_after_leveling_up = find_necessary_exp_by_level(to_level + 1)
+      inherited_fraction_exp = if next_necessary_exp_after_leveling_up
+        [level_status[:obtained_exp_for_next], next_necessary_exp_after_leveling_up - 1].min
+      else
+        0
+      end
+      calculate_total_necessary_exp(min_level, to_level) + inherited_fraction_exp - @exp
+    end
+
+    alter_exp(exp_delta)
+  end
+
+  # fraction_mode
+  #   :omitted
+  #     ex) Lv3(15/20) - Lv1 => Lv2( 0/10) - As a Wiz-like games
+  #   :full
+  #     ex) Lv3(15/20) - Lv1 => Lv2(14/15) - As a Rogue-like games
+  def drain_exp_by_level(decrease_of_level, fraction_mode)
+    raise ArgumentError.new('decrease_of_level is not a integer') unless decrease_of_level.is_a?(Integer)
+    raise ArgumentError.new('decrease_of_level is less than 0') if decrease_of_level < 0
+    raise ArgumentError.new('fraction_mode is invalid') unless [:omitted, :full].include?(fraction_mode)
+
+    from_level = level
+    to_level = cut_level_into_valid_range(from_level - decrease_of_level)
+
+    exp_delta = case fraction_mode
+    when :omitted then
+      calculate_total_necessary_exp(min_level, to_level) - @exp
+    when :full then
+      to_level = [to_level + 1, from_level].min
+      calculate_total_necessary_exp(min_level, to_level) - @exp - 1
+    end
+
+    alter_exp(exp_delta)
+  end
+
+  private
+
+  def self.generate_exp_change_result(before_exp, after_exp, before_level, after_level)
+    {
+      before_exp: before_exp,
+      after_exp: after_exp,
+      exp_delta: after_exp - before_exp,
+      before_level: before_level,
+      after_level: after_level,
+      level_delta: after_level - before_level,
+      is_leveling_up: after_level > before_level,
+      is_leveling_down: after_level < before_level
+    }
+  end
+
+  def generate_necessary_exps(max_level)
+    generated_exps = []
+    memo = {}
+
+    ((@min_level + 1)..max_level).map do |level|
+      exp = yield({
+        level: level,
+        min_level: @min_level,
+        max_level: max_level,
+        generated_exps: generated_exps,
+        memo: memo
+      })
+      generated_exps << exp
+      exp
+    end
+  end
+
+  def guess_level_from_necessary_exps_index(index)
+    @min_level + index + 1
+  end
+
+  def generate_status_of_current_level
+    current_level = @min_level
+    next_necessary_exp = nil
+    total_necessary_exp = 0
+    obtained_exp_for_next = nil
+    lacking_exp_for_next = nil
+
+    @necessary_exps.each_with_index do |necessary_exp, index|
+      total_necessary_exp += necessary_exp
+
+      if @exp < total_necessary_exp
+        next_necessary_exp = necessary_exp
+        lacking_exp_for_next = total_necessary_exp - @exp
+        obtained_exp_for_next = next_necessary_exp - lacking_exp_for_next
+        break
+      end
+
+      current_level = guess_level_from_necessary_exps_index(index)
+    end
+
+    {
+      level: current_level,
+      next_necessary_exp: next_necessary_exp,
+      lacking_exp_for_next: lacking_exp_for_next,
+      obtained_exp_for_next: obtained_exp_for_next
+    }
+  end
+
+  def clear_cached_current_level_status
+    @cached_current_level_status = CLEARED_CACHED_CURRENT_LEVEL_STATUS
+  end
+
+  def cut_exp_into_valid_range(suggested_exp)
+    [[suggested_exp, max_exp].min, 0].max
+  end
+
+  def change_exp(exp)
+    before_level = level
+    @exp = cut_exp_into_valid_range(exp)
+    clear_cached_current_level_status
+    {
+      before_level: before_level,
+      after_level: level
+    }
+  end
+
+  def cut_level_into_valid_range(suggested_level)
+    [[suggested_level, max_level].min, @min_level].max
+  end
+end

data/lib/rpg_level/version.rb

@@ -0,0 +1,3 @@
+class RpgLevel
+  VERSION = "0.1.0"
+end

data/rpg_level.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rpg_level/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rpg_level"
+  spec.version       = RpgLevel::VERSION
+  spec.authors       = ["kjirou"]
+  spec.email         = ["sorenariblog@gmail.com"]
+
+  spec.summary       = 'A Level/EXP manager for RPGs.'
+  spec.description   = 'Manage the Level/EXP that is known as the most commonly growth system of role-playing games.'
+  spec.homepage      = 'https://github.com/kjirou/ruby-rpg_level'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rpg_level
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kjirou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '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'
+description: Manage the Level/EXP that is known as the most commonly growth system
+  of role-playing games.
+email:
+- sorenariblog@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rpg_level.rb
+- lib/rpg_level/version.rb
+- rpg_level.gemspec
+homepage: https://github.com/kjirou/ruby-rpg_level
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Level/EXP manager for RPGs.
+test_files: []