gosu_notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a443fe622fac7958ecc6218e2f049f9f9925aa9d4de33ee6c5ee10467efad52
+  data.tar.gz: bcee1f7c47b77bc95515106e72e2206b8136052a4cf1f547d228d7eb2e71ad08
+SHA512:
+  metadata.gz: eac68c7a6ef62ea9f66fa5c879fed59b2ef0365301c2d2719dc78de6975c030aee47cb2961c215bb928d424ec4b7b0b3a361d063977fa616ad3417253e15e73b
+  data.tar.gz: a236213ac2242b63a3ae3ecb59bf8825f797c58b2f71b4035bcaf6d1c6ce7950aa635299e052c1b3667f821dd291ba469c4ee8cda0d82a1ecb1303520a2eaa72

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gosu_notifications.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 cyberarm
+
+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 @@
+# GosuNotifications
+
+A simple notifications system for Gosu
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "gosu_notifications"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gosu_notifications
+
+## Usage
+
+```ruby
+require "gosu"
+require "gosu_notifications"
+
+class Window < Gosu::Window
+  def initialize
+    super 640, 480, false
+
+    @notification_manager = GosuNotifications::NotificationManager.new(window: self)
+  end
+
+  def draw
+    @notification_manager.draw
+  end
+
+  def update
+    @notification_manager.update
+  end
+
+  def button_down(id)
+    @notification_manager.create_notification(
+        title: "A Button Has Been Pressed",
+        tagline: "#{id}"
+    )
+  end
+end
+
+Window.new.show
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gosu_notifications.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gosu_notifications"
+
+# 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(__FILE__)

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/examples/demo.rb

@@ -0,0 +1,78 @@
+require "gosu"
+require "gosu_notifications"
+
+class Window < Gosu::Window
+  def initialize
+    super 640, 480, false
+    self.caption = "Gosu Notifications Demo"
+
+    @notification_manager = GosuNotifications::Manager.new(window: self, max_visible: 5)
+    @notification_manager_mouse = GosuNotifications::Manager.new(edge: :bottom, mode: GosuNotifications::Manager::MODE_CIRCLE, window: self, max_visible: 1)
+    @font = Gosu::Font.new(22)
+    @text = "Press a Button"
+
+    @icon = generate_icon
+  end
+
+  def draw
+    @font.draw_text(@text, width / 2 - @font.text_width(@text) / 2, height / 2 - @font.height / 2, 0)
+    @notification_manager.draw
+    @notification_manager_mouse.draw
+  end
+
+  def update
+    @notification_manager.update
+    @notification_manager_mouse.update
+  end
+
+  def needs_cursor?
+    true
+  end
+
+  def button_down(id)
+    if [ Gosu::MS_LEFT, Gosu::MS_MIDDLE, Gosu::MS_RIGHT ].include?(id)
+      @notification_manager_mouse.create_notification(
+        priority: GosuNotifications::Notification::PRIORITY_HIGH,
+        title: "Mouse Button Pressed",
+
+        tagline: "Gosu::#{button_id_to_constant(id)} -> #{id}",
+        transition_duration: 1_000,
+        time_to_live: 500,
+        edge_color: 0xaaff8844,
+        background_color: 0xaa884422,
+        title_color: 0xaaf8fffef,
+        tagline_color: 0xaae4e4e4,
+        icon: @icon,
+    )
+    else
+      @notification_manager.create_notification(
+          priority: GosuNotifications::Notification::PRIORITY_HIGH,
+          title: "A Button Has Been Pressed",
+          tagline: "Gosu::#{button_id_to_constant(id)} -> #{id}",
+          transition_duration: 1_000,
+          time_to_live: 500,
+          edge_color: 0xaaffff88,
+          background_color: 0xaa222f2f
+      )
+    end
+  end
+
+  def generate_icon
+    Gosu.render(64, 64) do
+      Gosu.rotate(45, 32, 32) do
+        Gosu.draw_rect(16, 16, 64 - 32, 64 - 32, 0xff008855)
+        Gosu.draw_rect(30, 0, 4, 64, 0xffffffff)
+      end
+    end
+  end
+
+  def button_id_to_constant(id)
+    Gosu.constants.each do |constant|
+      if Gosu.const_get(constant) == id
+        return constant
+      end
+    end
+  end
+end
+
+Window.new.show

data/gosu_notifications.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/gosu_notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gosu_notifications"
+  spec.version       = GosuNotifications::VERSION
+  spec.authors       = ["cyberarm"]
+  spec.email         = ["matthewlikesrobots@gmail.com"]
+
+  spec.summary       = "A simple notifications system for Gosu"
+  spec.description   = "A simple notifications system for Gosu  "
+  spec.homepage      = "https://github.com/cyberarm/gosu_notifications"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/gosu_notifications.rb

@@ -0,0 +1,3 @@
+require_relative "gosu_notifications/version"
+require_relative "gosu_notifications/notification_manager"
+require_relative "gosu_notifications/notification"

data/lib/gosu_notifications/notification.rb

@@ -0,0 +1,83 @@
+module GosuNotifications
+  class Notification
+    WIDTH = 500
+    HEIGHT = 64
+    EDGE_WIDTH = 8
+    TRANSITION_DURATION = 750
+    PADDING = 8
+
+    TTL_LONG   = 5_000
+    TTL_MEDIUM = 3_250
+    TTL_SHORT  = 1_500
+    TIME_TO_LIVE = TTL_MEDIUM
+
+    BACKGROUND_COLOR = Gosu::Color.new(0xaa313533)
+    EDGE_COLOR    = Gosu::Color.new(0xaa010101)
+    ICON_COLOR    = Gosu::Color.new(0xddffffff)
+    TITLE_COLOR   = Gosu::Color.new(0xddffffff)
+    TAGLINE_COLOR = Gosu::Color.new(0xddaaaaaa)
+
+    TITLE_SIZE = 28
+    TAGLINE_SIZE = 18
+    ICON_SIZE = HEIGHT - PADDING * 2
+
+    TITLE_FONT = Gosu::Font.new(TITLE_SIZE, bold: true)
+    TAGLINE_FONT = Gosu::Font.new(TAGLINE_SIZE)
+
+    PRIORITY_HIGH   = 1.0
+    PRIORITY_MEDIUM = 0.5
+    PRIORITY_LOW    = 0.0
+
+    LINEAR_TRANSITION = :linear
+    EASE_IN_OUT_TRANSITION = :ease_in_out
+
+    attr_reader :priority, :title, :tagline, :icon, :time_to_live, :transition_duration, :transition_type
+    def initialize(
+      host:, priority:, title:, title_color: TITLE_COLOR, tagline: "", tagline_color: TAGLINE_COLOR, icon: nil, icon_color: ICON_COLOR,
+      edge_color: EDGE_COLOR, background_color: BACKGROUND_COLOR, time_to_live: TIME_TO_LIVE, transition_duration: TRANSITION_DURATION,
+      transition_type: EASE_IN_OUT_TRANSITION
+    )
+      @host = host
+
+      @priority = priority
+      @title = title
+      @title_color = title_color
+      @tagline = tagline
+      @tagline_color = tagline_color
+      @icon = icon
+      @icon_color = icon_color
+      @edge_color = edge_color
+      @background_color = background_color
+      @time_to_live = time_to_live
+      @transition_duration = transition_duration
+      @transition_type = transition_type
+
+      @icon_scale = ICON_SIZE.to_f / @icon.width if @icon
+    end
+
+    def draw
+      Gosu.draw_rect(0, 0, WIDTH, HEIGHT, @background_color)
+
+      if @host.edge == :top
+        Gosu.draw_rect(0, HEIGHT - EDGE_WIDTH, WIDTH, EDGE_WIDTH, @edge_color)
+        @icon.draw(EDGE_WIDTH + PADDING, PADDING, 0, @icon_scale, @icon_scale, @icon_color) if @icon
+
+      elsif @host.edge == :bottom
+        Gosu.draw_rect(0, 0, WIDTH, EDGE_WIDTH, @edge_color)
+        @icon.draw(EDGE_WIDTH + PADDING, PADDING, 0, @icon_scale, @icon_scale, @icon_color) if @icon
+
+      elsif @host.edge == :right
+        Gosu.draw_rect(0, 0, EDGE_WIDTH, HEIGHT, @edge_color)
+        @icon.draw(EDGE_WIDTH + PADDING, PADDING, 0, @icon_scale, @icon_scale, @icon_color) if @icon
+
+      else
+        Gosu.draw_rect(WIDTH - EDGE_WIDTH, 0, EDGE_WIDTH, HEIGHT, @edge_color)
+        @icon.draw(PADDING, PADDING, 0, @icon_scale, @icon_scale, @icon_color) if @icon
+      end
+
+      icon_space = @icon ? ICON_SIZE + PADDING : 0
+      TITLE_FONT.draw_text(@title, PADDING + EDGE_WIDTH + icon_space, PADDING, 0, 1, 1, @title_color)
+      TAGLINE_FONT.draw_text(@tagline, PADDING + EDGE_WIDTH + icon_space, PADDING + TITLE_FONT.height, 0, 1, 1, @tagline_color)
+    end
+  end
+end

data/lib/gosu_notifications/notification_manager.rb

@@ -0,0 +1,242 @@
+module GosuNotifications
+  class NotificationManager
+    EDGE_TOP = :top
+    EDGE_BOTTOM = :bottom
+    EDGE_RIGHT = :right
+    EDGE_LEFT = :left
+
+    MODE_DEFAULT = :slide
+    MODE_CIRCLE  = :circle
+
+    attr_reader :edge, :mode, :max_visible, :notifications
+    def initialize(edge: EDGE_RIGHT, mode: MODE_DEFAULT, window:, max_visible: 1)
+      @edge = edge
+      @mode = mode
+      @window = window
+      @max_visible = max_visible
+
+      @notifications = []
+      @drivers = []
+      @slots = Array.new(max_visible, nil)
+    end
+
+    def draw
+      @drivers.each do |driver|
+        case @edge
+        when :left, :right
+          x = @edge == :right ? @window.width + driver.x : -Notification::WIDTH + driver.x
+          y = driver.y + Notification::HEIGHT / 2
+
+          Gosu.translate(x, y + (Notification::HEIGHT + Notification::PADDING) * driver.slot) do
+            driver.draw
+          end
+
+        when :top, :bottom
+          x = @window.width / 2 - Notification::WIDTH / 2
+          y = @edge == :top ? driver.y - Notification::HEIGHT : @window.height + driver.y
+          slot_position = (Notification::HEIGHT + Notification::PADDING) * driver.slot
+          slot_position *= -1 if @edge == :bottom
+
+          Gosu.translate(x, y + slot_position) do
+            driver.draw
+          end
+        end
+      end
+    end
+
+    def update
+      show_next_notification if @drivers.size < @max_visible
+      @drivers.each do |driver|
+        if driver.done?
+          @slots[driver.slot] = nil
+          @drivers.delete(driver)
+        end
+      end
+
+      @drivers.each(&:update)
+    end
+
+    def show_next_notification
+      notification = @notifications.sort { |n| n.priority }.reverse.shift
+      return unless notification
+      return if available_slot_index < lowest_used_slot
+      @notifications.delete(notification)
+
+      @drivers << Driver.new(edge: @edge, mode: @mode, notification: notification, slot: available_slot_index)
+      slot = @slots[available_slot_index] = @drivers.last
+    end
+
+    def available_slot_index
+      @slots.each_with_index do |slot, i|
+        return i unless slot
+      end
+
+      return -1
+    end
+
+    def lowest_used_slot
+      @slots.each_with_index do |slot, i|
+        return i if slot
+      end
+
+      return -1
+    end
+
+    def highest_used_slot
+      _slot = -1
+      @slots.each_with_index do |slot, i|
+        _slot = i if slot
+      end
+
+      return _slot
+    end
+
+    def create_notification(**args)
+      notification = Notification.new(host: self, **args)
+      @notifications << notification
+    end
+
+    class Driver
+      attr_reader :x, :y, :notification, :slot
+      def initialize(edge:, mode:, notification:, slot:)
+        @edge = edge
+        @mode = mode
+        @notification = notification
+        @slot = slot
+
+        @x, @y = 0, 0
+        @delta = Gosu.milliseconds
+        @accumulator = 0.0
+
+        @born_at = Gosu.milliseconds
+        @duration_completed_at = Float::INFINITY
+        @transition_completed_at = Float::INFINITY
+      end
+
+      def transition_in_complete?
+        Gosu.milliseconds - @born_at >= @notification.transition_duration
+      end
+
+      def duration_completed?
+        Gosu.milliseconds - @transition_completed_at >= @notification.time_to_live
+      end
+
+      def done?
+        Gosu.milliseconds - @duration_completed_at >= @notification.transition_duration
+      end
+
+      def draw
+        ratio = 0.0
+
+        if not transition_in_complete?
+          ratio = animation_ratio
+        elsif transition_in_complete? and not duration_completed?
+          ratio = 1.0
+        elsif duration_completed?
+          ratio = 1.0 - animation_ratio
+        end
+
+        case @mode
+        when MODE_DEFAULT
+          Gosu.clip_to(0, 0, Notification::WIDTH, Notification::HEIGHT * ratio) do
+            @notification.draw
+          end
+        when MODE_CIRCLE
+          half = Notification::WIDTH / 2
+
+          Gosu.clip_to(half - (half * ratio), 0, Notification::WIDTH * ratio, Notification::HEIGHT) do
+            @notification.draw
+          end
+        end
+      end
+
+      def update
+        case @mode
+        when MODE_DEFAULT
+          update_default
+        when MODE_CIRCLE
+          update_circle
+        end
+
+        @accumulator += Gosu.milliseconds - @delta
+        @delta = Gosu.milliseconds
+      end
+
+
+      def update_default
+        case @edge
+        when :left, :right
+          if not transition_in_complete? # Slide In
+            @x = @edge == :right ? -x_offset : x_offset
+          elsif transition_in_complete? and not duration_completed?
+            @x = @edge == :right ? -Notification::WIDTH : Notification::WIDTH if @x.abs != Notification::WIDTH
+            @transition_completed_at = Gosu.milliseconds if @transition_completed_at == Float::INFINITY
+            @accumulator = 0.0
+          elsif duration_completed? # Slide Out
+            @x = @edge == :right ? x_offset - Notification::WIDTH : Notification::WIDTH - x_offset
+            @x = 0 if @edge == :left and @x <= 0
+            @x = 0 if @edge == :right and @x >= 0
+            @duration_completed_at = Gosu.milliseconds if @duration_completed_at == Float::INFINITY
+          end
+
+        when :top, :bottom
+          if not transition_in_complete? # Slide In
+            @y = @edge == :top ? y_offset : -y_offset
+          elsif transition_in_complete? and not duration_completed?
+            @y = @edge == :top ? Notification::HEIGHT : -Notification::HEIGHT if @x.abs != Notification::HEIGHT
+            @transition_completed_at = Gosu.milliseconds if @transition_completed_at == Float::INFINITY
+            @accumulator = 0.0
+          elsif duration_completed? # Slide Out
+            @y = @edge == :top ? Notification::HEIGHT - y_offset : y_offset - Notification::HEIGHT
+            @y = 0 if @edge == :top and @y <= 0
+            @y = 0 if @edge == :bottom and @y >= 0
+            @duration_completed_at = Gosu.milliseconds if @duration_completed_at == Float::INFINITY
+          end
+        end
+      end
+
+      def update_circle
+        case @edge
+        when :top, :bottom
+          @y = @edge == :top ? Notification::HEIGHT : -Notification::HEIGHT
+        when :left, :right
+          @x = @edge == :right ? -Notification::WIDTH : Notification::WIDTH
+        end
+
+        if transition_in_complete? and not duration_completed?
+          @transition_completed_at = Gosu.milliseconds if @transition_completed_at == Float::INFINITY
+          @accumulator = 0.0
+        elsif duration_completed?
+          @duration_completed_at = Gosu.milliseconds if @duration_completed_at == Float::INFINITY
+        end
+      end
+
+      def animation_ratio
+        x = (@accumulator / @notification.transition_duration)
+
+        case @notification.transition_type
+        when Notification::LINEAR_TRANSITION
+          x.clamp(0.0, 1.0)
+        when Notification::EASE_IN_OUT_TRANSITION # https://easings.net/#easeInOutQuint
+          (x < 0.5 ? 16 * x * x * x * x * x : 1 - ((-2 * x + 2) ** 5) / 2).clamp(0.0, 1.0)
+        end
+      end
+
+      def x_offset
+        if not transition_in_complete? or duration_completed?
+          Notification::WIDTH * animation_ratio
+        else
+          0
+        end
+      end
+
+      def y_offset
+        if not transition_in_complete? or duration_completed?
+          Notification::HEIGHT * animation_ratio
+        else
+          0
+        end
+      end
+    end
+  end
+end

data/lib/gosu_notifications/version.rb

@@ -0,0 +1,3 @@
+module GosuNotifications
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: gosu_notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cyberarm
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-22 00:00:00.000000000 Z
+dependencies: []
+description: 'A simple notifications system for Gosu  '
+email:
+- matthewlikesrobots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/demo.rb
+- gosu_notifications.gemspec
+- lib/gosu_notifications.rb
+- lib/gosu_notifications/notification.rb
+- lib/gosu_notifications/notification_manager.rb
+- lib/gosu_notifications/version.rb
+homepage: https://github.com/cyberarm/gosu_notifications
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cyberarm/gosu_notifications
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A simple notifications system for Gosu
+test_files: []